Skip to content

Commit f49b121

Browse files
apinnickapinnick
authored
Merge pull request #33673 from apinnick/mig743-migration-automation
MIG-743: Advanced migration options
2 parents cd900e6 + cefe79c commit f49b121

24 files changed

+403
-439
lines changed

‎_topic_map.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2014,6 +2014,8 @@ Topics:
20142014
File: premigration-checklists
20152015
- Name: Migrating your applications
20162016
File: migrating-applications-3-4
2017+
- Name: Advanced migration options
2018+
File: advanced-migration-options-3-4
20172019
- Name: Troubleshooting
20182020
File: troubleshooting-3-4
20192021
---
@@ -2033,6 +2035,8 @@ Topics:
20332035
File: premigration-checklists
20342036
- Name: Migrating your applications
20352037
File: migrating-applications-with-mtc
2038+
- Name: Advanced migration options
2039+
File: advanced-migration-options-mtc
20362040
- Name: Troubleshooting
20372041
File: troubleshooting-mtc
20382042
---

‎migrating_from_ocp_3_to_4/about-mtc-3-4.adoc‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,7 @@ The {mtc-short} console is installed on the target cluster by default. You can c
1818

1919
{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.
2020

21-
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.
22-
2321
The service catalog is deprecated in {product-title} 4. You can migrate workload resources provisioned with the service catalog from {product-title} 3 to 4 but you cannot perform service catalog actions such as `provision`, `deprovision`, or `update` on these workloads after migration. The {mtc-short} console displays a message if the service catalog resources cannot be migrated.
2422

2523
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
26-
include::modules/migration-mtc-custom-resources.adoc[leveloffset=+1]
2724
include::modules/migration-understanding-data-copy-methods.adoc[leveloffset=+1]
28-
include::modules/migration-about-migration-hooks.adoc[leveloffset=+1]

‎migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
[id="advanced-migration-options-3-4_{context}"]
2+
= Advanced migration options
3+
include::modules/common-attributes.adoc[]
4+
:context: advanced-migration-options-3-4
5+
:advanced-migration-options-3-4:
6+
7+
toc::[]
8+
9+
This section describes advanced options for automating your migration and for modifying the migration plan.
10+
11+
[discrete]
12+
[id="additional-resources_{context}"]
13+
=== Additional resources
14+
15+
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
16+
17+
[id="mtc-custom-resources_{context}"]
18+
== {mtc-short} custom resources
19+
20+
This section describes the custom resources (CRs) that are used by the {mtc-full} ({mtc-short}).
21+
22+
include::modules/migration-about-mtc-custom-resources.adoc[leveloffset=+2]
23+
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
24+
25+
[id="migrating-your-applications-api_{context}"]
26+
== Migrating your applications with the {mtc-short} API
27+
28+
This section describes how to migrate your applications with the {mtc-short} API from the command line interface (CLI).
29+
30+
include::modules/migration-about-migrating-applications-api.adoc[leveloffset=+2]
31+
include::modules/migration-prerequisites.adoc[leveloffset=+2]
32+
include::modules/migration-configuring-proxy-for-dvm.adoc[leveloffset=+3]
33+
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
34+
35+
[id="migration-hooks_{context}"]
36+
== Migration hooks
37+
38+
You can use migration hooks to run custom code at certain points during a migration.
39+
40+
include::modules/migration-about-migration-hooks.adoc[leveloffset=+2]
41+
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
42+
43+
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+1]
44+
include::modules/migration-excluding-resources.adoc[leveloffset=+1]
45+
46+
:advanced-migration-options-3-4!:

‎migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,6 @@ include::modules/migration-prerequisites.adoc[leveloffset=+1]
1818
* xref:../migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc#migration-updating-deprecated-internal-images_troubleshooting-3-4[Updating deprecated internal images]
1919

2020
include::modules/migration-configuring-proxy-for-dvm.adoc[leveloffset=+2]
21-
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
22-
23-
[discrete]
24-
[id="additional-resources-for-migration-hooks_{context}"]
25-
=== Additional resources for migration hooks
26-
27-
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-about-migration-hooks_about-mtc-3-4[About migration hooks]
28-
* xref:../migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc#mighook_migrating-applications-3-4[MigHook custom resource]
29-
* xref:../migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc#migplan_migrating-applications-3-4[MigPlan custom resource]
3021

3122
[id="migrating-applications-mtc-web-console_{context}"]
3223
== Migrating your applications by using the {mtc-short} web console
@@ -47,47 +38,4 @@ include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2]
4738

4839
include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
4940

