Skip to content
Draft
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
ifdef::context[:parent-context: {context}]

:_mod-docs-content-type: ASSEMBLY

[id="assembly_migrating-from-aws_{context}"]

= Migrating from {aws} {ec2}

//:context: migrating-aws

[role="_abstract"]
Run your {aws} {ec2} migration plan from the MTV UI or from the command-line.

== Prerequisites

* You have planned your migration from {aws} {ec2}.

:context: aws
:aws:

include::../modules/proc_running-migration-plan.adoc[leveloffset=+1]

include::../modules/ref_migration-plan-options-ui.adoc[leveloffset=+2]

include::../modules/proc_canceling-migration-ui.adoc[leveloffset=+2]

include::../modules/proc_migrating-vms-cli-aws.adoc[leveloffset=+1]

include::../modules/con_canceling-migration-cli.adoc[leveloffset=+2]

include::../modules/proc_canceling-migration-cli-entire.adoc[leveloffset=+3]

include::../modules/proc_canceling-migration-cli-specific.adoc[leveloffset=+3]

:aws!:

ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]


2 changes: 2 additions & 0 deletions documentation/doc-Migrating_your_virtual_machines/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ include::assemblies/assembly_migrating-from-osp.adoc[leveloffset=+1]

include::assemblies/assembly_migrating-from-ova.adoc[leveloffset=+1]

include::assemblies/assembly_migrating-from-aws.adoc[leveloffset=+1]

include::assemblies/assembly_migrating-from-cnv.adoc[leveloffset=+1]

include::assemblies/assembly_advanced-migration-options.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@

ifdef::context[:parent-context: {context}]

:_mod-docs-content-type: ASSEMBLY

[id="assembly_planning-migration-aws_{context}"]

= Planning a migration of virtual machines from {aws} {ec2}

//:context: planning-aws

[IMPORTANT]
====
Importing VMs from Amazon {ec2} is Technology Preview software only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
====

[role="_abstract"]
Create an {aws} {ec2} migration plan by setting up network maps, storage maps, and configuring source and destination providers in the {project-first} UI.

{aws} {ec2} migration supports cold migration only to Red Hat OpenShift Service on {aws} ({rosa}) or OpenShift Dedicated (OSD) on {aws} clusters.

:context: aws
:aws:

include::../modules/proc_creating-form-based-network-maps-ui-aws.adoc[leveloffset=+1]

include::../modules/proc_creating-yaml-based-network-maps-ui-aws.adoc[leveloffset=+1]

include::../modules/proc_creating-form-based-storage-maps-ui-aws.adoc[leveloffset=+1]

include::../modules/proc_creating-yaml-based-storage-maps-ui-aws.adoc[leveloffset=+1]

include::../modules/proc_adding-source-provider.adoc[leveloffset=+1]

:!aws:
:context: dest_aws
:dest_aws:

include::../modules/proc_adding-source-provider.adoc[leveloffset=+1]

include::../modules/proc_selecting-migration-network-for-virt-provider.adoc[leveloffset=+1]

:!dest_aws:
:context: aws
:aws:

include::../modules/proc_creating-plan-wizard-aws.adoc[leveloffset=+1]

:!aws:

[id="additional-resources_planning-aws"]
[role="_additional-resources"]
== Additional resources

* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]

ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]




Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ include::../modules/ref_cnv-prerequisites.adoc[leveloffset=+1]

include::../modules/ref_cnv-cnv-live-prerequisites.adoc[leveloffset=+2]

include::../modules/ref_aws-ec2-prerequisites.adoc[leveloffset=+1]

include::../modules/ref_compatibility-guidelines.adoc[leveloffset=+1]

include::../modules/ref_openshift-operator-life-cycles.adoc[leveloffset=+2]
Expand Down
2 changes: 2 additions & 0 deletions documentation/doc-Planning_your_migration/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ include::assemblies/assembly_planning-migration-osp.adoc[leveloffset=+1]

include::assemblies/assembly_planning-migration-ova.adoc[leveloffset=+1]

include::assemblies/assembly_planning-migration-aws.adoc[leveloffset=+1]

include::assemblies/assembly_planning-migration-cnv.adoc[leveloffset=+1]


Expand Down
3 changes: 3 additions & 0 deletions documentation/modules/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
:operator-name-ui: Migration Toolkit for Virtualization Operator
:operator-name: MTV Operator
:osp: OpenStack
:aws: AWS
Comment thread
Jenny-Anne marked this conversation as resolved.
:ec2: EC2
:rosa: ROSA
:project-full: Migration Toolkit for Virtualization
:project-short: MTV
:project-first: {project-full} ({project-short})
Expand Down
74 changes: 69 additions & 5 deletions documentation/modules/proc_adding-source-provider.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Module included in the following assemblies:
//
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-aws.adoc
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-cnv.adoc
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-osp.adoc
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-ova.adoc
Expand Down Expand Up @@ -40,6 +41,21 @@ You can add Open Virtual Appliance (OVA) files that were created by {vmw} vSpher

