Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ This guide details how to set up more complex Azure Batch compute environments w

The first step indicates how to configure a simple Azure Batch compute environment on Azure and Seqera Platform, however beyond that is not required for most users and is only recommended for those who need to customize their compute environments.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
- An Azure account with sufficient permissions to create resources.
- [Azure CLI][install-azure-cli]
- [Seqera Platform CLI][install-seqera-cli]
:::

### Set up Azure Batch

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Seqera publishes legacy Seqera Enterprise containers to a private Elastic Contai

docker pull ${REPOSITORY_URL}/backend:${TAG}
docker pull ${REPOSITORY_URL}/frontend:${TAG}
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Email authentication provides a passwordless login experience where users:

New users are automatically registered on their first login if their email address matches the trusted email patterns. The access link contains a time-limited token that expires after use.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before enabling email authentication, you need:

- A configured SMTP server for sending authentication emails
- Valid SMTP credentials with permission to send emails
:::

## Configure SMTP

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, entra, azure, oidc]

Configure [Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/identity-platform/v2-protocols-oidc) as a single sign-on (SSO) provider for Seqera Platform using OpenID Connect.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- An Azure account with Entra ID access
- Permission to create app registrations

Ensure you know how to register applications in Entra ID. See Microsoft's documentation on [registering an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for more information.
:::

## Register an Entra ID application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, github, oauth]

Configure GitHub as a single sign-on (SSO) provider for Seqera Platform.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- A GitHub organization
- Permission to create OAuth Apps in your organization

Ensure you know how to create a GitHub OAuth app. See GitHub's documentation on [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) for more information.
:::

## Create a GitHub OAuth App

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, google, oauth]

Configure Google as a single sign-on (SSO) provider for Seqera Platform.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- A Google Cloud account
- Permission to create OAuth credentials in the Google Cloud console

Ensure you know how to create Google OAuth credentials. See Google's documentation on [setting up OAuth 2.0](https://support.google.com/cloud/answer/6158849) for more information.
:::

## Create Google OAuth credentials

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, keycloak, oidc]

Configure [Keycloak](https://www.keycloak.org/) as a single sign-on (SSO) provider for Seqera Platform using OpenID Connect.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- A Keycloak instance
- Admin access to create clients in Keycloak

Ensure you know how to configure Keycloak clients. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#assembly-managing-clients_server_administration_guide) for more information.
:::

## Create a Keycloak client

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, okta, oidc]

