Skip to content

Commit 1615d75

Browse files
authored
fix: correct typos in README and variables.tf descriptions (#753)
1 parent 4eb9309 commit 1615d75

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

modules/mysql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module "mysql-db" {
4949
| 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 |
5050
| additional\_users | A list of users to be created in your cluster. A random password would be set for the user if the `random_password` variable is set. | <pre>list(object({<br> name = string<br> password = string<br> random_password = bool<br> type = string<br> host = string<br> }))</pre> | `[]` | no |
5151
| availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
52-
| backup\_configuration | The backup\_configuration settings subblock for the database setings | <pre>object({<br> binary_log_enabled = optional(bool, false)<br> enabled = optional(bool, false)<br> start_time = optional(string)<br> location = optional(string)<br> transaction_log_retention_days = optional(string)<br> retained_backups = optional(number)<br> retention_unit = optional(string)<br> })</pre> | `{}` | no |
52+
| backup\_configuration | The backup\_configuration settings subblock for the database settings | <pre>object({<br> binary_log_enabled = optional(bool, false)<br> enabled = optional(bool, false)<br> start_time = optional(string)<br> location = optional(string)<br> transaction_log_retention_days = optional(string)<br> retained_backups = optional(number)<br> retention_unit = optional(string)<br> })</pre> | `{}` | no |
5353
| connector\_enforcement | Enforce that clients use the connector library | `bool` | `false` | no |
5454
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
5555
| data\_cache\_enabled | Whether data cache is enabled for the instance. Defaults to false. Feature is only available for ENTERPRISE\_PLUS tier and supported database\_versions | `bool` | `false` | no |
@@ -100,7 +100,7 @@ module "mysql-db" {
100100
| retain\_backups\_on\_delete | When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON\_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. | `bool` | `false` | no |
101101
| root\_password | MySQL password for the root user. | `string` | `null` | no |
102102
| secondary\_zone | The preferred zone for the secondary/failover instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
103-
| tier | The tier for the master instance, for ADC its defualt value will be db-perf-optimized-N-8 which is tier value for edtion ENTERPRISE\_PLUS, if user wants to change the edition, he should chose compatible tier. | `string` | `"db-n1-standard-1"` | no |
103+
| tier | The tier for the master instance, for ADC its default value will be db-perf-optimized-N-8 which is tier value for edition ENTERPRISE\_PLUS, if user wants to change the edition, he should chose compatible tier. | `string` | `"db-n1-standard-1"` | no |
104104
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"30m"` | no |
105105
| user\_deletion\_policy | The deletion policy for the user. Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where users cannot be deleted from the API if they have been granted SQL roles. Possible values are: "ABANDON". | `string` | `null` | no |
106106
| user\_host | The host for the default user | `string` | `"%"` | no |

modules/mysql/variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ variable "instance_type" {
185185

186186
// Master
187187
variable "tier" {
188-
description = "The tier for the master instance, for ADC its defualt value will be db-perf-optimized-N-8 which is tier value for edtion ENTERPRISE_PLUS, if user wants to change the edition, he should chose compatible tier."
188+
description = "The tier for the master instance, for ADC its default value will be db-perf-optimized-N-8 which is tier value for edition ENTERPRISE_PLUS, if user wants to change the edition, he should chose compatible tier."
189189
type = string
190190
default = "db-n1-standard-1"
191191
}
@@ -301,7 +301,7 @@ variable "deny_maintenance_period" {
301301
}
302302

303303
variable "backup_configuration" {
304-
description = "The backup_configuration settings subblock for the database setings"
304+
description = "The backup_configuration settings subblock for the database settings"
305305
type = object({
306306
binary_log_enabled = optional(bool, false)
307307
enabled = optional(bool, false)

modules/postgresql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ module "pg" {
120120
| 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 |
121121
| additional\_users | A list of users to be created in your cluster. A random password would be set for the user if the `random_password` variable is set. | <pre>list(object({<br> name = string<br> password = string<br> random_password = bool<br> }))</pre> | `[]` | no |
122122
| availability\_type | 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`. | `string` | `"ZONAL"` | no |
123-
| backup\_configuration | The backup\_configuration settings subblock for the database setings | <pre>object({<br> enabled = optional(bool, false)<br> start_time = optional(string)<br> location = optional(string)<br> point_in_time_recovery_enabled = optional(bool, false)<br> transaction_log_retention_days = optional(string)<br> retained_backups = optional(number)<br> retention_unit = optional(string)<br> })</pre> | `{}` | no |
123+
| backup\_configuration | The backup\_configuration settings subblock for the database settings | <pre>object({<br> enabled = optional(bool, false)<br> start_time = optional(string)<br> location = optional(string)<br> point_in_time_recovery_enabled = optional(bool, false)<br> transaction_log_retention_days = optional(string)<br> retained_backups = optional(number)<br> retention_unit = optional(string)<br> })</pre> | `{}` | no |
124124
| connector\_enforcement | Enforce that clients use the connector library | `bool` | `false` | no |
125125
| create\_kms\_key\_handle | KeyHandles cannot be deleted from Google Cloud Platform. Destroying a Terraform-managed KeyHandle will remove it from state but will not delete the resource from the project. Set this to false if key handle already exists | `bool` | `true` | no |
126126
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
@@ -173,7 +173,7 @@ module "pg" {
173173
| retain\_backups\_on\_delete | When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON\_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. | `bool` | `false` | no |
174174
| root\_password | Initial root password during creation | `string` | `null` | no |
175175
| secondary\_zone | The preferred zone for the replica instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
176-
| tier | The tier for the Cloud SQL instance, for ADC its defualt value will be db-perf-optimized-N-8 which is tier value for edtion ENTERPRISE\_PLUS, if user wants to change the edition, he should chose compatible tier. | `string` | `"db-f1-micro"` | no |
176+
| tier | The tier for the Cloud SQL instance, for ADC its default value will be db-perf-optimized-N-8 which is tier value for edition ENTERPRISE\_PLUS, if user wants to change the edition, he should chose compatible tier. | `string` | `"db-f1-micro"` | no |
177177
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"30m"` | no |
178178
| use\_autokey | Enable the use of autokeys from Google Cloud KMS for CMEK. This requires autokey already configured in the project | `bool` | `false` | no |
179179
| user\_deletion\_policy | The deletion policy for the user. Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where users cannot be deleted from the API if they have been granted SQL roles. Possible values are: "ABANDON". | `string` | `null` | no |

modules/postgresql/variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ variable "random_instance_name" {
177177
}
178178

179179
variable "tier" {
180-
description = "The tier for the Cloud SQL instance, for ADC its defualt value will be db-perf-optimized-N-8 which is tier value for edtion ENTERPRISE_PLUS, if user wants to change the edition, he should chose compatible tier."
180+
description = "The tier for the Cloud SQL instance, for ADC its default value will be db-perf-optimized-N-8 which is tier value for edition ENTERPRISE_PLUS, if user wants to change the edition, he should chose compatible tier."
181181
type = string
182182
default = "db-f1-micro"
183183
}
@@ -283,7 +283,7 @@ variable "deny_maintenance_period" {
283283
}
284284

285285
variable "backup_configuration" {
286-
description = "The backup_configuration settings subblock for the database setings"
286+
description = "The backup_configuration settings subblock for the database settings"
287287
type = object({
288288
enabled = optional(bool, false)
289289
start_time = optional(string)

modules/private_service_access/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module "test_psa" {
3838
| ip\_version | IP Version for the allocation. Can be IPV4 or IPV6. | `string` | `""` | no |
3939
| labels | The key/value labels for the IP range allocated to the peered network. | `map(string)` | `{}` | no |
4040
| prefix\_length | Prefix length of the IP range reserved for Cloud SQL instances and other Private Service Access services. Defaults to /16. | `number` | `16` | no |
41-
| project\_id | The project ID of the VPC network to peer. This can be a shared VPC host projec. | `string` | n/a | yes |
41+
| project\_id | The project ID of the VPC network to peer. This can be a shared VPC host project. | `string` | n/a | yes |
4242
| vpc\_network | Name of the VPC network to peer. | `string` | n/a | yes |
4343

4444
## Outputs

modules/private_service_access/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*/
1616

1717
variable "project_id" {
18-
description = "The project ID of the VPC network to peer. This can be a shared VPC host projec."
18+
description = "The project ID of the VPC network to peer. This can be a shared VPC host project."
1919
type = string
2020
}
2121

modules/safer_mysql/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ module "safer-mysql-db" {
244244
| allocated\_ip\_range | Existing allocated IP range name for the Private IP CloudSQL instance. The networks needs to be configured with https://cloud.google.com/vpc/docs/configure-private-services-access. | `string` | `null` | no |
245245
| assign\_public\_ip | Set to true if the master instance should also have a public IP (less secure). | `bool` | `false` | no |
246246
| availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
247-
| 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 |
247+
| backup\_configuration | The backup\_configuration settings subblock for the database settings | <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 |
248248
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
249249
| data\_cache\_enabled | Whether data cache is enabled for the instance. Defaults to false. Feature is only available for ENTERPRISE\_PLUS tier and supported database\_versions | `bool` | `false` | no |
250250
| database\_flags | The database flags for the master instance. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |

modules/safer_mysql/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ variable "user_labels" {
216216
}
217217

218218
variable "backup_configuration" {
219-
description = "The backup_configuration settings subblock for the database setings"
219+
description = "The backup_configuration settings subblock for the database settings"
220220
type = object({
221221
binary_log_enabled = bool
222222
enabled = bool

0 commit comments

Comments
 (0)