OSDOCS#6669: Add OLM 1.0 arch/components by adellape · Pull Request #65963 · openshift/openshift-docs

adellape · 2023-10-09T18:34:04Z

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

OCP 4.14

Updates the About OLM 1.0 intro with PM-approved highlights (re-purposed from the merged 4.14 release note)
- Also breaks the "Purpose" section from the assembly out into its own olmv1-about-purpose.adoc module (content already reviewed previously)
Adds a "Components and architecture" subdirectory containing an overview + assemblies for each of the 4 components:
- Components overview: All new
- Operator Controller: New, with a re-used olmv1-about-target-versions.adoc module from 4.14 OLM 1.0 Tech Preview procedures #66036 (re-used content already reviewed)
- RukPak: Re-used existing content (with minor updates) that was originally added for the Platform Operators TP feature in 4.12
- Dependency resolution: All new
- Catalogd: New, with re-used olmv1-about-catalogs.adoc and olmv1-red-hat-catalogs.adoc modules from 4.14 OLM 1.0 Tech Preview procedures #66036 (re-used content already reviewed)
Also includes the follow-ups promised re: peer review feedback in OSDOCS#6673: Add initial OLM v1 subdir #63086 (comment). I.e., the assembly that was previously titled "Managing catalogs for OLM v1 (Technology Preview)" is now titled Managing plain bundles in OLM 1.0 (Technology Preview), and has been broken up into modules (note that this might be bloating the PR to a size "XL" when it likely is more like a size "L"). But the content has already been reviewed in the previous PR.
Short addition to the existing "RukPak" section in Understanding Operators / Packaging format (which was added when Platform Operators were added for TP in 4.12) just to note that RukPak also now has the 4.14 connection with OLM 1.0, and adds a link to the new OLM 1.0 area.

Preview: https://65963--docspreview.netlify.app/openshift-enterprise/latest/operators/olm_v1/arch/olmv1-components.html

ocpdocs-previewbot · 2023-10-09T20:44:55Z

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

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

jianzhangbjz · 2023-10-23T06:44:27Z

+    "name": "example-extension",
+    "defaultChannel": "preview"
+}
+{


Lack of the ---- between each JSON section.

I can't get opm validate to validate with ---- in the file, unless you are referring to breaking up each section into separate AsciiDoc ---- code blocks. However, opm validate does pass the full index.json file as is (all JSON sections together with no separations).

jianzhangbjz · 2023-10-23T06:44:49Z

+        }
+    ]
+}
+{


Same, here lack of the ---- between each JSON section.

jianzhangbjz · 2023-10-23T07:27:11Z

Others /lgtm

skrthomas

Really snazzy! A few suggestions for you but overall lookin good :)

