Skip to content

Commit 21326eb

Browse files
committed
Add documentation for the new rotate_passwords mysql option.
1 parent 2964911 commit 21326eb

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

sites/platform/src/add-services/mysql/_index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -340,11 +340,12 @@ You can also see a guide on how to [convert the `{{< vendor/prefix >}}_RELATIONS
340340

341341
You can configure your MySQL service in the [services configuration](/add-services/_index.md) with the following options:
342342

343-
| Name | Type | Version | Description |
344-
| ------------ | ----------------------- | ---------------------------------- | ----------- |
345-
| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. |
346-
| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). |
347-
| `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). |
343+
| Name | Type | Version | Description |
344+
| ------------------ | -------------------------- | ---------------------------------- | ----------- |
345+
| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. |
346+
| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). |
347+
| `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). |
348+
| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. |
348349

349350
Example configuration:
350351

@@ -756,6 +757,14 @@ you get an automatically generated password,
756757
similarly to when you create [multiple databases](#multiple-databases).
757758
Note that you can't customize these automatically generated passwords.
758759

760+
{{% note theme="warning" %}}
761+
By default, the generated password will rotate on a regular
762+
basis. Your applications MUST use the passwords from the
763+
relationships, as the password _is_ going to change. Please set
764+
`rotate_passwords` to `false` if you wish to change this default
765+
behavior.
766+
{{% /note %}}
767+
759768
After your custom endpoints are exposed as relationships in your [app configuration](/create-apps/_index.md),
760769
you can retrieve the password for each endpoint
761770
through the `{{% vendor/prefix %}}_RELATIONSHIPS` [environment variable](/development/variables/use-variables.md#use-provided-variables)

sites/upsun/src/add-services/mysql/_index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -512,11 +512,12 @@ You can also see a guide on how to [convert the `{{< vendor/prefix >}}_RELATIONS
512512

513513
You can configure your MySQL service in the [services configuration](../_index.md) with the following options:
514514

515-
| Name | Type | Version | Description |
516-
| ------------ | ----------------------- | ---------------------------------- | ----------- |
517-
| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. |
518-
| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). |
519-
| `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). |
515+
| Name | Type | Version | Description |
516+
| ------------------ | -------------------------- | ---------------------------------- | ----------- |
517+
| `schemas` | An array of `string`s | 10.0+ | All databases to be created. Defaults to a single `main` database. |
518+
| `endpoints` | An endpoints dictionary | 10.0+ | Endpoints with their permissions. See [multiple databases](#multiple-databases). |
519+
| `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). |
520+
| `rotate_passwords` | A boolean, default is true | 10.3+ | Allows disabling passwords rotation. |
520521

521522
Example configuration:
522523

@@ -746,6 +747,14 @@ you get an automatically generated password,
746747
similarly to when you create [multiple databases](#multiple-databases).
747748
Note that you can't customize these automatically generated passwords.
748749

750+
{{% note theme="warning" %}}
751+
By default, the generated password will rotate on a regular
752+
basis. Your applications MUST use the passwords from the
753+
relationships, as the password _is_ going to change. Please set
754+
`rotate_passwords` to `false` if you wish to change this default
755+
behavior.
756+
{{% /note %}}
757+
749758
After your custom endpoints are exposed as relationships in your [app configuration](../../create-apps/_index.md),
750759
you can retrieve the password for each endpoint
751760
through the `{{% vendor/prefix %}}_RELATIONSHIPS` [environment variable](../../development/variables/use-variables.md#use-provided-variables)

0 commit comments

Comments
 (0)