Add OLM 1.0 relnote for 4.14 #63605

adellape · 2023-08-15T18:05:23Z

https://issues.redhat.com/browse/OSDOCS-6727

4.14

Preview:

ocpdocs-previewbot · 2023-08-15T19:01:43Z

🤖 Updated build preview is available at:
https://63605--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/28978

adellape · 2023-08-30T15:55:15Z

release_notes/ocp-4-14-release-notes.adoc

+. Build your catalog as an image.
+. Publish your catalog image.
+
+For more information, see "Managing catalogs for OLM v1".


xref to content to be added after #63086 merges.

adellape · 2023-09-01T21:39:47Z

release_notes/ocp-4-14-release-notes.adoc

 |Technology Preview
-
-|Node Observability Operator


Removing "Node Observability Operator" from the "Operator lifecycle and development Technology Preview tracker" because it is a duplicate here and is already represented (and is a better fit) over in the "Scalability and performance Technology Preview features" section.

adellape · 2023-09-01T21:41:03Z

release_notes/ocp-4-14-release-notes.adoc

 |Technology Preview
 |Technology Preview
 |Technology Preview

-|Multi-cluster Engine Operator


I am not sure why "Multi-cluster Engine Operator" is here in the "Operator lifecycle and development Technology Preview tracker", so I moved it down to the "Architecture Technology Preview features" section since it seemed like it is related to hosted control planes. But I will follow up with the related tech writer to confirm that before merge.

skopacz1 · 2023-09-05T13:20:14Z

/label peer-review-in-progress

skopacz1

Left a nit and a suggestion, otherwise looks good!

release_notes/ocp-4-14-release-notes.adoc

skopacz1 · 2023-09-05T13:32:56Z

/remove-label peer-review-needed
/remove-label peer-review-in-progress

/label peer-review-done

adellape · 2023-10-18T20:07:38Z

_attributes/common-attributes.adoc

+//Next-gen (OCP 4.13+) Operator Lifecycle Manager, aka "v1"
+:olmv1: OLM 1.0
+:olmv1-first: Operator Lifecycle Manager (OLM) 1.0


I am borrowing this from the unmerged main PR https://github.com/openshift/openshift-docs/pull/65963/files. Whichever merges first, this should come out in the rebase-wash.

adellape · 2023-10-18T20:09:49Z

Looking for another round of peer review since this has had significant additions/changes since the last one. xrefs to be tidied up after #65963 merges.

jldohmann

Nice work! Generally LGTM, left some comments below

jldohmann · 2023-10-18T20:24:09Z

release_notes/ocp-4-14-release-notes.adoc

+* The `Catalog` API, provided by the new Catalogd component, serves as the foundation for {olmv1}, unpacking catalogs for on-cluster clients so that users can discover installable content, such as Operators and Kubernetes extensions. This provides increased visibility into all available Operator bundle versions, including their details, channels, and update edges.
+--
+
+For more information, see _Operator Controller_ and _Catalogd_.


Did you mean to add xrefs here?

Sorry, yea, mentioned above in #63605 (comment).

release_notes/ocp-4-14-release-notes.adoc

jianzhangbjz · 2023-10-19T01:45:06Z

release_notes/ocp-4-14-release-notes.adoc

 |Technology Preview
 |Technology Preview
 |Technology Preview

-|RukPak
-|Not Available
+|Java-based Operator


Actually, the Java-based Operator belongs to the operator-sdk, not OLM.

We have this section/table titled as "Operator lifecycle and development Technology Preview features", where "Operator lifecyce" is supposed to suggest "OLM", and "[Operator] development" is supposed to suggest "OSDK". So basically we're treating this table as any features related to the fuller Operator Framework.

jianzhangbjz · 2023-10-19T01:45:41Z

release_notes/ocp-4-14-release-notes.adoc

 |Technology Preview
 |Technology Preview

-|Platform Operators
+|Hybrid Helm Operator


I guess the Hybrid Helm Operator belongs to the Operator-SDK, not OLM.

jianzhangbjz · 2023-10-19T06:56:54Z

release_notes/ocp-4-14-release-notes.adoc

+{olmv1} simplifies Operator management through two key APIs:
+
+--
+* The `Operator` API, provided by the new Operator Controller component, streamlines management of installed Operators by consolidating user-facing APIs into a single object. This empowers administrators and SREs to automate processes and define desired states by using GitOps principles.


Actually, OLM has the Operator kind before, which is from the CRD operators.operators.coreos.com. Here is the new Operator kind from CRD: operators.operators.operatorframework.io. Both of them use the operator strings for now.
See the discussion on Slack: https://redhat-internal.slack.com/archives/GHMALGJV6/p1689573773633059 or the https://issues.redhat.com/browse/OCPBUGS-22094

MacBook-Pro:~ jianzhang$ oc get operators.operators.operatorframework.io NAME AGE quay-example 4h10m MacBook-Pro:~ jianzhang$ oc get operators.operators.coreos.com NAME AGE cluster-logging.openshift-logging 7h13m elasticsearch-operator.openshift-operators-redhat 7h13m loki-operator.openshift-operators-redhat 7h13m oadp-operator.e2e-test-olm-a-fwobi02w-gsc8h 3h42m

So, to avoid confusion, here I'd suggest using the operators.operators.operatorframework.io instead of operator.

Good point! I had created this olmv1-operator-api-group.adoc [NOTE] snippet in another WIP PR, which talks about that difference, so I'll re-use that here as well.

