New tfdoc version (#396)
* update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos
This commit is contained in:
Ludovico Magnocavallo
committed by
GitHub
GitHub
parent
d2cbf800fc
commit
1ac3fe4460
@@ -92,28 +92,29 @@ module "db" {
|
||||
```
|
||||
|
||||
<!-- BEGIN TFDOC -->
|
||||
|
||||
## Variables
|
||||
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---: |:---:|:---:|
|
||||
| database_version | Database type and version to create. | <code title="">string</code> | ✓ | |
|
||||
| name | Name of primary replica. | <code title="">string</code> | ✓ | |
|
||||
| network | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | <code title="">string</code> | ✓ | |
|
||||
| project_id | The ID of the project where this instances will be created. | <code title="">string</code> | ✓ | |
|
||||
| region | Region of the primary replica. | <code title="">string</code> | ✓ | |
|
||||
| tier | The machine type to use for the instances. | <code title="">string</code> | ✓ | |
|
||||
| *authorized_networks* | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code title="map(string)">map(string)</code> | | <code title="">null</code> |
|
||||
| *availability_type* | Availability type for the primary replica. Either `ZONAL` or `REGIONAL` | <code title="">string</code> | | <code title="">ZONAL</code> |
|
||||
| *backup_configuration* | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas | <code title="object({ enabled = bool binary_log_enabled = bool start_time = string location = string log_retention_days = number retention_count = number })">object({...})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = "EU" log_retention_days = 7 retention_count = 7 }">...</code> |
|
||||
| *databases* | Databases to create once the primary instance is created. | <code title="list(string)">list(string)</code> | | <code title="">null</code> |
|
||||
| *deletion_protection* | Allow terraform to delete instances. | <code title="">bool</code> | | <code title="">false</code> |
|
||||
| *disk_size* | Disk size in GB. Set to null to enable autoresize. | <code title="">number</code> | | <code title="">null</code> |
|
||||
| *disk_type* | The type of data disk: `PD_SSD` or `PD_HDD`. | <code title="">string</code> | | <code title="">PD_SSD</code> |
|
||||
| *flags* | Map FLAG_NAME=>VALUE for database-specific tuning. | <code title="map(string)">map(string)</code> | | <code title="">null</code> |
|
||||
| *labels* | Labels to be attached to all instances. | <code title="map(string)">map(string)</code> | | <code title="">null</code> |
|
||||
| *prefix* | Prefix used to generate instance names. | <code title="">string</code> | | <code title="">null</code> |
|
||||
| *replicas* | Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation. | <code title="map(any)">map(any)</code> | | <code title="">null</code> |
|
||||
| *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 | <code title="map(string)">map(string)</code> | | <code title="">null</code> |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| database_version | Database type and version to create. | <code>string</code> | ✓ | |
|
||||
| name | Name of primary replica. | <code>string</code> | ✓ | |
|
||||
| network | 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 | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
||||
| region | Region of the primary replica. | <code>string</code> | ✓ | |
|
||||
| tier | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
||||
| authorized_networks | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code>map(string)</code> | | <code>null</code> |
|
||||
| availability_type | Availability type for the primary replica. Either `ZONAL` or `REGIONAL` | <code>string</code> | | <code>"ZONAL"</code> |
|
||||
| backup_configuration | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas | <code title="object({ enabled = bool binary_log_enabled = bool start_time = string location = string log_retention_days = number retention_count = number })">object({…})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = "EU" log_retention_days = 7 retention_count = 7 }">{…}</code> |
|
||||
| databases | Databases to create once the primary instance is created. | <code>list(string)</code> | | <code>null</code> |
|
||||
| deletion_protection | Allow terraform to delete instances. | <code>bool</code> | | <code>false</code> |
|
||||
| disk_size | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
|
||||
| disk_type | The type of data disk: `PD_SSD` or `PD_HDD`. | <code>string</code> | | <code>"PD_SSD"</code> |
|
||||
| flags | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
||||
| labels | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
||||
| prefix | Prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
||||
| replicas | Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation. | <code>map(any)</code> | | <code>null</code> |
|
||||
| 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 | <code>map(string)</code> | | <code>null</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
@@ -129,4 +130,6 @@ module "db" {
|
||||
| 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. | ✓ |
|
||||
|
||||
|
||||
<!-- END TFDOC -->
|
||||
|
||||
Reference in New Issue
Block a user