|
|
|
|
@ -31,9 +31,15 @@ module "vpc" {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = module.project.project_id
|
|
|
|
|
network = module.vpc.self_link
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = module.project.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = module.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
database_version = "POSTGRES_13"
|
|
|
|
|
@ -46,9 +52,15 @@ module "db" {
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network = var.vpc.self_link
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = var.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
prefix = "myprefix"
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
@ -67,9 +79,15 @@ module "db" {
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network = var.vpc.self_link
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = var.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
database_version = "MYSQL_8_0"
|
|
|
|
|
@ -134,30 +152,63 @@ module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = module.project.project_id
|
|
|
|
|
encryption_key_name = module.kms.keys["key-sql"].id
|
|
|
|
|
network = var.vpc.self_link
|
|
|
|
|
name = "db"
|
|
|
|
|
region = var.region
|
|
|
|
|
database_version = "POSTGRES_13"
|
|
|
|
|
tier = "db-g1-small"
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = var.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
name = "db"
|
|
|
|
|
region = var.region
|
|
|
|
|
database_version = "POSTGRES_13"
|
|
|
|
|
tier = "db-g1-small"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# tftest modules=3 resources=10
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Instance with PSC enabled
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psc_allowed_consumer_projects = ["my-project-id"]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
prefix = "myprefix"
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
availability_type = "REGIONAL"
|
|
|
|
|
database_version = "POSTGRES_13"
|
|
|
|
|
tier = "db-g1-small"
|
|
|
|
|
}
|
|
|
|
|
# tftest modules=1 resources=1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Enable public IP
|
|
|
|
|
|
|
|
|
|
Use `ipv_enabled` to create instances with a public IP.
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network = var.vpc.self_link
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
public_ipv4 = true
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = var.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
tier = "db-g1-small"
|
|
|
|
|
database_version = "MYSQL_8_0"
|
|
|
|
|
ipv4_enabled = true
|
|
|
|
|
replicas = {
|
|
|
|
|
replica1 = { region = "europe-west3", encryption_key_name = null }
|
|
|
|
|
}
|
|
|
|
|
@ -171,9 +222,15 @@ Provide `insights_config` (can be just empty `{}`) to enable [Query Insights](ht
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
module "db" {
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network = var.vpc.self_link
|
|
|
|
|
source = "./fabric/modules/cloudsql-instance"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
network_config = {
|
|
|
|
|
connectivity = {
|
|
|
|
|
psa_config = {
|
|
|
|
|
private_network = var.vpc.self_link
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
name = "db"
|
|
|
|
|
region = "europe-west1"
|
|
|
|
|
database_version = "POSTGRES_13"
|
|
|
|
|
@ -190,37 +247,33 @@ module "db" {
|
|
|
|
|
|
|
|
|
|
| name | description | type | required | default |
|
|
|
|
|
|---|---|:---:|:---:|:---:|
|
|
|
|
|
| [database_version](variables.tf#L83) | Database type and version to create. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L167) | Name of primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [network](variables.tf#L172) | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | <code>string</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L193) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
|
|
|
|
| [region](variables.tf#L198) | Region of the primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [tier](variables.tf#L224) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
|
|
|
|
| [database_version](variables.tf#L68) | Database type and version to create. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L146) | Name of primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [network_config](variables.tf#L151) | Network configuration for the instance. Only one between private_network and psc_config can be used. | <code title="object({ authorized_networks = optional(map(string)) require_ssl = optional(bool) connectivity = object({ public_ipv4 = optional(bool, false) psa_config = optional(object({ private_network = string allocated_ip_ranges = optional(object({ primary = optional(string) replica = optional(string) })) })) psc_allowed_consumer_projects = optional(list(string)) }) })">object({…})</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L190) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
|
|
|
|
| [region](variables.tf#L195) | Region of the primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [tier](variables.tf#L215) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
|
|
|
|
| [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. | <code>string</code> | | <code>"ALWAYS"</code> |
|
|
|
|
|
| [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?. | <code title="object({ primary = optional(string) replica = optional(string) })">object({…})</code> | | <code>{}</code> |
|
|
|
|
|
| [authorized_networks](variables.tf#L36) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [availability_type](variables.tf#L42) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"ZONAL"</code> |
|
|
|
|
|
| [backup_configuration](variables.tf#L48) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | <code title="object({ enabled = optional(bool, false) binary_log_enabled = optional(bool, false) start_time = optional(string, "23:00") location = optional(string) log_retention_days = optional(number, 7) point_in_time_recovery_enabled = optional(bool) retention_count = optional(number, 7) })">object({…})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = null log_retention_days = 7 point_in_time_recovery_enabled = null retention_count = 7 }">{…}</code> |
|
|
|
|
|
| [collation](variables.tf#L71) | The name of server instance collation. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [connector_enforcement](variables.tf#L77) | Specifies if connections must use Cloud SQL connectors. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [databases](variables.tf#L88) | Databases to create once the primary instance is created. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [deletion_protection](variables.tf#L94) | Prevent terraform from deleting instances. | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [deletion_protection_enabled](variables.tf#L101) | Set Google's deletion protection attribute which applies across all surfaces (UI, API, & Terraform). | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [disk_autoresize_limit](variables.tf#L108) | The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. | <code>number</code> | | <code>0</code> |
|
|
|
|
|
| [disk_size](variables.tf#L114) | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [disk_type](variables.tf#L120) | The type of data disk: `PD_SSD` or `PD_HDD`. | <code>string</code> | | <code>"PD_SSD"</code> |
|
|
|
|
|
| [edition](variables.tf#L126) | The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS. | <code>string</code> | | <code>"ENTERPRISE"</code> |
|
|
|
|
|
| [encryption_key_name](variables.tf#L132) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [flags](variables.tf#L138) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [insights_config](variables.tf#L144) | Query Insights configuration. Defaults to null which disables Query Insights. | <code title="object({ query_string_length = optional(number, 1024) record_application_tags = optional(bool, false) record_client_address = optional(bool, false) query_plans_per_minute = optional(number, 5) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [ipv4_enabled](variables.tf#L155) | Add a public IP address to database instance. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [labels](variables.tf#L161) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [postgres_client_certificates](variables.tf#L177) | Map of cert keys connect to the application(s) using public IP. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [prefix](variables.tf#L183) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [replicas](variables.tf#L203) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | <code title="map(object({ region = string encryption_key_name = string }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [require_ssl](variables.tf#L212) | Enable SSL connections only. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
| [root_password](variables.tf#L218) | Root password of the Cloud SQL instance. Required for MS SQL Server. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [users](variables.tf#L229) | Map of users to create in the primary instance (and replicated to other replicas). 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. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | <code title="map(object({ password = optional(string) type = optional(string) }))">map(object({…}))</code> | | <code>null</code> |
|
|
|
|
|
| [availability_type](variables.tf#L27) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"ZONAL"</code> |
|
|
|
|
|
| [backup_configuration](variables.tf#L33) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | <code title="object({ enabled = optional(bool, false) binary_log_enabled = optional(bool, false) start_time = optional(string, "23:00") location = optional(string) log_retention_days = optional(number, 7) point_in_time_recovery_enabled = optional(bool) retention_count = optional(number, 7) })">object({…})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = null log_retention_days = 7 point_in_time_recovery_enabled = null retention_count = 7 }">{…}</code> |
|
|
|
|
|
| [collation](variables.tf#L56) | The name of server instance collation. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [connector_enforcement](variables.tf#L62) | Specifies if connections must use Cloud SQL connectors. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [databases](variables.tf#L73) | Databases to create once the primary instance is created. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [deletion_protection](variables.tf#L79) | Prevent terraform from deleting instances. | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [deletion_protection_enabled](variables.tf#L86) | Set Google's deletion protection attribute which applies across all surfaces (UI, API, & Terraform). | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [disk_autoresize_limit](variables.tf#L93) | The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. | <code>number</code> | | <code>0</code> |
|
|
|
|
|
| [disk_size](variables.tf#L99) | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [disk_type](variables.tf#L105) | The type of data disk: `PD_SSD` or `PD_HDD`. | <code>string</code> | | <code>"PD_SSD"</code> |
|
|
|
|
|
| [edition](variables.tf#L111) | The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS. | <code>string</code> | | <code>"ENTERPRISE"</code> |
|
|
|
|
|
| [encryption_key_name](variables.tf#L117) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [flags](variables.tf#L123) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [insights_config](variables.tf#L129) | Query Insights configuration. Defaults to null which disables Query Insights. | <code title="object({ query_string_length = optional(number, 1024) record_application_tags = optional(bool, false) record_client_address = optional(bool, false) query_plans_per_minute = optional(number, 5) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [labels](variables.tf#L140) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [postgres_client_certificates](variables.tf#L174) | Map of cert keys connect to the application(s) using public IP. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [prefix](variables.tf#L180) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [replicas](variables.tf#L200) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | <code title="map(object({ region = string encryption_key_name = string }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [root_password](variables.tf#L209) | Root password of the Cloud SQL instance. Required for MS SQL Server. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [users](variables.tf#L220) | Map of users to create in the primary instance (and replicated to other replicas). 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. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | <code title="map(object({ password = optional(string) type = optional(string) }))">map(object({…}))</code> | | <code>null</code> |
|
|
|
|
|
|
|
|
|
|
## Outputs
|
|
|
|
|
|
|
|
|
|
@ -228,15 +281,19 @@ module "db" {
|
|
|
|
|
|---|---|:---:|
|
|
|
|
|
| [connection_name](outputs.tf#L24) | Connection name of the primary instance. | |
|
|
|
|
|
| [connection_names](outputs.tf#L29) | Connection names of all instances. | |
|
|
|
|
|
| [id](outputs.tf#L37) | Fully qualified primary instance id. | |
|
|
|
|
|
| [ids](outputs.tf#L42) | Fully qualified ids of all instances. | |
|
|
|
|
|
| [instances](outputs.tf#L50) | Cloud SQL instance resources. | ✓ |
|
|
|
|
|
| [ip](outputs.tf#L56) | IP address of the primary instance. | |
|
|
|
|
|
| [ips](outputs.tf#L61) | IP addresses of all instances. | |
|
|
|
|
|
| [name](outputs.tf#L69) | Name of the primary instance. | |
|
|
|
|
|
| [names](outputs.tf#L74) | Names of all instances. | |
|
|
|
|
|
| [postgres_client_certificates](outputs.tf#L82) | The CA Certificate used to connect to the SQL Instance via SSL. | ✓ |
|
|
|
|
|
| [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. | ✓ |
|
|
|
|
|
| [dns_name](outputs.tf#L37) | The dns name of the instance. | |
|
|
|
|
|
| [dns_names](outputs.tf#L42) | Dns names of all instances. | |
|
|
|
|
|
| [id](outputs.tf#L50) | Fully qualified primary instance id. | |
|
|
|
|
|
| [ids](outputs.tf#L55) | Fully qualified ids of all instances. | |
|
|
|
|
|
| [instances](outputs.tf#L63) | Cloud SQL instance resources. | ✓ |
|
|
|
|
|
| [ip](outputs.tf#L69) | IP address of the primary instance. | |
|
|
|
|
|
| [ips](outputs.tf#L74) | IP addresses of all instances. | |
|
|
|
|
|
| [name](outputs.tf#L82) | Name of the primary instance. | |
|
|
|
|
|
| [names](outputs.tf#L87) | Names of all instances. | |
|
|
|
|
|
| [postgres_client_certificates](outputs.tf#L95) | The CA Certificate used to connect to the SQL Instance via SSL. | ✓ |
|
|
|
|
|
| [psc_service_attachment_link](outputs.tf#L101) | The link to service attachment of PSC instance. | |
|
|
|
|
|
| [psc_service_attachment_links](outputs.tf#L106) | Links to service attachment of PSC instances. | |
|
|
|
|
|
| [self_link](outputs.tf#L114) | Self link of the primary instance. | |
|
|
|
|
|
| [self_links](outputs.tf#L119) | Self links of all instances. | |
|
|
|
|
|
| [user_passwords](outputs.tf#L127) | Map of containing the password of all users created through terraform. | ✓ |
|
|
|
|
|
<!-- END TFDOC -->
|
|
|
|
|
|
luigi-bitonti
GitHub