Add instructions for setting up envtest

[fgiloux]

Signed-off-by: Frederic Giloux [email protected]

Description of the change:

Added instructions for installing envtest, mainly a link to controller-runtime documentation.

Motivation for the change:

The first instruction $ make test fails when envtest is not available.

Reviewer Checklist

• Docs updated or added to /doc
• Commit messages sensible and descriptive

[openshift-ci]

Hi @fgiloux. Thanks for your PR.

I'm waiting for a operator-framework 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.

[fgiloux]

Also changed the instruction for go version. Recommending looking at go.mod instead of using v1.9

[njhale]

/ok-to-test

[njhale]

So the make unit target has a prereq that ensures kubebuilder is installed. make test seems to be vestigial/unused. I'd be interested in merging the two and incorporating some of the envtest changes here as part of the Makefile directly.

(see

operator-lifecycle-manager/Makefile

Line 50 in 40b8b71

kubebuilder:

)

[njhale]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fgiloux, njhale

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

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

[timflannagan]

/lgtm

[fgiloux]

So the make unit target has a prereq that ensures kubebuilder is installed. make test seems to be vestigial/unused. I'd be interested in merging the two and incorporating some of the envtest changes here as part of the Makefile directly.

(see

operator-lifecycle-manager/Makefile

Line 50 in 40b8b71

kubebuilder:

)

@njhale it seems that there are more things than what I expected. If I understand it properly now:

1. document the use of make unit instead of make test
2. amend Makefile and merge make unit and make test
3. document the installation of envtest (the purpose of this PR). In this regard you have "kubebuilder" in the doc and in the Makefile as prerequisite but I only see the use of envtest. Am I missing something? If not the Makefile should point to the instructions for envtest installation and the kubebuilder check could be removed (keeping only api and etcd):

# ifeq (, $(wildcard $(KUBEBUILDER_ASSETS)/kubebuilder))
#       $(error kubebuilder $(KUBEBUILDER_ASSETS_ERR))
# endif

In regards to 2. I am not sure exactly of the options you need to keep so that I would rather let it to you. Let me know how you want to proceed.

[timflannagan]

Just a quick note: our current workflow setup of skipping markdown-only PRs doesn't work well with required branch protection checks so despite the requisite labels being present, tide can't merge this due to those defined protection rules. I took a stab at fixing this in #2500.

[timflannagan]

(just recycling the checks as we should've merged the update to the workflows to they don't block tide from merging markdown-only PRs)

[openshift-bot]

/retest-required

Please review the full test history for this PR and help us cut down flakes.

[openshift-bot]

/retest-required

Please review the full test history for this PR and help us cut down flakes.

[openshift-bot]

/retest-required

Please review the full test history for this PR and help us cut down flakes.