Skip to content

Add documentation for the new rotate_passwords mysql option. #4836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions sites/platform/src/add-services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. |

Example configuration:

Expand Down Expand Up @@ -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. 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)
Expand Down
19 changes: 14 additions & 5 deletions sites/upsun/src/add-services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | 10.3+ | Allows disabling passwords rotation. Defaults to `true`. |

Example configuration:

Expand Down Expand Up @@ -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. 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)
Expand Down
Loading