OLM operator support for downstream plug-ins #2843
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci
bot
added
the
do-not-merge/work-in-progress
perdasilva
changed the title
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: perdasilva 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:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
perdasilva
force-pushed
the
csv_event_handling
branch
8 times, most recently
from
ea79ffa
to
0b015f8
Compare
perdasilva
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
grokspawn
reviewed
Aug 24, 2022
bentito
reviewed
Aug 24, 2022
perdasilva
force-pushed
the
csv_event_handling
branch
5 times, most recently
from
9c2aaa4
to
881b8be
Compare
perdasilva
commented
Aug 25, 2022
| @@ -37,6 +37,26 @@ type operatorConfig struct { | |||
| configClient configv1client.Interface | |||
| } | |||
|
|
|||
| func (o *operatorConfig) OperatorClient() operatorclient.ClientInterface { | |||
There was a problem hiding this comment.
These chances go in conjunction with the OperatorConfig client interface on the plug-in package. This way the plug-in can have access to some of the configuration information
perdasilva
commented
Aug 25, 2022
| @@ -61,6 +61,10 @@ var ( | |||
| ErrAPIServiceOwnerConflict = errors.New("unable to adopt APIService") | |||
| ) | |||
|
|
|||
| // this unexported operator plugin slice provides an entrypoint for | |||
| // downstream to inject its own plugins to augment the controller behavior | |||
| var operatorPlugInFactoryFuncs []plugins.OperatorPlugInFactoryFunc | |||
There was a problem hiding this comment.
Using factory functions instead of the instantiated plug-in objects themselves. This guarantees that each instance of the operator gets their own instance of the plug-ins
perdasilva
force-pushed
the
csv_event_handling
branch
from
881b8be
to
5cbf02b
Compare
Signed-off-by: perdasilva <[email protected]>
perdasilva
force-pushed
the
csv_event_handling
branch
from
5cbf02b
to
bca9d5d
Compare
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: perdasilva [email protected]
Description of the change:
This PR introduces the concept of a plug-in for the OLM controller. Plugins can be injected downstream through the unexported
operatorPlugInspackage variable. Once the OLM controller is finished initializing, it will instantiate each of the plugins in turn.Motivation for the change:
We need to add some downstream only code for handling csvs in lights of the label sync'er. This code will act on csv additions (non-copied csvs) and add a label to the namespace the csv belongs to, if it's not already there.
Architectural changes:
Adds an unexported package variable that carries the references to the plug-ins and initializes.
Adds some accessor methods to the operatorConfig to make some configuration information available to the plug-in
Breaks up the Operator interface into three interfaces to reduce the level of access to operator methods by the plug-in
Testing remarks:
No functional changes are brought in by this PR. No testing required.
Reviewer Checklist
/doc[FLAKE]are truly flaky and have an issue