Move kind development instructions to top of dev cluster instructions. #4466
Conversation
kind provides an easy way for people to get started with developing Tekton. This change promotes kind to the top of the cluster getting started instructions, and simplifies the setup with easy copy+paste commands. Keeps reference to tekton_in_kind.sh, but does not rely on it for the core setup instructions since it installs multiple tekton components besides pipelines.
| [KinD](https://kind.sigs.k8s.io/) is a great tool for working with Kubernetes clusters locally. It is particularly useful to quickly test code against different cluster [configurations](https://kind.sigs.k8s.io/docs/user/quick-start/#advanced). | ||
|
|
||
| 1. Install [required tools](./DEVELOPMENT.md#install-tools) (note: may require a newer version of Go). | ||
| 2. Install [Docker](https://www.docker.com/get-started). |
There was a problem hiding this comment.
nit: or anything supported by kind (like podman)
There was a problem hiding this comment.
kind unfortunately doesn't have a good page to link to at the moment for supported runtimes, so I'm a bit hesitant to include this right now (I want to make the getting started instructions as simple as possible with minimal research needed).
|
|
||
| ```sh | ||
| $ export KO_DOCKER_REPO="kind.local" | ||
| $ export KIND_CLUSTER_NAME="kind" # only needed if you used a custom name in the previous step |
There was a problem hiding this comment.
I don't remember, if the cluster name is different, shouldn't KO_DOCKER_REPO be different too ?
There was a problem hiding this comment.
Nope! Only KIND_CLUSTER_NAME needs to be set. 🧙
I use this all the time having separate kind clusters for vanilla pipelines and pipelines + results.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Nice, cheers! /lgtm |
Changes
kind provides an easy way for people to get started with developing
Tekton. This change promotes kind to the top of the cluster getting
started instructions, and simplifies the setup with easy copy+paste
commands.
Keeps reference to tekton_in_kind.sh, but does not rely on it for the
core setup instructions since it installs multiple tekton components
besides pipelines.
/kind documentation
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes