Skip to content

[PLAT-217] Seqera Compute M2 docs #570

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions platform-cloud/cloud-sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"type": "category",
"label": "Cloud",
"items": [
"compute-envs/seqera-compute",
"compute-envs/aws-batch",
"compute-envs/azure-batch",
"compute-envs/google-cloud-batch",
Expand Down
40 changes: 40 additions & 0 deletions platform-cloud/docs/compute-envs/seqera-compute.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Seqera Compute"
description: "Instructions to set up Seqera Compute in Seqera Platform"
date: "21 Apr 2023"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
date: "21 Apr 2023"
date: "21 Apr 2025"

tags: [seqera compute, compute environment]
---

Seqera Compute enables you to seamlessly run pipelines and Studios in Seqera Cloud in a fully managed and optimized compute environment on AWS. Seqera automatically provisions and manages all underlying resources, including AWS accounts, credentials, roles, AWS Batch compute environments, and S3 storage buckets, requiring minimal user configuration. Using prepaid credits enables control and visibility of the compute spend in each of your organization's workspaces.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Seqera Compute enables you to seamlessly run pipelines and Studios in Seqera Cloud in a fully managed and optimized compute environment on AWS. Seqera automatically provisions and manages all underlying resources, including AWS accounts, credentials, roles, AWS Batch compute environments, and S3 storage buckets, requiring minimal user configuration. Using prepaid credits enables control and visibility of the compute spend in each of your organization's workspaces.
Seqera Compute enables you to run pipelines and studio sessions in Seqera Cloud in a fully managed and optimized AWS environment. Seqera automatically provisions and manages all the underlying resources, including AWS accounts, credentials, roles, AWS Batch compute environments, and S3 storage buckets, requiring minimal user configuration. Using prepaid credits enables control and visibility of the compute spend in each of your organization's workspaces.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to be very careful calling Seqera Compute a "compute environment on AWS". A compute environment is a very specific/defined resource/entity managed by AWS Batch. This is more than a CE. Either just call it an "AWS environment" or we need to think of another descriptive noun that best represents it.


### Manage Seqera Compute credits

View Seqera Compute credit balance and spend under the organization or workspace **Settings** tabs. Workspace settings show the credits spent on Seqera Compute in that workspace, whereas organization settings show the total credit spend in all workspaces in that organization.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
View Seqera Compute credit balance and spend under the organization or workspace **Settings** tabs. Workspace settings show the credits spent on Seqera Compute in that workspace, whereas organization settings show the total credit spend in all workspaces in that organization.
View Seqera Compute credit balance and spend under both your organization or workspace **Settings** tabs. Workspace settings show the credits spent on Seqera Compute in that workspace, whereas organization settings show the total credit spend across all workspaces in an organization.


Select **Contact us to upgrade** to purchase additional credits for your organization.

### Create a Seqera Compute environment

1. In a workspace with Seqera Compute enabled, select **Compute environments > New environment**.
1. Enter a descriptive name for this environment, such as _Seqera Compute 1 (eu-west-1)_.
1. Under **Platform**, select **Seqera Compute**.
1. Select a target execution **Region**.
:::info
If your pipeline or Studio input data resides in existing S3 storage, select the region nearest to this data to minimize cross-region data transfer costs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If your pipeline or Studio input data resides in existing S3 storage, select the region nearest to this data to minimize cross-region data transfer costs.
If your data resides in existing S3 object storage, select the same, or nearest, region to your data to minimize cross-region ingress/egress costs.

:::
1. Configure any advanced options described in the next section, as needed.
1. Select **Add** to complete the Seqera Compute environment configuration and return to the compute environments list. It will take a few seconds for the compute environment resources to be created before you are ready to launch pipelines.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Select **Add** to complete the Seqera Compute environment configuration and return to the compute environments list. It will take a few seconds for the compute environment resources to be created before you are ready to launch pipelines.
1. Select **Add** to complete the Seqera Compute environment configuration and return to the compute environments list. It will take a few seconds for the compute environment resources to be created before you are ready to launch pipelines or add studios.


:::info
See [Launch pipelines](../launch/launchpad.mdx) to start executing workflows in your Seqera Compute environment.
:::

#### Advanced options (optional)

1. Enter a relative **Pipeline work directory** path to be appended to the S3 storage bucket Seqera creates for this compute environment.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Enter a relative **Pipeline work directory** path to be appended to the S3 storage bucket Seqera creates for this compute environment.
1. Enter a relative **working directory** path to be appended to the S3 storage bucket Seqera creates for this compute environment.

1. Enter [pre- or post-run Bash scripts](../launch/advanced.mdx#pre--post-run-scripts) that execute before or after the Nextflow pipeline execution in your environment.
1. Enter 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Enter 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.
1. Enter Global Nextflow configuration settings for all pipeline runs launched with this environment. Values defined here are pre-filled in the **Nextflow config file** field in the pipeline launch form. These values can be overridden at pipeline launch.

:::info
Configuration settings in this field override the same values in the pipeline repository `nextflow.config` file. See [Nextflow config file](../launch/advanced.mdx#nextflow-config-file) for more information on configuration priority.
:::
1. Specify custom **Environment variables** for the **Head job** and/or **Compute jobs**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need another section on this page with limitations (ex. max CPUs, compute environments, etc.)

10 changes: 8 additions & 2 deletions platform-cloud/docs/orgs-and-teams/organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,21 @@ You can also add external collaborators to an organization.
3. Enter any other optional fields as needed: **Description**, **Location**, **Website URL**, and **Logo**.
4. Select **Add**.

### Edit an organization
### Organization settings

#### Credits

The **Credits** view contains the current credit balance available to the organization, and the credits spent in the workspace. Select **Contact us to upgrade** to purchase additional credits for your organization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add what Credits enable you to do, what the different billing elements are, how billing works (could be a separate section) and what behavior is when you run out of credits (ie. what won't work/be available)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note – This could also be on the Seqera Compute page

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There needs to be a section at the start (above this "Credits" block) saying something like "This page allows owners to manage their organizations. The top of the page displays metadata associated with your organization (name, link, location, description)."

Re. Credits: are credits consumed more rapidly if you have existing data in object storage and you're moving data across regions (either ingress or egress)? I would assume yes. If so, we should be explicit.

Definitely needs a more filled-out "what happens when you run out of credits" section to manage expectations (i.e. will someone from Seqera call you, will you be directly to a portal where you enter credit card details, etc?). Might need to be on a different page.


#### Edit or delete organization
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Edit or delete organization
#### Managing organizations


:::note
From version 23.2, **organization owners** can edit their organization name, either from the organizations page or the [Admin panel](../administration/overview.mdx).
:::

As an **organization owner**, access the organization page from the organizations and workspaces dropdown, or open the user menu and select **Your organizations** to view and edit your organizations. As a root user, you can also edit organizations from the [Admin panel](../administration/overview.mdx).

Open the **Settings** tab on the organization page, and select **Edit** in the **Edit Organization** row. Update the settings and select **Update** to save.
Select **Edit** in the **Edit Organization** row to update the organization name, full name, description, location, website URL, and logo. Update the settings and select **Update** to save.

### Organization resource usage tracking

Expand Down
27 changes: 22 additions & 5 deletions platform-cloud/docs/orgs-and-teams/workspace-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Organizations consist of members, while workspaces consist of participants.
A workspace participant may be a member of the workspace organization or a collaborator within that workspace only. Collaborators count toward the total number of workspace participants. See [Usage limits](../limits/limits.mdx).
:::

## Create a new workspace
### Create a new workspace

Organization owners and admins can create a new workspace within an organization:

Expand All @@ -32,15 +32,32 @@ As a workspace owner, you can modify optional workspace fields after workspace c

Apart from the **Participants** tab, the _organization_ workspace is similar to the _user_ workspace. As such, the relation to [runs](../launch/launchpad.mdx), [actions](../pipeline-actions/overview.mdx), [compute environments](../compute-envs/overview.mdx), and [credentials](../credentials/overview.mdx) is the same.

## Edit a workspace
### Workspace settings

Select the **Settings** tab within a workspace to manage credits, Studios settings, workspace labels, and edit or delete the workspace.

#### Credits

The **Credits** view contains the current credit balance available to the organization, and the credits spent in the workspace. Select **Contact us to upgrade** to purchase additional credits for your organization.

#### Studios settings

Edit the workspace Studios settings to set a predefined lifespan (between 1 and 120 hours) after which all Studio sessions in the workspace are automatically stopped. To keep all workspace Studio settings running indefinitely, select **Always keep the session running**.

#### Edit labels

Select **Edit labels** to manage the workspace [labels and resource labels](../labels/overview.mdx).

#### Edit or delete workspace

:::note
From version 23.2, **workspace owners** can edit their workspace name, either from the workspace settings tab or the [Admin panel](../administration/overview.mdx).
:::

Open the **Settings** tab on the workspace page and select **Edit Workspace**. Make your updates and select **Update** to save changes.
- Select **Edit workspace** to update the workspace name, full name, description, and sharing. Select **Update** to save changes.
- Select **Delete workspace** to delete the workspace and its associated resources. This action cannot be reveresed.

## Add a new participant
### Add a new participant

A new workspace participant can be an existing organization member, team, or collaborator. To add a new participant to a workspace:

Expand All @@ -49,7 +66,7 @@ A new workspace participant can be an existing organization member, team, or col
3. Enter the **Name** of the new participant.
4. Optionally, update the participant **role**.

## Workspace run monitoring
### Workspace run monitoring

To allow users executing pipelines from the command line to share their runs with a given workspace, see [deployment options](../getting-started/deployment-options.mdx#nextflow--with-tower).

Expand Down
Loading