Skip to content

update golang docs on CRD scoping #4812

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

Merged
merged 2 commits into from
Apr 30, 2021

Conversation

jberkhahn
Copy link
Contributor

Description of the change:
Update the docs to discuss the various ways golang operators can control the scope of their CRD

Motivation for the change:
see issue #3684

The CustomResourceDefinition (CRD) scope can also be changed for cluster-scoped operators so that there is only a single
instance (for a given name) of the Custom Resource (CR) to manage across the cluster.
Custom Resource Definitions (CRDs) contain a scope field that determines whether the resulting Custom Resource (CR)
is cluster or namespace scoped. Operators can be build making use of this feature that then operator either on the entire cluster,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Operators can be built using this feature to ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow, i don't know what happened there. thanks for the catch.

Signed-off-by: Jonathan Berkhahn <[email protected]>
Copy link
Member

@estroz estroz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bunch of suggestions, the main themes being:

  1. To clarify that operator scope != CRD scope
  2. Go vs. non-Go configuration

Co-authored-by: Eric Stroczynski <[email protected]>
Signed-off-by: Jonathan Berkhahn <[email protected]>
Copy link
Member

@estroz estroz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 30, 2021
@estroz estroz merged commit 4c16a1b into operator-framework:master Apr 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants