⚠️ adds deprecation of declarative plugin

kubernetes-sigs · Aug 26, 2023 · 70d3f3c · 70d3f3c
1 parent 226f160
commit 70d3f3c
Show file tree

Hide file tree

Showing 64 changed files with 38 additions and 2,580 deletions.
diff --git a/docs/book/src/plugins/declarative-v1.md b/docs/book/src/plugins/declarative-v1.md
@@ -1,4 +1,18 @@
-# Declarative Plugin
+# [Deprecated] Declarative Plugin
+
+<aside class="note warning">
+<h1>Notice of Deprecation</h1>
+
+The Declarative plugin is an implementation derived from the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project. 
+As the project maintainers possess the most comprehensive knowledge about its changes and Kubebuilder allows 
+the creation of custom plugins using its library, it has been decided that this plugin will be better 
+maintained within the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project itself, 
+which falls under its domain of responsibility. This decision aims to improve the maintainability of both the 
+plugin and Kubebuilder, ultimately providing an enhanced user experience. To follow up on this work, please refer 
+to [Issue #293](https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/issues/293) in the 
+kubebuilder-declarative-pattern repository.
+
+</aside>
 
 The declarative plugin allows you to create [controllers][controller-runtime] using the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern].
 By using the declarative plugin, you can make the required changes on top of what is scaffolded by default when you create a Go project with Kubebuilder and the Golang plugins (i.e. go/v2, go/v3).

diff --git a/docs/book/src/plugins/to-add-optional-features.md b/docs/book/src/plugins/to-add-optional-features.md
@@ -2,8 +2,8 @@
 
 The following plugins are useful to generate code and take advantage of optional features
 
