AWS prescriptive-guidance documentation change
Summary
Updated documentation structure, fixed broken links, reformatted tables for consistency, corrected terminology (e.g., 'AWS Transform MGN' to 'MGN'), and adjusted template references from linked samples to attached files.
Security assessment
Changes involve structural improvements, link updates, and table formatting without introducing new security content or addressing vulnerabilities. References to security groups/IAM roles remain unchanged in context and don't indicate security fixes.
Diff
diff --git a/prescriptive-guidance/latest/large-migration-portfolio-playbook/metadata.md b/prescriptive-guidance/latest/large-migration-portfolio-playbook/metadata.md index 90936748c..96db648b2 100644 --- a//prescriptive-guidance/latest/large-migration-portfolio-playbook/metadata.md +++ b//prescriptive-guidance/latest/large-migration-portfolio-playbook/metadata.md @@ -5 +5 @@ -[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Portfolio playbook for AWS large migrations](welcome.html) +[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Portfolio playbook for AWS large migrations](introduction.html) @@ -9 +9 @@ Step 1: Define the required metadataStep 2: Build the metadata storage and colle -# Task 2: Defining processes for identifying, collecting, and storing metadata +# Task 2: Defining metadata processes @@ -28 +28 @@ Before you can determine the required metadata attributes, you must understand t -The person or team that defines the metadata attributes begins by defining the steps and tasks needed to perform the migration pattern. The tasks determine what metadata is needed, so working through each task builds a comprehensive collection of the required metadata. The person who determines what metadata is required typically needs to have a comprehensive understanding of how to complete the migration pattern. Coordination with the person writing the migration runbook might be required. For more information, see the [Migration playbook for AWS large migrations](https://docs.aws.amazon.com/prescriptive-guidance/latest/large-migration-migration-playbook/). +The person or team that defines the metadata attributes begins by defining the steps and tasks needed to perform the migration pattern. The tasks determine what metadata is needed, so working through each task builds a comprehensive collection of the required metadata. The person who determines what metadata is required typically needs to have a comprehensive understanding of how to complete the migration pattern. Coordination with the person writing the migration runbook might be required. For more information, see the [Migration playbook for AWS large migrations](https://docs.aws.amazon.com/prescriptive-guidance/latest/large-migration-migration-playbook/welcome.html). @@ -113 +113 @@ The following are examples: -The following is an example of how you might record _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ from the [migration patterns table](./discovery.html#migration-patterns). +The following is an example of how you might record _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ from the migration patterns table. @@ -115 +115 @@ The following is an example of how you might record _Pattern 1: Rehost to Amazon -**Pattern ID** | 1 +Pattern ID| 1 @@ -125 +125 @@ The following is an example of how you might record _Pattern 1: Rehost to Amazon -Now that you have defined the pattern or task, you determine the metadata required for the source object, target object, tools, and other business information. To explain this process, this playbook uses _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ from the [migration patterns table](./discovery.html#migration-patterns) as an example. Note that for some patterns or tasks, some steps might not apply. +Now that you have defined the pattern or task, you determine the metadata required for the source object, target object, tools, and other business information. To explain this process, this playbook uses _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ from the migration patterns table as an example. Note that for some patterns or tasks, some steps might not apply. @@ -127 +127 @@ Now that you have defined the pattern or task, you determine the metadata requir - 1. **Analyze the target object** – Working backwards from the target object, manually create the object and identify the metadata needed to support it. Capture the metadata as demonstrated in the following table. + 1. **Analyze the target object –** Working backwards from the target object, manually create the object and identify the metadata needed to support it. Capture the metadata as demonstrated in the following table. @@ -133,8 +133,8 @@ Attribute name | Object type | Description or purpose -`target_subnet` | Target EC2 instance | Subnet of the target EC2 instance -`target_subnet_test` | Target EC2 instance | Test subnet of the target EC2 instance -`target_security_group` | Target EC2 instance | Security group of the target EC2 instance -`target_security_group_test` | Target EC2 instance | Test security group of the target EC2 instance -`IAM_role` | Target EC2 instance | AWS Identity and Access Management (IAM) role of the target EC2 instance -`instance_type` | Target EC2 instance | Instance type of the target EC2 instance -`AWS_account_ID` | Target EC2 instance | AWS account to host the target EC2 instance -`AWS_Region` | Target EC2 instance | AWS Region to host the target EC2 instance +target_subnet| Target EC2 instance| Subnet of the target EC2 instance +target_subnet_test| Target EC2 instance| Test subnet of the target EC2 instance +target_security_group| Target EC2 instance| Security group of the target EC2 instance +target_security_group_test| Target EC2 instance| Test security group of the target EC2 instance +IAM_role| Target EC2 instance| AWS Identity and Access Management (IAM) role of the target EC2 instance +instance_type| Target EC2 instance| Instance type of the target EC2 instance +AWS_account_ID| Target EC2 instance| AWS account to host the target EC2 instance +AWS_Region| Target EC2 instance| AWS Region to host the target EC2 instance @@ -142 +142 @@ Attribute name | Object type | Description or purpose - 2. **Analyze the tools** – Use the tool to create a target object and check for differences. Capture the tool-specific metadata as demonstrated in the following table, and remove the attributes from the previous table if it is not supported by the migration tool. For example, you cannot customize the OS type and storage size for MGN because the rehost migration tool is like-for-like. Therefore, you would remove target OS and target disk size if these attributes were included in the previous table. In the previous example table, all attributes are supported by the tool, so no action is required. + 2. **Analyze the tools –** Use the tool to create a target object and check for differences. Capture the tool-specific metadata as demonstrated in the following table, and remove the attributes from the previous table if it is not supported by the migration tool. For example, you cannot customize the OS type and storage size for MGN because the rehost migration tool is like-for-like. Therefore, you would remove target OS and target disk size if these attributes were included in the previous table. In the previous example table, all attributes are supported by the tool, so no action is required. @@ -148,4 +148,4 @@ Attribute name | Object type | Description or purpose -`AWS_account_ID` | Tools (MGN) | AWS account ID for AWS Transform MGN -`AWS_Region` | Tools (MGN) | AWS Region for MGN -`replication_server_subnet` | Tools (MGN) | Subnet for the MGN replication server -`replication_server_security_group` | Tools (MGN) | Security group for the MGN replication server +AWS_account_ID| Tools (MGN)| AWS account ID for MGN +AWS_Region| Tools (MGN)| AWS Region for MGN +replication_server_subnet| Tools (MGN)| Subnet for the MGN replication server +replication_server_security_group| Tools (MGN)| Security group for the MGN replication server @@ -167,19 +167,19 @@ Attribute name | Object type | Description or purpose -`wave_ID` | Source wave | ID of the wave (for example: wave 10) -`wave_start_date` | Source wave | Start date for the wave -`wave_cutover_date` | Source wave | Cutover date for the wave -`wave_owner` | Source wave | Owner of the wave -`app_name` | Source application | Source application name -`app_to_server_mapping` | Source application | Application-to-server relationship -`app_to_DB_mapping` | Source application | Application-to-database relationship -`app_to_app_dependencies` | Source application | External dependencies of the application -`server_name` | Source server | Source server name -`server_FQDN` | Source server | Fully qualified domain name of the source server -`server_OS_family` | Source server | Operating system (OS) family of the source server (for example: Windows or Linux) -`server_OS_version` | Source server | OS version of the source server (for example: Windows Server 2003) -`server_environment` | Source server | Environment of the source server (for example: development, production, or test) -`server_tier` | Source server | Tier of the source server (for example: web, database, or application) -`CPU` | Source server | Number of CPUs in the source server -`RAM` | Source server | RAM size of the source server -`disk_size` | Source server | Disk size of the source server - - 4. **Consider other attributes** – In addition to the primary action, consider other actions and attributes related to the target object or application. For the example pattern, _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ , the action is rehost, and the target object is Amazon EC2. Other related actions for this target object might include backing up to Amazon EC2, monitoring the EC2 instance after the migration, and using tags to manage costs associated with the EC2 instance. You might also want to consider other application attributes that help you manage the migration, such as the application owner, who you might need to contact for questions or cutover purposes. +wave_ID| Source wave| ID of the wave (for example: wave 10) +wave_start_date| Source wave| Start date for the wave +wave_cutover_date| Source wave| Cutover date for the wave +wave_owner| Source wave| Owner of the wave +app_name| Source application| Source application name +app_to_server_mapping| Source application| Application-to-server relationship +app_to_DB_mapping| Source application| Application-to-database relationship +app_to_app_dependencies| Source application| External dependencies of the application +server_name| Source server| Source server name +server_FQDN| Source server| Fully qualified domain name of the source server +server_OS_family| Source server| Operating system (OS) family of the source server (for example: Windows or Linux) +server_OS_version| Source server| OS version of the source server (for example: Windows Server 2003) +server_environment| Source server| Environment of the source server (for example: development, production, or test) +server_tier| Source server| Tier of the source server (for example: web, database, or application) +CPU| Source server| Number of CPUs in the source server +RAM| Source server| RAM size of the source server +disk_size| Source server| Disk size of the source server + + 4. **Consider other attributes –** In addition to the primary action, consider other actions and attributes related to the target object or application. For the example pattern, _Pattern 1: Rehost to Amazon EC2 using MGN or Cloud Migration Factory_ , the action is rehost, and the target object is Amazon EC2. Other related actions for this target object might include backing up to Amazon EC2, monitoring the EC2 instance after the migration, and using tags to manage costs associated with the EC2 instance. You might also want to consider other application attributes that help you manage the migration, such as the application owner, who you might need to contact for questions or cutover purposes. @@ -191,4 +191,4 @@ Attribute name | Object type | Description or purpose -`Name` | Target EC2 instance (tag) | Tag to define the name of a target EC2 instance -`app_owner` | Source application | The owner of a source application -`business_unit` | Target EC2 instance (tag) | Tag to identify the business unit for a target EC2 instance (for example: HR, finance, or IT) -`cost_center` | Target EC2 instance (tag) | Tag to identify the cost center for a target EC2 instance +Name| Target EC2 instance (tag)| Tag to define the name of a target EC2 instance +app_owner| Source application| The owner of a source application +business_unit| Target EC2 instance (tag)| Tag to identify the business unit for a target EC2 instance (for example: HR, finance, or IT) +cost_center| Target EC2 instance (tag)| Tag to identify the cost center for a target EC2 instance @@ -200,31 +200,31 @@ Attribute name | Object type | Description or purpose -`wave_ID` | Source wave | ID of the wave (for example: wave 10) -`wave_start_date` | Source wave | Start date for the wave -`wave_cutover_date` | Source wave | Cutover date for the wave -`wave_owner` | Source wave | Owner of the wave -`app_name` | Source application | Source application name -`app_to_server_mapping` | Source application | Application-to-server relationship -`app_to_DB_mapping` | Source application | Application-to-database relationship -`app_to_app_dependencies` | Source application | External dependencies of the application -`AWS_account_ID` | Tools (MGN) | AWS account to host the target EC2 instance -`AWS_Region` | Tools (MGN) | AWS Region to host the target EC2 instance -`replication_server_subnet` | Tools (MGN) | Subnet for the MGN replication server -`replication_server_security_group` | Tools (MGN) | Security group for the MGN replication server -`server_name` | Source server | Source server name -`server_FQDN` | Source server | Fully qualified domain name of the source server -`server_OS_family` | Source server | Operating system (OS) family of the source server (for example: Windows or Linux) -`server_OS_version` | Source server | OS version of the source server (for example: Windows Server 2003) -`server_environment` | Source server | Environment of the source server (for example: development, production, or test) -`server_tier` | Source server | Tier of the source server (for example: web, database, or application) -`CPU` | Source server | Number of CPUs in the source server -`RAM` | Source server | RAM size of the source server -`disk_size` | Source server | Disk size of the source server -`target_subnet` | Target server | Subnet of the target EC2 instance -`target_subnet_test` | Target server | Test subnet of the target EC2 instance -`target_security_group` | Target server | Security group of the target EC2 instance -`target_security_group_test` | Target server | Test security group of the target EC2 instance -`instance_type` | Target server | Instance type of the target EC2 instance -`IAM_role` | Target server | AWS Identity and Access Management (IAM) role of the target EC2 instance -`Name` | Target server (tag) | Tag to define the name of a target EC2 instance -`app_owner` | Source application | The owner of a source application -`business_unit` | Target server (tag) | Tag to identify the business unit for a target EC2 instance (for example: HR, finance, or IT) -`cost_center` | Target server (tag) | Tag to identify the cost center for a target EC2 instance +wave_ID| Source wave| ID of the wave (for example: wave 10) +wave_start_date| Source wave| Start date for the wave +wave_cutover_date| Source wave| Cutover date for the wave +wave_owner| Source wave| Owner of the wave +app_name| Source application| Source application name +app_to_server_mapping| Source application| Application-to-server relationship +app_to_DB_mapping| Source application| Application-to-database relationship +app_to_app_dependencies| Source application| External dependencies of the application +AWS_account_ID| Tools (MGN)| AWS account to host the target EC2 instance +AWS_Region| Tools (MGN)| AWS Region to host the target EC2 instance +replication_server_subnet| Tools (MGN)| Subnet for the MGN replication server +replication_server_security_group| Tools (MGN)| Security group for the MGN replication server +server_name| Source server| Source server name +server_FQDN| Source server| Fully qualified domain name of the source server +server_OS_family| Source server| Operating system (OS) family of the source server (for example: Windows or Linux) +server_OS_version| Source server| OS version of the source server (for example: Windows Server 2003) +server_environment| Source server| Environment of the source server (for example: development, production, or test) +server_tier| Source server| Tier of the source server (for example: web, database, or application) +CPU| Source server| Number of CPUs in the source server +RAM| Source server| RAM size of the source server +disk_size| Source server| Disk size of the source server +target_subnet| Target server| Subnet of the target EC2 instance +target_subnet_test| Target server| Test subnet of the target EC2 instance +target_security_group| Target server| Security group of the target EC2 instance +target_security_group_test| Target server| Test security group of the target EC2 instance +instance_type| Target server| Instance type of the target EC2 instance +IAM_role| Target server| AWS Identity and Access Management (IAM) role of the target EC2 instance +Name| Target server (tag)| Tag to define the name of a target EC2 instance +app_owner| Source application| The owner of a source application +business_unit| Target server (tag)| Tag to identify the business unit for a target EC2 instance (for example: HR, finance, or IT) +cost_center| Target server (tag)| Tag to identify the cost center for a target EC2 instance @@ -274,25 +273,0 @@ After listing all the possible sources of your metadata, you analyze the metadat -Metadata attribute | Metadata type | Metadata sources ----|---|--- -`app_name` | Source application | CMDB -`app_owner` | Source application | CMDB -`app_to_server_mapping` | Source application | CMDB, discovery tools, or application owner questionnaire -`app_to_DB_mapping` | Source application | CMDB, discovery tools, or application owner questionnaire -`app_to_app_dependencies` | Source application | CMDB, discovery tools, or application owner questionnaire -`server_name` | Source server | CMDB -`server_FQDN` | Source server | CMDB -`server_OS_family` | Source server | CMDB -`server_IP` | Source server | Discovery tools -`disk_size` | Source server | Discovery tools -`instance_type` | Target server | Discovery tools -`target_subnet` | Target server | Application owner questionnaire -`target_security_group` | Target server | Application owner questionnaire -`AWS_Region` | Target server | Application owner questionnaire -`AWS_account_ID` | Target server | Application owner questionnaire -`replication_server_subnet` | Tools (MGN) | Landing zone design documentation -`replication_server_security_group` | Tools (MGN) | Landing zone design documentation -`Name` | Target server (tag) | Application owner questionnaire -`business_unit` | Target server (tag) | Application owner questionnaire -`cost_center` | Target server (tag) | Application owner questionnaire -`wave_ID` | Wave planning | Application owner interview -`wave_start_date` | Wave planning | Application owner interview -`wave_cutover_date` | Wave planning | Application owner interview @@ -301,0 +277,25 @@ Metadata attribute | Metadata type | Metadata sources +Metadata attribute| Metadata type| Metadata sources +---|---|--- +app_name| Source application| CMDB +app_owner| Source application| CMDB +app_to_server_mapping| Source application| CMDB, discovery tools, or application owner questionnaire +app_to_DB_mapping| Source application| CMDB, discovery tools, or application owner questionnaire +app_to_app_dependencies| Source application| CMDB, discovery tools, or application owner questionnaire +server_name| Source server| CMDB