[PLAT-217] Seqera Compute M2 docs #570
Conversation
llewellyn-sl
added
1. Editor review
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Minor clarifications Signed-off-by: Drew DiPalma <drew.dipalma@seqera.io>
|
|
||
| #### 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.
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.
Note – This could also be on the Seqera Compute page
There was a problem hiding this comment.
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.
|
|
||
| #### 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.
Note – This could also be on the Seqera Compute page
| :::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.
I think we need another section on this page with limitations (ex. max CPUs, compute environments, etc.)
| --- | ||
| title: "Seqera Compute" | ||
| description: "Instructions to set up Seqera Compute in Seqera Platform" | ||
| date: "21 Apr 2023" |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
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.
| 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. |
| 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.
| 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. |
| 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. | ||
| ::: | ||
| 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.
| 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. |
|
|
||
| #### 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.
| 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 a relative **Pipeline work 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. |
There was a problem hiding this comment.
| 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. |
|
|
||
| #### 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.
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.
|
|
||
| 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. | ||
|
|
||
| #### Edit or delete organization |
There was a problem hiding this comment.
| #### Edit or delete organization | |
| #### Managing organizations |
No description provided.