Merge pull request #27373 from apinnick/MIG412-mtc-migration-rollback

apinnick · web-flow · commit 4f678c3a6024 · 2021-02-09T12:07:00.000+02:00
MIG-412: MTC migration rollback (1.4.0)
diff --git a/migration/migrating_3_4/troubleshooting-3-4.adoc b/migration/migrating_3_4/troubleshooting-3-4.adoc
@@ -20,8 +20,15 @@ include::modules/migration-using-mig-log-reader.adoc[leveloffset=+1]
 include::modules/migration-downloading-logs.adoc[leveloffset=+1]
 include::modules/migration-updating-deprecated-gvks.adoc[leveloffset=+1]
 include::modules/migration-error-messages.adoc[leveloffset=+1]
-include::modules/migration-manually-rolling-back-migration.adoc[leveloffset=+1]
+
+[id="rolling-back-migration_{context}"]
+== Rolling back a migration
+
+You can roll back a migration by using the {mtc-short} web console or the CLI.
+
+include::modules/migration-rolling-back-migration-web-console.adoc[leveloffset=+2]
+include::modules/migration-rolling-back-migration-cli.adoc[leveloffset=+2]
+
 include::modules/migration-using-must-gather.adoc[leveloffset=+1]
 include::modules/migration-known-issues.adoc[leveloffset=+1]
-
 :!migrating-3-4:
diff --git a/migration/migrating_4_1_4/troubleshooting-4-1-4.adoc b/migration/migrating_4_1_4/troubleshooting-4-1-4.adoc
@@ -8,7 +8,7 @@ toc::[]
 
 You can view the {mtc-full} ({mtc-short}) custom resources and download logs to troubleshoot a failed migration.
 
-If the application was stopped during the failed migration, you must roll it back manually in order to prevent data corruption.
+If the application was stopped during the failed migration, you must roll back the migration in order to prevent data corruption.
 
 [NOTE]
 ====
@@ -19,7 +19,15 @@ include::modules/migration-viewing-migration-crs.adoc[leveloffset=+1]
 include::modules/migration-using-mig-log-reader.adoc[leveloffset=+1]
 include::modules/migration-downloading-logs.adoc[leveloffset=+1]
 include::modules/migration-error-messages.adoc[leveloffset=+1]
-include::modules/migration-manually-rolling-back-migration.adoc[leveloffset=+1]
+
+[id="rolling-back-migration_{context}"]
+== Rolling back a migration
+
+You can roll back a migration by using the {mtc-short} web console or the CLI.
+
+include::modules/migration-rolling-back-migration-web-console.adoc[leveloffset=+2]
+include::modules/migration-rolling-back-migration-cli.adoc[leveloffset=+2]
+
 include::modules/migration-using-must-gather.adoc[leveloffset=+1]
 include::modules/migration-known-issues.adoc[leveloffset=+1]
 :!migrating-4-1-4:
diff --git a/migration/migrating_4_2_4/troubleshooting-4-2-4.adoc b/migration/migrating_4_2_4/troubleshooting-4-2-4.adoc
@@ -19,7 +19,15 @@ include::modules/migration-viewing-migration-crs.adoc[leveloffset=+1]
 include::modules/migration-using-mig-log-reader.adoc[leveloffset=+1]
 include::modules/migration-downloading-logs.adoc[leveloffset=+1]
 include::modules/migration-error-messages.adoc[leveloffset=+1]
-include::modules/migration-manually-rolling-back-migration.adoc[leveloffset=+1]
+
+[id="rolling-back-migration_{context}"]
+== Rolling back a migration
+
+You can roll back a migration by using the {mtc-short} web console or the CLI.
+
+include::modules/migration-rolling-back-migration-web-console.adoc[leveloffset=+2]
+include::modules/migration-rolling-back-migration-cli.adoc[leveloffset=+2]
+
 include::modules/migration-using-must-gather.adoc[leveloffset=+1]
 include::modules/migration-known-issues.adoc[leveloffset=+1]
 :!migrating-4-2-4:
