Keptn Bridge (Web UI)

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

OpenID Authentication

Enable/Disable OpenID authentication and implementation details for the identity provider

Deep Linking

Deep links into Bridge for better integration into DevOps tools

Daily Version Check

Enable/Disable daily version check feature

Loading integrations

Loading integrations page in Bridge from external source

Manage Projects

Create, update and delete projects from the Bridge

Manage Sequences

Manage sequences 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 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.

Project view

  • 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.

    Keptn Bridge empty project view
  • If you have created projects, you see the projects 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 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.

  • The service details on the right show the current and the past 5 evaluations, open approvals and running remediations for each service.

    Keptn Bridge environment view

Services view

  • 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 HeatMap and Chart:

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

    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, you can view both the SLOs against which the evaluation was executed against, and the event payload.

    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 for this stage.

    Keptn Bridge Evaluation Board

Sequences view

  • 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.

    Keptn Bridge Sequences View

Uniform view

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

  • 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 to which the services are subscribed
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 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.

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

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 latest event in your environment, depending on your configuration.

Show example payload

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

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.

Create Secret View

Integrations

You can find links 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 Load Information.

Settings

Project settings

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.

Keptn Bridge Project Settings View

Service settings

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.

Keptn Bridge Service Settings View

Keptn Bridge features

Approvals

If you have a [manual approval strategy](../continuous_delivery/multi_stage/ 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.

Approval in Environments

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.

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

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.

Supported Browsers

You can access Keptn Bridge using the following browsers.

Browser Versions
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.