Skip to content

Commit ece3028

Browse files
committed
Revert "Merge pull request #76555 from subhtk/ocm-v1"
This reverts commit 690b892, reversing changes made to c136038. Conflicts: modules/oc-mirror-imageset-config-params.adoc Resolved conflicts by keeping the "4.16" version bump that happened via PR 76649, but set back the commas instead of colons to their pre-76555 state.
1 parent c3cebe3 commit ece3028

20 files changed

+270
-444
lines changed

installing/disconnected_install/installing-mirroring-disconnected.adoc

Lines changed: 66 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,91 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="installing-mirroring-disconnected_{context}"]
3-
= Mirroring images for a disconnected installation using the oc-mirror plugin v1
2+
[id="installing-mirroring-disconnected"]
3+
= Mirroring images for a disconnected installation using the oc-mirror plugin
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-mirroring-disconnected
66

77
toc::[]
88

9-
Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See "Prerequisites" section for more information.
9+
Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See the xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.
10+
11+
You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.
1012

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

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

17-
[id="prerequisites_installing-mirroring-disconnected_{context}"]
19+
[role="_additional-resources"]
20+
.Additional resources
21+
22+
* For information on updating oc-mirror, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source].
23+
24+
// About the mirror registry
25+
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
26+
27+
[role="_additional-resources"]
28+
.Additional resources
29+
30+
* 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].
31+
32+
[id="prerequisites_installing-mirroring-disconnected"]
1833
== Prerequisites
1934

20-
* You must have a container image registry, which is referred as the mirror registry, that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2] in the location that hosts the {product-title} cluster, such as {quay}.
35+
* 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.
2136
+
2237
[NOTE]
2338
====
24-
If you use {quay}, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to {quay}, see the documentation on deploying {quay} link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[by using the Red Hat Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
39+
If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to Red Hat Quay, see the documentation on deploying Red Hat Quay link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[by using the Red Hat Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
2540
====
2641
+
27-
If you do not already have an existing solution for a mirror registry, the subscribers of {product-title} are provided in "Creating a mirror registry with mirror registry for Red Hat OpenShift".
42+
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.
2843

29-
* The mirror registry must be reachable by every machine in the clusters that you provision. If the registry is unreachable, installation, updating, or normal operations such as workload relocation might fail. For this reason, you must run mirror registries ensuring highly availability. The mirror registries must meet or exceed the production availability of your {product-title} clusters.
44+
[id="mirroring-preparing-your-hosts"]
45+
== Preparing your mirror hosts
3046

31-
* You have set the umask parameter to `0022` on the operating system that uses oc-mirror plugin v1.
47+
Before you can use the oc-mirror plugin to mirror images, you must install the plugin and create a container image registry credentials file to allow the mirroring from Red Hat to your mirror.
48+
49+
// Installing the oc-mirror OpenShift CLI plugin
50+
include::modules/oc-mirror-installing-plugin.adoc[leveloffset=+2]
3251

3352
[role="_additional-resources"]
3453
.Additional resources
3554

36-
* xref:../../installing/disconnected_install/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift]
37-
38-
[id="mirroring-preparing-your-hosts_{context}"]
39-
== Preparing your mirror hosts
40-
41-
To use the oc-mirror plugin v1 to mirror images, you need to install the plugin and create a container image registry credentials file to enable mirroring from Red Hat to your mirror.
42-
43-
// Installing the oc-mirror OpenShift CLI plugin v1
44-
include::modules/oc-mirror-installing-plugin.adoc[leveloffset=+2]
55+
* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-installing-plugins_cli-extend-plugins[Installing and using CLI plugins]
4556

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

49-
// About Image set configuration
50-
include::modules/oc-mirror-about-image-set-config.adoc[leveloffset=+1]
51-
5260
// Creating the image set configuration
53-
include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+2]
61+
include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+1]
5462

55-
// Image set configuration parameters
56-
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+2]
63+
[role="_additional-resources"]
64+
.Additional resources
5765

58-
// Image set configuration examples
59-
include::modules/oc-mirror-image-set-config-examples.adoc[leveloffset=+2]
66+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-imageset-config-params_installing-mirroring-disconnected[Image set configuration parameters]
67+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
68+
* xref:../../updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc#update-service-overview_updating-restricted-network-cluster-osus[Using the OpenShift Update Service in a disconnected environment]
6069

61-
// Setting up for incremental mirroring
62-
include::modules/oc-mirror-setting-incremental-mirroring.adoc[leveloffset=+1]
70+
[id="mirroring-image-set"]
71+
== Mirroring an image set to a mirror registry
6372

64-
[role="_additional-resources"]
65-
.Additional resources
73+
You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[partially disconnected environment] or in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[fully disconnected environment].
74+
75+
These procedures assume that you already have your mirror registry set up.
6676

