:_mod-docs-content-type: ASSEMBLY
[id="installing-mirroring-disconnected"]
= Mirroring images for a disconnected installation using the oc-mirror plugin
include::_attributes/common-attributes.adoc[]
:context: installing-mirroring-disconnected

toc::[]

[role="_abstract"]
You can run your cluster in a restricted network by installing from a mirrored set of {product-title} container images in a private registry. This registry must be running whenever the cluster is running.

You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.

[IMPORTANT]
====
The oc-mirror v1 plugin is deprecated. Specify the `--v1` flag to continue using the v1 plugin, or migrate to the supported v2 plugin and use the `--v2` flag. Transition to the oc-mirror v2 plugin for continued support and improvements.

For more information, see "Mirroring images for a disconnected installation" using oc-mirror plugin v2.
====

// About the oc-mirror plugin
include::modules/oc-mirror-about.adoc[leveloffset=+1]

// oc-mirror compatibility and support
include::modules/oc-mirror-support.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]

// About the mirror registry
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]

// Prerequisites
include::modules/installing-mirroring-disconnected-prerequisites.adoc[leveloffset=+1]

// Preparing your mirror hosts
include::modules/installing-mirroring-disconnected-preparing-hosts.adoc[leveloffset=+1]

// Installing the oc-mirror OpenShift CLI plugin
include::modules/oc-mirror-installing-plugin.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-installing-plugins_cli-extend-plugins[Installing and using CLI plugins]

// Configuring credentials that allow images to be mirrored
include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+2]

// Creating the image set configuration
include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-imageset-config-params_installing-mirroring-disconnected[Image set configuration parameters]
* xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
* xref:../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[Using the OpenShift Update Service in a disconnected environment]

// Mirroring an image set to a mirror registry
include::modules/installing-mirroring-disconnected-mirroring-image-set.adoc[leveloffset=+1]

// Mirroring an image set in a partially disconnected environment
include::modules/installing-mirroring-disconnected-partial.adoc[leveloffset=+2]

// Mirroring from mirror to mirror
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+3]

// Mirroring an image set in a partially disconnected environment
include::modules/installing-mirroring-disconnected-full.adoc[leveloffset=+2]

// Mirroring from mirror to disk
include::modules/oc-mirror-mirror-to-disk.adoc[leveloffset=+3]

// Mirroring from disk to mirror in a disconnected environment
include::modules/oc-mirror-disk-to-mirror.adoc[leveloffset=+3]

// Configuring your cluster to use the resources generated by oc-mirror
include::modules/oc-mirror-updating-cluster-manifests.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to a cluster]

// About updating your mirror registry content
include::modules/oc-mirror-updating-registry-about.adoc[leveloffset=+1]

include::modules/oc-mirror-updating-use-cases.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
* xref:../disconnected/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
* xref:../disconnected/installing-mirroring-disconnected.adoc#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
* xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]

// Performing a dry run
include::modules/oc-mirror-dry-run.adoc[leveloffset=+1]

// Including local OCI Operator catalogs
include::modules/oc-mirror-oci-format.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

// TODO: This title might need to update per sebastian's PR
* xref:../disconnected/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]

// Image set configuration parameters
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+1]

// Image set configuration examples
include::modules/oc-mirror-image-set-config-examples.adoc[leveloffset=+1]

// Command reference for oc-mirror
include::modules/oc-mirror-command-reference.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_installing-mirroring-disconnected"]
== Additional resources

* xref:../disconnected/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation using oc-mirror plugin v2]

* xref:../disconnected/updating/index.adoc#about-disconnected-updates[About cluster updates in a disconnected environment]
