kovagoadi/hunfabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add periods at the end of each description field where missing (#478)

Browse Source
This commit is contained in:
Simone Ruffilli
2022-01-31 10:45:34 +01:00
committed by GitHub
parent e2abd772f2
commit abb6b50a46
97 changed files with 253 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
modules/cloudsql-instance/README.md
View File

@@ -103,8 +103,8 @@ module "db" {
| [region](variables.tf#L112) | Region of the primary replica. | <code>string</code> | ✓ | |
| [tier](variables.tf#L123) | The machine type to use for the instances. | <code>string</code> | ✓ | |
| [authorized_networks](variables.tf#L17) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code>map&#40;string&#41;</code> | | <code>null</code> |
| [availability_type](variables.tf#L23) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL` | <code>string</code> | | <code>&#34;ZONAL&#34;</code> |
| [backup_configuration](variables.tf#L29) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas | <code title="object&#40;&#123;&#10; enabled &#61; bool&#10; binary_log_enabled &#61; bool&#10; start_time &#61; string&#10; location &#61; string&#10; log_retention_days &#61; number&#10; retention_count &#61; number&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; enabled &#61; false&#10; binary_log_enabled &#61; false&#10; start_time &#61; &#34;23:00&#34;&#10; location &#61; &#34;EU&#34;&#10; log_retention_days &#61; 7&#10; retention_count &#61; 7&#10;&#125;">&#123;&#8230;&#125;</code> |
| [availability_type](variables.tf#L23) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>&#34;ZONAL&#34;</code> |
| [backup_configuration](variables.tf#L29) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | <code title="object&#40;&#123;&#10; enabled &#61; bool&#10; binary_log_enabled &#61; bool&#10; start_time &#61; string&#10; location &#61; string&#10; log_retention_days &#61; number&#10; retention_count &#61; number&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; enabled &#61; false&#10; binary_log_enabled &#61; false&#10; start_time &#61; &#34;23:00&#34;&#10; location &#61; &#34;EU&#34;&#10; log_retention_days &#61; 7&#10; retention_count &#61; 7&#10;&#125;">&#123;&#8230;&#125;</code> |
| [databases](variables.tf#L55) | Databases to create once the primary instance is created. | <code>list&#40;string&#41;</code> | | <code>null</code> |
| [deletion_protection](variables.tf#L61) | Allow terraform to delete instances. | <code>bool</code> | | <code>false</code> |
| [disk_size](variables.tf#L67) | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
@@ -113,21 +113,21 @@ module "db" {
| [labels](variables.tf#L85) | Labels to be attached to all instances. | <code>map&#40;string&#41;</code> | | <code>null</code> |
| [prefix](variables.tf#L101) | Prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
| [replicas](variables.tf#L117) | Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation. | <code>map&#40;any&#41;</code> | | <code>null</code> |
| [users](variables.tf#L128) | 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&#40;string&#41;</code> | | <code>null</code> |
| [users](variables.tf#L128) | 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&#40;string&#41;</code> | | <code>null</code> |
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [connection_name](outputs.tf#L24) | Connection name of the primary instance | |
| [connection_names](outputs.tf#L29) | Connection names of all instances | |
| [id](outputs.tf#L37) | ID of the primary instance | |
| [ids](outputs.tf#L42) | IDs of all instances | |
| [instances](outputs.tf#L50) | Cloud SQL instance resources | ✓ |
| [ip](outputs.tf#L56) | IP address of the primary instance | |
| [ips](outputs.tf#L61) | IP addresses of all instances | |
| [self_link](outputs.tf#L69) | Self link of the primary instance | |
| [self_links](outputs.tf#L74) | Self links of all instances | |
| [connection_name](outputs.tf#L24) | Connection name of the primary instance. | |
| [connection_names](outputs.tf#L29) | Connection names of all instances. | |
| [id](outputs.tf#L37) | ID of the primary instance. | |
| [ids](outputs.tf#L42) | IDs of all instances. | |
| [instances](outputs.tf#L50) | Cloud SQL instance resources. | ✓ |
| [ip](outputs.tf#L56) | IP address of the primary instance. | |
| [ips](outputs.tf#L61) | IP addresses of all instances. | |
| [self_link](outputs.tf#L69) | Self link of the primary instance. | |
| [self_links](outputs.tf#L74) | Self links of all instances. | |
| [user_passwords](outputs.tf#L82) | Map of containing the password of all users created through terraform. | ✓ |
<!-- END TFDOC -->

18
modules/cloudsql-instance/outputs.tf
View File

@@ -22,12 +22,12 @@ locals {
}
output "connection_name" {
description = "Connection name of the primary instance"
description = "Connection name of the primary instance."
value = google_sql_database_instance.primary.connection_name
}
output "connection_names" {
description = "Connection names of all instances"
description = "Connection names of all instances."
value = {
for id, instance in local._all_intances :
id => instance.connection_name
@@ -35,12 +35,12 @@ output "connection_names" {
}
output "id" {
description = "ID of the primary instance"
description = "ID of the primary instance."
value = google_sql_database_instance.primary.private_ip_address
}
output "ids" {
description = "IDs of all instances"
description = "IDs of all instances."
value = {
for id, instance in local._all_intances :
id => instance.id
@@ -48,18 +48,18 @@ output "ids" {
}
output "instances" {
description = "Cloud SQL instance resources"
description = "Cloud SQL instance resources."
value = local._all_intances
sensitive = true
}
output "ip" {
description = "IP address of the primary instance"
description = "IP address of the primary instance."
value = google_sql_database_instance.primary.private_ip_address
}
output "ips" {
description = "IP addresses of all instances"
description = "IP addresses of all instances."
value = {
for id, instance in local._all_intances :
id => instance.private_ip_address
@@ -67,12 +67,12 @@ output "ips" {
}
output "self_link" {
description = "Self link of the primary instance"
description = "Self link of the primary instance."
value = google_sql_database_instance.primary.self_link
}
output "self_links" {
description = "Self links of all instances"
description = "Self links of all instances."
value = {
for id, instance in local._all_intances :
id => instance.self_link

6
modules/cloudsql-instance/variables.tf
View File

@@ -21,13 +21,13 @@ variable "authorized_networks" {
}
variable "availability_type" {
description = "Availability type for the primary replica. Either `ZONAL` or `REGIONAL`"
description = "Availability type for the primary replica. Either `ZONAL` or `REGIONAL`."
type = string
default = "ZONAL"
}
variable "backup_configuration" {
description = "Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas"
description = "Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas."
type = object({
enabled = bool
binary_log_enabled = bool
@@ -126,7 +126,7 @@ variable "tier" {
}
variable "users" {
description = "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"
description = "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."
type = map(string)
default = null
}