mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
132 lines
4.4 KiB
Plaintext
132 lines
4.4 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * disconnected/mirroring/oc-mirror-migration-v1-to-v2.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="oc-mirror-migration-process_{context}"]
|
|
= Migrating to oc-mirror plugin v2
|
|
|
|
To migrate from oc-mirror plugin v1 to v2, you must manually update the `ImageSetConfiguration` file, modify mirroring commands, and clean up v1 artifacts. Follow these steps to complete the migration.
|
|
|
|
.Procedure
|
|
|
|
. Modify the API version and remove deprecated fields in your `ImageSetConfiguration`.
|
|
+
|
|
.Example `ImageSetConfiguration` file with oc-mirror plugin v1 configuration
|
|
[source,yaml]
|
|
----
|
|
kind: ImageSetConfiguration
|
|
apiVersion: mirror.openshift.io/v1alpha2
|
|
mirror:
|
|
platform:
|
|
channels:
|
|
- name: stable-4.17
|
|
graph: true
|
|
helm:
|
|
repositories:
|
|
- name: sbo
|
|
url: https://redhat-developer.github.io/service-binding-operator-helm-chart/
|
|
additionalImages:
|
|
- name: registry.redhat.io/ubi8/ubi:latest
|
|
- name: quay.io/openshifttest/hello-openshift@sha256:example_hash
|
|
operators:
|
|
- catalog: oci:///test/redhat-operator-index
|
|
packages:
|
|
- name: aws-load-balancer-operator
|
|
storageConfig: # REMOVE this field in v2
|
|
local:
|
|
path: /var/lib/oc-mirror
|
|
----
|
|
+
|
|
.Example `ImageSetConfiguration` file with oc-mirror plugin v2 configuration
|
|
[source,yaml]
|
|
----
|
|
kind: ImageSetConfiguration
|
|
apiVersion: mirror.openshift.io/v2alpha1
|
|
mirror:
|
|
platform:
|
|
channels:
|
|
- name: stable-4.17
|
|
graph: true
|
|
helm:
|
|
repositories:
|
|
- name: sbo
|
|
url: https://redhat-developer.github.io/service-binding-operator-helm-chart/
|
|
additionalImages:
|
|
- name: registry.redhat.io/ubi8/ubi:latest
|
|
- name: quay.io/openshifttest/hello-openshift@sha256:example_hash
|
|
operators:
|
|
- catalog: oci:///test/redhat-operator-index
|
|
packages:
|
|
- name: aws-load-balancer-operator
|
|
----
|
|
+
|
|
[NOTE]
|
|
====
|
|
When migrating from oc-mirror plugin v1 to v2, you must use explicit registry hostnames for all images listed under `additionalImages`. Otherwise, images are mirrored to incorrect target paths.
|
|
====
|
|
|
|
. Check the `cluster-resources` directory inside the working directory for IDMS, ITMS, `CatalogSource`, and `ClusterCatalog` resources by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ ls <v2_workspace>/working-dir/cluster-resources/
|
|
----
|
|
|
|
. Once the migration is complete, verify that mirrored images and catalogs are available:
|
|
- Ensure that no errors or warnings occurred during mirroring.
|
|
- Ensure that no error file was generated (`working-dir/logs/mirroring_errors_YYYYMMdd_HHmmss.txt`).
|
|
|
|
. Verify that mirrored images and catalogs are available using the following the commands:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc get catalogsource -n openshift-marketplace
|
|
----
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc get imagedigestmirrorset,imagetagmirrorset
|
|
----
|
|
+
|
|
For more information, refer to "Mirroring images for a disconnected installation using oc-mirror plugin v2".
|
|
|
|
. Optional: Remove images mirrored using oc-mirror plugin v1:
|
|
|
|
.. Mirror the images using oc-mirror plugin v1.
|
|
|
|
.. Update the API version in the `ImageSetConfiguration` file from `v1alpha2` (v1) to `v2alpha1` (v2), then run the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc-mirror -c isc.yaml file://some-dir --v2
|
|
----
|
|
+
|
|
[NOTE]
|
|
====
|
|
`storageConfig` is not a valid field in the `ImageSetConfiguration` and `DeleteImageSetConfiguration` files. Remove this field when updating to oc-mirror plugin v2.
|
|
====
|
|
|
|
.. Generate a delete manifest and delete v1 images by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc-mirror delete --config=delete-isc.yaml --generate --delete-v1-images --workspace file://some-dir docker://registry.example:5000 --v2
|
|
----
|
|
+
|
|
[IMPORTANT]
|
|
====
|
|
oc-mirror plugin v2 does not automatically prune the destination registry, unlike oc-mirror plugin v1. To clean up images that are no longer needed, use the delete functionality in v2 with the `--delete-v1-images` command flag.
|
|
|
|
Once all images mirrored with oc-mirror plugin v1 are removed, you no longer need to use this flag. If you need to delete images mirrored with oc-mirror plugin v2, do not set `--delete-v1-images`.
|
|
====
|
|
+
|
|
For more information about deleting images, see "Deletion of images from your disconnected environment".
|
|
|
|
.. Delete images based on the generated manifest by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc-mirror delete --delete-yaml-file some-dir/working-dir/delete/delete-images.yaml docker://registry.example:5000 --v2
|
|
----
|