* add default versions file, remove old providers and versions * use default versions file everywhere * fix kms module * re-add provider configuration for data platform step 2 * update kms module outputs sorting * update kms documentation * fix data solutions tests * fix GKE workload identity attribute name * work around firewall provider issue in datafusion example |
||
---|---|---|
.. | ||
README.md | ||
main.tf | ||
outputs.tf | ||
variables.tf | ||
versions.tf |
README.md
Cloud SQL instance with read replicas
This module manages the creation of Cloud SQL instances with potential read replicas in other regions. It can also create an initial set of users and databases via the users
and databases
parameters.
Note that this module assumes that some options are the same for both the primary instance and all the replicas (e.g. tier, disks, labels, flags, etc).
Warning: if you use the users
field, you terraform state will contain each user's password in plain text.
Simple example
This example shows how to setup a project, VPC and a standalone Cloud SQL instance.
module "project" {
source = "./modules/project"
billing_account = var.billing_account_id
parent = var.organization_id
name = "my-db-project"
services = [
"servicenetworking.googleapis.com"
]
}
module "vpc" {
source = "./modules/net-vpc"
project_id = module.project.project_id
name = "my-network"
private_service_networking_range = "10.60.0.0/16"
}
module "db" {
source = "./modules/cloudsql-instance"
project_id = module.project.project_id
network = module.vpc.self_link
name = "db"
region = "europe-west1"
database_version = "POSTGRES_13"
tier = "db-g1-small"
}
# tftest:modules=3:resources=6
Cross-regional read replica
module "db" {
source = "./modules/cloudsql-instance"
project_id = var.project_id
network = var.vpc.self_link
name = "db"
region = "europe-west1"
database_version = "POSTGRES_13"
tier = "db-g1-small"
replicas = {
replica1 = "europe-west3"
replica2 = "us-central1"
}
}
# tftest:modules=1:resources=3
Custom flags, databases and users
module "db" {
source = "./modules/cloudsql-instance"
project_id = var.project_id
network = var.vpc.self_link
name = "db"
region = "europe-west1"
database_version = "MYSQL_8_0"
tier = "db-g1-small"
flags = {
disconnect_on_expired_password = "on"
}
databases = [
"people",
"departments"
]
users = {
# generatea password for user1
user1 = null
# assign a password to user2
user2 = "mypassword"
}
}
# tftest:modules=1:resources=6
Variables
name | description | type | required | default |
---|---|---|---|---|
database_version | Database type and version to create. | string |
✓ | |
name | Name of primary replica. | string |
✓ | |
network | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | string |
✓ | |
project_id | The ID of the project where this instances will be created. | string |
✓ | |
region | Region of the primary replica. | string |
✓ | |
tier | The machine type to use for the instances. | string |
✓ | |
authorized_networks | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | map(string) |
null |
|
availability_type | Availability type for the primary replica. Either ZONAL or REGIONAL |
string |
ZONAL |
|
backup_configuration | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas | object({...}) |
... |
|
databases | Databases to create once the primary instance is created. | list(string) |
null |
|
deletion_protection | Allow terraform to delete instances. | bool |
false |
|
disk_size | Disk size in GB. Set to null to enable autoresize. | number |
null |
|
disk_type | The type of data disk: PD_SSD or PD_HDD . |
string |
PD_SSD |
|
flags | Map FLAG_NAME=>VALUE for database-specific tuning. | map(string) |
null |
|
labels | Labels to be attached to all instances. | map(string) |
null |
|
prefix | Prefix used to generate instance names. | string |
null |
|
replicas | Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation. | map(any) |
null |
|
users | 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
name | description | sensitive |
---|---|---|
connection_name | Connection name of the primary instance | |
connection_names | Connection names of all instances | |
id | ID of the primary instance | |
ids | IDs of all instances | |
instances | Cloud SQL instance resources | ✓ |
ip | IP address of the primary instance | |
ips | IP addresses of all instances | |
self_link | Self link of the primary instance | |
self_links | Self links of all instances | |
user_passwords | Map of containing the password of all users created through terraform. | ✓ |