Skip to content

Explaining the need for operator group during install docs #27

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 6, 2020
Merged

Explaining the need for operator group during install docs #27

merged 2 commits into from
Jul 6, 2020

Conversation

shawn-hurley
Copy link
Member

Adding information on:

  1. That you need to create an operator group before installation into a namespace
  2. that the operator group is tied to the install mode of the operator
  3. Link to the operator group docs for further information

@shawn-hurley shawn-hurley force-pushed the add-operator-group-to-install branch from 251439d to a6b03a7 Compare June 17, 2020 15:00
anik120
anik120 requested changes Jun 30, 2020
View reviewed changes
Copy link
Contributor

@anik120 anik120 left a comment

Choose a reason for hiding this comment

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

@shawn-hurley thank you for your PR. I'm left some comments, I'll merge this one as soon you address them. Thanks!

content/en/docs/Tasks/install-operator-with-olm.md Outdated
@@ -6,6 +6,21 @@ description: >
[Once you've made your operator available in a catalog](/docs/tasks/make-operator-part-of-catalog/), or you've chosen an operator from the [list of operators available to be installed in the cluster](/docs/tasks/list-operators-available-to-install/), you can install your operator by creating a [`Subscription`](/docs/concepts/customresourcedefinitions/subscription/) to a specific [channel](/docs/concepts/glossary/#channel).
---

Before installing into a namespace, you will need to create an [operator group](/docs/concepts/crds/operatorgroup) in that namespace. The operator group must provide the namespaces that match the operator that you trying to install `installModes`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Before installing into a namespace, you will need to create an [operator group](/docs/concepts/crds/operatorgroup) in that namespace. The operator group must provide the namespaces that match the operator that you trying to install `installModes`.
Before installing an Operator in a namespace, you will need to create an [OperatorGroup](/docs/concepts/crds/operatorgroup) in that namespace. The operator group must provide the namespaces that match the operator that you trying to install `installModes`.

Copy link
Contributor

Choose a reason for hiding this comment

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

The operator group must provide the namespaces that match the operator that you trying to install installModes.

This sentence is confusing to me. Maybe it'll be clear if you elaborated on the part about "match"-ing the operator?

content/en/docs/Tasks/install-operator-with-olm.md Outdated
@@ -6,6 +6,21 @@ description: >
[Once you've made your operator available in a catalog](/docs/tasks/make-operator-part-of-catalog/), or you've chosen an operator from the [list of operators available to be installed in the cluster](/docs/tasks/list-operators-available-to-install/), you can install your operator by creating a [`Subscription`](/docs/concepts/customresourcedefinitions/subscription/) to a specific [channel](/docs/concepts/glossary/#channel).
---

Before installing into a namespace, you will need to create an [operator group](/docs/concepts/crds/operatorgroup) in that namespace. The operator group must provide the namespaces that match the operator that you trying to install `installModes`.

For example installing an operator into `foo` namespace that will be cluster scoped you would create a operator group like:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example installing an operator into `foo` namespace that will be cluster scoped you would create a operator group like:
For example, to install a cluster scoped operator in the namespace `foo`, you would create an OperatorGroup like:

@shawn-hurley shawn-hurley force-pushed the add-operator-group-to-install branch 3 times, most recently from efe982b to 9a85162 Compare July 6, 2020 14:58
@shawn-hurley shawn-hurley force-pushed the add-operator-group-to-install branch from 9a85162 to f32871b Compare July 6, 2020 17:30
@anik120 anik120 merged commit f68b142 into operator-framework:master Jul 6, 2020
@anik120
Copy link
Contributor

anik120 commented Sep 23, 2020

/cherry-pick legacy

@openshift-cherrypick-robot
Copy link

@anik120: #27 failed to apply on top of branch "legacy":

Applying: Explaining the need for operator group during install docs
.git/rebase-apply/patch:39: trailing whitespace.
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](/docs/tasks/troubleshooting/clusterserviceversion/) to debug your installation. 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	content/en/docs/Tasks/install-operator-with-olm.md
Falling back to patching base and 3-way merge...
Auto-merging content/en/docs/Tasks/install-operator-with-olm.md
CONFLICT (content): Merge conflict in content/en/docs/Tasks/install-operator-with-olm.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Explaining the need for operator group during install docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick legacy

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anik120 anik120 anik120 requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shawn-hurley @anik120 @openshift-cherrypick-robot