diff --git a/examples/cloud-operations/dns-shared-vpc/README.md b/examples/cloud-operations/dns-shared-vpc/README.md index 2a6c79011..242fc9782 100644 --- a/examples/cloud-operations/dns-shared-vpc/README.md +++ b/examples/cloud-operations/dns-shared-vpc/README.md @@ -36,6 +36,6 @@ Note that Terraform 0.13 at least is required due to the use of `for_each` with | name | description | sensitive | |---|---|:---:| -| [teams](outputs.tf#L17) | Team resources | | +| [teams](outputs.tf#L17) | Team resources. | | diff --git a/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/outputs.tf b/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/outputs.tf index fc145c2f4..a07eac091 100644 --- a/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/outputs.tf +++ b/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/outputs.tf @@ -15,11 +15,11 @@ */ output "host_project_id" { - description = "Shared VPC Host project id" + description = "Shared VPC Host project id." value = module.project-host.project_id } output "shared_vpc_self_link" { - description = "Shared VPC Self link" + description = "Shared VPC Self link." value = module.shared-vpc.self_link } diff --git a/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/variables.tf b/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/variables.tf index 77743bae3..7c0f7ed92 100644 --- a/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/variables.tf +++ b/examples/cloud-operations/dns-shared-vpc/examples/shared-vpc-example/variables.tf @@ -15,12 +15,12 @@ */ variable "host_project" { - description = "Host project name" + description = "Host project name." default = "host" } variable "service_projects" { - description = "List of service project names" + description = "List of service project names." type = list(any) default = [ "app-team1", @@ -29,7 +29,7 @@ variable "service_projects" { } variable "region" { - description = "Region in which to create the subnet" + description = "Region in which to create the subnet." default = "europe-west1" } @@ -42,24 +42,24 @@ variable "project_services" { } variable "organization_id" { - description = "The organization ID" + description = "The organization ID." } variable "billing_account" { - description = "The ID of the billing account to associate this project with" + description = "The ID of the billing account to associate this project with." } variable "prefix" { - description = "Customer name to use as prefix for resources' naming" + description = "Customer name to use as prefix for resources' naming." default = "test-dns" } variable "dns_domain" { - description = "DNS domain under which each application team DNS domain will be created" + description = "DNS domain under which each application team DNS domain will be created." default = "prod.internal" } variable "teams" { - description = "List of teams that require their own Cloud DNS instance" + description = "List of teams that require their own Cloud DNS instance." default = ["appteam1", "appteam2"] } diff --git a/examples/cloud-operations/dns-shared-vpc/outputs.tf b/examples/cloud-operations/dns-shared-vpc/outputs.tf index 2c9021e7d..a2deabe1d 100644 --- a/examples/cloud-operations/dns-shared-vpc/outputs.tf +++ b/examples/cloud-operations/dns-shared-vpc/outputs.tf @@ -15,7 +15,7 @@ */ output "teams" { - description = "Team resources" + description = "Team resources." value = { for k, v in local.projects : k => { project = v diff --git a/examples/cloud-operations/iam-delegated-role-grants/main.tf b/examples/cloud-operations/iam-delegated-role-grants/main.tf index b7d187669..ef83c05b8 100644 --- a/examples/cloud-operations/iam-delegated-role-grants/main.tf +++ b/examples/cloud-operations/iam-delegated-role-grants/main.tf @@ -69,7 +69,7 @@ resource "google_project_iam_binding" "iam_bindings" { members = var.project_administrators condition { title = "delegated_role_grant_${each.value.index}" - description = "Delegated role grants (${each.value.index}/${length(local.expressions)})" + description = "Delegated role grants (${each.value.index}/${length(local.expressions)})." expression = each.value.expression } } diff --git a/examples/cloud-operations/packer-image-builder/README.md b/examples/cloud-operations/packer-image-builder/README.md index 4784b47bf..6bcee4d6b 100644 --- a/examples/cloud-operations/packer-image-builder/README.md +++ b/examples/cloud-operations/packer-image-builder/README.md @@ -74,12 +74,12 @@ address for security reasons, Internet connectivity is done with [Cloud NAT](htt |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L55) | Project id that references existing project. | string | ✓ | | | [billing_account](variables.tf#L17) | Billing account id used as default for new projects. | string | | null | -| [cidrs](variables.tf#L23) | CIDR ranges for subnets | map(string) | | {…} | +| [cidrs](variables.tf#L23) | CIDR ranges for subnets. | map(string) | | {…} | | [create_packer_vars](variables.tf#L31) | Create packer variables file using template file and terraform output. | bool | | false | | [packer_account_users](variables.tf#L37) | List of members that will be allowed to impersonate Packer image builder service account in IAM format, i.e. 'user:{emailid}'. | list(string) | | [] | | [packer_source_cidrs](variables.tf#L43) | List of CIDR ranges allowed to connect to the temporary VM for provisioning. | list(string) | | ["0.0.0.0/0"] | | [project_create](variables.tf#L49) | Create project instead of using an existing one. | bool | | true | -| [region](variables.tf#L60) | Default region for resources | string | | "europe-west1" | +| [region](variables.tf#L60) | Default region for resources. | string | | "europe-west1" | | [root_node](variables.tf#L66) | The resource name of the parent folder or organization for project creation, in 'folders/folder_id' or 'organizations/org_id' format. | string | | null | | [use_iap](variables.tf#L72) | Use IAP tunnel to connect to Compute Engine instance for provisioning. | bool | | true | diff --git a/examples/cloud-operations/packer-image-builder/variables.tf b/examples/cloud-operations/packer-image-builder/variables.tf index d3b49a2f8..e06056b3c 100644 --- a/examples/cloud-operations/packer-image-builder/variables.tf +++ b/examples/cloud-operations/packer-image-builder/variables.tf @@ -21,7 +21,7 @@ variable "billing_account" { } variable "cidrs" { - description = "CIDR ranges for subnets" + description = "CIDR ranges for subnets." type = map(string) default = { image-builder = "10.0.0.0/24" @@ -58,7 +58,7 @@ variable "project_id" { } variable "region" { - description = "Default region for resources" + description = "Default region for resources." type = string default = "europe-west1" } diff --git a/examples/cloud-operations/quota-monitoring/README.md b/examples/cloud-operations/quota-monitoring/README.md index 0570867af..7b4e442f9 100644 --- a/examples/cloud-operations/quota-monitoring/README.md +++ b/examples/cloud-operations/quota-monitoring/README.md @@ -34,6 +34,6 @@ Clone this repository or [open it in cloud shell](https://ssh.cloud.google.com/c | [project_create](variables.tf#L29) | Create project instead ofusing an existing one. | bool | | false | | [quota_config](variables.tf#L40) | Cloud function configuration. | object({…}) | | {…} | | [region](variables.tf#L54) | Compute region used in the example. | string | | "europe-west1" | -| [schedule_config](variables.tf#L60) | Schedule timer configuration in crontab format | string | | "0 * * * *" | +| [schedule_config](variables.tf#L60) | Schedule timer configuration in crontab format. | string | | "0 * * * *" | diff --git a/examples/cloud-operations/quota-monitoring/variables.tf b/examples/cloud-operations/quota-monitoring/variables.tf index 12803af01..2b69aa1cb 100644 --- a/examples/cloud-operations/quota-monitoring/variables.tf +++ b/examples/cloud-operations/quota-monitoring/variables.tf @@ -58,7 +58,7 @@ variable "region" { } variable "schedule_config" { - description = "Schedule timer configuration in crontab format" + description = "Schedule timer configuration in crontab format." type = string default = "0 * * * *" } diff --git a/examples/cloud-operations/scheduled-asset-inventory-export-bq/README.md b/examples/cloud-operations/scheduled-asset-inventory-export-bq/README.md index 0354ec64a..a817c31a2 100644 --- a/examples/cloud-operations/scheduled-asset-inventory-export-bq/README.md +++ b/examples/cloud-operations/scheduled-asset-inventory-export-bq/README.md @@ -60,7 +60,7 @@ This is an optional part, created if `cai_gcs_export` is set to `true`. The high | [billing_account](variables.tf#L17) | Billing account id used as default for new projects. | string | | null | | [bundle_path](variables.tf#L23) | Path used to write the intermediate Cloud Function code bundle. | string | | "./bundle.zip" | | [bundle_path_cffile](variables.tf#L30) | Path used to write the intermediate Cloud Function code bundle. | string | | "./bundle_cffile.zip" | -| [cai_gcs_export](variables.tf#L47) | Enable optional part to export tables to GCS | bool | | false | +| [cai_gcs_export](variables.tf#L47) | Enable optional part to export tables to GCS. | bool | | false | | [file_config](variables.tf#L54) | Optional BQ table as a file export function config. | object({…}) | | {…} | | [location](variables.tf#L73) | Appe Engine location used in the example. | string | | "europe-west" | | [name](variables.tf#L80) | Arbitrary string used to name created resources. | string | | "asset-inventory" | diff --git a/examples/cloud-operations/scheduled-asset-inventory-export-bq/main.tf b/examples/cloud-operations/scheduled-asset-inventory-export-bq/main.tf index 963a6a0ee..15d479a3b 100644 --- a/examples/cloud-operations/scheduled-asset-inventory-export-bq/main.tf +++ b/examples/cloud-operations/scheduled-asset-inventory-export-bq/main.tf @@ -148,7 +148,7 @@ resource "google_cloud_scheduler_job" "job" { project = google_app_engine_application.app.project region = var.region name = "cai-export-job" - description = "CAI Export Job" + description = "CAI Export Job." schedule = "* 9 * * 1" time_zone = "Etc/UTC" @@ -171,7 +171,7 @@ resource "google_cloud_scheduler_job" "job_file" { project = google_app_engine_application.app.project region = var.region name = "file-export-job" - description = "File export from BQ Job" + description = "File export from BQ Job." schedule = "* 9 * * 1" time_zone = "Etc/UTC" diff --git a/examples/cloud-operations/scheduled-asset-inventory-export-bq/variables.tf b/examples/cloud-operations/scheduled-asset-inventory-export-bq/variables.tf index 8c6454473..735eebeed 100644 --- a/examples/cloud-operations/scheduled-asset-inventory-export-bq/variables.tf +++ b/examples/cloud-operations/scheduled-asset-inventory-export-bq/variables.tf @@ -45,7 +45,7 @@ variable "cai_config" { variable "cai_gcs_export" { - description = "Enable optional part to export tables to GCS" + description = "Enable optional part to export tables to GCS." type = bool default = false } diff --git a/examples/data-solutions/data-platform-foundations/01-environment/README.md b/examples/data-solutions/data-platform-foundations/01-environment/README.md index 7a619dc14..5d0971183 100644 --- a/examples/data-solutions/data-platform-foundations/01-environment/README.md +++ b/examples/data-solutions/data-platform-foundations/01-environment/README.md @@ -54,7 +54,7 @@ The script use 'google_access_context_manager_service_perimeter_resource' terraf |---|---|:---:|:---:|:---:| | [billing_account_id](variables.tf#L21) | Billing account id. | string | ✓ | | | [root_node](variables.tf#L50) | Parent folder or organization in 'folders/folder_id' or 'organizations/org_id' format. | string | ✓ | | -| [admins](variables.tf#L15) | List of users allowed to impersonate the service account | list(string) | | null | +| [admins](variables.tf#L15) | List of users allowed to impersonate the service account. | list(string) | | null | | [prefix](variables.tf#L26) | Prefix used to generate project id and name. | string | | null | | [project_names](variables.tf#L32) | Override this variable if you need non-standard names. | object({…}) | | {…} | | [service_account_names](variables.tf#L55) | Override this variable if you need non-standard names. | object({…}) | | {…} | diff --git a/examples/data-solutions/data-platform-foundations/01-environment/variables.tf b/examples/data-solutions/data-platform-foundations/01-environment/variables.tf index ca72e1e01..9c29b69ee 100644 --- a/examples/data-solutions/data-platform-foundations/01-environment/variables.tf +++ b/examples/data-solutions/data-platform-foundations/01-environment/variables.tf @@ -13,7 +13,7 @@ # limitations under the License. variable "admins" { - description = "List of users allowed to impersonate the service account" + description = "List of users allowed to impersonate the service account." type = list(string) default = null } diff --git a/examples/data-solutions/data-platform-foundations/02-resources/README.md b/examples/data-solutions/data-platform-foundations/02-resources/README.md index 1af1620f1..0753eec52 100644 --- a/examples/data-solutions/data-platform-foundations/02-resources/README.md +++ b/examples/data-solutions/data-platform-foundations/02-resources/README.md @@ -57,15 +57,15 @@ You can configure GCP resources to use existing CMEK keys configuring the 'servi | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_ids](variables.tf#L108) | Project IDs. | object({…}) | ✓ | | -| [admins](variables.tf#L16) | List of users allowed to impersonate the service account | list(string) | | null | -| [datamart_bq_datasets](variables.tf#L22) | Datamart Bigquery datasets | map(object({…})) | | {…} | -| [dwh_bq_datasets](variables.tf#L40) | DWH Bigquery datasets | map(object({…})) | | {…} | -| [landing_buckets](variables.tf#L54) | List of landing buckets to create | map(object({…})) | | {…} | -| [landing_pubsub](variables.tf#L72) | List of landing pubsub topics and subscriptions to create | map(map(object({…}))) | | {…} | +| [admins](variables.tf#L16) | List of users allowed to impersonate the service account. | list(string) | | null | +| [datamart_bq_datasets](variables.tf#L22) | Datamart Bigquery datasets. | map(object({…})) | | {…} | +| [dwh_bq_datasets](variables.tf#L40) | DWH Bigquery datasets. | map(object({…})) | | {…} | +| [landing_buckets](variables.tf#L54) | List of landing buckets to create. | map(object({…})) | | {…} | +| [landing_pubsub](variables.tf#L72) | List of landing pubsub topics and subscriptions to create. | map(map(object({…}))) | | {…} | | [landing_service_account](variables.tf#L102) | landing service accounts list. | string | | "sa-landing" | | [service_account_names](variables.tf#L119) | Project service accounts list. | object({…}) | | {…} | | [service_encryption_key_ids](variables.tf#L137) | Cloud KMS encryption key in {LOCATION => [KEY_URL]} format. Keys belong to existing project. | object({…}) | | {…} | -| [transformation_buckets](variables.tf#L149) | List of transformation buckets to create | map(object({…})) | | {…} | +| [transformation_buckets](variables.tf#L149) | List of transformation buckets to create. | map(object({…})) | | {…} | | [transformation_subnets](variables.tf#L167) | List of subnets to create in the transformation Project. | list(object({…})) | | […] | | [transformation_vpc_name](variables.tf#L185) | Name of the VPC created in the transformation Project. | string | | "transformation-vpc" | @@ -78,6 +78,6 @@ You can configure GCP resources to use existing CMEK keys configuring the 'servi | [landing-buckets](outputs.tf#L29) | List of buckets created for the landing project. | | | [landing-pubsub](outputs.tf#L34) | List of pubsub topics and subscriptions created for the landing project. | | | [transformation-buckets](outputs.tf#L44) | List of buckets created for the transformation project. | | -| [transformation-vpc](outputs.tf#L49) | Transformation VPC details | | +| [transformation-vpc](outputs.tf#L49) | Transformation VPC details. | | diff --git a/examples/data-solutions/data-platform-foundations/02-resources/outputs.tf b/examples/data-solutions/data-platform-foundations/02-resources/outputs.tf index 3023587d9..eb87eeb06 100644 --- a/examples/data-solutions/data-platform-foundations/02-resources/outputs.tf +++ b/examples/data-solutions/data-platform-foundations/02-resources/outputs.tf @@ -47,7 +47,7 @@ output "transformation-buckets" { } output "transformation-vpc" { - description = "Transformation VPC details" + description = "Transformation VPC details." value = { name = module.vpc-transformation.name subnets = { diff --git a/examples/data-solutions/data-platform-foundations/02-resources/variables.tf b/examples/data-solutions/data-platform-foundations/02-resources/variables.tf index 72a1d8472..256659830 100644 --- a/examples/data-solutions/data-platform-foundations/02-resources/variables.tf +++ b/examples/data-solutions/data-platform-foundations/02-resources/variables.tf @@ -14,13 +14,13 @@ variable "admins" { - description = "List of users allowed to impersonate the service account" + description = "List of users allowed to impersonate the service account." type = list(string) default = null } variable "datamart_bq_datasets" { - description = "Datamart Bigquery datasets" + description = "Datamart Bigquery datasets." type = map(object({ iam = map(list(string)) location = string @@ -38,7 +38,7 @@ variable "datamart_bq_datasets" { } variable "dwh_bq_datasets" { - description = "DWH Bigquery datasets" + description = "DWH Bigquery datasets." type = map(object({ location = string iam = map(list(string)) @@ -52,7 +52,7 @@ variable "dwh_bq_datasets" { } variable "landing_buckets" { - description = "List of landing buckets to create" + description = "List of landing buckets to create." type = map(object({ location = string name = string @@ -70,7 +70,7 @@ variable "landing_buckets" { } variable "landing_pubsub" { - description = "List of landing pubsub topics and subscriptions to create" + description = "List of landing pubsub topics and subscriptions to create." type = map(map(object({ iam = map(list(string)) labels = map(string) @@ -147,7 +147,7 @@ variable "service_encryption_key_ids" { } variable "transformation_buckets" { - description = "List of transformation buckets to create" + description = "List of transformation buckets to create." type = map(object({ location = string name = string diff --git a/examples/data-solutions/gcs-to-bq-with-dataflow/README.md b/examples/data-solutions/gcs-to-bq-with-dataflow/README.md index 9ccd2bf24..7cf12b047 100644 --- a/examples/data-solutions/gcs-to-bq-with-dataflow/README.md +++ b/examples/data-solutions/gcs-to-bq-with-dataflow/README.md @@ -117,7 +117,7 @@ You can check data imported into Google BigQuery from the Google Cloud Console U |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L31) | Project id, references existing project if `project_create` is null. | string | ✓ | | | [prefix](variables.tf#L16) | Unique prefix used for resource names. Not used for project if 'project_create' is null. | string | | null | -| [project_create](variables.tf#L22) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format | object({…}) | | null | +| [project_create](variables.tf#L22) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format. | object({…}) | | null | | [region](variables.tf#L36) | The region where resources will be deployed. | string | | "europe-west1" | | [vpc_subnet_range](variables.tf#L42) | Ip range used for the VPC subnet created for the example. | string | | "10.0.0.0/20" | diff --git a/examples/data-solutions/gcs-to-bq-with-dataflow/variables.tf b/examples/data-solutions/gcs-to-bq-with-dataflow/variables.tf index 55b04b389..36de489e6 100644 --- a/examples/data-solutions/gcs-to-bq-with-dataflow/variables.tf +++ b/examples/data-solutions/gcs-to-bq-with-dataflow/variables.tf @@ -20,7 +20,7 @@ variable "prefix" { } variable "project_create" { - description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format" + description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format." type = object({ billing_account_id = string parent = string diff --git a/examples/data-solutions/gcs-to-bq-with-least-privileges/README.md b/examples/data-solutions/gcs-to-bq-with-least-privileges/README.md index 24ac7d2ee..078ba2647 100644 --- a/examples/data-solutions/gcs-to-bq-with-least-privileges/README.md +++ b/examples/data-solutions/gcs-to-bq-with-least-privileges/README.md @@ -134,7 +134,7 @@ bq query --use_legacy_sql=false 'SELECT * FROM `PROJECT.datalake.person` LIMIT 1 | [project_id](variables.tf#L40) | Project id, references existing project if `project_create` is null. | string | ✓ | | | [cmek_encryption](variables.tf#L15) | Flag to enable CMEK on GCP resources created. | bool | | false | | [data_eng_principals](variables.tf#L21) | Groups with Service Account Token creator role on service accounts in IAM format, eg 'group:group@domain.com'. | list(string) | | [] | -| [project_create](variables.tf#L31) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format | object({…}) | | null | +| [project_create](variables.tf#L31) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format. | object({…}) | | null | | [region](variables.tf#L45) | The region where resources will be deployed. | string | | "europe-west1" | | [vpc_subnet_range](variables.tf#L51) | Ip range used for the VPC subnet created for the example. | string | | "10.0.0.0/20" | diff --git a/examples/data-solutions/gcs-to-bq-with-least-privileges/variables.tf b/examples/data-solutions/gcs-to-bq-with-least-privileges/variables.tf index d4d66b0ff..686339872 100644 --- a/examples/data-solutions/gcs-to-bq-with-least-privileges/variables.tf +++ b/examples/data-solutions/gcs-to-bq-with-least-privileges/variables.tf @@ -29,7 +29,7 @@ variable "prefix" { } variable "project_create" { - description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format" + description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format." type = object({ billing_account_id = string parent = string diff --git a/examples/factories/net-vpc-firewall-yaml/README.md b/examples/factories/net-vpc-firewall-yaml/README.md index c72c006e0..0cf7af5c8 100644 --- a/examples/factories/net-vpc-firewall-yaml/README.md +++ b/examples/factories/net-vpc-firewall-yaml/README.md @@ -140,7 +140,7 @@ web-app-a-ingress: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [config_directories](variables.tf#L17) | List of paths to folders where firewall configs are stored in yaml format. Folder may include subfolders with configuration files. Files suffix must be `.yaml` | list(string) | ✓ | | +| [config_directories](variables.tf#L17) | List of paths to folders where firewall configs are stored in yaml format. Folder may include subfolders with configuration files. Files suffix must be `.yaml`. | list(string) | ✓ | | | [network](variables.tf#L30) | Name of the network this set of firewall rules applies to. | string | ✓ | | | [project_id](variables.tf#L35) | Project Id. | string | ✓ | | | [log_config](variables.tf#L22) | Log configuration. Possible values for `metadata` are `EXCLUDE_ALL_METADATA` and `INCLUDE_ALL_METADATA`. Set to `null` for disabling firewall logging. | object({…}) | | null | diff --git a/examples/factories/net-vpc-firewall-yaml/variables.tf b/examples/factories/net-vpc-firewall-yaml/variables.tf index 04cb7a567..b41eb57ce 100644 --- a/examples/factories/net-vpc-firewall-yaml/variables.tf +++ b/examples/factories/net-vpc-firewall-yaml/variables.tf @@ -15,7 +15,7 @@ */ variable "config_directories" { - description = "List of paths to folders where firewall configs are stored in yaml format. Folder may include subfolders with configuration files. Files suffix must be `.yaml`" + description = "List of paths to folders where firewall configs are stored in yaml format. Folder may include subfolders with configuration files. Files suffix must be `.yaml`." type = list(string) } diff --git a/examples/factories/project-factory/README.md b/examples/factories/project-factory/README.md index fa0da75b2..268c173f1 100644 --- a/examples/factories/project-factory/README.md +++ b/examples/factories/project-factory/README.md @@ -223,7 +223,7 @@ vpc: | [project_id](variables.tf#L111) | Project id. | string | ✓ | | | [billing_alert](variables.tf#L22) | Billing alert configuration. | object({…}) | | null | | [dns_zones](variables.tf#L56) | DNS private zones to create as child of var.defaults.environment_dns_zone. | list(string) | | [] | -| [essential_contacts](variables.tf#L62) | Email contacts to be used for billing and GCP notifications | list(string) | | [] | +| [essential_contacts](variables.tf#L62) | Email contacts to be used for billing and GCP notifications. | list(string) | | [] | | [group_iam](variables.tf#L73) | Custom IAM settings in group => [role] format. | map(list(string)) | | {} | | [iam](variables.tf#L79) | Custom IAM settings in role => [principal] format. | map(list(string)) | | {} | | [kms_service_agents](variables.tf#L85) | KMS IAM configuration in as service => [key]. | map(list(string)) | | {} | diff --git a/examples/factories/project-factory/variables.tf b/examples/factories/project-factory/variables.tf index 7a7afb0e5..adae051a6 100644 --- a/examples/factories/project-factory/variables.tf +++ b/examples/factories/project-factory/variables.tf @@ -60,7 +60,7 @@ variable "dns_zones" { } variable "essential_contacts" { - description = "Email contacts to be used for billing and GCP notifications" + description = "Email contacts to be used for billing and GCP notifications." type = list(string) default = [] } diff --git a/examples/networking/filtering-proxy/README.md b/examples/networking/filtering-proxy/README.md index bc0fc6088..f08293ffb 100644 --- a/examples/networking/filtering-proxy/README.md +++ b/examples/networking/filtering-proxy/README.md @@ -24,10 +24,10 @@ You can optionally deploy the Squid server as [Managed Instance Group](https://c | [prefix](variables.tf#L52) | Prefix used for resources that need unique names. | string | ✓ | | | [root_node](variables.tf#L63) | Root node for the new hierarchy, either 'organizations/org_id' or 'folders/folder_id'. | string | ✓ | | | [allowed_domains](variables.tf#L17) | List of domains allowed by the squid proxy. | list(string) | | […] | -| [cidrs](variables.tf#L31) | CIDR ranges for subnets | map(string) | | {…} | +| [cidrs](variables.tf#L31) | CIDR ranges for subnets. | map(string) | | {…} | | [mig](variables.tf#L40) | Enables the creation of an autoscaling managed instance group of squid instances. | bool | | false | | [nat_logging](variables.tf#L46) | Enables Cloud NAT logging if not null, value is one of 'ERRORS_ONLY', 'TRANSLATIONS_ONLY', 'ALL'. | string | | "ERRORS_ONLY" | -| [region](variables.tf#L57) | Default region for resources | string | | "europe-west1" | +| [region](variables.tf#L57) | Default region for resources. | string | | "europe-west1" | ## Outputs diff --git a/examples/networking/filtering-proxy/variables.tf b/examples/networking/filtering-proxy/variables.tf index 194898999..35245a409 100644 --- a/examples/networking/filtering-proxy/variables.tf +++ b/examples/networking/filtering-proxy/variables.tf @@ -29,7 +29,7 @@ variable "billing_account" { } variable "cidrs" { - description = "CIDR ranges for subnets" + description = "CIDR ranges for subnets." type = map(string) default = { apps = "10.0.0.0/24" @@ -55,7 +55,7 @@ variable "prefix" { } variable "region" { - description = "Default region for resources" + description = "Default region for resources." type = string default = "europe-west1" } diff --git a/fast/stages/00-bootstrap/billing.tf b/fast/stages/00-bootstrap/billing.tf index 6f163ad2f..e6abc31dc 100644 --- a/fast/stages/00-bootstrap/billing.tf +++ b/fast/stages/00-bootstrap/billing.tf @@ -77,7 +77,7 @@ resource "google_organization_iam_binding" "billing_org_ext_admin_delegated" { members = [module.automation-tf-resman-sa.iam_email] condition { title = "automation_sa_delegated_grants" - description = "Automation service account delegated grants" + description = "Automation service account delegated grants." expression = format( "api.getAttribute('iam.googleapis.com/modifiedGrantsByRole', []).hasOnly([%s])", join(",", formatlist("'%s'", [ diff --git a/fast/stages/00-bootstrap/organization.tf b/fast/stages/00-bootstrap/organization.tf index a13480160..52747ce42 100644 --- a/fast/stages/00-bootstrap/organization.tf +++ b/fast/stages/00-bootstrap/organization.tf @@ -182,7 +182,7 @@ resource "google_organization_iam_binding" "org_admin_delegated" { members = [module.automation-tf-resman-sa.iam_email] condition { title = "automation_sa_delegated_grants" - description = "Automation service account delegated grants" + description = "Automation service account delegated grants." expression = format( "api.getAttribute('iam.googleapis.com/modifiedGrantsByRole', []).hasOnly([%s])", join(",", formatlist("'%s'", concat( diff --git a/fast/stages/02-networking/README.md b/fast/stages/02-networking/README.md index 11a727990..5348a54e6 100644 --- a/fast/stages/02-networking/README.md +++ b/fast/stages/02-networking/README.md @@ -313,12 +313,12 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res | [prefix](variables.tf#L113) | Prefix used for resources that need unique names. | string | ✓ | | 00-bootstrap | | [custom_adv](variables.tf#L23) | Custom advertisement definitions in name => range format. | map(string) | | {…} | | | [data_dir](variables.tf#L40) | Relative path for the folder storing configuration data for network resources. | string | | "data" | | -| [dns](variables.tf#L46) | Onprem DNS resolvers | map(list(string)) | | {…} | | +| [dns](variables.tf#L46) | Onprem DNS resolvers. | map(list(string)) | | {…} | | | [folder_id](variables.tf#L54) | Folder to be used for the networking resources in folders/nnnnnnnnnnn format. If null, folder will be created. | string | | null | 01-resman | | [gke](variables.tf#L68) | | map(object({…})) | | {} | 01-resman | | [l7ilb_subnets](variables.tf#L79) | Subnets used for L7 ILBs. | map(list(object({…}))) | | {…} | | | [outputs_location](variables.tf#L107) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | -| [project_factory_sa](variables.tf#L119) | IAM emails for project factory service accounts | map(string) | | {} | 01-resman | +| [project_factory_sa](variables.tf#L119) | IAM emails for project factory service accounts. | map(string) | | {} | 01-resman | | [psa_ranges](variables.tf#L126) | IP ranges used for Private Service Access (e.g. CloudSQL). | map(map(string)) | | {…} | | | [router_configs](variables.tf#L141) | Configurations for CRs and onprem routers. | map(object({…})) | | {…} | | | [vpn_onprem_configs](variables.tf#L165) | VPN gateway configuration for onprem interconnection. | map(object({…})) | | {…} | | diff --git a/fast/stages/02-networking/variables.tf b/fast/stages/02-networking/variables.tf index de9072343..70b21ad64 100644 --- a/fast/stages/02-networking/variables.tf +++ b/fast/stages/02-networking/variables.tf @@ -44,7 +44,7 @@ variable "data_dir" { } variable "dns" { - description = "Onprem DNS resolvers" + description = "Onprem DNS resolvers." type = map(list(string)) default = { onprem = ["10.0.200.3"] @@ -118,7 +118,7 @@ variable "prefix" { variable "project_factory_sa" { # tfdoc:variable:source 01-resman - description = "IAM emails for project factory service accounts" + description = "IAM emails for project factory service accounts." type = map(string) default = {} } diff --git a/fast/stages/02-security/core-dev.tf b/fast/stages/02-security/core-dev.tf index a3a14f10f..db12bdee7 100644 --- a/fast/stages/02-security/core-dev.tf +++ b/fast/stages/02-security/core-dev.tf @@ -52,7 +52,7 @@ resource "google_project_iam_member" "dev_key_admin_delegated" { member = each.key condition { title = "kms_sa_delegated_grants" - description = "Automation service account delegated grants" + description = "Automation service account delegated grants." expression = format( "api.getAttribute('iam.googleapis.com/modifiedGrantsByRole', []).hasOnly([%s])", join(",", formatlist("'%s'", [ diff --git a/fast/stages/02-security/core-prod.tf b/fast/stages/02-security/core-prod.tf index f259a488a..4154d0502 100644 --- a/fast/stages/02-security/core-prod.tf +++ b/fast/stages/02-security/core-prod.tf @@ -51,7 +51,7 @@ resource "google_project_iam_member" "prod_key_admin_delegated" { member = each.key condition { title = "kms_sa_delegated_grants" - description = "Automation service account delegated grants" + description = "Automation service account delegated grants." expression = format( "api.getAttribute('iam.googleapis.com/modifiedGrantsByRole', []).hasOnly([%s])", join(",", formatlist("'%s'", [ diff --git a/modules/__experimental/net-neg/README.md b/modules/__experimental/net-neg/README.md index e04896f50..ad90c14e9 100644 --- a/modules/__experimental/net-neg/README.md +++ b/modules/__experimental/net-neg/README.md @@ -29,19 +29,19 @@ module "neg" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [endpoints](variables.tf#L42) | List of (instance, port, address) of the NEG | list(object({…})) | ✓ | | -| [name](variables.tf#L22) | NEG name | string | ✓ | | +| [endpoints](variables.tf#L42) | List of (instance, port, address) of the NEG. | list(object({…})) | ✓ | | +| [name](variables.tf#L22) | NEG name. | string | ✓ | | | [network](variables.tf#L27) | Name or self link of the VPC used for the NEG. Use the self link for Shared VPC. | string | ✓ | | | [project_id](variables.tf#L17) | NEG project id. | string | ✓ | | | [subnetwork](variables.tf#L32) | VPC subnetwork name or self link. | string | ✓ | | -| [zone](variables.tf#L37) | NEG zone | string | ✓ | | +| [zone](variables.tf#L37) | NEG zone. | string | ✓ | | ## Outputs | name | description | sensitive | |---|---|:---:| -| [id](outputs.tf#L17) | Network endpoint group ID | | -| [self_lnk](outputs.tf#L27) | Network endpoint group self link | | -| [size](outputs.tf#L22) | Size of the network endpoint group | | +| [id](outputs.tf#L17) | Network endpoint group ID. | | +| [self_lnk](outputs.tf#L27) | Network endpoint group self link. | | +| [size](outputs.tf#L22) | Size of the network endpoint group. | | diff --git a/modules/__experimental/net-neg/outputs.tf b/modules/__experimental/net-neg/outputs.tf index 351a020c5..a8ccdbf00 100644 --- a/modules/__experimental/net-neg/outputs.tf +++ b/modules/__experimental/net-neg/outputs.tf @@ -15,16 +15,16 @@ */ output "id" { - description = "Network endpoint group ID" + description = "Network endpoint group ID." value = google_compute_network_endpoint_group.group.name } output "size" { - description = "Size of the network endpoint group" + description = "Size of the network endpoint group." value = google_compute_network_endpoint_group.group.size } output "self_lnk" { - description = "Network endpoint group self link" + description = "Network endpoint group self link." value = google_compute_network_endpoint_group.group.self_link } diff --git a/modules/__experimental/net-neg/variables.tf b/modules/__experimental/net-neg/variables.tf index a3f872c61..0771def15 100644 --- a/modules/__experimental/net-neg/variables.tf +++ b/modules/__experimental/net-neg/variables.tf @@ -20,7 +20,7 @@ variable "project_id" { } variable "name" { - description = "NEG name" + description = "NEG name." type = string } @@ -35,12 +35,12 @@ variable "subnetwork" { } variable "zone" { - description = "NEG zone" + description = "NEG zone." type = string } variable "endpoints" { - description = "List of (instance, port, address) of the NEG" + description = "List of (instance, port, address) of the NEG." type = list(object({ instance = string port = number diff --git a/modules/apigee-x-instance/README.md b/modules/apigee-x-instance/README.md index fad3f6b38..90f5d11e5 100644 --- a/modules/apigee-x-instance/README.md +++ b/modules/apigee-x-instance/README.md @@ -48,8 +48,8 @@ module "apigee-x-instance" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [apigee_org_id](variables.tf#L32) | Apigee Organization ID | string | ✓ | | -| [cidr_mask](variables.tf#L37) | CIDR mask for the Apigee instance | number | ✓ | | +| [apigee_org_id](variables.tf#L32) | Apigee Organization ID. | string | ✓ | | +| [cidr_mask](variables.tf#L37) | CIDR mask for the Apigee instance. | number | ✓ | | | [name](variables.tf#L52) | Apigee instance name. | string | ✓ | | | [region](variables.tf#L57) | Compute region. | string | ✓ | | | [apigee_envgroups](variables.tf#L17) | Apigee Environment Groups. | map(object({…})) | | {} | diff --git a/modules/apigee-x-instance/variables.tf b/modules/apigee-x-instance/variables.tf index a1cfc9542..b50daf0a1 100644 --- a/modules/apigee-x-instance/variables.tf +++ b/modules/apigee-x-instance/variables.tf @@ -30,12 +30,12 @@ variable "apigee_environments" { } variable "apigee_org_id" { - description = "Apigee Organization ID" + description = "Apigee Organization ID." type = string } variable "cidr_mask" { - description = "CIDR mask for the Apigee instance" + description = "CIDR mask for the Apigee instance." type = number validation { condition = contains([16, 20, 22], var.cidr_mask) diff --git a/modules/artifact-registry/README.md b/modules/artifact-registry/README.md index 1e080e477..ac463ec19 100644 --- a/modules/artifact-registry/README.md +++ b/modules/artifact-registry/README.md @@ -25,19 +25,19 @@ module "docker_artifact_registry" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [id](variables.tf#L35) | Repository id | string | ✓ | | +| [id](variables.tf#L35) | Repository id. | string | ✓ | | | [project_id](variables.tf#L52) | Registry project id. | string | ✓ | | -| [description](variables.tf#L17) | An optional description for the repository | string | | "Terraform-managed registry" | -| [format](variables.tf#L23) | Repository format. One of DOCKER or UNSPECIFIED | string | | "DOCKER" | +| [description](variables.tf#L17) | An optional description for the repository. | string | | "Terraform-managed registry" | +| [format](variables.tf#L23) | Repository format. One of DOCKER or UNSPECIFIED. | string | | "DOCKER" | | [iam](variables.tf#L29) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [labels](variables.tf#L40) | Labels to be attached to the registry. | map(string) | | {} | -| [location](variables.tf#L46) | Registry location. Use `gcloud beta artifacts locations list' to get valid values | string | | null | +| [location](variables.tf#L46) | Registry location. Use `gcloud beta artifacts locations list' to get valid values. | string | | null | ## Outputs | name | description | sensitive | |---|---|:---:| -| [id](outputs.tf#L17) | Repository id | | -| [name](outputs.tf#L22) | Repository name | | +| [id](outputs.tf#L17) | Repository id. | | +| [name](outputs.tf#L22) | Repository name. | | diff --git a/modules/artifact-registry/outputs.tf b/modules/artifact-registry/outputs.tf index cb035b760..2933d5d83 100644 --- a/modules/artifact-registry/outputs.tf +++ b/modules/artifact-registry/outputs.tf @@ -15,11 +15,11 @@ */ output "id" { - description = "Repository id" + description = "Repository id." value = google_artifact_registry_repository.registry.id } output "name" { - description = "Repository name" + description = "Repository name." value = google_artifact_registry_repository.registry.name } diff --git a/modules/artifact-registry/variables.tf b/modules/artifact-registry/variables.tf index 1cb16b747..907ee976b 100644 --- a/modules/artifact-registry/variables.tf +++ b/modules/artifact-registry/variables.tf @@ -15,13 +15,13 @@ */ variable "description" { - description = "An optional description for the repository" + description = "An optional description for the repository." type = string default = "Terraform-managed registry" } variable "format" { - description = "Repository format. One of DOCKER or UNSPECIFIED" + description = "Repository format. One of DOCKER or UNSPECIFIED." type = string default = "DOCKER" } @@ -33,7 +33,7 @@ variable "iam" { } variable "id" { - description = "Repository id" + description = "Repository id." type = string } @@ -44,7 +44,7 @@ variable "labels" { } variable "location" { - description = "Registry location. Use `gcloud beta artifacts locations list' to get valid values" + description = "Registry location. Use `gcloud beta artifacts locations list' to get valid values." type = string default = null } diff --git a/modules/billing-budget/README.md b/modules/billing-budget/README.md index 2be1b8151..0b39e1900 100644 --- a/modules/billing-budget/README.md +++ b/modules/billing-budget/README.md @@ -71,7 +71,7 @@ module "pubsub" { | [name](variables.tf#L50) | Budget name. | string | ✓ | | | [thresholds](variables.tf#L85) | Thresholds percentages at which alerts are sent. Must be a value between 0 and 1. | object({…}) | ✓ | | | [amount](variables.tf#L17) | Amount in the billing account's currency for the budget. Use 0 to set budget to 100% of last period's spend. | number | | 0 | -| [credit_treatment](variables.tf#L28) | How credits should be treated when determining spend for threshold calculations. Only INCLUDE_ALL_CREDITS or EXCLUDE_ALL_CREDITS are supported | string | | "INCLUDE_ALL_CREDITS" | +| [credit_treatment](variables.tf#L28) | How credits should be treated when determining spend for threshold calculations. Only INCLUDE_ALL_CREDITS or EXCLUDE_ALL_CREDITS are supported. | string | | "INCLUDE_ALL_CREDITS" | | [email_recipients](variables.tf#L41) | Emails where budget notifications will be sent. Setting this will create a notification channel for each email in the specified project. | object({…}) | | null | | [notification_channels](variables.tf#L55) | Monitoring notification channels where to send updates. | list(string) | | null | | [notify_default_recipients](variables.tf#L61) | Notify Billing Account Administrators and Billing Account Users IAM roles for the target account. | bool | | false | diff --git a/modules/billing-budget/variables.tf b/modules/billing-budget/variables.tf index bc836fce3..003f928e5 100644 --- a/modules/billing-budget/variables.tf +++ b/modules/billing-budget/variables.tf @@ -26,7 +26,7 @@ variable "billing_account" { } variable "credit_treatment" { - description = "How credits should be treated when determining spend for threshold calculations. Only INCLUDE_ALL_CREDITS or EXCLUDE_ALL_CREDITS are supported" + description = "How credits should be treated when determining spend for threshold calculations. Only INCLUDE_ALL_CREDITS or EXCLUDE_ALL_CREDITS are supported." type = string default = "INCLUDE_ALL_CREDITS" validation { diff --git a/modules/cloud-config-container/cos-generic-metadata/README.md b/modules/cloud-config-container/cos-generic-metadata/README.md index 1890abc33..5a01b43ec 100644 --- a/modules/cloud-config-container/cos-generic-metadata/README.md +++ b/modules/cloud-config-container/cos-generic-metadata/README.md @@ -65,17 +65,17 @@ module "cos-envoy" { |---|---|:---:|:---:|:---:| | [container_image](variables.tf#L42) | Container image. | string | ✓ | | | [authenticate_gcr](variables.tf#L112) | Setup docker to pull images from private GCR. Requires at least one user since the token is stored in the home of the first user defined. | bool | | false | -| [boot_commands](variables.tf#L17) | List of cloud-init `bootcmd`s | list(string) | | [] | +| [boot_commands](variables.tf#L17) | List of cloud-init `bootcmd`s. | list(string) | | [] | | [cloud_config](variables.tf#L23) | Cloud config template path. If provided, takes precedence over all other arguments. | string | | null | -| [config_variables](variables.tf#L29) | Additional variables used to render the template passed via `cloud_config` | map(any) | | {} | -| [container_args](variables.tf#L35) | Arguments for container | string | | "" | -| [container_name](variables.tf#L47) | Name of the container to be run | string | | "container" | -| [container_volumes](variables.tf#L53) | List of volumes | list(object({…})) | | [] | -| [docker_args](variables.tf#L62) | Extra arguments to be passed for docker | string | | null | +| [config_variables](variables.tf#L29) | Additional variables used to render the template passed via `cloud_config`. | map(any) | | {} | +| [container_args](variables.tf#L35) | Arguments for container. | string | | "" | +| [container_name](variables.tf#L47) | Name of the container to be run. | string | | "container" | +| [container_volumes](variables.tf#L53) | List of volumes. | list(object({…})) | | [] | +| [docker_args](variables.tf#L62) | Extra arguments to be passed for docker. | string | | null | | [file_defaults](variables.tf#L68) | Default owner and permissions for files. | object({…}) | | {…} | | [files](variables.tf#L80) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | -| [gcp_logging](variables.tf#L90) | Should container logs be sent to Google Cloud Logging | bool | | true | -| [run_commands](variables.tf#L96) | List of cloud-init `runcmd`s | list(string) | | [] | +| [gcp_logging](variables.tf#L90) | Should container logs be sent to Google Cloud Logging. | bool | | true | +| [run_commands](variables.tf#L96) | List of cloud-init `runcmd`s. | list(string) | | [] | | [users](variables.tf#L102) | List of usernames to be created. If provided, first user will be used to run the container. | list(object({…})) | | […] | ## Outputs diff --git a/modules/cloud-config-container/cos-generic-metadata/variables.tf b/modules/cloud-config-container/cos-generic-metadata/variables.tf index 41a11557e..e9aa051a0 100644 --- a/modules/cloud-config-container/cos-generic-metadata/variables.tf +++ b/modules/cloud-config-container/cos-generic-metadata/variables.tf @@ -15,7 +15,7 @@ */ variable "boot_commands" { - description = "List of cloud-init `bootcmd`s" + description = "List of cloud-init `bootcmd`s." type = list(string) default = [] } @@ -27,13 +27,13 @@ variable "cloud_config" { } variable "config_variables" { - description = "Additional variables used to render the template passed via `cloud_config`" + description = "Additional variables used to render the template passed via `cloud_config`." type = map(any) default = {} } variable "container_args" { - description = "Arguments for container" + description = "Arguments for container." type = string default = "" } @@ -45,13 +45,13 @@ variable "container_image" { } variable "container_name" { - description = "Name of the container to be run" + description = "Name of the container to be run." type = string default = "container" } variable "container_volumes" { - description = "List of volumes" + description = "List of volumes." type = list(object({ host = string, container = string @@ -60,7 +60,7 @@ variable "container_volumes" { } variable "docker_args" { - description = "Extra arguments to be passed for docker" + description = "Extra arguments to be passed for docker." type = string default = null } @@ -88,13 +88,13 @@ variable "files" { } variable "gcp_logging" { - description = "Should container logs be sent to Google Cloud Logging" + description = "Should container logs be sent to Google Cloud Logging." type = bool default = true } variable "run_commands" { - description = "List of cloud-init `runcmd`s" + description = "List of cloud-init `runcmd`s." type = list(string) default = [] } diff --git a/modules/cloud-config-container/envoy-traffic-director/README.md b/modules/cloud-config-container/envoy-traffic-director/README.md index b97b1cef9..4493e9ba7 100644 --- a/modules/cloud-config-container/envoy-traffic-director/README.md +++ b/modules/cloud-config-container/envoy-traffic-director/README.md @@ -51,7 +51,7 @@ module "vm-cos" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [envoy_image](variables.tf#L17) | Envoy Proxy container image to use. | string | | "envoyproxy/envoy:v1.14.1" | -| [gcp_logging](variables.tf#L23) | Should container logs be sent to Google Cloud Logging | bool | | true | +| [gcp_logging](variables.tf#L23) | Should container logs be sent to Google Cloud Logging. | bool | | true | ## Outputs diff --git a/modules/cloud-config-container/envoy-traffic-director/variables.tf b/modules/cloud-config-container/envoy-traffic-director/variables.tf index 6eb7dcc75..b43b3c5ec 100644 --- a/modules/cloud-config-container/envoy-traffic-director/variables.tf +++ b/modules/cloud-config-container/envoy-traffic-director/variables.tf @@ -21,7 +21,7 @@ variable "envoy_image" { } variable "gcp_logging" { - description = "Should container logs be sent to Google Cloud Logging" + description = "Should container logs be sent to Google Cloud Logging." type = bool default = true } diff --git a/modules/cloud-config-container/outputs-instance.tf b/modules/cloud-config-container/outputs-instance.tf index 182c02127..8c657eb05 100644 --- a/modules/cloud-config-container/outputs-instance.tf +++ b/modules/cloud-config-container/outputs-instance.tf @@ -15,7 +15,7 @@ */ output "test_instance" { - description = "Optional test instance name and address" + description = "Optional test instance name and address." value = (var.test_instance == null ? {} : { address = google_compute_instance.default[0].network_interface.0.network_ip name = google_compute_instance.default[0].name diff --git a/modules/cloud-config-container/squid/README.md b/modules/cloud-config-container/squid/README.md index 54e498c6e..e1aa87168 100644 --- a/modules/cloud-config-container/squid/README.md +++ b/modules/cloud-config-container/squid/README.md @@ -65,7 +65,7 @@ module "cos-squid" { | [clients](variables.tf#L69) | List of CIDR ranges from which Squid will allow connections. | list(string) | | [] | | [cloud_config](variables.tf#L17) | Cloud config template path. If null default will be used. | string | | null | | [config_variables](variables.tf#L23) | Additional variables used to render the cloud-config and Squid templates. | map(any) | | {} | -| [default_action](variables.tf#L75) | Default action for domains not matching neither the allow or deny lists | string | | "deny" | +| [default_action](variables.tf#L75) | Default action for domains not matching neither the allow or deny lists. | string | | "deny" | | [deny](variables.tf#L63) | List of domains Squid will deny connections to. | list(string) | | [] | | [file_defaults](variables.tf#L35) | Default owner and permissions for files. | object({…}) | | {…} | | [files](variables.tf#L47) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | diff --git a/modules/cloud-config-container/squid/variables.tf b/modules/cloud-config-container/squid/variables.tf index eaaca7309..5180c6d32 100644 --- a/modules/cloud-config-container/squid/variables.tf +++ b/modules/cloud-config-container/squid/variables.tf @@ -73,7 +73,7 @@ variable "clients" { } variable "default_action" { - description = "Default action for domains not matching neither the allow or deny lists" + description = "Default action for domains not matching neither the allow or deny lists." type = string default = "deny" validation { diff --git a/modules/cloud-function/README.md b/modules/cloud-function/README.md index f4c18eeae..46a5b4586 100644 --- a/modules/cloud-function/README.md +++ b/modules/cloud-function/README.md @@ -170,14 +170,14 @@ module "cf-http" { | [function_config](variables.tf#L52) | Cloud function configuration. | object({…}) | | {…} | | [iam](variables.tf#L70) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [ingress_settings](variables.tf#L76) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL and ALLOW_INTERNAL_ONLY. | string | | null | -| [labels](variables.tf#L82) | Resource labels | map(string) | | {} | +| [labels](variables.tf#L82) | Resource labels. | map(string) | | {} | | [prefix](variables.tf#L93) | Optional prefix used for resource names. | string | | null | | [region](variables.tf#L104) | Region used for all resources. | string | | "europe-west1" | | [service_account](variables.tf#L110) | Service account email. Unused if service account is auto-created. | string | | null | | [service_account_create](variables.tf#L116) | Auto-create service account. | bool | | false | | [trigger_config](variables.tf#L122) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | -| [vpc_connector](variables.tf#L132) | VPC connector configuration. Set create to 'true' if a new connector needs to be created | object({…}) | | null | -| [vpc_connector_config](variables.tf#L142) | VPC connector network configuration. Must be provided if new VPC connector is being created | object({…}) | | null | +| [vpc_connector](variables.tf#L132) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | null | +| [vpc_connector_config](variables.tf#L142) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | ## Outputs diff --git a/modules/cloud-function/variables.tf b/modules/cloud-function/variables.tf index 9ea767896..2ac663b13 100644 --- a/modules/cloud-function/variables.tf +++ b/modules/cloud-function/variables.tf @@ -80,7 +80,7 @@ variable "ingress_settings" { } variable "labels" { - description = "Resource labels" + description = "Resource labels." type = map(string) default = {} } @@ -130,7 +130,7 @@ variable "trigger_config" { } variable "vpc_connector" { - description = "VPC connector configuration. Set create to 'true' if a new connector needs to be created" + description = "VPC connector configuration. Set create to 'true' if a new connector needs to be created." type = object({ create = bool name = string @@ -140,7 +140,7 @@ variable "vpc_connector" { } variable "vpc_connector_config" { - description = "VPC connector network configuration. Must be provided if new VPC connector is being created" + description = "VPC connector network configuration. Must be provided if new VPC connector is being created." type = object({ ip_cidr_range = string network = string diff --git a/modules/cloud-identity-group/README.md b/modules/cloud-identity-group/README.md index cca456369..01c1289d8 100644 --- a/modules/cloud-identity-group/README.md +++ b/modules/cloud-identity-group/README.md @@ -40,7 +40,7 @@ module "group" { | [customer_id](variables.tf#L17) | Directory customer ID in the form customers/C0xxxxxxx. | string | ✓ | | | [display_name](variables.tf#L32) | Group display name. | string | ✓ | | | [name](variables.tf#L43) | Group ID (usually an email). | string | ✓ | | -| [description](variables.tf#L26) | Group description | string | | null | +| [description](variables.tf#L26) | Group description. | string | | null | | [members](variables.tf#L37) | List of group members. | list(string) | | [] | ## Outputs diff --git a/modules/cloud-identity-group/variables.tf b/modules/cloud-identity-group/variables.tf index 9dc579d8a..b95905372 100644 --- a/modules/cloud-identity-group/variables.tf +++ b/modules/cloud-identity-group/variables.tf @@ -24,7 +24,7 @@ variable "customer_id" { } variable "description" { - description = "Group description" + description = "Group description." type = string default = null } diff --git a/modules/cloud-run/README.md b/modules/cloud-run/README.md index 5ec4acf04..3ac4075da 100644 --- a/modules/cloud-run/README.md +++ b/modules/cloud-run/README.md @@ -212,33 +212,33 @@ module "cloud_run" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [containers](variables.tf#L27) | Containers | list(object({…})) | ✓ | | -| [name](variables.tf#L77) | Name used for cloud run service | string | ✓ | | +| [containers](variables.tf#L27) | Containers. | list(object({…})) | ✓ | | +| [name](variables.tf#L77) | Name used for cloud run service. | string | ✓ | | | [project_id](variables.tf#L88) | Project id used for all resources. | string | ✓ | | -| [audit_log_triggers](variables.tf#L18) | Event arc triggers (Audit log) | list(object({…})) | | null | +| [audit_log_triggers](variables.tf#L18) | Event arc triggers (Audit log). | list(object({…})) | | null | | [iam](variables.tf#L59) | IAM bindings for Cloud Run service in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [ingress_settings](variables.tf#L65) | Ingress settings | string | | null | -| [labels](variables.tf#L71) | Resource labels | map(string) | | {} | +| [ingress_settings](variables.tf#L65) | Ingress settings. | string | | null | +| [labels](variables.tf#L71) | Resource labels. | map(string) | | {} | | [prefix](variables.tf#L82) | Optional prefix used for resource names. | string | | null | -| [pubsub_triggers](variables.tf#L93) | Eventarc triggers (Pub/Sub) | list(string) | | null | +| [pubsub_triggers](variables.tf#L93) | Eventarc triggers (Pub/Sub). | list(string) | | null | | [region](variables.tf#L99) | Region used for all resources. | string | | "europe-west1" | -| [revision_name](variables.tf#L105) | Revision name | string | | null | +| [revision_name](variables.tf#L105) | Revision name. | string | | null | | [service_account](variables.tf#L111) | Service account email. Unused if service account is auto-created. | string | | null | | [service_account_create](variables.tf#L117) | Auto-create service account. | bool | | false | -| [traffic](variables.tf#L123) | Traffic | map(number) | | null | -| [volumes](variables.tf#L129) | Volumes | list(object({…})) | | null | -| [vpc_connector](variables.tf#L142) | VPC connector configuration. Set create to 'true' if a new connecto needs to be created | object({…}) | | null | -| [vpc_connector_config](variables.tf#L152) | VPC connector network configuration. Must be provided if new VPC connector is being created | object({…}) | | null | +| [traffic](variables.tf#L123) | Traffic. | map(number) | | null | +| [volumes](variables.tf#L129) | Volumes. | list(object({…})) | | null | +| [vpc_connector](variables.tf#L142) | VPC connector configuration. Set create to 'true' if a new connecto needs to be created. | object({…}) | | null | +| [vpc_connector_config](variables.tf#L152) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | ## Outputs | name | description | sensitive | |---|---|:---:| -| [service](outputs.tf#L18) | Cloud Run service | | +| [service](outputs.tf#L18) | Cloud Run service. | | | [service_account](outputs.tf#L23) | Service account resource. | | | [service_account_email](outputs.tf#L28) | Service account email. | | | [service_account_iam_email](outputs.tf#L33) | Service account email. | | -| [service_name](outputs.tf#L41) | Cloud Run service name | | +| [service_name](outputs.tf#L41) | Cloud Run service name. | | | [vpc_connector](outputs.tf#L47) | VPC connector resource if created. | | diff --git a/modules/cloud-run/outputs.tf b/modules/cloud-run/outputs.tf index 105e77eca..9a235f959 100644 --- a/modules/cloud-run/outputs.tf +++ b/modules/cloud-run/outputs.tf @@ -16,7 +16,7 @@ */ output "service" { - description = "Cloud Run service" + description = "Cloud Run service." value = google_cloud_run_service.service } @@ -39,7 +39,7 @@ output "service_account_iam_email" { } output "service_name" { - description = "Cloud Run service name" + description = "Cloud Run service name." value = google_cloud_run_service.service.name } diff --git a/modules/cloud-run/variables.tf b/modules/cloud-run/variables.tf index da0590d13..81777d9af 100644 --- a/modules/cloud-run/variables.tf +++ b/modules/cloud-run/variables.tf @@ -16,7 +16,7 @@ */ variable "audit_log_triggers" { - description = "Event arc triggers (Audit log)" + description = "Event arc triggers (Audit log)." type = list(object({ service_name = string method_name = string @@ -25,7 +25,7 @@ variable "audit_log_triggers" { } variable "containers" { - description = "Containers" + description = "Containers." type = list(object({ image = string options = object({ @@ -63,19 +63,19 @@ variable "iam" { } variable "ingress_settings" { - description = "Ingress settings" + description = "Ingress settings." type = string default = null } variable "labels" { - description = "Resource labels" + description = "Resource labels." type = map(string) default = {} } variable "name" { - description = "Name used for cloud run service" + description = "Name used for cloud run service." type = string } @@ -91,7 +91,7 @@ variable "project_id" { } variable "pubsub_triggers" { - description = "Eventarc triggers (Pub/Sub)" + description = "Eventarc triggers (Pub/Sub)." type = list(string) default = null } @@ -103,7 +103,7 @@ variable "region" { } variable "revision_name" { - description = "Revision name" + description = "Revision name." type = string default = null } @@ -121,13 +121,13 @@ variable "service_account_create" { } variable "traffic" { - description = "Traffic" + description = "Traffic." type = map(number) default = null } variable "volumes" { - description = "Volumes" + description = "Volumes." type = list(object({ name = string secret_name = string @@ -140,7 +140,7 @@ variable "volumes" { } variable "vpc_connector" { - description = "VPC connector configuration. Set create to 'true' if a new connecto needs to be created" + description = "VPC connector configuration. Set create to 'true' if a new connecto needs to be created." type = object({ create = bool name = string @@ -150,7 +150,7 @@ variable "vpc_connector" { } variable "vpc_connector_config" { - description = "VPC connector network configuration. Must be provided if new VPC connector is being created" + description = "VPC connector network configuration. Must be provided if new VPC connector is being created." type = object({ ip_cidr_range = string network = string diff --git a/modules/cloudsql-instance/README.md b/modules/cloudsql-instance/README.md index 0d32719c4..9880c2a46 100644 --- a/modules/cloudsql-instance/README.md +++ b/modules/cloudsql-instance/README.md @@ -103,8 +103,8 @@ module "db" { | [region](variables.tf#L112) | Region of the primary replica. | string | ✓ | | | [tier](variables.tf#L123) | The machine type to use for the instances. | string | ✓ | | | [authorized_networks](variables.tf#L17) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | map(string) | | null | -| [availability_type](variables.tf#L23) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL` | string | | "ZONAL" | -| [backup_configuration](variables.tf#L29) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas | object({…}) | | {…} | +| [availability_type](variables.tf#L23) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | string | | "ZONAL" | +| [backup_configuration](variables.tf#L29) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | object({…}) | | {…} | | [databases](variables.tf#L55) | Databases to create once the primary instance is created. | list(string) | | null | | [deletion_protection](variables.tf#L61) | Allow terraform to delete instances. | bool | | false | | [disk_size](variables.tf#L67) | Disk size in GB. Set to null to enable autoresize. | number | | null | @@ -113,21 +113,21 @@ module "db" { | [labels](variables.tf#L85) | Labels to be attached to all instances. | map(string) | | null | | [prefix](variables.tf#L101) | Prefix used to generate instance names. | string | | null | | [replicas](variables.tf#L117) | Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation. | map(any) | | null | -| [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 | map(string) | | null | +| [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. | map(string) | | null | ## 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. | ✓ | diff --git a/modules/cloudsql-instance/outputs.tf b/modules/cloudsql-instance/outputs.tf index caa28e83a..e2ca316d6 100644 --- a/modules/cloudsql-instance/outputs.tf +++ b/modules/cloudsql-instance/outputs.tf @@ -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 diff --git a/modules/cloudsql-instance/variables.tf b/modules/cloudsql-instance/variables.tf index 0093d4a33..148acee6f 100644 --- a/modules/cloudsql-instance/variables.tf +++ b/modules/cloudsql-instance/variables.tf @@ -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 } diff --git a/modules/compute-vm/README.md b/modules/compute-vm/README.md index a6f89fe16..fb1166410 100644 --- a/modules/compute-vm/README.md +++ b/modules/compute-vm/README.md @@ -310,7 +310,7 @@ module "instance-group" { | [confidential_compute](variables.tf#L84) | Enable Confidential Compute for these instances. | bool | | false | | [create_template](variables.tf#L90) | Create instance template instead of instances. | bool | | false | | [description](variables.tf#L95) | Description of a Compute Instance. | string | | "Managed by the compute-vm Terraform module." | -| [enable_display](variables.tf#L100) | Enable virtual display on the instances | bool | | false | +| [enable_display](variables.tf#L100) | Enable virtual display on the instances. | bool | | false | | [encryption](variables.tf#L106) | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | object({…}) | | null | | [group](variables.tf#L116) | Define this variable to create an instance group for instances. Disabled for template use. | object({…}) | | null | | [hostname](variables.tf#L124) | Instance FQDN name. | string | | null | diff --git a/modules/compute-vm/variables.tf b/modules/compute-vm/variables.tf index cfdd40dc5..f82d75b12 100644 --- a/modules/compute-vm/variables.tf +++ b/modules/compute-vm/variables.tf @@ -98,7 +98,7 @@ variable "description" { default = "Managed by the compute-vm Terraform module." } variable "enable_display" { - description = "Enable virtual display on the instances" + description = "Enable virtual display on the instances." type = bool default = false } diff --git a/modules/container-registry/README.md b/modules/container-registry/README.md index 0814f7164..c4baff763 100644 --- a/modules/container-registry/README.md +++ b/modules/container-registry/README.md @@ -23,12 +23,12 @@ module "container_registry" { |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L29) | Registry project id. | string | ✓ | | | [iam](variables.tf#L17) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [location](variables.tf#L23) | Registry location. Can be US, EU, ASIA or empty | string | | "" | +| [location](variables.tf#L23) | Registry location. Can be US, EU, ASIA or empty. | string | | "" | ## Outputs | name | description | sensitive | |---|---|:---:| -| [bucket_id](outputs.tf#L17) | ID of the GCS bucket created | | +| [bucket_id](outputs.tf#L17) | ID of the GCS bucket created. | | diff --git a/modules/container-registry/outputs.tf b/modules/container-registry/outputs.tf index 53f0fc6b1..f43f8ca8f 100644 --- a/modules/container-registry/outputs.tf +++ b/modules/container-registry/outputs.tf @@ -15,6 +15,6 @@ */ output "bucket_id" { - description = "ID of the GCS bucket created" + description = "ID of the GCS bucket created." value = google_container_registry.registry.id } diff --git a/modules/container-registry/variables.tf b/modules/container-registry/variables.tf index ae35034cb..9a5709e96 100644 --- a/modules/container-registry/variables.tf +++ b/modules/container-registry/variables.tf @@ -21,7 +21,7 @@ variable "iam" { } variable "location" { - description = "Registry location. Can be US, EU, ASIA or empty" + description = "Registry location. Can be US, EU, ASIA or empty." type = string default = "" } diff --git a/modules/datafusion/README.md b/modules/datafusion/README.md index 8de6e7441..20414c6b7 100644 --- a/modules/datafusion/README.md +++ b/modules/datafusion/README.md @@ -40,7 +40,7 @@ module "datafusion" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L63) | Name of the DataFusion instance. | string | ✓ | | -| [network](variables.tf#L68) | Name of the network in the project with which the tenant project will be peered for executing pipelines in the form of projects/{project-id}/global/networks/{network} | string | ✓ | | +| [network](variables.tf#L68) | Name of the network in the project with which the tenant project will be peered for executing pipelines in the form of projects/{project-id}/global/networks/{network}. | string | ✓ | | | [project_id](variables.tf#L85) | Project ID. | string | ✓ | | | [region](variables.tf#L90) | DataFusion region. | string | ✓ | | | [description](variables.tf#L21) | DataFuzion instance description. | string | | "Terraform managed." | diff --git a/modules/datafusion/variables.tf b/modules/datafusion/variables.tf index 57acf2244..19d61f49c 100644 --- a/modules/datafusion/variables.tf +++ b/modules/datafusion/variables.tf @@ -66,7 +66,7 @@ variable "name" { } variable "network" { - description = "Name of the network in the project with which the tenant project will be peered for executing pipelines in the form of projects/{project-id}/global/networks/{network}" + description = "Name of the network in the project with which the tenant project will be peered for executing pipelines in the form of projects/{project-id}/global/networks/{network}." type = string } diff --git a/modules/folder/README.md b/modules/folder/README.md index efb207e1d..569394ca3 100644 --- a/modules/folder/README.md +++ b/modules/folder/README.md @@ -236,14 +236,14 @@ module "folder2" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [contacts](variables.tf#L17) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES | map(list(string)) | | {} | +| [contacts](variables.tf#L17) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | | [firewall_policies](variables.tf#L24) | Hierarchical firewall policies created in this folder. | map(map(object({…}))) | | {} | | [firewall_policy_association](variables.tf#L41) | The hierarchical firewall policy to associate to this folder. Must be either a key in the `firewall_policies` map or the id of a policy defined somewhere else. | map(string) | | {} | | [firewall_policy_factory](variables.tf#L48) | Configuration for the firewall policy factory. | object({…}) | | null | | [folder_create](variables.tf#L58) | Create folder. When set to false, uses id to reference an existing folder. | bool | | true | | [group_iam](variables.tf#L64) | Authoritative IAM binding for organization groups, in {GROUP_EMAIL => [ROLES]} format. Group emails need to be static. Can be used in combination with the `iam` variable. | map(list(string)) | | {} | | [iam](variables.tf#L71) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [id](variables.tf#L78) | Folder ID in case you use folder_create=false | string | | null | +| [id](variables.tf#L78) | Folder ID in case you use folder_create=false. | string | | null | | [logging_exclusions](variables.tf#L84) | Logging exclusions for this folder in the form {NAME -> FILTER}. | map(string) | | {} | | [logging_sinks](variables.tf#L91) | Logging sinks to create for this folder. | map(object({…})) | | {} | | [name](variables.tf#L112) | Folder name. | string | | null | diff --git a/modules/folder/logging.tf b/modules/folder/logging.tf index 04df65103..d6a195e1e 100644 --- a/modules/folder/logging.tf +++ b/modules/folder/logging.tf @@ -30,7 +30,7 @@ locals { resource "google_logging_folder_sink" "sink" { for_each = var.logging_sinks name = each.key - #description = "${each.key} (Terraform-managed)" + #description = "${each.key} (Terraform-managed)." folder = local.folder.name destination = "${each.value.type}.googleapis.com/${each.value.destination}" filter = each.value.filter @@ -86,6 +86,6 @@ resource "google_logging_folder_exclusion" "logging-exclusion" { for_each = var.logging_exclusions name = each.key folder = local.folder.name - description = "${each.key} (Terraform-managed)" + description = "${each.key} (Terraform-managed)." filter = each.value } diff --git a/modules/folder/variables.tf b/modules/folder/variables.tf index 563831cb6..788574111 100644 --- a/modules/folder/variables.tf +++ b/modules/folder/variables.tf @@ -15,7 +15,7 @@ */ variable "contacts" { - description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES" + description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES." type = map(list(string)) default = {} nullable = false @@ -76,7 +76,7 @@ variable "iam" { } variable "id" { - description = "Folder ID in case you use folder_create=false" + description = "Folder ID in case you use folder_create=false." type = string default = null } diff --git a/modules/gcs/README.md b/modules/gcs/README.md index 161b9aa53..322a4c277 100644 --- a/modules/gcs/README.md +++ b/modules/gcs/README.md @@ -119,7 +119,7 @@ module "bucket-gcs-notification" { | [force_destroy](variables.tf#L34) | Optional map to set force destroy keyed by name, defaults to false. | bool | | false | | [iam](variables.tf#L40) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [labels](variables.tf#L46) | Labels to be attached to all buckets. | map(string) | | {} | -| [lifecycle_rule](variables.tf#L52) | Bucket lifecycle rule | object({…}) | | null | +| [lifecycle_rule](variables.tf#L52) | Bucket lifecycle rule. | object({…}) | | null | | [location](variables.tf#L74) | Bucket location. | string | | "EU" | | [logging_config](variables.tf#L80) | Bucket logging configuration. | object({…}) | | null | | [notification_config](variables.tf#L94) | GCS Notification configuration. | object({…}) | | null | diff --git a/modules/gcs/variables.tf b/modules/gcs/variables.tf index 43673beb3..d8885bbb8 100644 --- a/modules/gcs/variables.tf +++ b/modules/gcs/variables.tf @@ -50,7 +50,7 @@ variable "labels" { } variable "lifecycle_rule" { - description = "Bucket lifecycle rule" + description = "Bucket lifecycle rule." type = object({ action = object({ type = string diff --git a/modules/gke-cluster/README.md b/modules/gke-cluster/README.md index b1a8034e0..05cf84890 100644 --- a/modules/gke-cluster/README.md +++ b/modules/gke-cluster/README.md @@ -82,9 +82,9 @@ module "cluster-1" { | [default_max_pods_per_node](variables.tf#L83) | Maximum number of pods per node in this cluster. | number | | 110 | | [description](variables.tf#L89) | Cluster description. | string | | null | | [dns_config](variables.tf#L95) | Configuration for Using Cloud DNS for GKE. | object({…}) | | {…} | -| [enable_autopilot](variables.tf#L109) | Create cluster in autopilot mode. With autopilot there's no need to create node-pools and some features are not supported (e.g. setting default_max_pods_per_node) | bool | | false | +| [enable_autopilot](variables.tf#L109) | Create cluster in autopilot mode. With autopilot there's no need to create node-pools and some features are not supported (e.g. setting default_max_pods_per_node). | bool | | false | | [enable_binary_authorization](variables.tf#L115) | Enable Google Binary Authorization. | bool | | null | -| [enable_dataplane_v2](variables.tf#L121) | Enable Dataplane V2 on the cluster, will disable network_policy addons config | bool | | false | +| [enable_dataplane_v2](variables.tf#L121) | Enable Dataplane V2 on the cluster, will disable network_policy addons config. | bool | | false | | [enable_intranode_visibility](variables.tf#L127) | Enable intra-node visibility to make same node pod to pod traffic visible. | bool | | null | | [enable_l4_ilb_subsetting](variables.tf#L133) | Enable L4ILB Subsetting. | bool | | null | | [enable_shielded_nodes](variables.tf#L139) | Enable Shielded Nodes features on all nodes in this cluster. | bool | | null | @@ -92,7 +92,7 @@ module "cluster-1" { | [labels](variables.tf#L151) | Cluster resource labels. | map(string) | | null | | [logging_config](variables.tf#L162) | Logging configuration (enabled components). | list(string) | | null | | [logging_service](variables.tf#L168) | Logging service (disable with an empty string). | string | | "logging.googleapis.com/kubernetes" | -| [maintenance_config](variables.tf#L174) | Maintenance window configuration | object({…}) | | {…} | +| [maintenance_config](variables.tf#L174) | Maintenance window configuration. | object({…}) | | {…} | | [master_authorized_ranges](variables.tf#L200) | External Ip address ranges that can access the Kubernetes cluster master through HTTPS. | map(string) | | {} | | [min_master_version](variables.tf#L206) | Minimum version of the master, defaults to the version of the most recent official release. | string | | null | | [monitoring_config](variables.tf#L212) | Monitoring configuration (enabled components). | list(string) | | null | diff --git a/modules/gke-cluster/variables.tf b/modules/gke-cluster/variables.tf index ddb754e21..5cd8a56e2 100644 --- a/modules/gke-cluster/variables.tf +++ b/modules/gke-cluster/variables.tf @@ -107,7 +107,7 @@ variable "dns_config" { } variable "enable_autopilot" { - description = "Create cluster in autopilot mode. With autopilot there's no need to create node-pools and some features are not supported (e.g. setting default_max_pods_per_node)" + description = "Create cluster in autopilot mode. With autopilot there's no need to create node-pools and some features are not supported (e.g. setting default_max_pods_per_node)." type = bool default = false } @@ -119,7 +119,7 @@ variable "enable_binary_authorization" { } variable "enable_dataplane_v2" { - description = "Enable Dataplane V2 on the cluster, will disable network_policy addons config" + description = "Enable Dataplane V2 on the cluster, will disable network_policy addons config." type = bool default = false } @@ -172,7 +172,7 @@ variable "logging_service" { } variable "maintenance_config" { - description = "Maintenance window configuration" + description = "Maintenance window configuration." type = object({ daily_maintenance_window = object({ start_time = string diff --git a/modules/gke-nodepool/README.md b/modules/gke-nodepool/README.md index 957715efd..731a161d5 100644 --- a/modules/gke-nodepool/README.md +++ b/modules/gke-nodepool/README.md @@ -50,7 +50,7 @@ module "cluster-1-nodepool-1" { | [management_config](variables.tf#L64) | Optional node management configuration. | object({…}) | | null | | [max_pods_per_node](variables.tf#L73) | Maximum number of pods per node. | number | | null | | [name](variables.tf#L79) | Optional nodepool name. | string | | null | -| [node_boot_disk_kms_key](variables.tf#L85) | Customer Managed Encryption Key used to encrypt the boot disk attached to each node | string | | null | +| [node_boot_disk_kms_key](variables.tf#L85) | Customer Managed Encryption Key used to encrypt the boot disk attached to each node. | string | | null | | [node_count](variables.tf#L91) | Number of nodes per instance group, can be updated after creation. Ignored when autoscaling is set. | number | | null | | [node_disk_size](variables.tf#L97) | Node disk size, defaults to 100GB. | number | | 100 | | [node_disk_type](variables.tf#L103) | Node disk type, defaults to pd-standard. | string | | "pd-standard" | @@ -69,7 +69,7 @@ module "cluster-1-nodepool-1" { | [node_service_account_scopes](variables.tf#L182) | Scopes applied to service account. Default to: 'cloud-platform' when creating a service account; 'devstorage.read_only', 'logging.write', 'monitoring.write' otherwise. | list(string) | | [] | | [node_shielded_instance_config](variables.tf#L188) | Shielded instance options. | object({…}) | | null | | [node_tags](variables.tf#L197) | Network tags applied to nodes. | list(string) | | null | -| [node_taints](variables.tf#L203) | Kubernetes taints applied to nodes. E.g. type=blue:NoSchedule | list(string) | | [] | +| [node_taints](variables.tf#L203) | Kubernetes taints applied to nodes. E.g. type=blue:NoSchedule. | list(string) | | [] | | [upgrade_config](variables.tf#L215) | Optional node upgrade configuration. | object({…}) | | null | | [workload_metadata_config](variables.tf#L224) | Metadata configuration to expose to workloads on the node pool. | string | | "GKE_METADATA" | diff --git a/modules/gke-nodepool/variables.tf b/modules/gke-nodepool/variables.tf index 8b3f6d10f..6b7cdbc51 100644 --- a/modules/gke-nodepool/variables.tf +++ b/modules/gke-nodepool/variables.tf @@ -83,7 +83,7 @@ variable "name" { } variable "node_boot_disk_kms_key" { - description = "Customer Managed Encryption Key used to encrypt the boot disk attached to each node" + description = "Customer Managed Encryption Key used to encrypt the boot disk attached to each node." type = string default = null } @@ -201,7 +201,7 @@ variable "node_tags" { } variable "node_taints" { - description = "Kubernetes taints applied to nodes. E.g. type=blue:NoSchedule" + description = "Kubernetes taints applied to nodes. E.g. type=blue:NoSchedule." type = list(string) default = [] } diff --git a/modules/net-interconnect-attachment-direct/README.md b/modules/net-interconnect-attachment-direct/README.md index 1ca75f222..3b77372e2 100644 --- a/modules/net-interconnect-attachment-direct/README.md +++ b/modules/net-interconnect-attachment-direct/README.md @@ -110,23 +110,23 @@ module "vlan-attachment-2" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [interconnect](variables.tf#L46) | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | string | ✓ | | -| [peer](variables.tf#L57) | Peer Ip address and asn. Only IPv4 supported | object({…}) | ✓ | | -| [project_id](variables.tf#L65) | The project containing the resources | string | ✓ | | -| [router_config](variables.tf#L76) | Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. | object({…} | ✓ | | -| [bgp](variables.tf#L17) | Bgp session parameters | object({…}) | | null | -| [config](variables.tf#L28) | VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect | object({…}) | | {…} | -| [name](variables.tf#L51) | The name of the vlan attachment | string | | "vlan-attachment" | -| [region](variables.tf#L70) | Region where the router resides | string | | "europe-west1-b" | +| [peer](variables.tf#L57) | Peer Ip address and asn. Only IPv4 supported. | object({…}) | ✓ | | +| [project_id](variables.tf#L65) | The project containing the resources. | string | ✓ | | +| [router_config](variables.tf#L76) | Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. . | object({…} | ✓ | | +| [bgp](variables.tf#L17) | Bgp session parameters. | object({…}) | | null | +| [config](variables.tf#L28) | VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect. | object({…}) | | {…} | +| [name](variables.tf#L51) | The name of the vlan attachment. | string | | "vlan-attachment" | +| [region](variables.tf#L70) | Region where the router resides. | string | | "europe-west1-b" | | [router_create](variables.tf#L95) | Create router. | bool | | true | | [router_name](variables.tf#L101) | Router name used for auto created router, or to specify an existing router to use if `router_create` is set to `true`. Leave blank to use vlan attachment name for auto created router. | string | | "router-vlan-attachment" | -| [router_network](variables.tf#L107) | A reference to the network to which this router belongs | string | | null | +| [router_network](variables.tf#L107) | A reference to the network to which this router belongs. | string | | null | ## Outputs | name | description | sensitive | |---|---|:---:| -| [bgpsession](outputs.tf#L16) | bgp session | | -| [interconnect_attachment](outputs.tf#L21) | interconnect attachment | | +| [bgpsession](outputs.tf#L16) | bgp session. | | +| [interconnect_attachment](outputs.tf#L21) | interconnect attachment. | | | [router](outputs.tf#L26) | Router resource (only if auto-created). | | diff --git a/modules/net-interconnect-attachment-direct/outputs.tf b/modules/net-interconnect-attachment-direct/outputs.tf index a7905fefd..53b3616d8 100644 --- a/modules/net-interconnect-attachment-direct/outputs.tf +++ b/modules/net-interconnect-attachment-direct/outputs.tf @@ -14,12 +14,12 @@ * limitations under the License. */ output "bgpsession" { - description = "bgp session" + description = "bgp session." value = google_compute_router_peer.peer } output "interconnect_attachment" { - description = "interconnect attachment" + description = "interconnect attachment." value = google_compute_interconnect_attachment.interconnect_vlan_attachment } diff --git a/modules/net-interconnect-attachment-direct/variables.tf b/modules/net-interconnect-attachment-direct/variables.tf index 881147fbb..7c08ae2af 100644 --- a/modules/net-interconnect-attachment-direct/variables.tf +++ b/modules/net-interconnect-attachment-direct/variables.tf @@ -15,7 +15,7 @@ */ variable "bgp" { - description = "Bgp session parameters" + description = "Bgp session parameters." type = object({ session_range = string candidate_ip_ranges = list(string) @@ -26,7 +26,7 @@ variable "bgp" { } variable "config" { - description = "VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect" + description = "VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect." type = object({ description = string vlan_id = number @@ -49,13 +49,13 @@ variable "interconnect" { } variable "name" { - description = "The name of the vlan attachment" + description = "The name of the vlan attachment." type = string default = "vlan-attachment" } variable "peer" { - description = "Peer Ip address and asn. Only IPv4 supported" + description = "Peer Ip address and asn. Only IPv4 supported." type = object({ ip_address = string asn = number @@ -63,18 +63,18 @@ variable "peer" { } variable "project_id" { - description = "The project containing the resources" + description = "The project containing the resources." type = string } variable "region" { - description = "Region where the router resides" + description = "Region where the router resides." type = string default = "europe-west1-b" } variable "router_config" { - description = "Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. " + description = "Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. ." type = object({ description = string asn = number @@ -105,7 +105,7 @@ variable "router_name" { } variable "router_network" { - description = "A reference to the network to which this router belongs" + description = "A reference to the network to which this router belongs." type = string default = null } diff --git a/modules/net-vpc-firewall/README.md b/modules/net-vpc-firewall/README.md index f3184a778..75f6d48c4 100644 --- a/modules/net-vpc-firewall/README.md +++ b/modules/net-vpc-firewall/README.md @@ -137,7 +137,7 @@ healthchecks: | [data_folder](variables.tf#L48) | Path for optional folder containing firewall rules defined as YaML objects used by the rules factory. | string | | null | | [http_source_ranges](variables.tf#L54) | List of IP CIDR ranges for tag-based HTTP rule, defaults to the health checkers ranges. | list(string) | | ["35.191.0.0/16", "130.211.0.0/22", "209.85.152.0/22", "209.85.204.0/22"] | | [https_source_ranges](variables.tf#L60) | List of IP CIDR ranges for tag-based HTTPS rule, defaults to the health checkers ranges. | list(string) | | ["35.191.0.0/16", "130.211.0.0/22", "209.85.152.0/22", "209.85.204.0/22"] | -| [named_ranges](variables.tf#L66) | Names that can be used of valid values for the `ranges` field of `custom_rules` | map(list(string)) | | {…} | +| [named_ranges](variables.tf#L66) | Names that can be used of valid values for the `ranges` field of `custom_rules`. | map(list(string)) | | {…} | | [ssh_source_ranges](variables.tf#L90) | List of IP CIDR ranges for tag-based SSH rule, defaults to the IAP forwarders range. | list(string) | | ["35.235.240.0/20"] | ## Outputs diff --git a/modules/net-vpc-firewall/variables.tf b/modules/net-vpc-firewall/variables.tf index 356b8bd8e..b0a2a9d79 100644 --- a/modules/net-vpc-firewall/variables.tf +++ b/modules/net-vpc-firewall/variables.tf @@ -64,7 +64,7 @@ variable "https_source_ranges" { } variable "named_ranges" { - description = "Names that can be used of valid values for the `ranges` field of `custom_rules`" + description = "Names that can be used of valid values for the `ranges` field of `custom_rules`." type = map(list(string)) default = { any = ["0.0.0.0/0"] diff --git a/modules/net-vpc/README.md b/modules/net-vpc/README.md index 050fb5c47..17723006e 100644 --- a/modules/net-vpc/README.md +++ b/modules/net-vpc/README.md @@ -207,8 +207,8 @@ flow_logs: # enable, set to empty map to use defaults | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [name](variables.tf#L85) | The name of the network being created | string | ✓ | | -| [project_id](variables.tf#L106) | The ID of the project where this VPC will be created | string | ✓ | | +| [name](variables.tf#L85) | The name of the network being created. | string | ✓ | | +| [project_id](variables.tf#L106) | The ID of the project where this VPC will be created. | string | ✓ | | | [auto_create_subnetworks](variables.tf#L17) | Set to true to create an auto mode subnet, defaults to custom mode. | bool | | false | | [data_folder](variables.tf#L23) | An optional folder containing the subnet configurations in YaML format. | string | | null | | [delete_default_routes_on_create](variables.tf#L29) | Set to true to delete the default routes at creation time. | bool | | false | @@ -219,12 +219,12 @@ flow_logs: # enable, set to empty map to use defaults | [log_configs](variables.tf#L74) | Map keyed by subnet 'region/name' of optional configurations for flow logs when enabled. | map(map(string)) | | {} | | [mtu](variables.tf#L80) | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. | | | null | | [peering_config](variables.tf#L90) | VPC peering configuration. | object({…}) | | null | -| [peering_create_remote_end](variables.tf#L100) | Skip creation of peering on the remote end when using peering_config | bool | | true | +| [peering_create_remote_end](variables.tf#L100) | Skip creation of peering on the remote end when using peering_config. | bool | | true | | [psn_ranges](variables.tf#L111) | CIDR ranges used for Google services that support Private Service Networking. | list(string) | | null | | [routes](variables.tf#L124) | Network routes, keyed by name. | map(object({…})) | | {} | -| [routing_mode](variables.tf#L136) | The network routing mode (default 'GLOBAL') | string | | "GLOBAL" | +| [routing_mode](variables.tf#L136) | The network routing mode (default 'GLOBAL'). | string | | "GLOBAL" | | [shared_vpc_host](variables.tf#L146) | Enable shared VPC for this project. | bool | | false | -| [shared_vpc_service_projects](variables.tf#L152) | Shared VPC service projects to register with this host | list(string) | | [] | +| [shared_vpc_service_projects](variables.tf#L152) | Shared VPC service projects to register with this host. | list(string) | | [] | | [subnet_descriptions](variables.tf#L158) | Optional map of subnet descriptions, keyed by subnet 'region/name'. | map(string) | | {} | | [subnet_flow_logs](variables.tf#L164) | Optional map of boolean to control flow logs (default is disabled), keyed by subnet 'region/name'. | map(bool) | | {} | | [subnet_private_access](variables.tf#L170) | Optional map of boolean to control private Google access (default is enabled), keyed by subnet 'region/name'. | map(bool) | | {} | diff --git a/modules/net-vpc/variables.tf b/modules/net-vpc/variables.tf index 824c6f282..0dace3f17 100644 --- a/modules/net-vpc/variables.tf +++ b/modules/net-vpc/variables.tf @@ -83,7 +83,7 @@ variable "mtu" { } variable "name" { - description = "The name of the network being created" + description = "The name of the network being created." type = string } @@ -98,13 +98,13 @@ variable "peering_config" { } variable "peering_create_remote_end" { - description = "Skip creation of peering on the remote end when using peering_config" + description = "Skip creation of peering on the remote end when using peering_config." type = bool default = true } variable "project_id" { - description = "The ID of the project where this VPC will be created" + description = "The ID of the project where this VPC will be created." type = string } @@ -134,7 +134,7 @@ variable "routes" { } variable "routing_mode" { - description = "The network routing mode (default 'GLOBAL')" + description = "The network routing mode (default 'GLOBAL')." type = string default = "GLOBAL" validation { @@ -150,7 +150,7 @@ variable "shared_vpc_host" { } variable "shared_vpc_service_projects" { - description = "Shared VPC service projects to register with this host" + description = "Shared VPC service projects to register with this host." type = list(string) default = [] } diff --git a/modules/net-vpn-ha/README.md b/modules/net-vpn-ha/README.md index 5076a7bcc..d51b4852a 100644 --- a/modules/net-vpn-ha/README.md +++ b/modules/net-vpn-ha/README.md @@ -166,7 +166,7 @@ module "vpn_ha" { | [bgp_peers](outputs.tf#L18) | BGP peer resources. | | | [external_gateway](outputs.tf#L25) | External VPN gateway resource. | | | [gateway](outputs.tf#L34) | VPN gateway resource (only if auto-created). | | -| [name](outputs.tf#L43) | VPN gateway name (only if auto-created). | | +| [name](outputs.tf#L43) | VPN gateway name (only if auto-created). . | | | [random_secret](outputs.tf#L52) | Generated secret. | | | [router](outputs.tf#L57) | Router resource (only if auto-created). | | | [router_name](outputs.tf#L66) | Router name. | | diff --git a/modules/net-vpn-ha/outputs.tf b/modules/net-vpn-ha/outputs.tf index 181305b63..94aac9829 100644 --- a/modules/net-vpn-ha/outputs.tf +++ b/modules/net-vpn-ha/outputs.tf @@ -41,7 +41,7 @@ output "gateway" { } output "name" { - description = "VPN gateway name (only if auto-created). " + description = "VPN gateway name (only if auto-created). ." value = ( var.vpn_gateway_create ? google_compute_ha_vpn_gateway.ha_gateway[0].name diff --git a/modules/organization/README.md b/modules/organization/README.md index 8edc529d7..3fd0d1bf0 100644 --- a/modules/organization/README.md +++ b/modules/organization/README.md @@ -65,7 +65,7 @@ module "org" { firewall_policies = { iap-policy = { allow-iap-ssh = { - description = "Always allow ssh from IAP" + description = "Always allow ssh from IAP." direction = "INGRESS" action = "allow" priority = 100 @@ -257,7 +257,7 @@ module "org" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [organization_id](variables.tf#L151) | Organization id in organizations/nnnnnn format. | string | ✓ | | -| [contacts](variables.tf#L17) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES | map(list(string)) | | {} | +| [contacts](variables.tf#L17) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | | [custom_roles](variables.tf#L24) | Map of role name => list of permissions to create in this project. | map(list(string)) | | {} | | [firewall_policies](variables.tf#L31) | Hierarchical firewall policy rules created in the organization. | map(map(object({…}))) | | {} | | [firewall_policy_association](variables.tf#L48) | The hierarchical firewall policy to associate to this folder. Must be either a key in the `firewall_policies` map or the id of a policy defined somewhere else. | map(string) | | {} | diff --git a/modules/organization/iam.tf b/modules/organization/iam.tf index 501633ead..48cb452f7 100644 --- a/modules/organization/iam.tf +++ b/modules/organization/iam.tf @@ -51,7 +51,7 @@ resource "google_organization_iam_custom_role" "roles" { org_id = local.organization_id_numeric role_id = each.key title = "Custom role ${each.key}" - description = "Terraform-managed" + description = "Terraform-managed." permissions = each.value } diff --git a/modules/organization/logging.tf b/modules/organization/logging.tf index 4f799bf7d..0beeb0f87 100644 --- a/modules/organization/logging.tf +++ b/modules/organization/logging.tf @@ -91,6 +91,6 @@ resource "google_logging_organization_exclusion" "logging-exclusion" { for_each = var.logging_exclusions name = each.key org_id = local.organization_id_numeric - description = "${each.key} (Terraform-managed)" + description = "${each.key} (Terraform-managed)." filter = each.value } diff --git a/modules/organization/variables.tf b/modules/organization/variables.tf index 0e12c5d2f..1ed117cfb 100644 --- a/modules/organization/variables.tf +++ b/modules/organization/variables.tf @@ -15,7 +15,7 @@ */ variable "contacts" { - description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES" + description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES." type = map(list(string)) default = {} nullable = false diff --git a/modules/project/README.md b/modules/project/README.md index 170160325..d10953efd 100644 --- a/modules/project/README.md +++ b/modules/project/README.md @@ -197,11 +197,11 @@ module "project" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L125) | Project name and id suffix. | string | ✓ | | -| [auto_create_network](variables.tf#L17) | Whether to create the default network for the project | bool | | false | +| [auto_create_network](variables.tf#L17) | Whether to create the default network for the project. | bool | | false | | [billing_account](variables.tf#L23) | Billing account id. | string | | null | -| [contacts](variables.tf#L29) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES | map(list(string)) | | {} | +| [contacts](variables.tf#L29) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | | [custom_roles](variables.tf#L36) | Map of role name => list of permissions to create in this project. | map(list(string)) | | {} | -| [descriptive_name](variables.tf#L43) | Name of the project name. Used for project name instead of `name` variable | string | | null | +| [descriptive_name](variables.tf#L43) | Name of the project name. Used for project name instead of `name` variable. | string | | null | | [group_iam](variables.tf#L49) | Authoritative IAM binding for organization groups, in {GROUP_EMAIL => [ROLES]} format. Group emails need to be static. Can be used in combination with the `iam` variable. | map(list(string)) | | {} | | [iam](variables.tf#L56) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [iam_additive](variables.tf#L63) | IAM additive bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | diff --git a/modules/project/iam.tf b/modules/project/iam.tf index 5abf383ec..69925cc76 100644 --- a/modules/project/iam.tf +++ b/modules/project/iam.tf @@ -56,7 +56,7 @@ resource "google_project_iam_custom_role" "roles" { project = local.project.project_id role_id = each.key title = "Custom role ${each.key}" - description = "Terraform-managed" + description = "Terraform-managed." permissions = each.value } diff --git a/modules/project/logging.tf b/modules/project/logging.tf index 53bc2f030..04d7abf16 100644 --- a/modules/project/logging.tf +++ b/modules/project/logging.tf @@ -29,7 +29,7 @@ locals { resource "google_logging_project_sink" "sink" { for_each = var.logging_sinks name = each.key - #description = "${each.key} (Terraform-managed)" + #description = "${each.key} (Terraform-managed)." project = local.project.project_id destination = "${each.value.type}.googleapis.com/${each.value.destination}" filter = each.value.filter @@ -86,6 +86,6 @@ resource "google_logging_project_exclusion" "logging-exclusion" { for_each = var.logging_exclusions name = each.key project = local.project.project_id - description = "${each.key} (Terraform-managed)" + description = "${each.key} (Terraform-managed)." filter = each.value } diff --git a/modules/project/variables.tf b/modules/project/variables.tf index 00f20f949..3f81fbf2b 100644 --- a/modules/project/variables.tf +++ b/modules/project/variables.tf @@ -15,7 +15,7 @@ */ variable "auto_create_network" { - description = "Whether to create the default network for the project" + description = "Whether to create the default network for the project." type = bool default = false } @@ -27,7 +27,7 @@ variable "billing_account" { } variable "contacts" { - description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES" + description = "List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES." type = map(list(string)) default = {} nullable = false @@ -41,7 +41,7 @@ variable "custom_roles" { } variable "descriptive_name" { - description = "Name of the project name. Used for project name instead of `name` variable" + description = "Name of the project name. Used for project name instead of `name` variable." type = string default = null } diff --git a/tests/examples/data_solutions/gcs_to_bq_with_least_privileges/fixture/variables.tf b/tests/examples/data_solutions/gcs_to_bq_with_least_privileges/fixture/variables.tf index 03fa13959..477dcaf79 100644 --- a/tests/examples/data_solutions/gcs_to_bq_with_least_privileges/fixture/variables.tf +++ b/tests/examples/data_solutions/gcs_to_bq_with_least_privileges/fixture/variables.tf @@ -21,7 +21,7 @@ variable "prefix" { } variable "project_create" { - description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format" + description = "Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format." type = object({ billing_account_id = string parent = string diff --git a/tests/modules/net_interconnect_attachment_direct/fixture/variables.tf b/tests/modules/net_interconnect_attachment_direct/fixture/variables.tf index 55894d4e4..e5547473c 100644 --- a/tests/modules/net_interconnect_attachment_direct/fixture/variables.tf +++ b/tests/modules/net_interconnect_attachment_direct/fixture/variables.tf @@ -15,7 +15,7 @@ */ variable "bgp" { - description = "Bgp session parameters" + description = "Bgp session parameters." type = object({ session_range = string candidate_ip_ranges = list(string) @@ -26,7 +26,7 @@ variable "bgp" { } variable "config" { - description = "VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect" + description = "VLAN attachment parameters: description, vlan_id, bandwidth, admin_enabled, interconnect." type = object({ description = string vlan_id = number @@ -51,13 +51,13 @@ variable "interconnect" { } variable "name" { - description = "The name of the vlan attachment" + description = "The name of the vlan attachment." type = string default = "vlan-603" } variable "peer" { - description = "Peer Ip address and asn. Only IPv4 supported" + description = "Peer Ip address and asn. Only IPv4 supported." type = object({ ip_address = string asn = number @@ -69,7 +69,7 @@ variable "peer" { } variable "router_config" { - description = "Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. " + description = "Router asn and custom advertisement configuration, ip_ranges is a map of address ranges and descriptions.. ." type = object({ description = string asn = number @@ -100,7 +100,7 @@ variable "router_name" { } variable "router_network" { - description = "A reference to the network to which this router belongs" + description = "A reference to the network to which this router belongs." type = string default = "my-vpc" } diff --git a/tests/modules/net_vpc/fixture/variables.tf b/tests/modules/net_vpc/fixture/variables.tf index 918521b54..cd237e90e 100644 --- a/tests/modules/net_vpc/fixture/variables.tf +++ b/tests/modules/net_vpc/fixture/variables.tf @@ -78,7 +78,7 @@ variable "routes" { } variable "routing_mode" { - description = "The network routing mode (default 'GLOBAL')" + description = "The network routing mode (default 'GLOBAL')." type = string default = "GLOBAL" } @@ -90,13 +90,13 @@ variable "shared_vpc_host" { } variable "shared_vpc_service_projects" { - description = "Shared VPC service projects to register with this host" + description = "Shared VPC service projects to register with this host." type = list(string) default = [] } variable "subnets" { - description = "The list of subnets being created" + description = "The list of subnets being created." type = list(object({ name = string ip_cidr_range = string diff --git a/tests/modules/net_vpc_firewall/fixture/variables.tf b/tests/modules/net_vpc_firewall/fixture/variables.tf index 1ff9cff33..8627bf813 100644 --- a/tests/modules/net_vpc_firewall/fixture/variables.tf +++ b/tests/modules/net_vpc_firewall/fixture/variables.tf @@ -64,7 +64,7 @@ variable "https_source_ranges" { } variable "named_ranges" { - description = "Names that can be used of valid values for the `ranges` field of `custom_rules`" + description = "Names that can be used of valid values for the `ranges` field of `custom_rules`." type = map(list(string)) default = { any = ["0.0.0.0/0"]