Skip to content

Commit

Permalink
Add yaml to install gcr images, updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vincent-DeSousa-Tereso authored and tekton-robot committed Jun 7, 2019
1 parent 818afa9 commit 0f41e89
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,36 @@
Tekton Dashboard is a general purpose, web-based UI for Tekton Pipelines. It allows users to manage and view Tekton Pipeline and Task runs and the resources involved in their creation, execution, and completion.

![Dashboard UI workloads page](docs/dashboard-ui.png)

## Install Dashboard
To install the Dashboard using `ko`:
```sh
The Tekton Dashboard has a hosted image located at gcr.io/tekton-nightly/dashboard:latest
To install the latest dashboard using this image:
```
kubectl apply -f config/gcr-tekton-dashboard.yaml
```

Alternatively, the dashboard can be installed through the same Git Hub release asset:
```
curl -L https://github.com/tektoncd/dashboard/releases/download/v0/gcr-tekton-dashboard.yaml | kubectl apply -f -
```

Development installation of the Dashboard uses `ko`:
```
sh
$ docker login
$ export KO_DOCKER_REPO=docker.io/<mydockername>
$ npm install
$ npm run build_ko
$ ko apply -f config
$ ko apply -f config/dev-tekton-dashboard.yaml
```

The `ko apply` command will build and push an image of the Tekton Dashboard to the Docker registry which you are logged into. Any Docker registry will do, but in this case it will push to Dockerhub.

The Dashboard can also be installed without `ko`:

```sh
$ docker build -t <mydockername>/dashboard:<mytag> .
$ docker push <mydockername>/dashboard:<mytag>
```
- Replace the image path at `config/tekton-dashboard.yaml` with the value for <mydockername>/dashboard:<mytag>
- Replace the WEB_RESOURCES_DIR value in the same file with the value __./web__
```
$ kubectl apply -f config
```

## Install on Minishift

1. Install [tektoncd-pipeline-operator](https://github.com/openshift/tektoncd-pipeline-operator#deploy-openshift-pipelines-operator-on-minikube-for-testing)
2. [Checkout](https://github.com/tektoncd/dashboard/blob/master/DEVELOPMENT.md#checkout-your-fork) the repository
3. Install deployment config `$oc process -f config/templates/deploy.yaml | oc apply -f-`
4. Install build config `$oc process -f build.yaml | oc apply -f-`
4. Install build config `$oc process -f config/templates/build.yaml | oc apply -f-`

## Accessing Dashboard
The Dashboard has can be accessed through its ClusterIP Service by running `kubectl proxy`. Assuming default is the install namespace for the dashboard, you can access the web UI at `localhost:8001/api/v1/namespaces/default/services/tekton-dashboard:http/proxy/`
Expand Down
File renamed without changes.
59 changes: 59 additions & 0 deletions config/gcr-tekton-dashboard.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# ------------------- Dashboard Deployment ------------------- #
apiVersion: apps/v1
kind: Deployment
metadata:
name: tekton-dashboard
labels:
app: tekton-dashboard
spec:
replicas: 1
selector:
matchLabels:
app: tekton-dashboard
template:
metadata:
name: tekton-dashboard
labels:
app: tekton-dashboard
spec:
containers:
- name: tekton-dashboard
image: gcr.io/tekton-nightly/dashboard:latest
ports:
- containerPort: 9097
livenessProbe:
httpGet:
path: /health
port: 9097
readinessProbe:
httpGet:
path: /readiness
port: 9097
resources:
env:
- name: PORT
value: "9097"
- name: WEB_RESOURCES_DIR
value: /var/run/ko/web
- name: PIPELINE_RUN_SERVICE_ACCOUNT
value: ""
- name: INSTALLED_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
---
# ------------------- Dashboard Service ------------------- #
kind: Service
apiVersion: v1
metadata:
name: tekton-dashboard
labels:
app: tekton-dashboard
spec:
ports:
- name: http
protocol: TCP
port: 9097
targetPort: 9097
selector:
app: tekton-dashboard

0 comments on commit 0f41e89

Please sign in to comment.