Well... unfortunately I have discovered you can't use include statements (e.g., for a snippet) within footnotes, and adding the big [NOTE] box in-line with the description list and bullets is pretty unsightly. I think I will just change "The Operator API..." in that first bullet to "A new Operator API..." and then let the linked-to "see Operator Controller" section (which will have the aforementioned snippet/note in it, after the related PR merges) do the explaining on this matter.

OK, actually I sort of split the difference here, and went with:

openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 15, 2023

adellape force-pushed the olmv1_rn branch from f552f24 to 09f9b3a Compare August 15, 2023 19:09

adellape changed the title ~~Add OLM v1 relnote for 4.14~~ [WIP] Add OLM v1 relnote for 4.14 Aug 15, 2023

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 15, 2023

adellape force-pushed the olmv1_rn branch from 09f9b3a to a4a8c38 Compare August 22, 2023 16:25

adellape commented Aug 30, 2023

View reviewed changes

adellape force-pushed the olmv1_rn branch from a4a8c38 to db756e6 Compare September 1, 2023 18:03

adellape changed the title ~~[WIP] Add OLM v1 relnote for 4.14~~ Add initial OLM v1 relnote for 4.14 Sep 1, 2023

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 1, 2023

adellape added the branch/enterprise-4.14 label Sep 1, 2023

adellape added this to the Planned for 4.14 GA milestone Sep 1, 2023

adellape force-pushed the olmv1_rn branch from db756e6 to 7353a58 Compare September 1, 2023 21:38

openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 1, 2023

adellape commented Sep 1, 2023

View reviewed changes

adellape force-pushed the olmv1_rn branch from 7353a58 to 2cf2b05 Compare September 1, 2023 21:44

adellape added the peer-review-needed Signifies that the peer review team needs to review this PR label Sep 1, 2023

openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Sep 5, 2023

skopacz1 reviewed Sep 5, 2023

View reviewed changes

release_notes/ocp-4-14-release-notes.adoc Outdated Show resolved Hide resolved

release_notes/ocp-4-14-release-notes.adoc Outdated Show resolved Hide resolved

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Sep 5, 2023

adellape force-pushed the olmv1_rn branch 4 times, most recently from 646236d to 1dc8661 Compare October 2, 2023 20:58

adellape force-pushed the olmv1_rn branch from 1dc8661 to a3a9895 Compare October 2, 2023 21:05

adellape force-pushed the olmv1_rn branch 5 times, most recently from a782f64 to 7744d10 Compare October 18, 2023 20:06

adellape commented Oct 18, 2023

View reviewed changes

adellape changed the title ~~Add initial OLM v1 relnote for 4.14~~ Add OLM 1.0 relnote for 4.14 Oct 18, 2023

adellape force-pushed the olmv1_rn branch from 7744d10 to 24b7898 Compare October 18, 2023 20:08

adellape added peer-review-needed Signifies that the peer review team needs to review this PR and removed peer-review-done Signifies that the peer review team has reviewed this PR labels Oct 18, 2023

jldohmann added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Oct 18, 2023

jldohmann reviewed Oct 18, 2023

View reviewed changes

jldohmann 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 peer-review-needed Signifies that the peer review team needs to review this PR labels Oct 18, 2023

adellape force-pushed the olmv1_rn branch from 24b7898 to 5405b15 Compare October 18, 2023 21:13

jianzhangbjz reviewed Oct 19, 2023

View reviewed changes

Add OLM 1.0 relnote for 4.14

3839356

adellape force-pushed the olmv1_rn branch from 5405b15 to 3839356 Compare October 19, 2023 16:15

adellape merged commit 9d4e03c into openshift:enterprise-4.14 Oct 19, 2023
1 check passed

adellape deleted the olmv1_rn branch October 19, 2023 19:22

adellape mentioned this pull request Oct 23, 2023

OSDOCS#6669: Add OLM 1.0 arch/components #65963

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add OLM 1.0 relnote for 4.14 #63605

Add OLM 1.0 relnote for 4.14 #63605

adellape commented Aug 15, 2023 •

edited

Loading

ocpdocs-previewbot commented Aug 15, 2023 •

edited

Loading

adellape Aug 30, 2023

adellape Sep 1, 2023

adellape Sep 1, 2023 •

edited

Loading

skopacz1 commented Sep 5, 2023

skopacz1 left a comment

skopacz1 commented Sep 5, 2023

adellape Oct 18, 2023

adellape commented Oct 18, 2023 •

edited

Loading

jldohmann left a comment

jldohmann Oct 18, 2023

adellape Oct 18, 2023

jianzhangbjz Oct 19, 2023

adellape Oct 19, 2023

jianzhangbjz Oct 19, 2023

jianzhangbjz Oct 19, 2023

adellape Oct 19, 2023

adellape Oct 19, 2023

adellape Oct 19, 2023

Add OLM 1.0 relnote for 4.14 #63605

Add OLM 1.0 relnote for 4.14 #63605

Conversation

adellape commented Aug 15, 2023 • edited Loading

ocpdocs-previewbot commented Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape Sep 1, 2023 • edited Loading

Choose a reason for hiding this comment

skopacz1 commented Sep 5, 2023

skopacz1 left a comment

Choose a reason for hiding this comment

skopacz1 commented Sep 5, 2023

Choose a reason for hiding this comment

adellape commented Oct 18, 2023 • edited Loading

jldohmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape commented Aug 15, 2023 •

edited

Loading

ocpdocs-previewbot commented Aug 15, 2023 •

edited

Loading

adellape Sep 1, 2023 •

edited

Loading

adellape commented Oct 18, 2023 •

edited

Loading