From eb8c529d37feadfe0138ebec038b85983d0988c1 Mon Sep 17 00:00:00 2001
From: subhtk <stk@redhat.com>
Date: Tue, 24 Sep 2024 21:41:05 +0530
Subject: [PATCH] Added a note to specify the EUS versions in imageSetConfig.

---
 .../oc-mirror-creating-image-set-config.adoc  |  4 +++
 modules/oc-mirror-enclave-support.adoc        |  7 +++++
 .../oc-mirror-image-set-config-examples.adoc  | 31 +++++++++++++++++++
 3 files changed, 42 insertions(+)

diff --git a/modules/oc-mirror-creating-image-set-config.adoc b/modules/oc-mirror-creating-image-set-config.adoc
index 41be625599..b0df4cfb0a 100644
--- a/modules/oc-mirror-creating-image-set-config.adoc
+++ b/modules/oc-mirror-creating-image-set-config.adoc
@@ -70,6 +70,10 @@ mirror:
 [NOTE]
 ====
 The `graph: true` field also mirrors the `ubi-micro` image along with other mirrored images.
+
+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.
+
+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.
 ====
 +
 See "Image set configuration parameters" for the full list of parameters and "Image set configuration examples" for various mirroring use cases.
diff --git a/modules/oc-mirror-enclave-support.adoc b/modules/oc-mirror-enclave-support.adoc
index 729ae810eb..bd0b1f8e93 100644
--- a/modules/oc-mirror-enclave-support.adoc
+++ b/modules/oc-mirror-enclave-support.adoc
@@ -102,6 +102,13 @@ $ export UPDATE_URL_OVERRIDE=https://<osus.enterprise.in>/graph
 +
 For more information on setting up OSUS on an OpenShift cluster, see "Updating a cluster in a disconnected environment using the OpenShift Update Service".
 
+[NOTE]
+====
+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.
+
+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.
+====
+
 . Generate a mirror archive from the enterprise registry for the enclave.
 +
 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:
diff --git a/modules/oc-mirror-image-set-config-examples.adoc b/modules/oc-mirror-image-set-config-examples.adoc
index 38a908f914..014b1beb22 100644
--- a/modules/oc-mirror-image-set-config-examples.adoc
+++ b/modules/oc-mirror-image-set-config-examples.adoc
@@ -268,3 +268,34 @@ mirror:
   blockedImages:
     - name: registry.redhat.io/ubi8/ubi:fake
 ----
+
+[discrete]
+[id="oc-mirror-image-set-examples-eus_{context}"]
+== Use case: Including the upgrade path for EUS releases
+
+The following `ImageSetConfiguration` file includes the `eus-<version>` channel, where the `maxVersion` value is at least two minor versions higher than the `minVersion` value.
+
+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`. 
+
+.Example `ImageSetConfiguration` file
+[source,yaml,subs="attributes+"]
+----
+kind: ImageSetConfiguration
+apiVersion: mirror.openshift.io/v2alpha1
+mirror:
+  platform:
+    graph: true # Required for the OSUS Operator
+    architectures:
+    - amd64
+    channels:
+    - name: stable-4.12
+      minVersion: '4.12.28'
+      maxVersion: '4.12.28'
+      shortestPath: true
+      type: ocp
+    - name: eus-4.14
+      minVersion: '4.12.28'
+      maxVersion: '4.14.16'
+      shortestPath: true
+      type: ocp
+----