-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix RDS doc to specify which parameters require an instance reboot (#…
…2431) * fix RDS doc to specify which parameters require an instance reboot * fix email links
- Loading branch information
Showing
1 changed file
with
16 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -245,14 +245,14 @@ You can update to larger or smaller plans depending on your specific needs, and | |
|
|
||
| There are several optional parameters that you can specify when updating an existing instance: | ||
|
|
||
| Name | Description | | ||
| --- | --- | | ||
| `storage` | Number of GB available to the database instance | | ||
| `backup_retention_period` | Specifies a number of days to retain daily snapshots. | | ||
| `binary_log_format` | Specifies the format for [MySQL binary logging](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQL.BinaryFormat.html). **Only supported for MySQL database plans**. Valid options: `ROW`, `STATEMENT`, `MIXED`. | | ||
| `enable_pg_cron` | Boolean to enable [`pg_cron` extension on PostgreSQL databases](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html) (requires PostgreSQL 12.5 and above) | | ||
| `enable_functions` | Boolean to enable functions, procedures, and triggers on MySQL databases | | ||
| `storage_type` | [RDS storage type to use for the database](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html). Valid options: `gp3` | | ||
| Name | Description | Reboot required? | | ||
| --- | --- | --- | | ||
| `storage` | Number of GB available to the database instance | No | | ||
| `backup_retention_period` | Specifies a number of days to retain daily snapshots. | No | | ||
| `binary_log_format` | Specifies the format for [MySQL binary logging](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQL.BinaryFormat.html). **Only supported for MySQL database plans**. Valid options: `ROW`, `STATEMENT`, `MIXED`. | Yes | | ||
| `enable_pg_cron` | Boolean to enable [`pg_cron` extension on PostgreSQL databases](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html) (requires PostgreSQL 12.5 and above) | Yes | | ||
| `enable_functions` | Boolean to enable functions, procedures, and triggers on MySQL databases | Yes | | ||
| `storage_type` | [RDS storage type to use for the database](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html). Valid options: `gp3` | No | | ||
|
|
||
| #### Examples of optional parameters | ||
|
|
||
|
|
@@ -262,7 +262,7 @@ If you want to increase the storage available to the instance to be 50 GB: | |
| cf update-service ${SERVICE_NAME} -c '{"storage": 50}' | ||
| ``` | ||
|
|
||
| Note that you can only update to a larger size. If you want to downgrade to a lesser size, please email [support][support] for assistance. | ||
| Note that you can only update to a larger size. If you want to downgrade to a lesser size, please email [support@cloud.gov]({{ site.support_email }}) for assistance. | ||
|
|
||
| To enable functions, triggers, and procedures for a MySQL instance: | ||
|
|
||
|
|
@@ -306,11 +306,11 @@ cf update-service ${SERVICE_NAME} \ | |
| -c '{"storage_type": "gp3", "storage": 20}' | ||
| ``` | ||
|
|
||
| Please note that you may need to request an instance reboot after making these changes in order for them to apply immediately. You can request a reboot of your RDS instance by emailing [[email protected]][support]. | ||
| For the parameters [identified as requiring a reboot](#setting-optional-parameters-1), you need to request an instance reboot after the update in order for the changes to be applied. You can request a reboot of your RDS instance by emailing [[email protected]]({{ site.support_email }}). | ||
|
|
||
| #### A note about upgrading major versions | ||
|
|
||
| **You cannot update an existing instance to a new major version** with the `update-service` command. If you'd like to update your existing database instance to a new major version, please email [[email protected]][support] for assistance. | ||
| **You cannot update an existing instance to a new major version** with the `update-service` command. If you'd like to update your existing database instance to a new major version, please email [[email protected]]({{ site.support_email }}) for assistance. | ||
|
|
||
| ### Rotate your credentials | ||
|
|
||
|
|
@@ -358,13 +358,13 @@ Please note: If you are binding a service instance to a new space, please review | |
|
|
||
| *Please note that these instructions will change in the future as we expand our service offerings and provide more options for customers.* | ||
|
|
||
| RDS automatically retains daily backups for 14 days. These backups are AWS RDS storage volume snapshots, backing up the entire DB instance and not just individual databases. You can extend the length of retention up to 35 days by using the option detailed above. If you need to have a database restored using one of these backups, you can [email [email protected]][support]. For non-emergency situations, please provide at least 48 hours advance notice. | ||
| RDS automatically retains daily backups for 14 days. These backups are AWS RDS storage volume snapshots, backing up the entire DB instance and not just individual databases. You can extend the length of retention up to 35 days by using the option detailed above. If you need to have a database restored using one of these backups, you can email [[email protected]]({{ site.support_email }}). For non-emergency situations, please provide at least 48 hours advance notice. | ||
|
|
||
| If you have an emergency situation, such as data loss or a compromised system, please [email [email protected]][support] immediately and inform us of the situation. | ||
| If you have an emergency situation, such as data loss or a compromised system, please email [[email protected]]({{ site.support_email }}) immediately and inform us of the situation. | ||
|
|
||
| If you deleted your database instance and want to recover it, the recovery must be done within 14 days of the instance being deleted. We can perform a restoration using the automated backups that are retained for that 14 day window after a database is removed. | ||
|
|
||
| When you do [contact [email protected]][support] with a database backup or restoration request, please include the following information: | ||
| When you do contact [[email protected]]({{ site.support_email }}) with a database backup or restoration request, please include the following information: | ||
|
|
||
| - Your organization name | ||
| - The space you are working within | ||
|
|
@@ -506,7 +506,7 @@ Every RDS instance configured through cloud.gov is [encrypted at rest](https://d | |
|
|
||
| ## Rotating credentials | ||
|
|
||
| You can rotate credentials by creating a new instance and [deleting the existing instance](https://cli.cloudfoundry.org/en-US/cf/delete-service.html). If this is not an option, email [[email protected]][support] to request rotating the credentials manually. | ||
| You can rotate credentials by creating a new instance and [deleting the existing instance](https://cli.cloudfoundry.org/en-US/cf/delete-service.html). If this is not an option, email [[email protected]]({{ site.support_email }}) to request rotating the credentials manually. | ||
|
|
||
| ## Working with OracleDB | ||
|
|
||
|
|
@@ -633,10 +633,8 @@ New instances of dedicated RDS plans use the latest default database version ava | |
|
|
||
| The PostgreSQL and MySQL plans are configured to automatically upgrade currently-running dedicated instances to the most recent compatible [minor version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html) available via AWS RDS GovCloud (US). | ||
|
|
||
| For Oracle plans, minor upgrades are not automatic. To upgrade an existing Oracle database instance, please contact [[email protected]][support] and schedule a maintenance window for the upgrade to take place. | ||
| For Oracle plans, minor upgrades are not automatic. To upgrade an existing Oracle database instance, please contact [[email protected]]({{ site.support_email }}) and schedule a maintenance window for the upgrade to take place. | ||
|
|
||
| ## The broker in GitHub | ||
|
|
||
| You can find the broker here: [https://github.com/18F/aws-broker](https://github.com/18F/aws-broker). | ||
|
|
||
| [support]: mailto:[email protected] | ||