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

Commit 2fd1b1e

Browse files
committed
Add docs Custom Distribution section
1 parent ce8f22b commit 2fd1b1e

File tree

7 files changed

+73
-0
lines changed

7 files changed

+73
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Building Custom Resources
2+
3+
This section describes how to build and upload customized templates and artifacts.
4+
5+
## Building a Custom Distribution
6+
7+
## Deploying a custom Distribution

docs/core-env/custom-deploy.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Customized Templates and Artifacts
2+
3+
Deployments of the 'Nextflow on AWS Batch' solution are based on nested CloudFormation templates, and on artifacts comprising scripts, software packages, and configuration files. The templates and artifacts are stored in S3 buckets, and their S3 URLs are used when launching the top-level template and as parameters to that template's deployment.
4+
5+
## VPC
6+
The quick start link deploys the [AWS VPC Quickstart](https://aws.amazon.com/quickstart/architecture/vpc/), which creates a VPC with up to 4 Availability Zones, each with a public subnet and a private subnet with NAT Gateway access to the Internet.
7+
8+
## Genomics Workflow Core
9+
This quick start link deploys the CloudFormation template `gwfcore-root.template.yaml` for the Genomics Workflow Core (GWFCore) from the [Genomics Workflows on AWS](https://github.com/aws-samples/aws-genomics-workflows) solution. This template launches a number of nested templates, as shown below:
10+
11+
* Root Stack __gwfcore-root__ - Top level template for Genomics Workflow Core
12+
* S3 Stack __gwfcore-s3__ - S3 bucket (new or existing) for storing analysis results
13+
* IAM Stack __gwfcore-iam__ - Creates IAM roles to use with AWS Batch scalable genomics workflow environment
14+
* Code Stack __gwfcore-code__ - Creates AWS CodeCommit repos and CodeBuild projects for Genomics Workflows Core assets and artifacts
15+
* Launch Template Stack __gwfcore-launch-template__ - Creates an EC2 Launch Template for AWS Batch based genomics workflows
16+
* Batch Stack __gwfcore-batch__ - Deploys resource for a AWS Batch environment that is suitable for genomics, including default and high-priority JobQueues
17+
18+
### Root Stack
19+
The quick start solution links to the CloudFormation console, where the 'Amazon S3 URL' field is prefilled with the S3 URL of a copy of the root stack template, hosted in the public S3 bucket __aws-genomics-workflows__.
20+
21+
<img src="https://dpkk088kye7gn.cloudfront.net/aws-genomics-workflows/docs/images/custom-deploy-0.png"
22+
alt="custom-deploy-0"
23+
width="100%" height="100%"
24+
class="screenshot" />
25+
26+
To use a customized root stack, upload your modified stack template to an S3 bucket (see [Building a Custom Distribution](build-custom-distribution.md)), and specify that template's URL in 'Amazon S3 URL'.
27+
28+
### Artifacts and Nested Stacks
29+
The subsequent screen, 'Specify Stack Details', allows for customization of the deployed resources in the 'Distribution Configuration' section.
30+
31+
<img src="https://dpkk088kye7gn.cloudfront.net/aws-genomics-workflows/docs/images/custom-deploy-1.png"
32+
alt="custom-deploy-1"
33+
width="70%" height="70%"
34+
class="screenshot" />
35+
36+
* __Artifact S3 Bucket Name__ and __Artifact S3 Prefix__ define the location of the artifacts uploaded prior to this deployment. By default, pre-prepared artifacts are stored in the __aws-genomics-workflows__ bucket.
37+
* __Template Root URL__ defines the bucket and prefix used to store nested templates, called by the root template.
38+
39+
To use your own modified artifacts or nested templates, build and upload as described in [Building a Custom Distribution](build-custom-distribution.md), and specify the bucket and prefix in the fields above.
40+
41+
## Workflow Orchestrators
42+
### Nextflow
43+
This quick start deploys the Nextflow template `nextflow-resources.template.yaml`, which launches one nested stack:
44+
45+
* Root Stack __nextflow-resources__ - Creates resources specific to running Nextflow on AWS
46+
* Container Build Stack __container-build__ - Creates resources for building a Docker container image using CodeBuild, storing the image in ECR, and optionally creating a corresponding Batch Job Definition
47+
48+
The nextflow root stack is specified in the same way as the GWFCore root stack, above, and a location for a modified root stack may be specified as with the Core stack.
49+
50+
The subsequent 'Specify Stack Details' screen has fields allowing the customization of the Nextflow deployment.
51+
52+
<img src="https://dpkk088kye7gn.cloudfront.net/aws-genomics-workflows/docs/images/nextflow-0.png"
53+
alt="nextflow-0"
54+
width="70%" height="70%"
55+
class="screenshot" />
56+
57+
* __S3NextflowPrefix__, __S3LogsDirPrefix__, and __S3WorkDirPrefix__ specify the path within the GWFCore bucket in which to store per-run data and log files.
58+
* __TemplateRootUrl__ specifies the path to the nested templates called by the Nextflow root template, as with the GWFCore root stack.

docs/extra.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,10 @@
5757

5858
.md-header, .md-footer, .md-footer-nav, .md-footer-meta {
5959
background-color: #232f3e !important;
60+
}
61+
62+
.screenshot {
63+
style: "float: left";
64+
margin: 10px;
65+
border: 1px solid lightgrey;
6066
}

docs/images/custom-deploy-0.png

126 KB
Loading

docs/images/custom-deploy-1.png

93.9 KB
Loading

docs/images/nextflow-0.png

121 KB
Loading

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ nav:
99
- Permissions: core-env/create-iam-roles.md
1010
- Compute Resources: core-env/create-custom-compute-resources.md
1111
- AWS Batch: core-env/setup-aws-batch.md
12+
- Customized Deployment: core-env/custom-deploy.md
13+
- Building a Custom Distribution: core-env/build-custom-distribution.md
1214
# - Containerized Tooling:
1315
# - Introduction: containers/container-introduction.md
1416
# - Examples: containers/container-examples.md

0 commit comments

Comments
 (0)