Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

⚠️ (kustomize/v1) deprecated v1 version in favor of v2 #3235

Merged
merged 7 commits into from
Feb 21, 2023
Merged

⚠️ (kustomize/v1) deprecated v1 version in favor of v2 #3235

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9254479
:warning: deprecated kustomize/v1 plugin
camilamacedo86 Feb 19, 2023
881d91c
Update docs/book/src/plugins/kustomize-v1.md
camilamacedo86 Feb 20, 2023
e633807
Update docs/book/src/plugins/kustomize-v1.md
camilamacedo86 Feb 20, 2023
5e1159a
Update docs/book/src/plugins/to-be-extended.md
camilamacedo86 Feb 20, 2023
4524257
Update docs/book/src/plugins/to-be-extended.md
camilamacedo86 Feb 20, 2023
efaba32
Update pkg/plugins/common/kustomize/v1/plugin.go
camilamacedo86 Feb 20, 2023
ba2cdaa
Update docs/book/src/plugins/to-be-extended.md
camilamacedo86 Feb 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 12 additions & 0 deletions docs/book/src/plugins/kustomize-v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/book/src/plugins/to-be-extended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](kustomize-v1.md) | `kustomize/v1 (Deprecated)` | 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`). |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit ```suggestion
| kustomize.common.kubebuilder.io/v1 | 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`). |

camilamacedo86 marked this conversation as resolved.
Show resolved Hide resolved
| [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. |
camilamacedo86 marked this conversation as resolved.
Show resolved Hide resolved
| `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`) |
camilamacedo86 marked this conversation as resolved.
Show resolved Hide resolved
| `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
Expand Down
5 changes: 5 additions & 0 deletions pkg/plugins/common/kustomize/v1/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 version, v3x. Please, upgrade your project to use go/v4 and kustomize/v2 plugin versions."
camilamacedo86 marked this conversation as resolved.
Show resolved Hide resolved
}