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

Commit 560bc22

Browse files
authored
Update cromwell-overview.md
1 parent e412656 commit 560bc22

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/orchestration/cromwell/cromwell-overview.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
system for scientific workflows developed by the [Broad Institute](https://broadinstitute.org/)
77
and supports job execution using [AWS Batch](https://aws.amazon.com/batch/).
88

9-
## TL;DR
9+
## Full Stack Deployment (TL;DR)
1010

1111
If you need a Cromwell server backed by AWS **now** and will worry about the
1212
details later, use the CloudFormation template below.
@@ -16,7 +16,8 @@ details later, use the CloudFormation template below.
1616
{{ cfn_stack_row("Cromwell All-in-One", "Cromwell", "cromwell/cromwell-aio.template.yaml", "Create all resources needed to run Cromwell on AWS: an S3 Bucket, AWS Batch Environment, and Cromwell Server Instance") }}
1717

1818
When the above stack is complete, navigate to the `HostName` that is generated
19-
in the outputs to access Cromwell via its SwaggerUI.
19+
in the outputs to access Cromwell via its SwaggerUI, which provides a simple web interface for submitting workflows.
20+
2021

2122
![cromwell on aws](images/cromwell-all-in-one.png)
2223

@@ -36,7 +37,7 @@ these setup.
3637
!!! note
3738
For a Cromwell server that will run multiple workflows, or workflows with many
3839
steps (e.g. ones with large scatter steps), it is recommended to setup a
39-
database to use to store workflow metadata.
40+
database to store workflow metadata.
4041

4142
## Custom Compute Resource with Cromwell Additions
4243

@@ -49,7 +50,7 @@ Once complete, you will have a resource ID to give to AWS Batch to setup compute
4950

5051
## Cromwell Server
5152

52-
To ensure the highest level of security, and robustness for long running workflows,
53+
To ensure the highest level of security and robustness for long running workflows,
5354
it is recommended that you use an EC2 instance as your Cromwell server for submitting
5455
workflows to AWS Batch.
5556

@@ -222,7 +223,7 @@ backend {
222223

223224
The above file uses the [default credential provider chain](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) for authorization.
224225

225-
Replace the following with values appropriate for your accoutn and workload:
226+
Replace the following with values appropriate for your account and workload:
226227

227228
* `<your region>` : the AWS region your S3 bucket and AWS Batch environment are
228229
deployed into - e.g. `us-east-1`
@@ -235,7 +236,7 @@ Replace the following with values appropriate for your accoutn and workload:
235236

236237
!!! note
237238
The CloudFormation template above automatically starts Cromwell on launch.
238-
Use the instructions below are if you are provisioning your own EC2 instance.
239+
Use the instructions below if you are provisioning your own EC2 instance.
239240

240241
Log into your server using SSH. If you setup a port tunnel, you can interact
241242
with Cromwell's REST API from your local machine:
@@ -266,13 +267,13 @@ your local machine by navigating to:
266267

267268
## Running a workflow
268269

269-
To submit a workflow to your Cromwell server, you can use:
270+
To submit a workflow to your Cromwell server, you can use any of the following:
270271

271272
* Cromwell's SwaggerUI in a web-browser
272273
* a REST client like [Insomnia](https://insomnia.rest/) or [Postman](https://www.getpostman.com/)
273-
* or, the command line with `curl`
274+
* the command line with `curl`
274275

275276
After submitting a workflow, you can monitor the progress of tasks via the
276277
AWS Batch console.
277278

278-
The next section provides some examples of running Crommwell on AWS.
279+
The next section provides some examples of running Crommwell on AWS.

0 commit comments

Comments
 (0)