operator-sdk icon indicating copy to clipboard operation
operator-sdk copied to clipboard

Documentation RFE: Advanced Topics - ComponentConfig

Open fgiloux opened this issue 4 years ago • 8 comments

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.

fgiloux avatar Aug 01 '21 07:08 fgiloux

should probably go in this section: https://sdk.operatorframework.io/docs/best-practices/

jberkhahn avatar Aug 02 '21 18:08 jberkhahn

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Oct 31 '21 21:10 openshift-bot

/remove-lifecycle stale

fgiloux avatar Nov 01 '21 10:11 fgiloux

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Mar 06 '22 23:03 openshift-bot

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Apr 05 '22 23:04 openshift-bot

/remove-lifecycle rotten

fgiloux avatar Apr 06 '22 06:04 fgiloux

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Jul 05 '22 07:07 openshift-bot

/remove-lifecycle stale

fgiloux avatar Jul 11 '22 08:07 fgiloux

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Oct 09 '22 09:10 openshift-bot

/remove-lifecycle stale

fgiloux avatar Oct 10 '22 05:10 fgiloux

I can take a look into it. I recently worked on --component-config flag enablement in Kubebuilder.

laxmikantbpandhare avatar Oct 10 '22 05:10 laxmikantbpandhare

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Jan 08 '23 09:01 openshift-bot

@.***

scotRinga-MayaDog avatar Jan 08 '23 10:01 scotRinga-MayaDog

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Feb 08 '23 00:02 openshift-bot

/remove-lifecycle rotten

fgiloux avatar Feb 08 '23 07:02 fgiloux

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar May 09 '23 09:05 openshift-bot

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Jun 09 '23 00:06 openshift-bot

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-bot avatar Jul 09 '23 08:07 openshift-bot

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci[bot] avatar Jul 09 '23 08:07 openshift-ci[bot]