mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-2891: Adding docs for using the oc-mirror plug-in to mirror images for disconnected installs
This commit is contained in:
Andrea Hoffer
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
46cb9c889c
commit
ae88de0a41
@@ -106,9 +106,18 @@ Topics:
|
||||
- Name: Selecting an installation method and preparing a cluster
|
||||
File: installing-preparing
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Mirroring images for a disconnected installation
|
||||
File: installing-mirroring-installation-images
|
||||
- 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
|
||||
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 plug-in
|
||||
File: installing-mirroring-disconnected
|
||||
- Name: Installing on AWS
|
||||
Dir: installing_aws
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
|
||||
@@ -46,7 +46,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/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]
|
||||
* 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:../../cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc#mirroring-a-supported-builder-image_creating-and-deploying-a-component-to-the-disconnected-cluster[Mirroring a supported builder image]
|
||||
|
||||
|
||||
@@ -48,6 +48,6 @@ include::modules/op-pipelines-operator-in-restricted-environment.adoc[leveloffse
|
||||
|
||||
** xref:../../openshift_images/configuring-samples-operator.adoc#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster]
|
||||
|
||||
** xref:../../installing/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Creating a cluster with a mirrored registry]
|
||||
** 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:../../cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc#mirroring-a-supported-builder-image_creating-and-deploying-a-component-to-the-disconnected-cluster[Mirroring a supported builder image]
|
||||
|
||||
@@ -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/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[Mirroring images for a disconnected installation]
|
||||
* xref:../../../installing/disconnected_install/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]
|
||||
|
||||
1
installing/disconnected_install/images
Symbolic link
1
installing/disconnected_install/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../../images
|
||||
22
installing/disconnected_install/index.adoc
Normal file
22
installing/disconnected_install/index.adoc
Normal file
@@ -0,0 +1,22 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="installing-mirroring-disconnected-about"]
|
||||
= About disconnected installation mirroring
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing-mirroring-disconnected-about
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use a mirror registry to ensure that your clusters only use container images that satisfy your organizational controls on external content. Before you install a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. To mirror container images, you must have a registry for mirroring.
|
||||
|
||||
[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_].
|
||||
|
||||
[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 plug-in] (Technology Preview)
|
||||
@@ -0,0 +1,45 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="installing-mirroring-creating-registry"]
|
||||
= Creating a mirror registry
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing-mirroring-creating-registry
|
||||
|
||||
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].
|
||||
|
||||
[id="prerequisites_installing-mirroring-creating-registry"]
|
||||
== Prerequisites
|
||||
|
||||
* An {product-title} subscription.
|
||||
* {op-system-base-full} 8 with Podman 3.3 installed.
|
||||
* Fully qualified domain name for the Red Hat Quay service, which must resolve through a DNS server.
|
||||
* Passwordless `sudo` access on the target host.
|
||||
* Key-based SSH connectivity on the target host. SSH keys are automatically generated for local installs. For remote hosts, you must generate your own SSH keys.
|
||||
* 2 or more vCPUs.
|
||||
* 8 GB of RAM.
|
||||
* About 12 GB for {product-title} {product-version} release images, or about 358 GB for {product-title} {product-version} release images and {product-title} {product-version} Red Hat Operator images. Up to 1 TB per stream or more is suggested.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
These requirements are based on local testing results with only release images and Operator images. Storage requirements can vary based on your organization's needs. You might require more space, for example, when you mirror multiple z-streams. You can use standard Red Hat Quay functionality to remove unnecessary images and free up space.
|
||||
====
|
||||
|
||||
include::modules/mirror-registry-introduction.adoc[leveloffset=+1]
|
||||
include::modules/mirror-registry-localhost.adoc[leveloffset=+1]
|
||||
include::modules/mirror-registry-remote.adoc[leveloffset=+1]
|
||||
include::modules/mirror-registry-uninstall.adoc[leveloffset=+1]
|
||||
include::modules/mirror-registry-flags.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/manage_red_hat_quay/using-ssl-to-protect-quay[Using SSL to protect connections to Red Hat Quay]
|
||||
|
||||
* 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:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
|
||||
@@ -0,0 +1,128 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="installing-mirroring-disconnected"]
|
||||
= Mirroring images for a disconnected installation using the oc-mirror plug-in
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing-mirroring-disconnected
|
||||
|
||||
toc::[]
|
||||
|
||||
////
|
||||
General to do list:
|
||||
* Confirm that no new content was added since I did the reorg of the disconnected install assemblies (up to date as of 2/13)
|
||||
* Add info about mirroring to a namespace
|
||||
* Test and get some actual example output
|
||||
* Use cases for changing image set config between runs
|
||||
////
|
||||
|
||||
You can ensure your clusters only use container images that satisfy your organizational controls on external content. Before you install a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. To mirror container images, you must have a registry for mirroring.
|
||||
|
||||
You can use the oc-mirror OpenShift CLI (`oc`) plug-in to mirror images to a mirror registry in your fully or partially disconnected environments.
|
||||
|
||||
:FeatureName: Mirroring images for disconnected environments using the oc-mirror plug-in
|
||||
include::snippets/technology-preview.adoc[leveloffset=+1]
|
||||
|
||||
The following steps outline the high-level workflow on how to use the oc-mirror plug-in to mirror images to a mirror registry:
|
||||
|
||||
. Create an image set configuration file.
|
||||
. Mirror the image set to the mirror registry.
|
||||
. Install the `ImageContentSourcePolicy` and `CatalogSource` resources that were generated by oc-mirror into the cluster.
|
||||
. Repeat these steps to update your mirror registry as necessary.
|
||||
|
||||
// About the oc-mirror plug-in
|
||||
include::modules/oc-mirror-about.adoc[leveloffset=+1]
|
||||
|
||||
// TODO: Check the content of this module to make sure it's accurate for oc-mirror
|
||||
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
|
||||
|
||||
// TODO: Copied this prereq section + about mirror registry from the orig section. Review/update as necessary
|
||||
[id="prerequisites_installing-mirroring-disconnected"]
|
||||
== Prerequisites
|
||||
|
||||
* You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2] in the location that will host the {product-title} cluster, such as Red Hat Quay.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plug-in. 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.6/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.6/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/[by using the 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.
|
||||
|
||||
[id="mirroring-preparing-your-hosts"]
|
||||
== Preparing your mirror hosts
|
||||
|
||||
Before you can use the oc-mirror plug-in to mirror images, you must install the plug-in and create a container image registry credentials file to allow the mirroring from Red Hat to your mirror.
|
||||
|
||||
// Installing the oc-mirror OpenShift CLI plug-in
|
||||
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 plug-ins]
|
||||
|
||||
// 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:../../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]
|
||||
|
||||
[id="mirroring-image-set"]
|
||||
== Mirroring an image set to a mirror registry
|
||||
|
||||
You can use the oc-mirror CLI plug-in 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].
|
||||
|
||||
These procedures assume that you already have your mirror registry set up.
|
||||
|
||||
[id="mirroring-image-set-partial"]
|
||||
=== Mirroring an image set in a partially disconnected environment
|
||||
|
||||
In a partially disconnected environment, you can mirror an image set directly to the target mirror registry.
|
||||
|
||||
// Mirroring from mirror to mirror
|
||||
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].
|
||||
|
||||
// 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]
|
||||
|
||||
// Installing the ImageContentSourcePolicy and CatalogSource resources into the cluster
|
||||
include::modules/oc-mirror-updating-cluster-manifests.adoc[leveloffset=+1]
|
||||
|
||||
// TODO: Consider whether we want any sort of reference module on how to use `oc mirror` (the 3 ways etc)
|
||||
// Maybe consider adding the blurb just to the beginning of the procedure modules (the combo of params?)
|
||||
|
||||
// Updating your mirror registry with differential updates
|
||||
include::modules/oc-mirror-differential-updates.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* 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[Installing the ImageContentSourcePolicy and CatalogSource resources into the cluster]
|
||||
|
||||
// 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]
|
||||
|
||||
// TODO: Add an additional resources section to link to the non-TP assembly?
|
||||
@@ -6,14 +6,18 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use the procedures in this section to ensure your clusters only use container images that satisfy your organizational controls on external content. Before you install a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. To mirror container images, you must have a registry for mirroring.
|
||||
You can ensure your clusters only use container images that satisfy your organizational controls on external content. Before you install a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. To mirror container images, you must have a registry for mirroring.
|
||||
|
||||
// TODO: Is this procedure going to be marked deprecated for 4.10 so that it could be removed in the future?
|
||||
// TODO: Add a link to the TP procedure?
|
||||
// TODO: Consider updating the title of this one to indicate the difference? Or wait to make any changes like that til GA, til we know if it'll stick around or be completely replaced by the oc-mirror one?
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must have access to the internet to obtain the necessary container images.
|
||||
In this procedure, you place your mirror registry on a mirror host
|
||||
that has access to both your network and the Internet. If you do not have access
|
||||
to a mirror host, use the xref:../installing/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters] procedure to copy images to a device you can move across network boundaries with.
|
||||
that has access to both your network and the internet. If you do not have access
|
||||
to a mirror host, use the xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters] procedure to copy images to a device you can move across network boundaries with.
|
||||
====
|
||||
|
||||
[id="prerequisites_installing-mirroring-installation-images"]
|
||||
@@ -29,13 +33,13 @@ to a mirror host, use the xref:../installing/installing-mirroring-installation-i
|
||||
--
|
||||
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.5/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.5/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/[by using the 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/installing-mirroring-installation-images.adoc#mirror-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:../../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.
|
||||
|
||||
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
|
||||
|
||||
.Additional information
|
||||
|
||||
For information on viewing the CRI-O logs to view the image source, see xref:../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
|
||||
For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
|
||||
|
||||
[id="installing-preparing-mirror"]
|
||||
== Preparing your mirror host
|
||||
@@ -66,47 +70,6 @@ In production environments, add the required images to a registry in your restri
|
||||
modules/installation-performing-disconnected-mirror-without-registry.adoc[leveloffset=+2]
|
||||
////
|
||||
|
||||
[id="mirror-registry"]
|
||||
== Mirror registry for Red Hat OpenShift
|
||||
|
||||
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 these steps and go straight to xref:../installing/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository].
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* An {product-title} subscription.
|
||||
* {op-system-base-full} 8 with Podman 3.3 installed.
|
||||
* Fully qualified domain name for the Red Hat Quay service, which must resolve through a DNS server.
|
||||
* Passwordless `sudo` access on the target host.
|
||||
* Key-based SSH connectivity on the target host. SSH keys are automatically generated for local installs. For remote hosts, you must generate your own SSH keys.
|
||||
* 2 or more vCPUs.
|
||||
* 8 GB of RAM.
|
||||
* About 12 GB for {product-title} 4.10 Release images, or about 358 GB for {product-title} 4.10 Release images and {product-title} 4.10 Red Hat Operator images. Up to 1 TB per stream or more is suggested.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
These requirements are based on local testing results with only Release images and Operator images tested. Storage requirements can vary based on your organization's needs. Some users might require more space, for example, when they mirror multiple z-streams. You can use standard Red Hat Quay functionality to remove unnecessary images and free up space.
|
||||
====
|
||||
|
||||
include::modules/mirror-registry-introduction.adoc[leveloffset=+1]
|
||||
include::modules/mirror-registry-localhost.adoc[leveloffset=+2]
|
||||
include::modules/mirror-registry-remote.adoc[leveloffset=+2]
|
||||
include::modules/mirror-registry-uninstall.adoc[leveloffset=+2]
|
||||
include::modules/mirror-registry-flags.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/manage_red_hat_quay/using-ssl-to-protect-quay[Using SSL to protect connections to Red Hat Quay]
|
||||
|
||||
* 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/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the OpenShift Container Platform image repository]
|
||||
|
||||
* xref:../installing/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
|
||||
|
||||
|
||||
include::modules/installation-mirror-repository.adoc[leveloffset=+1]
|
||||
|
||||
[id="installing-preparing-samples-operator"]
|
||||
@@ -121,7 +84,7 @@ include::modules/olm-mirroring-catalog.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
|
||||
[id="olm-mirror-catalog-prerequisites_installing-mirroring-installation-images"]
|
||||
=== Prerequisites
|
||||
@@ -131,8 +94,8 @@ Mirroring Operator catalogs for use with disconnected clusters has the following
|
||||
* Workstation with unrestricted network access.
|
||||
* `podman` version 1.9.3 or later.
|
||||
* If you want to filter, or _prune_, the default catalog and selectively mirror only a subset of Operators, see the following sections:
|
||||
** xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[Installing the opm CLI]
|
||||
** xref:../operators/admin/olm-restricted-networks.adoc#olm-pruning-index-image_olm-restricted-networks[Filtering a SQLite-based index image]
|
||||
** xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[Installing the opm CLI]
|
||||
** xref:../../operators/admin/olm-restricted-networks.adoc#olm-pruning-index-image_olm-restricted-networks[Filtering a SQLite-based index image]
|
||||
ifndef::openshift-origin[]
|
||||
* If you want to mirror a Red Hat-provided catalog, run the following command on your workstation with unrestricted network access to authenticate with `registry.redhat.io`:
|
||||
+
|
||||
@@ -157,13 +120,13 @@ include::modules/olm-mirroring-catalog-colocated.adoc[leveloffset=+3]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators]
|
||||
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators]
|
||||
|
||||
include::modules/olm-mirroring-catalog-airgapped.adoc[leveloffset=+3]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators]
|
||||
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators]
|
||||
|
||||
include::modules/olm-mirroring-catalog-manifests.adoc[leveloffset=+2]
|
||||
include::modules/olm-mirroring-catalog-post.adoc[leveloffset=+2]
|
||||
@@ -171,7 +134,7 @@ include::modules/olm-mirroring-catalog-post.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../post_installation_configuration/preparing-for-users.adoc#post-install-mirrored-catalogs[Populating OperatorHub from mirrored Operator catalogs]
|
||||
* xref:../../post_installation_configuration/preparing-for-users.adoc#post-install-mirrored-catalogs[Populating OperatorHub from mirrored Operator catalogs]
|
||||
|
||||
[id="next-steps_installing-mirroring-installation-images"]
|
||||
== Next steps
|
||||
@@ -179,11 +142,11 @@ include::modules/olm-mirroring-catalog-post.adoc[leveloffset=+2]
|
||||
//* TODO need to add the registry secret to the machines, which is different
|
||||
|
||||
* Install a cluster on infrastructure that you provision in your restricted network, such as on
|
||||
xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[VMware vSphere],
|
||||
xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon Web Services].
|
||||
xref:../../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[VMware vSphere],
|
||||
xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon Web Services].
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="restricted-networks-additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* See xref:../support/gathering-cluster-data.adoc#gathering-data-specific-features_gathering-cluster-data[Gathering data about specific features] for more information about using must-gather.
|
||||
* See xref:../../support/gathering-cluster-data.adoc#gathering-data-specific-features_gathering-cluster-data[Gathering data about specific features] for more information about using must-gather.
|
||||
1
installing/disconnected_install/modules
Symbolic link
1
installing/disconnected_install/modules
Symbolic link
@@ -0,0 +1 @@
|
||||
../../modules/
|
||||
1
installing/disconnected_install/snippets
Symbolic link
1
installing/disconnected_install/snippets
Symbolic link
@@ -0,0 +1 @@
|
||||
../../snippets/
|
||||
@@ -70,7 +70,7 @@ If you use a user-provisioned installation method, you can configure a proxy for
|
||||
|
||||
If you want to prevent your cluster on a public cloud from exposing endpoints externally, you can deploy a private cluster with installer-provisioned infrastructure on xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[AWS], xref:../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[Azure], or xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[GCP].
|
||||
|
||||
If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user provisioned infrastructure installations into restricted networks for xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[IBM Z or LinuxONE], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[IBM Z or LinuxONE with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[IBM Power], xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], xref:../installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc#installing-restricted-networks-vmc-user-infra[VMC on AWS], or xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[VMC on AWS], xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[{rh-virtualization}], and xref:../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere].
|
||||
If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user provisioned infrastructure installations into restricted networks for xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[IBM Z or LinuxONE], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[IBM Z or LinuxONE with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[IBM Power], xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], xref:../installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc#installing-restricted-networks-vmc-user-infra[VMC on AWS], or xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[VMC on AWS], xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[{rh-virtualization}], and xref:../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere].
|
||||
|
||||
If you need to deploy your cluster to an xref:../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[AWS GovCloud region], xref:../installing/installing_aws/installing-aws-china.adoc#installing-aws-china-region[AWS China region], or xref:../installing/installing_azure/installing-azure-government-region.adoc#installing-azure-government-region[Azure government region], you can configure those custom regions during an installer-provisioned infrastructure installation.
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ In {product-title} version {product-version}, you can install a cluster on Amazo
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -30,7 +30,7 @@ The steps for performing a user-provisioned infrastructure installation are prov
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -22,7 +22,7 @@ before you attempt to install an {product-title} cluster in such an environment.
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -18,7 +18,7 @@ You can install an {product-title} cluster by using mirrored installation releas
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -25,7 +25,7 @@ The steps for performing a user-provisioned infrastructure installation are prov
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -19,7 +19,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* Before you begin the installation process, you must move or remove any existing installation files. This ensures that the required installation files are created and updated during the installation process.
|
||||
+
|
||||
[IMPORTANT]
|
||||
|
||||
@@ -25,7 +25,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You must move or remove any existing installation files, before you begin the installation process. This ensures that the required installation files are created and updated during the installation process.
|
||||
+
|
||||
[IMPORTANT]
|
||||
|
||||
@@ -25,7 +25,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* Before you begin the installation process, you must move or remove any existing installation files. This ensures that the required installation files are created and updated during the installation process.
|
||||
+
|
||||
[IMPORTANT]
|
||||
|
||||
@@ -14,7 +14,7 @@ In {product-title} {product-version}, you can install a cluster on
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -16,7 +16,7 @@ The following items are required to install an {product-title} cluster on a {rh-
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You have a supported combination of versions in the link:https://access.redhat.com/articles/5485861[Support Matrix for {product-title} on {rh-virtualization}].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -17,7 +17,7 @@ include::modules/vmc-sizer-tool.adoc[leveloffset=+2]
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtain the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtain the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -18,7 +18,7 @@ include::modules/vmc-sizer-tool.adoc[leveloffset=+2]
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -13,7 +13,7 @@ In {product-title} {product-version}, you can install a cluster on VMware vSpher
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -18,7 +18,7 @@ The steps for performing a user-provisioned infrastructure installation are prov
|
||||
|
||||
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
|
||||
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
|
||||
* You xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -1,16 +1,27 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
// * openshift_images/samples-operator-alt-registry.adoc
|
||||
// * scalability_and_performance/ztp-deploying-disconnected.adoc
|
||||
|
||||
ifeval::["{context}" == "installing-mirroring-disconnected"]
|
||||
:oc-mirror:
|
||||
endif::[]
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="installation-about-mirror-registry_{context}"]
|
||||
= About the mirror registry
|
||||
|
||||
ifndef::oc-mirror[]
|
||||
You can mirror the images that are required for {product-title} installation and subsequent product updates to a container mirror registry such as Red Hat Quay, JFrog Artifactory, Sonatype Nexus Repository, or Harbor. If you do not have access to a large-scale container registry, you can use the _mirror registry for Red Hat OpenShift_, a small-scale container registry included with {product-title} subscriptions.
|
||||
|
||||
You can use any container registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2], such as Red Hat Quay, the _mirror registry for Red Hat OpenShift_, Artifactory, Sonatype Nexus Repository, or Harbor. Regardless of your chosen registry, the procedure to mirror content from Red Hat hosted sites on the internet to an isolated image registry is the same. After you mirror the content, you configure each cluster to retrieve this content from your mirror registry.
|
||||
endif::[]
|
||||
ifdef::oc-mirror[]
|
||||
You can mirror the images that are required for {product-title} installation and subsequent product updates to a container mirror registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2], such as Red Hat Quay. If you do not have access to a large-scale container registry, you can use the _mirror registry for Red Hat OpenShift_, which is a small-scale container registry included with {product-title} subscriptions.
|
||||
|
||||
Regardless of your chosen registry, the procedure to mirror content from Red Hat hosted sites on the internet to an isolated image registry is the same. After you mirror the content, you configure each cluster to retrieve this content from your mirror registry.
|
||||
endif::[]
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
@@ -22,3 +33,7 @@ If choosing a container registry that is not the _mirror registry for Red Hat Op
|
||||
When you populate your mirror registry with {product-title} images, you can follow two scenarios. If you have a host that can access both the internet and your mirror registry, but not your cluster nodes, you can directly mirror the content from that machine. This process is referred to as _connected mirroring_. If you have no such host, you must mirror the images to a file system and then bring that host or removable media into your restricted environment. This process is referred to as _disconnected mirroring_.
|
||||
|
||||
For mirrored registries, to view the source of pulled images, you must review the `Trying to access` log entry in the CRI-O logs. Other methods to view the image pull source, such as using the `crictl images` command on a node, show the non-mirrored image name, even though the image is pulled from the mirrored location.
|
||||
|
||||
ifeval::["{context}" == "installing-mirroring-disconnected"]
|
||||
:!oc-mirror:
|
||||
endif::[]
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
// * openshift_images/samples-operator-alt-registry.adoc
|
||||
// * scalability_and_performance/ztp-deploying-disconnected.adoc
|
||||
// * updating/updating-restricted-network-cluster.adoc
|
||||
|
||||
ifeval::["{context}" == "updating-restricted-network-cluster"]
|
||||
@@ -12,6 +14,11 @@ ifeval::["{context}" == "installing-mirroring-installation-images"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "installing-mirroring-disconnected"]
|
||||
:restricted:
|
||||
:oc-mirror:
|
||||
endif::[]
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="installation-adding-registry-pull-secret_{context}"]
|
||||
= Configuring credentials that allow images to be mirrored
|
||||
@@ -48,29 +55,20 @@ Complete the following steps on the installation host:
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
. Download your `registry.redhat.io` pull secret from the
|
||||
link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site and save it to a `.json` file.
|
||||
endif::[]
|
||||
link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site.
|
||||
|
||||
. Generate the base64-encoded user name and password or token for your mirror
|
||||
registry:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ echo -n '<user_name>:<password>' | base64 -w0 <1>
|
||||
BGVtbYk3ZHAtqXs=
|
||||
----
|
||||
<1> For `<user_name>` and `<password>`, specify the user name and password that
|
||||
you configured for your registry.
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
. Make a copy of your pull secret in JSON format:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cat ./pull-secret.text | jq . > <path>/<pull_secret_file_in_json><1>
|
||||
$ cat ./pull-secret | jq . > <path>/<pull_secret_file_in_json> <1>
|
||||
----
|
||||
<1> Specify the path to the folder to store the pull secret in and a name for
|
||||
the JSON file that you create.
|
||||
ifndef::oc-mirror[]
|
||||
<1> Specify the path to the folder to store the pull secret in and a name for the JSON file that you create.
|
||||
endif::[]
|
||||
ifdef::oc-mirror[]
|
||||
<1> Specify the path to the folder to store the pull secret in and a name for the JSON file that you create. This file must be saved either as `~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`.
|
||||
endif::[]
|
||||
+
|
||||
The contents of the file resemble the following example:
|
||||
+
|
||||
@@ -99,6 +97,15 @@ The contents of the file resemble the following example:
|
||||
----
|
||||
endif::[]
|
||||
|
||||
. Generate the base64-encoded user name and password or token for your mirror registry:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ echo -n '<user_name>:<password>' | base64 -w0 <1>
|
||||
BGVtbYk3ZHAtqXs=
|
||||
----
|
||||
<1> For `<user_name>` and `<password>`, specify the user name and password that you configured for your registry.
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
. Edit the new
|
||||
endif::[]
|
||||
@@ -184,3 +191,8 @@ endif::[]
|
||||
ifeval::["{context}" == "updating-restricted-network-cluster"]
|
||||
:!restricted:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "installing-mirroring-disconnected"]
|
||||
:!restricted:
|
||||
:!oc-mirror:
|
||||
endif::[]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="mirror-registry-flags_{context}"]
|
||||
= Mirror registry for Red Hat OpenShift flags
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="mirror-registry-introduction_{context}"]
|
||||
== Mirror registry for Red Hat OpenShift introduction
|
||||
= Mirror registry for Red Hat OpenShift introduction
|
||||
|
||||
For disconnected deployments of {product-title}, a container registry is required to carry out the installation of the clusters. To run a production-grade registry service on such a cluster, you must create a separate registry deployment to install the first cluster. The _mirror registry for Red Hat OpenShift_ addresses this need and is included in every OpenShift subscription. It is available for download on the link:https://console.redhat.com/openshift/downloads#tool-mirror-registry[OpenShift console *Downloads*] page.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="mirror-registry-localhost_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="mirror-registry-remote_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="uninstalling-mirror-registry_{context}"]
|
||||
= Uninstalling the mirror registry for Red Hat OpenShift
|
||||
|
||||
23
modules/oc-mirror-about.adoc
Normal file
23
modules/oc-mirror-about.adoc
Normal file
@@ -0,0 +1,23 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="installation-oc-mirror-about_{context}"]
|
||||
= About the oc-mirror plug-in
|
||||
|
||||
You can use the oc-mirror OpenShift CLI (`oc`) plug-in to mirror all required {product-title} content and other images to your mirror registry by using a single tool. It provides the following features:
|
||||
|
||||
* Provides a centralized method to mirror {product-title} releases, Operators, helm charts, and other images.
|
||||
* Maintains update paths for {product-title} and Operators.
|
||||
* Uses a declarative image set configuration file to include only the {product-title} releases, Operators, and images that your cluster needs.
|
||||
* Performs incremental mirroring, which reduces the size of future image sets.
|
||||
|
||||
When using the oc-mirror plug-in, you specify which content to mirror in an image set configuration file. In this YAML file, you can fine-tune the configuration to only include the {product-title} releases and Operators that your cluster needs. This reduces the amount of data that you need to download and transfer. The oc-mirror plug-in can also mirror arbitrary helm charts and additional container images to assist users in seamlessly synchronizing their workloads onto mirror registries.
|
||||
|
||||
The first time you run the oc-mirror plug-in, it populates your mirror registry with the required content to perform your disconnected cluster installation. In order for your disconnected cluster to continue receiving updates, you must keep your mirror registry updated. To update your mirror registry, you run the oc-mirror plug-in using the same configuration as the first time you ran it. The oc-mirror plug-in references the metadata from the storage backend and only downloads what has been released since the last time you ran the tool. This provides update paths for {product-title} and Operators and performs dependency resolution as required.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
When using the oc-mirror CLI plug-in to populate a mirror registry, any further updates to the mirror registry must be made using the oc-mirror tool.
|
||||
====
|
||||
46
modules/oc-mirror-creating-image-set-config.adoc
Normal file
46
modules/oc-mirror-creating-image-set-config.adoc
Normal file
@@ -0,0 +1,46 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-creating-image-set-config_{context}"]
|
||||
= Creating the image set configuration
|
||||
|
||||
Before you can use the oc-mirror plug-in to mirror image sets, you must create an image set configuration file. This image set configuration file defines which {product-title} releases, Operators, and other images to mirror, along with other configuration settings for the oc-mirror plug-in.
|
||||
|
||||
You must specify a storage backend in the image set configuration file. This storage backend can be a local directory or a registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2]. The oc-mirror plug-in stores metadata in this storage backend during image set creation.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Do not delete or modify the metadata that is generated by the oc-mirror plug-in. You must use the same storage backend every time you run the oc-mirror plug-in for the same mirror registry.
|
||||
====
|
||||
|
||||
.Procedure
|
||||
|
||||
. Create an `ImageSetConfiguration` resource that specifies the necessary configuration details:
|
||||
+
|
||||
.Example `ImageSetConfiguration` file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: mirror.openshift.io/v1alpha1
|
||||
kind: ImageSetConfiguration
|
||||
archiveSize: 4 <1>
|
||||
mirror:
|
||||
ocp:
|
||||
channels:
|
||||
- name: stable-4.9 <2>
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.9 <3>
|
||||
storageConfig: <4>
|
||||
registry:
|
||||
imageURL: example.com/example/oc-mirror <5>
|
||||
----
|
||||
<1> The maximum size, in GiB, of each file within the image set.
|
||||
<2> The channel to retrieve the {product-title} images from.
|
||||
<3> The Operator catalog to retrieve the {product-title} images from.
|
||||
<4> The back-end location to save the image set metadata to. This location can be a registry or local directory. It is required to specify `storageConfig` values.
|
||||
<5> The registry URL for the storage backend.
|
||||
+
|
||||
This example pulls images from the `stable-4.9` channel for the `registry.redhat.io/redhat/redhat-operator-index:v4.9` operator catalog and saves the image set metadata to the `example.com/example/oc-mirror` registry.
|
||||
|
||||
. Save the file as `imageset-config.yaml`. This file is required by the `oc mirror` command when mirroring content.
|
||||
40
modules/oc-mirror-differential-updates.adoc
Normal file
40
modules/oc-mirror-differential-updates.adoc
Normal file
@@ -0,0 +1,40 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-differential-updates_{context}"]
|
||||
= Updating your mirror registry
|
||||
|
||||
After you publish a full image set to the mirror registry, you can use the oc-mirror plug-in to update the mirror registry with updated images.
|
||||
|
||||
When you run the oc-mirror plug-in again, it generates an image set that only contains new and updated images since the previous execution.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You must use the same storage backend as the initial execution of oc-mirror for the same mirror registry. Do not delete or modify the metadata that is generated by the oc-mirror plug-in.
|
||||
====
|
||||
|
||||
Because it only pulls in the differences since the previous image set was created, the generated image set is often smaller and faster to process than the initial image set.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Generated image sets are sequential and must be synchronized to the target mirror registry in order.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have used the oc-mirror plug-in to mirror the initial image set to your mirror registry.
|
||||
* You have access to the storage backend that was used for the initial execution of the oc-mirror plug-in.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Follow the same steps that you used to create the initial image set and mirror it to the mirror registry. For instructions, see _Mirroring an image set in a partially disconnected environment_ or _Mirroring an image set in a fully disconnected environment_.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
* You must provide the same storage backend so that only a differential image set is created and mirrored.
|
||||
* If you specified a top-level namespace for the mirror registry during the initial image set creation, then you must use this same namespace every time you run the oc-mirror plug-in for the same mirror registry.
|
||||
====
|
||||
|
||||
. Install the `ImageContentSourcePolicy` and `CatalogSource` resources into the cluster.
|
||||
43
modules/oc-mirror-disk-to-mirror.adoc
Normal file
43
modules/oc-mirror-disk-to-mirror.adoc
Normal file
@@ -0,0 +1,43 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-disk-to-mirror_{context}"]
|
||||
= Mirroring from disk to mirror
|
||||
|
||||
You can use the oc-mirror plug-in to mirror the contents of a generated image set to the target mirror registry.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the OpenShift CLI (`oc`) in the disconnected environment.
|
||||
* You have installed the `oc-mirror` CLI plug-in in the disconnected environment.
|
||||
* You have generated the image set file by using the `oc mirror` command.
|
||||
* You have transferred the image set file to the disconnected environment.
|
||||
// TODO: Confirm prereq about not needing a cluster, but need pull secret misc
|
||||
|
||||
.Procedure
|
||||
|
||||
* Run the `oc mirror` command to process the image set file on disk and mirror the contents to a target mirror registry:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror --from=./mirror_seq1_000000.tar \ <1>
|
||||
docker://registry.example:5000 <2>
|
||||
----
|
||||
<1> Pass in the image set .tar file to mirror, named `mirror_seq1_000000.tar` in this example. If an `archiveSize` value was specified in the image set configuration file, the image set might be broken up into multiple .tar files. In this situation, you can pass in a directory that contains the image set .tar files.
|
||||
<2> Specify the registry to mirror the image set file to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions.
|
||||
+
|
||||
This command updates the mirror registry with the image set and generates the `ImageContentSourcePolicy` and `CatalogSource` resources.
|
||||
|
||||
.Verification
|
||||
|
||||
. Navigate into the `oc-mirror-workspace/` directory that was generated.
|
||||
. Navigate into the results directory, for example, `results-1639608409/`.
|
||||
. Verify that YAML files are present for the `ImageContentSourcePolicy` and `CatalogSource` resources.
|
||||
+
|
||||
// TODO: Test and get some better wording/example output.
|
||||
|
||||
.Next steps
|
||||
|
||||
* Install the `ImageContentSourcePolicy` and `CatalogSource` resources into the cluster.
|
||||
67
modules/oc-mirror-image-set-config-examples.adoc
Normal file
67
modules/oc-mirror-image-set-config-examples.adoc
Normal file
@@ -0,0 +1,67 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: REFERENCE
|
||||
[id="oc-mirror-image-set-examples_{context}"]
|
||||
= Image set configuration examples
|
||||
|
||||
The following `ImageSetConfiguration` file examples show the configuration for various mirroring use cases.
|
||||
|
||||
[discrete]
|
||||
[id="oc-mirror-image-set-examples-helm_{context}"]
|
||||
== Use case: Including arbitrary images and helm charts
|
||||
|
||||
The following `ImageSetConfiguration` file uses a registry storage backend and includes helm charts and an additional Red Hat Universal Base Image (UBI).
|
||||
|
||||
.Example `ImageSetConfiguration` file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: mirror.openshift.io/v1alpha1
|
||||
kind: ImageSetConfiguration
|
||||
archiveSize: 4
|
||||
storageConfig:
|
||||
registry:
|
||||
imageURL: example.com/example/oc-mirror
|
||||
skipTLS: false
|
||||
mirror:
|
||||
ocp:
|
||||
channels:
|
||||
- name: stable-4.9
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.9
|
||||
helm:
|
||||
repos:
|
||||
- name: redhat-helm-charts
|
||||
url: https://raw.githubusercontent.com/redhat-developer/redhat-helm-charts/master
|
||||
charts:
|
||||
- name: ibm-mongodb-enterprise-helm
|
||||
version: 0.2.0
|
||||
additionalImages:
|
||||
- name: registry.redhat.io/ubi8/ubi:latest
|
||||
----
|
||||
|
||||
[discrete]
|
||||
[id="oc-mirror-image-set-examples-operator-versions_{context}"]
|
||||
== Use case: Including specific Operator versions
|
||||
|
||||
The following `ImageSetConfiguration` file uses a local storage backend and includes only the Red Hat Advanced Cluster Security for Kubernetes Operator, versions starting at 3.67.0 and later.
|
||||
|
||||
.Example `ImageSetConfiguration` file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: mirror.openshift.io/v1alpha1
|
||||
kind: ImageSetConfiguration
|
||||
storageConfig:
|
||||
local:
|
||||
path: /home/user/metadata
|
||||
mirror:
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.9
|
||||
headsOnly: false
|
||||
packages:
|
||||
- name: rhacs-operator
|
||||
channels:
|
||||
- name: latest
|
||||
startingVersion: 3.67.0
|
||||
----
|
||||
208
modules/oc-mirror-imageset-config-params.adoc
Normal file
208
modules/oc-mirror-imageset-config-params.adoc
Normal file
@@ -0,0 +1,208 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: REFERENCE
|
||||
[id="oc-mirror-imageset-config-params_{context}"]
|
||||
= Image set configuration parameters
|
||||
|
||||
The oc-mirror plug-in requires an image set configuration file that defines what images to mirror. The following table lists the available parameters for the `ImageSetConfiguration` resource.
|
||||
|
||||
// TODO: Consider adding examples for the general "Object" params
|
||||
|
||||
.`ImageSetConfiguration` parameters
|
||||
[cols="2,2a,1a",options="header"]
|
||||
|===
|
||||
|Parameter
|
||||
|Description
|
||||
|Values
|
||||
|
||||
|`apiVersion`
|
||||
|The API version for the `ImageSetConfiguration` content.
|
||||
|String. For example: `mirror.openshift.io/v1alpha1`.
|
||||
|
||||
|`archiveSize`
|
||||
|The maximum size, in GiB, of each archive file within the image set.
|
||||
|Integer. For example: `4`
|
||||
|
||||
|`mirror`
|
||||
|The configuration of the image set.
|
||||
|Object
|
||||
|
||||
|`mirror.additionalImages`
|
||||
|The additional images configuration of the image set.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
additionalImages:
|
||||
- name: registry.redhat.io/ubi8/ubi:latest
|
||||
----
|
||||
|
||||
|`mirror.additionalImages.name`
|
||||
|The tag of the image to mirror.
|
||||
|String. For example: `registry.redhat.io/ubi8/ubi:latest`
|
||||
|
||||
|`mirror.helm`
|
||||
|The helm configuration of the image set. Note that the oc-mirror plug-in supports only helm charts that do not require user input when rendered.
|
||||
|Object
|
||||
|
||||
|`mirror.helm.local`
|
||||
|The local helm charts to mirror.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
local:
|
||||
- name: podinfo
|
||||
path: /test/podinfo-5.0.0.tar.gz
|
||||
----
|
||||
|
||||
|`mirror.helm.local.name`
|
||||
|The name of the local helm chart to mirror.
|
||||
|String. For example: `podinfo`.
|
||||
|
||||
|`mirror.helm.local.path`
|
||||
|The path of the local helm chart to mirror.
|
||||
|String. For example: `/test/podinfo-5.0.0.tar.gz`.
|
||||
|
||||
|`mirror.helm.repos`
|
||||
|The remote helm repositories to mirror from.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
repos:
|
||||
- name: podinfo
|
||||
url: https://example.github.io/podinfo
|
||||
charts:
|
||||
- name: podinfo
|
||||
version: 5.0.0
|
||||
----
|
||||
|
||||
|`mirror.helm.repos.name`
|
||||
|The name of the helm repository to mirror from.
|
||||
|String. For example: `podinfo`.
|
||||
|
||||
|`mirror.helm.repos.url`
|
||||
|The URL of the helm repository to mirror from.
|
||||
|String. For example: [x-]`https://example.github.io/podinfo`.
|
||||
|
||||
|`mirror.helm.repos.charts`
|
||||
|The remote helm charts to mirror.
|
||||
|Array of objects.
|
||||
|
||||
|`mirror.helm.repos.charts.name`
|
||||
|The name of the helm chart to mirror.
|
||||
|String. For example: `podinfo`.
|
||||
|
||||
|`mirror.helm.repos.charts.version`
|
||||
|The version of the named helm chart to mirror.
|
||||
|String. For example: `5.0.0`.
|
||||
|
||||
|`mirror.ocp`
|
||||
|The platform configuration of the image set.
|
||||
|Object
|
||||
|
||||
|`mirror.ocp.channels`
|
||||
|The platform channel configuration of the image set.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
channels:
|
||||
- name: stable-4.7
|
||||
- name: stable-4.6
|
||||
versions:
|
||||
- '4.6.36'
|
||||
----
|
||||
|
||||
|`mirror.ocp.channels.name`
|
||||
|The name of the release channel.
|
||||
|String. For example: `stable-4.9` or `okd`.
|
||||
|
||||
|`mirror.ocp.channels.versions`
|
||||
|The list of release versions within the named channel.
|
||||
|String. For example: `4.9.6`.
|
||||
|
||||
|`mirror.operators`
|
||||
|The Operators configuration of the image set.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.9
|
||||
headsOnly: false
|
||||
packages:
|
||||
- name: elasticsearch-operator
|
||||
startingVersion: '2.4.0'
|
||||
----
|
||||
|
||||
|`mirror.operators.catalog`
|
||||
|The Operator catalog to include in the image set.
|
||||
|String. For example: `registry.redhat.io/redhat/redhat-operator-index:v4.9`.
|
||||
|
||||
|`mirror.operators.headsOnly`
|
||||
|Toggles between downloading channel HEADs and full channels. Cannot be used in conjunction with `mirror.operators.packages`.
|
||||
|Boolean
|
||||
|
||||
|`mirror.operators.packages`
|
||||
|The Operator packages configuration.
|
||||
|Array of objects. For example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.8
|
||||
headsOnly: false
|
||||
packages:
|
||||
- name: elasticsearch-operator
|
||||
startingVersion: '5.2.3-31'
|
||||
----
|
||||
|
||||
|`mirror.operators.packages.name`
|
||||
|The Operator package name to include in the image set
|
||||
|String. For example: `elasticsearch-operator`.
|
||||
|
||||
|`mirror.operators.packages.startingVersion`
|
||||
|The starting version of the Operator package to mirror. All versions of the Operator are mirrored between the value of `startingVersion` and the HEAD version of each channel that contains the referenced version.
|
||||
|String. For example: `5.2.3-31`.
|
||||
|
||||
|`mirror.operators.packages.channels`
|
||||
|The Operator package channel configuration.
|
||||
|Object
|
||||
|
||||
|`mirror.operators.packages.channels.name`
|
||||
|The Operator channel name, unique within a package, to include in the image set.
|
||||
|String. For example: `fast` or `stable-v4.9`.
|
||||
|
||||
|`mirror.operators.packages.channels.startingVersion`
|
||||
|The starting version of the Operator channel to mirror. All versions of the Operator are mirrored between the value of `startingVersion` and the HEAD version of the specified channel.
|
||||
|String. For example: `5.2.3-31`
|
||||
|
||||
|`storageConfig`
|
||||
|The back-end configuration of the image set.
|
||||
|Object
|
||||
|
||||
|`storageConfig.local`
|
||||
|The local back-end configuration of the image set.
|
||||
|Object
|
||||
|
||||
|`storageConfig.local.path`
|
||||
|The path of the directory to contain the image set metadata.
|
||||
|String. For example: `./path/to/dir/`.
|
||||
|
||||
|`storageConfig.registry`
|
||||
|The registry back-end configuration of the image set.
|
||||
|Object
|
||||
|
||||
|`storageConfig.registry.imageURL`
|
||||
|The back-end registry URI. Can optionally include a namespace reference in the URI.
|
||||
|String. For example: `quay.io/myuser/imageset:metadata`.
|
||||
|
||||
|`storageConfig.registry.skipTLS`
|
||||
|Optionally skip TLS verification of the referenced back-end registry.
|
||||
|Boolean. The default value is `false`.
|
||||
|
||||
|===
|
||||
56
modules/oc-mirror-installing-plugin.adoc
Normal file
56
modules/oc-mirror-installing-plugin.adoc
Normal file
@@ -0,0 +1,56 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="installation-oc-mirror-installing-plugin_{context}"]
|
||||
= Installing the oc-mirror OpenShift CLI plug-in
|
||||
|
||||
To use the oc-mirror OpenShift CLI plug-in to mirror registry images, you must install the plug-in. If you are mirroring image sets in a fully disconnected environment, ensure that you install the oc-mirror plug-in on the host with internet access and the host in the disconnected environment with access to the mirror registry.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
. Download the oc-mirror CLI plug-in.
|
||||
|
||||
.. Navigate to the link:https://console.redhat.com/openshift/downloads[Downloads] page of the {console-redhat-com}.
|
||||
|
||||
.. Under the *Command-line interface (CLI) tools* section, click *Download* for *OpenShift Client (oc) mirror plugin* and save the file.
|
||||
|
||||
. Extract the archive:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ tar xvzf oc-mirror-linux.tar.gz
|
||||
----
|
||||
|
||||
. If necessary, update the plug-in file to be executable:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ chmod +x oc-mirror
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Do not rename the `oc-mirror` file.
|
||||
====
|
||||
|
||||
. Install the oc-mirror CLI plug-in by placing the file in your `PATH`, for example, `/usr/local/bin`:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo mv oc-mirror /usr/local/bin/.
|
||||
----
|
||||
|
||||
.Verification
|
||||
|
||||
* Run `oc mirror help` to verify that the plug-in was successfully installed:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror help
|
||||
----
|
||||
69
modules/oc-mirror-mirror-to-disk.adoc
Normal file
69
modules/oc-mirror-mirror-to-disk.adoc
Normal file
@@ -0,0 +1,69 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-mirror-to-disk_{context}"]
|
||||
= Mirroring from mirror to disk
|
||||
|
||||
You can use the oc-mirror plug-in to generate an image set and save the contents to disk. The generated image set can then be transferred to the disconnected environment and mirrored to the target registry.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Depending on the configuration specified in the image set configuration file, using oc-mirror to mirror images might download several hundreds of gigabytes of data to disk.
|
||||
|
||||
The initial image set download when you populate the mirror registry is often the largest. Because you only download the images that changed since the last time you ran the command, when you run the oc-mirror plug-in again, the generated image set is often smaller.
|
||||
====
|
||||
|
||||
You are required to specify a storage backend in the image set configuration file. This storage backend can be a local directory or a docker v2 registry. The oc-mirror plug-in stores metadata in this storage backend during image set creation.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Do not delete or modify the metadata that is generated by the oc-mirror plug-in. You must use the same storage backend every time you run the oc-mirror plug-in for the same mirror registry.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have access to the internet to obtain the necessary container images.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* You have installed the `oc-mirror` CLI plug-in.
|
||||
* You have created the image set configuration file.
|
||||
// TODO: Don't need a running cluster, but need some pull secrets. Sync w/ team on this
|
||||
|
||||
.Procedure
|
||||
|
||||
* Run the `oc mirror` command to mirror the images from the specified image set configuration to disk:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror --config=./imageset-config.yaml \ <1>
|
||||
file://<path_to_output_directory> <2>
|
||||
----
|
||||
<1> Pass in the image set configuration file that was created. This procedure assumes that it is named `imageset-config.yaml`.
|
||||
<2> Specify the target directory where you want to output the image set file. The target directory path must start with `file://`.
|
||||
|
||||
.Verification
|
||||
|
||||
. Navigate to your output directory:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cd <path_to_output_directory>
|
||||
----
|
||||
|
||||
. Verify that an image set `.tar` file was created:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ ls
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,text]
|
||||
----
|
||||
mirror_seq1_000000.tar
|
||||
----
|
||||
|
||||
.Next steps
|
||||
|
||||
* Transfer the image set .tar file to the disconnected environment.
|
||||
55
modules/oc-mirror-mirror-to-mirror.adoc
Normal file
55
modules/oc-mirror-mirror-to-mirror.adoc
Normal file
@@ -0,0 +1,55 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-mirror-to-mirror_{context}"]
|
||||
= Mirroring from mirror to mirror
|
||||
|
||||
You can use the oc-mirror plug-in to mirror an image set directly to a target mirror registry that is accessible during image set creation.
|
||||
|
||||
// TODO: This note might be obsolete come GA, if they change the impl
|
||||
[IMPORTANT]
|
||||
====
|
||||
Depending on the configuration specified in the image set configuration file, using oc-mirror to mirror images might download several hundreds of gigabytes of data to disk before mirroring to the destination mirror registry.
|
||||
|
||||
The initial image set download when you populate the mirror registry is often the largest. Because you only download the images that changed since the last time you ran the command, when you run the oc-mirror plug-in again, the generated image set is often smaller.
|
||||
====
|
||||
|
||||
You are required to specify a storage backend in the image set configuration file. This storage backend can be a local directory or a Docker v2 registry. The oc-mirror plug-in stores metadata in this storage backend during image set creation.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Do not delete or modify the metadata that is generated by the oc-mirror plug-in. You must use the same storage backend every time you run the oc-mirror plug-in for the same mirror registry.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have access to the internet to obtain the necessary container images.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* You have installed the `oc-mirror` CLI plug-in.
|
||||
* You have created the image set configuration file.
|
||||
|
||||
.Procedure
|
||||
|
||||
* Run the `oc mirror` command to mirror the images from the specified image set configuration to a specified registry:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror --config=./imageset-config.yaml \ <1>
|
||||
docker://registry.example:5000 <2>
|
||||
----
|
||||
<1> Pass in the image set configuration file that was created. This procedure assumes that it is named `imageset-config.yaml`.
|
||||
<2> Specify the registry to mirror the image set file to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions.
|
||||
|
||||
.Verification
|
||||
|
||||
. Navigate into the `oc-mirror-workspace/` directory that was generated.
|
||||
. Navigate into the results directory, for example, `results-1639608409/`.
|
||||
. Verify that YAML files are present for the `ImageContentSourcePolicy` and `CatalogSource` resources.
|
||||
+
|
||||
// TODO: Test and get some better wording/example output.
|
||||
|
||||
.Next steps
|
||||
|
||||
* Install the `ImageContentSourcePolicy` and `CatalogSource` resources into the cluster.
|
||||
47
modules/oc-mirror-updating-cluster-manifests.adoc
Normal file
47
modules/oc-mirror-updating-cluster-manifests.adoc
Normal file
@@ -0,0 +1,47 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="oc-mirror-updating-cluster-manifests_{context}"]
|
||||
= Installing the ImageContentSourcePolicy and CatalogSource resources into the cluster
|
||||
|
||||
// TODO: Can we find a better title / more generic than calling out the two resources?
|
||||
|
||||
After you have mirrored your image set to the mirror registry, you must install the generated `ImageContentSourcePolicy` and `CatalogSource` resources into the cluster.
|
||||
|
||||
The `ImageContentSourcePolicy` resource associates the mirror registry with the source registry and redirects image pull requests from the online registries to the mirror registry. The `CatalogSource` resource is used by Operator Lifecycle Manager (OLM) to retrieve information about the available Operators in the mirror registry.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have mirrored the image set to the registry mirror in the disconnected environment.
|
||||
* You have access to the cluster as a user with the `cluster-admin` role.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Log in to the OpenShift CLI as a user with the `cluster-admin` role.
|
||||
|
||||
. Apply the YAML files from the results directory to the cluster:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f ./oc-mirror-workspace/results-1639608409/
|
||||
----
|
||||
|
||||
// TODO: Any example output to show?
|
||||
|
||||
.Verification
|
||||
|
||||
. Verify that the `ImageContentSourcePolicy` resources were successfully installed:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get imagecontentsourcepolicy --all-namespaces
|
||||
----
|
||||
|
||||
. Verify that the `CatalogSource` resources were successfully installed:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get catalogsource --all-namespaces
|
||||
----
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
ifdef::openshift-origin[]
|
||||
:index-image-pullspec: quay.io/operatorhubio/catalog:latest
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
ifdef::openshift-origin[]
|
||||
:index-image-pullspec: quay.io/operatorhubio/catalog:latest
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="olm-mirror-catalog-extracting_{context}"]
|
||||
= Extracting and mirroring catalog contents
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="olm-mirror-catalog-manifests_{context}"]
|
||||
= Generated manifests
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="olm-mirror-catalog-post_{context}"]
|
||||
= Post-installation requirements
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing-mirroring-installation-images.adoc
|
||||
// * installing/disconnected_install/installing-mirroring-installation-images.adoc
|
||||
|
||||
[id="olm-mirror-catalog_{context}"]
|
||||
= Mirroring Operator catalogs for use with disconnected clusters
|
||||
|
||||
@@ -55,7 +55,7 @@ include::modules/olm-pruning-index-image.adoc[leveloffset=+1]
|
||||
[id="olm-mirror-catalog_olm-restricted-networks"]
|
||||
== Mirroring an Operator catalog
|
||||
|
||||
For instructions about mirroring Operator catalogs for use with disconnected clusters, see xref:../../installing/installing-mirroring-installation-images.adoc#olm-mirroring-catalog_installing-mirroring-installation-images[Installing -> Mirroring images for a disconnected installation].
|
||||
For instructions about mirroring Operator catalogs for use with disconnected clusters, see xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirroring-catalog_installing-mirroring-installation-images[Installing -> Mirroring images for a disconnected installation].
|
||||
|
||||
include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ If you mirrored Operator catalogs for use with disconnected clusters, you can po
|
||||
[id="prerequisites_post-install-mirrored-catalogs"]
|
||||
=== Prerequisites
|
||||
|
||||
* xref:../installing/installing-mirroring-installation-images.html#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
|
||||
* xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters]
|
||||
|
||||
include::modules/olm-mirroring-catalog-icsp.adoc[leveloffset=+2]
|
||||
include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+2]
|
||||
|
||||
@@ -96,7 +96,7 @@ xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#in
|
||||
or
|
||||
xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]
|
||||
does not have full access to the internet, then
|
||||
xref:../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the {product-title} installation images] and install a cluster in a restricted network.
|
||||
xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the {product-title} installation images] and install a cluster in a restricted network.
|
||||
endif::openshift-origin[]
|
||||
|
||||
ifdef::openshift-origin[]
|
||||
@@ -107,7 +107,7 @@ xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#instal
|
||||
or
|
||||
xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]
|
||||
does not have full access to the internet, then
|
||||
xref:../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the {product-title} installation images] and install a cluster in a restricted network.
|
||||
xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the {product-title} installation images] and install a cluster in a restricted network.
|
||||
endif::openshift-origin[]
|
||||
|
||||
- **Install a cluster in an existing network**: If you use an existing Virtual Private Cloud (VPC) in
|
||||
|
||||
Reference in New Issue
Block a user