From d56c4809bc75d4d93746a682b0e1ef6c0eb0bb25 Mon Sep 17 00:00:00 2001 From: Imran Nayer Date: Tue, 17 Dec 2024 19:44:12 +0000 Subject: [PATCH 1/2] added support for maintenance version --- examples/postgresql-with-cross-region-failover/main.tf | 4 ++-- modules/mssql/README.md | 1 + modules/mssql/main.tf | 1 + modules/mssql/variables.tf | 6 ++++++ modules/mysql/README.md | 1 + modules/mysql/main.tf | 1 + modules/mysql/variables.tf | 6 ++++++ modules/postgresql/README.md | 3 ++- modules/postgresql/main.tf | 1 + modules/postgresql/variables.tf | 10 ++++++++-- modules/safer_mysql/README.md | 1 + modules/safer_mysql/main.tf | 1 + modules/safer_mysql/variables.tf | 6 ++++++ .../postgresql_cross_region_failover_test.go | 2 +- 14 files changed, 38 insertions(+), 6 deletions(-) diff --git a/examples/postgresql-with-cross-region-failover/main.tf b/examples/postgresql-with-cross-region-failover/main.tf index ec047dbb..07ac5a87 100644 --- a/examples/postgresql-with-cross-region-failover/main.tf +++ b/examples/postgresql-with-cross-region-failover/main.tf @@ -52,7 +52,7 @@ module "pg1" { name = var.pg_name_1 random_instance_name = true project_id = var.project_id - database_version = "POSTGRES_14" + database_version = "POSTGRES_17" region = local.region_1 edition = local.edition @@ -164,7 +164,7 @@ module "pg2" { name = var.pg_name_2 random_instance_name = true project_id = var.project_id - database_version = "POSTGRES_14" + database_version = "POSTGRES_17" region = local.region_2 edition = local.edition diff --git a/modules/mssql/README.md b/modules/mssql/README.md index 87dd43f0..55746a21 100644 --- a/modules/mssql/README.md +++ b/modules/mssql/README.md @@ -61,6 +61,7 @@ module "mssql" { | follow\_gae\_application | A Google App Engine application whose zone to remain in. Must be in the same region as this instance. | `string` | `null` | no | | instance\_type | The type of the instance. The supported values are SQL\_INSTANCE\_TYPE\_UNSPECIFIED, CLOUD\_SQL\_INSTANCE, ON\_PREMISES\_INSTANCE and READ\_REPLICA\_INSTANCE. Set to READ\_REPLICA\_INSTANCE when primary\_instance\_name is provided | `string` | `"CLOUD_SQL_INSTANCE"` | no | | ip\_configuration | The ip configuration for the Cloud SQL instances. | 
object({
    authorized_networks = optional(list(map(string)), [])
    ipv4_enabled        = optional(bool)
    private_network     = optional(string)
    allocated_ip_range  = optional(string)
    ssl_mode            = optional(string)
  })
| 
{
  "allocated_ip_range": null,
  "authorized_networks": [],
  "ipv4_enabled": true,
  "private_network": null,
  "ssl_mode": null
}
| no | +| maintenance\_version | The current software version on the instance. This attribute can not be set during creation. Refer to available\_maintenance\_versions attribute to see what maintenance\_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance\_version value that is older than the current one on the instance will be ignored | `string` | `null` | no | | maintenance\_window\_day | The day of week (1-7) for the Cloud SQL maintenance. | `number` | `1` | no | | maintenance\_window\_hour | The hour of day (0-23) maintenance window for the Cloud SQL maintenance. | `number` | `23` | no | | maintenance\_window\_update\_track | The update track of maintenance window for the Cloud SQL maintenance.Can be either `canary` or `stable`. | `string` | `"canary"` | no | diff --git a/modules/mssql/main.tf b/modules/mssql/main.tf index 569ba30f..7464ce24 100644 --- a/modules/mssql/main.tf +++ b/modules/mssql/main.tf @@ -47,6 +47,7 @@ resource "google_sql_database_instance" "default" { project = var.project_id name = var.random_instance_name ? "${var.name}-${random_id.suffix[0].hex}" : var.name database_version = var.database_version + maintenance_version = var.maintenance_version region = var.region encryption_key_name = var.encryption_key_name root_password = coalesce(var.root_password, random_password.root-password.result) diff --git a/modules/mssql/variables.tf b/modules/mssql/variables.tf index 205e845d..4ff68872 100644 --- a/modules/mssql/variables.tf +++ b/modules/mssql/variables.tf @@ -42,6 +42,12 @@ variable "random_instance_name" { default = false } +variable "maintenance_version" { + description = "The current software version on the instance. This attribute can not be set during creation. Refer to available_maintenance_versions attribute to see what maintenance_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance_version value that is older than the current one on the instance will be ignored" + type = string + default = null +} + // required variable "database_version" { description = "The database version to use: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB" diff --git a/modules/mysql/README.md b/modules/mysql/README.md index c4cc62ff..57726c75 100644 --- a/modules/mysql/README.md +++ b/modules/mysql/README.md @@ -78,6 +78,7 @@ module "mysql-db" { | insights\_config | The insights\_config settings for the database. | 
object({
    query_plans_per_minute  = number
    query_string_length     = number
    record_application_tags = bool
    record_client_address   = bool
  })
| `null` | no | | instance\_type | Users can upgrade a read replica instance to a stand-alone Cloud SQL instance with the help of instance\_type. To promote, users have to set the instance\_type property as CLOUD\_SQL\_INSTANCE and remove/unset master\_instance\_name and replica\_configuration from instance configuration. This operation might cause your instance to restart. | `string` | `null` | no | | ip\_configuration | The ip\_configuration settings subblock | 
object({
    authorized_networks                           = optional(list(map(string)), [])
    ipv4_enabled                                  = optional(bool, true)
    private_network                               = optional(string)
    ssl_mode                                      = optional(string)
    allocated_ip_range                            = optional(string)
    enable_private_path_for_google_cloud_services = optional(bool, false)
    psc_enabled                                   = optional(bool, false)
    psc_allowed_consumer_projects                 = optional(list(string), [])
  })
| `{}` | no | +| maintenance\_version | The current software version on the instance. This attribute can not be set during creation. Refer to available\_maintenance\_versions attribute to see what maintenance\_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance\_version value that is older than the current one on the instance will be ignored | `string` | `null` | no | | maintenance\_window\_day | The day of week (1-7) for the master instance maintenance. | `number` | `1` | no | | maintenance\_window\_hour | The hour of day (0-23) maintenance window for the master instance maintenance. | `number` | `23` | no | | maintenance\_window\_update\_track | The update track of maintenance window for the master instance maintenance. Can be either `canary` or `stable`. | `string` | `"canary"` | no | diff --git a/modules/mysql/main.tf b/modules/mysql/main.tf index 1816747d..b7ae1379 100644 --- a/modules/mysql/main.tf +++ b/modules/mysql/main.tf @@ -56,6 +56,7 @@ resource "google_sql_database_instance" "default" { project = var.project_id name = local.master_instance_name database_version = var.database_version + maintenance_version = var.maintenance_version region = var.region master_instance_name = var.master_instance_name instance_type = var.instance_type diff --git a/modules/mysql/variables.tf b/modules/mysql/variables.tf index ab7f7525..9479c1c5 100644 --- a/modules/mysql/variables.tf +++ b/modules/mysql/variables.tf @@ -43,6 +43,12 @@ variable "database_version" { type = string } +variable "maintenance_version" { + description = "The current software version on the instance. This attribute can not be set during creation. Refer to available_maintenance_versions attribute to see what maintenance_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance_version value that is older than the current one on the instance will be ignored" + type = string + default = null +} + variable "availability_type" { description = "The availability type for the master instance. Can be either `REGIONAL` or `null`." type = string diff --git a/modules/postgresql/README.md b/modules/postgresql/README.md index 3bde58b6..d9c561f5 100644 --- a/modules/postgresql/README.md +++ b/modules/postgresql/README.md @@ -127,7 +127,7 @@ module "pg" { | database\_deletion\_policy | The deletion policy for the database. Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be deleted from the API if there are users other than cloudsqlsuperuser with access. Possible values are: "ABANDON". | `string` | `null` | no | | database\_flags | The database flags for the Cloud SQL instance. See [more details](https://cloud.google.com/sql/docs/postgres/flags) | 
list(object({
    name  = string
    value = string
  }))
| `[]` | no | | database\_integration\_roles | The roles required by default database instance service account for integration with GCP services | `list(string)` | `[]` | no | -| database\_version | The database version to use | `string` | n/a | yes | +| database\_version | The database version to use. Can be 9\_6, 14, 15, 16, 17. | `string` | n/a | yes | | db\_charset | The charset for the default database | `string` | `""` | no | | db\_collation | The collation for the default database. Example: 'en\_US.UTF8' | `string` | `""` | no | | db\_name | The name of the default database to create | `string` | `"default"` | no | @@ -150,6 +150,7 @@ module "pg" { | insights\_config | The insights\_config settings for the database. | 
object({
    query_plans_per_minute  = optional(number, 5)
    query_string_length     = optional(number, 1024)
    record_application_tags = optional(bool, false)
    record_client_address   = optional(bool, false)
  })
| `null` | no | | instance\_type | The type of the instance. The supported values are SQL\_INSTANCE\_TYPE\_UNSPECIFIED, CLOUD\_SQL\_INSTANCE, ON\_PREMISES\_INSTANCE and READ\_REPLICA\_INSTANCE. Set to READ\_REPLICA\_INSTANCE if master\_instance\_name value is provided | `string` | `"CLOUD_SQL_INSTANCE"` | no | | ip\_configuration | The ip configuration for the Cloud SQL instances. | 
object({
    authorized_networks                           = optional(list(map(string)), [])
    ipv4_enabled                                  = optional(bool, true)
    private_network                               = optional(string)
    ssl_mode                                      = optional(string)
    allocated_ip_range                            = optional(string)
    enable_private_path_for_google_cloud_services = optional(bool, false)
    psc_enabled                                   = optional(bool, false)
    psc_allowed_consumer_projects                 = optional(list(string), [])
  })
| `{}` | no | +| maintenance\_version | The current software version on the instance. This attribute can not be set during creation. Refer to available\_maintenance\_versions attribute to see what maintenance\_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance\_version value that is older than the current one on the instance will be ignored | `string` | `null` | no | | maintenance\_window\_day | The day of week (1-7) for the Cloud SQL instance maintenance. | `number` | `1` | no | | maintenance\_window\_hour | The hour of day (0-23) maintenance window for the Cloud SQL instance maintenance. | `number` | `23` | no | | maintenance\_window\_update\_track | The update track of maintenance window for the Cloud SQL instance maintenance.Can be either `canary` or `stable`. | `string` | `"canary"` | no | diff --git a/modules/postgresql/main.tf b/modules/postgresql/main.tf index ca37538d..4adf4e4d 100644 --- a/modules/postgresql/main.tf +++ b/modules/postgresql/main.tf @@ -58,6 +58,7 @@ resource "google_sql_database_instance" "default" { project = var.project_id name = local.instance_name database_version = can(regex("\\d", substr(var.database_version, 0, 1))) ? format("POSTGRES_%s", var.database_version) : replace(var.database_version, substr(var.database_version, 0, 8), "POSTGRES") + maintenance_version = var.maintenance_version region = var.region encryption_key_name = var.encryption_key_name deletion_protection = var.deletion_protection diff --git a/modules/postgresql/variables.tf b/modules/postgresql/variables.tf index 23960281..20585153 100644 --- a/modules/postgresql/variables.tf +++ b/modules/postgresql/variables.tf @@ -38,15 +38,21 @@ variable "edition" { // required variable "database_version" { - description = "The database version to use" + description = "The database version to use. Can be 9_6, 14, 15, 16, 17." type = string validation { condition = (length(var.database_version) >= 9 && ((upper(substr(var.database_version, 0, 9)) == "POSTGRES_") && can(regex("^\\d+(?:_?\\d)*$", substr(var.database_version, 9, -1))))) || can(regex("^\\d+(?:_?\\d)*$", var.database_version)) - error_message = "The specified database version is not a valid representaion of database version. Valid database versions should be like the following patterns:- \"9_6\", \"postgres_9_6\", \"POSTGRES_14\" or \"POSTGRES_15\"" + error_message = "The specified database version is not a valid representation of database version. Valid database versions should be like the following patterns:- \"9_6\", \"postgres_9_6\", \"14\", \"POSTGRES_14\", \"15\", \"POSTGRES_15\", \"16\", \"POSTGRES_16\" or \"17\", \"POSTGRES_17\"" } } +variable "maintenance_version" { + description = "The current software version on the instance. This attribute can not be set during creation. Refer to available_maintenance_versions attribute to see what maintenance_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance_version value that is older than the current one on the instance will be ignored" + type = string + default = null +} + variable "availability_type" { description = "The availability type for the Cloud SQL instance.This is only used to set up high availability for the PostgreSQL instance. Can be either `ZONAL` or `REGIONAL`." type = string diff --git a/modules/safer_mysql/README.md b/modules/safer_mysql/README.md index ae4bb296..55fda368 100644 --- a/modules/safer_mysql/README.md +++ b/modules/safer_mysql/README.md @@ -265,6 +265,7 @@ module "safer-mysql-db" { | follow\_gae\_application | A Google App Engine application whose zone to remain in. Must be in the same region as this instance. | `string` | `null` | no | | iam\_users | A list of IAM users to be created in your CloudSQL instance. iam.users.type can be CLOUD\_IAM\_USER, CLOUD\_IAM\_SERVICE\_ACCOUNT, CLOUD\_IAM\_GROUP and is required for type CLOUD\_IAM\_GROUP (IAM groups) | 
list(object({
    id    = string,
    email = string,
    type  = optional(string)
  }))
| `[]` | no | | insights\_config | The insights\_config settings for the database. | 
object({
    query_plans_per_minute  = number
    query_string_length     = number
    record_application_tags = bool
    record_client_address   = bool
  })
| `null` | no | +| maintenance\_version | The current software version on the instance. This attribute can not be set during creation. Refer to available\_maintenance\_versions attribute to see what maintenance\_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance\_version value that is older than the current one on the instance will be ignored | `string` | `null` | no | | maintenance\_window\_day | The day of week (1-7) for the master instance maintenance. | `number` | `1` | no | | maintenance\_window\_hour | The hour of day (0-23) maintenance window for the master instance maintenance. | `number` | `23` | no | | maintenance\_window\_update\_track | The update track of maintenance window for the master instance maintenance. Can be either `canary` or `stable`. | `string` | `"stable"` | no | diff --git a/modules/safer_mysql/main.tf b/modules/safer_mysql/main.tf index 2aaada4a..e1b333f7 100644 --- a/modules/safer_mysql/main.tf +++ b/modules/safer_mysql/main.tf @@ -20,6 +20,7 @@ module "safer_mysql" { name = var.name random_instance_name = var.random_instance_name database_version = var.database_version + maintenance_version = var.maintenance_version region = var.region zone = var.zone secondary_zone = var.secondary_zone diff --git a/modules/safer_mysql/variables.tf b/modules/safer_mysql/variables.tf index 1d3afc6b..4f5efc8b 100644 --- a/modules/safer_mysql/variables.tf +++ b/modules/safer_mysql/variables.tf @@ -36,6 +36,12 @@ variable "database_version" { type = string } +variable "maintenance_version" { + description = "The current software version on the instance. This attribute can not be set during creation. Refer to available_maintenance_versions attribute to see what maintenance_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance_version value that is older than the current one on the instance will be ignored" + type = string + default = null +} + // required variable "region" { description = "The region of the Cloud SQL resources" diff --git a/test/integration/postgresql-with-cross-region-failover/postgresql_cross_region_failover_test.go b/test/integration/postgresql-with-cross-region-failover/postgresql_cross_region_failover_test.go index fa2a5dd8..7e2bb046 100644 --- a/test/integration/postgresql-with-cross-region-failover/postgresql_cross_region_failover_test.go +++ b/test/integration/postgresql-with-cross-region-failover/postgresql_cross_region_failover_test.go @@ -59,7 +59,7 @@ func TestPostgreSqlCrossRegionFailover(t *testing.T) { assert.Equal(1, len(authNetworks), "Expected one auth network") /// assert standard database settings - assert.Equal("POSTGRES_14", op.Get("databaseVersion").String(), "Expected POSTGRES_14 databaseVersion") + assert.Equal("POSTGRES_17", op.Get("databaseVersion").String(), "Expected POSTGRES_17 databaseVersion") assert.Equal("SECOND_GEN", op.Get("backendType").String(), "Expected SECOND_GEN backendType") assert.Equal("RUNNABLE", op.Get("state").String(), "Expected RUNNABLE state") assert.Equal("us-central1", op.Get("region").String(), "Expected us-central1 region") From 573a534a7fa5073ebe8677766c60cbf7bd627ac2 Mon Sep 17 00:00:00 2001 From: Imran Nayer Date: Wed, 8 Jan 2025 19:30:51 +0000 Subject: [PATCH 2/2] updated comments --- examples/postgresql-with-cross-region-failover/main.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/postgresql-with-cross-region-failover/main.tf b/examples/postgresql-with-cross-region-failover/main.tf index b44c840b..03eea7ce 100644 --- a/examples/postgresql-with-cross-region-failover/main.tf +++ b/examples/postgresql-with-cross-region-failover/main.tf @@ -158,7 +158,7 @@ module "pg2" { version = "~> 24.0" - # Comment this parameter to promot instance 2 as primary instance. This will break replication between instance 1 and 2 + # Comment this parameter to promote instance 2 as primary instance. master_instance_name = module.pg1.instance_name name = var.pg_name_2