Skip to content

OSDOCS#11843: Migrated mirroring content for new disconnected experience #81523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snarayan-redhat merged 1 commit into from
Sep 24, 2024
Merged

OSDOCS#11843: Migrated mirroring content for new disconnected experience #81523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,20 @@ Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Converting a connected cluster to a disconnected cluster
File: connected-to-disconnected
- Name: Mirroring in disconnected enviroments
Dir: mirroring
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About disconnected installation mirroring
File: index
- Name: Creating a mirror registry with mirror registry for Red Hat OpenShift
File: installing-mirroring-creating-registry
- Name: Mirroring images for a disconnected installation by using the oc adm command
File: installing-mirroring-installation-images
- Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
File: installing-mirroring-disconnected
- Name: Mirroring images for a disconnected installation using oc-mirror plugin v2
File: about-installing-oc-mirror-v2
- Name: Updating a cluster in a disconnected environment
Dir: updating
Topics:
Expand Down Expand Up @@ -152,20 +166,6 @@ Topics:
- Name: Support for FIPS cryptography
File: installing-fips
Distros: openshift-enterprise,openshift-online
- Name: Disconnected installation mirroring
Dir: disconnected_install
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About disconnected installation mirroring
File: index
- Name: Creating a mirror registry with mirror registry for Red Hat OpenShift
File: installing-mirroring-creating-registry
- Name: Mirroring images for a disconnected installation
File: installing-mirroring-installation-images
- Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
File: installing-mirroring-disconnected
- Name: Mirroring images for a disconnected installation using oc-mirror plugin v2
File: about-installing-oc-mirror-v2
- Name: Installing on Alibaba Cloud
Distros: openshift-origin,openshift-enterprise
Dir: installing_alibaba
Expand Down
2 changes: 1 addition & 1 deletion cicd/pipelines/creating-applications-with-cicd-pipelines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ include::modules/op-mirroring-images-to-run-pipelines-in-restricted-environment.

* xref:../../openshift_images/configuring-samples-operator.adoc#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster]

* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]
* xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]

include::modules/op-running-a-pipeline.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion cicd/pipelines/installing-pipelines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ include::modules/op-performance-tuning-using-tektonconfig-cr.adoc[leveloffset=+1

** xref:../../openshift_images/configuring-samples-operator.adoc#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster]

** xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]
** xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]

2 changes: 1 addition & 1 deletion ...sing_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ After you push the `odo` init image, you must xref:../../../cli_reference/develo
[role="_additional-resources"]
.Additional resources
ifdef::openshift-enterprise,openshift-webscale[]
* xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Mirroring images for a disconnected installation]
* xref:../../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Mirroring images for a disconnected installation]
endif::[]
* xref:../../../registry/accessing-the-registry.adoc#registry-accessing-directly_accessing-the-registry[Accessing the registry]
2 changes: 1 addition & 1 deletion cli_reference/opm/cli-opm-ref.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ ifndef::openshift-rosa,openshift-dedicated[]

* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format]
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
endif::openshift-rosa,openshift-dedicated[]

include::modules/opm-cli-ref-init.adoc[leveloffset=+1]
Expand Down
0 installing/disconnected_install/_attributes → disconnected/mirroring/_attributes
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ...nstall/about-installing-oc-mirror-v2.adoc → ...roring/about-installing-oc-mirror-v2.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ include::modules/oc-mirror-workflows-fully-disconnected-v2.adoc[leveloffset=+2]
include::modules/oc-mirror-mirror-to-disk-v2.adoc[leveloffset=+2]
include::modules/oc-mirror-disk-to-mirror-v2.adoc[leveloffset=+2]

[id="additional-resources"]
[id="additional-resources_{context}"]
== Additional resources

* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[Updating a cluster in a disconnected environment using the OpenShift Update Service].
* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[Updating a cluster in a disconnected environment using the OpenShift Update Service]

// About custom resources generated by v2
include::modules/oc-mirror-IDMS-ITMS-about.adoc[leveloffset=+1]
Expand Down Expand Up @@ -114,4 +114,4 @@ include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+1]

// Command reference for oc-mirror v2
include::modules/oc-mirror-command-reference-v2.adoc[leveloffset=+1]
* xref:../../installing/disconnected_install/about-installing-oc-mirror-v2.adoc#oc-mirror-updating-cluster-manifests-v2_about-installing-oc-mirror-v2[Configuring your cluster to use the resources generated by oc-mirror]
* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-updating-cluster-manifests-v2_about-installing-oc-mirror-v2[Configuring your cluster to use the resources generated by oc-mirror]
1 change: 1 addition & 0 deletions disconnected/mirroring/images
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../images/
6 changes: 3 additions & 3 deletions installing/disconnected_install/index.adoc → disconnected/mirroring/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ You can use a mirror registry to ensure that your clusters only use container im
[id="creating-mirror-registry"]
== Creating a mirror registry

