From 5388f351cf51575160368cac599645e382539487 Mon Sep 17 00:00:00 2001 From: Sergetron <28788978+sergetron@users.noreply.github.com> Date: Tue, 23 Feb 2021 10:31:07 -0500 Subject: [PATCH] Rewrite the Tekton Triggers installation instructions for clarity and flow. Rewrites the Tekton Triggers installation instructions for clarity and flow. --- docs/install.md | 82 +++++++++++++++++-------------------------------- 1 file changed, 28 insertions(+), 54 deletions(-) diff --git a/docs/install.md b/docs/install.md index fb2cbe0f5..dd5863679 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,93 +1,67 @@ -# Installing Tekton Triggers +# Setting Up Tekton Triggers -Use this page to add the component to an existing Kubernetes cluster. +Follow the steps below to set up an official release of Tekton Triggers on your Kubernetes cluster. +If you want to test Triggers from `HEAD`, see the +[Tekton Developer Guide](https://github.com/tektoncd/triggers/blob/master/DEVELOPMENT.md#install-triggers). -- [Pre-requisites](#pre-requisites) -- [Versions](#versions) -- [Installing Tekton Triggers](#installing-tekton-triggers-1) +## Prerequisites -## Pre-requisites +You must satisfy the following prerequisties to set up Tekton Triggers: -1. A Kubernetes cluster version 1.18 or later +* You must have a Kubernetes Cluster running Kubernetes 1.18 or above. - If you don't already have a cluster, you can create one for testing with - `kind`. [Install - `kind`](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) and - create a cluster by running [`kind create - cluster`](https://kind.sigs.k8s.io/docs/user/quick-start/#creating-a-cluster). - This will create a cluster running locally, with RBAC enabled. + You can use [`kind`](https://kind.sigs.k8s.io/) to quickly create a local cluster with RBAC enabled for testing purposes: -1. Grant current user `cluster-admin` privileges. + * Install `kind` as described in [Installation](https://kind.sigs.k8s.io/docs/user/quick-start/#installation). - _See - [Role-based access control](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#prerequisites_for_using_role-based_access_control) - for more information._ + * Create a cluster as described in [Creating a Cluster](https://kind.sigs.k8s.io/docs/user/quick-start/#creating-a-cluster). -1. Install Tekton Pipelines. You can install the latest version using the - command below or follow the - [pipeline installation guide](https://github.com/tektoncd/pipeline/blob/master/docs/install.md): +* You must have Tekton Pipelines installed on your Kubernetes cluster. - ```bash - kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/latest/release.yaml - ``` - - -## Versions - -The versions of Tekton Triggers available are: + For instructions, see [Installing Tekton Pipelines](https://github.com/tektoncd/pipeline/blob/master/docs/install.md). + +* You must grant the `cluster-admin` privilege to the user with which you installed Tekton Pipelines. -- [Officially released versions](https://github.com/tektoncd/triggers/releases), - e.g. `v0.1.0` -- `HEAD` - To install the most recent, unreleased code in the repo see - [the development guide](https://github.com/tektoncd/triggers/blob/master/DEVELOPMENT.md#install-triggers) + For instructions, see [Role-based access control](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#prerequisites_for_using_role-based_access_control). -## Installing Tekton Triggers +## Installing Tekton Triggers on Your Cluster -To add the Tekton Triggers component to an existing cluster: +1. Log on to your Kubernetes cluster as the user with which you installed Tekton Pipelines. -1. Run the - [`kubectl apply`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply) - command to install [Tekton Triggers](https://github.com/tektoncd/triggers) - and its dependencies: +1. Use the [`kubectl apply`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply) command to install the latest release of Tekton Triggers and its dependencies: ```bash kubectl apply --filename https://storage.googleapis.com/tekton-releases/triggers/latest/release.yaml ``` - You can install a specific previous release using `previous/$VERSION_NUMBER`, e.g. + To install a specific release of Tekton Triggers, replace `latest` with the desired version number as shown in the following example: ```bash kubectl apply -f https://storage.googleapis.com/tekton-releases/triggers/previous/v0.1.0/release.yaml ``` - To install a nightly release, use: + To install a nightly release, use the following command: ```bash kubectl apply --filename https://storage.googleapis.com/tekton-releases-nightly/triggers/latest/release.yaml ``` -1. Run the - [`kubectl get`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#get) - command to monitor the Tekton Triggers components until all of the components - show a `STATUS` of `Running`: +1. Monitor the installation using the [`kubectl get`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#get) + command: ```bash - kubectl get pods --namespace tekton-pipelines + kubectl get pods --namespace tekton-pipelines --watch ``` - Tip: Instead of running the `kubectl get` command multiple times, you can - append the `--watch` flag to view the component's status updates in real - time. Use CTRL + C to exit watch mode. +1. When all Tekton Triggers components report a status of `Running` press CTRL+C to stop monitoring. -You are now ready to create and run Tekton Triggers: +You are now ready to configure Tekton Triggers for your workflow. For instructions, see the following: -- See [Tekton Triggers Getting Started Guide](./getting-started/) to - get started. -- Look at the - [examples](https://github.com/tektoncd/triggers/tree/master/examples) +- [Tekton Triggers Getting Started Guide](./getting-started/) +- [Tekton Triggers code examples](https://github.com/tektoncd/triggers/tree/master/examples)