Skip to content
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

Jump to bottom

📖 fix migration guide after go/v4 stabilization and links #3344

Merged
merged 1 commit into from
Apr 21, 2023
Merged

📖 fix migration guide after go/v4 stabilization and links #3344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 5 additions & 22 deletions docs/book/src/migration/v3vsv4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ Further details can be found in the [go/v4 plugin section][go/v4-doc]

**_More details on this can be found at [here][kb-releases], but for the highlights, check below_**

<aside class="note">
<h1>Default plugin</h1>
Projects scaffolded with Kubebuilder v3 release still using the `go.kubebuilder.io/v3` plugin by default.

</aside>

<aside class="note warning">
<h1>Project customizations</h1>

Expand All @@ -55,21 +49,6 @@ If you want to upgrade your scaffolding to use the latest and greatest features
which will cover the steps in the most straightforward way to allow you to upgrade your project to get all
latest changes and improvements.

<aside class="note warning">
<h1> Apple Silicon (M1) </h1>

The current scaffold done by the CLI (`go/v3`) uses [kubernetes-sigs/kustomize][kustomize] v3 which does not provide
a valid binary for Apple Silicon (`darwin/arm64`). Therefore, you can use the `go/v4` plugin
instead which provides support for this platform:

```bash
kubebuilder init --domain my.domain --repo my.domain/guestbook --plugins=go/v4
```

**Note**: The `go/v4` plugin is an unstable version and can have breaking changes in future releases.

</aside>

- [Migration Guide go/v3 to go/v4][migration-guide-gov3-to-gov4] **(Recommended)**

### By updating the files manually
Expand All @@ -88,4 +67,8 @@ This way is more complex, susceptible to errors, and success cannot be assured.
[go/v4-doc]: ./../plugins/go-v4-plugin.md
[migration-guide-gov3-to-gov4]: migration_guide_gov3_to_gov4.md
[manually-upgrade]: manually_migration_guide_gov3_to_gov4.md
[standard-go-project]: https://github.com/golang-standards/project-layout
[standard-go-project]: https://github.com/golang-standards/project-layout
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
[controller-tools]: https://github.com/kubernetes-sigs/controller-tools
[kustomize-release]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv5.0.0
[kb-releases]: https://github.com/kubernetes-sigs/kubebuilder/releases