Merge pull request #3442 from camilamacedo86/deprecate-component-config

⚠️ deprecate component config and no longer able to ensure that it is functioning as intended

Author: k8s-ci-robot

docs/book/src/component-config-tutorial/api-changes.md

@@ -1,5 +1,17 @@
 # Changing things up
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 This tutorial will show you how to create a custom configuration file for your
 project by modifying a project generated with the `--component-config` flag
 passed to the `init` command. The full tutorial's source can be found 

docs/book/src/component-config-tutorial/config-type.md

@@ -1,5 +1,17 @@
 # Adding a new Config Type
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 To scaffold out a new config Kind, we can use `kubebuilder create api`.
 
 ```bash

docs/book/src/component-config-tutorial/custom-type.md

@@ -1,5 +1,17 @@
 # Using a Custom Type
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 <aside class="note warning">
 
 <h1>Built-in vs Custom Type</h1>

docs/book/src/component-config-tutorial/define-config.md

@@ -1,5 +1,17 @@
 # Defining your Config
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 Now that you have a component config base project we need to customize the
 values that are passed into the controller, to do this we can take a look at 
 `config/manager/controller_manager_config.yaml`.

docs/book/src/component-config-tutorial/define-custom-config.md

@@ -1,5 +1,17 @@
 # Defining your Custom Config
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 Now that you have a custom component config we change the 
 `config/manager/controller_manager_config.yaml` to use the new GVK you defined.
 

docs/book/src/component-config-tutorial/tutorial.md

@@ -1,5 +1,17 @@
 # Tutorial: ComponentConfig
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895) 
+Moreover, it has undergone breaking changes and is no longer functioning as intended. 
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature, 
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 Nearly every project that is built for Kubernetes will eventually need to
 support passing in additional configurations into the controller. These could
 be to enable better logging, turn on/off specific feature gates, set the sync

docs/book/src/component-config-tutorial/updating-main.md

@@ -1,5 +1,17 @@
 # Updating main
 
+<aside class="note warning">
+<h1>Component Config is deprecated</h1>
+
+The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0.  [More info](https://github.com/kubernetes-sigs/controller-runtime/issues/895)
+Moreover, it has undergone breaking changes and is no longer functioning as intended.
+As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature,
+no longer guaranteeing its functionality from version 3.11.0 onwards. You can find additional details on this issue [here](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+
+Please, be aware that it will force Kubebuilder remove this option soon in future release.
+
+</aside>
+
 Once you have defined your new custom component config type we need to make
 sure our new config type has been imported and the types are registered with
 the scheme. _If you used `kubebuilder create api` this should have been

test/e2e/v4/generate_test.go

@@ -203,177 +203,6 @@ Count int `+"`"+`json:"count,omitempty"`+"`"+`
 	}
 }
 
-// GenerateV4 implements a go/v4(-alpha) plugin project defined by a TestContext.
-func GenerateV4ComponentConfig(kbc *utils.TestContext) {
-	var err error
-
-	By("initializing a project")
-	err = kbc.Init(
-		"--plugins", "go/v4",
-		"--project-version", "3",
-		"--domain", kbc.Domain,
-		"--component-config=true",
-	)
-	ExpectWithOffset(1, err).NotTo(HaveOccurred())
-
-	By("creating API definition")
-	err = kbc.CreateAPI(
-		"--group", kbc.Group,
-		"--version", kbc.Version,
-		"--kind", kbc.Kind,
-		"--namespaced",
-		"--resource",
-		"--controller",
-		"--make=false",
-	)
-	ExpectWithOffset(1, err).NotTo(HaveOccurred())
-
-	By("implementing the API")
-	ExpectWithOffset(1, pluginutil.InsertCode(
-		filepath.Join(kbc.Dir, "api", kbc.Version, fmt.Sprintf("%s_types.go", strings.ToLower(kbc.Kind))),
-		fmt.Sprintf(`type %sSpec struct {
-`, kbc.Kind),
-		`	// +optional
-Count int `+"`"+`json:"count,omitempty"`+"`"+`
-`)).Should(Succeed())
-
-	By("scaffolding mutating and validating webhooks")
-	err = kbc.CreateWebhook(
-		"--group", kbc.Group,
-		"--version", kbc.Version,
-		"--kind", kbc.Kind,
-		"--defaulting",
-		"--programmatic-validation",
-	)
-	ExpectWithOffset(1, err).NotTo(HaveOccurred())
-
-	By("implementing the mutating and validating webhooks")
-	err = pluginutil.ImplementWebhooks(filepath.Join(
-		kbc.Dir, "api", kbc.Version,
-		fmt.Sprintf("%s_webhook.go", strings.ToLower(kbc.Kind))))
-	ExpectWithOffset(1, err).NotTo(HaveOccurred())
-
-	By("uncomment kustomization.yaml to enable webhook and ca injection")
-	ExpectWithOffset(1, pluginutil.UncommentCode(
-		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		"#- ../webhook", "#")).To(Succeed())
-	ExpectWithOffset(1, pluginutil.UncommentCode(
-		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		"#- ../certmanager", "#")).To(Succeed())
-	ExpectWithOffset(1, pluginutil.UncommentCode(
-		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		"#- ../prometheus", "#")).To(Succeed())
-	ExpectWithOffset(1, pluginutil.UncommentCode(
-		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		"#- manager_webhook_patch.yaml", "#")).To(Succeed())
-	ExpectWithOffset(1, pluginutil.UncommentCode(
-		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		"#- webhookcainjection_patch.yaml", "#")).To(Succeed())
-	ExpectWithOffset(1, pluginutil.UncommentCode(filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
-		`#replacements:
-#  - source: # Add cert-manager annotation to ValidatingWebhookConfiguration, MutatingWebhookConfiguration and CRDs
-#      kind: Certificate
-#      group: cert-manager.io
-#      version: v1
-#      name: serving-cert # this name should match the one in certificate.yaml
-#      fieldPath: .metadata.namespace # namespace of the certificate CR
-#    targets:
-#      - select:
-#          kind: ValidatingWebhookConfiguration
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 0
-#          create: true
-#      - select:
-#          kind: MutatingWebhookConfiguration
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 0
-#          create: true
-#      - select:
-#          kind: CustomResourceDefinition
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 0
-#          create: true
-#  - source:
-#      kind: Certificate
-#      group: cert-manager.io
-#      version: v1
-#      name: serving-cert # this name should match the one in certificate.yaml
-#      fieldPath: .metadata.name
-#    targets:
-#      - select:
-#          kind: ValidatingWebhookConfiguration
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 1
-#          create: true
-#      - select:
-#          kind: MutatingWebhookConfiguration
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 1
-#          create: true
-#      - select:
-#          kind: CustomResourceDefinition
-#        fieldPaths:
-#          - .metadata.annotations.[cert-manager.io/inject-ca-from]
-#        options:
-#          delimiter: '/'
-#          index: 1
-#          create: true
-#  - source: # Add cert-manager annotation to the webhook Service
-#      kind: Service
-#      version: v1
-#      name: webhook-service
-#      fieldPath: .metadata.name # namespace of the service
-#    targets:
-#      - select:
-#          kind: Certificate
-#          group: cert-manager.io
-#          version: v1
-#        fieldPaths:
-#          - .spec.dnsNames.0
-#          - .spec.dnsNames.1
-#        options:
-#          delimiter: '.'
-#          index: 0
-#          create: true
-#  - source:
-#      kind: Service
-#      version: v1
-#      name: webhook-service
-#      fieldPath: .metadata.namespace # namespace of the service
-#    targets:
-#      - select:
-#          kind: Certificate
-#          group: cert-manager.io
-#          version: v1
-#        fieldPaths:
-#          - .spec.dnsNames.0
-#          - .spec.dnsNames.1
-#        options:
-#          delimiter: '.'
-#          index: 1
-#          create: true`, "#")).To(Succeed())
-
-	if kbc.IsRestricted {
-		By("uncomment kustomize files to ensure that pods are restricted")
-		uncommentPodStandards(kbc)
-	}
-}
-
 func uncommentPodStandards(kbc *utils.TestContext) {
 	configManager := filepath.Join(kbc.Dir, "config", "manager", "manager.yaml")
 

test/e2e/v4/plugin_cluster_test.go

@@ -87,13 +87,6 @@ var _ = Describe("kubebuilder", func() {
 			GenerateV4(kbc)
 			Run(kbc)
 		})
-
-		It("should generate a runnable project"+
-			" with restricted pods and with --component-config field enabled", func() {
-			kbc.IsRestricted = true
-			GenerateV4ComponentConfig(kbc)
-			Run(kbc)
-		})
 	})
 })
 

test/testdata/generate.sh

@@ -136,6 +136,5 @@ scaffold_test_project project-v3 --plugins="go/v3"
 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-config --component-config --plugins="go/v4"
 scaffold_test_project project-v4-with-deploy-image --plugins="go/v4"
 scaffold_test_project project-v4-with-grafana --plugins="go/v4"