Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 3.5 KB

README.md

File metadata and controls

117 lines (85 loc) · 3.5 KB
Raw

Overview

Tekton Dashboard is a general-purpose, web-based UI for Tekton Pipelines and Tekton triggers resources.

It allows users to manage and view Tekton resource creation, execution, and completion.

Some of the features the Dashboard supports:

  • Realtime view of PipelineRun and TaskRun status and logs.
  • Filter lists of resources by label.
  • View resource details and YAML.
  • Show resources for the whole cluster or limit visibility to a particular namespace.
  • Import resources directly from a git repository.
  • Add functionality using extensions.

Tutorial

Try out the tutorial on Katacoda to install the Dashboard in a guided sandbox environment and explore some of its features.

Installation

{{% tabs %}}

{{% tab "Kubernetes" %}} To install the latest release of Tekton Dashboard, run the command below:

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

{{% /tab %}}

{{% tab "OpenShift" %}} To install the latest release of Tekton Dashboard, run the command below:

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

{{% /tab %}}

{{% /tabs %}}

{{% alert title="Important" color="warning" %}} The latest release may not be compatible with your Tekton Pipelines installation, should you have an earlier release of Tekton Pipelines installed. For more compatibility information, see the Tekton Dashboard's "Which version should I use?" section.

If you would like to install an earlier release of Tekton Dashboard for compatibility reasons, see the note below. {{% /alert %}}

{{% alert title="Note" color="success" %}} To install a different release of Tekton Dashboard, find the .yaml file you would like to use on the Tekton Dashboard Releases page, and run the command below:

kubectl apply --filename <release-url>

where <release-url> is the URL of the release you would like to use.

{{% /alert %}}

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

kubectl get pods --namespace tekton-pipelines

Confirm that every component listed has the status Running.

Usage

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

kubectl proxy --port=8080

Then you can open the Dashboard in your browser at

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

Alternatively, you can use port forwarding:

kubectl --namespace tekton-pipelines port-forward svc/tekton-dashboard 9097:9097

Once set up, the Dashboard is available in the browser at http://localhost:9097

What's next

Try out some of our walkthroughs for more details on deploying and configuring the Tekton Dashboard for some common scenarios. For more information, see the Tekton Dashboard GitHub repository.