OLM 1.0 OCP 4.15 clean up tasks #71400

michaelryanpeter · 2024-02-08T21:25:47Z

Version(s): 4.15

Issue: OSDOCS-8881

Link to docs preview:

Updating an Operator (Step 3 sub-bullets)
Adding a catalog (added pollInterval to CR and a callout)
Deleting an Operator (removed mention of the quay Operator)
Catalog queries (fixup closing brackets (>)
Version comparison strings (clarify that comparison strings must be wrapped in quotes)

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2024-02-08T21:30:43Z

🤖 Fri Feb 16 15:01:30 - Prow CI generated the docs preview: https://71400--ocpdocs-pr.netlify.app

modules/olmv1-updating-an-operator.adoc

michaelryanpeter · 2024-02-08T22:19:07Z

@jianzhangbjz or @Xia-Zhao-rh PTAL.

michaelryanpeter · 2024-02-09T16:10:49Z

@bandrade PTAL

kevinrizza · 2024-02-13T20:51:49Z

/lgtm

modules/olmv1-adding-a-catalog.adoc

modules/olmv1-red-hat-catalogs.adoc

everettraven

A couple typos but other than that LGTM

m1kola

/lgtm

bandrade

/lgtm

michaelryanpeter · 2024-02-15T23:35:25Z

/label peer-review-needed

snarayan-redhat

great work! Couple of suggestions. LGTM!

snarayan-redhat · 2024-02-16T09:58:19Z

modules/olmv1-adding-a-catalog.adoc

@@ -35,9 +35,11 @@ spec:
    image:
      ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} <1>
      pullSecret: <pull_secret_name> <2>
+      pollInterval: 30m <3>


IIUC, this is a variable/user-defined value. Hence can be represented as a placeholder value, e.g. <poll_interval_duration>

snarayan-redhat · 2024-02-16T10:00:38Z

modules/olmv1-adding-a-catalog.adoc

 ----
 <1> Specify the catalog's image in the `spec.source.image` field.
 <2> If your catalog is hosted on a secure registry, such as `registry.redhat.io`, you must create a pull secret scoped to the `openshift-catalog` namespace.
+<3> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include `s`, `m`, and `h`. To disable polling, set a zero value, such as `0s`.


Though it is implied, do you think it could be a good idea to specify seconds, minutes, hours? Up to you :)

snarayan-redhat · 2024-02-16T10:01:49Z

modules/olmv1-red-hat-catalogs.adoc

 ----
+<1> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include `s`, `m`, and `h`. To disable polling, set a zero value, such as `0s`.


same comment as previous

snarayan-redhat · 2024-02-16T10:02:20Z

modules/olmv1-updating-an-operator.adoc

-. Edit your CR to update the version to `1.12.1`, as shown in the following example:
+. Edit your CR by using one of the following methods:
+
+** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your  CR similar to the following example:


Suggested change

** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your CR similar to the following example:

** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your CR similar to the following example:

snarayan-redhat · 2024-02-16T10:09:26Z

modules/olmv1-version-range-comparisons.adoc

@@ -7,7 +7,7 @@
 [id="olmv1-version-range-comparisons_{context}"]
 = Version comparison strings

-You can define a version range by adding a comparison string to the `spec.version` field in an Operator or extension's custom resource (CR). A comparison string is a list of space- or comma-separated values and one or more comparison operators. You can add another comparison string by including an `OR`, or double vertical bar (`||`), comparison operator between the strings.
+You can define a version range by adding a comparison string to the `spec.version` field in an Operator or extension's custom resource (CR). A comparison string is a list of space- or comma-separated values and one or more comparison operators surrounded by double quotation marks (`"`). You can add another comparison string by including an `OR`, or double vertical bar (`||`), comparison operator between the strings.


Suggested change

You can define a version range by adding a comparison string to the `spec.version` field in an Operator or extension's custom resource (CR). A comparison string is a list of space- or comma-separated values and one or more comparison operators surrounded by double quotation marks (`"`). You can add another comparison string by including an `OR`, or double vertical bar (`||`), comparison operator between the strings.

You can define a version range by adding a comparison string to the `spec.version` field in an Operator or extension's custom resource (CR). A comparison string is a list of space- or comma-separated values and one or more comparison operators enclosed in double quotation marks (`"`). You can add another comparison string by including an `OR`, or double vertical bar (`||`), comparison operator between the strings.