If you already have a container image registry, such as Red Hat Quay, you can use it as your mirror registry. If you do not already have a registry, you can xref:../../installing/disconnected_install/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[create a mirror registry using the _mirror registry for Red Hat OpenShift_].
If you already have a container image registry, such as Red Hat Quay, you can use it as your mirror registry. If you do not already have a registry, you can xref:../../disconnected/mirroring/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[create a mirror registry using the _mirror registry for Red Hat OpenShift_].

[id="mirroring-images-disconnected-install"]
== Mirroring images for a disconnected installation

You can use one of the following procedures to mirror your {product-title} image repository to your mirror registry:

* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Mirroring images for a disconnected installation]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
* xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Mirroring images for a disconnected installation by using the oc adm command]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
6 changes: 3 additions & 3 deletions ...stalling-mirroring-creating-registry.adoc → ...stalling-mirroring-creating-registry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]

The _mirror registry for Red Hat OpenShift_ is a small and streamlined container registry that you can use as a target for mirroring the required container images of {product-title} for disconnected installations.

If you already have a container image registry, such as Red Hat Quay, you can skip this section and go straight to xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository].
If you already have a container image registry, such as Red Hat Quay, you can skip this section and go straight to xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository].

[id="prerequisites_installing-mirroring-creating-registry"]
== Prerequisites
Expand Down Expand Up @@ -46,6 +46,6 @@ include::modules/mirror-registry-troubleshooting.adoc[leveloffset=+1]

* link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/manage_red_hat_quay/using-ssl-to-protect-quay#configuring_the_system_to_trust_the_certificate_authority[Configuring the system to trust the certificate authority]

* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository]
* xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository]

* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
* xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
24 changes: 12 additions & 12 deletions ...ll/installing-mirroring-disconnected.adoc → ...ng/installing-mirroring-disconnected.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See the xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.
Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See the xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.

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.

Expand Down Expand Up @@ -39,7 +39,7 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to Red Hat Quay, see the documentation on deploying Red Hat Quay link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[by using the Red Hat Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
====
+
If you do not already have an existing solution for a container image registry, subscribers of {product-title} are provided a xref:../../installing/disconnected_install/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[mirror registry for Red Hat OpenShift]. The _mirror registry for Red Hat OpenShift_ is included with your subscription and is a small-scale container registry that can be used to mirror the required container images of {product-title} in disconnected installations.
If you do not already have an existing solution for a container image registry, subscribers of {product-title} are provided a xref:../../disconnected/mirroring/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[mirror registry for Red Hat OpenShift]. The _mirror registry for Red Hat OpenShift_ is included with your subscription and is a small-scale container registry that can be used to mirror the required container images of {product-title} in disconnected installations.

[id="mirroring-preparing-your-hosts"]
== Preparing your mirror hosts
Expand All @@ -63,14 +63,14 @@ include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-imageset-config-params_installing-mirroring-disconnected[Image set configuration parameters]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
* xref:../../disconnected/updating/disconnected-update-osus.adoc#update-service-overview_updating-disconnected-cluster-osus[Using the OpenShift Update Service in a disconnected environment]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#oc-mirror-imageset-config-params_installing-mirroring-disconnected[Image set configuration parameters]
* xref:../../disconnected/mirroring/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]

[id="mirroring-image-set"]
== Mirroring an image set to a mirror registry

You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[partially disconnected environment] or in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[fully disconnected environment].
You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[partially disconnected environment] or in a xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#mirroring-image-set-full[fully disconnected environment].

These procedures assume that you already have your mirror registry set up.

Expand All @@ -85,7 +85,7 @@ include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+3]
[id="mirroring-image-set-full"]
=== Mirroring an image set in a fully disconnected environment

To mirror an image set in a fully disconnected environment, you must first xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-mirror-to-disk_installing-mirroring-disconnected[mirror the image set to disk], then xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-disk-to-mirror_installing-mirroring-disconnected[mirror the image set file on disk to a mirror].
To mirror an image set in a fully disconnected environment, you must first xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#oc-mirror-mirror-to-disk_installing-mirroring-disconnected[mirror the image set to disk], then xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#oc-mirror-disk-to-mirror_installing-mirroring-disconnected[mirror the image set file on disk to a mirror].

// Mirroring from mirror to disk
include::modules/oc-mirror-mirror-to-disk.adoc[leveloffset=+3]
Expand All @@ -104,10 +104,10 @@ include::modules/oc-mirror-updating-use-cases.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources

* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
* xref:../../disconnected/mirroring/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]
Expand All @@ -119,7 +119,7 @@ include::modules/oc-mirror-oci-format.adoc[leveloffset=+1]
.Additional resources

// TODO: This title might need to update per sebastian's PR
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]
* xref:../../disconnected/mirroring/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]
Expand Down
Loading