diff --git a/disconnected/installing-mirroring-disconnected.adoc b/disconnected/installing-mirroring-disconnected.adoc index 5e899e163d..0818ba28f1 100644 --- a/disconnected/installing-mirroring-disconnected.adoc +++ b/disconnected/installing-mirroring-disconnected.adoc @@ -12,7 +12,7 @@ You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirr [IMPORTANT] ==== -The oc-mirror v1 plugin is deprecated. To prevent failures in a future release, specify the `--v1` flag to continue using the v1 plugin, or migrate to the supported v2 plugin and use the `--v2` flag. Transition to the xref:../disconnected/about-installing-oc-mirror-v2.adoc#installation-oc-mirror-v2-about_about-installing-oc-mirror-v2[oc-mirror v2 plugin] for continued support and improvements. +The oc-mirror v1 plugin is deprecated. Specify the `--v1` flag to continue using the v1 plugin, or migrate to the supported v2 plugin and use the `--v2` flag. Transition to the xref:../disconnected/about-installing-oc-mirror-v2.adoc#installation-oc-mirror-v2-about_about-installing-oc-mirror-v2[oc-mirror v2 plugin] for continued support and improvements. ==== // About the oc-mirror plugin diff --git a/modules/oc-mirror-command-reference.adoc b/modules/oc-mirror-command-reference.adoc index d0caeb5cfd..5445b9dfdb 100644 --- a/modules/oc-mirror-command-reference.adoc +++ b/modules/oc-mirror-command-reference.adoc @@ -41,6 +41,12 @@ The following tables describe the `oc mirror` subcommands and flags: |Flag |Description +|`--v1` +|Uses the oc-mirror v1 plugin implementation. + +|`--v2` +|Uses the oc-mirror v2 plugin implementation. + |`-c`, `--config` `` |Specify the path to an image set configuration file. diff --git a/modules/oc-mirror-creating-image-set-config.adoc b/modules/oc-mirror-creating-image-set-config.adoc index 8dbe75e8b5..63112ee253 100644 --- a/modules/oc-mirror-creating-image-set-config.adoc +++ b/modules/oc-mirror-creating-image-set-config.adoc @@ -26,7 +26,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin. + [source,terminal] ---- -$ oc mirror init --registry > imageset-config.yaml <1> +$ oc mirror init --registry > imageset-config.yaml --v1 <1> ---- <1> Specifies the location of your storage backend, such as `example.com/mirror/oc-mirror-metadata`. @@ -64,7 +64,7 @@ mirror: <5> 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_. <6> Set the Operator catalog to retrieve the {product-title} images from. <7> Specify only certain Operator packages to include in the image set. Remove this field to retrieve all packages in the catalog. -<8> Specify 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= --package=`. +<8> Specify 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= --package= --v1`. <9> Specify any additional images to include in image set. + [NOTE] diff --git a/modules/oc-mirror-disk-to-mirror.adoc b/modules/oc-mirror-disk-to-mirror.adoc index 526ec87fcd..456a630bcc 100644 --- a/modules/oc-mirror-disk-to-mirror.adoc +++ b/modules/oc-mirror-disk-to-mirror.adoc @@ -24,7 +24,7 @@ You can use the oc-mirror plugin to mirror the contents of a generated image set [source,terminal] ---- $ oc mirror --from=./mirror_seq1_000000.tar \// <1> - docker://registry.example:5000 <2> + docker://registry.example:5000 --v1 <2> ---- <1> Pass in the image set .tar file to mirror, named `mirror_seq1_000000.tar` in this example. If an `archiveSize` value was specified in the image set configuration file, the image set might be broken up into multiple .tar files. In this situation, you can pass in a directory that contains the image set .tar files. <2> Specify the registry to mirror the image set file to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions. diff --git a/modules/oc-mirror-dry-run.adoc b/modules/oc-mirror-dry-run.adoc index 8b13a22514..526e61bd07 100644 --- a/modules/oc-mirror-dry-run.adoc +++ b/modules/oc-mirror-dry-run.adoc @@ -24,7 +24,8 @@ You can use oc-mirror to perform a dry run, without actually mirroring any image ---- $ oc mirror --config=./imageset-config.yaml \// <1> docker://registry.example:5000 \// <2> - --dry-run <3> + --dry-run \// <3> + --v1 ---- <1> Pass in the image set configuration file that was created. This procedure assumes that it is named `imageset-config.yaml`. <2> Specify the mirror registry. Nothing is mirrored to this registry as long as you use the `--dry-run` flag. diff --git a/modules/oc-mirror-image-set-config-examples.adoc b/modules/oc-mirror-image-set-config-examples.adoc index 459a81f793..4c7b2d90b2 100644 --- a/modules/oc-mirror-image-set-config-examples.adoc +++ b/modules/oc-mirror-image-set-config-examples.adoc @@ -141,7 +141,7 @@ The following `ImageSetConfiguration` file includes the `stable-5.7` and `stable [TIP] ==== -You can find the default channel by running the following command: `oc mirror list operators --catalog= --package=`. +You can find the default channel by running the following command: `oc mirror list operators --catalog= --package= --v1`. ==== .Example `ImageSetConfiguration` file diff --git a/modules/oc-mirror-installing-plugin.adoc b/modules/oc-mirror-installing-plugin.adoc index 84005c6501..672acb07af 100644 --- a/modules/oc-mirror-installing-plugin.adoc +++ b/modules/oc-mirror-installing-plugin.adoc @@ -73,7 +73,7 @@ ifdef::oc-mirror[] + [source,terminal] ---- -$ oc mirror help +$ oc mirror help --v1 ---- endif::[] diff --git a/modules/oc-mirror-migration-differences.adoc b/modules/oc-mirror-migration-differences.adoc index 44c203d6ed..642f11357e 100644 --- a/modules/oc-mirror-migration-differences.adoc +++ b/modules/oc-mirror-migration-differences.adoc @@ -6,11 +6,7 @@ [id="oc-mirror-migration-differences_{context}"] = Changes from oc-mirror plugin v1 to v2 -Before migrating from oc-mirror plugin v1 to v2, see the following differences between oc-mirror plugin v1 and v2: - -* Explicit version selection: Users must explicitly specify `--v2` when using `oc-mirror`. If no version is specified, v1 is executed by default. This behavior is expected to change in future releases, where `--v2` will be the default. - -* Updated commands: Commands for mirroring workflows have changed to align with oc-mirror plugin v2's new workflow. +Before migrating from oc-mirror plugin v1 to v2, you must review the updated mirroring workflow commands, which have changed to align with the new v2 workflow. ** For mirror-to-disk, run the following command: + diff --git a/modules/oc-mirror-mirror-to-disk.adoc b/modules/oc-mirror-mirror-to-disk.adoc index 762c2c354d..97850949f4 100644 --- a/modules/oc-mirror-mirror-to-disk.adoc +++ b/modules/oc-mirror-mirror-to-disk.adoc @@ -38,7 +38,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin. [source,terminal] ---- $ oc mirror --config=./imageset-config.yaml \// <1> - file:// <2> + file:// --v1 <2> ---- <1> Pass in the image set configuration file that was created. This procedure assumes that it is named `imageset-config.yaml`. <2> Specify the target directory where you want to output the image set file. The target directory path must start with `file://`. diff --git a/modules/oc-mirror-mirror-to-mirror.adoc b/modules/oc-mirror-mirror-to-mirror.adoc index 20e71ac92e..d8c6364073 100644 --- a/modules/oc-mirror-mirror-to-mirror.adoc +++ b/modules/oc-mirror-mirror-to-mirror.adoc @@ -30,7 +30,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin. [source,terminal] ---- $ oc mirror --config=./ \// <1> - docker://registry.example:5000 <2> + docker://registry.example:5000 --v1 <2> ---- <1> Specify the image set configuration file that you created. For example, `imageset-config.yaml`. <2> Specify the registry to mirror the image set file to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions. diff --git a/modules/oc-mirror-oci-format.adoc b/modules/oc-mirror-oci-format.adoc index e46910676d..e9092b0dae 100644 --- a/modules/oc-mirror-oci-format.adoc +++ b/modules/oc-mirror-oci-format.adoc @@ -78,7 +78,7 @@ In oc-mirror plugin v2, you must use explicit registry hostnames for all images [source,terminal] ---- $ oc mirror --config=./imageset-config.yaml \ <1> - docker://registry.example:5000 <2> + docker://registry.example:5000 --v1 <2> ---- <1> Pass in the image set configuration file. This procedure assumes that it is named `imageset-config.yaml`. <2> Specify the registry to mirror the content to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions.