Keptn v1 reached EOL December 22, 2023. For more information see https://bit.ly/keptn
This documentation is for an older Keptn release. Please consider the newest one when working with the latest Keptn.

Keptn Bridge

The user interface of Keptn that presents all projects and services managed by Keptn. It is automatically installed with your Keptn deployment.

Basic Authentication

Enable/Disable basic authentication

OAuth/OpenID Authentication

Enable/Disable OAuth authentication and implementation details for OAuth service

Deep Linking

Deep links into Bridge for better integration into DevOps tools

Manage Projects

Create, update and deletes projects from the Bridge

Manage Services

Create, update and delete services from the Bridge

Views in Keptn Bridge

The Keptn Bridge provides an easy way to browse all events that are sent within Keptn. When you access the Keptn Bridge, all projects will be shown on the start screen. When clicking on a project, the stages of this project, and all onboarded services are shown on the next view. An overview of those views is given below.

Project view

  • When you enter the Keptn Bridge and have not created a project yet, you will be guided to the instructions on how to setup a project and onboard a sample app.

    Keptn Bridge empty project view
  • If you have created projects, you will see the project listed including their stages.

    Keptn Bridge project view

Environment view

  • When you select a project, you see the environment overview of the entire Keptn context.

  • This view allows to easily see the current deployed services on each stage and if there are any errors or pending approvals for one stage. By clicking on a stage you can see more information about the deployed services on the specific stage on the right side.

    Keptn Bridge environment view

Services view

  • One of the key steps for continuous delivery and remediation is the evaluation result based on SLO/SLIs. The services view gives you a clear overview over the result of this evaluation step.

  • For each service the deployed artifacts are listed. Accordingly, for each artifact and executed stage, the evaluation result is displayed as HeatMap and Chart:

    Evaluation Heatmap
    Evaluation Chart
  • To customize the chart, labels can be used. 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 an URL, the label will be displayed as a link, so you can easily link back to the Dynatrace Dashboard for example.

    Use `buildId` as label
  • 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.

    Ignore evaluation for comparison
  • For your convenience the SLOs that the evaluation was executed against, as well as the event payload, can be viewed.

    Evaluation SLOs
    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.

    Open remediations
    Remediation configuration

Evaluation board

  • 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 on this stage.

    Keptn Bridge Evaluation Board

Sequences view

  • The sequences for the selected project are shown on this screen. It has a lot of filter possibilities, that can either be selected in the left pane or be 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.

    Keptn Bridge Sequences View

Uniform view

The uniform view gives you an overview over all integrations installed within your Keptn installation. The data is fetched from your Kubernetes cluster and shows useful information like

  • Unread/New error events
  • Deployment version of the service
  • The cluster or host where it is running
  • The Kubernetes namespace
  • The location within Keptn
  • The Cloud Events the services are subscribed to
Keptn Bridge Uniform View

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 failed, then there is a link 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.

Integrated Service Error Events

Create/Edit subscriptions view

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.

Create/Edit Subscriptions

Secrets view

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.

List Secrets View

By clicking on the delete button, you can delete secrets after a confirmation.

If you want to add a secret, just 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.

Create Secret View

Integrations

You can find links to for different integration possibilities here. This makes it easier to start using Keptn. Integrate either with Keptn CLI / API or use our custom integrations for different CI providers.

Please note that the page contains dynamic content that is loaded from https://get.keptn.sh/integrations.html. By clicking the button the data is requested, and additional data is gathered from the client. For more information about this see https://v1.keptn.sh/docs/0.9.x/reference/load_information/.

Settings

Project settings

In the settings view the project settings can be edited. To get more information about how to manage your projects with the settings, visit Manage Projects.

Keptn Bridge Project Settings View

Service settings

In this view, services can be created, updated and deleted. To get more information about how services can be managed in your settings, visit Manage Services.

Keptn Bridge Service Settings View

Keptn Bridge features

Approvals

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. Examining the stage allows to directly approve or decline the sequence in the stage overview.

Approval in Environments

In the services view, a pending approval can be recognized by the blue border of the stage. By examining the stage, approval can also be directly triggered there.

Approval in Services

In sequences the approval is listed within the tasks in the sequence. Approve or decline the approval by opening the expand pane.

Approval in Sequences

Manage projects

See the documentation for managing projects to see which features for creating and updating projects the Bridge provides.

Early access version of Keptn Bridge

Right now there is no early access version of Keptn Bridge available.

If you have any questions or feedback regarding Keptn Bridge, please contact us through our Keptn Community Channels.