-| Plugin                                                                             | Key                  | Description                                                                                                                                                                                                                                  |
-| ---------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [declarative.go.kubebuilder.io/v1](declarative-v1.md)                              | `declarative/v1`     | Optional plugin used to scaffold APIs/controllers using the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project.                                                                                                      |
-| [grafana.kubebuilder.io/v1-alpha](grafana-v1-alpha.md)                             | `grafana/v1-alpha`   | Optional helper plugin which can be used to scaffold Grafana Manifests Dashboards for the default metrics which are exported by controller-runtime.                                                                                                 |
-| [deploy-image.go.kubebuilder.io/v1-alpha](deploy-image-plugin-v1-alpha)            | `deploy-image/v1-alpha`   | Optional helper plugin which can be used to scaffold APIs and controller with code implementation to Deploy and Manage an Operand(image).                                                                                                 |
+| Plugin                                                                  | Key                  | Description                                                                                                                                                                                                                                  |
+|-------------------------------------------------------------------------| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [declarative.go.kubebuilder.io/v1 - (Deprecated) ](declarative-v1.md)   | `declarative/v1`     | Optional plugin used to scaffold APIs/controllers using the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project.                                                                                                      |
+| [grafana.kubebuilder.io/v1-alpha](grafana-v1-alpha.md)                  | `grafana/v1-alpha`   | Optional helper plugin which can be used to scaffold Grafana Manifests Dashboards for the default metrics which are exported by controller-runtime.                                                                                                 |
+| [deploy-image.go.kubebuilder.io/v1-alpha](deploy-image-plugin-v1-alpha) | `deploy-image/v1-alpha`   | Optional helper plugin which can be used to scaffold APIs and controller with code implementation to Deploy and Manage an Operand(image).                                                                                                 |
diff --git a/pkg/plugins/golang/declarative/v1/plugin.go b/pkg/plugins/golang/declarative/v1/plugin.go
@@ -14,6 +14,15 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Deprecated: The declarative plugin has been deprecated.
+// The Declarative plugin is an implementation derived from the kubebuilder-declarative-pattern project.
+// As the project maintainers possess the most comprehensive knowledge about its changes and Kubebuilder
+// allows the creation of custom plugins using its library, it has been decided that this plugin will be
+// better maintained within the kubebuilder-declarative-pattern project
+// itself, which falls under its domain of responsibility. This decision aims to improve the maintainability
+// of both the plugin and Kubebuilder, ultimately providing an enhanced user experience.
+// To follow up on this work, please refer to the Issue #293:
+// https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/issues/293.
 package v1
 
 import (
@@ -61,5 +70,13 @@ type pluginConfig struct {
 }
 
 func (p Plugin) DeprecationWarning() string {
-	return ""
+	return "The declarative plugin has been deprecated. \n" +
+		"The Declarative plugin is an implementation derived from the kubebuilder-declarative-pattern project. " +
+		"As the project maintainers possess the most comprehensive knowledge about its changes and Kubebuilder " +
+		"allows the creation of custom plugins using its library, it has been decided that this plugin will be  " +
+		"better maintained within the kubebuilder-declarative-pattern project " +
+		"itself, which falls under its domain of responsibility. This decision aims to improve the maintainability " +
+		"of both the plugin and Kubebuilder, ultimately providing an enhanced user experience." +
+		"To follow up on this work, please refer to the Issue #293: " +
+		"https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/issues/293."
 }
diff --git a/test/testdata/generate.sh b/test/testdata/generate.sh
@@ -102,11 +102,6 @@ function scaffold_test_project {
       $kb create api --version v1 --kind Lakers --controller=true --resource=true --make=false
       $kb create webhook --version v1 --kind Lakers --defaulting --programmatic-validation
     fi
-  elif [[ $project =~ declarative ]]; then
-    header_text 'Creating APIs ...'
-    $kb create api --group crew --version v1 --kind Captain --controller=true --resource=true --make=false
-    $kb create api --group crew --version v1 --kind FirstMate --controller=true --resource=true --make=false
-    $kb create api --group crew --version v1 --kind Admiral --controller=true --resource=true --namespaced=false --make=false
   elif [[ $project =~ deploy-image ]]; then
       header_text 'Creating Memcached API with deploy-image plugin ...'
       $kb create api --group example.com --version v1alpha1 --kind Memcached --image=memcached:1.4.36-alpine --image-container-command="memcached,-m=64,-o,modern,-v" --image-container-port="11211" --run-as-user="1001" --plugins="deploy-image/v1-alpha" --make=false
@@ -135,6 +130,5 @@ scaffold_test_project project-v3 --plugins="go/v3"
 # [Currently, default CLI plugin] - [Next version, alpha] Project version v4-alpha
 scaffold_test_project project-v4 --plugins="go/v4"
 scaffold_test_project project-v4-multigroup --plugins="go/v4"
-scaffold_test_project project-v4-declarative-v1 --plugins="go/v4,declarative"
 scaffold_test_project project-v4-with-deploy-image --plugins="go/v4"
 scaffold_test_project project-v4-with-grafana --plugins="go/v4"
diff --git a/test/testdata/test.sh b/test/testdata/test.sh
@@ -33,6 +33,5 @@ build_kb
 # Project version v4-alpha
 test_project project-v4
 test_project project-v4-multigroup
-test_project project-v4-declarative-v1
 test_project project-v4-with-deploy-image
 test_project project-v4-with-grafana
diff --git a/testdata/project-v4-declarative-v1/.dockerignore b/testdata/project-v4-declarative-v1/.dockerignore
diff --git a/testdata/project-v4-declarative-v1/.gitignore b/testdata/project-v4-declarative-v1/.gitignore
diff --git a/testdata/project-v4-declarative-v1/Dockerfile b/testdata/project-v4-declarative-v1/Dockerfile
diff --git a/testdata/project-v4-declarative-v1/PROJECT b/testdata/project-v4-declarative-v1/PROJECT
diff --git a/testdata/project-v4-declarative-v1/README.md b/testdata/project-v4-declarative-v1/README.md