Skip to content

OperatorHub inconsistent to Documentation#28779

Merged
mburke5678 merged 1 commit intoopenshift:masterfrom
mburke5678:okd-add-community-ops
Feb 1, 2021
Merged

OperatorHub inconsistent to Documentation#28779
mburke5678 merged 1 commit intoopenshift:masterfrom
mburke5678:okd-add-community-ops

Conversation

@mburke5678
Copy link
Copy Markdown
Contributor

@mburke5678 mburke5678 commented Jan 23, 2021

okd-project/okd#432

Adding information on how to configure OKD to expose OpenShift operators if the user has the proper pull secret.

@mburke5678 mburke5678 added the okd-only Content that is only relevant to upstream OKD docs. label Jan 23, 2021
@mburke5678 mburke5678 added this to the Next Release milestone Jan 23, 2021
@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 23, 2021
@openshift-docs-preview-bot
Copy link
Copy Markdown

The preview will be available shortly at:

@mburke5678
Copy link
Copy Markdown
Contributor Author

mburke5678 commented Jan 23, 2021

@vrutkovs PTAL. I will take a closer look at the text on Monday. Does this address the concern in all the issues #429 #358 #283 #295?

Preview: http://file.rdu.redhat.com/~mburke/okd-add-community-ops/post_installation_configuration/preparing-for-users.html#olm-installing-operators-from-operatorhub-configure_post-install-preparing-for-users

cc @vikram-redhat Is this something we want to document? There are multiple issues filed asking for this content.

@vikram-redhat
Copy link
Copy Markdown
Contributor

cc @vikram-redhat Is this something we want to document? There are multiple issues filed asking for this content.

As long as this only appears in upstream docs, I am happy for it to be worked on (time permitting) and merged without QE ack.

@mburke5678
Copy link
Copy Markdown
Contributor Author

@vikram-redhat This PR is for OKD only

Comment thread modules/cluster-logging-deploy-cli.adoc Outdated
Elasticsearch is a memory-intensive application. By default, {product-title} installs three Elasticsearch nodes with memory requests and limits of 16 GB. This initial set of three {product-title} nodes might not have enough memory to run Elasticsearch within your cluster. If you experience memory issues that are related to Elasticsearch, add more Elasticsearch nodes to your cluster rather than increasing the memory on existing nodes.

ifdef::openshift-origin[]
* You muast 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 xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator.
Copy link
Copy Markdown

@vrutkovs vrutkovs Jan 24, 2021

Choose a reason for hiding this comment

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

Suggested change
* You muast 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 xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator.
* You must 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 xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 29, 2021

Deploy preview for osdocs ready!

Built with commit 2f4f847802b710ebfcc8106bf0912a6e1e41309d

https://deploy-preview-28779--osdocs.netlify.app

@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 29, 2021

Deploy preview for osdocs ready!

Built with commit cc3475e

https://deploy-preview-28779--osdocs.netlify.app

Copy link
Copy Markdown
Contributor

@bobfuru bobfuru left a comment

Choose a reason for hiding this comment

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

A few thoughts about wrapping the CR in backticks and such.

Comment thread modules/cluster-logging-deploy-cli.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you want to mention what book/section this is in? I'm not looking at a preview build for this distro so I don't know whether it is clear here and elsewhere in the PR as to whether the user will understand where to find this procedure.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@bobfuru How does this sound:
as shown in Obtaining the installation program in the installation documentation for your platform`

De we have a standard for such references?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

My brain is low on power, so I'm not sure but should this be "the OperatorHub custom resource (CR)"?
https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#object-references

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same comment as above: "OperatorHub CR"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes to "OperatorHub CR" here, but no to "object" because I think it is somewhat redundant. My understanding is that this would only be either a CR or an object but not both. Also seems that "object" can be interchangeable with the generic term "resource". Not confusing at all. 😛

From docs_guidelines.adoc:

Use "object", "resource", "custom resource", "spec", etc. as appropriate after the object reference. This helps with clarity and readability.

Copy link
Copy Markdown
Contributor

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.)

Copy link
Copy Markdown
Contributor Author

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.

apiVersion: config.openshift.io/v1
kind: OperatorHub

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OperatorHub

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OperatorHub

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OperatorHub

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OperatorHub

@bobfuru bobfuru added the peer-review-done Signifies that the peer review team has reviewed this PR label Jan 29, 2021
@mburke5678 mburke5678 force-pushed the okd-add-community-ops branch from aa6a181 to cc3475e Compare February 1, 2021 21:11
@mburke5678 mburke5678 merged commit b427a53 into openshift:master Feb 1, 2021
@mburke5678 mburke5678 deleted the okd-add-community-ops branch February 1, 2021 21:29
@mburke5678
Copy link
Copy Markdown
Contributor Author

mburke5678 commented Feb 1, 2021

/cherrypick enterprise-4.5

@openshift-cherrypick-robot
Copy link
Copy Markdown

openshift-cherrypick-robot commented Feb 1, 2021

@mburke5678: new pull request created: #29031

Details

In response to this:

/cherrypick enterprise-4.5

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.

@mburke5678
Copy link
Copy Markdown
Contributor Author

mburke5678 commented Feb 1, 2021

/cherrypick enterprise-4.6

@openshift-cherrypick-robot
Copy link
Copy Markdown

openshift-cherrypick-robot commented Feb 1, 2021

@mburke5678: new pull request created: #29033

Details

In response to this:

/cherrypick enterprise-4.6

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.

@mburke5678
Copy link
Copy Markdown
Contributor Author

mburke5678 commented Feb 1, 2021

/cherrypick enterprise-4.7

@openshift-cherrypick-robot
Copy link
Copy Markdown

openshift-cherrypick-robot commented Feb 1, 2021

@mburke5678: new pull request created: #29036

Details

In response to this:

/cherrypick enterprise-4.7

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

Labels

branch/enterprise-4.4 branch/enterprise-4.5 branch/enterprise-4.6 branch/enterprise-4.7 okd-only Content that is only relevant to upstream OKD docs. peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants