Skip to content

OSDOCS#6673: Add initial OLM v1 subdir#63086

Merged
adellape merged 1 commit intoopenshift:mainfrom
adellape:plainv0_proc
Oct 10, 2023
Merged

OSDOCS#6673: Add initial OLM v1 subdir#63086
adellape merged 1 commit intoopenshift:mainfrom
adellape:plainv0_proc

Conversation

@adellape
Copy link
Copy Markdown
Contributor

@adellape adellape commented Aug 2, 2023

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

OCP 4.14

Creates a new subdir for OLM v1 (Technology Preview), which at this initial point includes:

  • About OLM v1: Intro to OLM v1 and sets context for what's actually available during this TP phase.
  • Packaging format: This is primarily re-using existing modules from the 4.12 TP phase of Platform Operators, which also used (an older version of) RukPak. The content will be updated for newer OLM v1 changes in a separate PR.
  • Managing catalogs: Contains procedures for creating file-based catalogs that use the new plain bundle type.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 2, 2023
@adellape adellape changed the title Add initial OLM v1 subdir [WIP] OSDOCS#6673: Add initial OLM v1 subdir Aug 2, 2023
@openshift-ci 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 2, 2023
@adellape adellape added branch/enterprise-4.14 and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Aug 2, 2023
@adellape adellape added this to the Planned for 4.14 GA milestone Aug 2, 2023
@ocpdocs-previewbot
Copy link
Copy Markdown

ocpdocs-previewbot commented Aug 2, 2023

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

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

@openshift-ci 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 2, 2023
@adellape adellape force-pushed the plainv0_proc branch 2 times, most recently from 181b5a7 to 35c53e8 Compare August 8, 2023 20:11
Comment thread modules/olmv1-catalog-plain.adoc Outdated
@adellape adellape changed the title [WIP] OSDOCS#6673: Add initial OLM v1 subdir OSDOCS#6673: Add initial OLM v1 subdir Aug 21, 2023
@openshift-ci 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 Aug 21, 2023
@adellape adellape force-pushed the plainv0_proc branch 3 times, most recently from 56c5e6e to 5a059b1 Compare August 28, 2023 18:51
Comment thread modules/olmv1-catalog-plain.adoc
Comment thread modules/olmv1-catalog-plain.adoc Outdated
"name": "<extension_name>.v<version>",
"package": "<extension_name>",
"image": "quay.io/<organization_name>/<repository_name>:<image_tag>",
"properties": [
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

It's better to add the olm.gvk and olm.bundle.object types.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jianzhangbjz why do we have to add those types? My assumption was that for plain bundle, they're not really required.

@adellape adellape force-pushed the plainv0_proc branch 2 times, most recently from d9967e6 to eebb825 Compare August 29, 2023 17:15
@adellape adellape force-pushed the plainv0_proc branch 2 times, most recently from 194e037 to 7ac1979 Compare October 3, 2023 16:50

After running OLM in production clusters for many releases, it became apparent that there is a desire to deviate from this coupling of CRDs and controllers to encompass the lifecycling of extensions that are not just Operators.

Some of the goals of OLM v1 over the upcoming releases include improving Operator and extension lifecycle management in the following areas:
Copy link
Copy Markdown
Contributor Author

@adellape adellape Oct 3, 2023

Choose a reason for hiding this comment

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

[re: avoiding future claims] Checking with PM on how/if we want to make any statements like this. Included it here to try to give a brief sense that this release is just a first step of what ultimately will feed into OLM v1's bigger picture when it's more fully-realized.

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.

Assuming you get approval on the specifics of the plan/claim, the language seems fine to me.

@adellape adellape added the peer-review-needed Signifies that the peer review team needs to review this PR label Oct 3, 2023
@jeana-redhat jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Oct 3, 2023
Copy link
Copy Markdown
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

Really nice stuff! Just a few issues here; a lot of this is just commentary/things to think about

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

Comment thread modules/olm-rukpak-about.adoc
Comment thread modules/olm-rukpak-about.adoc
Comment thread operators/olm_v1/index.adoc
Comment thread operators/olm_v1/index.adoc
Comment thread operators/olm_v1/index.adoc
Comment thread modules/olmv1-catalog-plain.adoc
Comment thread modules/olmv1-catalog-plain.adoc
Comment thread modules/olmv1-catalog-plain.adoc
Comment thread modules/olmv1-catalog-plain.adoc
Comment thread modules/olmv1-catalog-plain.adoc
@openshift-ci openshift-ci Bot 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 3, 2023
@openshift-ci openshift-ci Bot removed the peer-review-needed Signifies that the peer review team needs to review this PR label Oct 3, 2023
@adellape
Copy link
Copy Markdown
Contributor Author

Because my #65963 and Michael's #65847 were branched off of this PR, I am going to merge this one as-is and then apply Jeana's peer review comments to my #65963, because I've done quite a bit of file-moving-around in that one.

@adellape adellape merged commit 2d62321 into openshift:main Oct 10, 2023
@adellape adellape deleted the plainv0_proc branch October 10, 2023 16:17
@adellape
Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.14

@openshift-cherrypick-robot
Copy link
Copy Markdown

@adellape: new pull request created: #66017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.14 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