Skip to content

Commit ff13b4f

Browse files
committed
Fixed broken links by adding general upgrade steps section
1 parent 3b3e6b7 commit ff13b4f

File tree

4 files changed

+52
-29
lines changed

4 files changed

+52
-29
lines changed

platform-enterprise_versioned_docs/version-23.4/enterprise/upgrade.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,28 @@ Follow these steps to upgrade your database instance and Platform Enterprise ins
1111
**Breaking change in version 23.4**: MySQL 8 is now required. If you are running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 23.4. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
1212
:::
1313

14+
### General upgrade steps
15+
1416
:::caution
1517
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.
1618
:::
1719

18-
1. Make a backup of the Seqera Platform database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
20+
:::info
21+
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
22+
:::
23+
24+
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.
1925
1. Download the latest versions of your deployment templates and update your Seqera container versions:
2026
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
2127
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
28+
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
29+
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
30+
- [server.yml](./_templates/k8s/data_studios/server.yml)
31+
32+
:::warning
33+
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
34+
:::
35+
2236
1. Restart the application.
2337
1. If you're using a containerized database as part of your implementation:
2438
1. Stop the application.

platform-enterprise_versioned_docs/version-24.1/enterprise/upgrade.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,28 @@ Follow these steps to upgrade your database instance and Platform installation:
1111
From Seqera Enterprise version 23.4, MySQL 8 is the only supported database version. If you are upgrading from a version prior to 23.4 and running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 24.1. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
1212
:::
1313

14+
### General upgrade steps
15+
1416
:::caution
1517
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.
1618
:::
1719

18-
1. Make a backup of the Seqera Platform database. If you use the pipeline optimization service and your `groundswell` database resides in a database instance separate from your Seqera database, make a backup of your `groundswell` database as well.
20+
:::info
21+
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
22+
:::
23+
24+
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.
1925
1. Download the latest versions of your deployment templates and update your Seqera container versions:
2026
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
2127
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
22-
1. **JVM memory configuration defaults (recommended)**: The following `JAVA_OPTS` environment variable is included in the deployment templates downloaded in the preceding step, to optimize JVM memory settings:
28+
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
29+
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
30+
- [server.yml](./_templates/k8s/data_studios/server.yml)
2331

24-
```bash
25-
JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144
26-
```
27-
28-
These baseline values are suitable for most deployments running moderate concurrent workflow loads.
29-
30-
:::tip
31-
These are starting recommendations that may require tuning based on your deployment's workload. See [Backend memory requirements](./configuration/overview.mdx#backend-memory-requirements) for detailed guidance on when and how to adjust these values for your environment.
32+
:::warning
33+
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
3234
:::
35+
3336
1. Restart the application.
3437
1. If you're using a containerized database as part of your implementation:
3538
1. Stop the application.

platform-enterprise_versioned_docs/version-24.2/enterprise/upgrade.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,28 @@ Follow these steps to upgrade your database instance and Platform Enterprise ins
1111
From Seqera Enterprise version 23.4, MySQL 8 is the only supported database version. If you are upgrading from a version prior to 23.4 and running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 24.2. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
1212
:::
1313

14+
### General upgrade steps
15+
1416
:::caution
1517
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.
1618
:::
1719

20+
:::info
21+
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
22+
:::
23+
1824
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.
1925
1. Download the latest versions of your deployment templates and update your Seqera container versions:
2026
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
2127
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
22-
1. **JVM memory configuration defaults (recommended)**: The following `JAVA_OPTS` environment variable is included in the deployment templates downloaded in the preceding step, to optimize JVM memory settings:
28+
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
29+
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
30+
- [server.yml](./_templates/k8s/data_studios/server.yml)
2331

24-
```bash
25-
JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144
26-
```
27-
28-
These baseline values are suitable for most deployments running moderate concurrent workflow loads.
29-
30-
:::tip
31-
These are starting recommendations that may require tuning based on your deployment's workload. See [Backend memory requirements](./configuration/overview.mdx#backend-memory-requirements) for detailed guidance on when and how to adjust these values for your environment.
32+
:::warning
33+
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
3234
:::
35+
3336
1. Restart the application.
3437
1. If you're using a containerized database as part of your implementation:
3538
1. Stop the application.

platform-enterprise_versioned_docs/version-25.1/enterprise/upgrade.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,28 @@ Follow these steps to upgrade your database instance and Platform Enterprise ins
1111
From Seqera Enterprise version 23.4, MySQL 8 is the only supported database version. If you are upgrading from a version prior to 23.4 and running MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8 before upgrading to version 25.1. See [General upgrade steps](#general-upgrade-steps) for database upgrade instructions.
1212
:::
1313

14+
### General upgrade steps
15+
1416
:::caution
1517
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.
1618
:::
1719

20+
:::info
21+
Starting from version 26.1, the frontend image running as root user will be deprecated. We recommend starting to switch to the [root-less image (also known as "unprivileged" image)](./platform-kubernetes#seqera-frontend-unprivileged) during this upgrade.
22+
:::
23+
1824
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.
1925
1. Download the latest versions of your deployment templates and update your Seqera container versions:
2026
- [docker-compose.yml](./_templates/docker/docker-compose.yml) for Docker Compose deployments
2127
- [tower-cron.yml](./_templates/k8s/tower-cron.yml) and [tower-svc.yml](./_templates/k8s/tower-svc.yml) for Kubernetes deployments
22-
1. **JVM memory configuration defaults (recommended)**: The following `JAVA_OPTS` environment variable is included in the deployment templates downloaded in the preceding step, to optimize JVM memory settings:
28+
1. If you're using Studios, download and apply the latest versions of the Kubernetes manifests:
29+
- [proxy.yml](./_templates/k8s/data_studios/proxy.yml)
30+
- [server.yml](./_templates/k8s/data_studios/server.yml)
2331

24-
```bash
25-
JAVA_OPTS: -Xms1000M -Xmx2000M -XX:MaxDirectMemorySize=800m -Dio.netty.maxDirectMemory=0 -Djdk.nio.maxCachedBufferSize=262144
26-
```
27-
28-
These baseline values are suitable for most deployments running moderate concurrent workflow loads.
29-
30-
:::tip
31-
These are starting recommendations that may require tuning based on your deployment's workload. See [Backend memory requirements](./configuration/overview.mdx#backend-memory-requirements) for detailed guidance on when and how to adjust these values for your environment.
32+
:::warning
33+
If you have customized the default Studios container template images, you must ensure that you update to latest recommended versions. Templates using earlier versions of Connect (than defined in the latest `proxy.yml` and `server.yml`) may no longer be supported in your existing Studios environments. Refer to the [Studios migration documentation](../studios/managing#migrate-a-studio-from-an-earlier-container-image-template) for guidance on migrating to the most recent versions of Connect server and clients.
3234
:::
35+
3336
1. Restart the application.
3437
1. If you're using a containerized database as part of your implementation:
3538
1. Stop the application.

0 commit comments

Comments
 (0)