From 21326eb44a392b03a71aafc0b6f23db8cf90a464 Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Tue, 12 Aug 2025 14:28:27 +0200 Subject: [PATCH 1/6] Add documentation for the new `rotate_passwords` mysql option. --- .../platform/src/add-services/mysql/_index.md | 19 ++++++++++++++----- sites/upsun/src/add-services/mysql/_index.md | 19 ++++++++++++++----- 2 files changed, 28 insertions(+), 10 deletions(-) diff --git a/sites/platform/src/add-services/mysql/_index.md b/sites/platform/src/add-services/mysql/_index.md index 1335e6f062..9a09a720ab 100644 --- a/sites/platform/src/add-services/mysql/_index.md +++ b/sites/platform/src/add-services/mysql/_index.md @@ -340,11 +340,12 @@ You can also see a guide on how to [convert the `{{< vendor/prefix >}}_RELATIONS You can configure your MySQL service in the [services configuration](/add-services/_index.md) with the following options: -| Name | Type | Version | Description | -| ------------ | ----------------------- | ---------------------------------- | ----------- | -| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | -| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | -| `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | +| Name | Type | Version | Description | +| ------------------ | -------------------------- | ---------------------------------- | ----------- | +| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | +| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | +| `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | +| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. | Example configuration: @@ -756,6 +757,14 @@ you get an automatically generated password, similarly to when you create [multiple databases](#multiple-databases). Note that you can't customize these automatically generated passwords. +{{% note theme="warning" %}} +By default, the generated password will rotate on a regular +basis. Your applications MUST use the passwords from the +relationships, as the password _is_ going to change. Please set +`rotate_passwords` to `false` if you wish to change this default +behavior. +{{% /note %}} + After your custom endpoints are exposed as relationships in your [app configuration](/create-apps/_index.md), you can retrieve the password for each endpoint through the `{{% vendor/prefix %}}_RELATIONSHIPS` [environment variable](/development/variables/use-variables.md#use-provided-variables) diff --git a/sites/upsun/src/add-services/mysql/_index.md b/sites/upsun/src/add-services/mysql/_index.md index ec99676ac0..058ea607a9 100644 --- a/sites/upsun/src/add-services/mysql/_index.md +++ b/sites/upsun/src/add-services/mysql/_index.md @@ -512,11 +512,12 @@ You can also see a guide on how to [convert the `{{< vendor/prefix >}}_RELATIONS You can configure your MySQL service in the [services configuration](../_index.md) with the following options: -| Name | Type | Version | Description | -| ------------ | ----------------------- | ---------------------------------- | ----------- | -| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | -| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | -| `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | +| Name | Type | Version | Description | +| ------------------ | -------------------------- | ---------------------------------- | ----------- | +| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | +| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | +| `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | +| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. | Example configuration: @@ -746,6 +747,14 @@ you get an automatically generated password, similarly to when you create [multiple databases](#multiple-databases). Note that you can't customize these automatically generated passwords. +{{% note theme="warning" %}} +By default, the generated password will rotate on a regular +basis. Your applications MUST use the passwords from the +relationships, as the password _is_ going to change. Please set +`rotate_passwords` to `false` if you wish to change this default +behavior. +{{% /note %}} + After your custom endpoints are exposed as relationships in your [app configuration](../../create-apps/_index.md), you can retrieve the password for each endpoint through the `{{% vendor/prefix %}}_RELATIONSHIPS` [environment variable](../../development/variables/use-variables.md#use-provided-variables) From 6b687e1e4c978021ed7ab20b5e869fd63de0415d Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Thu, 14 Aug 2025 10:14:15 +0200 Subject: [PATCH 2/6] Update sites/platform/src/add-services/mysql/_index.md Co-authored-by: Kemi Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> --- sites/platform/src/add-services/mysql/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sites/platform/src/add-services/mysql/_index.md b/sites/platform/src/add-services/mysql/_index.md index 9a09a720ab..5065fa5403 100644 --- a/sites/platform/src/add-services/mysql/_index.md +++ b/sites/platform/src/add-services/mysql/_index.md @@ -760,7 +760,7 @@ Note that you can't customize these automatically generated passwords. {{% note theme="warning" %}} By default, the generated password will rotate on a regular basis. Your applications MUST use the passwords from the -relationships, as the password _is_ going to change. Please set +relationships, as the password _is_ going to change. Set `rotate_passwords` to `false` if you wish to change this default behavior. {{% /note %}} From e49b982e28aa13efc1aee2eb6b9a06bc81e28d98 Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Thu, 14 Aug 2025 10:14:21 +0200 Subject: [PATCH 3/6] Update sites/upsun/src/add-services/mysql/_index.md Co-authored-by: Kemi Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> --- sites/upsun/src/add-services/mysql/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sites/upsun/src/add-services/mysql/_index.md b/sites/upsun/src/add-services/mysql/_index.md index 058ea607a9..2f3e8c16f9 100644 --- a/sites/upsun/src/add-services/mysql/_index.md +++ b/sites/upsun/src/add-services/mysql/_index.md @@ -750,7 +750,7 @@ Note that you can't customize these automatically generated passwords. {{% note theme="warning" %}} By default, the generated password will rotate on a regular basis. Your applications MUST use the passwords from the -relationships, as the password _is_ going to change. Please set +relationships, as the password _is_ going to change. Set `rotate_passwords` to `false` if you wish to change this default behavior. {{% /note %}} From 11578a333650166fe2d9e5cec8f7aba88e5e6c8b Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Thu, 14 Aug 2025 10:18:12 +0200 Subject: [PATCH 4/6] Update sites/upsun/src/add-services/mysql/_index.md Co-authored-by: Fabien Potencier --- sites/upsun/src/add-services/mysql/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sites/upsun/src/add-services/mysql/_index.md b/sites/upsun/src/add-services/mysql/_index.md index 2f3e8c16f9..924e1b4c65 100644 --- a/sites/upsun/src/add-services/mysql/_index.md +++ b/sites/upsun/src/add-services/mysql/_index.md @@ -517,7 +517,7 @@ You can configure your MySQL service in the [services configuration](../_index.m | `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | | `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | | `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | -| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. | +| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | Example configuration: From 5dbffbc3522b7f7d378007ac3f04f4026b051044 Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Thu, 14 Aug 2025 10:18:17 +0200 Subject: [PATCH 5/6] Update sites/platform/src/add-services/mysql/_index.md Co-authored-by: Fabien Potencier --- sites/platform/src/add-services/mysql/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sites/platform/src/add-services/mysql/_index.md b/sites/platform/src/add-services/mysql/_index.md index 5065fa5403..495a475416 100644 --- a/sites/platform/src/add-services/mysql/_index.md +++ b/sites/platform/src/add-services/mysql/_index.md @@ -345,7 +345,7 @@ You can configure your MySQL service in the [services configuration](/add-servic | `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | | `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | | `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | -| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. | +| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | Example configuration: From dcf71464bc23cee38c803d09989d4e67899587ee Mon Sep 17 00:00:00 2001 From: Florian Margaine Date: Thu, 14 Aug 2025 10:19:00 +0200 Subject: [PATCH 6/6] Fix spaces after suggestion. --- sites/platform/src/add-services/mysql/_index.md | 2 +- sites/upsun/src/add-services/mysql/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/platform/src/add-services/mysql/_index.md b/sites/platform/src/add-services/mysql/_index.md index 495a475416..622e5058a1 100644 --- a/sites/platform/src/add-services/mysql/_index.md +++ b/sites/platform/src/add-services/mysql/_index.md @@ -345,7 +345,7 @@ You can configure your MySQL service in the [services configuration](/add-servic | `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | | `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | | `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | -| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | +| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | Example configuration: diff --git a/sites/upsun/src/add-services/mysql/_index.md b/sites/upsun/src/add-services/mysql/_index.md index 924e1b4c65..bcd670cca4 100644 --- a/sites/upsun/src/add-services/mysql/_index.md +++ b/sites/upsun/src/add-services/mysql/_index.md @@ -517,7 +517,7 @@ You can configure your MySQL service in the [services configuration](../_index.m | `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. | | `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). | | `properties` | A properties dictionary | MariaDB: 10.1+; Oracle MySQL: 8.0+ | Additional properties for the database. Equivalent to using a `my.cnf` file. See [property options](#configure-the-database). | -| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | +| `rotate_passwords` | A boolean | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. | Example configuration: