Skip to content

Commit 42e4b1c

Browse files
apinnickapinnick
authored
Merge pull request #36044 from apinnick/definition-table
Reorganizing "Advanced migration options" assembly
2 parents 1bca628 + 1a7e273 commit 42e4b1c

12 files changed

+153
-182
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@ The {mtc-short} console is installed on the target cluster by default. You can c
2020

2121
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.
2222

23+
include::modules/migration-terminology.adoc[leveloffset=+1]
2324
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
2425
include::modules/migration-understanding-data-copy-methods.adoc[leveloffset=+1]

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

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,32 @@ toc::[]
88

99
This section describes advanced options for automating your migration and for modifying the migration plan.
1010

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]
11+
include::modules/migration-terminology.adoc[leveloffset=+1]
12+
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
13+
include::modules/migration-about-mtc-custom-resources.adoc[leveloffset=+1]
14+
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+1]
2415

2516
[id="migrating-your-applications-api_{context}"]
2617
== Migrating your applications with the {mtc-short} API
2718

2819
This section describes how to migrate your applications with the {mtc-short} API from the command line interface (CLI).
2920

30-
include::modules/migration-about-migrating-applications-api.adoc[leveloffset=+2]
3121
include::modules/migration-prerequisites.adoc[leveloffset=+2]
22+
include::modules/migration-creating-registry-route-for-dim.adoc[leveloffset=+2]
3223
include::modules/migration-configuring-proxies.adoc[leveloffset=+2]
3324
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
3425

35-
[id="migration-hooks_{context}"]
36-
== Migration hooks
26+
include::modules/migration-hooks.adoc[leveloffset=+1]
27+
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
3728

38-
You can use migration hooks to run custom code at certain points during a migration.
29+
[id="configuration-options_{context}"]
30+
== Configuration options
3931

40-
include::modules/migration-about-migration-hooks.adoc[leveloffset=+2]
41-
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
32+
You can configure the following options for the `MigPlan` and `MigrationController` CRs.
4233

43-
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+1]
44-
include::modules/migration-excluding-resources.adoc[leveloffset=+1]
45-
include::modules/migration-enabling-pv-resizing-dvm.adoc[leveloffset=+1]
46-
include::modules/migration-enabling-cached-kubernetes-clients.adoc[leveloffset=+1]
34+
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
35+
include::modules/migration-excluding-resources.adoc[leveloffset=+2]
36+
include::modules/migration-enabling-pv-resizing-dvm.adoc[leveloffset=+2]
37+
include::modules/migration-enabling-cached-kubernetes-clients.adoc[leveloffset=+2]
4738

4839
:advanced-migration-options-3-4!:

‎migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::modules/migration-using-mtc-crs-for-troubleshooting.adoc[leveloffset=+2
2828
=== Additional resources for debugging tools
2929

3030
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
31-
* 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]
31+
* xref:../migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc#migration-about-mtc-custom-resources_advanced-migration-options-3-4[{mtc-short} custom resources]
3232

3333
[id="common-issues-and-concerns_{context}"]
3434
== Common issues and concerns

‎migration_toolkit_for_containers/about-mtc.adoc

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,11 @@ The {mtc-full} ({mtc-short}) enables you to migrate stateful application workloa
1111

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

14-
[id="additional-resources-_{context}"]
15-
[discrete]
16-
== Additional resources
14+
See xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#advanced-migration-options-mtc[Advanced migration options] for information about the following topics:
1715

18-
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#advanced-migration-options-mtc[Advanced migration options]
19-
+
20-
Automate your migration with migration hooks and the {mtc-short} API.
21-
+
22-
Configure your migration plan to exclude resources, support large-scale migrations, and enable automatic PV resizing for direct volume migration.
23-
24-
[id="additional-resources_{context}"]
25-
[discrete]
26-
== Additional resources
27-
28-
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#advanced-migration-options-mtc[Advanced migration options] for automating migration
16+
* Automating your migration with migration hooks and the {mtc-short} API.
17+
* Configuring your migration plan to exclude resources, support large-scale migrations, and enable automatic PV resizing for direct volume migration.
2918

19+
include::modules/migration-terminology.adoc[leveloffset=+1]
3020
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
3121
include::modules/migration-understanding-data-copy-methods.adoc[leveloffset=+1]

‎migration_toolkit_for_containers/advanced-migration-options-mtc.adoc

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,31 @@ toc::[]
77

88
This section describes advanced options for automating your migration and for modifying the migration plan.
99

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]
10+
include::modules/migration-terminology.adoc[leveloffset=+1]
11+
include::modules/migration-mtc-workflow.adoc[leveloffset=+1]
12+
include::modules/migration-about-mtc-custom-resources.adoc[leveloffset=+1]
13+
include::modules/migration-mtc-cr-manifests.adoc[leveloffset=+1]
2314

2415
[id="migrating-your-applications-api_{context}"]
2516
== Migrating your applications with the {mtc-short} API
2617

2718
This section describes how to migrate your applications with the {mtc-short} API from the command line interface (CLI).
2819

