Dashboard

General-Purpose, Web-Based UI

This document is a work in progress.

Overview

Tekton provides a component, Tekton Dashboard, as a general-purpose,web-based UI for Tekton Pipelines, which allows developers to:

  • View and manage taskRuns and pipelineRuns
  • View and manage resources associated with taskRuns and pipelineRunsin their creation, execution, and completion

Installation

To install the latest release of Tekton Dashboard, run the command below:

  1. kubectl apply --filename https://github.com/tektoncd/dashboard/releases/latest/download/dashboard_latest_release.yaml

To install the latest release of Tekton Dashboard, run the command below:

  1. kubectl apply --filename https://github.com/tektoncd/dashboard/releases/latest/download/dashboard_latest_openshift-tekton-dashboard-release.yaml

Important

The latest release may not be compatible with your Tekton Pipelinesinstallation, should you have an earlier release of Tekton Pipelinesinstalled. For more compatibility information, see theTekton Dashboard Releasespage.

If you would like to install an earlier release of Tekton Dashboardfor compatibility reasons, see the note below.

Note

To install a different release of Tekton Dashboard, find the .yaml fileyou would like to use on the Tekton Dashboard Releasespage, and run the command below:

  1. # Replace YOUR-RELEASE with the URL of the release you would like to use.
  2. kubectl apply –filename YOUR-RELEASE

It may take a few moments before the installation completes. You can checkthe progress with the following command:

  1. kubectl get pods --namespace tekton-pipelines

Confirm that every component listed has the status Running.

Usage

Tekton Dashboard is accessible through its cluster IP type service witha reverse proxy.Run the following command:

  1. kubectl proxy --port=8080

And you can open the dashboard in your browser under the address

  1. localhost:8080/api/v1/namespaces/tekton-pipelines/services/tekton-dashboard:http/proxy/

It is also possible to set up port forwarding with Tekton Dashboard:

  1. kubectl --namespace tekton-pipelines port-forward svc/tekton-dashboard 8080:8080

Once set up, the dashboard is available in the browser under the addresslocalhost:8080.

What’s next

Tekton Dashboard provides many features such as Webhook extension (for settingup a GitHub repository with a Tekton pipeline in the UI), TLS support, andIngress support. For more information, see theTekton Dashboard GitHub repository.