-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OperatorHub inconsistent to Documentation #28779
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
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
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
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
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
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
87 changes: 87 additions & 0 deletions
87
modules/olm-installing-operators-from-operatorhub-configure.adoc
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,87 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * operators/user/olm-installing-operators-in-namespace.adoc | ||
| // * operators/admin/olm-adding-operators-to-cluster.adoc | ||
| // * post_installation_configuration/preparing-for-users.adoc | ||
| // | ||
| // Module watched for changes by Ecosystem Catalog team: | ||
| // https://projects.engineering.redhat.com/projects/RHEC/summary | ||
|
|
||
|
|
||
| [id="olm-installing-operators-from-operatorhub-configure_{context}"] | ||
| = Configuring {product-title} to use Red Hat Operators | ||
|
|
||
| In {product-title}, Red Hat Operators are not available by default. You can access and install these Operators if you have a pull secret from the Red Hat OpenShift Cluster Manager site by editing the `OperatorHub` custom resource (CR). | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Ensure that you have downloaded the link:https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the installation procedure. | ||
|
|
||
| .Procedure | ||
|
|
||
| To access the Red Hat Operators in a {product-title} cluster: | ||
|
|
||
| . Edit the `OperatorHub` CR using the web console or CLI: | ||
|
|
||
| .. Using the CLI: | ||
|
|
||
| ... Edit the `OperatorHub` CR: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit OperatorHub cluster | ||
| ---- | ||
|
|
||
| ... Add `redhat-operators` to the list of sources as `disabled: false`: | ||
| + | ||
| .Example `OperatorHub` CR | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: config.openshift.io/v1 | ||
| kind: OperatorHub | ||
| metadata: | ||
| name: cluster | ||
| spec: | ||
| disableAllDefaultSources: true | ||
| sources: | ||
| - disabled: false <1> | ||
| name: redhat-operators | ||
| - disabled: false | ||
| name: community-operators | ||
| ---- | ||
| <1> Add the `name: redhat-operators` and `disabled: false` parameters. | ||
|
|
||
| .. Using the web console: | ||
|
|
||
| ... Switch to the *Administration* -> *Custom Resource Definitions* page. | ||
|
|
||
| ... On the *Custom Resource Definitions* page, click *OperatorHub*. | ||
|
|
||
| ... On the *Custom Resource Definition Overview* page, click *Instances*. | ||
|
|
||
| ... On the *Instances* tab, click *cluster*. | ||
|
|
||
| ... On the *Instances* tab, click *YAML*. | ||
|
|
||
| ... In the YAML field, add `redhat-operators` to the list of sources as `disabled: false`: | ||
| + | ||
| .Example `OperatorHub` CR | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: config.openshift.io/v1 | ||
| kind: OperatorHub | ||
| metadata: | ||
| name: cluster | ||
| spec: | ||
| disableAllDefaultSources: true | ||
| sources: | ||
| - disabled: false <1> | ||
| name: redhat-operators | ||
| - disabled: false | ||
| name: community-operators | ||
| ---- | ||
| <1> Add the `name: redhat-operators` and `disabled: false` parameters. | ||
|
|
||
| ... Click *Save*. | ||
|
|
||
| . Log out of the web console, and then log back in. | ||
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
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
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
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
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.
s/$ oc edit OperatorHub cluster/$ oc edit operatorhub cluster ? (Did you test to see if it works with caps? If so, ignore.)
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.
@bobfuru Both versions work. The object YAML uses
OperatorHub, so I went with that.