Skip to content

fix testenv docs #2632

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

Closed
wants to merge 7 commits into from
Closed

fix testenv docs #2632

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cd7ef92
fix docs
shintaoku Apr 23, 2022
88f9e58
update envtest.md
shintaoku Apr 23, 2022
f44622c
update running.md
shintaoku Apr 23, 2022
d25e5f4
update running.md
shintaoku Apr 23, 2022
52120b4
Merge branch 'fix-testenv-docs' of github.com:shintard/kubebuilder in…
shintaoku Apr 23, 2022
d073346
fix docs
shintaoku Apr 23, 2022
b0cb2e1
Merge branch 'fix-testenv-docs' of github.com:shintard/kubebuilder in…
shintaoku Apr 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix docs
  • Loading branch information
@shintaoku
shintaoku committed Apr 23, 2022
commit d07334602b1cc7f9042fc4511a6ac6b6c777a75a
2 changes: 2 additions & 0 deletions docs/book/src/cronjob-tutorial/running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Member

@camilamacedo86 camilamacedo86 Apr 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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?

Copy link
Author

@shintaoku shintaoku Apr 27, 2022

Choose a reason for hiding this comment

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

I think it's a very good idea to post this description in the FAQ section!
Can we maintain the documentation that way?

Copy link
Member

@camilamacedo86 camilamacedo86 Apr 28, 2022

Choose a reason for hiding this comment

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

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.


<aside class="note">
<h1>registry permission</h1>

Expand Down
8 changes: 8 additions & 0 deletions docs/book/src/reference/envtest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ export K8S_VERSION=1.21.2
curl -sSLo envtest-bins.tar.gz "https://go.kubebuilder.io/test-tools/${K8S_VERSION}/$(go env GOOS)/$(go env GOARCH)"
```

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
Copy link
Member

@camilamacedo86 camilamacedo86 Apr 25, 2022

Choose a reason for hiding this comment

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

is the amd64 working in the AppleSillicon?

Copy link
Author

@shintaoku shintaoku Apr 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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)

Copy link
Member

@camilamacedo86 camilamacedo86 May 5, 2022

Choose a reason for hiding this comment

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

Hi @shintard,

I checked all that is missing for we support the Apple Silicon and I updated the comment: #1932 (comment)

```

This way, you can use intel binaries. downloaded intel binaries are executed via Rosseta2.

Then install them:

```sh
Expand Down