feat: MySQL - Allow setting type for additional_users (#237)

* pushing changes to use iam type

* fixing tests and changing to list map(any)

* fixing lint/docs

Co-authored-by: Morgante Pell <[email protected]>

Author: eahrend

examples/mysql-ha/main.tf

@@ -134,11 +134,13 @@ module "mysql" {
       name     = "tftest2"
       password = "abcdefg"
       host     = "localhost"
+      type     = "BUILT_IN"
     },
     {
       name     = "tftest3"
       password = "abcdefg"
       host     = "localhost"
+      type     = "BUILT_IN"
     },
   ]
 }

examples/mysql-private/README.md

@@ -85,7 +85,7 @@ terraform destroy
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | db\_name | The name of the SQL Database instance | `string` | `"example-mysql-private"` | no |
-| network\_name | n/a | `string` | `"mysql-privat"` | no |
+| network\_name | n/a | `string` | `"mysql-private"` | no |
 | project\_id | The project to run tests against | `string` | n/a | yes |
 
 ## Outputs

examples/mysql-private/main.tf

@@ -63,11 +63,13 @@ module "safer-mysql-db" {
       name     = "app"
       password = "PaSsWoRd"
       host     = "localhost"
+      type     = "BUILT_IN"
     },
     {
       name     = "readonly"
       password = "PaSsWoRd"
       host     = "localhost"
+      type     = "BUILT_IN"
     },
   ]
 

examples/mysql-private/variables.tf

@@ -20,7 +20,7 @@ variable "project_id" {
 }
 
 variable "network_name" {
-  default = "mysql-privat"
+  default = "mysql-private"
   type    = string
 }
 

modules/mysql/README.md

@@ -9,7 +9,7 @@ Note: CloudSQL provides [disk autoresize](https://cloud.google.com/sql/docs/mysq
 |------|-------------|------|---------|:--------:|
 | activation\_policy | The activation policy for the master instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | `string` | `"ALWAYS"` | no |
 | additional\_databases | A list of databases to be created in your cluster | <pre>list(object({<br>    name      = string<br>    charset   = string<br>    collation = string<br>  }))</pre> | `[]` | no |
-| additional\_users | A list of users to be created in your cluster | <pre>list(object({<br>    name     = string<br>    password = string<br>    host     = string<br>  }))</pre> | `[]` | no |
+| additional\_users | A list of users to be created in your cluster | `list(map(any))` | `[]` | no |
 | availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
 | backup\_configuration | The backup\_configuration settings subblock for the database setings | <pre>object({<br>    binary_log_enabled             = bool<br>    enabled                        = bool<br>    start_time                     = string<br>    location                       = string<br>    transaction_log_retention_days = string<br>    retained_backups               = number<br>    retention_unit                 = string<br>  })</pre> | <pre>{<br>  "binary_log_enabled": false,<br>  "enabled": false,<br>  "location": null,<br>  "retained_backups": null,<br>  "retention_unit": null,<br>  "start_time": null,<br>  "transaction_log_retention_days": null<br>}</pre> | no |
 | create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"10m"` | no |

modules/mysql/main.tf

@@ -187,6 +187,7 @@ resource "google_sql_user" "additional_users" {
   password   = lookup(each.value, "password", random_id.user-password.hex)
   host       = lookup(each.value, "host", var.user_host)
   instance   = google_sql_database_instance.default.name
+  type       = lookup(each.value, "type", "BUILT_IN")
   depends_on = [null_resource.module_depends_on, google_sql_database_instance.default]
 }
 

modules/mysql/variables.tf

@@ -242,12 +242,8 @@ variable "user_password" {
 
 variable "additional_users" {
   description = "A list of users to be created in your cluster"
-  type = list(object({
-    name     = string
-    password = string
-    host     = string
-  }))
-  default = []
+  type        = list(map(any))
+  default     = []
 }
 
 variable "create_timeout" {

modules/safer_mysql/README.md

@@ -166,7 +166,7 @@ mysql -S $HOME/mysql_sockets/myproject:region:instance -u user -p
 |------|-------------|------|---------|:--------:|
 | activation\_policy | The activation policy for the master instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | `string` | `"ALWAYS"` | no |
 | additional\_databases | A list of databases to be created in your cluster | <pre>list(object({<br>    name      = string<br>    charset   = string<br>    collation = string<br>  }))</pre> | `[]` | no |
-| additional\_users | A list of users to be created in your cluster | <pre>list(object({<br>    name     = string<br>    password = string<br>    host     = string<br>  }))</pre> | `[]` | no |
+| additional\_users | A list of users to be created in your cluster | <pre>list(object({<br>    name     = string<br>    password = string<br>    host     = string<br>    type     = string<br>  }))</pre> | `[]` | no |
 | assign\_public\_ip | Set to true if the master instance should also have a public IP (less secure). | `string` | `false` | no |
 | availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
 | backup\_configuration | The backup\_configuration settings subblock for the database setings | <pre>object({<br>    binary_log_enabled             = bool<br>    enabled                        = bool<br>    start_time                     = string<br>    location                       = string<br>    transaction_log_retention_days = string<br>    retained_backups               = number<br>    retention_unit                 = string<br>  })</pre> | <pre>{<br>  "binary_log_enabled": false,<br>  "enabled": false,<br>  "location": null,<br>  "retained_backups": null,<br>  "retention_unit": null,<br>  "start_time": null,<br>  "transaction_log_retention_days": null<br>}</pre> | no |

modules/safer_mysql/variables.tf

@@ -234,6 +234,7 @@ variable "additional_users" {
     name     = string
     password = string
     host     = string
+    type     = string
   }))
   default = []
 }

test/fixtures/mysql-private/variables.tf

@@ -20,6 +20,6 @@ variable "project_id" {
 }
 
 variable "network_name" {
-  default = "mysql-privat"
+  default = "mysql-private"
   type    = string
 }