KubeRocketCI Widgets
KubeRocketCI offers widgets as data visualization tools to observe the status of both the platform and its resources. This page describes all the widgets presented in KubeRocketCI.
Widgets Overview​
The first widget users view when using KubeRocketCI portal is Platform Dashboard. It shows the amount of pipeline runs, amount of failed pipeline runs and percentage of successful pipeline runs. When clicking on this small widget, you will be redirected to the Overview page which will show you the following widget groups:
-
Header: Shows you the total amount of PipelineRuns, their success rate, failed pipelines, and average duration.
-
Pipeline Activity (7 days): Shows you 7 columns that represent the amount of triggered pipeline runs and their success rate.
-
Resource Health: these widgets reflect all the resources in the default namespace:
- Codebases: Displays all the created codebases;
- Branches: Shows the total amount of codebase branches;
- Pipelines: Shows all the initiated pipeline runs;
- Deployments: Displays all the created deployments;
- Environments: Shows the total amount of created environments;
- + Add Widget: Opens the Add new widget window.
-
Resource Usage: These widgets show you a summary of cluster resources consumed by the platform.
-
Vulnerability Summary: This is the total amount of vulnerabilities of the Projects found by Dependency-Track.
-
SonarQube Quality: This is the summary for all the SonarQube Projects.
-
Recent Pipeline Activity: Shows recent PipelineRuns, including their name (clickable), status, duration, and start time.
-
DORA Metrics: These widgets provide insights into software delivery performance using DORA metrics, including Deployment Frequency and Change Failure Rate, covering the past 30 days.
-
Links: Clickable links that can lead you to other services integrated with the platform. You can manually create Quick Links by following the instructions in the Manage Quick Links guide.
The status of the resources is displayed real-time and doesn't require any preliminary configuration to for widgets to work. Not only these widgets display the amount of resources but also their statuses (success, fail, in progress).
Additionally, users can track any specific application status and deployed versions using custom widgets. To add a custom widget, follow the steps below:
-
On the Overview section, click the + Add Widget button.
-
On the Add new widget window, select the Application deployed versions widget type.
-
Select the application to track and click Add.
-
View the application widget to get the information about Deployments and Environments where application is deployed.
-
To delete the widget, hover your mouse cursor over the widget block and click the bin icon that appears.
SonarQube & Dependency-Track Widgets​
KubeRocketCI also offers widgets to track codebases' code quality directly from the KubeRocketCI portal. These widgets pull codebase-related data from SonarQube and Dependency-Track tools.
To enable these widgets, you need to pass the following steps:
- Integrate platform with SonarQube and/or Dependency-Track.
- Install and configure the KrakenD tool.
- Trigger the review pipeline in a codebase, allowing SonarQube and Dependency-Track to scan your code.
At least one build pipeline must be run for the codebase to activate the widgets.
- Verify the widgets started working for the codebase.
The SonarQube and Dependency-Track widgets only track the default branch.
Resource Quota Widget​
The last available widget is a resource quota widget. To open the widget, click the circle icon in the top-right corner of the screen.
This widget shows resource requests and limits (CPU, Memory, Namespace) of both the deployments and the entire platform.
To enable the widget, you need to deploy KubeRocketCI in a Capsule tenant.