adellape · 2023-10-24T20:41:23Z

            "value": {
            "packageName": "example-extension",
-            "version": "v0.0.1"
+            "version": "0.0.1"


Had to drop the v here because it was failing validation:

$ opm validate plainbundlecatalog FATA[0000] error parsing bundle "example-extension.v0.0.1" version "v0.0.1": Invalid character(s) found in major number "v0"

Seems possibly related to operator-framework/operator-registry#932. Running:

$ opm version Version: version.Version{OpmVersion:"v1.30.0-2-gb1374806", GitCommit:"b1374806", BuildDate:"2023-10-24T14:02:39Z", GoOs:"darwin", GoArch:"arm64"}

adellape · 2023-10-26T18:59:30Z

/cherrypick enterprise-4.14

openshift-cherrypick-robot · 2023-10-26T19:00:13Z

@adellape: #65963 failed to apply on top of branch "enterprise-4.14":

Applying: Add OLM 1.0 arch/components
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
Falling back to patching base and 3-way merge...
Removing operators/olm_v1/olmv1-packaging-format.adoc
Removing operators/olm_v1/olmv1-managing-catalogs.adoc
Removing modules/olmv1-catalog-plain.adoc
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
CONFLICT (content): Merge conflict in _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Add OLM 1.0 arch/components
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".

Details

In response to this:

/cherrypick enterprise-4.14

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.

openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 9, 2023

adellape force-pushed the arch_olmv1 branch 3 times, most recently from 511aecf to 4f09cc3 Compare October 9, 2023 19:59

adellape changed the title ~~Add OLMv1 dir and plain+v0 assembly~~ Add OLM 1.0 arch/components Oct 9, 2023

adellape force-pushed the arch_olmv1 branch 2 times, most recently from 0676406 to 2a09c41 Compare October 9, 2023 20:28

adellape added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 9, 2023

adellape added this to the Planned for 4.14 GA milestone Oct 9, 2023

adellape added the branch/enterprise-4.14 label Oct 9, 2023

adellape changed the title ~~Add OLM 1.0 arch/components~~ OSDOCS#6669: Add OLM 1.0 arch/components Oct 9, 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 Oct 9, 2023

adellape changed the title ~~OSDOCS#6669: Add OLM 1.0 arch/components~~ [WIP] OSDOCS#6669: Add OLM 1.0 arch/components Oct 10, 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 Oct 10, 2023

adellape mentioned this pull request Oct 10, 2023

OSDOCS#6673: Add initial OLM v1 subdir #63086

Merged

adellape force-pushed the arch_olmv1 branch 4 times, most recently from 4ccd705 to 72fced4 Compare October 10, 2023 20:04

openshift-ci Bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 10, 2023

adellape force-pushed the arch_olmv1 branch 5 times, most recently from 72cc804 to b938783 Compare October 18, 2023 14:06

adellape force-pushed the arch_olmv1 branch from b938783 to df4e8a1 Compare October 18, 2023 17:46

adellape mentioned this pull request Oct 18, 2023

Add OLM 1.0 relnote for 4.14 #63605

Merged

adellape force-pushed the arch_olmv1 branch from df4e8a1 to d9847da Compare October 20, 2023 18:01

adellape force-pushed the arch_olmv1 branch 9 times, most recently from 62e0ebb to 545ebf9 Compare October 23, 2023 01:45

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

adellape force-pushed the arch_olmv1 branch from 545ebf9 to 75057cc Compare October 23, 2023 02:25

jianzhangbjz reviewed Oct 23, 2023

View reviewed changes

skrthomas 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 Oct 23, 2023

skrthomas reviewed Oct 23, 2023

View reviewed changes

Comment thread operators/olm_v1/arch/olmv1-operator-controller.adoc Outdated

skrthomas reviewed Oct 23, 2023

View reviewed changes

Comment thread operators/olm_v1/arch/olmv1-operator-controller.adoc Outdated

Comment thread operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc Outdated

Comment thread snippets/olmv1-operator-api-group.adoc Outdated

skrthomas 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 Oct 23, 2023

adellape force-pushed the arch_olmv1 branch from 75057cc to c9d1aaf Compare October 24, 2023 20:33

adellape commented Oct 24, 2023

View reviewed changes

Add OLM 1.0 arch/components

699bbb0

adellape force-pushed the arch_olmv1 branch from c9d1aaf to 699bbb0 Compare October 26, 2023 16:33

openshift-ci Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 26, 2023

adellape merged commit a61ddf3 into openshift:main Oct 26, 2023

adellape deleted the arch_olmv1 branch October 26, 2023 18:58

adellape mentioned this pull request Oct 26, 2023

[enterprise-4.14] Add OLM 1.0 arch/components #66987

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

OSDOCS#6669: Add OLM 1.0 arch/components#65963
adellape merged 1 commit intoopenshift:mainfrom
adellape:arch_olmv1

adellape commented Oct 9, 2023 •

edited

Loading

Uh oh!

ocpdocs-previewbot commented Oct 9, 2023 •

edited

Loading

Uh oh!

jianzhangbjz Oct 23, 2023

Uh oh!

adellape Oct 24, 2023 •

edited

Loading

Uh oh!

jianzhangbjz Oct 23, 2023

Uh oh!

jianzhangbjz commented Oct 23, 2023

Uh oh!

Uh oh!

skrthomas left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adellape Oct 24, 2023 •

edited

Loading

Uh oh!

adellape commented Oct 26, 2023

Uh oh!

openshift-cherrypick-robot commented Oct 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

adellape commented Oct 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Oct 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jianzhangbjz Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

adellape Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jianzhangbjz Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

jianzhangbjz commented Oct 23, 2023

Uh oh!

Uh oh!

skrthomas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adellape Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adellape commented Oct 26, 2023

Uh oh!

openshift-cherrypick-robot commented Oct 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

adellape commented Oct 9, 2023 •

edited

Loading

ocpdocs-previewbot commented Oct 9, 2023 •

edited

Loading

adellape Oct 24, 2023 •

edited

Loading

adellape Oct 24, 2023 •

edited

Loading