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.

Sign up for GitHub

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

Jump to bottom

Document how to use the kind tool and the Tekton/plumbing convenience script #3972

Merged
merged 1 commit into from
Jun 14, 2021
Merged

Document how to use the kind tool and the Tekton/plumbing convenience script #3972

merged 1 commit into from
Jun 14, 2021

Conversation

mrutkows
Copy link
Member

@mrutkows mrutkows commented May 25, 2021 •
edited by pritidesai
Loading

Changes

This PR is a promised follow-on to PR #3955 (suggested by Andrea and Scott) which intends to document the use of the kind tool and specifically use of the convenience script(s) provided in the Tekton plumbing repo.

It addresses the reference issue #3970 which captures the request more fully.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

/kind documentation

Release Notes

Documenting how to use the kind tool to setup the development environment.

@tekton-robot tekton-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels May 25, 2021
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 25, 2021
@mrutkows
Copy link
Member Author

/kind documentation

@tekton-robot
Copy link
Collaborator

Hi @mrutkows. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. kind/documentation Categorizes issue or PR as related to documentation. labels May 25, 2021
@tekton-robot
Copy link
Collaborator

@mrutkows: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 25, 2021
@ghost
Copy link

ghost commented May 25, 2021

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 25, 2021
@pritidesai
Copy link
Member

/ok-to-test

@pritidesai pritidesai mentioned this pull request May 25, 2021
Merged
@nikhil-thomas nikhil-thomas mentioned this pull request May 26, 2021
Open
@mrutkows
Copy link
Member Author

As I started looking at the inner workings of the script and providing a small "delete" example, I realized more was going on with the script and decided to create tektoncd/plumbing#849 in the plumbing repo. where the script resides to host canonical information that could be referenced in DEVELOPMENT.md to avoid too much duplication.

@mrutkows
Copy link
Member Author

mrutkows commented Jun 10, 2021 •
edited
Loading

@sbwsg @pritidesai Thanks for your help. I have now factored in the refs./content in the plumbing docs, rebased and flattened commits. Please review when able. Thanks!

@mrutkows mrutkows marked this pull request as ready for review June 10, 2021 19:55
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 10, 2021
vdemeester
vdemeester reviewed Jun 11, 2021
View reviewed changes
DEVELOPMENT.md Outdated
@@ -265,7 +266,7 @@ The recommended minimum development configuration is:

<!-- TODO: Someone needs to validate the cluster-version-->
1. Create a GKE cluster (with `--cluster-version=latest` but you can use any
version 1.18 or later):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason to revert that back ? on main (and most likely on 0.24 too), we have a minimum version of k8s at 1.18.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how I reverted this... will put back.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done ;)

@mrutkows mrutkows force-pushed the kinddocs branch 2 times, most recently from b9c1a52 to 60298dd Compare June 11, 2021 15:16
ghost
ghost approved these changes Jun 11, 2021
View reviewed changes
DEVELOPMENT.md Outdated

### Standing up a K8s cluster with Tekton using the `kind` tool

An alternative to standing up your own K8s cluster and installing Tekton using `ko` is by using the [kind](https://kind.sigs.k8s.io/) tool. It was designed to help create and run local, Kubernetes clusters in Docker to assist in local development and testing.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: looks like there might be a word missing here? create and run local, Kubernetes clusters

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that I did not actually need a comma there between local and K8s. Can remove...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sbwsg Fixed

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 11, 2021
pritidesai
pritidesai reviewed Jun 11, 2021
View reviewed changes
DEVELOPMENT.md Outdated
@@ -98,7 +99,7 @@ To [build, deploy and run your Tekton Objects with `ko`](#install-pipeline), you

1. `GOROOT`: Set `GOROOT` to the location of the Go installation you want `ko` to use for builds.

> **NOTE** You may need to set `GOROOT` if you installed Go tools to a a non-default location or have multiple Go versions installed.
> **Note**: You may need to set `GOROOT` if you installed Go tools to a a non-default location or have multiple Go versions installed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: extra a here 🙃 to a a non-default location

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed the "a a" that was from previous PR ;)

pritidesai
pritidesai reviewed Jun 11, 2021
View reviewed changes
DEVELOPMENT.md
```shell
cd plumbing
./hack/tekton_in_kind.sh
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tried these instructions myself but excited to experiment with it. Thank you @mrutkows for documenting them in the pipeline repo.

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jun 11, 2021
@pritidesai
Copy link
Member

thanks @mrutkows I have updated the release notes

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 11, 2021
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jun 11, 2021
@ghost
Copy link

ghost commented Jun 14, 2021

/test pull-tekton-pipeline-alpha-integration-tests

1 similar comment
@ghost
Copy link

ghost commented Jun 14, 2021

/test pull-tekton-pipeline-alpha-integration-tests

@pritidesai
Copy link
Member

thanks again @mrutkows

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 14, 2021
@tekton-robot tekton-robot merged commit 64cc06c into tektoncd:main Jun 14, 2021
@mrutkows mrutkows deleted the kinddocs branch June 14, 2021 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pritidesai pritidesai pritidesai left review comments

@vdemeester vdemeester vdemeester left review comments

@imjasonh imjasonh Awaiting requested review from imjasonh

@jerop jerop Awaiting requested review from jerop

Assignees

@pritidesai pritidesai

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mrutkows @tekton-robot @pritidesai @vdemeester