Skip to content

Commit d5ded08

Browse files
authored
Merge pull request #84287 from anarnold97/MIG-1622-MTC-first-attribute
MIG-1622: Add new {MTC-first} attribute
2 parents e6069b5 + 6c1540e commit d5ded08

File tree

68 files changed

+107
-106
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+107
-106
lines changed

_attributes/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ endif::[]
6060
:velero-domain: velero.io
6161
:velero-version: 1.14
6262
:launch: image:app-launcher.png[title="Application Launcher"]
63+
:mtc-first: Migration Toolkit for Containers (MTC)
6364
:mtc-short: MTC
6465
:mtc-full: Migration Toolkit for Containers
6566
:mtc-version: 1.8

migration_toolkit_for_containers/about-mtc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
The {mtc-full} ({mtc-short}) enables you to migrate stateful application workloads between {product-title} 4 clusters at the granularity of a namespace.
10+
The {mtc-first} enables you to migrate stateful application workloads between {product-title} 4 clusters at the granularity of a namespace.
1111

1212
[NOTE]
1313
====

migration_toolkit_for_containers/index.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ include::_attributes/common-attributes.adoc[]
55

66
toc::[]
77

8-
You can migrate stateful application workloads between {product-title} 4 clusters at the granularity of a namespace by using the Migration Toolkit for Containers (MTC). To learn more about MTC see xref:../migration_toolkit_for_containers/about-mtc.adoc#about-mtc[understanding MTC].
8+
You can migrate stateful application workloads between {product-title} 4 clusters at the granularity of a namespace by using {mtc-first}. To learn more about {mtc-short} see xref:../migration_toolkit_for_containers/about-mtc.adoc#about-mtc[understanding {mtc-short}].
99

1010
[NOTE]
1111
====
1212
If you are migrating from {product-title} 3, see xref:../migrating_from_ocp_3_to_4/about-migrating-from-3-to-4.adoc#about-migrating-from-3-to-4[about migrating from {product-title} 3 to 4] and xref:../migrating_from_ocp_3_to_4/installing-3-4.adoc#migration-installing-legacy-operator_installing-3-4[installing the legacy {mtc-full} Operator on {product-title} 3].
1313
====
1414

1515
[id="mtc-overview-install-mtc"]
16-
== Installing MTC
16+
== Installing {mtc-short}
1717
You must install the Migration Toolkit for Containers Operator that is compatible for your {product-title} version:
1818

1919
* {product-title} 4.6 and later versions: xref:../migration_toolkit_for_containers/installing-mtc.adoc#installing-mtc[Install the Migration Toolkit for Containers Operator by using Operator Lifecycle Manager (OLM)].
@@ -22,24 +22,24 @@ You must install the Migration Toolkit for Containers Operator that is compatibl
2222
Then you xref:../migration_toolkit_for_containers/installing-mtc.adoc#configuring-replication-repository_installing-mtc[configure object storage to use as a replication repository].
2323

2424
[id="mtc-overview-upgrade-mtc"]
25-
== Upgrading MTC
26-
You can xref:../migration_toolkit_for_containers/upgrading-mtc.adoc#upgrading-mtc[upgrade the MTC] by using OLM.
25+
== Upgrading {mtc-short}
26+
You can xref:../migration_toolkit_for_containers/upgrading-mtc.adoc#upgrading-mtc[upgrade the {mtc-short}] by using OLM.
2727

2828
[id="mtc-overview-mtc-checklists"]
29-
== Reviewing MTC checklists
30-
Before you migrate your application workloads with the Migration Toolkit for Containers (MTC), review the xref:../migration_toolkit_for_containers/premigration-checklists-mtc.adoc#premigration-checklists-mtc[premigration checklists].
29+
== Reviewing {mtc-short} checklists
30+
Before you migrate your application workloads with the {mtc-short}, review the xref:../migration_toolkit_for_containers/premigration-checklists-mtc.adoc#premigration-checklists-mtc[premigration checklists].
3131

3232
[id="mtc-overview-migrate-mtc-applications"]
3333
== Migrating applications
34-
You can migrate your applications by using the MTC xref:../migration_toolkit_for_containers/migrating-applications-with-mtc.adoc#migrating-applications-mtc-web-console_migrating-applications-with-mtc[web console] or xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migrating-applications-cli_advanced-migration-options-mtc[the command line].
34+
You can migrate your applications by using the {mtc-short} xref:../migration_toolkit_for_containers/migrating-applications-with-mtc.adoc#migrating-applications-mtc-web-console_migrating-applications-with-mtc[web console] or xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migrating-applications-cli_advanced-migration-options-mtc[the command line].
3535

3636
[id="mtc-overview-advanced-migration-options"]
3737
== Advanced migration options
3838
You can automate your migrations and modify the `MigPlan` and `MigrationController` custom resources in order to perform large-scale migrations and to improve performance. You can check the following items:
3939

4040
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-creating-registry-route-for-dim_advanced-migration-options-mtc[Create a registry route for direct image migration]
4141
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-configuring-proxies_advanced-migration-options-mtc[Configuring proxies]
42-
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-migrating-applications-api_advanced-migration-options-mtc[Migrating an application by using the MTC API]
42+
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-migrating-applications-api_advanced-migration-options-mtc[Migrating an application by using the {mtc-short} API]
4343
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-state-migration-cli_advanced-migration-options-mtc[Running a state migration]
4444
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-hooks_advanced-migration-options-mtc[Creating migration hooks]
4545
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-plan-options_advanced-migration-options-mtc[Editing, excluding, and mapping migrated resources]
@@ -56,13 +56,13 @@ You can perform the following troubleshooting tasks:
5656
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-must-gather_troubleshooting-mtc[Using the `must-gather` tool]
5757
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-debugging-velero-resources_troubleshooting-mtc[Using the Velero CLI to debug Backup and Restore CRs]
5858
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-partial-failure-velero_troubleshooting-mtc[Debugging a partial migration failure]
59-
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-mtc-crs-for-troubleshooting_troubleshooting-mtc[Using MTC custom resources for troubleshooting]
59+
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-mtc-crs-for-troubleshooting_troubleshooting-mtc[Using {mtc-short} custom resources for troubleshooting]
6060
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#common-issues-and-concerns_troubleshooting-mtc[Checking common issues and concerns]
6161

6262
[id="mtc-overview-roll-back-mtc"]
6363
== Rolling back a migration
64-
You can xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#rolling-back-migration_troubleshooting-mtc[roll back a migration] by using the MTC web console, the CLI or manually.
64+
You can xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#rolling-back-migration_troubleshooting-mtc[roll back a migration] by using the {mtc-short} web console, the CLI or manually.
6565

6666
[id="mtc-overview-uninstall-mtc"]
67-
== Uninstalling MTC and deleting resources
68-
You can xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-uninstalling-mtc-clean-up_installing-mtc[uninstall the MTC and delete its resources] to clean up the cluster.
67+
== Uninstalling {mtc-short} and deleting resources
68+
You can xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-uninstalling-mtc-clean-up_installing-mtc[uninstall the {mtc-short} and delete its resources] to clean up the cluster.

migration_toolkit_for_containers/installing-mtc-restricted.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
You can install the {mtc-full} ({mtc-short}) on {product-title} 4 in a restricted network environment by performing the following procedures:
10+
You can install the {mtc-first} on {product-title} 4 in a restricted network environment by performing the following procedures:
1111

1212
. Create a xref:../disconnected/using-olm.adoc#olm-mirror-catalog_olm-restricted-networks[mirrored Operator catalog].
1313
+
@@ -47,7 +47,7 @@ This section applies only when you are working with the OpenShift API, not the w
4747

4848
OpenShift environments have the `PodSecurityAdmission` controller enabled by default. This controller requires cluster administrators to enforce Pod Security Standards by means of namespace labels. All workloads in the cluster are expected to run one of the following Pod Security Standard levels: `Privileged`, `Baseline` or `Restricted`. Every cluster has its own default policy set.
4949

50-
To guarantee successful data transfer in all environments, {mtc-full} ({mtc-short}) 1.7.5 introduced changes in Rsync pods, including running Rsync pods as non-root user by default. This ensures that data transfer is possible even for workloads that do not necessarily require higher privileges. This change was made because it is best to run workloads with the lowest level of privileges possible.
50+
To guarantee successful data transfer in all environments, {mtc-short} 1.7.5 introduced changes in Rsync pods, including running Rsync pods as non-root user by default. This ensures that data transfer is possible even for workloads that do not necessarily require higher privileges. This change was made because it is best to run workloads with the lowest level of privileges possible.
5151

5252
[discrete]
5353
[id="migration-rsync-override-data-transfer_{context}"]

migration_toolkit_for_containers/installing-mtc.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
You can install the {mtc-full} ({mtc-short}) on {product-title} 4.
10+
You can install the {mtc-first} on {product-title} 4.
1111

1212
[NOTE]
1313
====
@@ -41,7 +41,7 @@ This section applies only when you are working with the OpenShift API, not the w
4141

4242
OpenShift environments have the `PodSecurityAdmission` controller enabled by default. This controller requires cluster administrators to enforce Pod Security Standards by means of namespace labels. All workloads in the cluster are expected to run one of the following Pod Security Standard levels: `Privileged`, `Baseline` or `Restricted`. Every cluster has its own default policy set.
4343

44-
To guarantee successful data transfer in all environments, {mtc-full} ({mtc-short}) 1.7.5 introduced changes in Rsync pods, including running Rsync pods as non-root user by default. This ensures that data transfer is possible even for workloads that do not necessarily require higher privileges. This change was made because it is best to run workloads with the lowest level of privileges possible.
44+
To guarantee successful data transfer in all environments, {mtc-short} 1.7.5 introduced changes in Rsync pods, including running Rsync pods as non-root user by default. This ensures that data transfer is possible even for workloads that do not necessarily require higher privileges. This change was made because it is best to run workloads with the lowest level of privileges possible.
4545

4646
==== Manually overriding default non-root operation for data trannsfer
4747

@@ -62,7 +62,7 @@ include::modules/migration-rsync-mig-migration-root-non-root.adoc[leveloffset=+2
6262
[id="configuring-replication-repository_{context}"]
6363
== Configuring a replication repository
6464
65-
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.
65+
You must configure an object storage to use as a replication repository. The {mtc-first} copies data from the source cluster to the replication repository, and then from the replication repository to the target cluster.
6666
6767
{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. Select a method that is suited for your environment and is supported by your storage provider.
6868

migration_toolkit_for_containers/migrating-applications-with-mtc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can migrate your applications by using the {mtc-full} ({mtc-short}) web console or the xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migrating-applications-cli_advanced-migration-options-mtc[command line].
9+
You can migrate your applications by using the {mtc-first} web console or the xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migrating-applications-cli_advanced-migration-options-mtc[command line].
1010

1111
Most cluster-scoped resources are not yet handled by {mtc-short}. If your applications require cluster-scoped resources, you might have to create them manually on the target cluster.
1212

@@ -20,7 +20,7 @@ You can use state migration to migrate an application's state:
2020
* State migration copies selected persistent volume claims (PVCs).
2121
* You can use state migration to migrate a namespace within the same cluster.
2222
23-
During migration, the {mtc-full} ({mtc-short}) preserves the following namespace annotations:
23+
During migration, the {mtc-short} preserves the following namespace annotations:
2424

2525
* `openshift.io/sa.scc.mcs`
2626
* `openshift.io/sa.scc.supplemental-groups`

migration_toolkit_for_containers/mtc-direct-migration-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
88

99
toc::[]
1010

11-
Direct Migration is available with {mtc-full} ({mtc-short}) 1.4.0 or later.
11+
Direct Migration is available with {mtc-first} 1.4.0 or later.
1212

1313
There are two parts of the Direct Migration:
1414

migration_toolkit_for_containers/premigration-checklists-mtc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Before you migrate your application workloads with the {mtc-full} ({mtc-short}), review the following checklists.
9+
Before you migrate your application workloads with the {mtc-first}, review the following checklists.
1010

1111
[id="cluster-health-checklist_{context}"]
1212
== Cluster health checklist

migration_toolkit_for_containers/release_notes/mtc-release-notes-1-5.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
The release notes for {mtc-full} ({mtc-short}) describe new features and enhancements, deprecated features, and known issues.
10+
The release notes for {mtc-first} describe new features and enhancements, deprecated features, and known issues.
1111

1212
The {mtc-short} enables you to migrate application workloads between {product-title} clusters at the granularity of a namespace.
1313

migration_toolkit_for_containers/release_notes/mtc-release-notes-1-6.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
The release notes for {mtc-full} ({mtc-short}) describe new features and enhancements, deprecated features, and known issues.
10+
The release notes for {mtc-first} describe new features and enhancements, deprecated features, and known issues.
1111

1212
The {mtc-short} enables you to migrate application workloads between {product-title} clusters at the granularity of a namespace.
1313

0 commit comments

Comments
 (0)