67-
* xref:../../updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc#update-service-overview_updating-restricted-network-cluster-osus[Updating a cluster in a disconnected environment using the OpenShift Update Service]
77+
[id="mirroring-image-set-partial"]
78+
=== Mirroring an image set in a partially disconnected environment
6879

69-
* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-installing-plugins_cli-extend-plugins[Extending the OpenShift CLI with plugins]
80+
In a partially disconnected environment, you can mirror an image set directly to the target mirror registry.
7081

71-
// Mirroring an image set to a mirror registry
72-
include::modules/oc-mirror-mirroring-image-set.adoc[leveloffset=+1]
82+
// Mirroring from mirror to mirror
83+
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+3]
7384

74-
// Mirroring from partially disconnected environment:mirror to mirror
75-
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+2]
85+
[id="mirroring-image-set-full"]
86+
=== Mirroring an image set in a fully disconnected environment
7687

77-
// Mirroring from fully disconnected environment
78-
include::modules/oc-mirror-fully-disconnected.adoc[leveloffset=+2]
88+
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].
7989

8090
// Mirroring from mirror to disk
8191
include::modules/oc-mirror-mirror-to-disk.adoc[leveloffset=+3]
@@ -86,34 +96,42 @@ include::modules/oc-mirror-disk-to-mirror.adoc[leveloffset=+3]
8696
// Configuring your cluster to use the resources generated by oc-mirror
8797
include::modules/oc-mirror-updating-cluster-manifests.adoc[leveloffset=+1]
8898

89-
[role="_additional-resources"]
90-
.Additional resources
91-
92-
* xref:../../updating/understanding_updates/intro-to-updates.adoc#update-service-about_understanding-openshift-updates[About the OpenShift Update Service]
93-
9499
// About updating your mirror registry content
95100
include::modules/oc-mirror-updating-registry-about.adoc[leveloffset=+1]
96101

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

104+
[role="_additional-resources"]
105+
.Additional resources
106+
107+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
108+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
109+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
110+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]
111+
100112
// Performing a dry run
101113
include::modules/oc-mirror-dry-run.adoc[leveloffset=+1]
102114

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

106-
// Additional resources
118+
[role="_additional-resources"]
119+
.Additional resources
107120

108121
// TODO: This title might need to update per sebastian's PR
109-
// Configuring your cluster to use the resources generated by oc-mirror
122+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror]
123+
124+
// Image set configuration parameters
125+
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+1]
126+
127+
// Image set configuration examples
128+
include::modules/oc-mirror-image-set-config-examples.adoc[leveloffset=+1]
110129

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

114133
[role="_additional-resources"]
134+
[id="additional-resources_installing-mirroring-disconnected"]
115135
== Additional resources
116136

117137
* xref:../../updating/updating_a_cluster/updating_disconnected_cluster/index.adoc#about-restricted-network-updates[About cluster updates in a disconnected environment]
118-
119-
* xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]

modules/installation-adding-registry-pull-secret.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,23 @@ endif::[]
2222

2323
:_mod-docs-content-type: PROCEDURE
2424
[id="installation-adding-registry-pull-secret_{context}"]
25-
= Configuring credentials to enable mirroring images
25+
= Configuring credentials that allow images to be mirrored
2626

27-
Follow the procedure to create a container image registry credentials file for mirroring images from Red Hat to your mirror registry.
27+
Create a container image registry credentials file that allows mirroring
28+
images from Red Hat to your mirror.
2829

2930
ifdef::restricted[]
3031
[WARNING]
3132
====
32-
Do not use this image registry credentials file as the pull secret when installing a cluster. Using this file will grant write access to your mirror registry for all machines in the cluster.
33+
Do not use this image registry credentials file as the pull secret when you install a cluster. If you provide this file when you install cluster, all of the machines in the cluster will have write access to your mirror registry.
3334
====
3435
endif::restricted[]
3536

3637
ifdef::restricted[]
38+
[WARNING]
39+
====
40+
This process requires that you have write access to a container image registry on the mirror registry and adds the credentials to a registry pull secret.
41+
====
3742

3843
endif::restricted[]
3944

@@ -47,8 +52,6 @@ endif::openshift-rosa,openshift-dedicated[]
4752
ifdef::restricted[]
4853
* You identified an image repository location on your mirror registry to mirror images into.
4954
* You provisioned a mirror registry account that allows images to be uploaded to that image repository.
50-
* You have write access to the mirror registry.
51-
* You included the credentials in the registry pull secret.
5255
endif::restricted[]
5356

5457
.Procedure

modules/oc-mirror-about-image-set-config.adoc

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)