From aefcd800c73351508a169e5a45046446b2cf58bd Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 1 May 2025 12:26:06 +0100 Subject: [PATCH 1/9] Upgrade Guide --- changelog/seqera-enterprise/v25.1.mdx | 93 +++---------------- .../version-25.1/enterprise/upgrade.mdx | 68 ++++++++++++++ 2 files changed, 81 insertions(+), 80 deletions(-) diff --git a/changelog/seqera-enterprise/v25.1.mdx b/changelog/seqera-enterprise/v25.1.mdx index 5afbcf50d..de13e8025 100644 --- a/changelog/seqera-enterprise/v25.1.mdx +++ b/changelog/seqera-enterprise/v25.1.mdx @@ -4,6 +4,8 @@ date: 2025-04-09 tags: [seqera enterprise] --- +# Seqera Enterprise v25.1 Release Notes + Seqera Platform Enterprise version 25.1 introduces Studios GA and a number of bug fixes and performance enhancements. Studios is Seqera's in-platform tool for secure, on-demand, interactive data analysis using containers created from Seqera-managed container template images or your own organization-managed custom environments. You only pay for the compute your Studio sessions consume, and the compute is adjacent to your data, significantly reducing data transfer costs and wasted time copying data from storage to analysis. This significantly reduces infrastructure management requirements, removes data silos, adheres to strict in-platform role-based access control, and lowers your operational costs. [Learn more about Studios](https://docs.seqera.io/platform-enterprise/latest/studios). @@ -15,7 +17,7 @@ Studios is Seqera's in-platform tool for secure, on-demand, interactive data ana - **Labeled templates**: Labels indicate the status of support (`recommended` or `deprecated`) for a Seqera-managed Studio container template version. Users can migrate a Studio to a new base container template when **Adding as new**. - **[Private sessions](https://docs.seqera.io/platform-enterprise/latest/studios/managing#general-config)**: When adding a new Studio, the number of concurrent connections (private vs. all workspace members) can now be defined in **General Config > Collaboration**. - **[Custom session lifespans](https://docs.seqera.io/platform-enterprise/latest/studios/managing#modify-session-lifespan-for-all-studios)**: This new feature allows you to set a maximum lifespan for a session, after which time the session is stopped automatically and a checkpoint created, or the session can be extended on-demand. -- **Resource labels**: Users with at least workspace maintainer role permissions can manage the resource labels inherited from the compute environment and attached to the Studio. Resource labels attached to each Studio don’t affect the default resource labels associated with the compute environment. +- **Resource labels**: Users with at least workspace maintainer role permissions can manage the resource labels inherited from the compute environment and attached to the Studio. Resource labels attached to each Studio don't affect the default resource labels associated with the compute environment. ### Fusion @@ -40,15 +42,19 @@ Studios is Seqera's in-platform tool for secure, on-demand, interactive data ana - Allow users to remove organization logos. - New workflow job monitoring collects and publishes Platform metrics. - Notify the user when secrets cleanup fails. -- Dashboard page: Add a date filter. +- Dashboard page: Add a date filter. - Bump nf-launcher default to version 25.10.5. - Upgrade to Angular 18. ## Bug fixes -- **Studios** - - Fixed resource labels being erroneously non-editable for the Maintain role when adding or starting a Studio session. - - Fixed searches for names containing special SQL wildcard characters (_, %). +### Studios + +- Fixed resource labels being erroneously non-editable for the Maintain role when adding or starting a Studio session. +- Fixed searches for names containing special SQL wildcard characters (\_, %). + +### General + - Prohibit duplicate Git credentials and tie-break on `lastUpdated` for existing duplicates. Preference is given to the last-updated credentials when there are multiple candidates. A check is also added to avoid duplicates when creating new credentials. - Set `ECS_CONTAINER_START_TIMEOUT` to 10 minutes in the ECS settings used by AWS Batch CEs, to prevent `Task failed to start - DockerTimeoutError: Could not transition to started; timed out after waiting 3m0s` errors. - Compute environment creation form allows pre- and post-run scripts to be longer than the accepted value of 1024 characters. @@ -63,81 +69,8 @@ Studios is Seqera's in-platform tool for secure, on-demand, interactive data ana - Fallback to primary compute environment when launching a shared pipeline without an associated compute environment from a private workspace. - Fixed regression of the quick launch form not selecting the primary compute environment by default. -## Breaking changes and warnings - -### OIDC Secrets injection modifications - -The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. - -### Seqera AWS ECR repository customer access ends June 1, 2025 - -Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. - -See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information on the AWS ECR and other deprecated Seqera container registries. - -### Redis version change - -From Seqera Enterprise version 24.2: - -- Redis version 6.2 or greater is required. -- Redis version 7 is officially supported. - -### Redisson properties deprecated - -From Seqera Enterprise version 24.2, `redisson.*` configuration properties are deprecated. If you have set `redisson.*` properties directly previously, do the following: - -- Replace `/redisson/*` references in AWS Parameter Store entries with `TOWER_REDIS_*`. -- Replace `redisson.*` references in `tower.yml` with `TOWER_REDIS_*`. - -:::note -Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). -::: - -### MariaDB driver: New MySQL connection parameter required - -MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database: - -`jdbc:mysql://:/tower?permitMysqlScheme=true` - -All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must be updated when upgrading to Seqera Enterprise version 24.1 or later. - -### MariaDB driver: No truncation support for MySQL 5.6 - -The MariaDB driver has dropped support for the `jdbcCompliantTruncation` parameter, which was true by default and set the `STRICT_TRANS_TABLES` SQL mode. The `STRICT_TRANS_TABLES` mode produces an error when the value of a VARCHAR column exceeds its limit, instead of truncating it to fit. Most common installations of MySQL 5.7 and 8 already include this mode at the server level, but the Docker container version of MySQL 5.6 does not. - -The SQL mode must be set explicitly through the connection URL for deployments still using MySQL 5.6: - -`jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` - -### Micronaut property key changes - -The property that determines the expiration time of the JWT access token (used for authenticating web sessions and Nextflow-Platform interactions) has changed as of Seqera Enterprise version 24.1: - -| Previous | New | -| ---------------------------------------------------------------- | ------------------------------------------------------------ | -| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | - -Enterprise deployments that have customized this value previously will need to adopt the new format. - -## Upgrade steps - -:::warning -Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. -::: - -1. This version includes an update to the Platform Enterprise H8 cache. **Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost.** -1. This version requires a database schema update. Make a backup of your Platform database prior to upgrade. -1. If you are upgrading from a version older than 23.4.1, update your installation to version [23.4.4](https://docs.seqera.io/changelog/seqera-enterprise/v23.4) first, before updating to 25.1 with the steps below. -1. For recommended Platform memory settings, add the following environment variable to your Platform configuration values (`tower.env`, `configmap.yml`, etc.): - ```bash - JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144 - ``` -1. See [Upgrade installation](https://docs.seqera.io/platform-enterprise/24.2/enterprise/upgrade) for installation upgrade guidance. -:::info -Docker Compose deployments require downtime while upgrading services. Restarting the application may take several minutes. See [Docker compose deployment](https://docs.seqera.io/platform-enterprise/latest/enterprise/docker-compose) for more information. +:::note[UPGRADING] -For Kubernetes deployments, apply the 25.1 `tower-cron.yml` to your cron pod and wait for the cron pod to be running before applying the `tower-svc.yml` to your backend pod and restarting the service. If the cron pod update is interrupted, you may need to restore the instance from your DB backup and start again. See [Kubernetes deployment](https://docs.seqera.io/platform-enterprise/latest/enterprise/kubernetes) for more information. +See [Upgrade installation](https://docs.seqera.io/platform-enterprise/25.1/enterprise/upgrade) for installation upgrade guidance. -For custom deployments with third-party services such as ArgoCD, [contact support](https://support.seqera.io) for assistance during upgrade. -::: diff --git a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx index 2d0a942db..06a36e288 100644 --- a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx @@ -40,3 +40,71 @@ If you must host your nf-launcher container image on a private image registry, c :::caution If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. ::: + + + +## Upgrading to v25.1 + +Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... + +:::warning +Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. +::: + +### Prerequisites +- Redis version 6.2 or greater is required. +- Redis version 7 is officially supported. +- MySQL 5.7 or greater is required. +- MySQL 8.0 or greater is officially supported. + +### Breaking changes + +#### Seqera AWS ECR repository customer access ends June 1, 2025 + +Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. + +**Action required:** + +- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. +- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. +- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. + +#### OIDC Secrets injection modifications + +The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. + +**Action required:** + +- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. +- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. + +:::note +Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). +::: + +#### MariaDB driver: New MySQL connection parameter required + +MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. + +**Action required:** + +# TODO - Remove version numbers. +- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: + `jdbc:mysql://:/tower?permitMysqlScheme=true` + + +**Action required:** + + `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` + +#### Micronaut property key changes + +The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. + +**Action required:** + +- If you have customized this value previously, update to the new format: + +| Previous | New | +| ---------------------------------------------------------------- | ------------------------------------------------------------ | +| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | From 048728d9cdc5ff1f17af0871f3a91712667d7a67 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Thu, 1 May 2025 14:44:03 +0200 Subject: [PATCH 2/9] Update upgrade.mdx Signed-off-by: Justine Geffen --- .../version-25.1/enterprise/upgrade.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx index 06a36e288..d4d19b0df 100644 --- a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx @@ -41,8 +41,6 @@ If you must host your nf-launcher container image on a private image registry, c If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. ::: - - ## Upgrading to v25.1 Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... From b5d3c484fa529cc69e582369e6f0619bb2a346da Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 1 May 2025 12:59:07 +0100 Subject: [PATCH 3/9] Upgrade instructions --- .../upgrade.mdx => upgrade/24.1.mdx} | 5 +- .../version-25.1/upgrade/24.2.mdx | 113 ++++ .../version-25.1/upgrade/24.3.mdx | 113 ++++ .../version-25.1/upgrade/25.1.mdx | 113 ++++ .../version-25.1/upgrade/strats.mdx | 8 + .../version-25.1-sidebars.json | 503 +++++++++--------- 6 files changed, 603 insertions(+), 252 deletions(-) rename platform-enterprise_versioned_docs/version-25.1/{enterprise/upgrade.mdx => upgrade/24.1.mdx} (99%) create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx diff --git a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx similarity index 99% rename from platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx rename to platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx index d4d19b0df..870d1fdfd 100644 --- a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx @@ -1,10 +1,13 @@ --- -title: "Upgrade deployment" +title: "24.1" description: "Platform Enterprise update guidance" date: "21 Aug 2024" tags: [enterprise, update, install] --- + +# Prerequisites + Follow these steps to upgrade your database instance and Platform Enterprise installation: :::caution diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx new file mode 100644 index 000000000..59f912b73 --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx @@ -0,0 +1,113 @@ +--- +title: "24.2" +description: "Platform Enterprise update guidance" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + + +# Prerequisites + +Follow these steps to upgrade your database instance and Platform Enterprise installation: + +:::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 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. Restart the application. +1. If you're using a containerized database as part of your implementation: + 1. Stop the application. + 1. Upgrade the MySQL image. + 1. Restart the application. +1. If you're using Amazon RDS or other managed database services: + 1. Stop the application. + 1. Upgrade your database instance. + 1. Restart the application. +1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. + +### Custom deployments + +- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. +- Deploy Seqera following your usual procedures. + +### Nextflow launcher image + +If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: + + `TOWER_LAUNCH_CONTAINER=` + +:::caution +If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. +::: + + + +## Upgrading to v25.1 + +Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... + +:::warning +Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. +::: + +### Prerequisites +- Redis version 6.2 or greater is required. +- Redis version 7 is officially supported. +- MySQL 5.7 or greater is required. +- MySQL 8.0 or greater is officially supported. + +### Breaking changes + +#### Seqera AWS ECR repository customer access ends June 1, 2025 + +Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. + +**Action required:** + +- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. +- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. +- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. + +#### OIDC Secrets injection modifications + +The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. + +**Action required:** + +- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. +- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. + +:::note +Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). +::: + +#### MariaDB driver: New MySQL connection parameter required + +MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. + +**Action required:** + +# TODO - Remove version numbers. +- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: + `jdbc:mysql://:/tower?permitMysqlScheme=true` + + +**Action required:** + + `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` + +#### Micronaut property key changes + +The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. + +**Action required:** + +- If you have customized this value previously, update to the new format: + +| Previous | New | +| ---------------------------------------------------------------- | ------------------------------------------------------------ | +| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx new file mode 100644 index 000000000..169941254 --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx @@ -0,0 +1,113 @@ +--- +title: "24.3" +description: "Platform Enterprise update guidance" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + + +# Prerequisites + +Follow these steps to upgrade your database instance and Platform Enterprise installation: + +:::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 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. Restart the application. +1. If you're using a containerized database as part of your implementation: + 1. Stop the application. + 1. Upgrade the MySQL image. + 1. Restart the application. +1. If you're using Amazon RDS or other managed database services: + 1. Stop the application. + 1. Upgrade your database instance. + 1. Restart the application. +1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. + +### Custom deployments + +- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. +- Deploy Seqera following your usual procedures. + +### Nextflow launcher image + +If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: + + `TOWER_LAUNCH_CONTAINER=` + +:::caution +If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. +::: + + + +## Upgrading to v25.1 + +Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... + +:::warning +Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. +::: + +### Prerequisites +- Redis version 6.2 or greater is required. +- Redis version 7 is officially supported. +- MySQL 5.7 or greater is required. +- MySQL 8.0 or greater is officially supported. + +### Breaking changes + +#### Seqera AWS ECR repository customer access ends June 1, 2025 + +Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. + +**Action required:** + +- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. +- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. +- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. + +#### OIDC Secrets injection modifications + +The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. + +**Action required:** + +- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. +- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. + +:::note +Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). +::: + +#### MariaDB driver: New MySQL connection parameter required + +MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. + +**Action required:** + +# TODO - Remove version numbers. +- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: + `jdbc:mysql://:/tower?permitMysqlScheme=true` + + +**Action required:** + + `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` + +#### Micronaut property key changes + +The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. + +**Action required:** + +- If you have customized this value previously, update to the new format: + +| Previous | New | +| ---------------------------------------------------------------- | ------------------------------------------------------------ | +| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx new file mode 100644 index 000000000..7c19872bf --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx @@ -0,0 +1,113 @@ +--- +title: "25.1" +description: "Platform Enterprise update guidance" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + + +# Prerequisites + +Follow these steps to upgrade your database instance and Platform Enterprise installation: + +:::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 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. Restart the application. +1. If you're using a containerized database as part of your implementation: + 1. Stop the application. + 1. Upgrade the MySQL image. + 1. Restart the application. +1. If you're using Amazon RDS or other managed database services: + 1. Stop the application. + 1. Upgrade your database instance. + 1. Restart the application. +1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. + +### Custom deployments + +- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. +- Deploy Seqera following your usual procedures. + +### Nextflow launcher image + +If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: + + `TOWER_LAUNCH_CONTAINER=` + +:::caution +If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. +::: + + + +## Upgrading to v25.1 + +Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... + +:::warning +Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. +::: + +### Prerequisites +- Redis version 6.2 or greater is required. +- Redis version 7 is officially supported. +- MySQL 5.7 or greater is required. +- MySQL 8.0 or greater is officially supported. + +### Breaking changes + +#### Seqera AWS ECR repository customer access ends June 1, 2025 + +Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. + +**Action required:** + +- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. +- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. +- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. + +#### OIDC Secrets injection modifications + +The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. + +**Action required:** + +- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. +- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. + +:::note +Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). +::: + +#### MariaDB driver: New MySQL connection parameter required + +MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. + +**Action required:** + +# TODO - Remove version numbers. +- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: + `jdbc:mysql://:/tower?permitMysqlScheme=true` + + +**Action required:** + + `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` + +#### Micronaut property key changes + +The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. + +**Action required:** + +- If you have customized this value previously, update to the new format: + +| Previous | New | +| ---------------------------------------------------------------- | ------------------------------------------------------------ | +| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx new file mode 100644 index 000000000..45d14a6a6 --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx @@ -0,0 +1,8 @@ +--- +title: "Upgrade Strategies" +description: "Platform Enterprise update guidance" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + +Something Here. diff --git a/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json b/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json index ca6de0408..992e769f5 100644 --- a/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json +++ b/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json @@ -1,168 +1,177 @@ { - "platformSidebar": [ - "index", - { - "type": "category", - "label": "Installation", - "collapsed": true, - "link": { - "type": "doc", - "id": "enterprise/index" - }, - "items": [ - { - "type": "category", - "label": "Prerequisites", - "collapsed": true, - "items": [ - "enterprise/prerequisites/aws", - "enterprise/prerequisites/azure", - "enterprise/prerequisites/gcp", - "enterprise/prerequisites/on-prem" - ] - }, - { - "type": "category", - "label": "Configuration", - "collapsed": true, - "items": [ - "enterprise/configuration/overview", - "enterprise/configuration/authentication", - "enterprise/configuration/aws_parameter_store", - "enterprise/configuration/networking", - "enterprise/configuration/reverse_proxy", - "enterprise/configuration/ssl_tls", - "enterprise/configuration/pipeline_optimization", - "enterprise/configuration/wave", - "enterprise/studios" - ] - }, - { - "type": "category", - "label": "Deployment", - "collapsed": true, - "items": [ - "enterprise/docker-compose", - "enterprise/kubernetes", - "enterprise/testing", - "enterprise/upgrade" - ] - }, - { - "type": "category", - "label": "Advanced", - "collapsed": true, - "items": [ - "enterprise/advanced-topics/db-docker-to-RDS", - "enterprise/advanced-topics/use-iam-role", - "enterprise/advanced-topics/custom-launch-container", - "enterprise/advanced-topics/firewall-configuration", - "enterprise/advanced-topics/seqera-container-images" - ] - }, - "enterprise/general_troubleshooting" - ] - }, - { - "type": "category", - "label": "Tutorials", - "collapsed": true, - "items": [ - "getting-started/quickstart-demo/comm-showcase", - "getting-started/rnaseq", - "getting-started/proteinfold", - "getting-started/studios" - ] - }, - { - "type": "category", - "label": "Get started", - "collapsed": true, - "items": [ - "getting-started/deployment-options", - "getting-started/workspace-setup", - "getting-started/quickstart-demo/add-pipelines", - "getting-started/quickstart-demo/add-data", - "getting-started/quickstart-demo/launch-pipelines", - "getting-started/quickstart-demo/monitor-runs", - "getting-started/quickstart-demo/automation" - ] - }, - { - "type": "category", - "label": "Credentials", - "items": [ - "credentials/overview", - "git/overview", - { - "type": "category", - "label": "Container registry credentials", - "items": [ - "credentials/docker_hub_registry_credentials", - "credentials/aws_registry_credentials", - "credentials/azure_registry_credentials", - "credentials/google_registry_credentials", - "credentials/quay_registry_credentials", - "credentials/gitlab_registry_credentials", - "credentials/github_registry_credentials", - "credentials/gitea_registry_credentials" - ] - }, - "credentials/managed_identities", - "credentials/ssh_credentials", - "credentials/agent_credentials" - ] + "platformSidebar": [ + "index", + { + "type": "category", + "label": "Installation", + "collapsed": true, + "link": { + "type": "doc", + "id": "enterprise/index" }, - { - "type": "category", - "label": "Compute", - "items": [ - "compute-envs/overview", - { - "type": "category", - "label": "Cloud", - "items": [ - "compute-envs/aws-batch", - "compute-envs/azure-batch", - "compute-envs/google-cloud-batch", - "compute-envs/google-cloud-lifesciences", - "compute-envs/eks", - "compute-envs/gke", - "monitoring/cloud-costs" - ] - }, - "compute-envs/k8s", - "compute-envs/hpc", - "resource-labels/overview", - "supported_software/fusion/fusion", - "supported_software/agent/agent", - "supported_software/dragen/overview", - { - "type": "category", - "label": "Advanced options", - "items":[ - "enterprise/advanced-topics/manual-aws-batch-setup", - "enterprise/advanced-topics/manual-azure-batch-setup" - ] - } + "items": [ + { + "type": "category", + "label": "Prerequisites", + "collapsed": true, + "items": [ + "enterprise/prerequisites/aws", + "enterprise/prerequisites/azure", + "enterprise/prerequisites/gcp", + "enterprise/prerequisites/on-prem" ] - }, - { - "type": "category", - "label": "Data", - "items": [ - "data/data-explorer", - "data/datasets" - ] - }, - { - "type": "category", - "label": "Pipelines", - "items": [ - "pipeline-schema/overview", - "launch/launchpad", - "labels/overview", - { + }, + { + "type": "category", + "label": "Configuration", + "collapsed": true, + "items": [ + "enterprise/configuration/overview", + "enterprise/configuration/authentication", + "enterprise/configuration/aws_parameter_store", + "enterprise/configuration/networking", + "enterprise/configuration/reverse_proxy", + "enterprise/configuration/ssl_tls", + "enterprise/configuration/pipeline_optimization", + "enterprise/configuration/wave", + "enterprise/studios" + ] + }, + { + "type": "category", + "label": "Deployment", + "collapsed": true, + "items": [ + "enterprise/docker-compose", + "enterprise/kubernetes", + "enterprise/testing" + ] + }, + { + "type": "category", + "label": "Advanced", + "collapsed": true, + "items": [ + "enterprise/advanced-topics/db-docker-to-RDS", + "enterprise/advanced-topics/use-iam-role", + "enterprise/advanced-topics/custom-launch-container", + "enterprise/advanced-topics/firewall-configuration", + "enterprise/advanced-topics/seqera-container-images" + ] + }, + "enterprise/general_troubleshooting" + ] + }, + { + "type": "category", + "label": "Upgrade Seqera", + "collapsed": true, + "items": [ + "upgrade/strats", + "upgrade/25.1", + "upgrade/24.3", + "upgrade/24.2", + "upgrade/24.1" + ] + }, + { + "type": "category", + "label": "Get started", + "collapsed": true, + "items": [ + "getting-started/deployment-options", + "getting-started/workspace-setup", + "getting-started/quickstart-demo/add-pipelines", + "getting-started/quickstart-demo/add-data", + "getting-started/quickstart-demo/launch-pipelines", + "getting-started/quickstart-demo/monitor-runs", + "getting-started/quickstart-demo/automation" + ] + }, + { + "type": "category", + "label": "Tutorials", + "collapsed": true, + "items": [ + "getting-started/quickstart-demo/comm-showcase", + "getting-started/rnaseq", + "getting-started/proteinfold", + "getting-started/studios" + ] + }, + + { + "type": "category", + "label": "Credentials", + "items": [ + "credentials/overview", + "git/overview", + { + "type": "category", + "label": "Container registry credentials", + "items": [ + "credentials/docker_hub_registry_credentials", + "credentials/aws_registry_credentials", + "credentials/azure_registry_credentials", + "credentials/google_registry_credentials", + "credentials/quay_registry_credentials", + "credentials/gitlab_registry_credentials", + "credentials/github_registry_credentials", + "credentials/gitea_registry_credentials" + ] + }, + "credentials/managed_identities", + "credentials/ssh_credentials", + "credentials/agent_credentials" + ] + }, + { + "type": "category", + "label": "Compute", + "items": [ + "compute-envs/overview", + { + "type": "category", + "label": "Cloud", + "items": [ + "compute-envs/aws-batch", + "compute-envs/azure-batch", + "compute-envs/google-cloud-batch", + "compute-envs/google-cloud-lifesciences", + "compute-envs/eks", + "compute-envs/gke", + "monitoring/cloud-costs" + ] + }, + "compute-envs/k8s", + "compute-envs/hpc", + "resource-labels/overview", + "supported_software/fusion/fusion", + "supported_software/agent/agent", + "supported_software/dragen/overview", + { + "type": "category", + "label": "Advanced options", + "items": [ + "enterprise/advanced-topics/manual-aws-batch-setup", + "enterprise/advanced-topics/manual-azure-batch-setup" + ] + } + ] + }, + { + "type": "category", + "label": "Data", + "items": ["data/data-explorer", "data/datasets"] + }, + { + "type": "category", + "label": "Pipelines", + "items": [ + "pipeline-schema/overview", + "launch/launchpad", + "labels/overview", + { "type": "category", "label": "Monitor runs", "items": [ @@ -170,93 +179,85 @@ "monitoring/dashboard", "monitoring/run-details" ] - }, - "reports/overview", - "launch/cache-resume", - "secrets/overview", - "pipeline-optimization/overview", - "launch/advanced" - ] - }, - { - "type": "category", - "label": "Studios", - "items": [ - "studios/index", - "studios/custom-envs", - "studios/managing" - ] - }, - { - "type": "category", - "label": "Administration", - "items": [ - "administration/overview", - "orgs-and-teams/organizations", - "orgs-and-teams/workspace-management", - "orgs-and-teams/roles", - "monitoring/audit-logs" - ] - }, - { - "type": "category", - "label": "Developer tools", - "collapsed": true, - "items": [ - "api/overview", - { - "type": "category", - "label": "CLI", - "collapsed": true, - "items": [ - "cli/overview", - "cli/installation", - "cli/commands" - ] - }, - { - "type": "category", - "label": "Seqerakit", - "collapsed": true, - "items": [ - "seqerakit/installation", - "seqerakit/commands", - "seqerakit/yaml-configuration", - "seqerakit/templates" - ] - }, - "pipeline-actions/overview" + }, + "reports/overview", + "launch/cache-resume", + "secrets/overview", + "pipeline-optimization/overview", + "launch/advanced" + ] + }, + { + "type": "category", + "label": "Studios", + "items": ["studios/index", "studios/custom-envs", "studios/managing"] + }, + { + "type": "category", + "label": "Administration", + "items": [ + "administration/overview", + "orgs-and-teams/organizations", + "orgs-and-teams/workspace-management", + "orgs-and-teams/roles", + "monitoring/audit-logs" + ] + }, + { + "type": "category", + "label": "Developer tools", + "collapsed": true, + "items": [ + "api/overview", + { + "type": "category", + "label": "CLI", + "collapsed": true, + "items": ["cli/overview", "cli/installation", "cli/commands"] + }, + { + "type": "category", + "label": "Seqerakit", + "collapsed": true, + "items": [ + "seqerakit/installation", + "seqerakit/commands", + "seqerakit/yaml-configuration", + "seqerakit/templates" ] - }, - { - "type": "category", - "label": "Reference", - "collapsed": true, - "items": [ - "functionality_matrix/functionality_matrix", - "data-privacy/overview", - "limits/limits" - ] - }, - { - "type": "link", - "label": "Enterprise changelog", - "href": "/changelog/tags/seqera-enterprise" - }, - { - "type": "category", - "label": "Troubleshooting", - "collapsed": true, - "items": [ - "troubleshooting_and_faqs/troubleshooting", - "troubleshooting_and_faqs/api_and_cli", - "troubleshooting_and_faqs/studios_troubleshooting", - "troubleshooting_and_faqs/nextflow", - "troubleshooting_and_faqs/aws_troubleshooting", - "troubleshooting_and_faqs/azure_troubleshooting", - "troubleshooting_and_faqs/workspaces_troubleshooting", - "troubleshooting_and_faqs/datasets_troubleshooting" - ] - } - ] - } \ No newline at end of file + }, + "pipeline-actions/overview" + ] + }, + { + "type": "category", + "label": "Reference", + "collapsed": true, + "items": [ + "functionality_matrix/functionality_matrix", + "data-privacy/overview", + "limits/limits" + ] + }, + { + "type": "link", + "label": "Enterprise changelog", + "href": "/changelog/tags/seqera-enterprise" + }, + { + "type": "category", + "label": "Troubleshooting", + "collapsed": true, + "items": [ + "troubleshooting_and_faqs/troubleshooting", + "troubleshooting_and_faqs/api_and_cli", + "troubleshooting_and_faqs/studios_troubleshooting", + "troubleshooting_and_faqs/nextflow", + "troubleshooting_and_faqs/aws_troubleshooting", + "troubleshooting_and_faqs/azure_troubleshooting", + "troubleshooting_and_faqs/workspaces_troubleshooting", + "troubleshooting_and_faqs/datasets_troubleshooting" + ] + } + ] +} From 3e0b4f0a68797310ca5c7a9a562de6cc1485405b Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 1 May 2025 16:06:45 +0100 Subject: [PATCH 4/9] Provide a smaller breaking changes index --- .../version-25.1/upgrade/24.1.mdx | 111 ---------------- .../version-25.1/upgrade/24.2.mdx | 113 ---------------- .../version-25.1/upgrade/24.3.mdx | 113 ---------------- .../version-25.1/upgrade/25.1.mdx | 122 ++++++------------ .../version-25.1/upgrade/breaking-changes.mdx | 66 ++++++++++ .../version-25.1/upgrade/index.mdx | 19 +++ .../version-25.1/upgrade/strats.mdx | 8 -- .../version-25.1/upgrade/upgrade-template.mdx | 47 +++++++ .../version-25.1-sidebars.json | 11 +- 9 files changed, 181 insertions(+), 429 deletions(-) delete mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx delete mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx delete mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx delete mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx create mode 100644 platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx deleted file mode 100644 index 870d1fdfd..000000000 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.1.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "24.1" -description: "Platform Enterprise update guidance" -date: "21 Aug 2024" -tags: [enterprise, update, install] ---- - - -# Prerequisites - -Follow these steps to upgrade your database instance and Platform Enterprise installation: - -:::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 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. Restart the application. -1. If you're using a containerized database as part of your implementation: - 1. Stop the application. - 1. Upgrade the MySQL image. - 1. Restart the application. -1. If you're using Amazon RDS or other managed database services: - 1. Stop the application. - 1. Upgrade your database instance. - 1. Restart the application. -1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. - -### Custom deployments - -- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. -- Deploy Seqera following your usual procedures. - -### Nextflow launcher image - -If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: - - `TOWER_LAUNCH_CONTAINER=` - -:::caution -If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. -::: - -## Upgrading to v25.1 - -Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... - -:::warning -Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. -::: - -### Prerequisites -- Redis version 6.2 or greater is required. -- Redis version 7 is officially supported. -- MySQL 5.7 or greater is required. -- MySQL 8.0 or greater is officially supported. - -### Breaking changes - -#### Seqera AWS ECR repository customer access ends June 1, 2025 - -Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. - -**Action required:** - -- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. -- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. -- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. - -#### OIDC Secrets injection modifications - -The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. - -**Action required:** - -- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. -- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. - -:::note -Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). -::: - -#### MariaDB driver: New MySQL connection parameter required - -MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. - -**Action required:** - -# TODO - Remove version numbers. -- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: - `jdbc:mysql://:/tower?permitMysqlScheme=true` - - -**Action required:** - - `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` - -#### Micronaut property key changes - -The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. - -**Action required:** - -- If you have customized this value previously, update to the new format: - -| Previous | New | -| ---------------------------------------------------------------- | ------------------------------------------------------------ | -| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx deleted file mode 100644 index 59f912b73..000000000 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.2.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "24.2" -description: "Platform Enterprise update guidance" -date: "21 Aug 2024" -tags: [enterprise, update, install] ---- - - -# Prerequisites - -Follow these steps to upgrade your database instance and Platform Enterprise installation: - -:::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 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. Restart the application. -1. If you're using a containerized database as part of your implementation: - 1. Stop the application. - 1. Upgrade the MySQL image. - 1. Restart the application. -1. If you're using Amazon RDS or other managed database services: - 1. Stop the application. - 1. Upgrade your database instance. - 1. Restart the application. -1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. - -### Custom deployments - -- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. -- Deploy Seqera following your usual procedures. - -### Nextflow launcher image - -If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: - - `TOWER_LAUNCH_CONTAINER=` - -:::caution -If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. -::: - - - -## Upgrading to v25.1 - -Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... - -:::warning -Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. -::: - -### Prerequisites -- Redis version 6.2 or greater is required. -- Redis version 7 is officially supported. -- MySQL 5.7 or greater is required. -- MySQL 8.0 or greater is officially supported. - -### Breaking changes - -#### Seqera AWS ECR repository customer access ends June 1, 2025 - -Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. - -**Action required:** - -- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. -- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. -- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. - -#### OIDC Secrets injection modifications - -The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. - -**Action required:** - -- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. -- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. - -:::note -Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). -::: - -#### MariaDB driver: New MySQL connection parameter required - -MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. - -**Action required:** - -# TODO - Remove version numbers. -- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: - `jdbc:mysql://:/tower?permitMysqlScheme=true` - - -**Action required:** - - `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` - -#### Micronaut property key changes - -The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. - -**Action required:** - -- If you have customized this value previously, update to the new format: - -| Previous | New | -| ---------------------------------------------------------------- | ------------------------------------------------------------ | -| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx deleted file mode 100644 index 169941254..000000000 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/24.3.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "24.3" -description: "Platform Enterprise update guidance" -date: "21 Aug 2024" -tags: [enterprise, update, install] ---- - - -# Prerequisites - -Follow these steps to upgrade your database instance and Platform Enterprise installation: - -:::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 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. Restart the application. -1. If you're using a containerized database as part of your implementation: - 1. Stop the application. - 1. Upgrade the MySQL image. - 1. Restart the application. -1. If you're using Amazon RDS or other managed database services: - 1. Stop the application. - 1. Upgrade your database instance. - 1. Restart the application. -1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. - -### Custom deployments - -- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. -- Deploy Seqera following your usual procedures. - -### Nextflow launcher image - -If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: - - `TOWER_LAUNCH_CONTAINER=` - -:::caution -If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. -::: - - - -## Upgrading to v25.1 - -Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... - -:::warning -Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. -::: - -### Prerequisites -- Redis version 6.2 or greater is required. -- Redis version 7 is officially supported. -- MySQL 5.7 or greater is required. -- MySQL 8.0 or greater is officially supported. - -### Breaking changes - -#### Seqera AWS ECR repository customer access ends June 1, 2025 - -Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. - -**Action required:** - -- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. -- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. -- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. - -#### OIDC Secrets injection modifications - -The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. - -**Action required:** - -- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. -- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. - -:::note -Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). -::: - -#### MariaDB driver: New MySQL connection parameter required - -MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. - -**Action required:** - -# TODO - Remove version numbers. -- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: - `jdbc:mysql://:/tower?permitMysqlScheme=true` - - -**Action required:** - - `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` - -#### Micronaut property key changes - -The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. - -**Action required:** - -- If you have customized this value previously, update to the new format: - -| Previous | New | -| ---------------------------------------------------------------- | ------------------------------------------------------------ | -| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx index 7c19872bf..801c2629c 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx @@ -5,109 +5,73 @@ date: "21 Aug 2024" tags: [enterprise, update, install] --- +# Upgrade to Seqera Enterprise 25.1 -# Prerequisites +To benefit from the latest fixes and enhancements, we recommend upgrading Seqera regularly. -Follow these steps to upgrade your database instance and Platform Enterprise installation: +Seqera supports the latest patch versions of the current and previous major releases (e.g., 25.x and 24.x). Upgrades must proceed one major version at a time. -:::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 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. Restart the application. -1. If you're using a containerized database as part of your implementation: - 1. Stop the application. - 1. Upgrade the MySQL image. - 1. Restart the application. -1. If you're using Amazon RDS or other managed database services: - 1. Stop the application. - 1. Upgrade your database instance. - 1. Restart the application. -1. If you're using the pipeline optimization service (`groundswell` database) in a database separate from your Seqera database, update the MySQL image for your `groundswell` database instance while the application is down (during step 4 or 5 above). If you're using the same database instance for both, the `groundswell` update will happen automatically during the Seqera database update. - -### Custom deployments - -- Run the `/migrate-db.sh` script provided in the `migrate-db` container. This will migrate the database schema. -- Deploy Seqera following your usual procedures. +Alongside standard upgrade steps, some versions may include additional tasks specific to that release. -### Nextflow launcher image +:::warning[Version compatibility] +Seqera is backward-compatible with the previous version. As such, existing pipelines, workspaces, and studios will continue to function. -If you must host your nf-launcher container image on a private image registry, copy the [nf-launcher image](https://quay.io/seqeralabs/nf-launcher:j17-24.04.4) to your private registry. Then update your `tower.env` with the launch container environment variable: +However, default values for components (such as Nextflow) may change between versions. This can require updates to specific pipeline definitions or syntax to ensure compatibility. - `TOWER_LAUNCH_CONTAINER=` - -:::caution -If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container.mdx) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. +Please refer to the [functionality matrix](../functionality_matrix) for detailed information regarding default component versions. ::: +# Pre-upgrade Planning +The following external services are required for a deployment of Seqera Platform Enterprise: -## Upgrading to v25.1 - -Seqera Enterprise 25.1 is a major version release as such this requires downtime for reasons... - -:::warning -Upgrading to version 25.1 requires backend downtime in order for the database migration to complete successfully. Do not start the upgrade while any pipelines are in a `running` state as active run data may be lost. -::: +- **Redis**: Version 7 is officially supported (minimum required version is 6.2). +- **MySQL**: Version 8 is officially supported (minimum required version is 5.7). -### Prerequisites -- Redis version 6.2 or greater is required. -- Redis version 7 is officially supported. -- MySQL 5.7 or greater is required. -- MySQL 8.0 or greater is officially supported. +# Seqera container images -### Breaking changes +Seqera is distributed as a collection of containers available through the [Seqera container registry](https://cr.seqera.io). +To obtain access credentials, please contact [Seqera Support](https://support.seqera.io). -#### Seqera AWS ECR repository customer access ends June 1, 2025 +For production deployments, we recommend mirroring these containers to your own registry to enhance stability and reliability. -Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. +Seqera images publised as part of this release are available at -**Action required:** - -- The installation and configuration templates provided for both [Docker Compose](https://docs.seqera.io/platform-enterprise/25.1/enterprise/docker-compose) and [Kubernetes](https://docs.seqera.io/platform-enterprise/25.1/enterprise/kubernetes) installations already reference the `cr.seqera.io` container image URLs. -- If you have not yet transitioned to this registry, [contact Support](https://support.seqera.io) to request credentials and for any further assistance. -- See [Legacy Seqera container image registries](https://docs.seqera.io/platform/25.1/platform-enterprise/advanced-topics/seqera-container-images) for more information. - -#### OIDC Secrets injection modifications - -The `auth-oidc-secrets` Micronaut environment has been replaced with `oidc-token-import`. - -**Action required:** - -- If you use this configuration, you must change the `MICRONAUT_ENV` environment variable in the manifest during the migration process. -- If you activate the feature with the `TOWER_OIDC_TOKEN_IMPORT` environment variable, no changes are needed. - -:::note -Set `TOWER_REDIS_*` values directly in the `tower.yml` or AWS Parameter Store entry (for example, `TOWER_REDIS_URL: redis://...`). -::: +- cr.seqera.io/private/nf-tower-enterprise/frontend:v25.1.1 +- cr.seqera.io/private/nf-tower-enterprise/backend:v25.1.1 +- cr.seqera.io/private/nf-tower-enterprise/migrate-db:v25.1.1 -#### MariaDB driver: New MySQL connection parameter required +# Back up Seqera -MariaDB driver 3.x requires a special parameter in the connection URL to connect to a MySQL database. +MySQL -**Action required:** +```shell +backup: +> mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql -# TODO - Remove version numbers. -- All deployments using a MySQL database (regardless of version: 5.6, 5.7, or 8) must update their connection string to: - `jdbc:mysql://:/tower?permitMysqlScheme=true` +restore: +> mysql -u root -p [seqera_db_identifier] < seqera_backup.sql +``` +# Breaking changes and migration requirements -**Action required:** +Seqera Platform contains no breaking changes for the 25.1 release. - `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` +# Upgrade Seqera -#### Micronaut property key changes +## Upgrade Steps. -The property that determines the expiration time of the JWT access token has changed as of Seqera Enterprise version 24.1. +1. Stop all running services and pipelines. +1. Perform database migrations. +1. Start the backend +1. Start the frontend -**Action required:** +# Support -- If you have customized this value previously, update to the new format: +For assistance with your upgrade, please contact [Seqera Support](https://support.seqera.io) with the following information: -| Previous | New | -| ---------------------------------------------------------------- | ------------------------------------------------------------ | -| `micronaut.security.token.jwt.generator.access-token.expiration` | `micronaut.security.token.generator.access-token.expiration` | +- Your current Seqera version +- Your current MySQL version +- You current Redis version +- Details of your deployment environment +- Any error messages or logs from the upgrade process diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx new file mode 100644 index 000000000..7bb4e909e --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx @@ -0,0 +1,66 @@ +--- +title: "Breaking Changes" +description: "Upgrading Seqera Enterprise" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + +# Breaking changes in Seqera Platform + +Seqera attempts to limit the number of breaking changes we introduce between releases however changes to underlying libraries used as part of our application development may lead to changes being required between upgrades. + +While we prioritize backward compatibility with MySQL and Redis, **compatibility with end-of-life (EOL) versions is not guaranteed**. Any guidance for EOL components is offered on a best-effort basis, and we strongly recommend upgrading to officially supported versions for long-term stability. + +Seqera Platform Enterprise is tested and validated against MySQL 8 and Redis versions 6.2 and greater. + +:::note +- MySQL version 5.6 reached EOL in **February 2021** +- MySQL version 5.7 reached EOL in **October 2023** +::: + +## v25.1 +- No breaking changes reported + +## v24.2 +- **Seqera AWS ECR repository customer access ends June 1, 2025**: Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. + +- **Redis version change**: + - Redis version 6.2 or greater is required + - Redis version 7 is officially supported + +- **Redisson properties deprecated**: + - `/redisson/*` references in AWS Parameter Store entries should be replaced with `TOWER_REDIS_*` + - `redisson.*` references in `tower.yml` should be replaced with `TOWER_REDIS_*` + +## v24.1 +- **MariaDB driver: New MySQL connection parameter required**: + - MariaDB driver 3.x requires a special parameter in the connection URL: `jdbc:mysql://:/tower?permitMysqlScheme=true` + - All deployments using MySQL database (regardless of version) should be updated when upgrading to Platform version 24.1 or later + +- **MariaDB driver: No truncation support for MySQL 5.6**: + - The MariaDB driver has dropped support for the `jdbcCompliantTruncation` parameter + - For MySQL 5.6 deployments, SQL mode must be set explicitly: `jdbc:mysql://:/tower?permitMysqlScheme=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'` + +- **Micronaut property key changes**: + - Changed from `micronaut.security.token.jwt.generator.access-token.expiration` to `micronaut.security.token.generator.access-token.expiration` + +## v23.4 +- **Docker Compose V2 supersedes standalone docker-compose**: The Docker Compose CLI plugin replaces the standalone `docker-compose` binary, which was deprecated by DockerHub in July 2023 by Compose V2. The installation documentation now uses the `docker compose` subcommand for the Docker CLI when using compose files. + +- **Login redirection logic update**: Seqera now prepends the `TOWER_SERVER_URL` to the authentication redirect URL during the login flow. This is useful when your server URL contains a contextual path. + +- **Revert default Tower name changes in documentation**: Legacy `tower` values and naming conventions used by the Seqera backend will remain in place until a future release. + +- **ARM64 CPU architecture support enabled by default**: The `TOWER_ENABLE_ARM64` configuration environment variable is no longer needed to enable ARM64 CPU architecture support. + +- **Data Explorer default set to `false`**: From version 2.4.3, the default is `TOWER_DATA_EXPLORER_ENABLED=false`. + +## v23.3 +- **Login redirection logic update**: Seqera now prepends the `TOWER_SERVER_URL` to the authentication redirect URL during the login flow. + +- **Revert default Tower name changes in documentation**: Legacy `tower` values and naming conventions used by the Seqera backend will remain in place until a future release. + +## v23.2 +- **Updated AWS permissions policies**: Several new Tower features require updated AWS IAM permissions policies. + +- **Wave requires container registry credentials**: The Wave containers service uses container registry credentials in Tower to authenticate to container registries, separate from existing cloud provider credentials. diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx new file mode 100644 index 000000000..5f204a007 --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx @@ -0,0 +1,19 @@ +--- +title: "Upgrade Seqera" +description: "Upgrading Seqera Enterprise" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + +# Upgrade Seqera + +We recommend that you upgrade Seqera often to stay current with the latest fixes and enhancements. You can upgrade to any of the supported releases from any supported release. + +To learn what's available in a Seqera release, refer to the [Enterprise Changelog](https://docs.seqera.io/changelog/tags/seqera-enterprise). + +Refer to any of the following upgrade guides: + +- [Upgrade to v25.1](./upgrade/25.1) +- [Upgrade to v24.3](./upgrade/24.3) +- [Upgrade to v24.2](./upgrade/24.2) +- [Upgrade to v24.1](./upgrade/24.1) diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx deleted file mode 100644 index 45d14a6a6..000000000 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/strats.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Upgrade Strategies" -description: "Platform Enterprise update guidance" -date: "21 Aug 2024" -tags: [enterprise, update, install] ---- - -Something Here. diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx new file mode 100644 index 000000000..c18ea2914 --- /dev/null +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx @@ -0,0 +1,47 @@ +--- +title: "25.1" +description: "Platform Enterprise update guidance" +date: "21 Aug 2024" +tags: [enterprise, update, install] +--- + + +We recommend that you upgrade Seqera often to stay current with the latest fixes and enhancements. + +In addition to common tasks you should complete for all versions of Seqera, there might be additional upgrade tasks to complete for a version. + +!!!note +There might be breaking changes in some releases we document these in the following section. + +# External Services + +The following external services are required for a deployment of Seqera Platform Enterprise: + +- **Redis**: Version 7 is officially supported (minimum required version is 6.2). +- **MySQL**: Version 8 is officially supported (minimum required version is 5.7). + +# Back up Seqera + +MySQL + +```shell +backup: +> mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql + +restore: +> mysql -u root -p [seqera_db_identifier] < seqera_backup.sql + +# Upgrade Seqera + +## Upgrade Steps. + +1 - Stop all running services and pipelines. + +2 - Perform database migrations. +3 - Start the backend +4 - Start the frontend + +## Docker Compose + + +## Kubernetes diff --git a/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json b/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json index 992e769f5..51408fd64 100644 --- a/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json +++ b/platform-enterprise_versioned_sidebars/version-25.1-sidebars.json @@ -66,12 +66,13 @@ "type": "category", "label": "Upgrade Seqera", "collapsed": true, + "link": { + "type": "doc", + "id": "upgrade/index" + }, "items": [ - "upgrade/strats", - "upgrade/25.1", - "upgrade/24.3", - "upgrade/24.2", - "upgrade/24.1" + "upgrade/breaking-changes", + "upgrade/25.1" ] }, { From 196428c04fba7157d7fb6d062a60a83c39d5b283 Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 1 May 2025 16:23:26 +0100 Subject: [PATCH 5/9] remove non-breaking breaking changes --- .../version-25.1/upgrade/breaking-changes.mdx | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx index 7bb4e909e..d4edbabcb 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx @@ -15,7 +15,7 @@ Seqera Platform Enterprise is tested and validated against MySQL 8 and Redis ver :::note - MySQL version 5.6 reached EOL in **February 2021** -- MySQL version 5.7 reached EOL in **October 2023** +- MySQL version 5.7 reached EOL in **October 2023** ::: ## v25.1 @@ -45,11 +45,6 @@ Seqera Platform Enterprise is tested and validated against MySQL 8 and Redis ver - Changed from `micronaut.security.token.jwt.generator.access-token.expiration` to `micronaut.security.token.generator.access-token.expiration` ## v23.4 -- **Docker Compose V2 supersedes standalone docker-compose**: The Docker Compose CLI plugin replaces the standalone `docker-compose` binary, which was deprecated by DockerHub in July 2023 by Compose V2. The installation documentation now uses the `docker compose` subcommand for the Docker CLI when using compose files. - -- **Login redirection logic update**: Seqera now prepends the `TOWER_SERVER_URL` to the authentication redirect URL during the login flow. This is useful when your server URL contains a contextual path. - -- **Revert default Tower name changes in documentation**: Legacy `tower` values and naming conventions used by the Seqera backend will remain in place until a future release. - **ARM64 CPU architecture support enabled by default**: The `TOWER_ENABLE_ARM64` configuration environment variable is no longer needed to enable ARM64 CPU architecture support. From e1eaf45354170a4b48755af18ded5f47ff5631cf Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 1 May 2025 16:44:54 +0100 Subject: [PATCH 6/9] Ready for review --- .../version-25.1/upgrade/25.1.mdx | 69 +++++++++++++++---- 1 file changed, 54 insertions(+), 15 deletions(-) diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx index 801c2629c..94067b7aa 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx @@ -21,29 +21,31 @@ However, default values for components (such as Nextflow) may change between ver Please refer to the [functionality matrix](../functionality_matrix) for detailed information regarding default component versions. ::: -# Pre-upgrade Planning +## Pre-upgrade Planning The following external services are required for a deployment of Seqera Platform Enterprise: - **Redis**: Version 7 is officially supported (minimum required version is 6.2). - **MySQL**: Version 8 is officially supported (minimum required version is 5.7). -# Seqera container images +## Container Images Seqera is distributed as a collection of containers available through the [Seqera container registry](https://cr.seqera.io). To obtain access credentials, please contact [Seqera Support](https://support.seqera.io). For production deployments, we recommend mirroring these containers to your own registry to enhance stability and reliability. -Seqera images publised as part of this release are available at +Seqera images published as part of this release are available at: - cr.seqera.io/private/nf-tower-enterprise/frontend:v25.1.1 - cr.seqera.io/private/nf-tower-enterprise/backend:v25.1.1 - cr.seqera.io/private/nf-tower-enterprise/migrate-db:v25.1.1 -# Back up Seqera +## Database Backup -MySQL +Seqera version upgrades may include database schema and data modifications. Before proceeding with any upgrade, create a complete backup of your Seqera Platform database and any associated database instances. + +To create a backup of your MySQL database: ```shell backup: @@ -53,25 +55,62 @@ restore: > mysql -u root -p [seqera_db_identifier] < seqera_backup.sql ``` -# Breaking changes and migration requirements +:::tip +- Store your backup in a secure location separate from your production environment +- Verify the backup file size and contents before proceeding with the upgrade +::: -Seqera Platform contains no breaking changes for the 25.1 release. +If you're using a managed database service (such as Amazon RDS), follow your provider's recommended backup procedures. For containerized databases, ensure your volume mounts are properly configured to persist data. + +## Docker Compose Configuration + +For Docker Compose deployments, the upgrade process requires updating configuration files and container versions. Refer to the [Docker Compose deployment guide](../enterprise/docker-compose) for detailed instructions. + +### Configuration Files + +Key configuration files to review and update: + +- `docker-compose.yml`: Update container image versions to 25.1.1 +- `tower.env`: Verify environment variables and configuration values +- `configmap.yml`: Review and update any custom configurations + +### Documentation -# Upgrade Seqera +For detailed configuration options and deployment instructions, refer to: +- [Docker Compose deployment](../enterprise/docker-compose) +- [Configuration overview](../enterprise/configuration/overview) +- [Environment variables](../enterprise/configuration/overview#environment-variables) -## Upgrade Steps. +## Kubernetes Configuration -1. Stop all running services and pipelines. -1. Perform database migrations. -1. Start the backend -1. Start the frontend +For Kubernetes deployments, the upgrade process requires updating manifests and container versions. Refer to the [Kubernetes deployment guide](../enterprise/kubernetes) for detailed instructions. + +### Configuration Files + +Key configuration files to review and update: + +- `tower-cron.yml`: Update container image versions to 25.1.1 +- `tower-svc.yml`: Update container image versions to 25.1.1 +- `configmap.yml`: Review and update any custom configurations +- `tower.env`: Verify environment variables and configuration values + +### Documentation + +For detailed configuration options and deployment instructions, refer to: +- [Kubernetes deployment](../enterprise/kubernetes) +- [Configuration overview](../enterprise/configuration/overview) +- [Environment variables](../enterprise/configuration/overview#environment-variables) + +## Breaking Changes + +Seqera Platform contains no breaking changes for the 25.1 release. -# Support +## Support For assistance with your upgrade, please contact [Seqera Support](https://support.seqera.io) with the following information: - Your current Seqera version - Your current MySQL version -- You current Redis version +- Your current Redis version - Details of your deployment environment - Any error messages or logs from the upgrade process From d4c317480e255c47cab47e15cbf34e786e82de5a Mon Sep 17 00:00:00 2001 From: Gavin Elder Date: Thu, 5 Feb 2026 16:52:07 +0000 Subject: [PATCH 7/9] fix: Improve voice and tone in upgrade documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Applied editorial improvements across all upgrade documentation files: Voice and tone fixes: - Removed "we" language (changed to direct statements) - Converted passive voice to active voice - Changed future tense to present tense where appropriate - Used imperative voice for instructions Clarity improvements: - Fixed malformed admonition syntax (!!!note → :::note:::) - Improved code block formatting (added # for shell comments) - Fixed incomplete sentences and punctuation - Standardized numbered list formatting Files updated: - platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx - platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx - platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx - platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx - platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md Co-Authored-By: Claude Sonnet 4.5 --- .../version-25.1/enterprise/upgrade.md | 2 +- .../version-25.1/upgrade/25.1.mdx | 12 +++---- .../version-25.1/upgrade/breaking-changes.mdx | 10 +++--- .../version-25.1/upgrade/index.mdx | 2 +- .../version-25.1/upgrade/upgrade-template.mdx | 31 ++++++++++--------- 5 files changed, 29 insertions(+), 28 deletions(-) diff --git a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md index f97229652..300103d46 100644 --- a/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md +++ b/platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md @@ -49,5 +49,5 @@ If you host your nf-launcher container image on a private image registry, copy t `TOWER_LAUNCH_CONTAINER=` :::caution -If you're using AWS Batch, you will need to [configure a custom job definition](./advanced-topics/custom-launch-container) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. +If you use AWS Batch, [configure a custom job definition](./advanced-topics/custom-launch-container) and populate the `TOWER_LAUNCH_CONTAINER` with the job definition name instead. ::: diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx index 94067b7aa..8bd108a1a 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx @@ -7,7 +7,7 @@ tags: [enterprise, update, install] # Upgrade to Seqera Enterprise 25.1 -To benefit from the latest fixes and enhancements, we recommend upgrading Seqera regularly. +Upgrade Seqera regularly to benefit from the latest fixes and enhancements. Seqera supports the latest patch versions of the current and previous major releases (e.g., 25.x and 24.x). Upgrades must proceed one major version at a time. @@ -33,7 +33,7 @@ The following external services are required for a deployment of Seqera Platform Seqera is distributed as a collection of containers available through the [Seqera container registry](https://cr.seqera.io). To obtain access credentials, please contact [Seqera Support](https://support.seqera.io). -For production deployments, we recommend mirroring these containers to your own registry to enhance stability and reliability. +For production deployments, mirror these containers to your own registry to enhance stability and reliability. Seqera images published as part of this release are available at: @@ -48,11 +48,11 @@ Seqera version upgrades may include database schema and data modifications. Befo To create a backup of your MySQL database: ```shell -backup: -> mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql +# backup: +mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql -restore: -> mysql -u root -p [seqera_db_identifier] < seqera_backup.sql +# restore: +mysql -u root -p [seqera_db_identifier] < seqera_backup.sql ``` :::tip diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx index d4edbabcb..fb5ad168e 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx @@ -7,15 +7,15 @@ tags: [enterprise, update, install] # Breaking changes in Seqera Platform -Seqera attempts to limit the number of breaking changes we introduce between releases however changes to underlying libraries used as part of our application development may lead to changes being required between upgrades. +Seqera limits breaking changes between releases. However, changes to underlying libraries used in application development may require configuration changes during upgrades. -While we prioritize backward compatibility with MySQL and Redis, **compatibility with end-of-life (EOL) versions is not guaranteed**. Any guidance for EOL components is offered on a best-effort basis, and we strongly recommend upgrading to officially supported versions for long-term stability. +Seqera prioritizes backward compatibility with MySQL and Redis. However, **compatibility with end-of-life (EOL) versions is not guaranteed**. Seqera provides guidance for EOL components on a best-effort basis. Upgrade to officially supported versions for long-term stability. Seqera Platform Enterprise is tested and validated against MySQL 8 and Redis versions 6.2 and greater. :::note - MySQL version 5.6 reached EOL in **February 2021** -- MySQL version 5.7 reached EOL in **October 2023** +- MySQL version 5.7 reached EOL in **October 2023** ::: ## v25.1 @@ -24,11 +24,11 @@ Seqera Platform Enterprise is tested and validated against MySQL 8 and Redis ver ## v24.2 - **Seqera AWS ECR repository customer access ends June 1, 2025**: Customers will no longer be able to pull Seqera Enterprise container images from the legacy Seqera AWS ECR repository after June 1, 2025. All Seqera Enterprise images must be retrieved via the `cr.seqera.io` container registry after this cutoff date. -- **Redis version change**: +- **Redis version change**: - Redis version 6.2 or greater is required - Redis version 7 is officially supported -- **Redisson properties deprecated**: +- **Redisson properties deprecated**: - `/redisson/*` references in AWS Parameter Store entries should be replaced with `TOWER_REDIS_*` - `redisson.*` references in `tower.yml` should be replaced with `TOWER_REDIS_*` diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx index 5f204a007..289aab28d 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/index.mdx @@ -7,7 +7,7 @@ tags: [enterprise, update, install] # Upgrade Seqera -We recommend that you upgrade Seqera often to stay current with the latest fixes and enhancements. You can upgrade to any of the supported releases from any supported release. +Upgrade Seqera regularly to stay current with the latest fixes and enhancements. You can upgrade to any of the supported releases from any supported release. To learn what's available in a Seqera release, refer to the [Enterprise Changelog](https://docs.seqera.io/changelog/tags/seqera-enterprise). diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx index c18ea2914..6d237aa21 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx @@ -6,12 +6,13 @@ tags: [enterprise, update, install] --- -We recommend that you upgrade Seqera often to stay current with the latest fixes and enhancements. +Upgrade Seqera regularly to stay current with the latest fixes and enhancements. -In addition to common tasks you should complete for all versions of Seqera, there might be additional upgrade tasks to complete for a version. +In addition to common tasks you should complete for all versions of Seqera, some versions include additional upgrade tasks. -!!!note -There might be breaking changes in some releases we document these in the following section. +:::note +Some releases include breaking changes documented in the following section. +::: # External Services @@ -22,24 +23,24 @@ The following external services are required for a deployment of Seqera Platform # Back up Seqera -MySQL +To create a backup of your MySQL database: ```shell -backup: -> mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql +# backup: +mysqldump -u root -p[root_password] [seqera_db_identifier] > seqera_backup.sql -restore: -> mysql -u root -p [seqera_db_identifier] < seqera_backup.sql +# restore: +mysql -u root -p [seqera_db_identifier] < seqera_backup.sql +``` # Upgrade Seqera -## Upgrade Steps. +## Upgrade Steps -1 - Stop all running services and pipelines. - -2 - Perform database migrations. -3 - Start the backend -4 - Start the frontend +1. Stop all running services and pipelines. +2. Perform database migrations. +3. Start the backend. +4. Start the frontend. ## Docker Compose From c4f321e52846a29fb4e0f9a887c409b44e553709 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Thu, 5 Feb 2026 19:59:04 +0200 Subject: [PATCH 8/9] Update v25.1.md Signed-off-by: Justine Geffen --- changelog/seqera-enterprise/v25.1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/seqera-enterprise/v25.1.md b/changelog/seqera-enterprise/v25.1.md index 9688156e5..8ac269ec0 100644 --- a/changelog/seqera-enterprise/v25.1.md +++ b/changelog/seqera-enterprise/v25.1.md @@ -4,7 +4,7 @@ date: 2025-04-09 tags: [seqera enterprise] --- -# Seqera Enterprise v25.1 Release Notes +# Seqera Enterprise v25.1 release notes Seqera Platform Enterprise version 25.1 introduces Studios GA and a number of bug fixes and performance enhancements. From 1a9a20a43069e7021f953092cf025aa484b803b5 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Thu, 5 Feb 2026 20:02:51 +0200 Subject: [PATCH 9/9] Update 25.1.mdx Signed-off-by: Justine Geffen --- .../version-25.1/upgrade/25.1.mdx | 27 +++++++++---------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx index 8bd108a1a..fb70f3f1a 100644 --- a/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx +++ b/platform-enterprise_versioned_docs/version-25.1/upgrade/25.1.mdx @@ -21,19 +21,16 @@ However, default values for components (such as Nextflow) may change between ver Please refer to the [functionality matrix](../functionality_matrix) for detailed information regarding default component versions. ::: -## Pre-upgrade Planning +## Pre-upgrade planning The following external services are required for a deployment of Seqera Platform Enterprise: - **Redis**: Version 7 is officially supported (minimum required version is 6.2). - **MySQL**: Version 8 is officially supported (minimum required version is 5.7). -## Container Images +## Container images -Seqera is distributed as a collection of containers available through the [Seqera container registry](https://cr.seqera.io). -To obtain access credentials, please contact [Seqera Support](https://support.seqera.io). - -For production deployments, mirror these containers to your own registry to enhance stability and reliability. +Seqera is distributed as a collection of containers available through the [Seqera container registry](https://cr.seqera.io). To obtain access credentials, please contact [Seqera Support](https://support.seqera.io). For production deployments, mirror these containers to your own registry to enhance stability and reliability. Seqera images published as part of this release are available at: @@ -41,7 +38,7 @@ Seqera images published as part of this release are available at: - cr.seqera.io/private/nf-tower-enterprise/backend:v25.1.1 - cr.seqera.io/private/nf-tower-enterprise/migrate-db:v25.1.1 -## Database Backup +## Database backup Seqera version upgrades may include database schema and data modifications. Before proceeding with any upgrade, create a complete backup of your Seqera Platform database and any associated database instances. @@ -56,17 +53,17 @@ mysql -u root -p [seqera_db_identifier] < seqera_backup.sql ``` :::tip -- Store your backup in a secure location separate from your production environment -- Verify the backup file size and contents before proceeding with the upgrade +- Store your backup in a secure location separate from your production environment. +- Verify the backup file size and contents before proceeding with the upgrade. ::: If you're using a managed database service (such as Amazon RDS), follow your provider's recommended backup procedures. For containerized databases, ensure your volume mounts are properly configured to persist data. -## Docker Compose Configuration +## Docker Compose configuration For Docker Compose deployments, the upgrade process requires updating configuration files and container versions. Refer to the [Docker Compose deployment guide](../enterprise/docker-compose) for detailed instructions. -### Configuration Files +### Configuration files Key configuration files to review and update: @@ -81,11 +78,11 @@ For detailed configuration options and deployment instructions, refer to: - [Configuration overview](../enterprise/configuration/overview) - [Environment variables](../enterprise/configuration/overview#environment-variables) -## Kubernetes Configuration +## Kubernetes configuration For Kubernetes deployments, the upgrade process requires updating manifests and container versions. Refer to the [Kubernetes deployment guide](../enterprise/kubernetes) for detailed instructions. -### Configuration Files +### Configuration files Key configuration files to review and update: @@ -101,9 +98,9 @@ For detailed configuration options and deployment instructions, refer to: - [Configuration overview](../enterprise/configuration/overview) - [Environment variables](../enterprise/configuration/overview#environment-variables) -## Breaking Changes +## Breaking changes -Seqera Platform contains no breaking changes for the 25.1 release. +Seqera Platform Enterprise contains no breaking changes for the 25.1 release. ## Support