⚠️ (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 <everettraven@gmail.com> * Update docs/book/src/plugins/kustomize-v1.md Co-authored-by: Bryce Palmer <everettraven@gmail.com> * Update docs/book/src/plugins/to-be-extended.md * Update docs/book/src/plugins/to-be-extended.md Co-authored-by: Varsha <varshaprasad96@gmail.com> * Update pkg/plugins/common/kustomize/v1/plugin.go Co-authored-by: Bryce Palmer <everettraven@gmail.com> * Update docs/book/src/plugins/to-be-extended.md Co-authored-by: Varsha <varshaprasad96@gmail.com> --------- Co-authored-by: Bryce Palmer <everettraven@gmail.com> Co-authored-by: Varsha <varshaprasad96@gmail.com>
kubernetes-sigs · Feb 21, 2023 · 751e268 · 751e268
1 parent a2a7659
commit 751e268
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 7 deletions.
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -123,7 +123,7 @@
       - [grafana/v1-alpha](./plugins/grafana-v1-alpha.md)
       - [deploy-image/v1-alpha](./plugins/deploy-image-plugin-v1-alpha.md)
     - [To be extended for others tools](./plugins/to-be-extended.md)
-      - [kustomize/v1](./plugins/kustomize-v1.md)
+      - [kustomize/v1 (Deprecated)](./plugins/kustomize-v1.md)
       - [kustomize/v2-alpha](./plugins/kustomize-v2-alpha.md)
   - [Extending the CLI](./plugins/extending-cli.md)
   - [Creating your own plugins](./plugins/creating-plugins.md)

diff --git a/docs/book/src/plugins/kustomize-v1.md b/docs/book/src/plugins/kustomize-v1.md
@@ -1,5 +1,17 @@
 # Kustomize (kustomize/v1)
 
+<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. 

diff --git a/docs/book/src/plugins/to-be-extended.md b/docs/book/src/plugins/to-be-extended.md
@@ -13,12 +13,12 @@ the base language plugins which are responsible for to scaffold the Golang files
 another languages (i.e. [Operator-SDK][sdk] does to allow users work with Ansible/Helm) or to add
 helpers on top, such as [Operator-SDK][sdk] does to add their features to integrate the projects with [OLM][olm].
 
-| Plugin                                                                             | Key                  | Description                                                                                                                                                                                                                                  |
-| ---------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [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`).                    |
-| [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. |
-| `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`)                                                                                                     |
-| `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`)                                                                                     |
+| Plugin                                                                             | Key                         | Description                                                                                                                                                                                                                                  |
+| ---------------------------------------------------------------------------------- |-----------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [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`). |
+| [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. |
+| `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`)                                                                                                     |
+| `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`)                                                                                     |
 
 [create-plugins]: creating-plugins.md
 [kubebuilder-declarative-pattern]: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern

diff --git a/pkg/plugins/common/kustomize/v1/plugin.go b/pkg/plugins/common/kustomize/v1/plugin.go
@@ -65,3 +65,8 @@ func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand { return &p.
 func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand {
 	return &p.createWebhookSubcommand
 }
+
+func (p Plugin) DeprecationWarning() string {
+	return "This version is deprecated.The kustomize/v1 plugin used within go/v3 projects uses an old version " +
+		"of kustomize (v3). It is recommended that you upgrade your project to use the go/v4 and kustomize/v2 plugins."
+}