Update README.md

Updated ReadMe for new script version

Author: ajkeane-aws

README.md

@@ -1,36 +1,75 @@
 # AWS DataSync Deployment for Azure
 
-This repository contains a script designed to convert the DataSync Agent VHDX to VHD on Amazon Linux 2 (AL2), and upload the generated disk to Azure and create an Azure Virtual Machine. The script can create the DataSync Virtual Machine in a new Azure vNet and Subnet or it can also use an existing Azure vNET and Subnet. Please review the Parameters section for deployment options.
+This repository contains a script designed to convert the DataSync Agent VHDX to VHD on Amazon Linux 2 (AL2), and upload the generated disk to Azure and create an Azure Virtual Machine. The script will create the DataSync Virtual Machine in a new Azure vNet and Subnet or it can also use an existing Azure vNET and Subnet. Please review the Parameters section for deployment options.
 
-## Getting Started
+## Blogs
+For more details on migrating Azure Blob Storage to Amazon S3 using AWS DataSync, see the following blog post:
 
-To begin the deployment process, ensure that you have the necessary prerequisites in place and are familiar with the configuration parameters required for successful execution.
+[Migrating Azure Blob Storage to Amazon S3 Using AWS DataSync](https://aws.amazon.com/blogs/storage/migrating-azure-blob-storage-to-amazon-s3-using-aws-datasync/)
 
-### Prerequisites
+For information on moving data from Azure Files SMB shares to AWS using AWS DataSync, check out this blog post:
 
-Before running the deployment script, please ensure that you have the following parameters readily available:
+[How to Move Data from Azure Files SMB Shares to AWS Using AWS DataSync](https://aws.amazon.com/blogs/storage/how-to-move-data-from-azure-files-smb-shares-to-aws-using-aws-datasync/)
 
-This script has been developed to run on an Amazon Linux 2 AMI and the EC2 instance should have at least 160GB of disk space for the conversion process.**
+## Getting Started
 
-Parameters:
+To start the deployment, make sure you have met all the necessary prerequisites and are familiar with the configuration parameters needed for successful execution.
 
-**Mandatory Parameters:**
-- **Deployment Type (-d)**: Choose whether you want to use a new_vnet or an existing_vnet.
-- **Location (-l)**: The Azure region where you want to deploy your resources, such as eastus.
-- **Resource Group (-r)**: The name of the Azure Resource Group where the deployed resources will be managed, e.g., aws-datasync-rg.
-- **Virtual Machine Name (-v)**: The desired name for the Azure Virtual Machine that will host the AWS DataSync Agent, for example, datasync-vm.
+It's recommended to log in to your Azure account before running the script. During the script execution, you'll be prompted to enter the authorization code provided in the Azure console to grant the script access to your Azure resources.
 
-**Optional Parameters (when -d is existing_vnet):**
-- **VNET Resource Group (-g)**: The name of the Azure Resource Group with the existing VNET, e.g., existing-vnet-rg.
-- **VNET Name (-n)**: The name of the existing VNET, e.g., existing-vnet.
-- **Subnet Name (-s)**: The name of the subnet that exists in the VNET, e.g., existing-subnet.
+## Deployment Steps
 
----
+The deployment script automates several steps to ensure a smooth integration between AWS DataSync and Azure services. Here's a breakdown of the deployment process:
+
+1. Provide Configuration Parameters: Before executing the script, open it in your preferred editor and provide the necessary configuration parameters. These parameters will be used to customize the deployment according to your requirements.
+2. Install Azure CLI and AzCopy: As a part of the setup process, the script will **automatically** download and install the Azure Command-Line Interface (CLI) and AzCopy tools. These tools are essential for managing and transferring data within the Azure environment.
+3. Download AWS DataSync Agent for Hyper-V: The script will download the AWS DataSync Agent specifically designed for Hyper-V environment.
+4. Convert VHDX to VHD: Once the AWS DataSync Agent is downloaded, the script will take care of converting the Virtual Hard Disk (VHDX) file to the compatible Hyper-V Disk (HVD) format for Azure
+5. Azure Authentication: To access and manage your Azure resources, the script will guide you through the authentication process, ensuring secure access to your Azure account.
+6. Create Resource Group: The deployment script will automatically create or use an existing Azure Resource Group. This Resource Group will serve as the container for your deployed resources.
+7. Upload VHD as Managed Disk: The script will upload the converted VHD file as a managed disk within the specified Resource Group. This disk will contain the AWS DataSync Agent.
+8. Create Virtual Machine: Leveraging the uploaded managed disk, the script will create an Azure Virtual Machine in either a new VNET or an existing VNET and subnet. 
+
+### Prerequisites
+
+Before running the deployment script, please ensure that you have the following and the parameters needed for Azure readily available:
+- Amazon Linux 2 instance with 160GB storage
+- Azure permissions to:
+  - Create/manage resource groups
+  - Create/manage virtual machines
+  - Create/manage virtual networks (if using new_vnet deployment)
+  - Upload and manage disks
 
 > This script has been developed to run on an Amazon Linux 2 AMI and the EC2 instance should have at least 160GB of disk space for the conversion process
 
 ![Amazon EC2 Launch Instance](./docs/datasync.png)
 
+**Mandatory Parameters:**
+- **Deployment Type (-d)**: Choose whether you want to use a ('new_vnet' or 'existing_vnet')
+- **Location (-l)**: Azure region where you want to deploy your resources (e.g., 'eastus', 'westus')
+- **Resource Group (-r)**: Azure Resource Group name (e.g. aws-datasync-rg)
+- **Virtual Machine Name (-v)**: The  name for the Azure Virtual Machine that will host the AWS DataSync Agent (e.g. aws-datasync-vm)
+- **Virtual Machine Size (-z)**: Azure VM size (e.g., 'Standard_E4s_v3', 'Standard_E16_v5')
+
+**Additional Parameters (when -d is existing_vnet):**
+- **VNET Resource Group (-g)**: Virtual network resource group (required for 'existing_vnet')
+- **VNET Name (-n)**: Virtual network name (required for 'existing_vnet')
+- **Subnet Name (-s)**: (required for 'existing_vnet')
+
+**Display Help Menu**
+- **Show help message (-h)**
+```
+sudo bash datasync.sh -h
+```
+![Datasync Help Menu options](./docs/deployment-menu-options.png)
+
+
+When selecting the Azure Virtual Machine for the Datasync Agent, we recommend the following:
+- 32 GB of RAM assigned to the VM for task executions working with **up** to 20 million files, objects, or directories.
+- 64 GB of RAM assigned to the VM for task executions working with **more** than 20 million files, objects, or directories.  
+- For detailed AWS DataSync agent requirements, see the [AWS DataSync Agent Requirements](https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html) documentation.
+
+---
 
 ### Download the Deployment Script
 
@@ -39,33 +78,41 @@ Run the following command to download the deployment script from the code reposi
 ```
 curl -sLO https://raw.githubusercontent.com/aws-samples/aws-datasync-deploy-agent-azure/main/src/bash/datasync.sh
 ```
-
+Make the script executable:
+```
+chmod +x datasync.sh
+```
 ### Running the Deployment Script
 
 Once you have your parameters ready, you can initiate the deployment script using the following commands:
 
 For new_vnet deployment:
 ```
-sudo bash datasync.sh -d new_vnet -l eastus -r aws-datasync-rg -v datasync-vm
+sudo bash datasync.sh -d new_vnet -l eastus -r myResourceGroup -v myVM -z Standard_E4s_v3
 ```
 
 For existing_vnet deployment:
 ```
-sudo bash datasync.sh -d existing_vnet -l eastus -r aws-datasync-rg -v datasync-vm -g existing-vnet-rg -n existing-vnet -s existing-subnet
+sudo bash datasync.sh -d existing_vnet -l eastus -r aws-datasync-rg -v datasync-vm -g existing-vnet-rg -n existing-vnet -s existing-subnet -z Standard_E16_v5
 ```
 
-## Deployment Steps
+## Azure CLI Login
+You will be prompted to login to Azure and allow the script to create the Virtual Machine for the DataSync Appliance
 
-The deployment script automates several steps to ensure a smooth integration between AWS DataSync and Azure services. Here's a breakdown of the deployment process:
+![Azure CLI Login](./docs/Azure-Authentication.png)
 
-1. Provide Configuration Parameters: Before executing the script, open it in your preferred editor and provide the necessary configuration parameters. These parameters will be used to customize the deployment according to your requirements.
-2. Install Azure CLI and AzCopy: As a part of the setup process, the script will automatically download and install the Azure Command-Line Interface (CLI) and AzCopy tools. These tools are essential for managing and transferring data within the Azure environment.
-3. Download AWS DataSync Agent for Hyper-V: The script will download the AWS DataSync Agent specifically designed for Hyper-V environments. This agent enables efficient and secure data transfers between your Azure infrastructure and AWS.
-4. Convert VHDX to VHD: Once the AWS DataSync Agent is downloaded, the script will take care of converting the Virtual Hard Disk (VHDX) file to the compatible Hyper-V Disk (HVD) format, ensuring compatibility with Azure.
-5. Azure Authentication: To access and manage your Azure resources, the script will guide you through the authentication process, ensuring secure access to your Azure account.
-6. Create Resource Group: The deployment script will automatically create a dedicated Azure Resource Group using the provided name. This Resource Group will serve as the container for your deployed resources.
-7. Upload VHD as Managed Disk: The script will facilitate the seamless upload of the converted HVD file as a managed disk within the specified Resource Group. This disk will contain the AWS DataSync Agent.
-8. Create Virtual Machine: Leveraging the uploaded managed disk, the script will assist you in creating an Azure Virtual Machine in either a new VNET or an existing VNET. This Virtual Machine will host the AWS DataSync Agent and enable data synchronization between AWS and Azure.
+
+## Successful deployment to Azure.
+
+![Deployment Successful](./docs/DataSync-VM.png)
+
+### Logging
+The script includes logging with color-coded output:
+
+- 🔵 INFO
+- 🟡 WARNING
+- 🔴 ERROR
+- 🟢 SUCCESS
 
 ## Clean Up