Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ endif::[]
:velero-domain: velero.io
:velero-version: 1.14
:launch: image:app-launcher.png[title="Application Launcher"]
:mtc-first: Migration Toolkit for Containers (MTC)
:mtc-short: MTC
:mtc-full: Migration Toolkit for Containers
:mtc-version: 1.8
Expand Down
2 changes: 1 addition & 1 deletion migration_toolkit_for_containers/about-mtc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

[NOTE]
====
Expand Down
24 changes: 12 additions & 12 deletions migration_toolkit_for_containers/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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].
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}].

[NOTE]
====
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].
====

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

* {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)].
Expand All @@ -23,24 +23,24 @@ You must install the Migration Toolkit for Containers Operator that is compatibl
Then you xref:../migration_toolkit_for_containers/installing-mtc.adoc#configuring-replication-repository_installing-mtc[configure object storage to use as a replication repository].

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

[id="mtc-overview-mtc-checklists"]
== Reviewing MTC checklists
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].
== Reviewing {mtc-short} checklists
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].

[id="mtc-overview-migrate-mtc-applications"]
== Migrating applications
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].
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].

[id="mtc-overview-advanced-migration-options"]
== Advanced migration options
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:

* 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]
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-configuring-proxies_advanced-migration-options-mtc[Configuring proxies]
* 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]
* 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]
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-state-migration-cli_advanced-migration-options-mtc[Running a state migration]
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-hooks_advanced-migration-options-mtc[Creating migration hooks]
* xref:../migration_toolkit_for_containers/advanced-migration-options-mtc.adoc#migration-plan-options_advanced-migration-options-mtc[Editing, excluding, and mapping migrated resources]
Expand All @@ -57,13 +57,13 @@ You can perform the following troubleshooting tasks:
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-must-gather_troubleshooting-mtc[Using the `must-gather` tool]
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-debugging-velero-resources_troubleshooting-mtc[Using the Velero CLI to debug Backup and Restore CRs]
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-partial-failure-velero_troubleshooting-mtc[Debugging a partial migration failure]
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-mtc-crs-for-troubleshooting_troubleshooting-mtc[Using MTC custom resources for troubleshooting]
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#migration-using-mtc-crs-for-troubleshooting_troubleshooting-mtc[Using {mtc-short} custom resources for troubleshooting]
* xref:../migration_toolkit_for_containers/troubleshooting-mtc.adoc#common-issues-and-concerns_troubleshooting-mtc[Checking common issues and concerns]

[id="mtc-overview-roll-back-mtc"]
== Rolling back a migration
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.
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.

[id="mtc-overview-uninstall-mtc"]
== Uninstalling MTC and deleting resources
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.
== Uninstalling {mtc-short} and deleting resources
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.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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

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

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.

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

[discrete]
[id="migration-rsync-override-data-transfer_{context}"]
Expand Down
6 changes: 3 additions & 3 deletions migration_toolkit_for_containers/installing-mtc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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

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

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.

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

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

