Installing the UI

To use the GUI, you must install and configure it for your CloudBees Jenkins X Distribution environment.

  1. Ensure that you have the proper namespace set by running jx from the command line to switch to the jx namespace:

    jx ns jx
  2. From a command-line, install the UI application by using the jx add app command:

    jx add app jx-app-ui --version 0.1.211
  3. If you have enabled GitOps mode in your CloudBees Jenkins X Distribution cluster, the jx add app command updates your development (dev) environment repository and automatically merges the UI app source code changes to your dev environment.

    If you do not have Gitops enabled in your cluster, you can manually navigate to the Pull request tab in your dev repository GitHub page and click Merge to accept the UI app source code to your dev environment. There may be a delay of up to several minutes after merging for the UI to become available for use.
  4. Determine whether or not you have TLS/DNS support enabled in your cluster and choose one of the following steps:

    • If you have TLS/DNS enabled in your cluster:

      1. The UI is exposed with its own subdomain URL, accessible by using the kubectl command:

        kubectl get -n jx ingress jenkins-x-jxui

        This should give you a URL which looks like: dashboard.cluster1.acmecorp.example that you can open in your browser.

      2. The UI is protected by basic authentication, the user and password are the admin credentials setup for your cluster.

    • If you don’t have TLS/DNS enabled in your cluster:

      1. Start the UI at the command line using the jx command:

        jx ui -p 8080

        The -p option allows you to specify a port number. You may choose available HTTP port open or allowed on your local network. The jx command executes a kubectl port-forward that commands your cluster to direct UI related traffic to the specified port.

      2. Open the UI app in your browser using your specified port:

        open http://localhost:8080
      3. The UI is protected by basic authentication, the user and password are the admin credentials setup for your cluster.