diff --git a/modules/cloudsql-instance/README.md b/modules/cloudsql-instance/README.md index 172a805e..00cf5ded 100644 --- a/modules/cloudsql-instance/README.md +++ b/modules/cloudsql-instance/README.md @@ -183,36 +183,36 @@ module "db" { # tftest modules=1 resources=1 inventory=insights.yaml ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [database_version](variables.tf#L61) | Database type and version to create. | string | ✓ | | -| [name](variables.tf#L125) | Name of primary instance. | string | ✓ | | -| [network](variables.tf#L130) | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | string | ✓ | | -| [project_id](variables.tf#L151) | The ID of the project where this instances will be created. | string | ✓ | | -| [region](variables.tf#L156) | Region of the primary instance. | string | ✓ | | -| [tier](variables.tf#L182) | The machine type to use for the instances. | string | ✓ | | -| [allocated_ip_ranges](variables.tf#L17) | (Optional)The name of the allocated ip range for the private ip CloudSQL instance. For example: \"google-managed-services-default\". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. | object({…}) | | {} | -| [authorized_networks](variables.tf#L26) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | map(string) | | null | -| [availability_type](variables.tf#L32) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | string | | "ZONAL" | -| [backup_configuration](variables.tf#L38) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | object({…}) | | {…} | -| [databases](variables.tf#L66) | Databases to create once the primary instance is created. | list(string) | | null | -| [deletion_protection](variables.tf#L72) | Allow terraform to delete instances. | bool | | false | -| [disk_size](variables.tf#L78) | Disk size in GB. Set to null to enable autoresize. | number | | null | -| [disk_type](variables.tf#L84) | The type of data disk: `PD_SSD` or `PD_HDD`. | string | | "PD_SSD" | -| [encryption_key_name](variables.tf#L90) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | string | | null | -| [flags](variables.tf#L96) | Map FLAG_NAME=>VALUE for database-specific tuning. | map(string) | | null | -| [insights_config](variables.tf#L102) | Query Insights configuration. Defaults to null which disables Query Insights. | object({…}) | | null | -| [ipv4_enabled](variables.tf#L113) | Add a public IP address to database instance. | bool | | false | -| [labels](variables.tf#L119) | Labels to be attached to all instances. | map(string) | | null | -| [postgres_client_certificates](variables.tf#L135) | Map of cert keys connect to the application(s) using public IP. | list(string) | | null | -| [prefix](variables.tf#L141) | Optional prefix used to generate instance names. | string | | null | -| [replicas](variables.tf#L161) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | map(object({…})) | | {} | -| [require_ssl](variables.tf#L170) | Enable SSL connections only. | bool | | null | -| [root_password](variables.tf#L176) | Root password of the Cloud SQL instance. Required for MS SQL Server. | string | | null | -| [users](variables.tf#L187) | Map of users to create in the primary instance (and replicated to other replicas) in the format USER=>PASSWORD. For MySQL, anything afterr the first `@` (if persent) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. | map(string) | | null | +| [database_version](variables.tf#L71) | Database type and version to create. | string | ✓ | | +| [name](variables.tf#L135) | Name of primary instance. | string | ✓ | | +| [network](variables.tf#L140) | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | string | ✓ | | +| [project_id](variables.tf#L161) | The ID of the project where this instances will be created. | string | ✓ | | +| [region](variables.tf#L166) | Region of the primary instance. | string | ✓ | | +| [tier](variables.tf#L192) | The machine type to use for the instances. | string | ✓ | | +| [activation_policy](variables.tf#L16) | This variable specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND. Default is ALWAYS. | string | | "ALWAYS" | +| [allocated_ip_ranges](variables.tf#L27) | (Optional)The name of the allocated ip range for the private ip CloudSQL instance. For example: \"google-managed-services-default\". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. | object({…}) | | {} | +| [authorized_networks](variables.tf#L36) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | map(string) | | null | +| [availability_type](variables.tf#L42) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | string | | "ZONAL" | +| [backup_configuration](variables.tf#L48) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | object({…}) | | {…} | +| [databases](variables.tf#L76) | Databases to create once the primary instance is created. | list(string) | | null | +| [deletion_protection](variables.tf#L82) | Allow terraform to delete instances. | bool | | false | +| [disk_size](variables.tf#L88) | Disk size in GB. Set to null to enable autoresize. | number | | null | +| [disk_type](variables.tf#L94) | The type of data disk: `PD_SSD` or `PD_HDD`. | string | | "PD_SSD" | +| [encryption_key_name](variables.tf#L100) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | string | | null | +| [flags](variables.tf#L106) | Map FLAG_NAME=>VALUE for database-specific tuning. | map(string) | | null | +| [insights_config](variables.tf#L112) | Query Insights configuration. Defaults to null which disables Query Insights. | object({…}) | | null | +| [ipv4_enabled](variables.tf#L123) | Add a public IP address to database instance. | bool | | false | +| [labels](variables.tf#L129) | Labels to be attached to all instances. | map(string) | | null | +| [postgres_client_certificates](variables.tf#L145) | Map of cert keys connect to the application(s) using public IP. | list(string) | | null | +| [prefix](variables.tf#L151) | Optional prefix used to generate instance names. | string | | null | +| [replicas](variables.tf#L171) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | map(object({…})) | | {} | +| [require_ssl](variables.tf#L180) | Enable SSL connections only. | bool | | null | +| [root_password](variables.tf#L186) | Root password of the Cloud SQL instance. Required for MS SQL Server. | string | | null | +| [users](variables.tf#L197) | Map of users to create in the primary instance (and replicated to other replicas) in the format USER=>PASSWORD. For MySQL, anything afterr the first `@` (if persent) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. | map(string) | | null | ## Outputs @@ -231,5 +231,4 @@ module "db" { | [self_link](outputs.tf#L88) | Self link of the primary instance. | | | [self_links](outputs.tf#L93) | Self links of all instances. | | | [user_passwords](outputs.tf#L101) | Map of containing the password of all users created through terraform. | ✓ | - diff --git a/modules/cloudsql-instance/main.tf b/modules/cloudsql-instance/main.tf index 05f150dd..953e135e 100644 --- a/modules/cloudsql-instance/main.tf +++ b/modules/cloudsql-instance/main.tf @@ -59,6 +59,7 @@ resource "google_sql_database_instance" "primary" { disk_type = var.disk_type availability_type = var.availability_type user_labels = var.labels + activation_policy = var.activation_policy ip_configuration { ipv4_enabled = var.ipv4_enabled @@ -137,7 +138,8 @@ resource "google_sql_database_instance" "replicas" { disk_size = var.disk_size disk_type = var.disk_type # availability_type = var.availability_type - user_labels = var.labels + user_labels = var.labels + activation_policy = var.activation_policy ip_configuration { ipv4_enabled = var.ipv4_enabled diff --git a/modules/cloudsql-instance/variables.tf b/modules/cloudsql-instance/variables.tf index 03e0d6df..8b359a09 100644 --- a/modules/cloudsql-instance/variables.tf +++ b/modules/cloudsql-instance/variables.tf @@ -13,6 +13,16 @@ * See the License for the specific language governing permissions and * limitations under the License. */ +variable "activation_policy" { + description = "This variable specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND. Default is ALWAYS." + type = string + default = "ALWAYS" + validation { + condition = var.activation_policy == "NEVER" || var.activation_policy == "ON_DEMAND" || var.activation_policy == "ALWAYS" + error_message = "The variable activation_policy must be ALWAYS, NEVER or ON_DEMAND." + } + nullable = false +} variable "allocated_ip_ranges" { description = "(Optional)The name of the allocated ip range for the private ip CloudSQL instance. For example: \"google-managed-services-default\". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?." @@ -189,3 +199,4 @@ variable "users" { type = map(string) default = null } +