endif::[]

ifdef::aws[]
= Adding an {aws} {ec2} source provider

[IMPORTANT]
====
Importing VMs from Amazon {ec2} is Technology Preview software only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
====

[role="_abstract"]
You can add an {aws} {ec2} source provider to migrate {ec2} instances to {virt} on Red Hat OpenShift Service on {aws} ({rosa}) or OpenShift Dedicated (OSD) on {aws}.

endif::[]

ifdef::ostack[]
= Adding an {osp} source provider

Expand All @@ -64,17 +80,22 @@ The {ocp} cluster version of the source provider must be 4.16 or later.
====
endif::[]

ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[]
ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_aws,dest_cnv[]
= Adding {a-virt} destination provider

[role="_abstract"]
Use a Red Hat {virt} provider as both source and destination provider. You can migrate VMs from the cluster that {project-first} is deployed on to another cluster or from a remote cluster to the cluster that {project-short} is deployed on.
endif::[]

ifdef::vmware,rhv,dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[]
ifdef::vmware,rhv,aws,dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_aws,dest_cnv[]
.Prerequisites
endif::[]

ifdef::aws[]
* {aws} credentials with required IAM permissions. For more information, see xref:ref_aws-ec2-prerequisites_mtv[{aws} {ec2} prerequisites].
* EBS CSI driver installed on the target cluster
endif::[]

ifdef::vmware[]
* It is strongly recommended to create a {vmw} Virtual Disk Development Kit (VDDK) image in a secure registry that is accessible to all clusters. A VDDK image accelerates migration and reduces the risk of a plan failing. If you are not using VDDK and a plan fails, retry with VDDK installed. For more information, see xref:proc_creating-vddk-image_mtv[Creating a VDDK image].

Expand All @@ -88,7 +109,7 @@ ifdef::rhv[]
* {manager} CA certificate, unless it was replaced by a third-party certificate, in which case, specify the {manager} Apache CA certificate
endif::[]

ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[]
ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_aws,dest_cnv[]
* You must have {a-virt} link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/authentication_and_authorization/using-service-accounts[service account token] with `cluster-admin` privileges.
endif::[]

