Merge pull request #110726 from openshift-cherrypick-robot/cherry-pick-109114-to-enterprise-4.22

[enterprise-4.22] OSDOCS#18868: Added mirror list support to oc-mirror v2

Author: ShaunaDiaz

modules/microshift-oc-mirror-list-ops-catalogs.adoc

@@ -7,7 +7,7 @@
 = Inspecting catalog contents by using the oc-mirror plugin
 
 [role="_abstract"]
-Use the following example procedure to select a catalog and list Operators to add to your oc-mirror plugin image set configuration file. You must use `oc mirror` v1 to select a catalog and list Operators.
+Use the following example procedure to select a catalog and list Operators to add to your oc-mirror plugin image set configuration file.
 
 [NOTE]
 ====
@@ -26,14 +26,14 @@ If you use your own catalogs and Operators, you can push the images directly to
 +
 [source,terminal,subs="attributes+"]
 ----
-$ oc mirror list operators --version {product-version} --catalogs
+$ oc mirror list operators --version {product-version} --catalogs --v2
 ----
 
 . Get a list of Operators in the Red Hat Operators catalog by running the following command:
 +
 [source,terminal]
 ----
-$ oc mirror list operators <--catalog=<catalog_source>>
+$ oc mirror list operators --catalog=<catalog_source> --v2
 ----
 +
 Replace `<catalog_source>` with your catalog source, such as `registry.redhat.io/redhat/redhat-operator-index:v{product-version}` or `quay.io/operatorhubio/catalog:latest`.
@@ -46,13 +46,13 @@ Replace `<catalog_source>` with your catalog source, such as `registry.redhat.io
 +
 [source,terminal,subs="attributes+"]
 ----
-$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v{product-version} --package=amq-broker-rhel9
+$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v{product-version} --package=amq-broker-rhel9 --v2
 ----
 .. Get a list of versions within a channel by running the following command:
 +
 [source,terminal,subs="attributes+"]
 ----
-$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v{product-version} --package=amq-broker-rhel9 --channel=7.13.x
+$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v{product-version} --package=amq-broker-rhel9 --channel=7.13.x --v2
 ----
 
 .Next steps

modules/oc-mirror-building-image-set-config-v2.adoc

@@ -36,24 +36,22 @@ mirror:
        - name: aws-load-balancer-operator
        - name: 3scale-operator
        - name: node-observability-operator
+         channels:
+         - name: stable
   additionalImages: <5>
    - name: registry.redhat.io/ubi8/ubi:latest
    - name: registry.redhat.io/ubi9/ubi@sha256:20f695d2a91352d4eaa25107535126727b5945bff38ed36a3e59590f495046f0
 ----
-<1> Set the channel to retrieve {product-title} images from.
-<2> Add `graph: true` to build and push the graph-data image to the mirror registry.
-The graph-data image is required to create OpenShift Update Service (OSUS).
-The `graph: true` field also generates the `UpdateService` custom resource manifest.
-The `oc` command-line interface (CLI) can use the `UpdateService` custom resource manifest to create OSUS.
-For more information, see _About the OpenShift Update Service_.
-<3> Set the Operator catalog to retrieve the {product-title} images from.
-<4> Specify only certain Operator packages to include in the image set. Remove this field to retrieve all packages in the catalog.
-<5> Specify any additional images to include in image set.
++
+
+`mirror.platform.channels.name`:: Set the channel to retrieve {product-title} images from.
+`mirror.platform.graph`:: Add `graph: true` to build and push the graph-data image to the mirror registry. The graph-data image is required to create OpenShift Update Service (OSUS). The `graph: true` field also generates the `UpdateService` custom resource manifest. The `oc` command-line interface (CLI) can use the `UpdateService` custom resource manifest to create OSUS. For more information, see _About the OpenShift Update Service_.
+`mirror.operators.catalog`:: Set the Operator catalog to retrieve the {product-title} images from.
+`mirror.operators.packages`:: Specify only certain Operator packages to include in the image set. Remove this field to retrieve all packages in the catalog.
+`mirror.operators.packages.channels.name`:: Specifies only certain channels of the Operator packages to include in the image set. You must always include the default channel for the Operator package even if you do not use the bundles in that channel. You can find the default channel by running the following command: `oc mirror list operators --catalog=<catalog_name> --package=<package_name> --v2`.
+`mirror.additionalImages`:: Specify any additional images to include in image set.
 +
 [NOTE]
 ====
-In oc-mirror plugin v2, you must use explicit registry hostnames for all images listed under `additionalImages`. Otherwise, images are mirrored to incorrect target paths.
+You must use explicit registry hostnames for all images listed under `additionalImages`. Without explicit hostnames, the plugin mirrors the images to unexpected target paths.
 ====
-
-// Are there more relevant example version numbers we can use in the example above?
-// Also, are there any other callouts that would be helpful for users here?

modules/oc-mirror-imageset-config-parameters-v2.adoc

@@ -226,6 +226,11 @@ Example: `elasticsearch-operator`
 
 |`mirror.operators.packages.channels.name`
 |The Operator channel name, unique within a package, to include in the image set.
++
+[NOTE]
+====
+You must use explicit registry hostnames for all images listed under `additionalImages`. Without explicit hostnames, the plugin mirrors the images to unexpected target paths.
+====
 |String
 Example: `fast` or `stable-v4.15`