Skip to content

Commit

Permalink
Improve queue docs (#5154) [ci skip]
Browse files Browse the repository at this point in the history

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Co-authored-by: Ben Sherman <bentshermann@gmail.com>
  • Loading branch information
pditommaso and bentsherman committed Jul 19, 2024
1 parent a437e97 commit bc2fb40
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
6 changes: 4 additions & 2 deletions docs/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ The `aws` command can be made available by either (1) installing it in the conta
To configure your pipeline for AWS Batch:

1. Specify the AWS Batch {ref}`executor <awsbatch-executor>`
2. Specify one or more AWS Batch queues with the {ref}`process-queue` directive
2. Specify the AWS Batch queue with the {ref}`process-queue` directive
3. Specify any Batch job container options with the {ref}`process-containerOptions` directive.

An example `nextflow.config` file is shown below:
Expand All @@ -212,7 +212,9 @@ aws {
}
```

Different queues bound to the same or different Compute Environments can be configured according to each process' requirements.
:::{tip}
Each process can be configured with its own queue by using the {ref}`process-queue` directive in the process definition or via {ref}`config-process-selectors` in your Nextflow configuration.
:::

## Container Options

Expand Down
16 changes: 4 additions & 12 deletions docs/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2370,18 +2370,10 @@ process grid_job {
}
```

Multiple queues can be specified by separating their names with a comma for example:

```groovy
process grid_job {
queue 'short,long,cn-el6'
executor 'sge'
"""
your task script here
"""
}
```
:::{tip}
Grid executors allow specifying multiple queue names separating them with a comma e.g. `queue 'short,long,cn-el6'`.
However, this does not generally apply to other executors such as AWS Batch, Azure Batch, Google Batch.
:::

:::{note}
This directive is only used by certain executors. Refer to the {ref}`executor-page` page to see which executors support this directive.
Expand Down

0 comments on commit bc2fb40

Please sign in to comment.