AWS drs documentation change
Summary
Multiple wording changes from 'the following' to 'these/this' and minor grammatical improvements
Security assessment
These are stylistic changes that don't alter technical content or security implications
Diff
diff --git a/drs/latest/userguide/failback-failover-drsfa.md b/drs/latest/userguide/failback-failover-drsfa.md index f851727a0..742e99823 100644 --- a/drs/latest/userguide/failback-failover-drsfa.md +++ b/drs/latest/userguide/failback-failover-drsfa.md @@ -21 +21 @@ The DRSFA client was only tested on vCenter versions 6.7 and 7.0. -The following are the prerequisites for performing failback automation with the DRSFA client: +These are the prerequisites for performing failback automation with the DRSFA client: @@ -45 +45 @@ The installation procedure shown below uses Ubuntu 20.04 which has the required - 10. The server on which the DRSFA client is ran requires the following tools for DRSFA Client installation. The installer will attempt to install them if they are not already present:: + 10. The server on which the DRSFA client is ran requires these tools for DRSFA Client installation. The installer will attempt to install them if they are not already present:: @@ -61 +61 @@ If no attached CD ROM devices are found, the DRSFA client will attempt to add th - 14. We recommend running SHA512 checksum verification on the DRS Failback Client prior to using it with the DRSFA client. You can verify the checksum at the following address: ` ` https://aws-elastic-disaster-recovery-hashes-{REGION}.s3.amazonaws.com/latest/failback_livecd/aws-failback-livecd-64bit.iso.sha512 ` ` + 14. We recommend running SHA512 checksum verification on the DRS Failback Client prior to using it with the DRSFA client. You can verify the checksum at this address: ` ` https://aws-elastic-disaster-recovery-hashes-{REGION}.s3.amazonaws.com/latest/failback_livecd/aws-failback-livecd-64bit.iso.sha512 ` ` @@ -67 +67 @@ If no attached CD ROM devices are found, the DRSFA client will attempt to add th - 17. You need to have the following vCenter API credentials and permissions: ‘Virtual machine’ : [ ‘Change Settings’, ‘Guest operation queries’, ‘Guest operation program execution’, ‘Connect devices’, ‘Power off’, ‘Power on’. ‘Add or remove device’, ‘Configure CD media] ‘Datastore’: [‘Browse datastore’] + 17. You need to have these vCenter API credentials and permissions: ‘Virtual machine’ : [ ‘Change Settings’, ‘Guest operation queries’, ‘Guest operation program execution’, ‘Connect devices’, ‘Power off’, ‘Power on’. ‘Add or remove device’, ‘Configure CD media] ‘Datastore’: [‘Browse datastore’] @@ -78 +78 @@ If no attached CD ROM devices are found, the DRSFA client will attempt to add th -The following are security best practices for using the DRSFA Client: +These are security best practices for using the DRSFA Client: @@ -107 +107 @@ Prior to running the DRSFA Client, you must first install it. Installing the cli -The DRSFA client was fully tested on Ubuntu 20.04 and an installation script for this version is provided. Use the following vanilla AMI or public ISO to run the client locally in your vCenter environment. +The DRSFA client was fully tested on Ubuntu 20.04 and an installation script for this version is provided. Use this vanilla AMI or public ISO to run the client locally in your vCenter environment. @@ -109 +109 @@ The DRSFA client was fully tested on Ubuntu 20.04 and an installation script for -Follow the [Create your EC2 resources and launch your EC2 instance](https://docs.aws.amazon.com/efs/latest/ug/gs-step-one-create-ec2-resources.html) guidelines as per the EC2 documentation. When asked to select an AMI, select the option below instead of the Amazon Linux 2 AMI and then proceed according to the documentation. Use the following AMI from EC2: Ubuntu Server 20.04 LTS (HVM), SSD Volume Type: +Follow the [Create your EC2 resources and launch your EC2 instance](https://docs.aws.amazon.com/efs/latest/ug/gs-step-one-create-ec2-resources.html) guidelines as per the EC2 documentation. When asked to select an AMI, select the option below instead of the Amazon Linux 2 AMI and then proceed according to the documentation. Use this AMI from EC2: Ubuntu Server 20.04 LTS (HVM), SSD Volume Type: @@ -115 +115 @@ Download the Ubuntu Server 20.04 LTS server install image ISO from the [Ubuntu d -Once your VM instance is set up and ready, connect to the Ubuntu instance and run command prompt and download the DRSFA client using the following command: +Once your VM instance is set up and ready, connect to the Ubuntu instance and run command prompt and download the DRSFA client using this command: @@ -125 +125 @@ You should verify the hash of the installer after running the installation comma -Use the following command to execute the installation script: +Use this command to execute the installation script: @@ -141 +141 @@ This command may ask for a sudo password if you use the Ubuntu ISO. Enter the pa -The DRSFA client has a one-time installation. The DRSFA client will be installed in the `drs_failback_automation_client` directory. Once you've successfully ran the command above and installed the client, you can delete the DRSFA client installer from your server by running the following command: +The DRSFA client has a one-time installation. The DRSFA client will be installed in the `drs_failback_automation_client` directory. Once you've successfully ran the command above and installed the client, you can delete the DRSFA client installer from your server by running this command: @@ -147 +147 @@ The DRSFA client has a one-time installation. The DRSFA client will be installed -Once installation is complete, you will need to set up a password for the VM on which the DRSFA client is ran. This is done by generating a seed.iso file that you must upload to your Datastore. Run the following commands to generate the seed.iso file: +Once installation is complete, you will need to set up a password for the VM on which the DRSFA client is ran. This is done by generating a seed.iso file that you must upload to your Datastore. Run these commands to generate the seed.iso file: @@ -159 +159 @@ Two files will be generated, the `drs_failback_automation_seed.iso` file and the -Once the `drs_failback_automation_seed.iso` file is generated, you can run the following command to delete the seed creator: +Once the `drs_failback_automation_seed.iso` file is generated, you can run this command to delete the seed creator: @@ -177 +177 @@ Temporary credentials have many advantages. You don't need to rotate them or rev -To create temporary credentials, take the following steps: +To create temporary credentials: @@ -179 +179 @@ To create temporary credentials, take the following steps: - 1. [Create a new IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) with the **AWSElasticDisasterRecoveryAgentInstallationPolicy** policy. + 1. [Create a new IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) with the [ AWSElasticDisasterRecoveryFailbackInstallationPolicy](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticDisasterRecoveryFailbackInstallationPolicy.html) policy. @@ -192 +192 @@ Once you have installed the DRSFA client, you can run it by following these inst -`cd` into the `drs_failback_automation_client` directory and enter the following parameters in a single line or settings the environment variables one by one, replace the defaults with your specific parameters and paths followed by the `python drs_failback_automation_init.pyc` command and press enter. +`cd` into the `drs_failback_automation_client` directory and enter these parameters in a single line or settings the environment variables one by one, replace the defaults with your specific parameters and paths followed by the `python drs_failback_automation_init.pyc` command and press enter. @@ -223 +223 @@ Once you have installed the DRSFA client, you can run it by following these inst -You should enter all of the parameters in a single line or enter the environmental variables individually one by one. Once you have entered your parameters, enter the `python drs_failback_automation_init.pyc` command and press enter. The full parameters and command should look like the following example: +Enter all of the parameters in a single line or enter the environmental variables individually one by one. Once you have entered your parameters, enter the `python drs_failback_automation_init.pyc` command and press enter. The full parameters and command should look like this example: @@ -231 +231,4 @@ You should enter all of the parameters in a single line or enter the environment -SSL verification is active by default. If you want to deactivate SSL verification, then add the following parameter: DISABLE_SSL_VERIFICATION=true + * SSL verification is active by default. If you want to deactivate SSL verification, then add this parameter: DISABLE_SSL_VERIFICATION=true + + * By default, the DRSFA client initiates a failback for 10 servers at once (if failing back more than 10 servers). To change the default value, use the THREAD_POOL_SIZE parameter. + @@ -233 +235,0 @@ SSL verification is active by default. If you want to deactivate SSL verificatio -###### Note @@ -235 +236,0 @@ SSL verification is active by default. If you want to deactivate SSL verificatio -By default, the DRSFA client will initiate a failback for 10 servers at once (if failing back more than 10 servers). However, if you would like to change the default value, use the THREAD_POOL_SIZE parameter. @@ -243 +244 @@ Once the client has connected successfully and finished verification, select the -Enter a custom prefix for the results output for this failback operation. This file will be saved in the `/drs_failback_automation_client/results/Failback` directory. +Enter a custom prefix for the results output for this failback operation. This file is saved in the `/drs_failback_automation_client/results/Failback` directory. @@ -247 +248 @@ Enter a custom prefix for the results output for this failback operation. This f -If failback replication has already been started for some of the Recovery instances, the console will prompt you whether you want to skip the instances that are already in failback or restart replication for those instances. +If failback replication has already been started for some of the Recovery instances, the console prompts you to decide if you want to skip the instances that are already in failback or restart replication for those instances. @@ -261 +262 @@ The client will initiate failback. You can see the failback progress on the **Re -Once the failback has been complete, the DRSFA client will display the results of the failback, including the number of servers for which replication has successfully been initiated and the number of servers for which the failback operation failed. +Once the failback has been complete, the DRSFA client displays the results of the failback, including the number of servers for which replication has successfully been initiated and the number of servers for which the failback operation failed. @@ -265 +266 @@ The full results of the failback will be exported as a JSON file to the failback -The JSON file will display the following: +The JSON file displays: @@ -298 +299 @@ To generate a default failback configuration file, once the client has connected -Enter a custom prefix for the configuration file name. The configuration file will be created as a JSON file in the `/drs_failback_automation_client/` `Configurations` /folder with the following name: "{prefix}_{account_id}_{region}.json" +Enter a custom prefix for the configuration file name. The configuration file will be created as a JSON file in the `/drs_failback_automation_client/` `Configurations` /folder with the name: "{prefix}_{account_id}_{region}.json" @@ -302 +303 @@ Enter a custom prefix for the configuration file name. The configuration file wi -You can edit any of the fields in the file in order to correctly configure it. The file will display the following fields for each machine. You can edit every field to have absolute control over your failback configuration for each machine. Ensure to save your changes. +You can edit any of the fields in the file in order to correctly configure it. The file displays these fields for each machine. You can edit every field to have absolute control over your failback configuration for each machine. Ensure to save your changes. @@ -336 +337 @@ You can edit any of the fields in the file in order to correctly configure it. T -You can edit any of the fields in the file in order to correctly configure it. The file will display the following fields for each machine. You can edit every field to have absolute control over your failback configuration for each machine. Ensure to save your changes. +You can edit any of the fields in the file in order to correctly configure it. The file displays these fields for each machine. You can edit every field to have absolute control over your failback configuration for each machine. Ensure to save your changes. @@ -391 +392 @@ Select your configuration file. You can either define a custom path or select th -Enter a custom prefix for the results output for this failback operation. This file will be saved in the `/drs_failback_automation_client/Results/Failback` directory. +Enter a custom prefix for the results output for this failback operation. This file is saved in the `/drs_failback_automation_client/Results/Failback` directory. @@ -395 +396 @@ Enter a custom prefix for the results output for this failback operation. This f -If failback replication has already been started for some of the recovery instances, the console will prompt you whether you want to skip the instances that are already in failback or restart replication for those instances. +If failback replication has already been started for some of the recovery instances, the console prompts you to decide if you want to skip the instances that are already in failback or restart replication for those instances. @@ -409 +410 @@ The Client will initiate failback. You can see the failback progress on the **Re -Once the failback has been complete, the DRSFA client will display the results of the failback, including the number of servers for which replication has successfully been initiated and the number of servers for which the failback operation failed. +Once the failback has been complete, the DRSFA client displays the results of the failback, including the number of servers for which replication has successfully been initiated and the number of servers for which the failback operation failed. @@ -413 +414 @@ The full results of the failback will be exported as a JSON file to the failback -The JSON file will display the following: +The JSON file displays: @@ -448 +449 @@ The results will be exported to the `Results/VMFinder` folder in the DRSFA clien -The following will be displayed for each server: +These are displayed for each server: @@ -465 +466 @@ Most of DRSFA components are upgraded automatically upon execution. However, in -To complete the upgrade, take the following steps: +To complete the upgrade, take these steps: