OSDOCS-8991: OLM on MicroShift intro by ShaunaDiaz · Pull Request #70128 · openshift/openshift-docs

ShaunaDiaz · 2024-01-11T18:42:23Z

Version(s):
4.15+

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift
xref in Install with RPMs
xref in Add to Blueprint

QE review:

QE has approved this change.

Additional information:
Install updates for OLM
SME and PM LGTM 2 Feb 2024

openshift-ci-robot · 2024-01-11T18:42:26Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:

QE review:

QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2024-01-11T18:48:53Z

🤖 Wed Feb 07 16:09:59 - Prow CI generated the docs preview: https://70128--ocpdocs-pr.netlify.app

openshift-ci-robot · 2024-01-11T19:19:45Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift

QE review:

QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

kevinrizza

Just one comment on the existing content. Otherwise, I think the only other bits that are missing are that I would have expected something specific about how to install OLM itself with a microshift cluster.

openshift-ci-robot · 2024-01-19T14:52:50Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift

QE review:

QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

ShaunaDiaz · 2024-01-19T15:44:26Z

/retest

kevinrizza · 2024-01-22T14:23:56Z

lgtm

pmtk

/lgtm

ShaunaDiaz · 2024-02-02T11:40:56Z

@kuiwang02 A few things about the goal of this PR to help:

This is a foundational PR; I expect to add links to other elements as they are completed, such as offine use and installing OLM. Docs epic: https://issues.redhat.com/browse/OSDOCS-7079
** Disconnected and offline use for MicroShift will come in a later PR. I will add links to that section once complete.
** We will add OLM and Operators for offline use as a compliment to our existing workflow in another PR. The oc mirror docs team is being asked to document a single procedure that we can link to, so we hope that is coming soon.
We discussed with OLM engineering leads yesterday, and they prefer we use curated links for catalog building (either method). I will update the links as you suggested.

Other than the unfinished nature of the information, do you agree that the procedures we worked on are correct?

DanielFroehlich

/lgtm

ShaunaDiaz · 2024-02-02T15:15:50Z

/label peer-review-needed

ShaunaDiaz · 2024-02-02T15:34:19Z

Last few updates (bb2b4a4 to fa372d6) removed changes to OLM doc modules that are not used in this PR.

pmtk · 2024-02-02T15:52:33Z

/lgtm

openshift-ci · 2024-02-02T18:29:02Z

New changes are detected. LGTM label has been removed.

ShaunaDiaz · 2024-02-02T18:34:15Z

c62731d rebase to scoop up install xrefs

ShaunaDiaz · 2024-02-02T19:09:23Z

/remove-label peer-review-needed

ShaunaDiaz · 2024-02-02T19:15:33Z

4b0701b adding/fixing xrefs to Install modules (and back to OLM assembly from the installation chapters)

ShaunaDiaz · 2024-02-02T19:18:06Z

/label peer-review-needed

openshift-ci-robot · 2024-02-02T19:20:25Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift
xref in Install with RPMs
xref in Add to Blueprint

QE review:

QE has approved this change.

Additional information:
Install updates for OLM

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-02-02T19:31:31Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift
xref in Install with RPMs
xref in Add to Blueprint

QE review:

QE has approved this change.

Additional information:
Install updates for OLM
SME and PM LGTM 2 Feb 2024

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 openshift-eng/jira-lifecycle-plugin repository.

ShaunaDiaz · 2024-02-02T19:31:51Z

/label peer-review-needed

kuiwang02 · 2024-02-04T03:06:50Z

Using OLM with MicroShift

@ShaunaDiaz Thanks.
let's review this PR per current scope.

1, https://70128--ocpdocs-pr.netlify.app/microshift/latest/microshift_running_apps/microshift-operators-olm#microshift-olm-namespaces_microshift-operators-olm
The global namespace. Empty by default. This namespace must be set in the catalog source YAML if you want the catalog source to be available globally to users in all namespaces. An Operator group in this namespace is set to All Namespaces mode by default. should be The global namespace. Empty by default. This namespace must be set in the catalog source YAML if you want the catalog source to be available globally to users in all namespaces. because Operator group is in openshift-operators ns, not openshift-marketplace

