Skip to content

Commit

Permalink
Merge branch 'book-v3' into release-3.10-solve-conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 authored Apr 21, 2023
2 parents 999a75a + 918af6d commit 88fa5f8
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 4 deletions.
2 changes: 0 additions & 2 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@
- [Testing your own plugins](./plugins/testing-plugins.md)
- [Plugins Versioning](./plugins/plugins-versioning.md)

---

[FAQ](./faq.md)

[Appendix: The TODO Landing Page](./TODO.md)
Expand Down
4 changes: 3 additions & 1 deletion docs/book/src/migration/v3vsv4.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,6 @@ This way is more complex, susceptible to errors, and success cannot be assured.
[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
[kb-releases]: https://github.com/kubernetes-sigs/kubebuilder/releases
[standard-go-project]: https://github.com/golang-standards/project-layout

2 changes: 2 additions & 0 deletions docs/book/src/plugins/go-v4-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Kubebuilder will scaffold using the `go/v4` plugin only if specified when initializing the project.
This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2` and `base.go.kubebuilder.io/v4`.

It scaffolds a project template that helps in constructing sets of [controllers][controller-runtime].

It scaffolds boilerplate code to create and design controllers.
Expand Down Expand Up @@ -58,3 +59,4 @@ kubebuilder init --domain tutorial.kubebuilder.io --repo tutorial.kubebuilder.io
[kustomize]: https://github.com/kubernetes-sigs/kustomize
[standard-go-project]: https://github.com/golang-standards/project-layout
[v4-plugin]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/golang/v4

12 changes: 12 additions & 0 deletions docs/book/src/plugins/kustomize-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ the [Migration guide](../migration/v3vsv4.md) to learn how to upgrade your proje

</aside>

<aside class="note warning">
<h1>Deprecated</h1>

The kustomize/v1 plugin is deprecated. If you are using this plugin, it is recommended
to migrate to the kustomize/v2 plugin which uses Kustomize v5 and provides support for
Apple Silicon (M1).

If you are using Golang projects scaffolded with `go/v3` which uses this version please, check
the [Migration guide](../migration/v3vsv4.md) to learn how to upgrade your projects.

</aside>

The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language plugins such as `go/v2` and `go/v3`.
By using the kustomize plugin, you can create your own language plugins and ensure that you will have the same configurations
and features provided by it.
Expand Down
3 changes: 2 additions & 1 deletion docs/book/src/plugins/kustomize-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import (
// You can define that one plugin is composite by 1 or Many others plugins
gov3Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 3},
kustomizecommonv2.Plugin{}, // scaffold the config/ directory and all kustomize files
golangv4.Plugin{}, // Scaffold the Golang files and all that specific for the language e.g. go.mod, apis, controllers
golangv4.Plugin{}, // Scaffold the Golang files and all that specific for the language e.g. go.mod, apis, controllers
)
```

Expand Down Expand Up @@ -113,3 +113,4 @@ The following scaffolds will be created or updated by this plugin:
[kustomize-vars]: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars/
[release-notes-v5]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv5.0.0
[release-notes-v4]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.0.0

0 comments on commit 88fa5f8

Please sign in to comment.