Meta - ComponentConfig scaffolds should not be done by default

[camilamacedo86]

What broke? What's expected?

Users should have the scaffold of https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/component-config-tutorial/testdata/project/config/manager/controller_manager_config.yaml ONLY/when they create the project following the tutorial: https://book.kubebuilder.io/component-config-tutorial/api-changes.html

That means, the scaffold should only be done when we run kubebuilder init --domain tutorial.kubebuilder.io --component-config. However, it has been added to the default scaffolds when we run kubebuilder init and it has brought confusion since users do not understand how properly use it and that their code in the main.go also needs to be customized accordingly.

Reproducing this issue

Examples:

• 📖 documentation Fixes ProjectConfig from ControllerManagerConfig in the component-con… #2778
• Attempt to use manager_config_patch.yaml results in "flag provided but not defined: -config" operator-framework/operator-sdk#5884

KubeBuilder (CLI) Version

3.5.0

Plugin versions

Therefore, these options would fit in a plugin and should not be a flag. It is only a flag because it was implemented in the past (Kubebuilder 2.X) before the plugin design was introduced.

• Proposed changes (Bug FIX)
  a) Ensure that the component config scaffolds are not done by default and are only done when the flag is used - 🐛 (kustomize/v1 and kustomize/v2-alpha) : ComponentConfig scaffolds should not be done by default #2826
  b) Review the documentation and ensure that it proper clarifies how it should be used and work - done

• Proposed changes in the long term (RFE)
  a) Deprecated the flag
  b) Move ComponentConfig behaviour to a plugin that can be used in the init/edit subcommands.

[laxmikantbpandhare]

/assign

[camilamacedo86]

Re-open this one it still missing we create a plugin for this feature and deprecate the flag.
Also, we should update the docs in the pr where it will be addressed.

[laxmikantbpandhare]

@camilamacedo86 yes, working on plug-in part for this command.

[laxmikantbpandhare]

@camilamacedo86 - Raised PR #2942 for one of the fixes.

Working on the below part and will raise the PR soon.

Move ComponentConfig behavior to a plugin that can be used in the init/edit subcommands.

[laxmikantbpandhare]

@camilamacedo86 raised PR for init/edit subcommands: #3022

[k8s-triage-robot]

This issue is labeled with priority/important-soon but has not been updated in over 90 days, and should be re-triaged.
Important-soon issues must be staffed and worked on either currently, or very soon, ideally in time for the next release.

You can:

• Confirm that this issue is still relevant with /triage accepted (org members only)
• Deprioritize it with /priority important-longterm or /priority backlog
• Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

[rustycl0ck]

• Just mentioning here for information: RFC: Deprecation and removal of ComponentConfig controller-runtime#895
  There might be some useful information in this discussion about how to move forward with this.

I stumbled upon this issue because the linter is now throwing errors that options.AndFrom is deprecated and will be removed in a future version. Will have to bypass the linter for now, but the documents should at least be updated soon to discourage people from migrating to ComponentConfig now (maybe can point to the above thread for more information about alternatives or discussions in the meantime).

[camilamacedo86]

Yes, we need to just deprecated the flag and we deprecated the configuration already, see: #3442

@laxmikantbpandhare could you please rebase your PR #3023, ensure that we are deprecating it for go/v4 and help us to get it merged ?

Or if any other person either would like to help with this one would be great.
See that we need to add a text to explain the deprecation reason as we did in the docs.

Thank you.

[laxmikantbpandhare]

@camilamacedo86 - I was on leave and away from coding. I will look into it and merge it ASAP.

[aperullo]

What is the intended replacement for componentconfig we should be using instead?