Skip to content

Commit e0a7309

Browse files
authored
Update README.md
Updated ReadMe
1 parent 94635aa commit e0a7309

File tree

1 file changed

+41
-46
lines changed

1 file changed

+41
-46
lines changed

README.md

Lines changed: 41 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AWS DataSync Deployment for Azure
22

3-
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.
3+
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.
44

55
## Getting Started
66

@@ -10,84 +10,79 @@ To begin the deployment process, ensure that you have the necessary prerequisite
1010

1111
Before running the deployment script, please ensure that you have the following parameters readily available:
1212

13-
#### The following parameters are mandatory
13+
** 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.**
1414

15-
- *Deployment Type (`-d`):* Choose whether you want to use a `new_vnet` or an `existing_vnet`.
16-
- *Location (`-l`):* The Azure region where you want to deploy your resources, such as `eastus`.
17-
- *Resource Group (`-r`):* The name of the Azure Resource Group where the deployed resources will be managed, e.g., `aws-datasync-rg`.
18-
- *Virtual Machine Name (`-v`):* The desired name for the Azure Virtual Machine that will host the AWS DataSync Agent, for example, `datasync-vm`.
15+
Parameters:
1916

20-
#### The following parameters are mandatory when the value of `-d` is `existing_vnet`
17+
**Mandatory Parameters:**
18+
- **Deployment Type (-d)**: Choose whether you want to use a new_vnet or an existing_vnet.
19+
- **Location (-l)**: The Azure region where you want to deploy your resources, such as eastus.
20+
- **Resource Group (-r)**: The name of the Azure Resource Group where the deployed resources will be managed, e.g., aws-datasync-rg.
21+
- **Virtual Machine Name (-v)**: The desired name for the Azure Virtual Machine that will host the AWS DataSync Agent, for example, datasync-vm.
2122

22-
- *VNET Resource Group (`-g`):* The name of the Azure Resource Group with the existing VNET, e.g., `existing-vnet-rg`
23-
- *VNET Name (`-n`):* The name of the existing VNET, e.g., `existing-vnet`
24-
- *Subnet Name (`-s`):* The name of the subnet that exists in the VNET, e.g., `existing-subnet`
23+
**Optional Parameters (when -d is existing_vnet):**
24+
- **VNET Resource Group (-g)**: The name of the Azure Resource Group with the existing VNET, e.g., existing-vnet-rg.
25+
- **VNET Name (-n)**: The name of the existing VNET, e.g., existing-vnet.
26+
- **Subnet Name (-s)**: The name of the subnet that exists in the VNET, e.g., existing-subnet.
2527

2628
---
2729

2830
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
2931

3032
![Amazon EC2 Launch Instance](./docs/datasync.png)
3133

34+
3235
### Download the Deployment Script
3336

34-
Run the following command to download the deployment script from the code repository.
37+
Run the following command to download the deployment script from the code repository:
3538

36-
`curl -sLO https://raw.githubusercontent.com/aws-samples/aws-datasync-deploy-agent-azure/main/src/bash/datasync.sh`
39+
```
40+
curl -sLO https://raw.githubusercontent.com/aws-samples/aws-datasync-deploy-agent-azure/main/src/bash/datasync.sh
41+
```
3742

3843
### Running the Deployment Script
3944

40-
Once you have your parameters ready, you can initiate the deployment script using the following command:
41-
42-
If you would like to deploy the DataSync VM in a new VNET:
43-
44-
`sudo bash datasync.sh -d new_vnet -l eastus -r aws-datasync-rg -v datasync-vm`
45+
Once you have your parameters ready, you can initiate the deployment script using the following commands:
4546

46-
If you would like to deploy the DataSync VM in an existing VNET:
47+
For new_vnet deployment:
48+
```
49+
sudo bash datasync.sh -d new_vnet -l eastus -r aws-datasync-rg -v datasync-vm
50+
```
4751

48-
`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`
52+
For existing_vnet deployment:
53+
```
54+
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
55+
```
4956

5057
## Deployment Steps
5158

5259
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:
5360

54-
1. *Provide Configuration Parameters:*
55-
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.
56-
57-
2. *Install Azure CLI and AzCopy:*
58-
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.
59-
60-
3. *Download AWS DataSync Agent for Hyper-V:*
61-
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.
62-
63-
4. *Convert VHDX to VHD:*
64-
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.
65-
66-
5. *Azure Authentication:*
67-
To access and manage your Azure resources, the script will guide you through the authentication process, ensuring secure access to your Azure account.
68-
69-
6. *Create Resource Group:*
70-
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.
71-
72-
7. *Upload VHD as Managed Disk:*
73-
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.
74-
75-
8. *Create Virtual Machine:*
76-
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.
61+
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.
62+
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.
63+
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.
64+
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.
65+
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.
66+
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.
67+
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.
68+
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.
7769

7870
## Clean Up
7971

8072
Once the deployment script has successfully executed and the AWS DataSync Agent is seamlessly integrated with Azure, you can consider cleaning up your environment:
8173

82-
- *Delete Amazon Linux EC2 Instance:*
83-
The Amazon Linux EC2 instance that was used for the deployment can be safely deleted. The script will have completed its tasks, and the instance is no longer required for the ongoing operation of the integration.
74+
1. Delete Amazon Linux EC2 Instance: The Amazon Linux EC2 instance that was used for the deployment can be safely deleted. The script will have completed its tasks, and the instance is no longer required for the ongoing operation of the integration.
8475

85-
Thank you for using the *AWS DataSync Deployment for Azure* repository. We hope this tool proves valuable in streamlining your data synchronization between AWS and Azure environments.
76+
Thank you for using the AWS DataSync Deployment for Azure repository. We hope this tool proves valuable in streamlining your data synchronization between AWS and Azure environments.
8677

8778
## Security
8879

89-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
80+
See CONTRIBUTING for more information.
9081

9182
## License
9283

9384
This library is licensed under the MIT-0 License. See the LICENSE file.
85+
86+
## About
87+
88+
VHDX to VHD Conversion Tool for AWS DataSync

0 commit comments

Comments
 (0)