Skip to content

Commit 1480580

Browse files
📖 fix kustomize-v2 index link and udated info accordingly
1 parent 0fa5740 commit 1480580

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
- [deploy-image/v1-alpha](./plugins/deploy-image-plugin-v1-alpha.md)
125125
- [To be extended for others tools](./plugins/to-be-extended.md)
126126
- [kustomize/v1 (Deprecated)](./plugins/kustomize-v1.md)
127-
- [kustomize/v2-alpha](./plugins/kustomize-v2-alpha.md)
127+
- [kustomize/v2](./plugins/kustomize-v2.md)
128128
- [Extending the CLI](./plugins/extending-cli.md)
129129
- [Creating your own plugins](./plugins/creating-plugins.md)
130130
- [Testing your own plugins](./plugins/testing-plugins.md)

docs/book/src/plugins/kustomize-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Kustomize (kustomize/v1)
1+
# [Deprecated] Kustomize (kustomize/v1)
22

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

docs/book/src/plugins/kustomize-v2.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Kustomize v2
1+
# [Default Scaffold] Kustomize v2
22

3-
The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language base plugin `base.go.kubebuilder.io/v3`.
3+
The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language base plugin `base.go.kubebuilder.io/v4`.
4+
This plugin is used to generate the manifest under `config/` directory for the projects build within the go/v4 plugin (default scaffold).
45

56
Note that projects such as [Operator-sdk][sdk] consume the Kubebuilder project as a lib and provide options to work with other languages
67
like Ansible and Helm. The kustomize plugin allows them to easily keep a maintained configuration and ensure that all languages have
@@ -21,7 +22,7 @@ directory of the Kubebuilder project.
2122

2223
- If you are looking to scaffold the kustomize configuration manifests for your own language plugin
2324
- If you are looking for support on Apple Silicon (`darwin/arm64`). (_Before kustomize `4.x` the binary for this plataform is not provided_)
24-
- If you are looking for to begin to try out the new syntax and features provide by kustomize v5
25+
- If you are looking for to begin to try out the new syntax and features provide by kustomize v4 [(More info)][release-notes-v4] and v5 [(More info)][release-notes-v5]
2526
- If you are NOT looking to build projects which will be used on Kubernetes cluster versions < `1.22` (_The new features provides by kustomize v4 are not officially supported and might not work with kubectl < `1.22`_)
2627
- If you are NOT looking to rely on special URLs in resource fields
2728
- If you want to use [replacements][kustomize-replacements] since [vars][kustomize-vars] are deprecated and might be removed soon
@@ -36,7 +37,7 @@ all that is language specific and kustomize for its configuration, see:
3637
import (
3738
...
3839
kustomizecommonv2alpha "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v2"
39-
golangv3 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3"
40+
golangv4 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v4"
4041
...
4142
)
4243

@@ -45,7 +46,7 @@ import (
4546
// You can define that one plugin is composite by 1 or Many others plugins
4647
gov3Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 3},
4748
kustomizecommonv2.Plugin{}, // scaffold the config/ directory and all kustomize files
48-
golangv3.Plugin{}, // Scaffold the Golang files and all that specific for the language e.g. go.mod, apis, controllers
49+
golangv4.Plugin{}, // Scaffold the Golang files and all that specific for the language e.g. go.mod, apis, controllers
4950
)
5051
```
5152

@@ -98,7 +99,8 @@ The following scaffolds will be created or updated by this plugin:
9899
* Check the kustomize [plugin implementation](https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/common/kustomize)
99100
* Check the [kustomize documentation][kustomize-docs]
100101
* Check the [kustomize repository][kustomize-github]
101-
* To know more about the changes between kustomize v4 and v5 see its [release notes][release-notes]
102+
* Check the [release notes][release-notes-v5] for Kustomize v5.0.0
103+
* Check the [release notes][release-notes-v4] for Kustomuze v4.0.0
102104
* Also, you can compare the `config/` directory between the samples `project-v3` and `project-v4` to check the difference in the syntax of the manifests provided by default
103105

104106
[sdk]:https://github.com/operator-framework/operator-sdk
@@ -109,4 +111,5 @@ The following scaffolds will be created or updated by this plugin:
109111
[kustomize-github]: https://github.com/kubernetes-sigs/kustomize
110112
[kustomize-replacements]: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replacements/
111113
[kustomize-vars]: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars/
112-
[release-notes]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv5.0.0
114+
[release-notes-v5]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv5.0.0
115+
[release-notes-v4]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.0.0

0 commit comments

Comments
 (0)