Skip to content

Commit b426bb9

Browse files
authored
Update README.md
Added additional options for existing Azure vNet and Subnet
1 parent ed19a43 commit b426bb9

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,42 @@ 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
14+
15+
- *Deployment Type (`-d`):* Choose whether you want to use a `new_vnet` or an `existing_vnet`.
1316
- *Location (`-l`):* The Azure region where you want to deploy your resources, such as `eastus`.
1417
- *Resource Group (`-r`):* The name of the Azure Resource Group where the deployed resources will be managed, e.g., `aws-datasync-rg`.
1518
- *Virtual Machine Name (`-v`):* The desired name for the Azure Virtual Machine that will host the AWS DataSync Agent, for example, `datasync-vm`.
1619

20+
#### The following parameters are mandatory when the value of `-d` is `existing_vnet`
21+
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`
25+
1726
---
1827

1928
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
2029

2130
![Amazon EC2 Launch Instance](./docs/datasync.png)
2231

32+
### Download the Deployment Script
33+
34+
Run the following command to download the deployment script from the code repository.
35+
36+
`curl -sLO https://raw.githubusercontent.com/aws-samples/aws-datasync-deploy-agent-azure/main/src/bash/datasync.sh`
37+
2338
### Running the Deployment Script
2439

2540
Once you have your parameters ready, you can initiate the deployment script using the following command:
2641

27-
sudo bash datasync.sh -l eastus -r aws-datasync-rg -v datasync-vm
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+
46+
If you would like to deploy the DataSync VM in an existing VNET:
2847

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`
2949

3050
## Deployment Steps
3151

@@ -53,7 +73,7 @@ The deployment script automates several steps to ensure a smooth integration bet
5373
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.
5474

5575
8. *Create Virtual Machine:*
56-
Leveraging the uploaded managed disk, the script will assist you in creating an Azure Virtual Machine. This Virtual Machine will host the AWS DataSync Agent and enable data synchronization between AWS and Azure.
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.
5777

5878
## Clean Up
5979

@@ -62,7 +82,6 @@ Once the deployment script has successfully executed and the AWS DataSync Agent
6282
- *Delete Amazon Linux EC2 Instance:*
6383
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.
6484

65-
6685
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.
6786

6887
## Security
@@ -72,4 +91,3 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
7291
## License
7392

7493
This library is licensed under the MIT-0 License. See the LICENSE file.
75-

0 commit comments

Comments
 (0)