50-
[id="migrating-applications-mtc-cli_{context}"]
51-
== Migrating your applications from the command line
52-
53-
You can migrate your applications on the command line by creating or editing the {mtc-short} custom resource (CR) manifests.
54-
55-
You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
56-
57-
[discrete]
58-
[id="cluster-terminology_{context}"]
59-
=== Cluster terminology
60-
61-
The following terms are relevant for configuring clusters:
62-
63-
* `host` cluster:
64-
** The `migration-controller` pod runs on the `host` cluster.
65-
** A `host` cluster does not require an exposed secure registry route for direct image migration.
66-
* Local cluster: The local cluster is often the same as the `host` cluster but this is not a requirement.
67-
* Remote cluster:
68-
** A remote cluster must have an exposed secure registry route for direct image migration.
69-
** A remote cluster must have a `Secret` CR containing the `migration-controller` service account token.
70-
71-
The following terms are relevant for performing a migration:
72-
73-
* Source cluster: Cluster from which the applications are migrated.
74-
* Destination cluster: Cluster to which the applications are migrated.
75-
76-
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
77-
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
78-
79-
[discrete]
80-
[id="additional-resources-for-custom-resources_{context}"]
81-
=== Additional resources for custom resources
82-
83-
* xref:../migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc#migration-viewing-migration-crs_troubleshooting-3-4[Viewing migration custom resources]
84-
85-
[id="configuring-migration-plan_{context}"]
86-
== Configuring a migration plan
87-
88-
You can increase the number of objects to be migrated or exclude resources from the migration.
89-
90-
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
91-
include::modules/migration-excluding-resources.adoc[leveloffset=+2]
92-
9341
:migrating-applications-3-4!:

‎migrating_from_ocp_3_to_4/premigration-checklists.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ Even if the pods are in a *Running* state, a high restart count might indicate u
4848
$ oc adm prune images
4949
----
5050

51-
* [ ] The internal container image registry uses a link:https://docs.openshift.com/container-platform/3.11/scaling_performance/optimizing_storage.html#registry[supported storage type].
51+
* [ ] The internal registry uses a link:https://docs.openshift.com/container-platform/3.11/scaling_performance/optimizing_storage.html#registry[supported storage type].
52+
* [ ] Direct image migration only: The internal registry is link:https://docs.openshift.com/container-platform/3.11/install_config/registry/securing_and_exposing_registry.html#exposing-the-registry[exposed] to external traffic.
5253
* [ ] You can read and write images to the registry.
5354
* [ ] The link:https://access.redhat.com/articles/3093761[etcd cluster] is healthy.
5455
* [ ] The link:https://docs.openshift.com/container-platform/3.11/install_config/master_node_configuration.html#master-node-configuration-node-qps-burst[average API server response time] on the source cluster is less than 50 ms.

‎migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ include::modules/migration-using-mig-log-reader.adoc[leveloffset=+2]
1818
include::modules/migration-using-must-gather.adoc[leveloffset=+2]
1919
include::modules/migration-debugging-velero-resources.adoc[leveloffset=+2]
2020
include::modules/migration-partial-failure-velero.adoc[leveloffset=+2]
21-
include::modules/migration-viewing-migration-crs.adoc[leveloffset=+2]
21+
include::modules/migration-using-mtc-crs-for-troubleshooting.adoc[leveloffset=+2]
2222

2323
[discrete]
2424
[id="additional-resources-for-debugging-tools_{context}"]
2525
=== Additional resources for debugging tools
2626

2727
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
28-
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-custom-resources_about-mtc-3-4[{mtc-short} custom resources]
28+
* xref:../migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc#mtc-custom-resources_advanced-migration-options-3-4[{mtc-short} custom resources]
2929

3030
[id="common-issues-and-concerns_{context}"]
3131
== Common issues and concerns

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,5 @@ The {mtc-short} console is installed on the target cluster by default. You can c
1111

1212
{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.
1313

14-
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.
15-
1614
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
17-
include::modules/migration-mtc-custom-resources.adoc[leveloffset=+1]
1815
include::modules/migration-understanding-data-copy-methods.adoc[leveloffset=+1]
19-
include::modules/migration-about-migration-hooks.adoc[leveloffset=+1]

‎migration-toolkit-for-containers/advanced-migration-options-mtc.adoc‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
[id="advanced-migration-options-mtc_{context}"]
2+
= Advanced migration options
3+
include::modules/common-attributes.adoc[]
4+
:context: advanced-migration-options-mtc
5+
6+
toc::[]
7+
8+
This section describes advanced options for automating your migration and for modifying the migration plan.
9+
10+
[discrete]
11+
[id="additional-resources_{context}"]
12+
=== Additional resources
13+
14+
* xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
15+
16+
[id="mtc-custom-resources_{context}"]
17+
== {mtc-short} custom resources
18+
19+
This section describes the custom resources (CRs) that are used by the {mtc-full} ({mtc-short}).
20+
21+
include::modules/migration-about-mtc-custom-resources.adoc[leveloffset=+2]
22+
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
23+
24+
[id="migrating-your-applications-api_{context}"]
25+
== Migrating your applications with the {mtc-short} API
26+
27+
This section describes how to migrate your applications with the {mtc-short} API from the command line interface (CLI).
28+
29+
include::modules/migration-about-migrating-applications-api.adoc[leveloffset=+2]
30+
include::modules/migration-prerequisites.adoc[leveloffset=+2]
31+
include::modules/migration-configuring-proxy-for-dvm.adoc[leveloffset=+3]
32+
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
33+
34+
[id="migration-hooks_{context}"]
35+
== Migration hooks
36+
37+
You can use migration hooks to run custom code at certain points during a migration.
38+
39+
include::modules/migration-about-migration-hooks.adoc[leveloffset=+2]
40+
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
41+
42+
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+1]
43+
include::modules/migration-excluding-resources.adoc[leveloffset=+1]

