diff --git a/README.md b/README.md index b416a42..863388f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ [![Releases](https://img.shields.io/github/release/ministryofjustice/cloud-platform-terraform-rds-instance/all.svg?style=flat-square)](https://github.com/ministryofjustice/cloud-platform-terraform-rds-instance/releases) +# IMP NOTE: Updating to module version 5.3, existing database password will be rotated. +# Make sure you restart your pods which use this RDS secret to avoid any down time. + This terraform module will create an RDS instance and all required AWS resources. A KMS key is also created in order to enable encryption. The RDS instance that is created uses a randomly generated name to avoid any conflicts. The default database created in the instance uses the same random identifier but can be overriden by the user. @@ -14,6 +17,7 @@ When upgrading the major version of an engine, `allow_major_version_upgrade` mus Some engines can't apply some parameters without a reboot(ex postgres9.x cant apply force_ssl immediate), and you will need to specify "pending-reboot" here. + ## Usage See [this example](example/rds.tf) diff --git a/example/rds.tf b/example/rds.tf index 3a37ffb..777b0d8 100644 --- a/example/rds.tf +++ b/example/rds.tf @@ -16,8 +16,12 @@ variable "cluster_state_bucket" { * releases page of this repository. * */ + +# IMP NOTE: Updating to module version 5.3, existing database password will be rotated. +# Make sure you restart your pods which use this RDS secret to avoid any down time. + module "example_team_rds" { - source = "github.com/ministryofjustice/cloud-platform-terraform-rds-instance?ref=5.2" + source = "github.com/ministryofjustice/cloud-platform-terraform-rds-instance?ref=5.3" cluster_name = var.cluster_name cluster_state_bucket = var.cluster_state_bucket team_name = "example-repo"