Merge pull request #33018 from apinnick/bz1962111-reorganize-mtc-4

BZ1962111: Reorganize MTC 4

Author: apinnick

_topic_map.yml

@@ -1984,37 +1984,21 @@ Topics:
   File: troubleshooting-3-4
 ---
 Name: Migration Toolkit for Containers
-Dir: migration
+Dir: migration-toolkit-for-containers
 Distros: openshift-enterprise,openshift-origin
 Topics:
-- Name: Migrating from OpenShift Container Platform 4.1
-  Dir: migrating_4_1_4
-  Distros: openshift-enterprise
-  Topics:
-  - Name: About the Migration Toolkit for Containers
-    File: migrating-application-workloads-4-1-4
-  - Name: Installing and upgrading the Migration Toolkit for Containers
-    File: deploying-cam-4-1-4
-  - Name: Configuring object storage for a replication repository
-    File: configuring-replication-repository-4-1-4
-  - Name: Migrating your applications
-    File: migrating-applications-with-cam-4-1-4
-  - Name: Troubleshooting
-    File: troubleshooting-4-1-4
-- Name: Migrating from Openshift Container Platform 4.2 and later
-  Dir: migrating_4_2_4
-  Distros: openshift-enterprise
-  Topics:
-  - Name: About the Migration Toolkit for Containers
-    File: migrating-application-workloads-4-2-4
-  - Name: Installing and upgrading the Migration Toolkit for Containers
-    File: deploying-cam-4-2-4
-  - Name: Configuring object storage for a replication repository
-    File: configuring-replication-repository-4-2-4
-  - Name: Migrating your applications
-    File: migrating-applications-with-cam-4-2-4
-  - Name: Troubleshooting
-    File: troubleshooting-4-2-4
+- Name: About MTC
+  File: about-mtc
+- Name: Installing MTC
+  File: installing-mtc
+- Name: Installing MTC in a restricted network environment
+  File: installing-mtc-restricted
+- Name: Upgrading MTC
+  File: upgrading-mtc
+- Name: Migrating your applications
+  File: migrating-applications-with-mtc
+- Name: Troubleshooting
+  File: troubleshooting-mtc
 ---
 Name: API reference
 Dir: rest_api

migrating_from_ocp_3_to_4/configuring-replication-repository-3-4.adoc

@@ -17,8 +17,6 @@ By default, the {mtc-short} web console and the `Migration Controller` pod run o
 
 You can configure the `Migration Controller` custom resource manifest to run the {mtc-short} web console and the `Migration Controller` pod on a link:https://access.redhat.com/articles/5064151[source cluster or on a remote cluster].
 
-You must create an Operator catalog from a mirror image in a local registry. See xref:../operators/admin/olm-restricted-networks.adoc[Using Operator Lifecycle Manager on restricted networks] for instructions.
-
 include::modules/migration-installing-mtc-on-ocp-4.adoc[leveloffset=+1]
 include::modules/migration-installing-mtc-on-ocp-3.adoc[leveloffset=+1]
 

migrating_from_ocp_3_to_4/installing-restricted-3-4.adoc

@@ -11,7 +11,7 @@ You can upgrade the {mtc-full} ({mtc-short}) by using the {product-title} web co
 ====
 You must ensure that you upgrade to the same {mtc-short} version on all clusters.
 
-If you are upgrading {mtc-short} version 1.3, you must perform an additional procedure to update the `MigPlan` custom resource (CR).
+If you are upgrading from {mtc-short} version 1.3, you must perform an additional procedure to update the `MigPlan` custom resource (CR).
 ====
 
 include::modules/migration-upgrading-mtc-on-ocp-4.adoc[leveloffset=+1]

migrating_from_ocp_3_to_4/upgrading-3-4.adoc

