fix testenv docs #2632
fix testenv docs #2632
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
Welcome @shintard! |
k8s-ci-robot
added
needs-ok-to-test
|
Hi @shintard. 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 Once the patch is verified, the new status will be reflected by the 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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: shintard The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
update envtest.md
…to fix-testenv-docs
…to fix-testenv-docs
| However, in the case of M1 Mac using AppleSillicon, the arm64 binary is not yet available, so the test in the Makefile must be changed. | ||
| ```makefile | ||
| test: manifests generate fmt vet envtest ## Run tests. | ||
| KUBEBUILDER_ASSETS="$(shell $(ENVTEST) --arch=amd64 use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out |
There was a problem hiding this comment.
is the amd64 working in the AppleSillicon?
There was a problem hiding this comment.
As you say, there is no kubebuilder-tools supporting darwin/arm64, so using this flag will allow Apple Sillicon to run binaries for intel via Rosseta. (Temporary solution)
There was a problem hiding this comment.
Hi @shintard,
I checked all that is missing for we support the Apple Silicon and I updated the comment: #1932 (comment)
| @@ -72,6 +72,8 @@ make docker-build docker-push IMG=<some-registry>/<project-name>:tag | |||
| make deploy IMG=<some-registry>/<project-name>:tag | |||
| ``` | |||
|
|
|||
| If you are using an Apple Sillicon M1 Mac, you need to follow the instructions [here](/reference/envtest.md#installation). | |||
There was a problem hiding this comment.
the project does not support arm64 yet.
It is not the only place that would need to receive some tweaks to work with probably.
I think for now we could have a FAQ section and then add there the steps/info
WDYT?
There was a problem hiding this comment.
I think it's a very good idea to post this description in the FAQ section!
Can we maintain the documentation that way?
There was a problem hiding this comment.
We have the wish to create the FAQ for too long and we have other things to add.
I think that it is also a nice one to go there.
There was a problem hiding this comment.
Thank you for your contribution 🥇
The goal of this PR is to let users know how to use Kubebuilder with Apple Silicon which is not supported. We have for too long the desire to have a FAQ section, so if we would move forward with IMO that would fit in well under this section.
Also, see here what we need to do support Apple Silicon: #1932 (comment)
- We are unable to build the kubebuilder-tools for darwin/arm64 because we do have not this architecture for etcd. See the issue raised here: ETCD has not been building artefacts for darwin/arm64 to support Apple Silicon etcd-io/etcd#14001
- Also, we have a problem with kustomize. We cannot upgrade the default layout to use kustomize v4 because from v3 to v4 it is a major bump with breaking changes. We will need to have a new kustomize plugin for that see: ✨ add kustomize/v2-alpha plugin to support kustomize versions >= v4 (pinned version 4.5.3) #2583
In this way, if we would like to have this info in the docs, (ihmo) we need to:
a) create the FAQ section
b) add the info on why were are not supporting darwin/arm64 yet. What is done and what is not.
c) we need to fix the PR title accordingly because we use it in the release notes. See the CONTRIBUTION guide : https://github.com/kubernetes-sigs/kubebuilder/blob/master/CONTRIBUTING.md#pr-process
WDYT?
|
Closing this one because asap we have the etcd bin etcd-io/etcd#14001 (comment) and from Kubebuilder 3.5.* release we will be able to have all working on for Apple Silicon |
Description:
I was trying kubebuilder the other day in an Apple Sillicon m1 mac arm64 environment and found that it did not work when run as documented.
From the issues and PR it looks like these issues have been resolved.
I think the documentation needs to be meticulous so as not to discourage first-time users from doing the tutorial.
This is my first commit to kubebuilder, so please let me know if there is anything I can do to help.
Also, if there is anything else in the documentation that you would like to see changed, I will help.
tied issue
Motivation
kubernetes-sigs/controller-runtime#1657
#2516