Skip to content

Commit ce7f68b

Browse files
committed
Ran make generate_docs with terraform-docs 0.6.0.
It looks like there's now a feature to escape underscores in variables with more than 1 underscore... terraform-docs/terraform-docs#48 /shrug
1 parent d17defc commit ce7f68b

File tree

2 files changed

+146
-140
lines changed

2 files changed

+146
-140
lines changed

modules/mysql/README.md

Lines changed: 84 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -6,91 +6,94 @@
66

77
| Name | Description | Type | Default | Required |
88
|------|-------------|:----:|:-----:|:-----:|
9-
| activation_policy | The activation policy for the master instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `ALWAYS` | no |
10-
| additional_databases | A list of databases to be created in your cluster | list | `<list>` | no |
11-
| additional_users | A list of users to be created in your cluster | list | `<list>` | no |
12-
| authorized_gae_applications | The list of authorized App Engine project names | list | `<list>` | no |
13-
| backup_configuration | The backup configuration block of the Cloud SQL resources This argument will be passed through the master instance directrly.<br><br>See [more details](https://www.terraform.io/docs/providers/google/r/sql_database_instance.html). | map | `<map>` | no |
14-
| database_flags | The database flags for the master instance. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
15-
| database_version | The database version to use | string | - | yes |
16-
| db_charset | The charset for the default database | string | `` | no |
17-
| db_collation | The collation for the default database. Example: 'utf8_general_ci' | string | `` | no |
18-
| db_name | The name of the default database to create | string | `default` | no |
19-
| disk_autoresize | Configuration to increase storage size | string | `true` | no |
20-
| disk_size | The disk size for the master instance | string | `10` | no |
21-
| disk_type | The disk type for the master instance. | string | `PD_SSD` | no |
22-
| failover_replica | Specify true if the failover instance is required | string | `false` | no |
23-
| failover_replica_activation_policy | The activation policy for the failover replica instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `ALWAYS` | no |
24-
| failover_replica_configuration | The replica configuration for the failover replica instance. In order to create a failover instance, need to specify this argument. | map | `<map>` | no |
25-
| failover_replica_crash_safe_replication | The crash safe replication is to indicates when crash-safe replication flags are enabled. | string | `true` | no |
26-
| failover_replica_database_flags | The database flags for the failover replica instance. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
27-
| failover_replica_disk_autoresize | Configuration to increase storage size. | string | `true` | no |
28-
| failover_replica_disk_size | The disk size for the failover replica instance. | string | `10` | no |
29-
| failover_replica_disk_type | The disk type for the failover replica instance. | string | `PD_SSD` | no |
30-
| failover_replica_ip_configuration | The ip configuration for the failover replica instances. | map | `<map>` | no |
31-
| failover_replica_maintenance_window_day | The day of week (1-7) for the failover replica instance maintenance. | string | `1` | no |
32-
| failover_replica_maintenance_window_hour | The hour of day (0-23) maintenance window for the failover replica instance maintenance. | string | `23` | no |
33-
| failover_replica_maintenance_window_update_track | The update track of maintenance window for the failover replica instance maintenance. Can be either `canary` or `stable`. | string | `canary` | no |
34-
| failover_replica_pricing_plan | The pricing plan for the failover replica instance. | string | `PER_USE` | no |
35-
| failover_replica_replication_type | The replication type for the failover replica instance. Can be one of ASYNCHRONOUS or SYNCHRONOUS. | string | `SYNCHRONOUS` | no |
36-
| failover_replica_tier | The tier for the failover replica instance. | string | `` | no |
37-
| failover_replica_user_labels | The key/value labels for the failover replica instance. | map | `<map>` | no |
38-
| failover_replica_zone | The zone for the failover replica instance, it should be something like: `a`, `c`. | string | `` | no |
39-
| ip_configuration | The ip configuration for the master instance. | map | `<map>` | no |
40-
| maintenance_window_day | The day of week (1-7) for the master instance maintenance. | string | `1` | no |
41-
| maintenance_window_hour | The hour of day (0-23) maintenance window for the master instance maintenance. | string | `23` | no |
42-
| maintenance_window_update_track | The update track of maintenance window for the master instance maintenance. Can be either `canary` or `stable`. | string | `canary` | no |
43-
| name | The name of the Cloud SQL resources | string | - | yes |
44-
| pricing_plan | The pricing plan for the master instance. | string | `PER_USE` | no |
45-
| project_id | The project ID to manage the Cloud SQL resources | string | - | yes |
46-
| read_replica_activation_policy | The activation policy for the read replica instances. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `ALWAYS` | no |
47-
| read_replica_configuration | The replica configuration for use in all read replica instances. | map | `<map>` | no |
48-
| read_replica_crash_safe_replication | The crash safe replication is to indicates when crash-safe replication flags are enabled. | string | `true` | no |
49-
| read_replica_database_flags | The database flags for the read replica instances. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
50-
| read_replica_disk_autoresize | Configuration to increase storage size. | string | `true` | no |
51-
| read_replica_disk_size | The disk size for the read replica instances. | string | `10` | no |
52-
| read_replica_disk_type | The disk type for the read replica instances. | string | `PD_SSD` | no |
53-
| read_replica_ip_configuration | The ip configuration for the read replica instances. | map | `<map>` | no |
54-
| read_replica_maintenance_window_day | The day of week (1-7) for the read replica instances maintenance. | string | `1` | no |
55-
| read_replica_maintenance_window_hour | The hour of day (0-23) maintenance window for the read replica instances maintenance. | string | `23` | no |
56-
| read_replica_maintenance_window_update_track | The update track of maintenance window for the read replica instances maintenance. Can be either `canary` or `stable`. | string | `canary` | no |
57-
| read_replica_pricing_plan | The pricing plan for the read replica instances. | string | `PER_USE` | no |
58-
| read_replica_replication_type | The replication type for read replica instances. Can be one of ASYNCHRONOUS or SYNCHRONOUS. | string | `SYNCHRONOUS` | no |
59-
| read_replica_size | The size of read replicas | string | `0` | no |
60-
| read_replica_tier | The tier for the read replica instances. | string | `` | no |
61-
| read_replica_user_labels | The key/value labels for the read replica instances. | map | `<map>` | no |
62-
| read_replica_zones | The zones for the read replica instancess, it should be something like: `a,b,c`. Given zones are used rotationally for creating read replicas. | string | `` | no |
63-
| region | The region of the Cloud SQL resources | string | `us-central1` | no |
64-
| tier | The tier for the master instance. | string | `db-n1-standard-1` | no |
65-
| user_host | The host for the default user | string | `%` | no |
66-
| user_labels | The key/value labels for the master instances. | map | `<map>` | no |
67-
| user_name | The name of the default user | string | `default` | no |
68-
| 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 |
69-
| zone | The zone for the master instance, it should be something like: `a`, `c`. | string | - | yes |
9+
| activation\_policy | The activation policy for the master instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `"ALWAYS"` | no |
10+
| additional\_databases | A list of databases to be created in your cluster | list | `<list>` | no |
11+
| additional\_users | A list of users to be created in your cluster | list | `<list>` | no |
12+
| authorized\_gae\_applications | The list of authorized App Engine project names | list | `<list>` | no |
13+
| backup\_configuration | The backup configuration block of the Cloud SQL resources This argument will be passed through the master instance directrly.<br><br>See [more details](https://www.terraform.io/docs/providers/google/r/sql_database_instance.html). | map | `<map>` | no |
14+
| create\_timeout | The optional timout that is applied to limit long database creates. | string | `"10m"` | no |
15+
| database\_flags | The database flags for the master instance. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
16+
| database\_version | The database version to use | string | n/a | yes |
17+
| db\_charset | The charset for the default database | string | `""` | no |
18+
| db\_collation | The collation for the default database. Example: 'utf8_general_ci' | string | `""` | no |
19+
| db\_name | The name of the default database to create | string | `"default"` | no |
20+
| delete\_timeout | The optional timout that is applied to limit long database deletes. | string | `"10m"` | no |
21+
| disk\_autoresize | Configuration to increase storage size | string | `"true"` | no |
22+
| disk\_size | The disk size for the master instance | string | `"10"` | no |
23+
| disk\_type | The disk type for the master instance. | string | `"PD_SSD"` | no |
24+
| failover\_replica | Specify true if the failover instance is required | string | `"false"` | no |
25+
| failover\_replica\_activation\_policy | The activation policy for the failover replica instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `"ALWAYS"` | no |
26+
| failover\_replica\_configuration | The replica configuration for the failover replica instance. In order to create a failover instance, need to specify this argument. | map | `<map>` | no |
27+
| failover\_replica\_crash\_safe\_replication | The crash safe replication is to indicates when crash-safe replication flags are enabled. | string | `"true"` | no |
28+
| failover\_replica\_database\_flags | The database flags for the failover replica instance. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
29+
| failover\_replica\_disk\_autoresize | Configuration to increase storage size. | string | `"true"` | no |
30+
| failover\_replica\_disk\_size | The disk size for the failover replica instance. | string | `"10"` | no |
31+
| failover\_replica\_disk\_type | The disk type for the failover replica instance. | string | `"PD_SSD"` | no |
32+
| failover\_replica\_ip\_configuration | The ip configuration for the failover replica instances. | map | `<map>` | no |
33+
| failover\_replica\_maintenance\_window\_day | The day of week (1-7) for the failover replica instance maintenance. | string | `"1"` | no |
34+
| failover\_replica\_maintenance\_window\_hour | The hour of day (0-23) maintenance window for the failover replica instance maintenance. | string | `"23"` | no |
35+
| failover\_replica\_maintenance\_window\_update\_track | The update track of maintenance window for the failover replica instance maintenance. Can be either `canary` or `stable`. | string | `"canary"` | no |
36+
| failover\_replica\_pricing\_plan | The pricing plan for the failover replica instance. | string | `"PER_USE"` | no |
37+
| failover\_replica\_replication\_type | The replication type for the failover replica instance. Can be one of ASYNCHRONOUS or SYNCHRONOUS. | string | `"SYNCHRONOUS"` | no |
38+
| failover\_replica\_tier | The tier for the failover replica instance. | string | `""` | no |
39+
| failover\_replica\_user\_labels | The key/value labels for the failover replica instance. | map | `<map>` | no |
40+
| failover\_replica\_zone | The zone for the failover replica instance, it should be something like: `a`, `c`. | string | `""` | no |
41+
| ip\_configuration | The ip configuration for the master instance. | map | `<map>` | no |
42+
| maintenance\_window\_day | The day of week (1-7) for the master instance maintenance. | string | `"1"` | no |
43+
| maintenance\_window\_hour | The hour of day (0-23) maintenance window for the master instance maintenance. | string | `"23"` | no |
44+
| maintenance\_window\_update\_track | The update track of maintenance window for the master instance maintenance. Can be either `canary` or `stable`. | string | `"canary"` | no |
45+
| name | The name of the Cloud SQL resources | string | n/a | yes |
46+
| pricing\_plan | The pricing plan for the master instance. | string | `"PER_USE"` | no |
47+
| project\_id | The project ID to manage the Cloud SQL resources | string | n/a | yes |
48+
| read\_replica\_activation\_policy | The activation policy for the read replica instances. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. | string | `"ALWAYS"` | no |
49+
| read\_replica\_configuration | The replica configuration for use in all read replica instances. | map | `<map>` | no |
50+
| read\_replica\_crash\_safe\_replication | The crash safe replication is to indicates when crash-safe replication flags are enabled. | string | `"true"` | no |
51+
| read\_replica\_database\_flags | The database flags for the read replica instances. See [more details](https://cloud.google.com/sql/docs/mysql/flags) | list | `<list>` | no |
52+
| read\_replica\_disk\_autoresize | Configuration to increase storage size. | string | `"true"` | no |
53+
| read\_replica\_disk\_size | The disk size for the read replica instances. | string | `"10"` | no |
54+
| read\_replica\_disk\_type | The disk type for the read replica instances. | string | `"PD_SSD"` | no |
55+
| read\_replica\_ip\_configuration | The ip configuration for the read replica instances. | map | `<map>` | no |
56+
| read\_replica\_maintenance\_window\_day | The day of week (1-7) for the read replica instances maintenance. | string | `"1"` | no |
57+
| read\_replica\_maintenance\_window\_hour | The hour of day (0-23) maintenance window for the read replica instances maintenance. | string | `"23"` | no |
58+
| read\_replica\_maintenance\_window\_update\_track | The update track of maintenance window for the read replica instances maintenance. Can be either `canary` or `stable`. | string | `"canary"` | no |
59+
| read\_replica\_pricing\_plan | The pricing plan for the read replica instances. | string | `"PER_USE"` | no |
60+
| read\_replica\_replication\_type | The replication type for read replica instances. Can be one of ASYNCHRONOUS or SYNCHRONOUS. | string | `"SYNCHRONOUS"` | no |
61+
| read\_replica\_size | The size of read replicas | string | `"0"` | no |
62+
| read\_replica\_tier | The tier for the read replica instances. | string | `""` | no |
63+
| read\_replica\_user\_labels | The key/value labels for the read replica instances. | map | `<map>` | no |
64+
| read\_replica\_zones | The zones for the read replica instancess, it should be something like: `a,b,c`. Given zones are used rotationally for creating read replicas. | string | `""` | no |
65+
| region | The region of the Cloud SQL resources | string | `"us-central1"` | no |
66+
| tier | The tier for the master instance. | string | `"db-n1-standard-1"` | no |
67+
| update\_timeout | The optional timout that is applied to limit long database updates. | string | `"10m"` | no |
68+
| user\_host | The host for the default user | string | `"%"` | no |
69+
| user\_labels | The key/value labels for the master instances. | map | `<map>` | no |
70+
| user\_name | The name of the default user | string | `"default"` | no |
71+
| 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 |
72+
| zone | The zone for the master instance, it should be something like: `a`, `c`. | string | n/a | yes |
7073

7174
## Outputs
7275

7376
| Name | Description |
7477
|------|-------------|
75-
| failover-replica_instance_connection_name | The connection name of the failover-replica instance to be used in connection strings |
76-
| failover-replica_instance_first_ip_address | The first IPv4 address of the addesses assigned for the failover-replica instance |
77-
| failover-replica_instance_name | The instance name for the failover replica instance |
78-
| failover-replica_instance_self_link | The URI of the failover-replica instance |
79-
| failover-replica_instance_server_ca_cert | The CA certificate information used to connect to the failover-replica instance via SSL |
80-
| failover-replica_instance_service_account_email_address | The service account email addresses assigned to the failover-replica instance |
81-
| generated_user_password | The auto generated default user password if not input password was provided |
82-
| instance_connection_name | The connection name of the master instance to be used in connection strings |
83-
| instance_first_ip_address | The first IPv4 address of the addresses assigned for the master instance. |
84-
| instance_ip_address | The IPv4 address assigned for the master instance |
85-
| instance_name | The instance name for the master instance |
86-
| instance_self_link | The URI of the master instance |
87-
| instance_server_ca_cert | The CA certificate information used to connect to the SQL instance via SSL |
88-
| instance_service_account_email_address | The service account email address assigned to the master instance |
89-
| read_replica_instance_names | The instance names for the read replica instances |
90-
| replicas_instance_connection_names | The connection names of the replica instances to be used in connection strings |
91-
| replicas_instance_first_ip_addresses | The first IPv4 addresses of the addresses assigned for the replica instances |
92-
| replicas_instance_self_links | The URIs of the replica instances |
93-
| replicas_instance_server_ca_certs | The CA certificates information used to connect to the replica instances via SSL |
94-
| replicas_instance_service_account_email_addresses | The service account email addresses assigned to the replica instances |
78+
| failover-replica\_instance\_connection\_name | The connection name of the failover-replica instance to be used in connection strings |
79+
| failover-replica\_instance\_first\_ip\_address | The first IPv4 address of the addesses assigned for the failover-replica instance |
80+
| failover-replica\_instance\_name | The instance name for the failover replica instance |
81+
| failover-replica\_instance\_self\_link | The URI of the failover-replica instance |
82+
| failover-replica\_instance\_server\_ca\_cert | The CA certificate information used to connect to the failover-replica instance via SSL |
83+
| failover-replica\_instance\_service\_account\_email\_address | The service account email addresses assigned to the failover-replica instance |
84+
| generated\_user\_password | The auto generated default user password if not input password was provided |
85+
| instance\_connection\_name | The connection name of the master instance to be used in connection strings |
86+
| instance\_first\_ip\_address | The first IPv4 address of the addresses assigned for the master instance. |
87+
| instance\_ip\_address | The IPv4 address assigned for the master instance |
88+
| instance\_name | The instance name for the master instance |
89+
| instance\_self\_link | The URI of the master instance |
90+
| instance\_server\_ca\_cert | The CA certificate information used to connect to the SQL instance via SSL |
91+
| instance\_service\_account\_email\_address | The service account email address assigned to the master instance |
92+
| read\_replica\_instance\_names | The instance names for the read replica instances |
93+
| replicas\_instance\_connection\_names | The connection names of the replica instances to be used in connection strings |
94+
| replicas\_instance\_first\_ip\_addresses | The first IPv4 addresses of the addresses assigned for the replica instances |
95+
| replicas\_instance\_self\_links | The URIs of the replica instances |
96+
| replicas\_instance\_server\_ca\_certs | The CA certificates information used to connect to the replica instances via SSL |
97+
| replicas\_instance\_service\_account\_email\_addresses | The service account email addresses assigned to the replica instances |
9598

9699
[^]: (autogen_docs_end)

0 commit comments

Comments
 (0)