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

Commit 718d368

Browse files
authored
Merge pull request #26 from wleepang/nextflow-updates
update nextflow documentation
2 parents 17807d1 + 1eda8fe commit 718d368

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/orchestration/nextflow/nextflow-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ To get started using Nextflow on AWS you'll need the following setup in your AWS
2727
* An IAM Role for the Nextflow head node job that allows it access to AWS Batch
2828
* (optional) An S3 Bucket to store your Nextflow workflow definitions
2929

30-
The last four items above are created by the following CloudFormation template:
30+
The last five items above are created by the following CloudFormation template:
3131

3232
| Name | Description | Source | Launch Stack |
3333
| -- | -- | :--: | -- |
34-
{{ cfn_stack_row("Nextflow Resources", "NextflowResources", "nextflow/nextflow-resources.template.yaml", "Create Nextflow specific resources needed to run on AWS: an S3 Bucket for nextflow workflow scripts, AWS Batch Job Definition for a Nextflow head node, and an IAM role for the nextflow head node job") }}
34+
{{ cfn_stack_row("Nextflow Resources", "NextflowResources", "nextflow/nextflow-resources.template.yaml", "Create Nextflow specific resources needed to run on AWS: an S3 Bucket for nextflow workflow scripts, Nextflow container, AWS Batch Job Definition for a Nextflow head node, and an IAM role for the nextflow head node job") }}
3535

3636
### Nextflow container
3737

38-
For AWS Batch to run Nextflow as a Batch Job, it needs to be containerized. In the process of doing so you can add the ability to automatically create a config file based on environment variables passed in by Batch and use workflow scripts that are stored in S3.
38+
For AWS Batch to run Nextflow as a Batch Job, it needs to be containerized. The template above will build a container using the methods described below which includes adding capabilities to automatically configure Nextflow and run workflow scripts in S3. If you want to add specialized capabilities or require a particular version of Nextflow, you can modify the source code to best suit your needs.
3939

4040
To create such a container, you can use a `Dockerfile` like the one below:
4141

@@ -65,7 +65,7 @@ ENTRYPOINT ["/opt/bin/nextflow.aws.sh"]
6565
!!! note
6666
If you are trying to keep your container image as small as possible, keep in mind that Nextflow relies on basic linux tools such as `awk`, `bash`, `ps`, `date`, `sed`, `grep`, `egrep`, and `tail` which may need to be installed on extra minimalist base images like `alpine`.
6767

68-
The script used for the entrypoint is:
68+
The script used for the entrypoint is shown below. Notice that it automatically configures Nextflow based on environment variables set by AWS Batch.
6969

7070
```bash
7171
#!/bin/bash

0 commit comments

Comments
 (0)