You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Restructure the AWS Batch page in cloud, remove mentions of external repo, start fixing manual batch page
* S3/EFS/FSx work dir must be in the same region as compute
* Expand instructions on how to setup EFS/FSx SG
* lowercase S3 bucket in section title
* Fix internal links
* Outbound EFS/FSx rules must allow 0./0
* Remove references to nf-tower-aws from cloud repo
* Document role to assume instead of attaching policy directly to user
* Apply suggestions from code review
Co-authored-by: Justine Geffen <[email protected]>
Signed-off-by: Alberto Chiusole <[email protected]>
* Update manual-aws-batch-setup.mdx
Signed-off-by: Justine Geffen <[email protected]>
---------
Signed-off-by: Alberto Chiusole <[email protected]>
Signed-off-by: Justine Geffen <[email protected]>
Co-authored-by: Justine Geffen <[email protected]>
Copy file name to clipboardExpand all lines: platform-cloud/docs/compute-envs/eks.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ After you have prepared your Kubernetes cluster and assigned a service account r
69
69
1. Add the IAM user **Access key** and **Secret key**. This is the IAM user with the service account role detailed in the previous section.
70
70
1. (Optional) Under **Assume role**, specify the IAM role to be assumed by the Seqera IAM user to access the compute environment AWS resources.
71
71
:::note
72
-
When using AWS keys without an assumed role, the associated AWS user account must have Seqera [Launch](https://github.com/seqeralabs/nf-tower-aws/tree/master/launch) and [Forge](https://github.com/seqeralabs/nf-tower-aws/tree/master/forge) permissions. When an assumed role is provided, the keys are only used to retrieve temporary credentials impersonating the role specified. In this case, Seqera [Launch](https://github.com/seqeralabs/nf-tower-aws/tree/master/launch) and [Forge](https://github.com/seqeralabs/nf-tower-aws/tree/master/forge) permissions must be granted to the role instead of the user account.
72
+
When using AWS keys without an assumed role, the associated AWS user account must have all the appropriate [IAM permissions](./aws-batch.md#required-platform-iam-permissions). When an assumed role is provided, the keys are only used to retrieve temporary credentials impersonating the role specified: in this case, the permissions must be granted to the role instead of the user account, and the user must have the `sts:AssumeRole` permission for the role (see [AWS Batch IAM role creation (optional)](./aws-batch.md#iam-role-creation-optional)).
73
73
:::
74
74
1. Select a **Region**, e.g., _eu-west-1 - Europe (Ireland)_.
75
75
1. Select a **Cluster name** from the list of available EKS clusters in the selected region.
@@ -85,9 +85,9 @@ After you have prepared your Kubernetes cluster and assigned a service account r
85
85
1. Apply [**Resource labels**](../resource-labels/overview) to the cloud resources consumed by this compute environment. Workspace default resource labels are prefilled.
86
86
1. Expand **Staging options** to include:
87
87
- Optional [pre- or post-run Bash scripts](../launch/advanced#pre-and-post-run-scripts) that execute before or after the Nextflow pipeline execution in your environment.
88
-
- Global Nextflow configuration settings for all pipeline runs launched with this compute environment. Values defined here are pre-filled in the **Nextflow config file** field in the pipeline launch form. These values can be overridden during pipeline launch.
88
+
- Global Nextflow configuration settings for all pipeline runs launched with this compute environment. Values defined here are pre-filled in the **Nextflow config file** field in the pipeline launch form. These values can be overridden during pipeline launch.
89
89
:::info
90
-
Configuration settings in this field override the same values in the pipeline repository `nextflow.config` file. See [Nextflow config file](../launch/advanced#nextflow-config-file) for more information on configuration priority.
90
+
Configuration settings in this field override the same values in the pipeline repository `nextflow.config` file. See [Nextflow config file](../launch/advanced#nextflow-config-file) for more information on configuration priority.
91
91
:::
92
92
1. Specify custom **Environment variables** for the **Head job** and/or **Compute jobs**.
93
93
1. Configure any advanced options described in the next section, as needed.
@@ -191,4 +191,3 @@ To use [Fusion v2](https://docs.seqera.io/fusion) in your Seqera EKS compute env
191
191
See the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) for further details.
Copy file name to clipboardExpand all lines: platform-cloud/docs/data/data-explorer.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Data Explorer lists public and private data repositories. Repositories accessibl
22
22
23
23
-**Retrieve data repositories with workspace credentials**
24
24
25
-
Private data repositories accessible to the credentials defined in your workspace are listed in Data Explorer automatically. The permissions required for your [AWS](../compute-envs/aws-batch#iam), [Google Cloud](../compute-envs/google-cloud-batch#iam), [Azure Batch](../compute-envs/azure-batch#storage-account), or Amazon S3-compatible API storage: credentials allow full Data Explorer functionality.
25
+
Private data repositories accessible to the credentials defined in your workspace are listed in Data Explorer automatically. The permissions required for your [AWS](../compute-envs/aws-batch#required-platform-iam-permissions), [Google Cloud](../compute-envs/google-cloud-batch#iam), [Azure Batch](../compute-envs/azure-batch#storage-account), or Amazon S3-compatible API storage: credentials allow full Data Explorer functionality.
26
26
27
27
-**Configure individual data repositories manually**
Copy file name to clipboardExpand all lines: platform-cloud/docs/enterprise/advanced-topics/manual-aws-batch-setup.mdx
+9-45Lines changed: 9 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,11 @@ import TabItem from '@theme/TabItem';
11
11
This page describes how to set up AWS roles and Batch queues manually for the deployment of Nextflow workloads with Seqera Platform.
12
12
13
13
:::tip
14
-
Manual AWS Batch configuration is only necessary if you don't use Batch Forge.
15
-
16
-
Batch Forge _automatically creates_ the AWS Batch queues required for your workflow executions.
14
+
Manual AWS Batch configuration is only necessary if you don't want to let Seqera Platform create the required AWS Batch resources in your AWS account automatically, done using the internal tool called Batch Forge.
17
15
:::
18
16
19
-
Complete the following procedures to configure AWS Batch manually:
17
+
Complete the following steps to configure the AWS Batch resources needed by Seqera Platform:
20
18
21
-
1. Create a user policy.
22
19
2. Create the instance role policy.
23
20
3. Create the AWS Batch service role.
24
21
4. Create an EC2 Instance role.
@@ -27,39 +24,6 @@ Complete the following procedures to configure AWS Batch manually:
27
24
7. Create the AWS Batch compute environments.
28
25
8. Create the AWS Batch queue.
29
26
30
-
### Create a user policy
31
-
32
-
Create the policy for the user launching Nextflow jobs:
33
-
34
-
1. In the [IAM Console](https://console.aws.amazon.com/iam/home), select **Create policy** from the Policies page.
35
-
1. Create a new policy with the following content:
36
-
37
-
```json
38
-
{
39
-
"Version": "2012-10-17",
40
-
"Statement": [
41
-
{
42
-
"Sid": "Stmt1530313170000",
43
-
"Effect": "Allow",
44
-
"Action": [
45
-
"batch:CancelJob",
46
-
"batch:RegisterJobDefinition",
47
-
"batch:DescribeComputeEnvironments",
48
-
"batch:DescribeJobDefinitions",
49
-
"batch:DescribeJobQueues",
50
-
"batch:DescribeJobs",
51
-
"batch:ListJobs",
52
-
"batch:SubmitJob",
53
-
"batch:TerminateJob"
54
-
],
55
-
"Resource": ["*"]
56
-
}
57
-
]
58
-
}
59
-
```
60
-
61
-
1. Save with it the name `seqera-user`.
62
-
63
27
### Create the instance role policy
64
28
65
29
Create the policy with a role that allows Seqera to submit Batch jobs on your EC2 instances:
@@ -174,7 +138,7 @@ Create a launch template to configure the EC2 instances deployed by Batch jobs:
@@ -276,8 +240,8 @@ Create a launch template to configure the EC2 instances deployed by Batch jobs:
276
240
277
241
### Create the Batch compute environments
278
242
279
-
:::caution
280
-
AWS Graviton instances (ARM64 CPU architecture) are not supported in manual compute environments. To use Graviton instances, create your AWS Batch compute environment with [Batch Forge](../../compute-envs/aws-batch#batch-forge-compute-environment).
243
+
:::caution
244
+
AWS Graviton instances (ARM64 CPU architecture) are not supported in manual compute environments. To use Graviton instances, create your AWS Batch compute environment with [Batch Forge](../../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment).
281
245
:::
282
246
283
247
Nextflow makes use of two job queues during workflow execution:
@@ -301,7 +265,7 @@ The head queue requires an on-demand compute environment. Do not select **Use Sp
301
265
1. In the [Batch Console](https://eu-west-1.console.aws.amazon.com/batch/home), select **Create** on the Compute environments page.
302
266
1. Select **Amazon EC2** as the compute environment configuration.
303
267
:::note
304
-
Seqera AWS Batch compute environments created with [Batch Forge](../../compute-envs/aws-batch#batch-forge-compute-environment) support using Fargate for the head job, but manual compute environments must use EC2.
268
+
Seqera AWS Batch compute environments created with [Batch Forge](../../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) support using Fargate for the head job, but manual compute environments must use EC2.
305
269
:::
306
270
1. Enter a name of your choice, and apply the `seqera-servicerole` and `seqera-instancerole`.
307
271
1. Enter vCPU limits and instance types, if needed.
@@ -310,7 +274,7 @@ The head queue requires an on-demand compute environment. Do not select **Use Sp
310
274
:::
311
275
1. Expand **Additional configuration** and select the `seqera-launchtemplate` from the Launch template dropdown.
312
276
1. Configure VPCs, subnets, and security groups on the next page as needed.
313
-
1. Review your configuration and select **Create compute environment**.
277
+
1. Review your configuration and select **Create compute environment**.
314
278
315
279
</TabItem>
316
280
<TabItemvalue="Compute queue with Spot instances"label="Compute queue with Spot instances"default>
@@ -320,11 +284,11 @@ Create this compute environment to use Spot instances for your workflow compute
320
284
1. In the [Batch Console](https://eu-west-1.console.aws.amazon.com/batch/home), select **Create** on the Compute environments page.
321
285
1. Select **Amazon EC2** as the compute environment configuration.
322
286
1. Enter a name of your choice, and apply the `seqera-servicerole` and `seqera-instancerole`.
323
-
1. Select **Enable using Spot instances** to use Spot instances and save computing costs.
287
+
1. Select **Enable using Spot instances** to use Spot instances and save computing costs.
324
288
1. Select the `seqera-fleetrole` and enter vCPU limits and instance types, if needed.
325
289
1. Expand **Additional configuration** and select the `seqera-launchtemplate` from the Launch template dropdown.
326
290
1. Configure VPCs, subnets, and security groups on the next page as needed.
327
-
1. Review your configuration and select **Create compute environment**.
291
+
1. Review your configuration and select **Create compute environment**.
Copy file name to clipboardExpand all lines: platform-cloud/docs/getting-started/proteinfold.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ You will need the following to get started:
19
19
20
20
-[Admin](../orgs-and-teams/roles) permissions in an existing organization workspace. See [Set up your workspace](./workspace-setup) to create an organization and workspace from scratch.
21
21
- An existing AWS cloud account with access to the AWS Batch service.
22
-
- Existing access credentials with permissions to create and manage resources in your AWS account. See [IAM](../compute-envs/aws-batch#iam) for guidance to set up IAM permissions for Platform.
22
+
- Existing access credentials with permissions to create and manage resources in your AWS account. See [IAM](../compute-envs/aws-batch#required-platform-iam-permissions) for guidance to set up IAM permissions for Platform.
Copy file name to clipboardExpand all lines: platform-cloud/docs/getting-started/rnaseq.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ You will need the following to get started:
21
21
22
22
-[Admin](../orgs-and-teams/roles) permissions in an existing organization workspace. See [Set up your workspace](./workspace-setup) to create an organization and workspace from scratch.
23
23
- An existing AWS cloud account with access to the AWS Batch service.
24
-
- Existing access credentials with permissions to create and manage resources in your AWS account. See [IAM](../compute-envs/aws-batch#iam) for guidance to set up IAM permissions for Platform.
24
+
- Existing access credentials with permissions to create and manage resources in your AWS account. See [IAM](../compute-envs/aws-batch#required-platform-iam-permissions) for guidance to set up IAM permissions for Platform.
Copy file name to clipboardExpand all lines: platform-cloud/docs/getting-started/studios.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This guide explores how Studios integrates with your existing workflows, bridgin
13
13
You will need the following to get started:
14
14
15
15
- At least the **Maintain** workspace [user role](../orgs-and-teams/roles) to create and configure Studios.
16
-
- An [AWS Batch compute environment](../compute-envs/aws-batch#batch-forge-compute-environment) (**without Fargate**) with sufficient resources (minimum: 2 CPUs, 8192 MB RAM).
16
+
- An [AWS Batch compute environment](../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) (**without Fargate**) with sufficient resources (minimum: 2 CPUs, 8192 MB RAM).
17
17
- Valid [credentials](../credentials/overview) for your cloud storage account and compute environment.
18
18
-[Data Explorer](../data/data-explorer) enabled in your workspace.
19
19
:::
@@ -32,7 +32,7 @@ This script and instructions can also be used to visualize the structures from *
32
32
33
33
#### Create an AWS Batch compute environment
34
34
35
-
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#batch-forge-compute-environment) with the following attributes:
35
+
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) with the following attributes:
36
36
37
37
-**Region**: To minimize costs, your compute environment should be in the same region as your data. To browse the nf-core AWS megatests public data optimally, select **eu-west-1**.
38
38
-**Provisioning model**: Use **On-demand** EC2 instances.
@@ -366,7 +366,7 @@ An R-IDE enables interactive analysis using R libraries and tools. For example,
366
366
367
367
#### Create an AWS Batch compute environment
368
368
369
-
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#batch-forge-compute-environment) with the following attributes:
369
+
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) with the following attributes:
370
370
371
371
- **Region**: To minimize costs, your compute environment should be in the same region as your data. To browse the nf-core AWS megatests public data optimally, select **eu-west-1**.
372
372
- **Provisioning model**: Use **On-demand** EC2 instances.
@@ -463,7 +463,7 @@ Xpra provides remote desktop functionality that enables many interactive analysi
463
463
464
464
#### Create an AWS Batch compute environment
465
465
466
-
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#batch-forge-compute-environment) with the following attributes:
466
+
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) with the following attributes:
467
467
468
468
- **Region**: To minimize costs, your compute environment should be in the same region as your data. To browse the 1000 Genomes public data optimally, select **us-east-1**.
469
469
- **Provisioning model**: Use **On-demand** EC2 instances.
@@ -531,7 +531,7 @@ Using Studios and Visual Studio Code allows you to create a portable and interac
531
531
532
532
#### Create an AWS Batch compute environment
533
533
534
-
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#batch-forge-compute-environment) with the following attributes:
534
+
Studios require an AWS Batch compute environment. If you do not have an existing compute environment available, [create one](../compute-envs/aws-batch#create-a-seqera-aws-batch-compute-environment) with the following attributes:
535
535
536
536
- **Region**: To minimize costs, your compute environment should be in the same region as your data. To use the iGenomes public data bucket that contains the *nf-core/fetchngs* `test` profile data, select **eu-west-1**.
537
537
- **Provisioning model**: Use **On-demand** EC2 instances.
0 commit comments