Expand Down Expand Up @@ -364,7 +385,7 @@ If both *URL* and *Service account bearer token* are left blank, the local {ocp-
Once confirmed, the CA certificate will be used to validate subsequent communication with the API endpoint.
endif::[]

ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[]
ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_aws,dest_cnv[]
. Access the *Create {virt} provider* interface by doing one of the following:

.. In the {ocp} web console, click *Migration for Virtualization > Providers*.
Expand Down Expand Up @@ -412,11 +433,54 @@ If both *URL* and *Service account bearer token* are left blank, the local {ocp-
Once confirmed, the CA certificate will be used to validate subsequent communication with the API endpoint.
endif::[]

ifdef::aws[]
. Access the *Create provider* page for {aws} {ec2} by doing one of the following:

.. In the {ocp} web console, click *Migration for Virtualization > Providers*.
... Click *Create Provider*.
... Select a *Project* from the list. The default project shown depends on the active project of {project-short}.
+
If the active project is *All projects*, then the default project is +{namespace}+. Otherwise, the default project is the same as the active project.
+
If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.
... Click *Amazon {ec2}*.

.. If you have Administrator privileges, in the {ocp} web console, click *Migration for Virtualization > Overview*.
... In the *Welcome* pane, click *Amazon {ec2}*.
+
If the *Welcome* pane is not visible, click *Show the welcome card* in the upper-right corner of the page, and click *Amazon {ec2}* when the *Welcome* pane opens.
... Select a *Project* from the list. The default project shown depends on the active project of {project-short}.
+
If the active project is *All projects*, then the default project is +{namespace}+. Otherwise, the default project is the same as the active project.
+
If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.

. Specify the following fields:
+
* *Provider resource name*: Name of the source provider.
* *{aws} region*: The {aws} region where your {ec2} instances are located, for example, `us-east-1`. This must be the same region as your {rosa} or OSD cluster.
+
. Specify the provider credentials:
+
* *Access key ID*: {aws} access key ID for authenticating to the {ec2} API.
* *Secret access key*: {aws} secret access key for authenticating to the {ec2} API.
+
. Configure target settings:
+
* *Auto-detect target settings*: Select this checkbox to automatically fetch target {aws} credentials from the cluster and detect the target availability zone from worker nodes. This option is selected by default.
+
* *Use cross-account credentials*: Select this checkbox if the target {aws} account is different from the source account. When selected, you must provide the following:
+
** *Target access key ID*: {aws} access key ID for the target account.
** *Target secret access key*: {aws} secret access key for the target account.

endif::[]

. Click *Create provider* to add and save the provider.
+
The provider appears in the list of providers.

ifdef::vmware[]
ifdef::vmware,aws[]
+
[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
[role="_abstract"]
You can use the command-line interface (CLI) to cancel an entire migration while a migration is in progress.

// When a Migration CR is deleted, are resources automatically cleaned up (same question for all providers)?

.Procedure

* Delete the `Migration` CR:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Module included in the following assemblies:
//
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-aws.adoc

:_mod-docs-content-type: PROCEDURE
[id="proc_creating-form-based-network-maps-ui-aws_{context}"]
= Creating ownerless network maps from the form page in the {project-short} UI

[role="_abstract"]
You can add ownerless network maps from the form page in the {project-first} UI. Later, you can add these maps to a migration plan by using the *Use an existing network map* option in the *Network map* page of the {project-short} wizard.

Network maps define the mapping between {aws} subnet IDs and OpenShift networks (pod network or Multus networks).

For more information about network and storage maps in {project-short}, see link:{mtv-plan}assembly_mapping-networks-storage_mtv[Mapping networks and storage in migration plans].

.Prerequisites

* Have an {aws} {ec2} source provider and {a-virt} destination provider. For more information, see xref:proc_adding-source-provider_aws[Adding an {aws} {ec2} source provider] or xref:proc_adding-source-provider_dest_aws[Adding {a-virt} destination provider].

// Can we get an example AWS subnet ID format?

.Procedure

. In the {ocp} web console, click *Migration for Virtualization* > *Network maps*.
. Click *Create network map* > *Create with form*.
. Specify the following:

* *Network map name*: Name of the network map.
* *Project*: Select from the list.
* *Source provider*: Select the {aws} {ec2} source provider from the list.
* *Target provider*: Select the {virt} destination provider from the list.
* *Source network*: Select the {aws} subnet ID from the list.
* *Target network*: Select the OpenShift network from the list. This can be the pod network or a Multus network attachment definition.

. Optional: Click *Add mapping* to create additional network maps, including mapping multiple network sources to a single target network.
. Click *Create*.
+
Your map appears in the list of network maps.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Module included in the following assemblies:
//
// * documentation/doc-Planning_your_migration/assemblies/assembly_planning-migration-aws.adoc

:_mod-docs-content-type: PROCEDURE
[id="proc_creating-form-based-storage-maps-ui-aws_{context}"]
= Creating ownerless storage maps from the form page in the {project-short} UI

[role="_abstract"]
You can add ownerless storage maps from the form page in the {project-first} UI. Later, you can add these maps to a migration plan by using the *Use an existing storage map* option in the *Storage map* page of the {project-short} wizard.

Storage maps define the mapping between {aws} EBS volume types and OpenShift storage classes that use the EBS CSI driver.

For more information about network and storage maps in {project-short}, see link:{mtv-plan}assembly_mapping-networks-storage_mtv[Mapping networks and storage in migration plans].

[IMPORTANT]
====
You must map EBS volumes to storage classes that use the {aws} EBS CSI driver.
====

.Prerequisites

* Have an {aws} {ec2} source provider and {a-virt} destination provider. For more information, see xref:proc_adding-source-provider_aws[Adding an {aws} {ec2} source provider] or xref:proc_adding-source-provider_dest_aws[Adding {a-virt} destination provider].
* EBS CSI driver installed and configured on the target cluster.
* Storage classes configured to use the EBS CSI driver.

.Procedure

. In the {ocp} web console, click *Migration for Virtualization* > *Storage maps*.
. Click *Create storage map* > *Create with form*.
. Specify the following:

* *Map name*: Name of the storage map.
* *Project*: Select from the list.
* *Source provider*: Select the {aws} {ec2} source provider from the list.
* *Target provider*: Select the {virt} destination provider from the list.
* *Source storage*: Select the EBS volume type from the list.
* *Target storage*: Select a storage class that uses the EBS CSI driver from the list.

. Optional: Click *Add mapping* to create additional storage maps, including mapping multiple storage sources to a single target storage class.
. Click *Create*.
+
Your map appears in the list of storage maps.

Loading
Loading