OSDOCS-8990: Adds oc mirror for MicroShift operator deployment with OLM

[ShaunaDiaz]

trafficstars

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Adding OLM Operators to an offline cluster

QE review:

• [ ] QE has approved this change.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue:

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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]

🤖 Fri Apr 05 10:39:08 - Prow CI generated the docs preview:

https://71992--ocpdocs-pr.netlify.app/ https://71992--ocpdocs-pr.netlify.app/microshift/latest/microshift_running_apps/microshift_operators/microshift-operators-oc-mirror-disconnected.html https://71992--ocpdocs-pr.netlify.app/microshift/latest/microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.html https://71992--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/disconnected_install/installing-mirroring-disconnected.html https://71992--ocpdocs-pr.netlify.app/openshift-enterprise/latest/updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.html

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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.

[sherine-k]

Hi @ShaunaDiaz Nice and clear doc about the mirroring process. :+1: It's interesting to see which parts of oc-mirror are getting used by other OCP products! and we thank you for approaching the team for review.

For the heads up, oc-mirror is gradually migrating to its v2, and this will have impact on the contents of this doc:

• storageConfig is not needed nor used in v2.
• ImageContentSourcePolicy is not generated in favor of ImageDigestMirrorSet(IDMS) and ImageTagMirrorSet. I' m not sure if those custom resources can be deployed to Microshift directly : this might replace the process by which you generate registries.conf for CRI-O from ICSP.
• In V2, mappings.txt is not sure to be generated in this exact format, because the current oc-mirror uses a deprecated portion of the oc packages to generate it, and we' re replacing this deprecated code.
• To use widely available Operators in a Red Hat Enterprise Linux for Edge (RHEL for Edge), use oc-mirror in dry-run mode to produce the filtered down catalog index. : oc-mirror v2 will not create filtered catalog index. But I think you can use opm binary to generate file-based catalog formats.
• By the way, apart from the results folder, I do not recommend to suggest to users to consider contents of oc-mirror-workspace as outputs of oc-mirror: these are temporary files that are used internally by oc-mirror, and will not be available with the v2 anymore. Ex: the index.json used in step2 of Using catalog and Operator images offline in RHEL for Edge

PS: oc-mirror v2 TechPreview 4.16

Please feel free to reach out for further questions / to look for alternatives to the features not added in v2 of oc-mirror / or to request reshaping some features of oc-mirror according to the needs of microshift.

[kuiwang02]

@ShaunaDiaz olm supports micorshift from 4.15, so should remove label branch/enterprise-4.14. and the example should be 4.15, not 4.14.

[kuiwang02]

for current code, only one comment https://github.com/openshift/openshift-docs/pull/71992#issuecomment-2008594542 for others, lgtm.

[aguidirh]

Hello @ShaunaDiaz and @pmtk,

Thanks for all the details you added about the oc-mirror mirroring process.

I have similar comments as already mentioned by @sherine-k above:

• oc-mirror-workspace/src must not be used, the files inside of this folder are for oc-mirror internal usage.
• storageConfig is not going to be in the oc-mirror v2 so probably we will need to update the docs later when V2 becomes the default
• ImageContentSourcePolicy is going to be replaced by ImageDigestMirrorSet (IDMS) and ImageTagMirrorSet (ITMS) in V2
• oc-mirror dry-run in v2 will not generate a filtered catalog index
• mappings.txt won't be available in v2 with the same format

Please feel free to reach out for futher questions.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Adding OLM Operators to an offline cluster

QE review:

• [x] 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.

[michaelryanpeter]

/label peer-review-in-progress

[ShaunaDiaz]

/label peer-review-needed

[pmtk]

/lgtm

[openshift-ci[bot]]

New changes are detected. LGTM label has been removed.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Adding OLM Operators to a disconnected cluster

QE review:

• [x] 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.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Add xrefs to install book OpenShift module edits--Mirroring for installation OpenShift module edits--Updating a disconnected cluster

QE review:

• [x] 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.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Add xrefs to install book OpenShift module edits--Mirroring for installation OpenShift module edits--Updating a disconnected cluster

QE review:

• [x] 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.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Add xrefs to install book oc mirror use for RHEL for Edge OpenShift module edits--Mirroring for installation OpenShift module edits--Updating a disconnected cluster

QE review:

• [x] 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.

[openshift-ci-robot]

@ShaunaDiaz: This pull request references OSDOCS-8990 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.

In response to this:

Version(s): 4.15+

Issue: OSDOCS-8990

Link to docs preview: The oc mirror tool for Operators Add xrefs to install book oc mirror use for RHEL for Edge OpenShift module edits--Mirroring for installation OpenShift module edits--Updating a disconnected cluster

QE review:

• [x] 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.

[openshift-ci[bot]]

@ShaunaDiaz: 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.

[ShaunaDiaz]

/cherrypick enterprise-4.15

[ShaunaDiaz]

/cherrypick enterprise-4.16

[openshift-cherrypick-robot]

@ShaunaDiaz: new pull request created: #74256

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-cherrypick-robot]

@ShaunaDiaz: new pull request created: #74257

In response to this:

/cherrypick enterprise-4.16

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.

[ShaunaDiaz]

/cherrypick enterprise-4.15

[openshift-cherrypick-robot]

@ShaunaDiaz: new pull request created: #74259

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.

[ShaunaDiaz]

/cherrypick enterprise-4.15

[openshift-cherrypick-robot]

@ShaunaDiaz: new pull request created: #74262

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.