Skip to content
This repository was archived by the owner on Aug 9, 2023. It is now read-only.

Commit ec7333b

Browse files
authored
Update tldr.md
Note: Launch for VPC stack also downloads the yaml file and doesn't open the AWS console.
1 parent 7afd16a commit ec7333b

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/tldr.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# TL;DR - For the impatient
1+
# TL;DR - For rapid deployment
22

3-
## Core resources
3+
## Step 0: Amazon VPC
44

5-
### Amazon VPC
6-
7-
While you can use an existing "default" VPC to implement deployment of your genomics environment, we strongly recommend utilizing a VPC with private subnets for the processing sensitive data with AWS Batch. Doing so will restrict access to the instances from the internet, and help meet security and compliance requirements, such as [dbGaP](http://j.mp/aws-dbgap).
5+
While you can use an existing "default" VPC to implement deployment of your genomics environment, we strongly recommend utilizing a VPC with private subnets for processing sensitive data with AWS Batch. Doing so will restrict access to the instances from the internet, and help meet security and compliance requirements, such as [dbGaP](http://j.mp/aws-dbgap).
86

97

108
!!! tip
@@ -19,13 +17,15 @@ While you can use an existing "default" VPC to implement deployment of your geno
1917

2018
| Name | Description | Source | Launch Stack |
2119
| -- | -- | :--: | :--: |
22-
{{ cfn_stack_row("VPC", "GenomicsVPC", "https://aws-quickstart.s3.amazonaws.com/quickstart-aws-vpc/templates/aws-vpc.template", "(Optional) Creates a new Virtual Private Cloud to use for your genomics workflow resources.") }}
20+
{{ cfn_stack_row("VPC (Optional)", "GenomicsVPC", "https://aws-quickstart.s3.amazonaws.com/quickstart-aws-vpc/templates/aws-vpc.template", "Creates a new Virtual Private Cloud to use for your genomics workflow resources.") }}
2321

2422
The above template uses the AWS Quickstart reference for a [Modular and Scalable VPC Architecture](https://aws.amazon.com/quickstart/architecture/vpc/) and provides a networking foundation for AWS Cloud infrastructures, deploying an Amazon Virtual Private Cloud (Amazon VPC) according to AWS best practices and guidelines.
2523

2624
For architectural details, best practices, step-by-step instructions, and customization options, see the [deployment guide](https://fwd.aws/9VdxN).
2725

28-
### Full stack
26+
## Step 1: Compute Environment
27+
28+
### Option A: Full stack
2929

3030
The "Full Stack" CloudFormation template below will create all of the AWS resources required - S3 Bucket, EC2 Launch Templates, IAM Roles, Batch Compute Environments, Batch Job Queues - for your genomics workflow environment into an existing VPC.
3131

@@ -43,20 +43,20 @@ Once completed, click on the `Outputs` tab and copy down the AWS Batch Job Queue
4343

4444
![CloudFormation web console wizard output job queue ARN](./images/root-vpc-5.png)
4545

46-
### Individual components
46+
### Option B: Individual components
4747

4848
The CloudFormation templates above are [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), a hierarchy of templates that pass values from a parent template to dependent templates.
4949

5050
Below are the stand-alone CloudFormation templates for S3, IAM, and AWS Batch. These are handy in case you need to modify the individual components, or need to have another individual with elevated privileges to execute one of them (e.g. the IAM template). They are in order of dependency, and you will need to provide output values from one template to the dependent templates.
5151

5252
| Name | Description | Source | Launch Stack |
5353
| -- | -- | :--: | :--: |
54-
{{ cfn_stack_row("Amazon IAM Roles", "GenomicsWorkflow-IAM", "aws-genomics-iam.template.yaml", "Create the necessary IAM Roles. This is useful to hand to someone with the right permissions to create these on your behalf. _You will need to provide a S3 bucket name_.") }}
54+
{{ cfn_stack_row("Amazon IAM Roles", "GenomicsWorkflow-IAM", "aws-genomics-iam.template.yaml", "Create the necessary IAM Roles. This is useful to hand to someone with the right permissions to create these on your behalf. _You will need to provide an Amazon S3 bucket name_.") }}
5555
{{ cfn_stack_row("EC2 Launch Template", "GenomicsWorkflow-LT", "aws-genomics-launch-template.template.yaml", "Creates an EC2 Launch Template that provisions instances on first boot for processing genomics workflow tasks.") }}
56-
{{ cfn_stack_row("Amazon S3 Bucket", "GenomicsWorkflow-S3", "aws-genomics-s3.template.yaml", "Creates a secure Amazon S3 bucket to read from and write results to.") }}
56+
{{ cfn_stack_row("Amazon S3 Bucket", "GenomicsWorkflow-S3", "aws-genomics-s3.template.yaml", "Creates a secure Amazon S3 bucket to read inputs and write results.") }}
5757
{{ cfn_stack_row("AWS Batch", "GenomicsWorkflow-Batch", "aws-genomics-batch.template.yaml", "Creates AWS Batch Job Queues and Compute Environments. You will need to provide the details on IAM roles and instance profiles, and the IDs for a VPC and subnets.") }}
5858

59-
## Worklow Orchestrators
59+
## Step 3: Worklow Orchestrators
6060

6161
| Name | Description | Source | Launch Stack |
6262
| -- | -- | :--: | :--: |

0 commit comments

Comments
 (0)