Skip to content

Commit 2c5e99c

Browse files
authored
Merge pull request #53575 from skopacz1/OCP3076_oc_mirror
OCPBUGS#3076 - adding oc mirror info
2 parents d19606f + 0da7938 commit 2c5e99c

File tree

4 files changed

+81
-10
lines changed

4 files changed

+81
-10
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-restricted-network-cluster.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="update-mirror-repository-oc-mirror_{context}"]
7+
= Mirroring resources using the oc-mirror plug-in
8+
9+
Use the oc-mirror OpenShift CLI (`oc`) plug-in to mirror images onto a mirror registry. Compared to using `oc adm release mirror`, the oc-mirror plug-in has the following advantages:
10+
11+
* It is simpler to use.
12+
13+
* It can mirror content other than container images.
14+
15+
* After mirroring images for the first time, it is easier to update images in the registry.
16+
17+
.Procedure
18+
19+
. Navigate to the _Mirroring images for a disconnected installation using the oc-mirror plug-in_ page of the documentation.
20+
21+
. Follow the instructions on that page to mirror resources onto a mirror registry.
22+
23+
** If you are using oc-mirror for the first time, follow the instructions on that page up until and including the section titled _Installing the ImageContentSourcePolicy and CatalogSource resources into the cluster_.
24+
25+
** If you have already used oc-mirror to mirror resources onto a registry, follow the instructions in the section titled _Keeping your mirror registry content updated_.

modules/update-mirror-repository.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
// * updating/updating-restricted-network-cluster.adoc
44

55
:_content-type: PROCEDURE
6-
[id="update-mirror-repository_{context}"]
7-
= Mirroring the {product-title} image repository
8-
9-
Before you update a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. You can also use this procedure in unrestricted networks to ensure your clusters only use container images that have satisfied your organizational controls on external content.
6+
[id="update-mirror-repository-adm-release-mirror_{context}"]
7+
= Mirroring images using the oc adm release mirror command
108

119
.Procedure
1210

modules/update-service-mirror-release.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: PROCEDURE
2-
[id="update-service-mirror-release_{context}"]
3-
= Mirroring the {product-title} image repository
2+
[id="update-service-mirror-release-adm-release-mirror_{context}"]
3+
= Mirroring images using the oc adm release mirror command
44

55
The OpenShift Update Service requires a locally accessible registry containing update release payloads.
66

updating/updating-restricted-network-cluster.adoc

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,31 @@ include::modules/cli-installing-cli.adoc[leveloffset=+3]
3838

3939
// this file doesn't exist, so I'm including the one that should pick up more changes from Clayton's PR - modules/installation-adding-mirror-registry-pull-secret.adoc[leveloffset=+1]
4040

41-
include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+2]
41+
include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+3]
4242

43-
include::modules/update-mirror-repository.adoc[leveloffset=+2]
43+
[id="update-mirror-repository_updating-restricted-network-cluster"]
44+
=== Mirroring the {product-title} image repository
4445

45-
include::modules/machine-health-checks-pausing.adoc[leveloffset=+3]
46+
You must mirror container images onto a mirror registry before you can update a cluster in a restricted network environment. You can also use this procedure in unrestricted networks to ensure your clusters only use container images that have satisfied your organizational controls on external content.
47+
48+
There are two supported methods for mirroring images onto a mirror registry:
49+
50+
* Using the oc-mirror OpenShift CLI (`oc`) plug-in
51+
52+
* Using the oc adm release mirror command
53+
54+
Choose one of the following supported options.
55+
56+
include::modules/update-mirror-repository-oc-mirror.adoc[leveloffset=+3]
57+
58+
[role="_additional-resources"]
59+
.Additional resources
60+
61+
* xref:../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in]
62+
63+
include::modules/update-mirror-repository.adoc[leveloffset=+3]
64+
65+
include::modules/machine-health-checks-pausing.adoc[leveloffset=+2]
4666

4767
include::modules/update-restricted.adoc[leveloffset=+2]
4868

@@ -123,7 +143,35 @@ include::modules/update-service-install-cli.adoc[leveloffset=+2]
123143

124144
include::modules/update-service-graph-data.adoc[leveloffset=+2]
125145

126-
include::modules/update-service-mirror-release.adoc[leveloffset=+2]
146+
[id="update-service-mirror-release_updating-restricted-network-cluster"]
147+
=== Mirroring the {product-title} image repository
148+
149+
You must mirror container images onto a mirror registry before you can update a cluster in a restricted network environment. You can also use this procedure in unrestricted networks to ensure your clusters only use container images that have satisfied your organizational controls on external content.
150+
151+
There are two supported methods for mirroring images onto a mirror registry:
152+
153+
* Using the oc-mirror OpenShift CLI (`oc`) plug-in
154+
155+
* Using the oc adm release mirror command
156+
157+
Choose one of the following supported options.
158+
159+
//The module below is being used twice in this assembly, so this instance needs to have a unique context set in order for its ID to be unique. In the future, if and when the two main sections of this webpage are split into their own assemblies/pages, the context attributes below can be removed.
160+
161+
:!context:
162+
:context: osus-restricted-network-cluster
163+
164+
include::modules/update-mirror-repository-oc-mirror.adoc[leveloffset=+3]
165+
166+
[role="_additional-resources"]
167+
.Additional resources
168+
169+
* xref:../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in]
170+
171+
:!context:
172+
:context: updating-restricted-network-cluster
173+
174+
include::modules/update-service-mirror-release.adoc[leveloffset=+3]
127175

128176
[id="update-service-create-service"]
129177
=== Creating an OpenShift Update Service application

0 commit comments

Comments
 (0)