of course, you could move An Operator group in this namespace is set to All Namespaces mode by default. into description for openshift-operators

2, https://70128--ocpdocs-pr.netlify.app/microshift/latest/microshift_running_apps/microshift-operators-olm#microshift-file-based-olm-catalogs_microshift-operators-olm
I suggest to remove the link https://access.redhat.com/documentation/en-us/openshift_container_platform/4.15/html/operators/understanding-operators#olm-fb-catalogs-example_olm-packaging-format. and the link
https://docs.openshift.com/container-platform/4.14/operators/admin/olm-managing-custom-catalogs.html#olm-creating-fb-catalog-image_olm-managing-custom-catalogs is enough.

lpettyjo

Otherwise, LGTM! Nice work!

kuiwang02 · 2024-02-06T02:02:48Z

@ShaunaDiaz this comment is not correctly fixed.
here are the corrected per your PR.

for 1,
#70128 (comment)
#70128 (comment)

for 2,
#70128 (comment)

kuiwang02 · 2024-02-07T10:09:16Z

@ShaunaDiaz
I will take PTO from tomorrow （2/8 BJ time） and am back after Spring Festival.
after #70128 (comment) is fixed, lgtm for me.

openshift-ci-robot · 2024-02-07T11:09:49Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift
xref in Install with RPMs
xref in Add to Blueprint

QE review:

QE has approved this change.

Additional information:
Install updates for OLM
SME and PM LGTM 2 Feb 2024

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 openshift-eng/jira-lifecycle-plugin repository.

dhensel-rh · 2024-02-07T14:17:44Z

/label qe-approved

openshift-ci-robot · 2024-02-07T14:18:24Z

@ShaunaDiaz: This pull request references OSDOCS-8991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.15+

Issue:
OSDOCS-8991

Link to docs preview:
How Operators work with MicroShift
Using OLM with MicroShift
xref in Install with RPMs
xref in Add to Blueprint

QE review:

QE has approved this change.

Additional information:
Install updates for OLM
SME and PM LGTM 2 Feb 2024

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2024-02-07T16:11:14Z

@ShaunaDiaz: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

ShaunaDiaz · 2024-02-07T16:13:43Z

/cherrypick enterprise-4.15

openshift-cherrypick-robot · 2024-02-07T16:14:34Z

@ShaunaDiaz: new pull request created: #71312

Details

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.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 11, 2024

openshift-ci Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 11, 2024

ShaunaDiaz added this to the Planned for 4.15 GA milestone Jan 11, 2024

ShaunaDiaz added the branch/enterprise-4.15 label Jan 11, 2024

ShaunaDiaz force-pushed the OSDOCS-8991 branch from 96a6518 to c92c118 Compare January 12, 2024 16:00

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 Jan 12, 2024

ShaunaDiaz force-pushed the OSDOCS-8991 branch 3 times, most recently from 478a791 to 81fd1e8 Compare January 16, 2024 12:00

ShaunaDiaz changed the title ~~[WIP] OSDOCS-8991: OLM to on MicroShift intro~~ OSDOCS-8991: OLM to on MicroShift intro Jan 16, 2024

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 Jan 16, 2024

ShaunaDiaz force-pushed the OSDOCS-8991 branch from 81fd1e8 to 9ea5880 Compare January 16, 2024 12:40

ShaunaDiaz requested review from dhellmann, kevinrizza and pmtk January 17, 2024 14:23

kevinrizza suggested changes Jan 17, 2024

View reviewed changes

Comment thread microshift_running_apps/microshift-operators.adoc Outdated

pmtk reviewed Jan 18, 2024

View reviewed changes

Comment thread microshift_running_apps/microshift-operators.adoc Outdated

