-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
:sparkling: (go/v4-alpha) new alpha plugin using kustomize v4 (add su…
…pport for Apple Silicon)
- Loading branch information
1 parent
dda4b5f
commit a5dcd3a
Showing
458 changed files
with
17,765 additions
and
612 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# go/v4-alpha (go.kubebuilder.io/v4-alpha) | ||
|
||
Kubebuilder tool will scaffold the go/v4-alpha plugin only if ask for it when you create the project. | ||
This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v2-alpha` and `base.go.kubebuilder.io/v3`. | ||
By using it you can scaffold a project which is a helper to construct sets of [controllers][controller-runtime]. | ||
|
||
It basically scaffolds all the boilerplate code required to create and design controllers. | ||
Note that by following the [quickstart][quickstart] you will be using this plugin. | ||
<aside class="note"> | ||
|
||
<h1>Examples</h1> | ||
|
||
You can check samples using this plugin by looking at the `project-v4-<options>` projects | ||
under the [testdata][testdata] directory on the root directory of the Kubebuilder project. | ||
|
||
</aside> | ||
|
||
## When to use it ? | ||
|
||
- If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime] | ||
- If you are looking to experiment the future default scaffold that will be provided by Kubebuilder CLI | ||
- If your local enviroment is Apple Silicon (`darwin/arm64`) | ||
- If you are looking to use [kubernetes-sigs/kustomize][kustomize] v4 | ||
|
||
## How to use it ? | ||
|
||
To create a new project with the `go/v4-alpha` plugin the following command can be used: | ||
|
||
```sh | ||
kubebuilder init --domain tutorial.kubebuilder.io --repo tutorial.kubebuilder.io/project --plugins=v4-alpha | ||
``` | ||
|
||
## Subcommands supported by the plugin | ||
|
||
- Init - `kubebuilder init [OPTIONS]` | ||
- Edit - `kubebuilder edit [OPTIONS]` | ||
- Create API - `kubebuilder create api [OPTIONS]` | ||
- Create Webhook - `kubebuilder create webhook [OPTIONS]` | ||
|
||
## Further resources | ||
|
||
- To check how plugins are composited by looking at this definition in the [main.go][plugins-main]. | ||
- Check the code implementation of the [base Golang plugin `base.go.kubebuilder.io/v3`][v3-plugin]. | ||
- Check the code implementation of the [Kustomize/v2-alpha plugin][kustomize-plugin]. | ||
- Check [controller-runtime][controller-runtime] to know more about controllers. | ||
|
||
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime | ||
[quickstart]: ../quick-start.md | ||
[testdata]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/testdata | ||
[plugins-main]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/cmd/main.go | ||
[kustomize-plugin]: ../plugins/kustomize-v2-alpha.md | ||
[kustomize]: https://github.com/kubernetes-sigs/kustomize |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.