Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of kind tool for developer k8s cluster deployments #3970

Closed
mrutkows opened this issue May 21, 2021 · 3 comments
Closed

Document use of kind tool for developer k8s cluster deployments #3970

mrutkows opened this issue May 21, 2021 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@mrutkows
Copy link
Member

Feature request

This issue is being opened assure work is done on a suggested follow-on PR to add developer documentation related to use of kind (i.e., https://kind.sigs.k8s.io/) and leverage existing scripts perhaps to deploy Tekton into K8s clusters.

See discussion in: #3955

Specifically, what was suggested by @afrittoli and endorsed by @nikhil-thomas and @sbwsg is copied here:

@afrittoli also has an extremely useful script for getting a Kind cluster installed with the latest version tekton pipelines running inside it.

Indeed, I find kind to be great for development. With KO_DOCKER_REPO=kind.local the images built by ko are uploaded directly into the containerd cache, which is very convenient.

The script is in the plumbing repo.
I also have an evolution of that which includes setting up an ingress controller and more, but I need to clean it up before I can put it back into plumbing.

I wonder if something like that would be useful as an "extremely quick quickstart"? We could place in contrib/ and reference it from here. Not a blocker on this PR though at all.

Agreed, linking the kind script in here could be an extra PR on top.

Note: I would happily agree to own this as I was unaware of kind and welcome the opp. to learn about this.

Use case

Assist developers in standing up k8s clusters not specific to any provider/platform

@mrutkows mrutkows added the kind/feature Categorizes issue or PR as related to a new feature. label May 21, 2021
@mrutkows
Copy link
Member Author

Sooo the plan is to document the kind tool and specifically leverage the use of this script:
https://github.com/tektoncd/plumbing/blob/main/hack/tekton_in_kind.sh

IMO, we should also document the script purpose/usage not only in DEVELOPMENT.md, but also in a new README in the parent "plumbing/hack" directory (and see if we can leverage that as a canonical doc. from DEVELOPMENT.md".

I can work to do these things as well as as test it in at least Docker Desktop... perhaps it might surface other parameters that the script could take in as well? Looking forward.

@tekton-robot
Copy link
Collaborator

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 15, 2021
@jerop
Copy link
Member

jerop commented Oct 15, 2021

documentation was added here: https://github.com/tektoncd/pipeline/blob/main/DEVELOPMENT.md#standing-up-a-k8s-cluster-with-tekton-using-the-kind-tool

and adding a quickstart using Kind on the Tekton Website is in progress in tektoncd/website#298

@jerop jerop closed this as completed Oct 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

3 participants