wip: Versioned Upgrade guides & Practices.

changelog/seqera-enterprise/v25.1.md

@@ -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/25.1/studios/overview).
@@ -104,7 +106,7 @@ Studios is Seqera's in-platform tool for secure, on-demand, interactive data ana
 
 ## Breaking changes and warnings
 
-### OIDC Secrets injection modifications
+:::note[UPGRADING]
 
 `oidc-token-import` replaces the `auth-oidc-secrets` Micronaut environment. 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.
 

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=<FULL_PATH_TO_YOUR_PRIVATE_IMAGE>`
 
 :::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.
 :::

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]
+---
+
+# Upgrade to Seqera Enterprise 25.1
+
+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.
+
+Alongside standard upgrade steps, some versions may include additional tasks specific to that release.
+
+:::warning[Version compatibility]
+Seqera is backward-compatible with the previous version. As such, existing pipelines, workspaces, and studios will continue to function.
+
+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.
+
+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:
+
+- **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
+
+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:
+
+- 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
+
+## 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.
+
+To create a backup of your MySQL database:
+
+```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
+```
+
+:::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.
+:::
+
+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
+
+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)
+
+## 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
+
+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 Enterprise contains no breaking changes for the 25.1 release.
+
+## 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
+- Your current Redis version
+- Details of your deployment environment
+- Any error messages or logs from the upgrade process

platform-enterprise_versioned_docs/version-25.1/upgrade/breaking-changes.mdx

@@ -0,0 +1,61 @@
+---
+title: "Breaking Changes"
+description: "Upgrading Seqera Enterprise"
+date: "21 Aug 2024"
+tags: [enterprise, update, install]
+---
+
+# Breaking changes in Seqera Platform
+
+Seqera limits breaking changes between releases. However, changes to underlying libraries used in application development may require configuration changes during upgrades.
+
+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**
+:::
+
+## 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://<domain>:<port>/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://<domain>:<port>/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
+
+- **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.

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
+
+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).
+
+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)

platform-enterprise_versioned_docs/version-25.1/upgrade/upgrade-template.mdx

@@ -0,0 +1,48 @@
+---
+title: "25.1"
+description: "Platform Enterprise update guidance"
+date: "21 Aug 2024"
+tags: [enterprise, update, install]
+---
+
+
+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, some versions include additional upgrade tasks.
+
+:::note
+Some releases include breaking changes documented 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
+
+To create a backup of your MySQL database:
+
+```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