Skip to content

Commit 751e268

Browse files
camilamacedo86everettravenvarshaprasad96
authored
⚠️ (kustomize/v1) deprecated v1 version in favor of v2 (#3235)
* ⚠️ deprecated kustomize/v1 plugin * Update docs/book/src/plugins/kustomize-v1.md Co-authored-by: Bryce Palmer <[email protected]> * Update docs/book/src/plugins/kustomize-v1.md Co-authored-by: Bryce Palmer <[email protected]> * Update docs/book/src/plugins/to-be-extended.md * Update docs/book/src/plugins/to-be-extended.md Co-authored-by: Varsha <[email protected]> * Update pkg/plugins/common/kustomize/v1/plugin.go Co-authored-by: Bryce Palmer <[email protected]> * Update docs/book/src/plugins/to-be-extended.md Co-authored-by: Varsha <[email protected]> --------- Co-authored-by: Bryce Palmer <[email protected]> Co-authored-by: Varsha <[email protected]>
1 parent a2a7659 commit 751e268

File tree

4 files changed

+24
-7
lines changed

4 files changed

+24
-7
lines changed

docs/book/src/SUMMARY.md

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

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Kustomize (kustomize/v1)
22

3+
<aside class="note warning">
4+
<h1>Deprecated</h1>
5+
6+
The kustomize/v1 plugin is deprecated. If you are using this plugin, it is recommended
7+
to migrate to the kustomize/v2 plugin which uses Kustomize v5 and provides support for
8+
Apple Silicon (M1).
9+
10+
If you are using Golang projects scaffolded with `go/v3` which uses this version please, check
11+
the [Migration guide](../migration/v3vsv4.md) to learn how to upgrade your projects.
12+
13+
</aside>
14+
315
The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language plugins such as `go/v2` and `go/v3`.
416
By using the kustomize plugin, you can create your own language plugins and ensure that you will have the same configurations
517
and features provided by it.

docs/book/src/plugins/to-be-extended.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ the base language plugins which are responsible for to scaffold the Golang files
1313
another languages (i.e. [Operator-SDK][sdk] does to allow users work with Ansible/Helm) or to add
1414
helpers on top, such as [Operator-SDK][sdk] does to add their features to integrate the projects with [OLM][olm].
1515

16-
| Plugin | Key | Description |
17-
| ---------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18-
| [kustomize.common.kubebuilder.io/v1](kustomize-v1.md) | `kustomize/v1` | Responsible for scaffold all manifests to configure the projects with [kustomize(v3)][kustomize]. (create and update the `config/` directory). This plugin is used in the composition to create the plugin (`go/v3`). |
19-
| [kustomize.common.kubebuilder.io/v2-alpha](kustomize-v2-alpha.md) | `kustomize/v2-alpha` | It has the same purpose of `kustomize/v1`. However, it works with [kustomize][kustomize] version `v4` and addresses the required changes for future kustomize configurations. It will probably be used with the future `go/v4-alpha` plugin. |
20-
| `base.go.kubebuilder.io/v3` | `base/v3` | Responsible for scaffold all files which specific requires Golang. This plugin is used in the composition to create the plugin (`go/v3`) |
21-
| `base.go.kubebuilder.io/v4-alpha` | `base/v3-alpha` | Responsible for scaffolding all files which specifically requires Golang. This plugin is used in the composition to create the plugin (`go/v4-alpha`) |
16+
| Plugin | Key | Description |
17+
| ---------------------------------------------------------------------------------- |-----------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| [kustomize.common.kubebuilder.io/v1](https://github.com/kubernetes-sigs/kubebuilder/pull/3235/kustomize-v1.md) | kustomize/v1 (Deprecated) | Responsible for scaffolding all manifests to configure projects with [kustomize(v3)][kustomize]. (create and update the `config/` directory). This plugin is used in the composition to create the plugin (`go/v3`). |
19+
| [kustomize.common.kubebuilder.io/v2-alpha](kustomize-v2-alpha.md) | `kustomize/v2-alpha` | It has the same purpose as of `kustomize/v1`. However, it works with [kustomize][kustomize] version `v4` and addresses the required changes for future kustomize configurations. It will probably be used with the future `go/v4-alpha` plugin. |
20+
| `base.go.kubebuilder.io/v3` | `base/v3` | Responsible for scaffolding all files that specifically require Golang. This plugin is used in composition to create the plugin (`go/v3`) |
21+
| `base.go.kubebuilder.io/v4-alpha` | `base/v3-alpha` | Responsible for scaffolding all files which specifically requires Golang. This plugin is used in the composition to create the plugin (`go/v4-alpha`) |
2222

2323
[create-plugins]: creating-plugins.md
2424
[kubebuilder-declarative-pattern]: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern

pkg/plugins/common/kustomize/v1/plugin.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,8 @@ func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand { return &p.
6565
func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand {
6666
return &p.createWebhookSubcommand
6767
}
68+
69+
func (p Plugin) DeprecationWarning() string {
70+
return "This version is deprecated.The kustomize/v1 plugin used within go/v3 projects uses an old version " +
71+
"of kustomize (v3). It is recommended that you upgrade your project to use the go/v4 and kustomize/v2 plugins."
72+
}

0 commit comments

Comments
 (0)