-
Notifications
You must be signed in to change notification settings - Fork 4
[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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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" | ||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
::: | ||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
:::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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
:::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**. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.) |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note – This could also be on the Seqera Compute page There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
:::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 | ||||||
|
||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.