Enable/Disable basic authentication
Home / Keptn v1 Docs / Release 1.y.z / Keptn Bridge (Web UI)
Keptn dashboard used to view and manage projects and services managed by Keptn.
Enable/Disable basic authentication
Enable/Disable OpenID authentication and implementation details for the identity provider
Deep links into Bridge for better integration into DevOps tools
Enable/Disable daily version check feature
Create, update and delete projects from the Bridge
Manage sequences from the Bridge
Create, update and delete services from the Bridge
The Keptn Bridge is the Keptn user interface. It provides a dashboard that provides information about all projects and services managed by Keptn It is automatically installed with your Keptn deployment.
The Keptn Bridge provides an easy way to browse all events that are sent within Keptn. When you access the Keptn Bridge, all projects are shown on the start screen. When clicking on a project, the stages of this project, and all services are shown on the next view. An overview of those views is given below.
When you enter the Keptn Bridge and have not created a project yet, you are guided to the instructions about how to set up a project and create a sample app.
If you have created projects, you see the projects listed, including their stages.
When you select a project, you see the environment overview of the entire Keptn context.
This view shows the currently deployed services on each stage and whether any stages have errors or pending approvals. When you click on a stage, more information about the services deployed on this stage is shown.
The service details on the right show the current and the past 5 evaluations, open approvals and running remediations for each service.
One of the key steps for continuous delivery and remediation is the evaluation result based on SLOs and SLIs. The services view gives an overview of the results of this evaluation step.
The deployed artifacts for each service are listed, with the evaluation result for each artifact and executed stage as a HeatMap and Chart:
Use labels to customize the chart. If the
sh.keptn.event.evaluation.triggered event has the label
buildId attached, the Keptn Bridge reads the value
of this label and uses it as label for the x-axis in the Chart. If the value of the label is a URL, the label is displayed as a link,
so you can easily link back to the Dashboard of your observability server.
If you are using relative SLO values that are based on past evaluations Ignore for comparison could come in handy. With this you can exclude an evaluation when determining the relative values. To do so click on the desired evaluation in the heatmap and click the button Ignore for comparison. The evaluation is then removed from the heatmap and the evaluation calculation.
For your convenience, you can view both the SLOs which the evaluation was executed against, and the event payload.
If you configured some remediations and one of them is currently running, the affected service, deployment and stage is indicated. You can also see which type of remediation is being executed and view its configuration and sequence execution.
Next to the evaluation comparison as a heatmap or chart in the Services view, we provide a link to the Evaluation Board, which displays only the evaluation comparison for this stage.
The sequences for the selected project are shown on this screen. It has many filter possibilities which can either be selected in the left pane or applied by using the search bar.
When you select a sequence, the related tasks are shown for each stage. The stages can be selected by clicking onto the stage name in the timeline, or the badge of the sequence list item.
You can also expand each task to show the related events.
The uniform view gives you an overview of all integrations installed within your Keptn installation. The data is fetched from your Kubernetes cluster and shows useful information like
You can view the related subscriptions, events on error level, and sequence failures by selecting an integration. It is also possible to directly configure the subscriptions to listen to specific events. If there are new error events since the last time the integration was viewed, a red indicator shows up for this integration. When a sequence in this particular scope fails, a link is provided that takes you directly to the failed task in the sequence. ’n/a’ in this regard means that the error is not related to any sequence execution.
By clicking on the edit icon next to the subscription detail or the “Add sequence"-button, you are redirected to the subscription view. In this view, you can configure the task, stage and service for the subscription. The values used for the configuration are defined in the shipyard file. It is also possible to define whether the subscription is active for all projects or just the currently selected one.
Once you have selected an event and configured your filters, you may inspect an example event payload by clicking on the “Show example payload”-Button. This will show you the payload of the latest event in your environment, depending on your configuration.
Secrets are used to store sensitive data like credentials or URIs for integrations. This view gives you an overview of all secrets that have been created by the secret-service.
Click on the delete button to delete secrets after a confirmation.
To add a secret, click on the “Add secret"-Button. It will show you a form where you can set the secret name and provide key-value-pairs that should be stored with that secret name.
Use the settings view to edit the project settings. To get more information about how to manage your projects with the settings, visit Manage Services.
Use this view to create, update, and delete services. To get more information about how services can be managed in your settings, visit Manage Services.
If you have a manual approval strategy defined in your shipyard.yaml file, approvals can be handled with the Keptn Bridge. At sequence execution, if the approval task is reached, a panel is shown in all relevant screens:
In the environment view a pending approval can be recognized by the blue service out-of-sync icon at the according stage. You can directly approve or decline the sequence by examining the stage in the stage overview.
In the services view, a pending approval can be recognized by the blue border of the stage. You can directly trigger an approval when you examine the stage.
In sequences the approval is listed within the tasks in the sequence. Approve or decline the approval by opening the expand pane.
See the documentation for managing projects to see which features for creating and updating projects the Bridge provides.
No early access version of Keptn Bridge is currently available.
If you have any questions or feedback regarding Keptn Bridge, please contact us through our Keptn Community Channels.
You can access Keptn Bridge using the following browsers.
|Microsoft Edge||Latest version (desktop)|
|Mozilla Firefox||Latest version (desktop)|
|Google Chrome||Latest version (desktop)|
|Safari||11+ (OS X)|
Keptn Bridge is not designed to work on mobile devices.