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

camilamacedo86 · 2023-06-09T10:59:16Z

Description

The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0. More info
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.

Please, be aware that it will force Kubebuilder remove this option in soon future release.

Motivation

Bump Controller Runtime v0.15.0 and add support for k8s 1.27

kkkkun · 2023-06-09T13:06:26Z

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"


Should we change this to scaffold_test_project project-v4-config --plugins="go/v4" ? Just remove component-config

this line scaffolds the sample under testdata with component config
So we are just removing here since we no longer need this scaffold

kkkkun

LGTM

kkkkun · 2023-06-09T13:19:37Z

Hope to confirm again @Kavinjsir @varshaprasad96

varshaprasad96

The changes look good to me. But, we may also have to deprecate/remove the following:

Setting of component config flag:

kubebuilder/pkg/config/v3/config.go

Line 163 in 81f65c2

func (c *cfg) SetComponentConfig() error {

Remove the option for setting the flag in kustomize plugin:

kubebuilder/pkg/plugins/common/kustomize/v1/init.go

Line 76 in 81f65c2

fs.BoolVar(&p.componentConfig, "component-config", false,

and

kubebuilder/pkg/plugins/common/kustomize/v1/init.go

Lines 103 to 107 in 81f65c2

    
           if p.componentConfig { 
        
           	if err := p.config.SetComponentConfig(); err != nil { 
        
           		return err 
        
           	} 
        
           }

varshaprasad96 · 2023-06-09T15:50:29Z

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

+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 in soon future release.


Suggested change

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 in soon future release.

The `ComponentConfig` feature has been deprecated in the controller-Runtime since its version of 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 Controller Runtime, has also deprecated this feature, and no longer guarantees to have its functionality from version 3.11.0 and above. You can find additional details on this [issue](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).

Please be aware that it will force Kubebuilder to remove this option in future release if controller-runtime decides to not support it further.

Instead of using component-config, the [`Options`](https://github.com/kubernetes-sigs/controller-runtime/blob/e54088c8c7da82111b4508bdaf189c45d1344f00/pkg/manager/manager.go#L100) can be passed directly to the manager like below:

```go

mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), manager.Options{

Scheme: scheme,

Controller: config.Controller{

NeedLeaderElection: pointer.Bool(true),

MaxConcurrentReconciles: 2,

...

},

})

The alternative is straight forward, hence added it here. It would be helpful to provide another approach if we are deprecating this one.

@varshaprasad96 but the idea of the ComponentConfig is we are able to have an option to deploy the same solution (same code) with different config options per env. So, if we pass direct the Options in the manager (default behaviour) then it does not achieve the same goal. Right?

Therefore, should we really say that?

Since passing of the configuration options through the config file s removed, the next alternative for it to pass it through manager.Options. The idea is letting the user pass all customizable options through manager instead of config file. Which is why it is the alternative to what we have currently.

We need not block this PR for the docs update, I can add that in a follow up.

varshaprasad96 · 2023-06-09T15:51:57Z

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

+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 in soon future release.


Suggested change

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 in soon future release.

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 releases.

varshaprasad96 · 2023-06-09T15:52:22Z

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

+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 in soon future release.


Nit

Suggested change

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 in soon future release.

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 releases.

varshaprasad96 · 2023-06-09T15:52:54Z

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

+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 in soon future release.


Suggested change

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 in soon future release.

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 releases.

… functioning as intended

varshaprasad96

/lgtm
/approve

k8s-ci-robot · 2023-06-12T15:25:42Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, kkkkun, varshaprasad96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86,varshaprasad96]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 9, 2023

k8s-ci-robot requested review from everettraven and rashmigottipati June 9, 2023 10:59

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 9, 2023

camilamacedo86 requested review from Kavinjsir and varshaprasad96 June 9, 2023 10:59

camilamacedo86 force-pushed the deprecate-component-config branch from 2c0d6b6 to ae3d30e Compare June 9, 2023 11:09

camilamacedo86 closed this Jun 9, 2023

camilamacedo86 reopened this Jun 9, 2023

kubernetes-sigs deleted a comment from k8s-ci-robot Jun 9, 2023

camilamacedo86 force-pushed the deprecate-component-config branch from ae3d30e to b097026 Compare June 9, 2023 11:18

camilamacedo86 mentioned this pull request Jun 9, 2023

✨ bump controller-runtime to v0.15.0 #3421

Closed

kkkkun reviewed Jun 9, 2023

View reviewed changes

camilamacedo86 requested a review from kkkkun June 9, 2023 13:10

kkkkun approved these changes Jun 9, 2023

View reviewed changes

varshaprasad96 reviewed Jun 9, 2023

View reviewed changes

⚠️ deprecate component config and no longer able to ensure that it is…

da3322d

… functioning as intended

camilamacedo86 force-pushed the deprecate-component-config branch from b097026 to da3322d Compare June 12, 2023 15:07

camilamacedo86 mentioned this pull request Jun 12, 2023

✨ bump controller-runtime and K8s 1.27 #3444

Merged

varshaprasad96 approved these changes Jun 12, 2023

View reviewed changes

k8s-ci-robot assigned varshaprasad96 Jun 12, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 12, 2023

k8s-ci-robot merged commit d6c34bc into kubernetes-sigs:master Jun 12, 2023
17 checks passed

This was referenced Jun 14, 2023

✨ deprecate flag component-config #3023

Closed

Meta - ComponentConfig scaffolds should not be done by default #2782

Closed

varshaprasad96 mentioned this pull request Jun 14, 2023

Update Kubebuilder documentation with steps to add custom configurations #3457

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

camilamacedo86 commented Jun 9, 2023

kkkkun Jun 9, 2023

camilamacedo86 Jun 9, 2023

kkkkun Jun 9, 2023

kkkkun left a comment

kkkkun commented Jun 9, 2023 •

edited

varshaprasad96 left a comment

varshaprasad96 Jun 9, 2023

varshaprasad96 Jun 9, 2023

camilamacedo86 Jun 10, 2023

varshaprasad96 Jun 12, 2023

varshaprasad96 Jun 9, 2023

varshaprasad96 Jun 9, 2023

varshaprasad96 Jun 9, 2023

varshaprasad96 left a comment

k8s-ci-robot commented Jun 12, 2023

	if p.componentConfig {
	if err := p.config.SetComponentConfig(); err != nil {
	return err
	}
	}

-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 in soon future release.
+The `ComponentConfig` feature has been deprecated in the controller-Runtime since its version of 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 Controller Runtime, has also deprecated this feature, and no longer guarantees to have its functionality from version 3.11.0 and above. You can find additional details on this [issue](https://github.com/kubernetes-sigs/controller-runtime/issues/2370).
+Please be aware that it will force Kubebuilder to remove this option in future release if controller-runtime decides to not support it further.
+Instead of using component-config, the [`Options`](https://github.com/kubernetes-sigs/controller-runtime/blob/e54088c8c7da82111b4508bdaf189c45d1344f00/pkg/manager/manager.go#L100) can be passed directly to the manager like below:
+```go
+mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), manager.Options{
+		Scheme: scheme,
+		Controller: config.Controller{
+			NeedLeaderElection:      pointer.Bool(true),
+			MaxConcurrentReconciles: 2,
+			...
+		},
+	})

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

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

Conversation

camilamacedo86 commented Jun 9, 2023

Description

Motivation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kkkkun left a comment

Choose a reason for hiding this comment

kkkkun commented Jun 9, 2023 • edited

varshaprasad96 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

varshaprasad96 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 12, 2023

kkkkun commented Jun 9, 2023 •

edited