Skip to content

Commit 5d4ee3e

Browse files
authored
Merge pull request #82375 from subhtk/osdocs10733
OSDOCS 10733: Added a note to specify the EUS versions in ImageSetConfiguration file
2 parents 89e80b0 + 667a485 commit 5d4ee3e

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ mirror:
7070
[NOTE]
7171
====
7272
The `graph: true` field also mirrors the `ubi-micro` image along with other mirrored images.
73+
74+
When upgrading {product-title} Extended Update Support (EUS) versions, an intermediate version might be required between the current and target versions. For example, if the current version is `4.14` and target version is `4.16`, you might need to include a version such as `4.15.8` in the `ImageSetConfiguration` when using the oc-mirror plugin v1.
75+
76+
The oc-mirror plugin v1 might not always detect this automatically, so check the link:https://access.redhat.com/labs/ocpupgradegraph/update_path[Cincinnati graph web page] to confirm any required intermediate versions and add them manually to your configuration.
7377
====
7478
+
7579
See "Image set configuration parameters" for the full list of parameters and "Image set configuration examples" for various mirroring use cases.

modules/oc-mirror-enclave-support.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,13 @@ $ export UPDATE_URL_OVERRIDE=https://<osus.enterprise.in>/graph
102102
+
103103
For more information on setting up OSUS on an OpenShift cluster, see "Updating a cluster in a disconnected environment using the OpenShift Update Service".
104104

105+
[NOTE]
106+
====
107+
When upgrading {product-title} Extended Update Support (EUS) versions, an intermediate version might be required between the current and target versions. For example, if the current version is `4.14` and target version is `4.16`, you might need to include a version such as `4.15.8` in the `ImageSetConfiguration` when using the oc-mirror plugin v2.
108+
109+
The oc-mirror plugin v2 might not always detect this automatically, so check the link:https://access.redhat.com/labs/ocpupgradegraph/update_path[Cincinnati graph web page] to confirm any required intermediate versions and add them manually to your configuration.
110+
====
111+
105112
. Generate a mirror archive from the enterprise registry for the enclave.
106113
+
107114
To prepare an archive for the `enclave1`, the user executes oc-mirror plugin v2 in the enterprise disconnected environment by using the `imageSetConfiguration` specific for that enclave. This ensures that only images needed by that enclave are mirrored:

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,3 +268,34 @@ mirror:
268268
blockedImages:
269269
- name: registry.redhat.io/ubi8/ubi:fake
270270
----
271+
272+
[discrete]
273+
[id="oc-mirror-image-set-examples-eus_{context}"]
274+
== Use case: Including the upgrade path for EUS releases
275+
276+
The following `ImageSetConfiguration` file includes the `eus-<version>` channel, where the `maxVersion` value is at least two minor versions higher than the `minVersion` value.
277+
278+
For example, in this `ImageSetConfiguration` file, the `minVersion` is set to `4.12.28`, while the `maxVersion` for the `eus-4.14` channel is `4.14.16`.
279+
280+
.Example `ImageSetConfiguration` file
281+
[source,yaml,subs="attributes+"]
282+
----
283+
kind: ImageSetConfiguration
284+
apiVersion: mirror.openshift.io/v2alpha1
285+
mirror:
286+
platform:
287+
graph: true # Required for the OSUS Operator
288+
architectures:
289+
- amd64
290+
channels:
291+
- name: stable-4.12
292+
minVersion: '4.12.28'
293+
maxVersion: '4.12.28'
294+
shortestPath: true
295+
type: ocp
296+
- name: eus-4.14
297+
minVersion: '4.12.28'
298+
maxVersion: '4.14.16'
299+
shortestPath: true
300+
type: ocp
301+
----

0 commit comments

Comments
 (0)