1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-13626: updates oc mirror to v2

This commit is contained in:
“Shauna Diaz”
2025-08-04 07:56:03 -04:00
committed by openshift-cherrypick-robot
parent d93dab0fb8
commit 6e8c982363
17 changed files with 344 additions and 260 deletions

View File

@@ -18,8 +18,7 @@ include::modules/microshift-olm-deploy-op-disconnected-con.adoc[leveloffset=+1]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]
//OCP module, edit with conditionals and care
include::modules/oc-mirror-dry-run.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-dry-run.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-embed-ops-disconnected-use.adoc[leveloffset=+2]

View File

@@ -1,57 +1,49 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-operators-oc-mirror"]
= Creating custom catalogs using the oc-mirror plugin
= Creating custom Operator catalogs using the oc-mirror plugin
include::_attributes/attributes-microshift.adoc[]
:context: microshift-operators-oc-mirror
toc::[]
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin.
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror {oc-first} plugin.
[id="microshift-olm-red-hat-ops-mirror_{context}"]
== Using Red Hat-provided Operator catalogs and mirror registries
You can filter and prune catalogs to get specific Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin. You can also use Operators in disconnected settings or embedded in {op-system-ostree-first} images. To read more details about how to configure your systems for mirroring, use the links in the following "Additional resources" section. If you are ready to deploy Operators from Red Hat-provided Operator catalogs, mirror them, or to embed them in {op-system-ostree} images, start with the following section, "Inspecting catalog contents by using the oc-mirror plugin."
//additional resources for deploying operators in disconnected environments
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
include::modules/microshift-olm-rh-ops-mirror.adoc[leveloffset=+1]
include::modules/microshift-oc-mirror-about-con.adoc[leveloffset=+1]
//additional resources for preqeq to using oc mirror
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#prerequisites_installing-mirroring-disconnected[Installing the oc mirror plugin]
include::modules/microshift-oc-mirror-connectivity.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+1]
//First, make the image sets
include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=+1]
//OCP module, reference for valid imageset parameters for microshift; see conditionals
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+3]
include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+2]
//additional resources for creating image sets
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#oc-mirror-image-set-examples_installing-mirroring-disconnected[Imageset configuration examples]
// OCP module, mirroring from mirror to mirror
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+2]
//additional resources for microshift mirror to mirror module
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
//mirroring from mirror to mirror
include::modules/microshift-oc-mirror-to-mirror.adoc[leveloffset=+1]
//Convert the imageset file and add configuration to CRI-O
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+1]
//Apply changes to cluster so it can use Operators
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+2]
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+1]
[id="Additional-resources_microshift-operators-oc-mirror_{context}"]
[role="_additional-resources"]
== Additional resources
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[Installing the oc mirror plugin]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-migration-v1-to-v2[Migrating from oc-mirror plugin v1 to v2]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-custom-resources-v2_about-installing-oc-mirror-v2[About custom resources generated by oc-mirror plugin v2]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-about-cache-and-workspace-dirs_about-installing-oc-mirror-v2[About the --cache-dir and --workspace flags]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-procedure-delete-v2_about-installing-oc-mirror-v2[Deleting images from a disconnected environment]
{microshift-short} links::
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-deploy-with-mirror-registry[Mirroring container images for disconnected installations]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]

View File

@@ -6,7 +6,9 @@ include::_attributes/attributes-microshift.adoc[]
toc::[]
The Operator Lifecycle Manager (OLM) package manager is used in {microshift-short} for installing and running optional link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/architecture/control-plane#olm-operators_control-plane[add-on Operators].
Operator Lifecycle Manager (OLM) is used in {microshift-short} for installing and running optional add-on Operators. See the following link for more information:
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/operators/understanding-operators#operator-lifecycle-manager-olm[Operator Lifecycle Manager]
[id="microshift-olm-considerations_{context}"]
== Considerations for using OLM with {microshift-short}