Skip to content

Documentation RFE: Advanced Topics - ComponentConfig #5104

@fgiloux

Description

@fgiloux

I could not find any reference to ComponentConfig in operator-sdk documentation:
https://book.kubebuilder.io/component-config-tutorial/tutorial.html

This is an important aspect for controlling any advance functionality of the controller:

  • cleansing policies
  • sync period
  • logging level
  • feature gates

IMHO this should be part of best practices for development of any advanced operator.

The current alternative of relying on feature flags has several limitations, for instance:

  • any configuration change requires the controller deployment to be changed and the controller to be restarted
  • this does not support any data structure / validation and little self documentation
  • this is not gitOps friendly: the deployment is created at installation time and needs to be patched afterwards, whereas a configuration resource can just be applied onto the default one.

Metadata

Metadata

Labels

help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions