Add Documentation for Cluster Name via Yaml Configuration

[jsievenpiper]

👋🏾 I love this project -- it's been exactly what I needed for a recent project of my own.

I saw that PRs were welcome for some undocumented config file options, so thought I'd lend a hand!

[k8s-ci-robot]

Welcome @jsievenpiper!

It looks like this is your first PR to kubernetes-sigs/kind 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kind has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @jsievenpiper. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

[jsievenpiper]

/assign @amwat

Hope I'm doing this correctly 🙂

[amwat]

Thanks for adding this!
/approve

minor nits

[amwat]

I think this is generally true for every parameter. i.e. CLI flags will overwrite whatever is specified in the config file.
Since this page specifically deals with the config, I think just the config example should suffice here in this subsection.

Even better if we can move this note as a general note at the top somewhere :)

[BenTheElder]

+1 for a general note and also the CLI usage documenting this.

[jsievenpiper]

@amwat @BenTheElder thanks for the feedback! I pulled that CLI precedence note up and trimmed down the name section specifically. Good call out!

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amwat, jsievenpiper

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:

• OWNERS [amwat]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[BenTheElder]

/ok-to-test

[jsievenpiper]

/retest

[k8s-ci-robot]

@jsievenpiper: The following test failed, say /retest to rerun all failed tests:

Test name	Commit	Details	Rerun command
pull-kind-e2e-kubernetes-1-20	bc8e491	link	/test pull-kind-e2e-kubernetes-1-20

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

[BenTheElder]

/lgtm
thank you!