29-
include::modules/migration-about-migrating-applications-api.adoc[leveloffset=+2]
3020
include::modules/migration-prerequisites.adoc[leveloffset=+2]
21+
include::modules/migration-creating-registry-route-for-dim.adoc[leveloffset=+2]
3122
include::modules/migration-configuring-proxies.adoc[leveloffset=+2]
23+
include::modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc[leveloffset=+2]
3224
include::modules/migration-migrating-applications-api.adoc[leveloffset=+2]
3325

34-
[id="migration-hooks_{context}"]
35-
== Migration hooks
26+
include::modules/migration-hooks.adoc[leveloffset=+1]
27+
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
3628

37-
You can use migration hooks to run custom code at certain points during a migration.
29+
[id="configuration-options_{context}"]
30+
== Configuration options
3831

39-
include::modules/migration-about-migration-hooks.adoc[leveloffset=+2]
40-
include::modules/migration-writing-ansible-playbook-hook.adoc[leveloffset=+2]
32+
You can configure the following options for the `MigPlan` and `MigrationController` CRs.
4133

42-
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+1]
43-
include::modules/migration-excluding-resources.adoc[leveloffset=+1]
44-
include::modules/migration-enabling-pv-resizing-dvm.adoc[leveloffset=+1]
45-
include::modules/migration-enabling-cached-kubernetes-clients.adoc[leveloffset=+1]
34+
include::modules/migration-changing-migration-plan-limits.adoc[leveloffset=+2]
35+
include::modules/migration-excluding-resources.adoc[leveloffset=+2]
36+
include::modules/migration-enabling-pv-resizing-dvm.adoc[leveloffset=+2]
37+
include::modules/migration-enabling-cached-kubernetes-clients.adoc[leveloffset=+2]

‎migration_toolkit_for_containers/troubleshooting-mtc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::modules/migration-using-mtc-crs-for-troubleshooting.adoc[leveloffset=+2
2828
=== Additional resources for debugging tools
2929

3030
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
31-
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#mtc-custom-resources_advanced-migration-options-mtc[{mtc-short} custom resources]
31+
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-about-mtc-custom-resources_advanced-migration-options-mtc[{mtc-short} custom resources]
3232

3333
[id="common-issues-and-concerns_{context}"]
3434
== Common issues and concerns

‎modules/migration-about-migrating-applications-api.adoc

Lines changed: 0 additions & 117 deletions
This file was deleted.

‎modules/migration-creating-registry-route-for-dim.adoc

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc
4+
// * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc
5+
6+
[id="migration-creating-registry-route-for-dim_{context}"]
7+
= Creating a registry route for direct image migration
8+
9+
For direct image migration, you must create a route to the exposed internal registry on all remote clusters.
10+
11+
.Prerequisites
12+
13+
* The internal registry must be exposed to external traffic on all remote clusters.
14+
+
15+
The {product-title} 4 registry is exposed by default.
16+
ifdef::advanced-migration-options-3-4[]
17+
+
18+
The {product-title} 3 registry must be link:https://docs.openshift.com/container-platform/3.11/install_config/registry/securing_and_exposing_registry.html#exposing-the-registry[exposed manually].
19+
endif::[]
20+
21+
.Procedure
22+
23+
ifdef::advanced-migration-options-3-4[]
24+
* To create a route to an {product-title} 3 registry, run the following command:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc create route passthrough --service=docker-registry --port=5000 -n default
29+
----
30+
endif::[]
31+
32+
* To create a route to an {product-title} 4 registry, run the following command:
33+
+
34+
[source,terminal]
35+
----
36+
$ oc create route passthrough --service=image-registry --port=5000 -n openshift-image-registry
37+
----

‎modules/migration-about-migration-hooks.adoc renamed to ‎modules/migration-hooks.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
// * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc
44
// * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc
55

6-
[id="migration-about-migration-hooks_{context}"]
7-
= About migration hooks
6+
[id="migration-hooks_{context}"]
7+
= Migration hooks
88

99
You can add up to four migration hooks to a single migration plan, with each hook running at a different phase of the migration. Migration hooks perform tasks such as customizing application quiescence, manually migrating unsupported data types, and updating applications after migration.
1010

‎modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc
4+
5+
[id="migration-mapping-destination-namespaces-in-the-migplan-cr_{context}"]
6+
= Mapping destination namespaces in the MigPlan custom resource
7+
8+
If you map destination namespaces in the `MigPlan` custom resource (CR), you must ensure that the namespaces are not duplicated on the source or the destination clusters because the UID and GID ranges of the namespaces are copied during migration.
9+
10+
.Two source namespaces mapped to the same destination namespace
11+
[source,yaml]
12+
----
13+
spec:
14+
namespaces:
15+
- namespace_2
16+
- namespace_1:namespace_2
17+
----
18+
19+
If you want the source namespace to be mapped to a namespace of the same name, you do not need to create a mapping. By default, a source namespace and a target namespace have the same name.
20+
21+
.Incorrect namespace mapping
22+
[source,yaml]
23+
----
24+
spec:
25+
namespaces:
26+
- namespace_1:namespace_1
27+
----
28+
29+
.Correct namespace reference
30+
[source,yaml]
31+
----
32+
spec:
33+
namespaces:
34+
- namespace_1
35+
----

0 commit comments

Comments
 (0)