This is a Web UI for Jenkins X, with a clear goal: visualize the pipelines - and their logs.

See the announcement blog post for more details and a demo.

This project has been started in September 2020 and shared after a couple of hours of work. It's working - and is deployed and used at Dailymotion - even if the UI is very basic for the moment.

Note that it is being used on GKE with logs stored in a GCS bucket.

• Improve the UI: visualize the pipeline (stages/steps), group logs per stage/step, and so on
• Split the API and the UI, to make it easier to iterate on the UI

• very simple
• very fast: get your logs in milliseconds, not seconds. Yes, I'm looking at you, JXUI.
• either retrieve the build logs from the persistent storage (tested with GCS), or stream them from the running pods if the pipeline is still running.
• retrieve the build logs even for the garbage-collected pipelines (the JXUI just returns 404)
• read-only. Only requires READ permissions on the JX and Tekton Pipelines CRDs
• URLs backward-compatible with JXUI - so that you can easily swap the JXUI URL for the jx-pipelines-visualizer one in the Lighthouse config, and have Lighthouse set links to jx-pipelines-visualizer in GitHub Pull Requests.

• Auth - use a reverse-proxy in front or anything else to handle it
  • for example Vouch and Okta
  • or dex, oauth2-proxy, ...
  • or nginx basic-auth - if you are using the nginx ingress controller
• Create/Update/Delete operations. It is meant to be a read-only web UI
• Anything in JX which is not related to the pipelines

It's already installed by default with Jenkins X v3. If its not (e.g. you have an older git repository) - add the following to your helmfile.yaml file in the releases: section:

releases:
- chart: jx3/jx-pipelines-visualizer

By default an ingress is created to access the UI using basic authentication. See the documentation for how to access it

You can see the default values here: https://github.com/jenkins-x/jxr-versions/tree/master/charts/jx3/jx-pipelines-visualizer

In the Git repository for your dev environment:

• Update the env/requirements.yaml file with the following:

  - name: jx-pipelines-visualizer
    repository: https://storage.googleapis.com/jenkinsxio/charts/
    version: 0.0.30
  

• Create a new file env/jx-pipelines-visualizer/values.tmpl.yaml with the following content:

  {{- if .Requirements.storage.logs.enabled }}
  config:
    archivedLogsURLTemplate: >-
      {{ .Requirements.storage.logs.url }}{{`/jenkins-x/logs/{{.Owner}}/{{.Repository}}/{{if hasPrefix .Branch "pr"}}{{.Branch | upper}}{{else}}{{.Branch}}{{end}}/{{.Build}}.log`}}
  {{- end }}
  
  ingress:
    enabled: true
    hosts:
      - pipelines{{.Requirements.ingress.namespaceSubDomain}}{{.Requirements.ingress.domain}}
    {{- if .Requirements.ingress.tls.enabled }}
    tls:
      enabled: true
      secrets:
        # re-use the existing tls secret managed by jx
        {{- if .Requirements.ingress.tls.production }}
        tls-{{ .Requirements.ingress.domain | replace "." "-" }}-p: {}
        {{- else }}
        tls-{{ .Requirements.ingress.domain | replace "." "-" }}-s: {}
        {{- end }}
    {{- end }}
    annotations:
      kubernetes.io/ingress.class: nginx
  

  This will expose the UI at pipelines.your.domain.tld - without any auth. You can add basic auth by appending a few additional annotations - re-using the Jenkins X Auth Secret:

  nginx.ingress.kubernetes.io/auth-type: basic
  nginx.ingress.kubernetes.io/auth-secret: jx-basic-auth
  

• If you want Lighthouse to add links to your jx-pipelines-visualizer instance from your Pull/Merge Request checks, update the env/lighthouse-jx/values.tmpl.yaml file and add the following:

  env:
    LIGHTHOUSE_REPORT_URL_BASE: "https://pipelines{{.Requirements.ingress.namespaceSubDomain}}{{.Requirements.ingress.domain}}"
  

$ helm repo add jx https://storage.googleapis.com/jenkinsxio/charts/
$ helm install jx-pipelines-visualizer jx/jx-pipelines-Visualizer

$ helm repo add jx https://storage.googleapis.com/jenkinsxio/charts/
$ helm repo update
$ helm install --name jx-pipelines-visualizer jx/jx-pipelines-visualizer

See the values.yaml file for the configuration.

If you are not using the Helm Chart, the binary is using CLI flags only - no config files. You can run jx-pipelines-visualizer -h to see all the flags.

go run cmd/server/main.go

It uses the "informer" Kubernetes pattern to keep a local cache of the Jenkins X PipelineActivities, and index them in an in-memory Bleve index.

It uses part of jx code to retrieve the build logs - mainly the part to stream the build logs from the running pods. It is the same code used by the jx get build logs command.

Thanks to Dailymotion for creating the original repository and then donate it to the Jenkins X project.