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 @@ -136,7 +136,7 @@ Configuration values that control Seqera's interaction with databases and Redis
From Seqera Enterprise version 23.3, Redis version 7 is officially supported. Follow your cloud provider specifications to upgrade your instance.
:::

### Database requirements
### Database requirements

:::warning Aurora Serverless is not supported
AWS Aurora Serverless is **not supported** for production Seqera Enterprise deployments. We have observed critical stability and performance issues with Aurora Serverless under typical production workloads, including:
Expand All @@ -153,6 +153,10 @@ AWS Aurora Serverless is **not supported** for production Seqera Enterprise depl
If you are currently using Aurora Serverless and experiencing performance issues, we strongly recommend migrating to one of the supported database configurations above.
:::

:::warning
**Breaking change in version 23.4**: MySQL 8 is now required. If you are currently using MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8.0 before upgrading to version 23.4 or later.
:::

External databases for Seqera Enterprise deployments require:

- A **MySQL8 Community** DB instance
Expand Down Expand Up @@ -545,11 +549,11 @@ Do not replace the [Seqera-provided default image](../../functionality_matrix/ov

## Seqera API

Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.
Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.

:::note
To configure API rate limit environment variables, you must add `ratelim` to the `MICRONAUT_ENVIRONMENTS`. Without `ratelim` being set, the rate limit configuration variables below are ignored.
:::
:::

<Tabs>
<TabItem value="Environment variables" label="Environment variables" default>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Seqera Enterprise requires a Redis database for caching purposes.

Seqera requires a SQL database to persist user activities and state. The application has been tested against MySQL 8.0. [Contact Seqera support](https://support.seqera.io) if you need to use a different JDBC-compliant SQL database.

:::warning
**Breaking change in version 23.4**: MySQL 8 is now required. If you are currently using MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8.0 before upgrading to version 23.4 or later.
:::

### SMTP service

Seqera requires an SMTP relay to send email messages and user notifications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,32 @@ tags: [enterprise, update, install]

Follow these steps to upgrade your database instance and Platform Enterprise installation:

:::warning
**Breaking change in version 23.4**: MySQL 8 is now required. If you are running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 23.4. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
:::

### General upgrade steps

:::caution
The database volume is persistent on the local machine by default if you use the `volumes` key in the `db` or `redis` section of your `docker-compose.yml` file to specify a local path to the DB or Redis instance. If your database is not persistent, you must back up your database before performing any application or database upgrades.
:::

1. Make a backup of the Seqera Platform database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
:::info
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
:::

1. Make a backup of the Seqera database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
1. Download the latest versions of your deployment templates and update your Seqera container versions:
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
- [server.yml](./_templates/k8s/data_studios/server.yml)

:::warning
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
:::

1. Restart the application.
1. If you're using a containerized database as part of your implementation:
1. Stop the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Configuration values that control Seqera's interaction with databases and Redis
From Seqera Enterprise version 23.3, Redis version 7 is officially supported. Follow your cloud provider specifications to upgrade your instance.
:::

### Database requirements
### Database requirements

:::warning Aurora Serverless is not supported
AWS Aurora Serverless is **not supported** for production Seqera Enterprise deployments. We have observed critical stability and performance issues with Aurora Serverless under typical production workloads, including:
Expand All @@ -153,6 +153,12 @@ AWS Aurora Serverless is **not supported** for production Seqera Enterprise depl
If you are currently using Aurora Serverless and experiencing performance issues, we strongly recommend migrating to one of the supported database configurations above.
:::

:::note
From Seqera Enterprise version 23.4:
- MySQL 8 is the officially supported and tested database version.
- MySQL versions 5.6 and 5.7 are no longer supported.
:::

External databases for Seqera Enterprise deployments require:

- A **MySQL8 Community** DB instance
Expand Down Expand Up @@ -420,7 +426,7 @@ JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirect
```

:::note
These default JVM memory settings are included in the configuration templates provided in these docs:
These default JVM memory settings are included in the configuration templates provided in these docs:
- Kubernetes: [tower-svc.yml](../_templates/k8s/tower-svc.yml) and [tower-cron.yml](../_templates/k8s/tower-cron.yml)
- Docker Compose: [tower.env](../_templates/docker/tower.env)
:::
Expand Down Expand Up @@ -616,11 +622,11 @@ Do not replace the [Seqera-provided default image](../../functionality_matrix/ov

## Seqera API

Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.
Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.

:::note
To configure API rate limit environment variables, you must add `ratelim` to the `MICRONAUT_ENVIRONMENTS`. Without `ratelim` being set, the rate limit configuration variables below are ignored.
:::
:::

<Tabs>
<TabItem value="Environment variables" label="Environment variables" default>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ Seqera Enterprise requires a Redis database for caching purposes.

Seqera requires a SQL database to persist user activities and state. The application has been tested against MySQL 8.0. [Contact Seqera support](https://support.seqera.io) if you need to use a different JDBC-compliant SQL database.

:::note
From Seqera Enterprise version 23.4:
- MySQL 8 is the officially supported and tested database version.
- MySQL versions 5.6 and 5.7 are no longer supported.
:::

### SMTP service

Seqera requires an SMTP relay to send email messages and user notifications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,32 @@ tags: [enterprise, update, install]

Follow these steps to upgrade your database instance and Platform installation:

:::note
From Seqera Enterprise version 23.4, MySQL 8 is the only supported database version. If you are upgrading from a version prior to 23.4 and running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 24.1. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
:::

### General upgrade steps

:::caution
The database volume is persistent on the local machine by default if you use the `volumes` key in the `db` or `redis` section of your `docker-compose.yml` file to specify a local path to the DB or Redis instance. If your database is not persistent, you must back up your database before performing any application or database upgrades.
:::

1. Make a backup of the Seqera Platform database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
:::info
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
:::

1. Make a backup of the Seqera database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
1. Download the latest versions of your deployment templates and update your Seqera container versions:
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
1. **JVM memory configuration defaults (recommended)**: The following `JAVA_OPTS` environment variable is included in the deployment templates downloaded in the preceding step, to optimize JVM memory settings:

```bash
JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144
```
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
- [server.yml](./_templates/k8s/data_studios/server.yml)

These baseline values are suitable for most deployments running moderate concurrent workflow loads.

:::tip
These are starting recommendations that may require tuning based on your deployment's workload. See [Backend memory requirements](./configuration/overview.mdx#backend-memory-requirements) for detailed guidance on when and how to adjust these values for your environment.
:::warning
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
:::

1. Restart the application.
1. If you're using a containerized database as part of your implementation:
1. Stop the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ From Seqera Enterprise version 24.2:
Follow your cloud provider specifications to upgrade your instance.
:::

### Database requirements
### Database requirements

:::warning Aurora Serverless is not supported
AWS Aurora Serverless is **not supported** for production Seqera Enterprise deployments. We have observed critical stability and performance issues with Aurora Serverless under typical production workloads, including:
Expand All @@ -158,6 +158,12 @@ AWS Aurora Serverless is **not supported** for production Seqera Enterprise depl
If you are currently using Aurora Serverless and experiencing performance issues, we strongly recommend migrating to one of the supported database configurations above.
:::

:::note
From Seqera Enterprise version 23.4:
- MySQL 8 is the officially supported and tested database version.
- MySQL versions 5.6 and 5.7 are no longer supported.
:::

External databases for Seqera Enterprise deployments require:

- A **MySQL8 Community** DB instance
Expand Down Expand Up @@ -425,7 +431,7 @@ JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirect
```

:::note
These default JVM memory settings are included in the configuration templates provided in these docs:
These default JVM memory settings are included in the configuration templates provided in these docs:
- Kubernetes: [tower-svc.yml](../_templates/k8s/tower-svc.yml) and [tower-cron.yml](../_templates/k8s/tower-cron.yml)
- Docker Compose: [tower.env](../_templates/docker/tower.env)
:::
Expand Down Expand Up @@ -621,11 +627,11 @@ Do not replace the [Seqera-provided default image](../../functionality_matrix/ov

## Seqera API

Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.
Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.

:::note
To configure API rate limit environment variables, you must add `ratelim` to the `MICRONAUT_ENVIRONMENTS`. Without `ratelim` being set, the rate limit configuration variables below are ignored.
:::
:::

<Tabs>
<TabItem value="Environment variables" label="Environment variables" default>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ Seqera Enterprise requires a Redis database for caching purposes.

Seqera requires a SQL database to persist user activities and state. The application has been tested against MySQL 8.0. [Contact Seqera support](https://support.seqera.io) if you need to use a different JDBC-compliant SQL database.

:::note
From Seqera Enterprise version 23.4:
- MySQL 8 is the officially supported and tested database version.
- MySQL versions 5.6 and 5.7 are no longer supported.
:::

### SMTP service

Seqera requires an SMTP relay to send email messages and user notifications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,32 @@ tags: [enterprise, update, install]

Follow these steps to upgrade your database instance and Platform Enterprise installation:

:::note
From Seqera Enterprise version 23.4, MySQL 8 is the only supported database version. If you are upgrading from a version prior to 23.4 and running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 24.2. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
:::

### General upgrade steps

:::caution
The database volume is persistent on the local machine by default if you use the `volumes` key in the `db` or `redis` section of your `docker-compose.yml` file to specify a local path to the DB or Redis instance. If your database is not persistent, you must back up your database before performing any application or database upgrades.
:::

:::info
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
:::

1. Make a backup of the Seqera database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
1. Download the latest versions of your deployment templates and update your Seqera container versions:
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
1. **JVM memory configuration defaults (recommended)**: The following `JAVA_OPTS` environment variable is included in the deployment templates downloaded in the preceding step, to optimize JVM memory settings:

```bash
JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144
```
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
- [server.yml](./_templates/k8s/data_studios/server.yml)

These baseline values are suitable for most deployments running moderate concurrent workflow loads.

:::tip
These are starting recommendations that may require tuning based on your deployment's workload. See [Backend memory requirements](./configuration/overview.mdx#backend-memory-requirements) for detailed guidance on when and how to adjust these values for your environment.
:::warning
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
:::

1. Restart the application.
1. If you're using a containerized database as part of your implementation:
1. Stop the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ See each deployment guide for detailed requirements.
## Prerequisites

Before you begin, you need:
- A MySQL 8 database
- A MySQL 8 database. MySQL v5.x is not supported.
- A Redis 7 instance

:::note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Seqera Enterprise requires a Redis database for caching purposes.

### SQL database

Seqera requires a SQL database to persist user activities and state. The application has been tested against MySQL 8.0. [Contact Seqera support](https://support.seqera.io) if you need to use a different JDBC-compliant SQL database.
Seqera requires a SQL database to persist user activities and state. The application has been tested against MySQL 8.0: MySQL v5.x is not supported anymore. [Contact Seqera support](https://support.seqera.io) if you need to use a different JDBC-compliant SQL database.

### SMTP service

Expand Down
Loading
Loading