diff --git a/_topic_map.yml b/_topic_map.yml index 165407ea9d..b8ee4033f9 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1036,11 +1036,13 @@ Topics: File: planning-migration-3-to-4 - Name: Migrating OpenShift Container Platform 3.7 to 4.2 File: migrating-openshift-3-to-4 -- Name: Migrating OpenShift Container Platform 4.1 to 4.2 +- Name: Migrating OpenShift Container Platform 4.x to 4.x Dir: migrating-4-4 Topics: - Name: Migrating OpenShift Container Platform 4.1 to 4.2 - File: migrating-openshift-4-to-4 + File: migrating-openshift-4_1-to-4 + - Name: Migrating between OpenShift Container Platform 4.2 clusters + File: migrating-openshift-4_2-to-4 --- Name: CLI tools Dir: cli_reference diff --git a/migration/migrating-3-4/migrating-openshift-3-to-4.adoc b/migration/migrating-3-4/migrating-openshift-3-to-4.adoc index 0344fe3f88..5655bd84a6 100644 --- a/migration/migrating-3-4/migrating-openshift-3-to-4.adoc +++ b/migration/migrating-3-4/migrating-openshift-3-to-4.adoc @@ -66,10 +66,10 @@ The CAM Operator installs the following: include::modules/migration-installing-cam-operator-ocp-3.adoc[leveloffset=+2] :ocp-3-to-4!: -:context: targetcluster3-4 -:targetcluster3-4: +:context: targetcluster_4.2 +:targetcluster_4.2: include::modules/migration-installing-cam-operator-ocp-4.adoc[leveloffset=+2] -:targetcluster3-4!: +:targetcluster_4.2!: :context: ocp-3-to-4 :ocp-3-to-4: diff --git a/migration/migrating-4-4/migrating-openshift-4-to-4.adoc b/migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc similarity index 93% rename from migration/migrating-4-4/migrating-openshift-4-to-4.adoc rename to migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc index b3ba6c0a6d..27e71be090 100644 --- a/migration/migrating-4-4/migrating-openshift-4-to-4.adoc +++ b/migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc @@ -1,6 +1,6 @@ -[id="migrating-openshift-4-to-4"] +[id="migrating-openshift-4_1-to-4"] = Migrating {product-title} 4.1 to 4.2 -include::modules/common-attributes.adoc[] + :context: ocp-4_1-4_2 :ocp-4_1-4_2: @@ -54,20 +54,23 @@ The CAM Operator installs the Migration controller, CAM web console, Restic, and :ocp-4_1-4_2!: -:context: sourcecluster -:sourcecluster: +:context: sourcecluster-4_1-4_2 +:sourcecluster-4_1-4_2: include::modules/migration-installing-cam-operator-ocp-4.adoc[leveloffset=+2] -:sourcecluster!: +:sourcecluster-4_1-4_2!: -:context: targetcluster4-4 -:targetcluster4-4: +:context: targetcluster_4_1-4_2 +:targetcluster_4_1-4_2: include::modules/migration-installing-cam-operator-ocp-4.adoc[leveloffset=+2] -:targetcluster4-4!: +:targetcluster_4_1-4_2!: + +:context: sourcecluster-4_1-4_2 +:sourcecluster-4_1-4_2: +include::modules/migration-configuring-cors-4.adoc[leveloffset=+2] +:sourcecluster-4_1-4_2!: :context: ocp-4_1-4_2 :ocp-4_1-4_2: -include::modules/migration-configuring-cors-4.adoc[leveloffset=+2] - == Migrating applications with the CAM web console include::modules/migration-launching-cam.adoc[leveloffset=+2] diff --git a/migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc b/migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc new file mode 100644 index 0000000000..aafe1f2c49 --- /dev/null +++ b/migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc @@ -0,0 +1,71 @@ +[id="migrating-openshift-4_2-to-4"] += Migrating between {product-title} 4.2 clusters + +:context: ocp-4_2-4_2 +:ocp-4_2-4_2: + +toc::[] + +You can migrate application workloads between {product-title} 4.2 clusters with the Cluster Application Migration (CAM) tool. The CAM tool enables you to control the migration and to minimize application downtime. + +The CAM tool's web console and API, based on Kubernetes custom resources, enable you to migrate stateful and stateless application workloads at the granularity of a namespace. + +You can migrate data to a different storage class, for example, from Red Hat Gluster Storage or NFS storage to Red Hat Ceph Storage. + +.Prerequisites + +* You must have xref:../../cli_reference/openshift_cli/administrator-cli-commands.html#policy[`cluster-admin` privileges] on all clusters. +* You must have a replication repository that supports the S3 API and is accessible to the source and target clusters. + +include::modules/migration-understanding-cam.adoc[leveloffset=+1] + +== Deploying the Cluster Application Migration tool + +Deploying the CAM tool involves the following steps: + +. Installing the CAM Operator on all clusters ++ +The CAM Operator installs the Migration controller, CAM web console, Restic, and Velero on the target cluster and Restic and Velero on the source cluster(s). + +. Configuring cross-origin resource sharing on the source cluster(s) to enable communication with the CAM tool + +:ocp-4_2-4_2!: + +:context: sourcecluster-4_2-4_2 +:sourcecluster-4_2-4_2: +include::modules/migration-installing-cam-operator-ocp-4.adoc[leveloffset=+2] +:sourcecluster-4_2-4_2!: + +:context: targetcluster-4_2-4_2 +:targetcluster-4_2-4_2: +include::modules/migration-installing-cam-operator-ocp-4.adoc[leveloffset=+2] +:targetcluster-4_2-4_2!: + +:context: sourcecluster-4_2-4_2 +:sourcecluster-4_2-4_2: +include::modules/migration-configuring-cors-4.adoc[leveloffset=+2] +:sourcecluster-4_2-4_2!: + + +:context: ocp-4_2-4_2 +:ocp-4_2-4_2: +== Migrating applications with the CAM web console + +include::modules/migration-launching-cam.adoc[leveloffset=+2] +include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+2] +include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+2] +include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2] +include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2] +include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2] + +== Troubleshooting a failed migration + +You can view the migration custom resources (CRs) and download logs to troubleshoot a failed migration. + +include::modules/migration-custom-resources.adoc[leveloffset=+2] +include::modules/migration-viewing-migration-crs.adoc[leveloffset=+2] +include::modules/migration-downloading-logs.adoc[leveloffset=+2] +include::modules/migration-restic-timeout.adoc[leveloffset=+2] + +include::modules/migration-known-issues.adoc[leveloffset=+1] +:ocp-4_2-4_2!: diff --git a/modules/migration-adding-cluster-to-cam.adoc b/modules/migration-adding-cluster-to-cam.adoc index 615418d4c3..cf35df9b4e 100644 --- a/modules/migration-adding-cluster-to-cam.adoc +++ b/modules/migration-adding-cluster-to-cam.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-adding-cluster-to-cam_{context}'] = Adding a cluster to the CAM web console diff --git a/modules/migration-adding-replication-repository-to-cam.adoc b/modules/migration-adding-replication-repository-to-cam.adoc index 413de2ad23..39b8e6f717 100644 --- a/modules/migration-adding-replication-repository-to-cam.adoc +++ b/modules/migration-adding-replication-repository-to-cam.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-adding-replication-repository-to-cam_{context}'] = Adding a replication repository to the CAM web console diff --git a/modules/migration-changing-migration-plan-limits.adoc b/modules/migration-changing-migration-plan-limits.adoc index d106442e8e..74f95eab87 100644 --- a/modules/migration-changing-migration-plan-limits.adoc +++ b/modules/migration-changing-migration-plan-limits.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-changing-migration-plan-limits_{context}'] = Changing migration plan limits for large migrations diff --git a/modules/migration-configuring-cors-4.adoc b/modules/migration-configuring-cors-4.adoc index 9bc875d57e..d4eaf23e37 100644 --- a/modules/migration-configuring-cors-4.adoc +++ b/modules/migration-configuring-cors-4.adoc @@ -1,10 +1,19 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-configuring-cors-4_{context}'] -= Configuring cross-origin resource sharing on an {product-title} 4 source cluster +ifdef::sourcecluster-4_1-4_2[] += Configuring cross-origin resource sharing on an {product-title} 4.1 source cluster -You must configure cross-origin resource sharing on an {product-title} 4 source cluster to enable communication between the source cluster's API server and the CAM tool. +You must configure cross-origin resource sharing on an {product-title} 4.1 source cluster to enable communication between the source cluster's API server and the CAM tool. +endif::[] +ifdef::sourcecluster-4_2-4_2[] += Configuring cross-origin resource sharing on an {product-title} 4.2 source cluster + +You must configure cross-origin resource sharing on an {product-title} 4.2 source cluster to enable communication between the source cluster's API server and the CAM tool. +endif::[] // If you are migrating to or from an {product-title} 4 cluster that does not have the CAM tool installed, you must configure cross-origin resource sharing so that the CAM tool can access the cluster's API server. @@ -18,6 +27,7 @@ $ oc get -n openshift-migration route/migration -o go-template='(?i)//{{ .spec.h ---- . Log in to the source cluster. +ifdef::sourcecluster-4_1-4_2[] . Edit the OAuth server CR: + ---- @@ -36,6 +46,7 @@ spec: <1> Specify your CORS configuration value. . Save the file to apply the changes. +endif::[] . Edit the Kubernetes API server CR: + @@ -43,6 +54,7 @@ spec: $ oc edit kubeapiserver.operator cluster ---- +ifdef::sourcecluster-4_1-4_2[] . Add the CORS configuration value to `corsAllowedOrigins` under `unsupportedConfigOverrides` in the `spec` stanza: + [source,yaml] @@ -53,6 +65,18 @@ spec: - (?i)//migration-openshift-migration\.apps\.cluster\.com(:|\z) <1> ---- <1> Specify your CORS configuration value. +endif::[] +ifdef::sourcecluster-4_2-4_2[] +. Add the CORS configuration value to `additionalCORSAllowedOrigins` in the `spec` stanza: ++ +[source,yaml] +---- +spec: + additionalCORSAllowedOrigins: + - (?i)//migration-openshift-migration\.apps\.cluster\.com(:|\z) <1> +---- +<1> Specify your CORS configuration value. +endif::[] . Save the file to apply the changes. diff --git a/modules/migration-creating-migration-plan-cam.adoc b/modules/migration-creating-migration-plan-cam.adoc index 758c61abb7..4f1973cda5 100644 --- a/modules/migration-creating-migration-plan-cam.adoc +++ b/modules/migration-creating-migration-plan-cam.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-creating-migration-plan-cam_{context}'] = Creating a migration plan in the CAM web console diff --git a/modules/migration-custom-resources.adoc b/modules/migration-custom-resources.adoc index 5d2553822a..d5e4b3d752 100644 --- a/modules/migration-custom-resources.adoc +++ b/modules/migration-custom-resources.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-custom-resources_{context}'] = Understanding the migration custom resources diff --git a/modules/migration-downloading-logs.adoc b/modules/migration-downloading-logs.adoc index 0480076227..993a23ab1d 100644 --- a/modules/migration-downloading-logs.adoc +++ b/modules/migration-downloading-logs.adoc @@ -1,5 +1,8 @@ // Module included in the following assemblies: -// migration/migrating-openshift-3-to-4.adoc +// +// migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-downloading-logs_{context}'] = Downloading migration logs diff --git a/modules/migration-installing-cam-operator-ocp-4.adoc b/modules/migration-installing-cam-operator-ocp-4.adoc index b199c27d26..9af5a6c1ff 100644 --- a/modules/migration-installing-cam-operator-ocp-4.adoc +++ b/modules/migration-installing-cam-operator-ocp-4.adoc @@ -1,17 +1,24 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc -// migration/migrating-4-4/migrating-openshift-4-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id="installing-cam-operator-ocp-4_{context}"] -ifdef::sourcecluster[] +ifdef::sourcecluster-4_1-4_2[] = Installing the CAM Operator on an {product-title} 4.1 source cluster You can install the CAM Operator on an {product-title} 4.1 source cluster with OLM. The CAM Operator installs Velero and Restic. endif::[] +ifdef::sourcecluster-4_2-4_2[] += Installing the CAM Operator on an {product-title} 4.2 source cluster -ifdef::targetcluster3-4,targetcluster4-4[] +You can install the CAM Operator on an {product-title} 4.2 source cluster with OLM. + +The CAM Operator installs Velero and Restic. +endif::[] +ifdef::targetcluster-4_2-4_2[] = Installing the CAM Operator on an {product-title} 4.2 target cluster You can install the CAM Operator on an {product-title} 4.2 target cluster with OLM. @@ -43,7 +50,7 @@ The *Cluster Application Migration Operator* is listed in the *openshift-migrati . On the *Installed Operators* page: .. Under *Provided APIs*, click *View 12 more...*. .. Click *Create New* -> *MigrationController*. -ifdef::sourcecluster[] +ifdef::sourcecluster-4_1-4_2[] .. Update the `migration_controller` and `migration_ui` parameters and add the `deprecated_cors_configuration` parameter to the `spec` stanza: + [source,yaml] @@ -56,11 +63,23 @@ spec: deprecated_cors_configuration: true ---- endif::[] +ifdef::sourcecluster-4_2-4_2[] +.. Update the `migration_controller` and `migration_ui` parameters in the `spec` stanza: ++ +[source,yaml] +---- +spec: + [...] + migration_controller: false + migration_ui: false + [...] +---- +endif::[] .. Click *Create*. -ifdef::sourcecluster[] +ifdef::sourcecluster-4_1-4_2,sourcecluster-4_2-4_2[] . Click *Workloads* -> *Pods* to verify that the Restic and Velero Pods are running. endif::[] -ifdef::targetcluster3-4,targetcluster4-4[] +ifdef::targetcluster-4_2-4_2[] . Click *Workloads* -> *Pods* to verify that the Controller Manager, Migration UI, Restic, and Velero Pods are running. endif::[] diff --git a/modules/migration-known-issues.adoc b/modules/migration-known-issues.adoc index ee0627e5b6..dca8117f19 100644 --- a/modules/migration-known-issues.adoc +++ b/modules/migration-known-issues.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-known-issues_{context}'] = Known issues diff --git a/modules/migration-launching-cam.adoc b/modules/migration-launching-cam.adoc index 34bfdadc28..7b24f6e09a 100644 --- a/modules/migration-launching-cam.adoc +++ b/modules/migration-launching-cam.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id="migration-launching-cam_{context}"] = Launching the CAM web console diff --git a/modules/migration-restic-timeout.adoc b/modules/migration-restic-timeout.adoc index ac467e3ce1..990f30d6e6 100644 --- a/modules/migration-restic-timeout.adoc +++ b/modules/migration-restic-timeout.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-restic-timeout_{context}'] = Restic timeout error diff --git a/modules/migration-running-migration-plan-cam.adoc b/modules/migration-running-migration-plan-cam.adoc index d461b93348..da5a8dea13 100644 --- a/modules/migration-running-migration-plan-cam.adoc +++ b/modules/migration-running-migration-plan-cam.adoc @@ -1,6 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-running-migration-plan-cam_{context}'] = Running a migration plan in the CAM web console diff --git a/modules/migration-understanding-cam.adoc b/modules/migration-understanding-cam.adoc index f891473264..eefe2d85c7 100644 --- a/modules/migration-understanding-cam.adoc +++ b/modules/migration-understanding-cam.adoc @@ -1,7 +1,8 @@ // Module included in the following assemblies: // // migration/migrating-3-4/migrating-openshift-3-to-4.adoc -// migration/migrating-4-4/migrating-openshift-4-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-understanding-cam_{context}'] = Understanding the Cluster Application Migration tool diff --git a/modules/migration-viewing-migration-crs.adoc b/modules/migration-viewing-migration-crs.adoc index 81eec8ddbd..385876dee7 100644 --- a/modules/migration-viewing-migration-crs.adoc +++ b/modules/migration-viewing-migration-crs.adoc @@ -1,5 +1,8 @@ // Module included in the following assemblies: -// migration/migrating-openshift-3-to-4.adoc +// +// migration/migrating-3-4/migrating-openshift-3-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_1-to-4.adoc +// migration/migrating-4-4/migrating-openshift-4_2-to-4.adoc [id='migration-viewing-migration-crs_{context}'] = Viewing migration custom resources