snarayan-redhat · 2024-02-16T10:16:45Z

modules/olmv1-red-hat-catalogs.adoc

@@ -28,7 +28,9 @@ spec:
    image:
      ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version}
      pullSecret: <pull_secret_name>
+      pollInterval: 24h <1>


same as previous suggestion for using placeholder unless this is for a specific scenario.

snarayan-redhat · 2024-02-16T10:18:44Z

modules/olmv1-updating-an-operator.adoc

+  name: pipelines-operator
+spec:
+  packageName: openshift-pipelines-operator-rh
+  channel: latest


IMO this example might need a placeholder and a corresponding callout to highlight the field specifying the channel?

Heard. I did a draft of the doc where I took that approach. But the goal here is to give an actual example from the RH Operators catalog. So, using a placeholder goes against the goal of showing a customer a working CR.

snarayan-redhat · 2024-02-16T10:21:01Z

modules/olmv1-updating-an-operator.adoc

+  version: "<1.13"
+----
+
+For more information, see "Example custom resources that specify a target version".


Based on the text in Additional resources section.

Suggested change

For more information, see "Example custom resources that specify a target version".

For more information, see "Example custom resources (CRs) that specify a target version".

snarayan-redhat · 2024-02-16T11:03:47Z

modules/olmv1-updating-an-operator.adoc

+
+** If you want to specify a channel and version or version range, edit your CR similar to the following example:
+
+.Example CR with a specified channel


Should this be specified channel and version?

snarayan-redhat

Sorry for adding another comment. Looking at the preview, I had a question:
Step 3 here seems to have scenarios similar to this section. Can we create sections instead of putting them within the procedure? The procedure could have a single yaml with placeholders for channel and version fields and callouts explaining those.

michaelryanpeter · 2024-02-16T14:54:28Z

@snarayan-redhat Thank you for the review! Great suggestions, and I applied most of them. In terms of the break down of step three in the procedure, this was a specific ask from my PM to format the text and include an additional section that goes over the content in a bit more detail later.

openshift-ci · 2024-02-16T14:57:14Z

New changes are detected. LGTM label has been removed.

openshift-ci · 2024-02-16T15:02:49Z

@michaelryanpeter: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

michaelryanpeter · 2024-02-16T15:07:13Z

/cherrypick enterprise-4.15

openshift-cherrypick-robot · 2024-02-16T15:08:02Z

@michaelryanpeter: new pull request created: #71741

In response to this:

/cherrypick enterprise-4.15

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.

…p-tasks OLM 1.0 OCP 4.15 clean up tasks

michaelryanpeter added the branch/enterprise-4.15 label Feb 8, 2024

michaelryanpeter added this to the Planned for 4.15 GA milestone Feb 8, 2024

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 8, 2024

kevinrizza reviewed Feb 8, 2024

View reviewed changes

modules/olmv1-updating-an-operator.adoc Outdated Show resolved Hide resolved

modules/olmv1-updating-an-operator.adoc Show resolved Hide resolved

tlwu2013 reviewed Feb 8, 2024

View reviewed changes

modules/olmv1-updating-an-operator.adoc Outdated Show resolved Hide resolved

tlwu2013 reviewed Feb 8, 2024

View reviewed changes

modules/olmv1-updating-an-operator.adoc Outdated Show resolved Hide resolved

michaelryanpeter force-pushed the 4.15-clean-up-tasks branch 2 times, most recently from 7d9b600 to b90e71e Compare February 13, 2024 20:34

kevinrizza approved these changes Feb 13, 2024

View reviewed changes

openshift-ci bot assigned kevinrizza Feb 13, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 13, 2024

everettraven reviewed Feb 13, 2024

View reviewed changes

modules/olmv1-adding-a-catalog.adoc Outdated Show resolved Hide resolved

everettraven reviewed Feb 13, 2024

View reviewed changes

modules/olmv1-red-hat-catalogs.adoc Outdated Show resolved Hide resolved

everettraven reviewed Feb 13, 2024

View reviewed changes

michaelryanpeter force-pushed the 4.15-clean-up-tasks branch from b90e71e to ffa0135 Compare February 13, 2024 21:06

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 13, 2024

m1kola approved these changes Feb 14, 2024

View reviewed changes

openshift-ci bot assigned m1kola Feb 14, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 14, 2024

