2.2. Installing and upgrading the Migration Toolkit for Containers

Procedure

1. In the OpenShift Container Platform web console, click Operators OperatorHub.
2. Use the Filter by keyword field to find the Migration Toolkit for Containers Operator.

3. Select the Migration Toolkit for Containers Operator and click Install.

   注意

   Do not change the subscription approval option to Automatic. The Migration Toolkit for Containers version must be the same on the source and the target clusters.

4. Click Install.

   On the Installed Operators page, the Migration Toolkit for Containers Operator appears in the openshift-migration project with the status Succeeded.

5. Click Migration Toolkit for Containers Operator.
6. Under Provided APIs, locate the Migration Controller tile, and click Create Instance.
7. Click Create.
8. Click Workloads Pods to verify that the MTC pods are running.

Procedure

1. In the OpenShift Container Platform web console, click Catalog OperatorHub.
2. Use the Filter by keyword field to find the Migration Toolkit for Containers Operator.

3. Select the Migration Toolkit for Containers Operator and click Install.

   注意

   Do not change the subscription approval option to Automatic. The Migration Toolkit for Containers version must be the same on the source and the target clusters.

4. Click Install.

   On the Installed Operators page, the Migration Toolkit for Containers Operator appears in the openshift-migration project with the status Succeeded.

5. Click Migration Toolkit for Containers Operator.
6. Under Provided APIs, locate the Migration Controller tile, and click Create Instance.

7. Update the following parameters in the migration-controller custom resource manifest:

   spec:
   ...
     migration_controller: false
     migration_ui: false
   ...
     deprecated_cors_configuration: true 

   1

   Copy to Clipboard Toggle word wrap

   1

   Add the deprecated_cors_configuration parameter and its value.

8. Click Create.
9. Click Workloads Pods to verify that the MTC pods are running.

Procedure

1. On the workstation with unrestricted network access, authenticate with the target mirror registry:

   $ podman login <registry_host_name>

   Copy to Clipboard Toggle word wrap

   Also authenticate with registry.redhat.io so that the base image can be pulled during the build:

   $ podman login registry.redhat.io

   Copy to Clipboard Toggle word wrap

2. Build a catalog image based on the redhat-operators catalog from Quay.io, tagging and pushing it to your mirror registry:

   $ oc adm catalog build \
       --appregistry-org redhat-operators \

   1

   
       --from=registry.redhat.io/openshift4/ose-operator-registry:v4.5 \

   2

   
       --filter-by-os="linux/amd64" \

   3

   
       --to=<registry_host_name>:<port>/olm/redhat-operators:v1 \

   4

   
       [-a ${REG_CREDS}] \

   5

   
       [--insecure] \

   6

   
       [--auth-token "${AUTH_TOKEN}"] 

   7

   Copy to Clipboard Toggle word wrap

   1

   Organization (namespace) to pull from an App Registry instance.

   2

   Set --from to the ose-operator-registry base image using the tag that matches the target OpenShift Container Platform cluster major and minor version.

   3

   Set --filter-by-os to the operating system and architecture to use for the base image, which must match the target OpenShift Container Platform cluster. Valid values are linux/amd64, linux/ppc64le, and linux/s390x.

   4

   Name your catalog image and include a tag, for example, v1.

   5

   Optional: If required, specify the location of your registry credentials file.

   6

   Optional: If you do not want to configure trust for the target registry, add the --insecure flag.

   7

   Optional: If other application registry catalogs are used that are not public, specify a Quay authentication token.

   Example output

   INFO[0013] loading Bundles                               dir=/var/folders/st/9cskxqs53ll3wdn434vw4cd80000gn/T/300666084/manifests-829192605
   ...
   Pushed sha256:f73d42950021f9240389f99ddc5b0c7f1b533c054ba344654ff1edaf6bf827e3 to example_registry:5000/olm/redhat-operators:v1

   Copy to Clipboard Toggle word wrap

   Sometimes invalid manifests are accidentally introduced catalogs provided by Red Hat; when this happens, you might see some errors:

   Example output with errors

   ...
   INFO[0014] directory                                     dir=/var/folders/st/9cskxqs53ll3wdn434vw4cd80000gn/T/300666084/manifests-829192605 file=4.2 load=package
   W1114 19:42:37.876180   34665 builder.go:141] error building database: error loading package into db: fuse-camel-k-operator.v7.5.0 specifies replacement that couldn't be found
   Uploading ... 244.9kB/s

   Copy to Clipboard Toggle word wrap

   These errors are usually non-fatal, and if the Operator package mentioned does not contain an Operator you plan to install or a dependency of one, then they can be ignored.

Procedure