diff --git a/modules/migration-manually-rolling-back-migration.adoc b/modules/migration-manually-rolling-back-migration.adoc
diff --git a/modules/migration-rolling-back-migration-cli.adoc b/modules/migration-rolling-back-migration-cli.adoc
@@ -0,0 +1,50 @@
+// Module included in the following assemblies:
+// * migration/migrating_3_4/troubleshooting-3-4.adoc
+// * migration/migrating_4_1_4/troubleshooting-4-1-4.adoc
+// * migration/migrating_4_2_4/troubleshooting-4-2-4.adoc
+
+[id='migration-rolling-back-migration-cli_{context}']
+== Rolling back a migration from the CLI
+
+You can roll back a migration by using the CLI.
+
+If your application was stopped during a failed migration, you must roll back the migration in order to prevent data corruption in the persistent volume.
+
+Rollback is not required if the application was not stopped during migration because the original application is still running on the source cluster.
+
+.Procedure
+
+. Create a `MigMigration` CR object based on the following example:
++
+[source,yaml]
+----
+$ cat << EOF | oc apply -f -
+---
+apiVersion: migration.openshift.io/v1alpha1
+kind: MigMigration
+metadata:
+  labels:
+    controller-tools.k8s.io: "1.0"
+  name: migration-rollback
+  namespace: openshift-migration
+spec:
+  # 'canceled: true' cancels the migration
+  canceled: false
+  # 'rollback: true' rolls back the migration
+  rollback: true
+  # 'stage: true' runs a stage migration without quiescing the application on the source cluster.
+  stage: false
+  # 'quiescePods: true' scales the pods on the source cluster to '0' after the 'Backup' stage of a migration has finished
+  quiescePods: false
+  # 'keepAnnotations: true' retains the labels and annotations applied by the migration
+  keepAnnotations: false
+
+  migPlanRef:
+    name: <migplan-name> <1>
+    namespace: openshift-migration
+EOF
+----
+<1> Specify the name of the migration plan that you want to roll back.
+
+. In the {mtc-short} console, verify that the migrated project resources have been removed from the target cluster.
+. Verify that the migrated project resources are present in the source cluster and that the application is running.
diff --git a/modules/migration-rolling-back-migration-web-console.adoc b/modules/migration-rolling-back-migration-web-console.adoc
@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+// * migration/migrating_3_4/troubleshooting-3-4.adoc
+// * migration/migrating_4_1_4/troubleshooting-4-1-4.adoc
+// * migration/migrating_4_2_4/troubleshooting-4-2-4.adoc
+
+[id='migration-rolling-back-migration-web-console_{context}']
+= Rolling back a migration in the {mtc-short} web console
+
+You can roll back a migration by using the {mtc-full} ({mtc-short}) web console.
+
+If your application was stopped during a failed migration, you must roll back the migration in order to prevent data corruption in the persistent volume.
+
+Rollback is not required if the application was not stopped during migration because the original application is still running on the source cluster.
+
+.Procedure
+
+. In the {mtc-short} web console, click *Migration plans*.
+. Click the Options menu {kebab} beside a migration plan and select *Rollback*.
+. Click *Rollback* and wait for rollback to complete.
++
+In the migration plan details, *Rollback succeeded* is displayed.
+
+. Verify that rollback was successful in the {product-title} web console of the source cluster:
+
+.. Click *Home* -> *Projects*.
+.. Click the migrated project to view its status.
+.. In the *Routes* section, click *Location* to verify that the application is functioning, if applicable.
+.. Click *Workloads* -> *Pods* to verify that the pods are running in the migrated namespace.
+.. Click *Storage* -> *Persistent volumes* to verify that the migrated persistent volume is correctly provisioned.
diff --git a/modules/migration-running-migration-plan-cam.adoc b/modules/migration-running-migration-plan-cam.adoc
@@ -9,15 +9,6 @@
 
 You can stage or migrate applications and data with the migration plan you created in the {mtc-full} ({mtc-short}) web console.
 
-.Prerequisites
-
-The {mtc-short} web console must contain the following:
-
-* Source cluster
-* Target cluster
-* Replication repository
-* Valid migration plan
-
 .Procedure
 
 . Log in to the source cluster.