Expand All @@ -62,7 +62,7 @@ include::modules/migration-rsync-mig-migration-root-non-root.adoc[leveloffset=+2
[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.
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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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

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.

Expand All @@ -20,7 +20,7 @@ You can use state migration to migrate an application's state:
* State migration copies selected persistent volume claims (PVCs).
* You can use state migration to migrate a namespace within the same cluster.

During migration, the {mtc-full} ({mtc-short}) preserves the following namespace annotations:
During migration, the {mtc-short} preserves the following namespace annotations:

* `openshift.io/sa.scc.mcs`
* `openshift.io/sa.scc.supplemental-groups`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

There are two parts of the Direct Migration:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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

[id="cluster-health-checklist_{context}"]
== Cluster health checklist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

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

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

Expand Down
2 changes: 1 addition & 1 deletion migration_toolkit_for_containers/troubleshooting-mtc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

This section describes resources for troubleshooting the {mtc-full} ({mtc-short}).
This section describes resources for troubleshooting the {mtc-first}.

For known issues, see the xref:../migration_toolkit_for_containers/release_notes/mtc-release-notes.adoc#mtc-release-notes[{mtc-short} release notes].

Expand Down
2 changes: 1 addition & 1 deletion migration_toolkit_for_containers/upgrading-mtc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

You can upgrade the {mtc-full} ({mtc-short}) on {product-title} {product-version} by using Operator Lifecycle Manager.
You can upgrade the {mtc-first} on {product-title} {product-version} by using Operator Lifecycle Manager.

You can upgrade {mtc-short} on {product-title} 4.5, and earlier versions, by reinstalling the legacy {mtc-full} Operator.

Expand Down
2 changes: 1 addition & 1 deletion modules/configuring-retries-for-rsync.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="configuring-retries-for-rsync_{context}"]
= Rsync retry configuration

With MTC 1.4.3 and later, a new ability of retrying a failed Rsync operation is introduced.
With {mtc-first} 1.4.3 and later, a new ability of retrying a failed Rsync operation is introduced.

By default, the migration controller retries Rsync until all of the data is successfully transferred from the source to the target volume or a specified number of retries is met. The default retry limit is set to `+20+`.

Expand Down
4 changes: 2 additions & 2 deletions modules/migration-about-configuring-proxies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

For {product-title} 4.1 and earlier versions, you must configure proxies in the `MigrationController` custom resource (CR) manifest after you install the {mtc-full} Operator because these versions do not support a cluster-wide `proxy` object.

For {product-title} 4.2 to {product-version}, the {mtc-full} ({mtc-short}) inherits the cluster-wide proxy settings. You can change the proxy parameters if you want to override the cluster-wide proxy settings.
For {product-title} 4.2 to {product-version}, the {mtc-short} inherits the cluster-wide proxy settings. You can change the proxy parameters if you want to override the cluster-wide proxy settings.

[id="direct-volume-migration_{context}"]
== Direct volume migration

Direct Volume Migration (DVM) was introduced in MTC 1.4.2. DVM supports only one proxy. The source cluster cannot access the route of the target cluster if the target cluster is also behind a proxy.
Direct Volume Migration (DVM) was introduced in {mtc-short} 1.4.2. DVM supports only one proxy. The source cluster cannot access the route of the target cluster if the target cluster is also behind a proxy.

If you want to perform a DVM from a source cluster behind a proxy, you must configure a TCP proxy that works at the transport layer and forwards the SSL connections transparently without decrypting and re-encrypting them with their own SSL certificates. A Stunnel proxy is an example of such a proxy.

Expand Down
2 changes: 1 addition & 1 deletion modules/migration-about-mtc-custom-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="migration-about-mtc-custom-resources_{context}"]
= About {mtc-short} custom resources

The {mtc-full} ({mtc-short}) creates the following custom resources (CRs):
The {mtc-first} creates the following custom resources (CRs):

image::migration-architecture.png[migration architecture diagram]

Expand Down
2 changes: 1 addition & 1 deletion modules/migration-adding-cluster-to-cam.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="migration-adding-cluster-to-cam_{context}"]
= Adding a cluster to the {mtc-short} web console

You can add a cluster to the {mtc-full} ({mtc-short}) web console.
You can add a cluster to the {mtc-first} web console.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="migration-adding-replication-repository-to-cam_{context}"]
= Adding a replication repository to the {mtc-short} web console

You can add an object storage as a replication repository to the {mtc-full} ({mtc-short}) web console.
You can add an object storage as a replication repository to the {mtc-first} web console.

{mtc-short} supports the following storage providers:

Expand Down
2 changes: 1 addition & 1 deletion modules/migration-changing-migration-plan-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="migration-changing-migration-plan-limits_{context}"]
= Increasing limits for large migrations

You can increase the limits on migration objects and container resources for large migrations with the {mtc-full} ({mtc-short}).
You can increase the limits on migration objects and container resources for large migrations with the {mtc-first}.

[IMPORTANT]
====
Expand Down
2 changes: 1 addition & 1 deletion modules/migration-compatibility-guidelines-3-to-4.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="migration-compatibility-guidelines-3-to-4_{context}"]
= Compatibility guidelines

You must install the {mtc-full} ({mtc-short}) Operator that is compatible with your {product-title} version.
You must install the {mtc-first} Operator that is compatible with your {product-title} version.

.Definitions

Expand Down
Loading