bandrade approved these changes Feb 15, 2024

View reviewed changes

openshift-ci bot assigned bandrade Feb 15, 2024

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 15, 2024

snarayan-redhat added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Feb 16, 2024

snarayan-redhat reviewed Feb 16, 2024

View reviewed changes

snarayan-redhat added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Feb 16, 2024

OLM 1.0 OCP 4.15 clean up tasks

6f601d7

michaelryanpeter force-pushed the 4.15-clean-up-tasks branch from ffa0135 to 6f601d7 Compare February 16, 2024 14:56

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 16, 2024

michaelryanpeter merged commit f124014 into openshift:main Feb 16, 2024

openshift-cherrypick-robot mentioned this pull request Feb 16, 2024

[enterprise-4.15] OLM 1.0 OCP 4.15 clean up tasks #71741

Merged

aireilly pushed a commit to aireilly/openshift-docs that referenced this pull request Feb 26, 2024

Merge pull request openshift#71400 from michaelryanpeter/4.15-clean-u…

feaca91

…p-tasks OLM 1.0 OCP 4.15 clean up tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OLM 1.0 OCP 4.15 clean up tasks #71400

OLM 1.0 OCP 4.15 clean up tasks #71400

michaelryanpeter commented Feb 8, 2024 •

edited

Loading

ocpdocs-previewbot commented Feb 8, 2024 •

edited

Loading

michaelryanpeter commented Feb 8, 2024

michaelryanpeter commented Feb 9, 2024

kevinrizza commented Feb 13, 2024

everettraven left a comment

m1kola left a comment

bandrade left a comment

michaelryanpeter commented Feb 15, 2024

snarayan-redhat left a comment

snarayan-redhat Feb 16, 2024

snarayan-redhat Feb 16, 2024 •

edited

Loading

snarayan-redhat Feb 16, 2024 •

edited

Loading

snarayan-redhat Feb 16, 2024

snarayan-redhat Feb 16, 2024

snarayan-redhat Feb 16, 2024

snarayan-redhat Feb 16, 2024 •

edited

Loading

michaelryanpeter Feb 16, 2024

snarayan-redhat Feb 16, 2024

snarayan-redhat Feb 16, 2024

snarayan-redhat left a comment •

edited

Loading

michaelryanpeter commented Feb 16, 2024

openshift-ci bot commented Feb 16, 2024

openshift-ci bot commented Feb 16, 2024

michaelryanpeter commented Feb 16, 2024

openshift-cherrypick-robot commented Feb 16, 2024

		----
		<1> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include `s`, `m`, and `h`. To disable polling, set a zero value, such as `0s`.

	** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your CR similar to the following example:
	** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your CR similar to the following example:

	For more information, see "Example custom resources that specify a target version".
	For more information, see "Example custom resources (CRs) that specify a target version".

OLM 1.0 OCP 4.15 clean up tasks #71400

OLM 1.0 OCP 4.15 clean up tasks #71400

Conversation

michaelryanpeter commented Feb 8, 2024 • edited Loading

ocpdocs-previewbot commented Feb 8, 2024 • edited Loading

michaelryanpeter commented Feb 8, 2024

michaelryanpeter commented Feb 9, 2024

kevinrizza commented Feb 13, 2024

everettraven left a comment

Choose a reason for hiding this comment

m1kola left a comment

Choose a reason for hiding this comment

bandrade left a comment

Choose a reason for hiding this comment

michaelryanpeter commented Feb 15, 2024

snarayan-redhat left a comment

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

michaelryanpeter Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat Feb 16, 2024

Choose a reason for hiding this comment

snarayan-redhat left a comment • edited Loading

Choose a reason for hiding this comment

michaelryanpeter commented Feb 16, 2024

openshift-ci bot commented Feb 16, 2024

openshift-ci bot commented Feb 16, 2024

michaelryanpeter commented Feb 16, 2024

openshift-cherrypick-robot commented Feb 16, 2024

michaelryanpeter commented Feb 8, 2024 •

edited

Loading

ocpdocs-previewbot commented Feb 8, 2024 •

edited

Loading

snarayan-redhat Feb 16, 2024 •

edited

Loading

snarayan-redhat Feb 16, 2024 •

edited

Loading

snarayan-redhat Feb 16, 2024 •

edited

Loading

snarayan-redhat left a comment •

edited

Loading