Comment thread microshift_running_apps/microshift-operators.adoc Outdated

Comment thread microshift_running_apps/microshift-operators.adoc Outdated

Comment thread microshift_running_apps/microshift-operators.adoc Outdated

ShaunaDiaz force-pushed the OSDOCS-8991 branch from 9ea5880 to a782197 Compare January 18, 2024 19:30

ShaunaDiaz removed the request for review from dhellmann January 18, 2024 19:34

ShaunaDiaz force-pushed the OSDOCS-8991 branch from a782197 to 762963a Compare January 19, 2024 14:42

ShaunaDiaz changed the title ~~OSDOCS-8991: OLM to on MicroShift intro~~ OSDOCS-8991: OLM on MicroShift intro Jan 19, 2024

pmtk reviewed Jan 22, 2024

View reviewed changes

pmtk reviewed Feb 2, 2024

View reviewed changes

Comment thread modules/microshift-olm-build-op-catalogs.adoc Outdated

DanielFroehlich approved these changes Feb 2, 2024

View reviewed changes

dhensel-rh reviewed Feb 2, 2024

View reviewed changes

Comment thread modules/microshift-olm-deploy-ops-spec-ns.adoc Outdated

dhensel-rh reviewed Feb 2, 2024

View reviewed changes

Comment thread modules/microshift-olm-deploy-ops-spec-ns.adoc Outdated

dhensel-rh reviewed Feb 5, 2024

View reviewed changes

Comment thread modules/microshift-olm-deploy-ops-spec-ns.adoc Outdated

lpettyjo reviewed Feb 6, 2024

View reviewed changes

kuiwang02 reviewed Feb 6, 2024

View reviewed changes

Comment thread modules/microshift-olm-namespaces.adoc Outdated

Comment thread modules/microshift-olm-namespaces.adoc Outdated

Comment thread modules/microshift-olm-build-op-catalogs.adoc Outdated

OSDOCS-8991: OLM to on MicroShift intro

6bcd031

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

[enterprise-4.15] OSDOCS-8991: OLM on MicroShift intro #71312

Merged

Conversation

ShaunaDiaz commented Jan 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 11, 2024 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jan 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 11, 2024 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevinrizza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 19, 2024 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ShaunaDiaz commented Jan 19, 2024

Uh oh!

kevinrizza commented Jan 22, 2024

Uh oh!

pmtk left a comment

Choose a reason for hiding this comment

Uh oh!

ShaunaDiaz commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

DanielFroehlich left a comment

Choose a reason for hiding this comment

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

pmtk commented Feb 2, 2024

Uh oh!

openshift-ci Bot commented Feb 2, 2024

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

openshift-ci-robot commented Feb 2, 2024 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Feb 2, 2024 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ShaunaDiaz commented Feb 2, 2024

Uh oh!

Uh oh!

Uh oh!

kuiwang02 commented Feb 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

lpettyjo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShaunaDiaz commented Jan 11, 2024 •

edited

Loading

openshift-ci-robot commented Jan 11, 2024 •

edited by openshift-ci Bot

Loading

ocpdocs-previewbot commented Jan 11, 2024 •

edited

Loading

openshift-ci-robot commented Jan 11, 2024 •

edited by openshift-ci Bot

Loading

openshift-ci-robot commented Jan 19, 2024 •

edited by openshift-ci Bot

Loading

ShaunaDiaz commented Feb 2, 2024 •

edited

Loading

openshift-ci-robot commented Feb 2, 2024 •

edited by openshift-ci Bot

Loading

openshift-ci-robot commented Feb 2, 2024 •

edited by openshift-ci Bot

Loading

kuiwang02 commented Feb 4, 2024 •

edited

Loading

openshift-ci-robot commented Feb 7, 2024 •

edited by openshift-ci Bot

Loading

openshift-ci-robot commented Feb 7, 2024 •

edited by openshift-ci Bot

Loading