Configure [Okta](https://www.okta.com/) as a single sign-on (SSO) provider for Seqera Platform using OpenID Connect.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- An Okta organization
- Administrator access to create applications

Ensure you know how to create Okta app integrations. See Okta's documentation on [creating OIDC app integrations](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_oidc.htm) for more information.
:::

## Create an Okta app integration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ tags: [docker, compose, groundswell, pipeline optimization, deployment]

This guide describes how to deploy the pipeline optimization service (referred to as `groundswell` in the configuration file) for Seqera Platform Enterprise using Docker Compose.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Pipeline Optimization installation overview](./install-groundswell#prerequisites), you will need:
- Docker Engine and Docker Compose
:::

## New installation

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/groundswell-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [helm, deployment, installation, kubernetes, pipeline-optimization]

[Helm](https://helm.sh) is an open-source command line tool used for managing Kubernetes applications. Seqera offers a [Helm chart](https://github.com/seqeralabs/helm-charts/tree/pipeline-optimization-0.2.4/platform/charts/pipeline-optimization) to deploy Pipeline Optimization Enterprise on a Kubernetes cluster.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Pipeline Optimization installation overview](./install-groundswell#prerequisites), you will need:
- A Kubernetes cluster
- [Helm v3](https://helm.sh/docs/intro/install) and [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

## Installation as part of Seqera Platform Enterprise

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [kubernetes, groundswell, pipeline optimization, deployment]

This guide describes how to deploy the pipeline optimization service (referred to as `groundswell` in the configuration file) for Seqera Platform Enterprise on Kubernetes.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Pipeline Optimization installation overview](./install-groundswell#prerequisites), you will need:
- A Kubernetes cluster
- [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

## Procedure

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/install-groundswell.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Pipeline optimization (Groundswell) uses resource usage data from previous workf

See each deployment guide for detailed requirements.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:
- A running Seqera Platform Enterprise deployment
- A MySQL 8 database separate from the one used by Seqera Platform
Expand All @@ -40,6 +39,7 @@ Before you begin, you need:
GRANT SELECT ON `seqera_enterprise`.* TO 'pipeline_optimization_ro'@'%';
FLUSH PRIVILEGES;
```
:::

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/install-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Seqera Platform Enterprise can be deployed using Docker Compose, Kubernetes, or

See each deployment guide for detailed requirements.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:
- A MySQL 8 database
- A Redis 7 instance

:::note
MySQL 8 is the only supported database version from Seqera Enterprise version 23.4 onwards. MySQL 5.6 and 5.7 are not supported.
:::
:::
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/install-studios.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Studios provides interactive analysis environments within Seqera Platform. Deplo

See each deployment guide for detailed requirements.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:
- A running Seqera Platform Enterprise deployment at hostname `example.com` or `platform.example.com`
- A Redis 7 instance separate from the one used by Seqera Platform
Expand All @@ -30,6 +29,7 @@ Before you begin, you need:
- `connect.another.subdomain.example.com`
- A wildcard DNS record covering the Studios subdomains, e.g., `*.connect.example.com`
- Data Explorer enabled in your Seqera Platform instance (automatic with Helm deployments)
:::

## DNS configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ tags: [docker, compose, deployment]

Docker Compose deployments are suitable for evaluation, development, and small production workloads.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Platform installation overview](./install-platform#prerequisites), you will need:
- Docker Engine and Docker Compose
:::

## Container images

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/platform-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [helm, deployment, installation, kubernetes]

[Helm](https://helm.sh) is an open-source command line tool used for managing Kubernetes applications. Seqera offers a [Helm chart](https://github.com/seqeralabs/helm-charts/tree/platform-0.20.1/platform) to deploy Seqera Platform Enterprise on a Kubernetes cluster.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Platform installation overview](./install-platform#prerequisites), you will need:
- A Kubernetes cluster
- [Helm v3](https://helm.sh/docs/intro/install) and [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

## Installing the Helm chart

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/platform-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [kubernetes, deployment]

Kubernetes deployments are recommended for production workloads requiring high availability and scalability.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Platform installation overview](./install-platform#prerequisites), you will need:
- A Kubernetes cluster
- [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

### Recommended resources

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/studios-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ tags: [docker, compose, studios, deployment]

This guide describes how to deploy Studios for Seqera Platform Enterprise with Docker Compose.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Studios installation overview](./install-studios#prerequisites), you will need:
- Docker Engine and Docker Compose
:::

## Procedure

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/studios-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [helm, deployment, installation, kubernetes, studios]

[Helm](https://helm.sh) is an open-source command line tool used for managing Kubernetes applications. Seqera offers a [Helm chart](https://github.com/seqeralabs/helm-charts/tree/studios-1.1.3/platform/charts/studios) to deploy Studios Enterprise on a Kubernetes cluster.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Studios installation overview](./install-studios#prerequisites), you will need:
- A Kubernetes cluster
- [Helm v3](https://helm.sh/docs/intro/install) and [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

## Installation as part of Seqera Platform Enterprise

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/studios-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ tags: [kubernetes, studios, deployment]

This guide describes how to deploy Studios for Seqera Platform Enterprise on Kubernetes.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Other than the basic requirements [already listed in the Studios installation overview](./install-studios#prerequisites), you will need:
- A Kubernetes cluster
- [kubectl](https://kubernetes.io/docs/tasks/tools/) installed locally
:::

## Tool configuration

Expand Down
4 changes: 2 additions & 2 deletions platform-enterprise_docs/enterprise/studios-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ To enable SSH access to running Studio sessions, you need:

If you have pinned Studio container images to specific versions, you will need to [migrate](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) them to the required Connect client version.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
- Studios enabled (see [Studios installation](./install-studios))
- Access to Platform configuration
- Administrative access to modify your deployment infrastructure
- Ability to configure network routing and firewall rules
:::

## Requirements overview

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ This guide details how to set up more complex Azure Batch compute environments w

The first step indicates how to configure a simple Azure Batch compute environment on Azure and Seqera Platform, however beyond that is not required for most users and is only recommended for those who need to customize their compute environments.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
- An Azure account with sufficient permissions to create resources.
- [Azure CLI][install-azure-cli]
- [Seqera Platform CLI][install-seqera-cli]
:::

### Set up Azure Batch

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Seqera publishes legacy Seqera Enterprise containers to a private Elastic Contai

docker pull ${REPOSITORY_URL}/backend:${TAG}
docker pull ${REPOSITORY_URL}/frontend:${TAG}
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Email authentication provides a passwordless login experience where users:

New users are automatically registered on their first login if their email address matches the trusted email patterns. The access link contains a time-limited token that expires after use.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before enabling email authentication, you need:

- A configured SMTP server for sending authentication emails
- Valid SMTP credentials with permission to send emails
:::

## Configure SMTP

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, entra, azure, oidc]

Configure [Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/identity-platform/v2-protocols-oidc) as a single sign-on (SSO) provider for Seqera Platform using OpenID Connect.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- An Azure account with Entra ID access
- Permission to create app registrations

Ensure you know how to register applications in Entra ID. See Microsoft's documentation on [registering an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for more information.
:::

## Register an Entra ID application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, github, oauth]

Configure GitHub as a single sign-on (SSO) provider for Seqera Platform.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- A GitHub organization
- Permission to create OAuth Apps in your organization

Ensure you know how to create a GitHub OAuth app. See GitHub's documentation on [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) for more information.
:::

## Create a GitHub OAuth App

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags: [authentication, google, oauth]

Configure Google as a single sign-on (SSO) provider for Seqera Platform.

## Prerequisites

:::info <span id="prerequisites">**Prerequisites**</span>
Before you begin, you need:

- A Google Cloud account
- Permission to create OAuth credentials in the Google Cloud console

Ensure you know how to create Google OAuth credentials. See Google's documentation on [setting up OAuth 2.0](https://support.google.com/cloud/answer/6158849) for more information.
:::

## Create Google OAuth credentials

Expand Down
Loading
Loading