@@ -0,0 +1,19 @@
+[id="about-mtc"]
+= About the {mtc-full}
+include::modules/common-attributes.adoc[]
+:context: about-mtc
+
+toc::[]
+
+The {mtc-full} ({mtc-short}) web console and API, based on Kubernetes custom resources, enable you to migrate stateful application workloads at the granularity of a namespace.
+
+The {mtc-short} console is installed on the target cluster by default. You can configure the {mtc-full} Operator to install the console on a link:https://access.redhat.com/articles/5064151[remote cluster].
+
+{mtc-short} supports the file system and snapshot data copy methods for migrating data from the source cluster to the target cluster. You can select a method that is suited for your environment and is supported by your storage provider.
+
+You can use migration hooks to run Ansible playbooks at certain points during the migration. The hooks are added when you create a migration plan.
+
+include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
+include::modules/migration-mtc-custom-resources.adoc[leveloffset=+1]
+include::modules/migration-understanding-data-copy-methods.adoc[leveloffset=+1]
+include::modules/migration-about-migration-hooks.adoc[leveloffset=+1]

migration-toolkit-for-containers/about-mtc.adoc

@@ -0,0 +1 @@
+../images

migration-toolkit-for-containers/images

@@ -0,0 +1,34 @@
+[id="installing-mtc-restricted"]
+= Installing the Migration Toolkit for Containers in a restricted network environment
+include::modules/common-attributes.adoc[]
+:context: installing-mtc-restricted
+:installing-mtc-restricted:
+
+toc::[]
+
+You can install the {mtc-full} ({mtc-short}) on {product-title} 4 in a restricted network environment.
+
+[IMPORTANT]
+====
+You must install the same {mtc-short} version on all clusters.
+====
+
+By default, the {mtc-short} web console and the `Migration Controller` pod run on the target cluster.
+
+You can configure the `Migration Controller` custom resource manifest to run the {mtc-short} web console and the `Migration Controller` pod on a link:https://access.redhat.com/articles/5064151[remote cluster].
+
+include::modules/migration-installing-mtc-on-ocp-4.adoc[leveloffset=+1]
+
+[id="configuring-replication-repository_{context}"]
+== Configuring a replication repository
+
+You must configure an object storage to use as a replication repository. The {mtc-full} ({mtc-short}) copies data from the source cluster to the replication repository, and then from the replication repository to the target cluster. Multi-Cloud Object Gateway (MCG) is the only supported option for a restricted network environment.
+
+{mtc-short} supports the xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[file system and snapshot data copy methods] for migrating data from the source cluster to the target cluster. You can select a method that is suited for your environment and is supported by your storage provider.
+
+All clusters must have uninterrupted network access to the replication repository.
+
+If you use a proxy server with an internally hosted replication repository, you must ensure that the proxy allows access to the replication repository.
+
+include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
+:installing-mtc-restricted!:

migration-toolkit-for-containers/installing-mtc-restricted.adoc

@@ -0,0 +1,44 @@
+[id="installing-mtc"]
+= Installing the Migration Toolkit for Containers
+include::modules/common-attributes.adoc[]
+:context: installing-mtc
+:installing-mtc:
+
+toc::[]
+
+You can install the {mtc-full} ({mtc-short}) on {product-title} 4.
+
+[IMPORTANT]
+====
+You must install the same {mtc-short} version on all clusters.
+====
+
+By default, the {mtc-short} web console and the `Migration Controller` pod run on the target cluster. You can configure the `Migration Controller` custom resource manifest to run the {mtc-short} web console and the `Migration Controller` pod on a link:https://access.redhat.com/articles/5064151[remote cluster].
+
+include::modules/migration-installing-mtc-on-ocp-4.adoc[leveloffset=+1]
+
+[id="configuring-replication-repository_{context}"]
+== Configuring a replication repository
+
+You must configure an object storage to use as a replication repository. The {mtc-full} ({mtc-short}) copies data from the source cluster to the replication repository, and then from the replication repository to the target cluster.
+
+{mtc-short} supports the xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[file system and snapshot data copy methods] for migrating data from the source cluster to the target cluster. You can select a method that is suited for your environment and is supported by your storage provider.
+
+All clusters must have uninterrupted network access to the replication repository.
+
+If you use a proxy server with an internally hosted replication repository, you must ensure that the proxy allows access to the replication repository.
+
+The following storage providers are supported:
+
+* Multi-Cloud Object Gateway (MCG)
+* Amazon Web Services (AWS) S3
+* Google Cloud Provider (GCP)
+* Microsoft Azure Blob
+* Generic S3 object storage, for example, Minio or Ceph S3
+
+include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
+include::modules/migration-configuring-aws-s3.adoc[leveloffset=+2]
+include::modules/migration-configuring-gcp.adoc[leveloffset=+2]
+include::modules/migration-configuring-azure.adoc[leveloffset=+2]
+
+:installing-mtc!:

