Updated oc-mirror v2 docs

Author: subhtk

_topic_maps/_topic_map.yml

@@ -124,14 +124,14 @@ Topics:
     File: index
   - Name: Creating a mirror registry with mirror registry for Red Hat OpenShift
     File: installing-mirroring-creating-registry
-  - Name: Mirroring images for a disconnected installation by using the oc adm command
-    File: installing-mirroring-installation-images
-  - Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
-    File: installing-mirroring-disconnected
   - Name: Mirroring images for a disconnected installation using oc-mirror plugin v2
     File: about-installing-oc-mirror-v2
   - Name: Migrating from oc-mirror plugin v1 to v2
     File: oc-mirror-migration-v1-to-v2
+  - Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
+    File: installing-mirroring-disconnected
+  - Name: Mirroring images for a disconnected installation by using the oc adm command
+    File: installing-mirroring-installation-images
 - Name: Installing a cluster in a disconnected environment
   File: installing
 - Name: Using OLM in disconnected environments

disconnected/mirroring/about-installing-oc-mirror-v2.adoc

@@ -8,10 +8,7 @@ toc::[]
 
 You can run your cluster in a disconnected environment if you install the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running whenever your cluster is running.
 
-Just as you can use the oc-mirror OpenShift CLI (`oc`) plugin, you can also use oc-mirror plugin v2 to mirror images to a mirror registry in your fully or partially disconnected environments. To download the required images from the official Red{nbsp}Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.
-
-:FeatureName: oc-mirror plugin v2
-include::snippets/technology-preview.adoc[]
+You can use oc-mirror plugin v2 to mirror images to a mirror registry in your fully or partially disconnected environments. To download the required images from the official Red{nbsp}Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.
 
 // About oc-mirror plugin v2
 include::modules/oc-mirror-v2-about.adoc[leveloffset=+1]
@@ -85,7 +82,7 @@ After your cluster is configured to use the resources generated by oc-mirror plu
 
 * xref:../../extensions/catalogs/disconnected-catalogs.adoc#disconnected-catalogs[Disconnected environment support in {olmv1}]
 
-//Delete Feature
+// Delete Feature
 // workflows of delete feature
 include::modules/oc-mirror-workflows-delete-v2.adoc[leveloffset=+1]
 
@@ -107,7 +104,7 @@ include::modules/oc-mirror-dry-run-v2.adoc[leveloffset=+2]
 // Troubleshooting
 include::modules/oc-mirror-troubleshooting-v2.adoc[leveloffset=+1]
 
-//oc-mirror-enclave-support-about
+// oc-mirror-enclave-support-about
 include::modules//oc-mirror-enclave-support-about.adoc[leveloffset=+1]
 
 // How to mirror to an Enclave
@@ -121,14 +118,18 @@ include::modules/oc-mirror-proxy-support.adoc[leveloffset=+1]
 * xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[Updating a cluster in a disconnected environment using the OpenShift Update Service]
 * xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-v2-procedure-garbage-collector_about-installing-oc-mirror-v2[Resolving storage cleanup issues in the distribution registry]
 
-//operator catalog filtering
+// Operator catalog filtering
 include::modules/oc-mirror-operator-catalog-filtering.adoc[leveloffset=+1]
 
-//Image set configuration parameters
+// Image set configuration parameters
 include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+1]
 
 // Command reference for oc-mirror v2
 include::modules/oc-mirror-command-reference-v2.adoc[leveloffset=+1]
+include::modules/oc-mirror-command-reference-v2-delete.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
 * xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-updating-cluster-manifests-v2_about-installing-oc-mirror-v2[Configuring your cluster to use the resources generated by oc-mirror]
 
 [id="next-steps_{context}"]

modules/oc-mirror-command-reference-v2-delete.adoc

@@ -0,0 +1,72 @@
+// Module included in the following assemblies:
+//
+// * installing/disconnected_install/installing-mirroring-disconnected-v2.adoc
+
+
+:_mod-docs-content-type: REFERENCE
+[id="oc-mirror-command-reference-delete-v2_{context}"]
+= Command reference for deleting images
+
+The following tables describe the `oc mirror` subcommands and flags for deleting images:
+
+.Subcommands and flags for the deleting images
+[cols="1,2",options="header"]
+|===
+|Subcommand
+|Description
+
+|`--authfile <string>`
+|Path of the authentication file. The default value is `${XDG_RUNTIME_DIR}/containers/auth.json`.
+
+|`--cache-dir <string>` 
+|oc-mirror cache directory location. The default is `$HOME`.
+
+|`-c <string>`, `--config <string>` 
+|Path to the delete imageset configuration file.
+
+|`--delete-id <string>` 
+|Used to differentiate between versions for files created by the delete functionality.
+
+|`--delete-v1-images` 
+|Used during the migration, along with `--generate`, in order to target images previously mirrored with oc-mirror plugin v1.
+
+|`--delete-yaml-file <string>` 
+|If set, uses the generated or updated yaml file to delete contents.
+
+|`--dest-tls-verify` 
+|Require HTTPS and verify certificates when talking to the container registry or daemon. TThe default value is `true`.
+
+|`--force-cache-delete` 
+|Used to force delete the local cache manifests and blobs.
+
+|`--generate` 
+|Used to generate the delete yaml for the list of manifests and blobs, used when deleting from local cache and remote registry.
+
+|`-h`, `--help` 
+|Displays help.
+
+|`--log-level <string>` 
+|Log level one of `info`, `debug`, `trace`, and `error`. The default value is `info`.
+
+|`--parallel-images <unit>` 
+|Indicates the number of images deleted in parallel. The default value is `8`.
+
+|`--parallel-layers <unit>`          
+|Indicates the number of image layers mirrored in parallel. The default value is `10`.
+
+|`-p <unit>`, `--port <unit>` 
+|HTTP port used by oc-mirror's local storage instance. The default value is `55000`.
+
+|`--retry-delay` 
+|Duration delay between 2 retries. The default value is `1s`.
+
+|`--retry-times <int>` 
+|The number of times to retry. The default value is `2`.
+
+|`--src-tls-verify` 
+|Require HTTPS and verify certificates when talking to the container registry or daemon. The default value is `true`.
+
+|`--workspace <string>` 
+|oc-mirror workspace where resources and internal artifacts are generated.
+
+|===

modules/oc-mirror-command-reference-v2.adoc

@@ -38,29 +38,41 @@ The following tables describe the `oc mirror` subcommands and flags for oc-mirro
 |`-c`, `--config` `<string>`
 |Specifies the path to an image set configuration file.
 
+|`--cache-dir <string>` 
+|oc-mirror cache directory location. The default value is `$HOME`.
+
 |`--dest-tls-verify`
-|Requires HTTPS and verifies certificates when accessing the container registry or daemon.
+|Requires HTTPS and verifies certificates when accessing the container registry or daemon. The default value is `true`.
 
 |`--dry-run`
-|Prints actions without mirroring images
+|Prints actions without mirroring images.
 
 |`--from <string>`
 |Specifies the path to an image set archive that was generated by executing oc-mirror plugin v2 to load a target registry.
 
 |`-h`, `--help`
 |Displays help
 
-|`--loglevel` 
-|Displays string log levels. Supported values include info, debug, trace, error. The default is `info`.
+|`--image-timeout duration` 
+|Timeout for mirroring an image. The default is 10m0s. Valid time units are `ns`, `us` or `µs`, `ms`, `s`, `m`, and `h`.
+
+|`--log-level <string>`
+|Displays string log levels. Supported values include info, debug, trace, error. The default value is `info`.
 
 |`-p`, `--port` 
-|Determines the HTTP port used by oc-mirror plugin v2 local storage instance. The default is `55000`.
+|Determines the HTTP port used by oc-mirror plugin v2 local storage instance. The default value is `55000`.
+
+|`--parallel-images <unit>` 
+|Specifies the number of images mirrored in parallel. The default value is `8`.
+
+|`--parallel-layers <unit>`           
+|Specifies the number of image layers mirrored in parallel. The default value is `10`.
 
 |`--max-nested-paths <int>`
-|Specifies the maximum number of nested paths for destination registries that limit nested paths. The default is `0`.
+|Specifies the maximum number of nested paths for destination registries that limit nested paths. The default value is `0`.
 
 |`--secure-policy` 
-|Default value is `false`. If you set a non-default value, the command enables signature verification, which is the secure policy for signature verification.
+|The default value is `false`. If you set a non-default value, the command enables signature verification, which is the secure policy for signature verification.
 
 |`--since` 
 |Includes all new content since a specified date (format: `yyyy-mm-dd`). When not provided, new content since previous mirroring is mirrored.