1. The oc adm catalog mirror command extracts the contents of your custom Operator catalog image to generate the manifests required for mirroring. You can choose to either:

   • Allow the default behavior of the command to automatically mirror all of the image content to your mirror registry after generating manifests, or
   • Add the --manifests-only flag to only generate the manifests required for mirroring, but do not actually mirror the image content to a registry yet. This can be useful for reviewing what will be mirrored, and it allows you to make any changes to the mapping list if you only require a subset of the content. You can then use that file with the oc image mirror command to mirror the modified list of images in a later step.

   On your workstation with unrestricted network access, run the following command:

   $ oc adm catalog mirror \
       <registry_host_name>:<port>/olm/redhat-operators:v1 \

   1

   
       <registry_host_name>:<port> \
       [-a ${REG_CREDS}] \

   2

   
       [--insecure] \

   3

   
       --filter-by-os='.*' \

   4

   
       [--manifests-only] 

   5

   Copy to Clipboard Toggle word wrap

   1

   Specify your Operator catalog image.

   2

   Optional: If required, specify the location of your registry credentials file.

   3

   Optional: If you do not want to configure trust for the target registry, add the --insecure flag.

   4

   This flag is currently required due to a known issue with multiple architecture support.

   5

   Optional: Only generate the manifests required for mirroring and do not actually mirror the image content to a registry.

   警告

   If the --filter-by-os flag remains unset or set to any value other than .*, the command filters out different architectures, which changes the digest of the manifest list, also known as a multi-arch image. The incorrect digest causes deployments of those images and Operators on disconnected clusters to fail. For more information, see BZ#1890951.

   Example output

   using database path mapping: /:/tmp/190214037
   wrote database to /tmp/190214037
   using database at: /tmp/190214037/bundles.db 

   1

   
   ...

   Copy to Clipboard Toggle word wrap

   1

   Temporary database generated by the command.

   After running the command, a <image_name>-manifests/ directory is created in the current directory and generates the following files:

   • The imageContentSourcePolicy.yaml file defines an ImageContentSourcePolicy object that can configure nodes to translate between the image references stored in Operator manifests and the mirrored registry.
   • The mapping.txt file contains all of the source images and where to map them in the target registry. This file is compatible with the oc image mirror command and can be used to further customize the mirroring configuration.

2. If you used the --manifests-only flag in the previous step and want to mirror only a subset of the content:

   1. Modify the list of images in your mapping.txt file to your specifications. If you are unsure of the exact names and versions of the subset of images you want to mirror, use the following steps to find them:

      1. Run the sqlite3 tool against the temporary database that was generated by the oc adm catalog mirror command to retrieve a list of images matching a general search query. The output helps inform how you will later edit your mapping.txt file.

         For example, to retrieve a list of images that are similar to the string clusterlogging.4.3:

         $ echo "select * from related_image \
             where operatorbundle_name like 'clusterlogging.4.3%';" \
             | sqlite3 -line /tmp/190214037/bundles.db 

         1

         Copy to Clipboard Toggle word wrap

         1

         Refer to the previous output of the oc adm catalog mirror command to find the path of the database file.

         Example output

         image = registry.redhat.io/openshift4/ose-logging-kibana5@sha256:aa4a8b2a00836d0e28aa6497ad90a3c116f135f382d8211e3c55f34fb36dfe61
         operatorbundle_name = clusterlogging.4.3.33-202008111029.p0
         
         image = registry.redhat.io/openshift4/ose-oauth-proxy@sha256:6b4db07f6e6c962fc96473d86c44532c93b146bbefe311d0c348117bf759c506
         operatorbundle_name = clusterlogging.4.3.33-202008111029.p0
         ...

         Copy to Clipboard Toggle word wrap

      2. Use the results from the previous step to edit the mapping.txt file to only include the subset of images you want to mirror.

         For example, you can use the image values from the previous example output to find that the following matching lines exist in your mapping.txt file:

         Matching image mappings in mapping.txt

         registry.redhat.io/openshift4/ose-logging-kibana5@sha256:aa4a8b2a00836d0e28aa6497ad90a3c116f135f382d8211e3c55f34fb36dfe61=<registry_host_name>:<port>/openshift4-ose-logging-kibana5:a767c8f0
         registry.redhat.io/openshift4/ose-oauth-proxy@sha256:6b4db07f6e6c962fc96473d86c44532c93b146bbefe311d0c348117bf759c506=<registry_host_name>:<port>/openshift4-ose-oauth-proxy:3754ea2b

         Copy to Clipboard Toggle word wrap

         In this example, if you only want to mirror these images, you would then remove all other entries in the mapping.txt file and leave only the above two lines.

   2. Still on your workstation with unrestricted network access, use your modified mapping.txt file to mirror the images to your registry using the oc image mirror command:

      $ oc image mirror \
          [-a ${REG_CREDS}] \
          --filter-by-os='.*' \
          -f ./redhat-operators-manifests/mapping.txt

      Copy to Clipboard Toggle word wrap
      警告

      If the --filter-by-os flag remains unset or set to any value other than .*, the command filters out different architectures, which changes the digest of the manifest list, also known as a multi-arch image. The incorrect digest causes deployments of those images and Operators on disconnected clusters to fail.

3. Apply the ImageContentSourcePolicy object:

   $ oc apply -f ./redhat-operators-manifests/imageContentSourcePolicy.yaml

   Copy to Clipboard Toggle word wrap

