Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CROM-6893 Add in Azure into documentation as TES backend. #6773

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Many users today run their WDL workflows in [Terra](https://app.terra.bio/), a m

Users with specialized needs who wish to install and maintain their own Cromwell instances can [download](https://github.com/broadinstitute/cromwell/releases) a JAR or Docker image. The development team accepts reproducible bug reports from self-managed instances, but cannot feasibly provide direct support.

[Cromwell's backends](https://cromwell.readthedocs.io/en/stable/backends/Backends/) receive development resources proportional to user demand. The team is actively developing for Google Cloud and Microsoft Azure. Maintenance of other backends is primarily community-based.
[Cromwell's backends](https://cromwell.readthedocs.io/en/stable/backends/Backends/) receive development resources proportional to user demand. The team is actively developing for Google Cloud and Microsoft Azure (see [Cromwell on Azure](https://github.com/microsoft/CromwellOnAzure)). Maintenance of other backends is primarily community-based.

Cromwell [supports](https://cromwell.readthedocs.io/en/stable/LanguageSupport/) the WDL workflow language. Cromwell version 80 and above no longer support CWL.

Expand Down
9 changes: 9 additions & 0 deletions docs/backends/Azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**Azure**

[Cromwell on Azure](https://github.com/microsoft/CromwellOnAzure) configures all Azure resources needed to run
workflows through Cromwell on the Azure cloud, and uses the [GA4GH TES](TES) backend for
orchestrating the tasks that create a workflow.

Check out the [getting started guide](https://github.com/microsoft/CromwellOnAzure#Deploy-your-instance-of-Cromwell-on-Azure) for how to setup your environment.

Have an existing WDL file that you want to run on Azure? [Modify your existing WDL with these adaptations for Azure](https://github.com/microsoft/CromwellOnAzure/blob/main/docs/change-existing-WDL-for-Azure.md/#How-to-modify-an-existing-WDL-file-to-run-on-Cromwell-on-Azure)
17 changes: 10 additions & 7 deletions docs/backends/TES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ echo $? > rc

**Configuring**

Configuring the TES backend is straightforward; one must only provide the TES API endpoint for the service.
Configuring the TES backend is straightforward; one must only provide the TES API endpoint for the service.

```hocon
backend {
Expand All @@ -42,7 +42,7 @@ backend {

**Supported File Systems**

Currently this backend only works with files on a Local or Shared File System.
Currently this backend only works with files on a Local or Shared File System.

**Docker**

Expand All @@ -51,22 +51,25 @@ This backend supports the following optional [Runtime Attributes](../RuntimeAttr
* `docker`: Docker image to use such as "Ubuntu".
* `dockerWorkingDir`: defines the working directory in the container.

**CPU, Memory and Disk**
**CPU, Memory and Disk**

This backend supports CPU, memory and disk size configuration through the use of the following [Runtime Attributes](../RuntimeAttributes) and [Workflow Options](../wf_options/Overview/):

* `cpu` defines the amount of CPU to use.
* `cpu` defines the amount of CPU to use.
* Type: Integer (ex: 4)
* `memory` defines the amount of memory to use.
* `memory` defines the amount of memory to use.
* Type: String (ex: "4 GB" or "4096 MB")
* `disk` defines the amount of disk to use.
* `disk` defines the amount of disk to use.
* Type: String (ex: "1 GB" or "1024 MB")
* `preemptible` defines whether or not to use preemptible VMs.
* `preemptible` defines whether or not to use preemptible VMs.
* Type: Boolean (ex: "true" or "false")
* Integers are accepted and will be converted to boolean (true if > 0)

If they are not set, the TES backend may use default values.

**Azure**
[Azure](Azure) is an implementation of Cromwell that uses the TES interface for orchestrating the tasks on Azure.

**TESK**

[TESK](https://github.com/EMBL-EBI-TSI/TESK) is an implementation of the TES interface that uses Kubernetes and FTP.
Expand Down