@@ -69,12 +81,21 @@ The following tables describe the `oc mirror` subcommands and flags for oc-mirro
 |Requires HTTPS and verifies certificates when accessing the container registry or daemon.
 
 |`--strict-archive` 
-|Default value is `false`. If you set a value, the command generates archives that are strictly less than the `archiveSize` that was set in the `imageSetConfig` custom resource (CR). Mirroring exist in error if a file being archived exceeds `archiveSize` (GB).
+|The default value is `false`. If you set a value, the command generates archives that are strictly less than the `archiveSize` that was set in the `imageSetConfig` custom resource (CR). Mirroring exist in error if a file being archived exceeds `archiveSize` (GB).
 
 |`-v`, `--version` 
 |Displays the version for oc-mirror plugin v2.
 
 |`--workspace` 
 |Determines string oc-mirror plugin v2 workspace where resources and internal artifacts are generated.
 
+|`--retry-delay duration` 
+|Delay between 2 retries. The default value is `1s`.
+
+|`--retry-times <int>` 
+|The number of times to retry. The default value is `2`.
+
+|`--rootless-storage-path <string>` 
+|Overrides the default container rootless storage path (usually in `etc/containers/storage.conf`).
+
 |===

modules/oc-mirror-dry-run-v2.adoc

@@ -5,7 +5,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="oc-mirror-dry-run-v2_{context}"]
-= Performing dry run for oc-mirror plugin v2
+= Performing a dry run for oc-mirror plugin v2
 
 Verify your image set configuration by performing a dry run without mirroring any images. This ensures your setup is correct and prevents unintended changes.
 
@@ -15,19 +15,18 @@ Verify your image set configuration by performing a dry run without mirroring an
 +
 [source,terminal]
 ----
-$ oc mirror -c <image_set_config_yaml> --from file://<oc_mirror_workspace_path> docker://<mirror_registry_url> --dry-run --v2
+$ oc mirror -c <image_set_config_yaml> file://<oc_mirror_workspace_path> --dry-run --v2
 ----
-Where:
-- `<image_set_config_yaml>`: Use the image set configuration file that you just created.
-- `<oc_mirror_workspace_path>`: Insert the address of the workspace path.
-- `<mirror_registry_url>`: Insert the URL or address of the remote container registry from which images will be deleted.
++
+where:
+
+`<image_set_config_yaml>`:: Specifies the image set configuration file that you created.
+`<oc_mirror_workspace_path>`:: Insert the address of the workspace path.
+`<mirror_registry_url>`:: Insert the URL or address of the remote container registry from which images will be mirrored or deleted.
 +
 .Example output
 [source,terminal]
 ----
-$ oc mirror --config /tmp/isc_dryrun.yaml file://<oc_mirror_workspace_path> --dry-run --v2
-
-[INFO]   : :warning:  --v2 flag identified, flow redirected to the oc-mirror v2 version. This is Tech Preview, it is still under development and it is not production ready.
 [INFO]   : :wave: Hello, welcome to oc-mirror
 [INFO]   : :gear:  setting up the environment for you...
 [INFO]   : :twisted_rightwards_arrows: workflow mode: mirrorToDisk 

modules/oc-mirror-enclave-support-about.adoc

@@ -8,9 +8,6 @@
 
 Enclave support restricts internal access to a specific part of a network. Unlike a demilitarized zone (DMZ) network, which allows inbound and outbound traffic access through firewall boundaries, enclaves do not cross firewall boundaries.
 
-:FeatureName: Enclave Support
-include::snippets/technology-preview.adoc[]
-
 The new enclave support functionality is for scenarios where mirroring is needed for multiple enclaves that are secured behind at least one intermediate disconnected network.
 
 Enclave support has the following benefits:

modules/oc-mirror-procedure-delete-v2.adoc

@@ -38,18 +38,15 @@ delete:
          minVersion: <operator_max_version> <5>
          maxVersion: <operator_min_version> <5>
   additionalImages:
-    - name: <additional_images> <6>
+    - name: <additional_images>
 ----
 <1> Specify the name of the {product-title} channel to delete, for example `stable-4.15`.
 <2> Specify a version range of the images to delete within the channel, for example `4.15.0` for the minimum version and `4.15.1` for the maximum version.
 To delete only one version's images, use that version number for both the `minVersion` and `maxVersion` fields.
