-
Notifications
You must be signed in to change notification settings - Fork 1.8k
[wip] sdk: add operator and builder interface #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
fanminshi
wants to merge
1
commit into
operator-framework:master
from
fanminshi:add_operators_interface
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package sdk | ||
|
|
||
| type Builder interface { | ||
| // Name is the name of the operator. | ||
| Name(name string) Builder | ||
| // CRDName is the full name of the Custom Resource Resource that the operator operates on. | ||
| CRDName(crdName string) Builder | ||
| // APIVersion is the version from the groupVersion. | ||
| APIVersion(apiVersion string) Builder | ||
| // Callbacks registers the callbacks which notifies the creation, update, and deletion of any Custom Resource. | ||
| Callbacks(callBacks CallBacks) Builder | ||
| // Build builds an operator instance. | ||
| Build() (Operator, error) | ||
| } | ||
|
|
||
| type CallBacks interface { | ||
| // OnAdd notifies a creation of a Custom Resource. | ||
| OnAdd(obj interface{}) | ||
| // OnUpdate notifies a update of an existing Custom Resource. | ||
| OnUpdate(oldObj, newObj interface{}) | ||
| // OnDelete notifies a deletion of an existing Custom Resource. | ||
| OnDelete(obj interface{}) | ||
| } | ||
|
|
||
| // NewOperatorBuilder creates a operator builder. | ||
| func NewOperatorBuilder() Builder { | ||
| // Implement me! | ||
| return nil | ||
| } | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| package sdk | ||
|
|
||
| import "context" | ||
|
|
||
| type Operator interface { | ||
| // Start starts the operator. | ||
| Start(Context context.Context) error | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the callback should not be per resource based. it is a pain in the ass to ask the users to serialize the requests to avoid concurrency issues.
users should only need to implement a single sync func where all changes are serialized already by SDK. Users do not need to solve any concurrency issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. that makes sense. i'll re-think the api def.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the callback should not be per resource based.What do you mean by not per resource based?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So from what I understand related to xiang's comment on the other PR the idea is that there should not be separate callbacks/sync functions registered for each different custom resource, pods, secrets etc.
https://github.com/coreos/operator-sdk/pull/6/files#r167013090
The users would just watch for all the resources they need and all events(add,update, delete) would get sent to the main sync function and be handled by the user over there.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hasbro17 exactly.
users only need to fill in sync func like this