‎migration-toolkit-for-containers/migrating-applications-with-mtc.adoc‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,6 @@ You can migrate your applications by using the {mtc-full} ({mtc-short}) web cons
99

1010
include::modules/migration-prerequisites.adoc[leveloffset=+1]
1111
include::modules/migration-configuring-proxy-for-dvm.adoc[leveloffset=+2]
12-
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
13-
14-
[discrete]
15-
[id="additional-resources-for-migration-hooks_{context}"]
16-
=== Additional resources for migration hooks
17-
18-
* xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-about-migration-hooks_about-mtc[About migration hooks]
19-
* xref:../migration-toolkit-for-containers/migrating-applications-with-mtc.adoc#mighook_migrating-applications-with-mtc[MigHook custom resource]
20-
* xref:../migration-toolkit-for-containers/migrating-applications-with-mtc#migplan_migrating-applications-with-mtc[MigPlan custom resource]
2112

2213
[id="migrating-applications-mtc-web-console_{context}"]
2314
== Migrating your applications by using the {mtc-short} web console
@@ -37,46 +28,3 @@ include::modules/migration-creating-migration-plan-cam.adoc[leveloffset=+2]
3728
* xref:../migration-toolkit-for-containers/about-mtc.adoc#snapshot-copy-method_about-mtc[{mtc-short} snapshot copy method]
3829

3930
include::modules/migration-running-migration-plan-cam.adoc[leveloffset=+2]
40-
41-
[id="migrating-applications-mtc-cli_{context}"]
42-
== Migrating your applications from the command line
43-
44-
You can migrate your applications on the command line by creating or editing the {mtc-short} custom resource (CR) manifests.
45-
46-
You can migrate applications from a local cluster to a remote cluster, from a remote cluster to a local cluster, and between remote clusters.
47-
48-
[discrete]
49-
[id="cluster-terminology_{context}"]
50-
=== Cluster terminology
51-
52-
The following terms are relevant for configuring clusters:
53-
54-
* `host` cluster:
55-
** The `migration-controller` pod runs on the `host` cluster.
56-
** A `host` cluster does not require an exposed secure registry route for direct image migration.
57-
* Local cluster: The local cluster is often the same as the `host` cluster but this is not a requirement.
58-
* Remote cluster:
59-
** A remote cluster must have an exposed secure registry route for direct image migration.
60-
** A remote cluster must have a `Secret` CR containing the `migration-controller` service account token.
61-
62-
The following terms are relevant for performing a migration:
63-
64-
* Source cluster: Cluster from which the applications are migrated.
65-
* Destination cluster: Cluster to which the applications are migrated.
66-
67-
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
68-
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+2]
69-
70-
[discrete]
71-
[id="additional-resources-for-custom-resources_{context}"]
72-
=== Additional resources for custom resources
73-
74-
* xref:../migration-toolkit-for-containers/troubleshooting-mtc.adoc#migration-viewing-migration-crs_troubleshooting-mtc[Viewing migration custom resources]
75-
76-
[id="configuring-migration-plan_{context}"]
77-
== Configuring a migration plan
78-
79-
You can increase the number of objects to be migrated or exclude resources from the migration.
80-
81-
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
82-
include::modules/migration-excluding-resources.adoc[leveloffset=+2]

‎migration-toolkit-for-containers/troubleshooting-mtc.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ include::modules/migration-using-mig-log-reader.adoc[leveloffset=+2]
1818
include::modules/migration-using-must-gather.adoc[leveloffset=+2]
1919
include::modules/migration-debugging-velero-resources.adoc[leveloffset=+2]
2020
include::modules/migration-partial-failure-velero.adoc[leveloffset=+2]
21-
include::modules/migration-viewing-migration-crs.adoc[leveloffset=+2]
21+
include::modules/migration-using-mtc-crs-for-troubleshooting.adoc[leveloffset=+2]
2222

2323
[discrete]
2424
[id="additional-resources-for-debugging-tools_{context}"]
2525
=== Additional resources for debugging tools
2626

2727
* xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
28-
* xref:../migration-toolkit-for-containers/about-mtc.adoc#migration-mtc-custom-resources_about-mtc[{mtc-short} custom resources]
28+
* xref:../migration-toolkit-for-containers/advanced-migration-options-mtc.adoc#mtc-custom-resources_advanced-migration-options-mtc[{mtc-short} custom resources]
2929

3030
[id="common-issues-and-concerns_{context}"]
3131
== Common issues and concerns

0 commit comments

Comments
 (0)