Skip to content

Commit f4523c7

Browse files
authored
docs: make generate_docs (#440)
1 parent 42b14c5 commit f4523c7

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

modules/mssql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following dependency must be available for SQL Server module:
1515
| 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 |
1616
| availability\_type | The availability type for the master instance.This is only used to set up high availability for the MSSQL instance. Can be either `ZONAL` or `REGIONAL`. | `string` | `"ZONAL"` | no |
1717
| backup\_configuration | The database backup configuration. | <pre>object({<br> binary_log_enabled = bool<br> enabled = bool<br> point_in_time_recovery_enabled = bool<br> start_time = string<br> transaction_log_retention_days = string<br> retained_backups = number<br> retention_unit = string<br> })</pre> | <pre>{<br> "binary_log_enabled": null,<br> "enabled": false,<br> "point_in_time_recovery_enabled": null,<br> "retained_backups": null,<br> "retention_unit": null,<br> "start_time": null,<br> "transaction_log_retention_days": null<br>}</pre> | no |
18-
| create\_timeout | The optional timeout that is applied to limit long database creates. | `string` | `"15m"` | no |
18+
| create\_timeout | The optional timeout that is applied to limit long database creates. | `string` | `"30m"` | no |
1919
| database\_flags | The database flags for the master instance. See [more details](https://cloud.google.com/sql/docs/sqlserver/flags) | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
2020
| database\_version | The database version to use: SQLSERVER\_2017\_STANDARD, SQLSERVER\_2017\_ENTERPRISE, SQLSERVER\_2017\_EXPRESS, or SQLSERVER\_2017\_WEB | `string` | `"SQLSERVER_2017_STANDARD"` | no |
2121
| db\_charset | The charset for the default database | `string` | `""` | no |
@@ -45,7 +45,7 @@ The following dependency must be available for SQL Server module:
4545
| secondary\_zone | The preferred zone for the secondary/failover instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
4646
| sql\_server\_audit\_config | SQL server audit config settings. | `map(string)` | `{}` | no |
4747
| tier | The tier for the master instance. | `string` | `"db-custom-2-3840"` | no |
48-
| update\_timeout | The optional timeout that is applied to limit long database updates. | `string` | `"15m"` | no |
48+
| update\_timeout | The optional timeout that is applied to limit long database updates. | `string` | `"30m"` | no |
4949
| user\_labels | The key/value labels for the master instances. | `map(string)` | `{}` | no |
5050
| user\_name | The name of the default user | `string` | `"default"` | no |
5151
| user\_password | The password for the default user. If not set, a random one will be generated and available in the generated\_user\_password output variable. | `string` | `""` | no |

modules/mysql/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Note: CloudSQL provides [disk autoresize](https://cloud.google.com/sql/docs/mysq
1212
| 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 |
1313
| availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
1414
| 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 |
15-
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"10m"` | no |
15+
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
1616
| database\_flags | List of Cloud SQL flags that are applied to the database server. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
1717
| database\_version | The database version to use | `string` | n/a | yes |
1818
| db\_charset | The charset for the default database | `string` | `""` | no |
1919
| db\_collation | The collation for the default database. Example: 'utf8\_general\_ci' | `string` | `""` | no |
2020
| db\_name | The name of the default database to create | `string` | `"default"` | no |
21-
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"10m"` | no |
21+
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"30m"` | no |
2222
| deletion\_protection | Used to block Terraform from deleting a SQL Instance. | `bool` | `true` | no |
2323
| deletion\_protection\_enabled | Enables protection of an instance from accidental deletion protection across all surfaces (API, gcloud, Cloud Console and Terraform). | `bool` | `false` | no |
2424
| deny\_maintenance\_period | The Deny Maintenance Period fields to prevent automatic maintenance from occurring during a 90-day time period. See [more details](https://cloud.google.com/sql/docs/mysql/maintenance) | <pre>list(object({<br> end_date = string<br> start_date = string<br> time = string<br> }))</pre> | `[]` | no |
@@ -50,7 +50,7 @@ Note: CloudSQL provides [disk autoresize](https://cloud.google.com/sql/docs/mysq
5050
| root\_password | Mysql password for the root user. If not set, a random one will be generated and available in the root\_password output variable. | `string` | `""` | no |
5151
| secondary\_zone | The preferred zone for the secondary/failover instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
5252
| tier | The tier for the master instance. | `string` | `"db-n1-standard-1"` | no |
53-
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"10m"` | no |
53+
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"30m"` | no |
5454
| user\_host | The host for the default user | `string` | `"%"` | no |
5555
| user\_labels | The key/value labels for the master instances. | `map(string)` | `{}` | no |
5656
| user\_name | The name of the default user | `string` | `"default"` | no |

modules/postgresql/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Note: CloudSQL provides [disk autoresize](https://cloud.google.com/sql/docs/mysq
1212
| 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 |
1313
| availability\_type | The availability type for the master instance.This is only used to set up high availability for the PostgreSQL instance. Can be either `ZONAL` or `REGIONAL`. | `string` | `"ZONAL"` | no |
1414
| backup\_configuration | The backup\_configuration settings subblock for the database setings | <pre>object({<br> enabled = bool<br> start_time = string<br> location = string<br> point_in_time_recovery_enabled = bool<br> transaction_log_retention_days = string<br> retained_backups = number<br> retention_unit = string<br> })</pre> | <pre>{<br> "enabled": false,<br> "location": null,<br> "point_in_time_recovery_enabled": false,<br> "retained_backups": null,<br> "retention_unit": null,<br> "start_time": null,<br> "transaction_log_retention_days": null<br>}</pre> | no |
15-
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"15m"` | no |
15+
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
1616
| database\_deletion\_policy | The deletion policy for the database. Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be deleted from the API if there are users other than cloudsqlsuperuser with access. Possible values are: "ABANDON". | `string` | `null` | no |
1717
| database\_flags | The database flags for the master instance. See [more details](https://cloud.google.com/sql/docs/postgres/flags) | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
1818
| database\_version | The database version to use | `string` | n/a | yes |
1919
| db\_charset | The charset for the default database | `string` | `""` | no |
2020
| db\_collation | The collation for the default database. Example: 'en\_US.UTF8' | `string` | `""` | no |
2121
| db\_name | The name of the default database to create | `string` | `"default"` | no |
22-
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"15m"` | no |
22+
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"30m"` | no |
2323
| deletion\_protection | Used to block Terraform from deleting a SQL Instance. | `bool` | `true` | no |
2424
| deletion\_protection\_enabled | Enables protection of an instance from accidental deletion protection across all surfaces (API, gcloud, Cloud Console and Terraform). | `bool` | `false` | no |
2525
| deny\_maintenance\_period | The Deny Maintenance Period fields to prevent automatic maintenance from occurring during a 90-day time period. See [more details](https://cloud.google.com/sql/docs/postgres/maintenance) | <pre>list(object({<br> end_date = string<br> start_date = string<br> time = string<br> }))</pre> | `[]` | no |
@@ -50,7 +50,7 @@ Note: CloudSQL provides [disk autoresize](https://cloud.google.com/sql/docs/mysq
5050
| region | The region of the Cloud SQL resources | `string` | `"us-central1"` | no |
5151
| secondary\_zone | The preferred zone for the secondary/failover instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
5252
| tier | The tier for the master instance. | `string` | `"db-f1-micro"` | no |
53-
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"15m"` | no |
53+
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"30m"` | no |
5454
| 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 |
5555
| user\_labels | The key/value labels for the master instances. | `map(string)` | `{}` | no |
5656
| user\_name | The name of the default user | `string` | `"default"` | no |

modules/safer_mysql/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,13 @@ mysql -S $HOME/mysql_sockets/myproject:region:instance -u user -p
171171
| assign\_public\_ip | Set to true if the master instance should also have a public IP (less secure). | `string` | `false` | no |
172172
| availability\_type | The availability type for the master instance. Can be either `REGIONAL` or `null`. | `string` | `"REGIONAL"` | no |
173173
| 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 |
174-
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"15m"` | no |
174+
| create\_timeout | The optional timout that is applied to limit long database creates. | `string` | `"30m"` | no |
175175
| 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 |
176176
| database\_version | The database version to use | `string` | n/a | yes |
177177
| db\_charset | The charset for the default database | `string` | `""` | no |
178178
| db\_collation | The collation for the default database. Example: 'utf8\_general\_ci' | `string` | `""` | no |
179179
| db\_name | The name of the default database to create | `string` | `"default"` | no |
180-
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"15m"` | no |
180+
| delete\_timeout | The optional timout that is applied to limit long database deletes. | `string` | `"30m"` | no |
181181
| deletion\_protection | Used to block Terraform from deleting a SQL Instance. | `bool` | `true` | no |
182182
| deletion\_protection\_enabled | Enables protection of an instance from accidental deletion protection across all surfaces (API, gcloud, Cloud Console and Terraform). | `bool` | `false` | no |
183183
| deny\_maintenance\_period | The Deny Maintenance Period fields to prevent automatic maintenance from occurring during a 90-day time period. See [more details](https://cloud.google.com/sql/docs/mysql/maintenance) | <pre>list(object({<br> end_date = string<br> start_date = string<br> time = string<br> }))</pre> | `[]` | no |
@@ -202,7 +202,7 @@ mysql -S $HOME/mysql_sockets/myproject:region:instance -u user -p
202202
| region | The region of the Cloud SQL resources | `string` | n/a | yes |
203203
| secondary\_zone | The preferred zone for the secondary/failover instance, it should be something like: `us-central1-a`, `us-east1-c`. | `string` | `null` | no |
204204
| tier | The tier for the master instance. | `string` | `"db-n1-standard-1"` | no |
205-
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"15m"` | no |
205+
| update\_timeout | The optional timout that is applied to limit long database updates. | `string` | `"30m"` | no |
206206
| user\_labels | The key/value labels for the master instances. | `map(string)` | `{}` | no |
207207
| user\_name | The name of the default user | `string` | `"default"` | no |
208208
| user\_password | The password for the default user. If not set, a random one will be generated and available in the generated\_user\_password output variable. | `string` | `""` | no |

0 commit comments

Comments
 (0)