Merge pull request #29058 from apinnick/mig414-mtc-api

MIG414: MTC API documentation (1.4.1)

Author: apinnick

migration/migrating_3_4/migrating-applications-with-cam-3-4.adoc

@@ -6,20 +6,54 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-You must add your clusters and a replication repository to the {mtc-short} web console. Then, you can create and run a migration plan.
+You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or on the command line.
 
-If your cluster or replication repository are secured with self-signed certificates, you can create a CA certificate bundle file or disable SSL verification.
+If you are using self-signed CA certificates to secure the clusters or the replication repository, you can create a CA certificate bundle file or disable SSL verification.
 
 include::modules/migration-creating-ca-bundle.adoc[leveloffset=+1]
-include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+1]
-include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+1]
-include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+1]
-include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+1]
+
+[id="migrating-applications-mtc-web-console_{context}"]
+== Migrating your applications by using the {mtc-short} web console
+
+You can configure clusters and a replication repository by using the {mtc-short} web console. Then, you can create and run a migration plan.
+
+include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+2]
+include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+2]
+include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2]
+include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
+
+[id="migrating-applications-mtc-cli_{context}"]
+== Migrating your applications on the command line
+
+You can migrate your applications on the command line by using the {mtc-short} custom resources (CRs).
+
+You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
+
+[discrete]
+=== {mtc-short} terminology
+
+The following terms are relevant for configuring clusters:
+
+* `host` cluster:
+** The `migration-controller` pod runs on the `host` cluster.
+** A `host` cluster does not require an exposed secure registry route for direct image migration.
+* Local cluster: The local cluster is often the same as the `host` cluster but this is not a requirement.
+* Remote cluster:
+** A remote cluster must have an exposed secure registry route for direct image migration.
+** A remote cluster must have a `Secret` CR containing the `migration-controller` service account token.
+
+The following terms are relevant for performing a migration:
+
+* Source cluster: Cluster from which the applications are migrated.
+* Destination cluster: Cluster to which the applications are migrated.
+
+include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
+include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
 
 [id='configuring-migration-plan_{context}']
 == Configuring a migration plan
 
-You can configure a migration plan to suit your needs by increasing the number of objects migrated or excluding resources from migration.
+You can configure a migration plan by increasing the number of objects migrated or excluding resources from migration.
 
 include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
 include::modules/migration-excluding-resources.adoc[leveloffset=+2]

migration/migrating_4_1_4/migrating-applications-with-cam-4-1-4.adoc

@@ -6,20 +6,54 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-You must add your clusters and a replication repository to the {mtc-short} web console. Then, you can create and run a migration plan.
+You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or on the command line.
 
-If your cluster or replication repository are secured with self-signed certificates, you can create a CA certificate bundle file or disable SSL verification.
+If you are using self-signed CA certificates to secure the clusters or the replication repository, you can create a CA certificate bundle file or disable SSL verification.
 
 include::modules/migration-creating-ca-bundle.adoc[leveloffset=+1]
-include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+1]
-include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+1]
-include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+1]
-include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+1]
+
+[id="migrating-applications-mtc-web-console_{context}"]
+== Migrating your applications using the {mtc-short} web console
+
+You can configure clusters and a replication repository by using the {mtc-short} web console. Then, you can create and run a migration plan.
+
+include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+2]
+include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+2]
+include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2]
+include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
+
+[id="migrating-applications-mtc-cli_{context}"]
+== Migrating your applications on the command line
+
+You can migrate your applications on the command line by using the {mtc-short} custom resources (CRs).
+
+You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
+
+[discrete]
+=== {mtc-short} terminology
+
+The following terms are relevant for configuring clusters:
+
+* `host` cluster:
+** The `migration-controller` pod runs on the `host` cluster.
+** A `host` cluster does not require an exposed secure registry route for direct image migration.
+* Local cluster: The local cluster is often the same as the `host` cluster but this is not a requirement.
+* Remote cluster:
+** A remote cluster must have an exposed secure registry route for direct image migration.
+** A remote cluster must have a `Secret` CR containing the `migration-controller` service account token.
+
+The following terms are relevant for performing a migration:
+
+* Source cluster: Cluster from which the applications are migrated.
+* Destination cluster: Cluster to which the applications are migrated.
+
+include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
+include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
 
 [id='configuring-migration-plan_{context}']
 == Configuring a migration plan
 
-You can configure a migration plan to suit your needs by increasing the number of objects migrated or excluding resources from migration.
+You can configure a migration plan by increasing the number of objects migrated or excluding resources from migration.
 
 include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
 include::modules/migration-excluding-resources.adoc[leveloffset=+2]

migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc

@@ -6,20 +6,54 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-You must add your clusters and a replication repository to the {mtc-short} web console. Then, you can create and run a migration plan.
+You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or on the command line.
 
-If your cluster or replication repository are secured with self-signed certificates, you can create a CA certificate bundle file or disable SSL verification.
+If you are using self-signed CA certificates to secure the clusters or the replication repository, you can create a CA certificate bundle file or disable SSL verification.
 
 include::modules/migration-creating-ca-bundle.adoc[leveloffset=+1]
-include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+1]
-include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+1]
-include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+1]
-include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+1]
+
+[id="migrating-applications-mtc-web-console_{context}"]
+== Migrating your applications by using the {mtc-short} web console
+
+You can configure clusters and a replication repository by using the {mtc-short} web console. Then, you can create and run a migration plan.
+
+include::modules/migration-adding-cluster-to-cam.adoc[leveloffset=+2]
+include::modules/migration-adding-replication-repository-to-cam.adoc[leveloffset=+2]
+include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2]
+include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
+
+[id="migrating-applications-mtc-cli_{context}"]
+== Migrating your applications on the command line
+
+You can migrate your applications on the command line by using the {mtc-short} custom resources (CRs).
+
+You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
+
+[discrete]
+=== {mtc-short} terminology
+
+The following terms are relevant for configuring clusters:
+
+* `host` cluster:
+** The `migration-controller` pod runs on the `host` cluster.
+** A `host` cluster does not require an exposed secure registry route for direct image migration.
+* Local cluster: The local cluster is often the same as the `host` cluster but this is not a requirement.
+* Remote cluster:
+** A remote cluster must have an exposed secure registry route for direct image migration.
+** A remote cluster must have a `Secret` CR containing the `migration-controller` service account token.
+
+The following terms are relevant for performing a migration:
+
+* Source cluster: Cluster from which the applications are migrated.
+* Destination cluster: Cluster to which the applications are migrated.
+
+include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
+include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
 
 [id='configuring-migration-plan_{context}']
 == Configuring a migration plan
 
-You can configure a migration plan to suit your needs by increasing the number of objects migrated or excluding resources from migration.
+You can configure a migration plan by increasing the number of objects migrated or excluding resources from migration.
 
 include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
 include::modules/migration-excluding-resources.adoc[leveloffset=+2]