4. Create a CatalogSource object that references your catalog image.

   1. Modify the following to your specifications and save it as a catalogsource.yaml file:

      apiVersion: operators.coreos.com/v1alpha1
      kind: CatalogSource
      metadata:
        name: my-operator-catalog
        namespace: openshift-marketplace
      spec:
        sourceType: grpc
        image: <registry_host_name>:<port>/olm/redhat-operators:v1 

      1

      
        displayName: My Operator Catalog
        publisher: grpc

      Copy to Clipboard Toggle word wrap

      1

      Specify your custom Operator catalog image.

   2. Use the file to create the CatalogSource object:

      $ oc create -f catalogsource.yaml

      Copy to Clipboard Toggle word wrap

5. Verify the following resources are created successfully.

   1. Check the pods:

      $ oc get pods -n openshift-marketplace

      Copy to Clipboard Toggle word wrap

      Example output

      NAME                                    READY   STATUS    RESTARTS  AGE
      my-operator-catalog-6njx6               1/1     Running   0         28s
      marketplace-operator-d9f549946-96sgr    1/1     Running   0         26h

      Copy to Clipboard Toggle word wrap

   2. Check the catalog source:

      $ oc get catalogsource -n openshift-marketplace

      Copy to Clipboard Toggle word wrap

      Example output

      NAME                  DISPLAY               TYPE PUBLISHER  AGE
      my-operator-catalog   My Operator Catalog   grpc            5s

      Copy to Clipboard Toggle word wrap

   3. Check the package manifest:

      $ oc get packagemanifest -n openshift-marketplace

      Copy to Clipboard Toggle word wrap

      Example output

      NAME    CATALOG              AGE
      etcd    My Operator Catalog  34s

      Copy to Clipboard Toggle word wrap

Procedure

1. In the OpenShift Container Platform web console, click Operators OperatorHub.
2. Use the Filter by keyword field to find the Migration Toolkit for Containers Operator.

3. Select the Migration Toolkit for Containers Operator and click Install.

   注意

   Do not change the subscription approval option to Automatic. The Migration Toolkit for Containers version must be the same on the source and the target clusters.

4. Click Install.

   On the Installed Operators page, the Migration Toolkit for Containers Operator appears in the openshift-migration project with the status Succeeded.

5. Click Migration Toolkit for Containers Operator.
6. Under Provided APIs, locate the Migration Controller tile, and click Create Instance.
7. Click Create.
8. Click Workloads Pods to verify that the MTC pods are running.

Procedure

1. Use the Filter by keyword field to find the Migration Toolkit for Containers Operator.

2. Select the Migration Toolkit for Containers Operator and click Install.

   注意

   Do not change the subscription approval option to Automatic. The Migration Toolkit for Containers version must be the same on the source and the target clusters.

3. Click Install.

   On the Installed Operators page, the Migration Toolkit for Containers Operator appears in the openshift-migration project with the status Succeeded.

4. Click Migration Toolkit for Containers Operator.
5. Under Provided APIs, locate the Migration Controller tile, and click Create Instance.
6. Click Create.
7. Click Workloads Pods to verify that the MTC pods are running.

Procedure

1. In the OpenShift Container Platform console, navigate to Operators Installed Operators.

   Operators that have a pending upgrade display an Upgrade available status.

2. Click Migration Toolkit for Containers Operator.
3. Click the Subscription tab. Any upgrades requiring approval are displayed next to Upgrade Status. For example, it might display 1 requires approval.
4. Click 1 requires approval, then click Preview Install Plan.
5. Review the resources that are listed as available for upgrade and click Approve.
6. Navigate back to the Operators Installed Operators page to monitor the progress of the upgrade. When complete, the status changes to Succeeded and Up to date.
7. Click Migration Toolkit for Containers Operator.
8. Under Provided APIs, locate the Migration Controller tile, and click Create Instance.

9. If you are upgrading MTC on a source cluster, update the following parameters in the MigrationController custom resource (CR) manifest:

   spec:
   ...
     migration_controller: false
     migration_ui: false
   ...
     deprecated_cors_configuration: true

   Copy to Clipboard Toggle word wrap

   You do not need to update the MigrationController CR manifest on the target cluster.

10. Click Create.
11. Click Workloads Pods to verify that the MTC pods are running.

Procedure

1. Log in to the cluster on which the MigrationController pod is running.

2. Get the MigPlan CR manifest:

   $ oc get migplan <migplan> -o yaml -n openshift-migration

   Copy to Clipboard Toggle word wrap

3. Update the following parameter values and save the file as migplan.yaml:

   ...
   spec:
     indirectImageMigration: true
     indirectVolumeMigration: true

   Copy to Clipboard Toggle word wrap

4. Replace the MigPlan CR manifest to apply the changes:

   $ oc replace -f migplan.yaml -n openshift-migration

   Copy to Clipboard Toggle word wrap

5. Get the updated MigPlan CR manifest to verify the changes:

   $ oc get migplan <migplan> -o yaml -n openshift-migration

   Copy to Clipboard Toggle word wrap