migration-toolkit-for-containers/installing-mtc.adoc

@@ -1,24 +1,24 @@
-[id="migrating-applications-with-cam-4-2-4"]
+[id="migrating-applications-with-mtc_{context}"]
 = Migrating your applications
 include::modules/common-attributes.adoc[]
-:context: migrating-4-2-4
-:migrating-4-2-4:
+:context: migrating-applications-with-mtc
 
 toc::[]
 
-You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or on the command line.
+You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or from the command line.
 
 include::modules/migration-prerequisites.adoc[leveloffset=+1]
+include::modules/migration-updating-deprecated-internal-images.adoc[leveloffset=+2]
 include::modules/migration-creating-ca-bundle.adoc[leveloffset=+2]
 include::modules/migration-configuring-proxy-for-dvm.adoc[leveloffset=+2]
 include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
 
 [id="migrating-applications-additional-resources_{context}"]
 === Additional resources
 
-* xref:../../migration/migrating_4_2_4/migrating-application-workloads-4-2-4.adoc#migration-about-migration-hooks_migrating-4-2-4[About migration hooks]
-* xref:../../migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc#mighook_migrating-4-2-4[MigHook custom resource]
-* xref:../../migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc#migplan_migrating-4-2-4[MigPlan custom resource]
+* xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-about-migration-hooks_about-mtc[About migration hooks]
+* xref:../migration-toolkit-for-containers/migrating-applications-with-mtc.adoc#mighook_migrating-applications-with-mtc[MigHook custom resource]
+* xref:../migration-toolkit-for-containers/migrating-applications-with-mtc#migplan_migrating-applications-with-mtc[MigPlan custom resource]
 
 [id="migrating-applications-mtc-web-console_{context}"]
 == Migrating your applications by using the {mtc-short} web console
@@ -34,7 +34,7 @@ include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
 [id="migrating-applications-mtc-cli_{context}"]
 == Migrating your applications from the command line
 
-You can migrate your applications on the command line by using the {mtc-short} custom resources (CRs).
+You can migrate your applications on the command line by creating or editing the {mtc-short} custom resource (CR) manifests.
 
 You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
 
@@ -60,11 +60,12 @@ include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
 include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
 
 [id="migrating-applications-mtc-cli-additional-resources_{context}"]
-=== Additional resources
+== Additional resources
 
-* xref:../../migration/migrating_4_2_4/migrating-application-workloads-4-2-4.adoc#migration-about-migration-hooks_migrating-4-2-4[About migration hooks]
-* xref:../../migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc#mighook_migrating-4-2-4[MigHook custom resource]
-* xref:../../migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc#migplan_migrating-4-2-4[MigPlan custom resource]
+* xref:../registry/securing-exposing-registry.adoc#registry-exposing-secure-registry-manually_securing-exposing-registry[Exposing a secure registry manually]
+* xref:../migration-toolkit-for-containers/about-mtc.adoc#file-system-copy-method_about-mtc[{mtc-short} file system copy method]
+* xref:../migration-toolkit-for-containers/about-mtc.adoc#snapshot-copy-method_about-mtc[{mtc-short} snapshot copy method]
+* xref:../migration-toolkit-for-containers/troubleshooting-mtc.adoc#migration-viewing-migration-crs_troubleshooting-mtc[Viewing migration custom resources]
 
 [id="configuring-migration-plan_{context}"]
 == Configuring a migration plan
@@ -73,5 +74,3 @@ You can increase the number of objects to be migrated or exclude resources from
 
 include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
 include::modules/migration-excluding-resources.adoc[leveloffset=+2]
-
-:!migrating-4-2-4:

…grating-applications-with-cam-4-2-4.adoc …ers/migrating-applications-with-mtc.adocmigration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc renamed to migration-toolkit-for-containers/migrating-applications-with-mtc.adoc migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc renamed to migration-toolkit-for-containers/migrating-applications-with-mtc.adoc

@@ -0,0 +1 @@
+../modules