GSoC 2022 Final Report: Building Jenkins X UI
Jenkins X New UI
It is a web application built with Golang for the backend and Sveltekit for the frontend, both of which are built together and used in the same container. To function properly, it must be installed as a helm chart with Jenkins X CRDs.
🌟 It has light and dark themes.
Why need a new UI?
A good UI is essential for a CI/CD tool, as not everyone is familiar with the CLI. The current UI (jx-pipeline-visualizer) is a read-only UI, the user can view the logs of PipelineActivity but neither can start nor stop the pipeline.
Features that the UI will provide:
- Start and Stop a PipelineActivity.
- Have an audit trail.
- A graphical representation of PipelineActivity.
- RBAC to limit access to certain functionalities.
New Jenkins X UI focus on Simplicity, Security and a Superb User Experience.
This is NOT GA (General Availability) yet. Visit the project repo here to try it.
How to use it?
- Go to the
helmfiles/jx/helmfile.yamlin your cluster repo.
- Replace jx-pipelines-visualizer chart with the jx-ui chart.
- chart: jxgh/jx-ui version: <latest-version> name: jx-ui values: - ../../versionStream/charts/jxgh/jx-ui/values.yaml.gotmpl - jx-values.yaml
- Add the code snippet to ~/.config/ngrok/ngrok.yml under
ui: proto: http addr: 9200 schemes: - http
- Add that domain to the ingress file, Run the following command and replace dashboard.jx.change.me with ngrok link.
kubectl edit ing jx-ui
- And boom, visit localhost:9200 and it works, you should see the homepage screen.
Stop a running or pending PipelineActivity from UI
We have added a button in pipelines page and pipelineDetails page, it asks for confirmation and on selecting Yes it will stop the PipelineActivity.
We can stop the PipelineActivity from the pipelines tables.
We can also stop the PipelineActivity from the pipelines details page.
Show message with status of the PipelineActivity
When a pipeline is cancelled or it has timedout, we update the status of the pipeline to cancelled or timed out. However, we do not show the reason why a job was timed out. That information should be displayed on the pipeline details page (along with the step which has timed out). Issue: https://github.com/jenkins-x/jx-ui/issues/23
Implement a DAG for PipelineActivity
To make the UI more user friendly and to explain the sequence of the steps in a PipelineActivity, we have added a DAG (Directed Acyclic Graph) chart to graphically visualize the PipelineActivity.
We used D3.js library to create a custom component which create a DAG chart of PipelineActivity for us. D3-hierarchy is an important part of our component. We’re unit testing the component using vitest.
- The UI project is just started, we have also start a seperate UI-sig which you can join from calendar.
- There are some amazing features that we are planning to add to the new UI:
- Dynamically update the list of pipelines
- Upgrade version stream from the UI
- Import repositories using the UI
- Break down pipeline logs into individual steps
- Mask secrets in the logs
- Display logs for cancelled and timed out pipelines
To read more read the issues created here
I never imagined I would be this sad after finishing an internship. Just as Osama noted in his work report, this was the most difficult experience we have had thus far, but the encouragement of the jx community and the direction of our mentor made it the best educational experience I have ever had.
I learned a lot here, but there are still many things I need to learn (I haven’t finished my 30-day plan yet). I knew I could learn a lot from open source, but I didn’t expect this much. In addition, I think the CD Foundation is very special, and the community and the ways in which we can collaborate with other projects are also very valuable.
I started my intern by attending conferences like kubecon and CD Summit, we started UI-SIG, and in the last 2 months we’ve given 3 talks about Jenkins X. As I mentioned above there are still thing to do in the UI project and since we all loved the GSoC program, I’d love to became a part of it in future with Jenkins X.
Again Big Thanks to all my mentor Ankit, Christoffer, Marten, Tom and gsoc fellow Osama and JX community for such a great opportunity.