-<3> Specify an Operator catalog image to delete, for example `registry.redhat.io/redhat/redhat-operator-index:v4.14`.
-To delete the catalog image, you must not specify individual Operators using the `delete.operators.packages` parameter.
-<4> Specify a specific Operator bundle to delete, for example `aws-load-balancer-operator`.
-If you specify individual Operators, the Operator catalog image does not get deleted.
+<3> Specify an Operator catalog image containing the Operators to delete, for example `registry.redhat.io/redhat/redhat-operator-index:v4.14`.
+The Operator catalog image will not get deleted. Its presence in the registry might be necessary for other Operators still remaining on the cluster.
+<4> Specify a specific Operator to delete, for example `aws-load-balancer-operator`.
 <5> Specify a version range of the images to delete for the Operator, for example `0.0.1` for the minimum version and `0.0.2` for the maximum version.
-To delete only one version's images, use that version number for both the `minVersion` and `maxVersion` fields.
-<6> Specify additional images to delete, for example `registry.redhat.io/ubi9/ubi-init:latest`.
 
 . Create a `delete-images.yaml` file by running the following command:
 +
@@ -62,6 +59,11 @@ where:
 
 <previously_mirrored_work_folder>:: Specifies the directory where images were previously mirrored to or stored during the mirroring process.
 <remote_registry>:: Specifies the URL or address of the remote container registry from which images will be deleted.
++
+[IMPORTANT]
+====
+When deleting images, specify the correct workspace directory. Modify or delete the cache directory only when starting mirroring from scratch, such as setting up a new cluster. Incorrect changes to the cache directory might disrupt further mirroring operations.
+====
 
 . Go to the `<previously_mirrored_work_folder>/delete` directory that was created.
 

modules/oc-mirror-troubleshooting-v2.adoc

@@ -12,7 +12,7 @@ oc-mirror plugin v2 now logs all image mirroring errors in a separate file, maki
 ====
 When errors occur while mirroring release or release component images, they are critical. This stops the mirroring process immediately.
 
-Errors with mirroring Operators, Operator-related images, or additional images do not stop the mirroring process. Mirroring continues, and oc-mirror plugin v2 logs updates every 8 images.
+Errors with mirroring Operators, Operator-related images, or additional images do not stop the mirroring process. Mirroring continues, and oc-mirror plugin v2 saves a file under the `working-dir/logs` directory describing which Operator failed to mirror.
 ====
 
 When an image fails to mirror, and that image is mirrored as part of one or more Operator bundles, oc-mirror plugin v2 notifies the user which Operators are incomplete, providing clarity on the Operator bundles affected by the error.

modules/oc-mirror-v2-about.adoc

@@ -9,7 +9,7 @@
 
 The oc-mirror OpenShift CLI (`oc`) plugin is a single tool that mirrors all required {product-title} content and other images to your mirror registry.
 
-To use the new Technology Preview version of oc-mirror, add the `--v2` flag to the oc-mirror plugin v2 command line.
+To use the new version of oc-mirror, add the `--v2` flag to the oc-mirror plugin v2 command line.
 
 oc-mirror plugin v2 has the following features:
 

modules/oc-mirror-workflows-delete-v2.adoc

@@ -17,7 +17,6 @@ You must create a `DeleteImageSetConfiguration` file to specify which images to
 In the following example, the `DeleteImageSetConfiguration` file removes the following images:
 
 * All release images for {product-title} 4.13.3.
-* The `redhat-operator-index` `v4.12` catalog image.
 * The `aws-load-balancer-operator` v0.0.1 bundle and all its related images.
 * The additional images for `ubi` and `ubi-minimal`, referenced by their corresponding digests.
 
@@ -47,7 +46,7 @@ delete:
 
 [IMPORTANT]
 ====
-Consider using the mirror-to-disk and disk-to-mirror workflows to reduce mirroring issues.
+Consider using the mirror-to-disk and disk-to-mirror workflows to reduce deletion issues.
 ====
 
 oc-mirror plugin v2 deletes only the manifests of the images, which does not reduce the storage occupied in the registry.
@@ -68,4 +67,4 @@ If only the Operator catalog image is specified, all Operators within that catal
 If you are certain that no Operators from a catalog remain in the registry or cluster, you can explicitly add the catalog image to `additionalImages` in `DeleteImageSetConfiguration` to remove it.
 
 * Garbage collection behavior depends on the registry. Some registries do not automatically remove deleted images, requiring a system administrator to manually trigger garbage collection to free up space.
-====
+====