📖 Document environment variables supported by envtest

[mariantalla]

This is part of kubernetes-sigs/kubebuilder#1000 and a followup to the work in kubernetes-sigs/kubebuilder#1055.

Adds information on envtest environment variables to the GoDoc.

/kind documentation

[k8s-ci-robot]

Welcome @mariantalla!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. 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/controller-runtime 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. 😃

[mariantalla]

/cc @DirectXMan12

[DirectXMan12]

do those actually show up in the godoc in that position? If so, lgtm, otherwise, maybe just move to the package doc comment.

[mariantalla]

They show up as part of the documentation on Constants:

It would be nice to be able to show the actual defaults (defaultKubebuilderPath, defaultKubebuilderControlPlaneStart/StopTimeout too, but I think that's only possible if they become exported.

[edit] ...or with some godoc sorcery, but it means copy-pasting from right below so, hm, not too sure (this is uncommitted):

[mariantalla]

Added a small note on defaults, which now shows up like this. Let me know if it doesn't work and I'll revert that one.

[mariantalla]

👋 Any thoughts on this one?

/assign @DirectXMan12 @pwittrock @droot

[DirectXMan12]

awesome, thanks!

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: DirectXMan12, mariantalla

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 [DirectXMan12]

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