From 612d7283e882eb56c7c7b01dd8be10cc7751f5f3 Mon Sep 17 00:00:00 2001 From: Julio Castillo Date: Thu, 24 Nov 2022 18:56:01 +0100 Subject: [PATCH 1/3] Enforce nonempty descriptions ending in a colon --- blueprints/cloud-operations/adfs/README.md | 2 +- blueprints/cloud-operations/adfs/variables.tf | 2 +- blueprints/cloud-operations/apigee/README.md | 2 +- .../cloud-operations/apigee/variables.tf | 4 +- .../network-dashboard/README.md | 12 ++--- .../network-dashboard/variables.tf | 12 ++--- .../tfc-workflow-using-wif/tfc-oidc/README.md | 2 +- .../tfc-oidc/outputs.tf | 1 + .../vm-migration/esxi/README.md | 8 +-- .../vm-migration/esxi/variables.tf | 8 +-- .../host-target-projects/README.md | 12 ++--- .../host-target-projects/outputs.tf | 2 +- .../host-target-projects/variables.tf | 10 ++-- .../host-target-sharedvpc/README.md | 14 +++--- .../host-target-sharedvpc/outputs.tf | 2 +- .../host-target-sharedvpc/variables.tf | 12 ++--- .../vm-migration/single-project/README.md | 12 ++--- .../vm-migration/single-project/outputs.tf | 2 +- .../vm-migration/single-project/variables.tf | 10 ++-- .../cloudsql-multiregion/README.md | 2 +- .../cloudsql-multiregion/variables.tf | 2 +- .../data-solutions/data-playground/README.md | 6 +-- .../data-solutions/data-playground/outputs.tf | 4 +- .../data-playground/variables.tf | 2 +- .../sqlserver-alwayson/README.md | 48 +++++++++--------- .../sqlserver-alwayson/outputs.tf | 5 +- .../sqlserver-alwayson/variables.tf | 46 ++++++++--------- .../factories/bigquery-factory/README.md | 2 +- .../factories/bigquery-factory/variables.tf | 2 +- .../factories/project-factory/README.md | 6 +-- .../factories/project-factory/outputs.tf | 2 +- .../factories/project-factory/variables.tf | 4 +- .../README.md | 4 +- .../variables.tf | 4 +- .../nginx-reverse-proxy-cluster/README.md | 26 +++++----- .../nginx-reverse-proxy-cluster/variables.tf | 5 +- .../wordpress/cloudrun/README.md | 26 +++++----- .../wordpress/cloudrun/outputs.tf | 8 +-- .../wordpress/cloudrun/variables.tf | 18 +++---- .../00-bootstrap/00-bootstrap-providers.tfx | 1 + fast/stages/00-bootstrap/README.md | 2 +- fast/stages/00-bootstrap/variables.tf | 2 +- fast/stages/01-resman/README.md | 2 +- fast/stages/01-resman/variables.tf | 2 +- fast/stages/02-networking-nva/README.md | 2 +- fast/stages/02-networking-nva/variables.tf | 2 +- fast/stages/03-data-platform/dev/README.md | 32 ++++++------ fast/stages/03-data-platform/dev/variables.tf | 1 + modules/api-gateway/README.md | 6 +-- modules/api-gateway/variables.tf | 6 +-- modules/apigee/README.md | 2 +- modules/apigee/outputs.tf | 2 +- modules/binauthz/README.md | 10 ++-- modules/binauthz/outputs.tf | 2 +- modules/binauthz/variables.tf | 8 +-- modules/cloud-function/README.md | 4 +- modules/cloud-function/variables.tf | 4 +- modules/cloudsql-instance/README.md | 2 +- modules/cloudsql-instance/variables.tf | 2 +- modules/gke-hub/README.md | 3 +- modules/gke-hub/outputs.tf | 1 + modules/net-ilb-l7/README.md | 8 +-- modules/net-ilb-l7/outputs.tf | 2 +- tools/check_documentation.py | 49 ++++++++++++++++--- 64 files changed, 272 insertions(+), 236 deletions(-) create mode 120000 fast/stages/00-bootstrap/00-bootstrap-providers.tfx diff --git a/blueprints/cloud-operations/adfs/README.md b/blueprints/cloud-operations/adfs/README.md index b18f60fee2..36b772f8e7 100644 --- a/blueprints/cloud-operations/adfs/README.md +++ b/blueprints/cloud-operations/adfs/README.md @@ -61,7 +61,7 @@ Once done testing, you can clean up resources by running `terraform destroy`. | [disk_type](variables.tf#L37) | Disk type. | string | | "pd-ssd" | | [image](variables.tf#L43) | Image. | string | | "projects/windows-cloud/global/images/family/windows-2022" | | [instance_type](variables.tf#L49) | Instance type. | string | | "n1-standard-2" | -| [network_config](variables.tf#L55) | Network configuration | object({…}) | | null | +| [network_config](variables.tf#L55) | Network configuration. | object({…}) | | null | | [project_create](variables.tf#L73) | Parameters for the creation of the new project. | object({…}) | | null | | [region](variables.tf#L87) | Region. | string | | "europe-west1" | | [subnet_ip_cidr_block](variables.tf#L93) | Subnet IP CIDR block. | string | | "10.0.1.0/28" | diff --git a/blueprints/cloud-operations/adfs/variables.tf b/blueprints/cloud-operations/adfs/variables.tf index 95a121d0cb..66c1276d7a 100644 --- a/blueprints/cloud-operations/adfs/variables.tf +++ b/blueprints/cloud-operations/adfs/variables.tf @@ -53,7 +53,7 @@ variable "instance_type" { } variable "network_config" { - description = "Network configuration" + description = "Network configuration." type = object({ network = string subnet = string diff --git a/blueprints/cloud-operations/apigee/README.md b/blueprints/cloud-operations/apigee/README.md index 65bcea51c0..922f038eda 100644 --- a/blueprints/cloud-operations/apigee/README.md +++ b/blueprints/cloud-operations/apigee/README.md @@ -63,7 +63,7 @@ Do the following to verify that everything works as expected. | [instances](variables.tf#L46) | Instance. | map(object({…})) | ✓ | | | [project_id](variables.tf#L92) | Project ID. | string | ✓ | | | [psc_config](variables.tf#L98) | PSC configuration. | map(string) | ✓ | | -| [datastore_name](variables.tf#L17) | Datastore | string | | "gcs" | +| [datastore_name](variables.tf#L17) | Datastore. | string | | "gcs" | | [organization](variables.tf#L60) | Apigee organization. | object({…}) | | {…} | | [path](variables.tf#L76) | Bucket path. | string | | "/analytics" | | [project_create](variables.tf#L83) | Parameters for the creation of the new project. | object({…}) | | null | diff --git a/blueprints/cloud-operations/apigee/variables.tf b/blueprints/cloud-operations/apigee/variables.tf index 61c9339101..22dea90b35 100644 --- a/blueprints/cloud-operations/apigee/variables.tf +++ b/blueprints/cloud-operations/apigee/variables.tf @@ -1,4 +1,4 @@ -/** +** * Copyright 2022 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -15,7 +15,7 @@ */ variable "datastore_name" { - description = "Datastore" + description = "Datastore." type = string nullable = false default = "gcs" diff --git a/blueprints/cloud-operations/network-dashboard/README.md b/blueprints/cloud-operations/network-dashboard/README.md index 179ae9c884..768e0f12d1 100644 --- a/blueprints/cloud-operations/network-dashboard/README.md +++ b/blueprints/cloud-operations/network-dashboard/README.md @@ -89,15 +89,15 @@ If you are interested in this and/or would like to contribute, please contact le | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [billing_account](variables.tf#L17) | The ID of the billing account to associate this project with | | ✓ | | -| [monitored_projects_list](variables.tf#L36) | ID of the projects to be monitored (where limits and quotas data will be pulled) | list(string) | ✓ | | -| [organization_id](variables.tf#L46) | The organization id for the associated services | | ✓ | | +| [billing_account](variables.tf#L17) | The ID of the billing account to associate this project with. | | ✓ | | +| [monitored_projects_list](variables.tf#L36) | ID of the projects to be monitored (where limits and quotas data will be pulled). | list(string) | ✓ | | +| [organization_id](variables.tf#L46) | The organization id for the associated services. | | ✓ | | | [prefix](variables.tf#L50) | Prefix used for resource names. | string | ✓ | | | [cf_version](variables.tf#L21) | Cloud Function version 2nd Gen or 1st Gen. Possible options: 'V1' or 'V2'.Use CFv2 if your Cloud Function timeouts after 9 minutes. By default it is using CFv1. | | | V1 | -| [monitored_folders_list](variables.tf#L30) | ID of the projects to be monitored (where limits and quotas data will be pulled) | list(string) | | [] | -| [monitoring_project_id](variables.tf#L41) | Monitoring project where the dashboard will be created and the solution deployed; a project will be created if set to empty string | | | | +| [monitored_folders_list](variables.tf#L30) | ID of the projects to be monitored (where limits and quotas data will be pulled). | list(string) | | [] | +| [monitoring_project_id](variables.tf#L41) | Monitoring project where the dashboard will be created and the solution deployed; a project will be created if set to empty string. | | | | | [project_monitoring_services](variables.tf#L59) | Service APIs enabled in the monitoring project if it will be created. | | | […] | -| [region](variables.tf#L81) | Region used to deploy the cloud functions and scheduler | | | europe-west1 | +| [region](variables.tf#L81) | Region used to deploy the cloud functions and scheduler. | | | europe-west1 | | [schedule_cron](variables.tf#L86) | Cron format schedule to run the Cloud Function. Default is every 10 minutes. | | | */10 * * * * | diff --git a/blueprints/cloud-operations/network-dashboard/variables.tf b/blueprints/cloud-operations/network-dashboard/variables.tf index 9c279b9d6e..2744eed629 100644 --- a/blueprints/cloud-operations/network-dashboard/variables.tf +++ b/blueprints/cloud-operations/network-dashboard/variables.tf @@ -15,7 +15,7 @@ */ 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 "cf_version" { @@ -29,22 +29,22 @@ variable "cf_version" { variable "monitored_folders_list" { type = list(string) - description = "ID of the projects to be monitored (where limits and quotas data will be pulled)" + description = "ID of the projects to be monitored (where limits and quotas data will be pulled)." default = [] } variable "monitored_projects_list" { type = list(string) - description = "ID of the projects to be monitored (where limits and quotas data will be pulled)" + description = "ID of the projects to be monitored (where limits and quotas data will be pulled)." } variable "monitoring_project_id" { - description = "Monitoring project where the dashboard will be created and the solution deployed; a project will be created if set to empty string" + description = "Monitoring project where the dashboard will be created and the solution deployed; a project will be created if set to empty string." default = "" } variable "organization_id" { - description = "The organization id for the associated services" + description = "The organization id for the associated services." } variable "prefix" { @@ -79,7 +79,7 @@ variable "project_monitoring_services" { ] } variable "region" { - description = "Region used to deploy the cloud functions and scheduler" + description = "Region used to deploy the cloud functions and scheduler." default = "europe-west1" } diff --git a/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/README.md b/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/README.md index dcad294b38..240d6d024d 100644 --- a/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/README.md +++ b/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/README.md @@ -35,6 +35,6 @@ provider "google-beta" { | name | description | sensitive | |---|---|:---:| -| [credentials](outputs.tf#L17) | | | +| [credentials](outputs.tf#L17) | Credentials in format to pass the to gcp provider. | | diff --git a/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/outputs.tf b/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/outputs.tf index fbcea8c229..a4d54c544c 100644 --- a/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/outputs.tf +++ b/blueprints/cloud-operations/terraform-enterprise-wif/tfc-workflow-using-wif/tfc-oidc/outputs.tf @@ -15,6 +15,7 @@ */ output "credentials" { + description = "Credentials in format to pass the to gcp provider." value = jsonencode({ "type" : "external_account", "audience" : "${local.audience}", diff --git a/blueprints/cloud-operations/vm-migration/esxi/README.md b/blueprints/cloud-operations/vm-migration/esxi/README.md index 575b0adf22..f3b4ebedf6 100644 --- a/blueprints/cloud-operations/vm-migration/esxi/README.md +++ b/blueprints/cloud-operations/vm-migration/esxi/README.md @@ -22,11 +22,11 @@ This sample creates several distinct groups of resources: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [m4ce_ssh_public_key](variables.tf#L43) | Filesystem path to the public key for the SSH login | string | ✓ | | +| [m4ce_ssh_public_key](variables.tf#L43) | Filesystem path to the public key for the SSH login. | string | ✓ | | | [vcenter_password](variables.tf#L48) | VCenter user password. | string | ✓ | | -| [vsphere_environment](variables.tf#L53) | VMVware VSphere connection parameters | object({…}) | ✓ | | -| [m4ce_appliance_properties](variables.tf#L15) | M4CE connector OVA image configuration parameters | object({…}) | | {…} | -| [m4ce_connector_ovf_url](variables.tf#L37) | http URL to the public M4CE connector OVA image | string | | "https://storage.googleapis.com/vmmigration-public-artifacts/migrate-connector-2-0-1663.ova" | +| [vsphere_environment](variables.tf#L53) | VMVware VSphere connection parameters. | object({…}) | ✓ | | +| [m4ce_appliance_properties](variables.tf#L15) | M4CE connector OVA image configuration parameters. | object({…}) | | {…} | +| [m4ce_connector_ovf_url](variables.tf#L37) | http URL to the public M4CE connector OVA image. | string | | "https://storage.googleapis.com/vmmigration-public-artifacts/migrate-connector-2-0-1663.ova" | ## Manual Steps diff --git a/blueprints/cloud-operations/vm-migration/esxi/variables.tf b/blueprints/cloud-operations/vm-migration/esxi/variables.tf index ba886d43f8..34d2157be3 100644 --- a/blueprints/cloud-operations/vm-migration/esxi/variables.tf +++ b/blueprints/cloud-operations/vm-migration/esxi/variables.tf @@ -13,7 +13,7 @@ # limitations under the License. variable "m4ce_appliance_properties" { - description = "M4CE connector OVA image configuration parameters" + description = "M4CE connector OVA image configuration parameters." type = object({ hostname = string ip0 = string @@ -35,13 +35,13 @@ variable "m4ce_appliance_properties" { } variable "m4ce_connector_ovf_url" { - description = "http URL to the public M4CE connector OVA image" + description = "http URL to the public M4CE connector OVA image." type = string default = "https://storage.googleapis.com/vmmigration-public-artifacts/migrate-connector-2-0-1663.ova" } variable "m4ce_ssh_public_key" { - description = "Filesystem path to the public key for the SSH login" + description = "Filesystem path to the public key for the SSH login." type = string } @@ -51,7 +51,7 @@ variable "vcenter_password" { } variable "vsphere_environment" { - description = "VMVware VSphere connection parameters" + description = "VMVware VSphere connection parameters." type = object({ vcenter_ip = string vcenter_user = string diff --git a/blueprints/cloud-operations/vm-migration/host-target-projects/README.md b/blueprints/cloud-operations/vm-migration/host-target-projects/README.md index 241cf03ad8..c1d241824f 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-projects/README.md +++ b/blueprints/cloud-operations/vm-migration/host-target-projects/README.md @@ -25,16 +25,16 @@ This sample creates\updates several distinct groups of resources: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format | list(string) | ✓ | | -| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations | list(string) | ✓ | | -| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format | list(string) | | [] | -| [project_create](variables.tf#L31) | Parameters for the creation of the new project to host the M4CE backend | object({…}) | | null | -| [project_name](variables.tf#L40) | Name of an existing project or of the new project assigned as M4CE host project | string | | "m4ce-host-project-000" | +| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format. | list(string) | ✓ | | +| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations. | list(string) | ✓ | | +| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format. | list(string) | | [] | +| [project_create](variables.tf#L31) | Parameters for the creation of the new project to host the M4CE backend. | object({…}) | | null | +| [project_name](variables.tf#L40) | Name of an existing project or of the new project assigned as M4CE host project. | string | | "m4ce-host-project-000" | ## Outputs | name | description | sensitive | |---|---|:---:| -| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration.. It is used by M4CE to perform activities on target projects | | +| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration.. It is used by M4CE to perform activities on target projects. | | diff --git a/blueprints/cloud-operations/vm-migration/host-target-projects/outputs.tf b/blueprints/cloud-operations/vm-migration/host-target-projects/outputs.tf index ef78d4c7ca..2db8f1ae9e 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-projects/outputs.tf +++ b/blueprints/cloud-operations/vm-migration/host-target-projects/outputs.tf @@ -13,6 +13,6 @@ # limitations under the License. output "m4ce_gmanaged_service_account" { - description = "Google managed service account created automatically during the migrate connector registration.. It is used by M4CE to perform activities on target projects" + description = "Google managed service account created automatically during the migrate connector registration.. It is used by M4CE to perform activities on target projects." value = "serviceAccount:service-${module.host-project.number}@gcp-sa-vmmigration.iam.gserviceaccount.com" } diff --git a/blueprints/cloud-operations/vm-migration/host-target-projects/variables.tf b/blueprints/cloud-operations/vm-migration/host-target-projects/variables.tf index f6e3345f8c..c210fa3159 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-projects/variables.tf +++ b/blueprints/cloud-operations/vm-migration/host-target-projects/variables.tf @@ -13,23 +13,23 @@ # limitations under the License. variable "migration_admin_users" { - description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format" + description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format." type = list(string) } variable "migration_target_projects" { - description = "List of target projects for m4ce workload migrations" + description = "List of target projects for m4ce workload migrations." type = list(string) } variable "migration_viewer_users" { - description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format" + description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format." type = list(string) default = [] } variable "project_create" { - description = "Parameters for the creation of the new project to host the M4CE backend" + description = "Parameters for the creation of the new project to host the M4CE backend." type = object({ billing_account_id = string parent = string @@ -38,7 +38,7 @@ variable "project_create" { } variable "project_name" { - description = "Name of an existing project or of the new project assigned as M4CE host project" + description = "Name of an existing project or of the new project assigned as M4CE host project." type = string default = "m4ce-host-project-000" } diff --git a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/README.md b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/README.md index cc40135783..bb34cf8ff3 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/README.md +++ b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/README.md @@ -26,18 +26,18 @@ This sample creates\update several distinct groups of resources: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format | list(string) | ✓ | | -| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations | list(string) | ✓ | | -| [sharedvpc_host_projects](variables.tf#L45) | List of host projects that share a VPC with the selected target projects | list(string) | ✓ | | -| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format | list(string) | | [] | -| [project_create](variables.tf#L30) | Parameters for the creation of the new project to host the M4CE backend | object({…}) | | null | -| [project_name](variables.tf#L39) | Name of an existing project or of the new project assigned as M4CE host project | string | | "m4ce-host-project-000" | +| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format. | list(string) | ✓ | | +| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations. | list(string) | ✓ | | +| [sharedvpc_host_projects](variables.tf#L45) | List of host projects that share a VPC with the selected target projects. | list(string) | ✓ | | +| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format. | list(string) | | [] | +| [project_create](variables.tf#L30) | Parameters for the creation of the new project to host the M4CE backend. | object({…}) | | null | +| [project_name](variables.tf#L39) | Name of an existing project or of the new project assigned as M4CE host project. | string | | "m4ce-host-project-000" | ## Outputs | name | description | sensitive | |---|---|:---:| -| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects | | +| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects. | | ## Manual Steps diff --git a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/outputs.tf b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/outputs.tf index 3e6d553dc4..c772de5f6e 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/outputs.tf +++ b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/outputs.tf @@ -13,6 +13,6 @@ # limitations under the License. output "m4ce_gmanaged_service_account" { - description = "Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects" + description = "Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects." value = "serviceAccount:service-${module.host-project.number}@gcp-sa-vmmigration.iam.gserviceaccount.com" } diff --git a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/variables.tf b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/variables.tf index 85f333ce05..c01740dc47 100644 --- a/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/variables.tf +++ b/blueprints/cloud-operations/vm-migration/host-target-sharedvpc/variables.tf @@ -13,22 +13,22 @@ # limitations under the License. variable "migration_admin_users" { - description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format" + description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format." type = list(string) } variable "migration_target_projects" { - description = "List of target projects for m4ce workload migrations" + description = "List of target projects for m4ce workload migrations." type = list(string) } variable "migration_viewer_users" { - description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format" + description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format." type = list(string) default = [] } variable "project_create" { - description = "Parameters for the creation of the new project to host the M4CE backend" + description = "Parameters for the creation of the new project to host the M4CE backend." type = object({ billing_account_id = string parent = string @@ -37,12 +37,12 @@ variable "project_create" { } variable "project_name" { - description = "Name of an existing project or of the new project assigned as M4CE host project" + description = "Name of an existing project or of the new project assigned as M4CE host project." type = string default = "m4ce-host-project-000" } variable "sharedvpc_host_projects" { - description = "List of host projects that share a VPC with the selected target projects" + description = "List of host projects that share a VPC with the selected target projects." type = list(string) } diff --git a/blueprints/cloud-operations/vm-migration/single-project/README.md b/blueprints/cloud-operations/vm-migration/single-project/README.md index 85f3164abb..20afd4a9b4 100644 --- a/blueprints/cloud-operations/vm-migration/single-project/README.md +++ b/blueprints/cloud-operations/vm-migration/single-project/README.md @@ -26,16 +26,16 @@ This sample creates several distinct groups of resources: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format | list(string) | ✓ | | -| [migration_viewer_users](variables.tf#L20) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format | list(string) | | [] | -| [project_create](variables.tf#L26) | Parameters for the creation of the new project to host the M4CE backend | object({…}) | | null | -| [project_name](variables.tf#L35) | Name of an existing project or of the new project assigned as M4CE host an target project | string | | "m4ce-host-project-000" | -| [vpc_config](variables.tf#L41) | Parameters to create a simple VPC on the M4CE project | object({…}) | | {…} | +| [migration_admin_users](variables.tf#L15) | List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format. | list(string) | ✓ | | +| [migration_viewer_users](variables.tf#L20) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format. | list(string) | | [] | +| [project_create](variables.tf#L26) | Parameters for the creation of the new project to host the M4CE backend. | object({…}) | | null | +| [project_name](variables.tf#L35) | Name of an existing project or of the new project assigned as M4CE host an target project. | string | | "m4ce-host-project-000" | +| [vpc_config](variables.tf#L41) | Parameters to create a simple VPC on the M4CE project. | object({…}) | | {…} | ## Outputs | name | description | sensitive | |---|---|:---:| -| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects | | +| [m4ce_gmanaged_service_account](outputs.tf#L15) | Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects. | | diff --git a/blueprints/cloud-operations/vm-migration/single-project/outputs.tf b/blueprints/cloud-operations/vm-migration/single-project/outputs.tf index 347eb54fc5..269bb2bd52 100644 --- a/blueprints/cloud-operations/vm-migration/single-project/outputs.tf +++ b/blueprints/cloud-operations/vm-migration/single-project/outputs.tf @@ -13,6 +13,6 @@ # limitations under the License. output "m4ce_gmanaged_service_account" { - description = "Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects" + description = "Google managed service account created automatically during the migrate connector registration. It is used by M4CE to perform activities on target projects." value = "serviceAccount:service-${module.landing-project.number}@gcp-sa-vmmigration.iam.gserviceaccount.com" } diff --git a/blueprints/cloud-operations/vm-migration/single-project/variables.tf b/blueprints/cloud-operations/vm-migration/single-project/variables.tf index 2d7214f47d..3335254f23 100644 --- a/blueprints/cloud-operations/vm-migration/single-project/variables.tf +++ b/blueprints/cloud-operations/vm-migration/single-project/variables.tf @@ -13,18 +13,18 @@ # limitations under the License. variable "migration_admin_users" { - description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format" + description = "List of users authorized to create a new M4CE sources and perform all other migration operations, in IAM format." type = list(string) } variable "migration_viewer_users" { - description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format" + description = "List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format." type = list(string) default = [] } variable "project_create" { - description = "Parameters for the creation of the new project to host the M4CE backend" + description = "Parameters for the creation of the new project to host the M4CE backend." type = object({ billing_account_id = string parent = string @@ -33,13 +33,13 @@ variable "project_create" { } variable "project_name" { - description = "Name of an existing project or of the new project assigned as M4CE host an target project" + description = "Name of an existing project or of the new project assigned as M4CE host an target project." type = string default = "m4ce-host-project-000" } variable "vpc_config" { - description = "Parameters to create a simple VPC on the M4CE project" + description = "Parameters to create a simple VPC on the M4CE project." type = object({ ip_cidr_range = string, region = string diff --git a/blueprints/data-solutions/cloudsql-multiregion/README.md b/blueprints/data-solutions/cloudsql-multiregion/README.md index 821d9a844b..d6420d6c91 100644 --- a/blueprints/data-solutions/cloudsql-multiregion/README.md +++ b/blueprints/data-solutions/cloudsql-multiregion/README.md @@ -151,7 +151,7 @@ The above command will delete the associated resources so there will be no billa | [project_create](variables.tf#L54) | Provide values if project creation is needed, uses existing project if null. Parent is in 'folders/nnn' or 'organizations/nnn' format. | object({…}) | | null | | [regions](variables.tf#L68) | Map of instance_name => location where instances will be deployed. | map(string) | | {…} | | [service_encryption_keys](variables.tf#L81) | Cloud KMS keys to use to encrypt resources. Provide a key for each reagion configured. | map(string) | | null | -| [sql_configuration](variables.tf#L87) | Cloud SQL configuration | object({…}) | | {…} | +| [sql_configuration](variables.tf#L87) | Cloud SQL configuration. | object({…}) | | {…} | ## Outputs diff --git a/blueprints/data-solutions/cloudsql-multiregion/variables.tf b/blueprints/data-solutions/cloudsql-multiregion/variables.tf index d05f1bac74..6542779294 100644 --- a/blueprints/data-solutions/cloudsql-multiregion/variables.tf +++ b/blueprints/data-solutions/cloudsql-multiregion/variables.tf @@ -85,7 +85,7 @@ variable "service_encryption_keys" { } variable "sql_configuration" { - description = "Cloud SQL configuration" + description = "Cloud SQL configuration." type = object({ availability_type = string database_version = string diff --git a/blueprints/data-solutions/data-playground/README.md b/blueprints/data-solutions/data-playground/README.md index 79455dd3d0..ecc12973ad 100644 --- a/blueprints/data-solutions/data-playground/README.md +++ b/blueprints/data-solutions/data-playground/README.md @@ -50,7 +50,7 @@ You can now connect to the Vertex AI notbook to perform your data analysy. | [prefix](variables.tf#L22) | Prefix used for resource names. | string | ✓ | | | [project_id](variables.tf#L40) | Project id, references existing project if `project_create` is null. | string | ✓ | | | [location](variables.tf#L16) | The location where resources will be deployed. | string | | "EU" | -| [project_create](variables.tf#L31) | Provide values if project creation is needed, uses existing project if null. Parent format: folders/folder_id or organizations/org_id | object({…}) | | null | +| [project_create](variables.tf#L31) | Provide values if project creation is needed, uses existing project if null. Parent format: folders/folder_id or organizations/org_id. | object({…}) | | null | | [region](variables.tf#L45) | The region where resources will be deployed. | string | | "europe-west1" | | [vpc_config](variables.tf#L61) | Parameters to create a VPC. | object({…}) | | {…} | @@ -61,7 +61,7 @@ You can now connect to the Vertex AI notbook to perform your data analysy. | [bucket](outputs.tf#L15) | GCS Bucket URL. | | | [dataset](outputs.tf#L20) | GCS Bucket URL. | | | [notebook](outputs.tf#L25) | Vertex AI notebook details. | | -| [project](outputs.tf#L33) | Project id | | -| [vpc](outputs.tf#L38) | VPC Network | | +| [project](outputs.tf#L33) | Project id. | | +| [vpc](outputs.tf#L38) | VPC Network. | | diff --git a/blueprints/data-solutions/data-playground/outputs.tf b/blueprints/data-solutions/data-playground/outputs.tf index 03db250609..4b80c311c5 100644 --- a/blueprints/data-solutions/data-playground/outputs.tf +++ b/blueprints/data-solutions/data-playground/outputs.tf @@ -31,11 +31,11 @@ output "notebook" { } output "project" { - description = "Project id" + description = "Project id." value = module.project.project_id } output "vpc" { - description = "VPC Network" + description = "VPC Network." value = module.vpc.name } diff --git a/blueprints/data-solutions/data-playground/variables.tf b/blueprints/data-solutions/data-playground/variables.tf index 5ee6642380..1735406733 100644 --- a/blueprints/data-solutions/data-playground/variables.tf +++ b/blueprints/data-solutions/data-playground/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 format: folders/folder_id or organizations/org_id" + description = "Provide values if project creation is needed, uses existing project if null. Parent format: folders/folder_id or organizations/org_id." type = object({ billing_account_id = string parent = string diff --git a/blueprints/data-solutions/sqlserver-alwayson/README.md b/blueprints/data-solutions/sqlserver-alwayson/README.md index f3ef9d8514..1ce4dad7d4 100644 --- a/blueprints/data-solutions/sqlserver-alwayson/README.md +++ b/blueprints/data-solutions/sqlserver-alwayson/README.md @@ -35,37 +35,37 @@ and to `C:\GcpSetupLog.txt` file. | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [ad_domain_fqdn](variables.tf#L15) | Active Directory domain (FQDN) | string | ✓ | | -| [ad_domain_netbios](variables.tf#L24) | Active Directory domain (NetBIOS) | string | ✓ | | -| [network](variables.tf#L90) | Network to use in the project | string | ✓ | | +| [ad_domain_fqdn](variables.tf#L15) | Active Directory domain (FQDN). | string | ✓ | | +| [ad_domain_netbios](variables.tf#L24) | Active Directory domain (NetBIOS). | string | ✓ | | +| [network](variables.tf#L90) | Network to use in the project. | string | ✓ | | | [prefix](variables.tf#L113) | Prefix used for resource names. | string | ✓ | | -| [project_id](variables.tf#L131) | Google Cloud project ID | string | ✓ | | -| [sql_admin_password](variables.tf#L148) | Password for the SQL admin user to be created | string | ✓ | | -| [subnetwork](variables.tf#L163) | Subnetwork to use in the project | string | ✓ | | -| [always_on_groups](variables.tf#L33) | List of Always On Groups | list(string) | | ["bookshelf"] | -| [boot_disk_size](variables.tf#L39) | Boot disk size in GB | number | | 50 | -| [cluster_name](variables.tf#L45) | Cluster name (prepended with prefix) | string | | "cluster" | -| [data_disk_size](variables.tf#L51) | Database disk size in GB | number | | 200 | -| [health_check_config](variables.tf#L57) | Health check configuration | … | | {…} | -| [health_check_port](variables.tf#L72) | Health check port | number | | 59997 | -| [health_check_ranges](variables.tf#L78) | Health check ranges | list(string) | | ["35.191.0.0/16", "209.85.152.0/22", "209.85.204.0/22"] | -| [managed_ad_dn](variables.tf#L84) | Managed Active Directory domain (eg. OU=Cloud,DC=example,DC=com) | string | | "" | -| [node_image](variables.tf#L95) | SQL Server node machine image | string | | "projects/windows-sql-cloud/global/images/family/sql-ent-2019-win-2019" | -| [node_instance_type](variables.tf#L101) | SQL Server database node instance type | string | | "n2-standard-8" | -| [node_name](variables.tf#L107) | Node base name | string | | "node" | +| [project_id](variables.tf#L131) | Google Cloud project ID. | string | ✓ | | +| [sql_admin_password](variables.tf#L148) | Password for the SQL admin user to be created. | string | ✓ | | +| [subnetwork](variables.tf#L163) | Subnetwork to use in the project. | string | ✓ | | +| [always_on_groups](variables.tf#L33) | List of Always On Groups. | list(string) | | ["bookshelf"] | +| [boot_disk_size](variables.tf#L39) | Boot disk size in GB. | number | | 50 | +| [cluster_name](variables.tf#L45) | Cluster name (prepended with prefix). | string | | "cluster" | +| [data_disk_size](variables.tf#L51) | Database disk size in GB. | number | | 200 | +| [health_check_config](variables.tf#L57) | Health check configuration. | … | | {…} | +| [health_check_port](variables.tf#L72) | Health check port. | number | | 59997 | +| [health_check_ranges](variables.tf#L78) | Health check ranges. | list(string) | | ["35.191.0.0/16", "209.85.152.0/22", "209.85.204.0/22"] | +| [managed_ad_dn](variables.tf#L84) | Managed Active Directory domain (eg. OU=Cloud,DC=example,DC=com). | string | | "" | +| [node_image](variables.tf#L95) | SQL Server node machine image. | string | | "projects/windows-sql-cloud/global/images/family/sql-ent-2019-win-2019" | +| [node_instance_type](variables.tf#L101) | SQL Server database node instance type. | string | | "n2-standard-8" | +| [node_name](variables.tf#L107) | Node base name. | string | | "node" | | [project_create](variables.tf#L122) | 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#L136) | Region for resources | string | | "europe-west4" | -| [shared_vpc_project_id](variables.tf#L142) | Shared VPC project ID for firewall rules | string | | null | -| [sql_client_cidrs](variables.tf#L157) | CIDR ranges that are allowed to connect to SQL Server | list(string) | | ["0.0.0.0/0"] | +| [region](variables.tf#L136) | Region for resources. | string | | "europe-west4" | +| [shared_vpc_project_id](variables.tf#L142) | Shared VPC project ID for firewall rules. | string | | null | +| [sql_client_cidrs](variables.tf#L157) | CIDR ranges that are allowed to connect to SQL Server. | list(string) | | ["0.0.0.0/0"] | | [vpc_ip_cidr_range](variables.tf#L168) | Ip range used in the subnet deployef in the Service Project. | string | | "10.0.0.0/20" | -| [witness_image](variables.tf#L174) | SQL Server witness machine image | string | | "projects/windows-cloud/global/images/family/windows-2019" | -| [witness_instance_type](variables.tf#L180) | SQL Server witness node instance type | string | | "n2-standard-2" | -| [witness_name](variables.tf#L186) | Witness base name | string | | "witness" | +| [witness_image](variables.tf#L174) | SQL Server witness machine image. | string | | "projects/windows-cloud/global/images/family/windows-2019" | +| [witness_instance_type](variables.tf#L180) | SQL Server witness node instance type. | string | | "n2-standard-2" | +| [witness_name](variables.tf#L186) | Witness base name. | string | | "witness" | ## Outputs | name | description | sensitive | |---|---|:---:| -| [instructions](outputs.tf#L19) | | | +| [instructions](outputs.tf#L19) | List of steps to follow after applying. | | diff --git a/blueprints/data-solutions/sqlserver-alwayson/outputs.tf b/blueprints/data-solutions/sqlserver-alwayson/outputs.tf index 2d09476357..1856f823c1 100644 --- a/blueprints/data-solutions/sqlserver-alwayson/outputs.tf +++ b/blueprints/data-solutions/sqlserver-alwayson/outputs.tf @@ -17,7 +17,8 @@ locals { } output "instructions" { - value = < 0 @@ -22,7 +22,7 @@ variable "ad_domain_fqdn" { } variable "ad_domain_netbios" { - description = "Active Directory domain (NetBIOS)" + description = "Active Directory domain (NetBIOS)." type = string validation { condition = length(var.ad_domain_netbios) > 0 @@ -31,31 +31,31 @@ variable "ad_domain_netbios" { } variable "always_on_groups" { - description = "List of Always On Groups" + description = "List of Always On Groups." type = list(string) default = ["bookshelf"] } variable "boot_disk_size" { - description = "Boot disk size in GB" + description = "Boot disk size in GB." type = number default = 50 } variable "cluster_name" { - description = "Cluster name (prepended with prefix)" + description = "Cluster name (prepended with prefix)." type = string default = "cluster" } variable "data_disk_size" { - description = "Database disk size in GB" + description = "Database disk size in GB." type = number default = 200 } variable "health_check_config" { - description = "Health check configuration" + description = "Health check configuration." type = object({ check_interval_sec = number, healthy_threshold = number, unhealthy_threshold = number, @@ -70,42 +70,42 @@ variable "health_check_config" { } variable "health_check_port" { - description = "Health check port" + description = "Health check port." type = number default = 59997 } variable "health_check_ranges" { - description = "Health check ranges" + description = "Health check ranges." type = list(string) default = ["35.191.0.0/16", "209.85.152.0/22", "209.85.204.0/22"] } variable "managed_ad_dn" { - description = "Managed Active Directory domain (eg. OU=Cloud,DC=example,DC=com)" + description = "Managed Active Directory domain (eg. OU=Cloud,DC=example,DC=com)." type = string default = "" } variable "network" { - description = "Network to use in the project" + description = "Network to use in the project." type = string } variable "node_image" { - description = "SQL Server node machine image" + description = "SQL Server node machine image." type = string default = "projects/windows-sql-cloud/global/images/family/sql-ent-2019-win-2019" } variable "node_instance_type" { - description = "SQL Server database node instance type" + description = "SQL Server database node instance type." type = string default = "n2-standard-8" } variable "node_name" { - description = "Node base name" + description = "Node base name." type = string default = "node" } @@ -129,24 +129,24 @@ variable "project_create" { } variable "project_id" { - description = "Google Cloud project ID" + description = "Google Cloud project ID." type = string } variable "region" { - description = "Region for resources" + description = "Region for resources." type = string default = "europe-west4" } variable "shared_vpc_project_id" { - description = "Shared VPC project ID for firewall rules" + description = "Shared VPC project ID for firewall rules." type = string default = null } variable "sql_admin_password" { - description = "Password for the SQL admin user to be created" + description = "Password for the SQL admin user to be created." type = string validation { condition = length(var.sql_admin_password) > 0 @@ -155,13 +155,13 @@ variable "sql_admin_password" { } variable "sql_client_cidrs" { - description = "CIDR ranges that are allowed to connect to SQL Server" + description = "CIDR ranges that are allowed to connect to SQL Server." type = list(string) default = ["0.0.0.0/0"] } variable "subnetwork" { - description = "Subnetwork to use in the project" + description = "Subnetwork to use in the project." type = string } @@ -172,19 +172,19 @@ variable "vpc_ip_cidr_range" { } variable "witness_image" { - description = "SQL Server witness machine image" + description = "SQL Server witness machine image." type = string default = "projects/windows-cloud/global/images/family/windows-2019" } variable "witness_instance_type" { - description = "SQL Server witness node instance type" + description = "SQL Server witness node instance type." type = string default = "n2-standard-2" } variable "witness_name" { - description = "Witness base name" + description = "Witness base name." type = string default = "witness" } diff --git a/blueprints/factories/bigquery-factory/README.md b/blueprints/factories/bigquery-factory/README.md index 3f1acc4a77..05cabffb22 100644 --- a/blueprints/factories/bigquery-factory/README.md +++ b/blueprints/factories/bigquery-factory/README.md @@ -73,7 +73,7 @@ deletion_protection: bool # not required, defaults to false | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [project_id](variables.tf#L17) | Project ID | string | ✓ | | +| [project_id](variables.tf#L17) | Project ID. | string | ✓ | | | [tables_dir](variables.tf#L22) | Relative path for the folder storing table data. | string | ✓ | | | [views_dir](variables.tf#L27) | Relative path for the folder storing view data. | string | ✓ | | diff --git a/blueprints/factories/bigquery-factory/variables.tf b/blueprints/factories/bigquery-factory/variables.tf index cd34f02bd0..774ec86e1c 100644 --- a/blueprints/factories/bigquery-factory/variables.tf +++ b/blueprints/factories/bigquery-factory/variables.tf @@ -15,7 +15,7 @@ */ variable "project_id" { - description = "Project ID" + description = "Project ID." type = string } diff --git a/blueprints/factories/project-factory/README.md b/blueprints/factories/project-factory/README.md index b749bcbce9..a5680781a2 100644 --- a/blueprints/factories/project-factory/README.md +++ b/blueprints/factories/project-factory/README.md @@ -238,8 +238,8 @@ vpc: | [org_policies](variables.tf#L111) | Org-policy overrides at project level. | map(object({…})) | | {} | | [service_accounts](variables.tf#L165) | Service accounts to be created, and roles assigned them on the project. | map(list(string)) | | {} | | [service_accounts_additive](variables.tf#L171) | Service accounts to be created, and roles assigned them on the project additively. | map(list(string)) | | {} | -| [service_accounts_iam](variables.tf#L177) | IAM bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]} | map(map(list(string))) | | {} | -| [service_accounts_iam_additive](variables.tf#L184) | IAM additive bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]} | map(map(list(string))) | | {} | +| [service_accounts_iam](variables.tf#L177) | IAM bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}. | map(map(list(string))) | | {} | +| [service_accounts_iam_additive](variables.tf#L184) | IAM additive bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}. | map(map(list(string))) | | {} | | [service_identities_iam](variables.tf#L191) | Custom IAM settings for service identities in service => [role] format. | map(list(string)) | | {} | | [service_identities_iam_additive](variables.tf#L198) | Custom additive IAM settings for service identities in service => [role] format. | map(list(string)) | | {} | | [services](variables.tf#L205) | Services to be enabled for the project. | list(string) | | [] | @@ -249,7 +249,7 @@ vpc: | name | description | sensitive | |---|---|:---:| -| [project](outputs.tf#L19) | The project resource as return by the `project` module | | +| [project](outputs.tf#L19) | The project resource as return by the `project` module. | | | [project_id](outputs.tf#L29) | Project ID. | | diff --git a/blueprints/factories/project-factory/outputs.tf b/blueprints/factories/project-factory/outputs.tf index a60ad457fd..a989eaba86 100644 --- a/blueprints/factories/project-factory/outputs.tf +++ b/blueprints/factories/project-factory/outputs.tf @@ -17,7 +17,7 @@ # TODO(): proper outputs output "project" { - description = "The project resource as return by the `project` module" + description = "The project resource as return by the `project` module." value = module.project depends_on = [ diff --git a/blueprints/factories/project-factory/variables.tf b/blueprints/factories/project-factory/variables.tf index 034974f279..0ece0f0423 100644 --- a/blueprints/factories/project-factory/variables.tf +++ b/blueprints/factories/project-factory/variables.tf @@ -175,14 +175,14 @@ variable "service_accounts_additive" { } variable "service_accounts_iam" { - description = "IAM bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}" + description = "IAM bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}." type = map(map(list(string))) default = {} nullable = false } variable "service_accounts_iam_additive" { - description = "IAM additive bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}" + description = "IAM additive bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}." type = map(map(list(string))) default = {} nullable = false diff --git a/blueprints/gke/multi-cluster-mesh-gke-fleet-api/README.md b/blueprints/gke/multi-cluster-mesh-gke-fleet-api/README.md index 7deafdadaa..7d43bd4011 100644 --- a/blueprints/gke/multi-cluster-mesh-gke-fleet-api/README.md +++ b/blueprints/gke/multi-cluster-mesh-gke-fleet-api/README.md @@ -69,8 +69,8 @@ Once done testing, you can clean up resources by running `terraform destroy`. | [mgmt_project_id](variables.tf#L63) | Management Project ID. | string | ✓ | | | [parent](variables.tf#L94) | Parent. | string | ✓ | | | [clusters_config](variables.tf#L22) | Clusters configuration. | map(object({…})) | | {…} | -| [istio_version](variables.tf#L57) | ASM version | string | | "1.14.1-asm.3" | -| [mgmt_server_config](variables.tf#L68) | Mgmt server configuration | object({…}) | | {…} | +| [istio_version](variables.tf#L57) | ASM version. | string | | "1.14.1-asm.3" | +| [mgmt_server_config](variables.tf#L68) | Mgmt server configuration. | object({…}) | | {…} | | [mgmt_subnet_cidr_block](variables.tf#L88) | Management subnet CIDR block. | string | | "10.0.0.0/28" | | [region](variables.tf#L99) | Region. | string | | "europe-west1" | diff --git a/blueprints/gke/multi-cluster-mesh-gke-fleet-api/variables.tf b/blueprints/gke/multi-cluster-mesh-gke-fleet-api/variables.tf index 4cff10fb5e..428778f264 100644 --- a/blueprints/gke/multi-cluster-mesh-gke-fleet-api/variables.tf +++ b/blueprints/gke/multi-cluster-mesh-gke-fleet-api/variables.tf @@ -55,7 +55,7 @@ variable "host_project_id" { variable "istio_version" { - description = "ASM version" + description = "ASM version." type = string default = "1.14.1-asm.3" } @@ -66,7 +66,7 @@ variable "mgmt_project_id" { } variable "mgmt_server_config" { - description = "Mgmt server configuration" + description = "Mgmt server configuration." type = object({ disk_size = number disk_type = string diff --git a/blueprints/networking/nginx-reverse-proxy-cluster/README.md b/blueprints/networking/nginx-reverse-proxy-cluster/README.md index 3a957d2c81..6e469a8db0 100644 --- a/blueprints/networking/nginx-reverse-proxy-cluster/README.md +++ b/blueprints/networking/nginx-reverse-proxy-cluster/README.md @@ -17,20 +17,20 @@ There is a simple [`Dockerfile`](Dockerfile) available for building Ops Agent to | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [autoscaling_metric](variables.tf#L31) | | object({…} | ✓ | | -| [prefix](variables.tf#L93) | Prefix used for resource names. | string | ✓ | | -| [project_name](variables.tf#L111) | Name of an existing project or of the new project | string | ✓ | | +| [autoscaling_metric](variables.tf#L31) | Definition of metric to use for scaling. | object({…} | ✓ | | +| [prefix](variables.tf#L94) | Prefix used for resource names. | string | ✓ | | +| [project_name](variables.tf#L112) | Name of an existing project or of the new project. | string | ✓ | | | [autoscaling](variables.tf#L17) | Autoscaling configuration for the instance group. | object({…}) | | {…} | -| [backends](variables.tf#L49) | Nginx locations configurations to proxy traffic to. | string | | "<<-EOT…EOT" | -| [cidrs](variables.tf#L61) | Subnet IP CIDR ranges. | map(string) | | {…} | -| [network](variables.tf#L69) | Network name. | string | | "reverse-proxy-vpc" | -| [network_create](variables.tf#L75) | Create network or use existing one. | bool | | true | -| [nginx_image](variables.tf#L81) | Nginx container image to use. | string | | "gcr.io/cloud-marketplace/google/nginx1:latest" | -| [ops_agent_image](variables.tf#L87) | Google Cloud Ops Agent container image to use. | string | | "gcr.io/sfans-hub-project-d647/ops-agent:latest" | -| [project_create](variables.tf#L102) | Parameters for the creation of the new project | object({…}) | | null | -| [region](variables.tf#L116) | Default region for resources. | string | | "europe-west4" | -| [subnetwork](variables.tf#L122) | Subnetwork name. | string | | "gce" | -| [tls](variables.tf#L128) | Also offer reverse proxying with TLS (self-signed certificate). | bool | | false | +| [backends](variables.tf#L50) | Nginx locations configurations to proxy traffic to. | string | | "<<-EOT…EOT" | +| [cidrs](variables.tf#L62) | Subnet IP CIDR ranges. | map(string) | | {…} | +| [network](variables.tf#L70) | Network name. | string | | "reverse-proxy-vpc" | +| [network_create](variables.tf#L76) | Create network or use existing one. | bool | | true | +| [nginx_image](variables.tf#L82) | Nginx container image to use. | string | | "gcr.io/cloud-marketplace/google/nginx1:latest" | +| [ops_agent_image](variables.tf#L88) | Google Cloud Ops Agent container image to use. | string | | "gcr.io/sfans-hub-project-d647/ops-agent:latest" | +| [project_create](variables.tf#L103) | Parameters for the creation of the new project. | object({…}) | | null | +| [region](variables.tf#L117) | Default region for resources. | string | | "europe-west4" | +| [subnetwork](variables.tf#L123) | Subnetwork name. | string | | "gce" | +| [tls](variables.tf#L129) | Also offer reverse proxying with TLS (self-signed certificate). | bool | | false | ## Outputs diff --git a/blueprints/networking/nginx-reverse-proxy-cluster/variables.tf b/blueprints/networking/nginx-reverse-proxy-cluster/variables.tf index 92eebae79e..286bbcbebb 100644 --- a/blueprints/networking/nginx-reverse-proxy-cluster/variables.tf +++ b/blueprints/networking/nginx-reverse-proxy-cluster/variables.tf @@ -29,6 +29,7 @@ variable "autoscaling" { } variable "autoscaling_metric" { + description = "Definition of metric to use for scaling." type = object({ name = string single_instance_assignment = number @@ -100,7 +101,7 @@ variable "prefix" { } variable "project_create" { - description = "Parameters for the creation of the new project" + description = "Parameters for the creation of the new project." type = object({ billing_account_id = string parent = string @@ -109,7 +110,7 @@ variable "project_create" { } variable "project_name" { - description = "Name of an existing project or of the new project" + description = "Name of an existing project or of the new project." type = string } diff --git a/blueprints/third-party-solutions/wordpress/cloudrun/README.md b/blueprints/third-party-solutions/wordpress/cloudrun/README.md index b9a2306f49..0ffcc395c2 100644 --- a/blueprints/third-party-solutions/wordpress/cloudrun/README.md +++ b/blueprints/third-party-solutions/wordpress/cloudrun/README.md @@ -123,25 +123,25 @@ The above command will delete the associated resources so there will be no billa |---|---|:---:|:---:|:---:| | [prefix](variables.tf#L57) | Prefix used for resource names. | string | ✓ | | | [project_id](variables.tf#L81) | Project id, references existing project if `project_create` is null. | string | ✓ | | -| [wordpress_image](variables.tf#L92) | Image to run with Cloud Run, starts with \"gcr.io\" | string | ✓ | | -| [cloud_run_invoker](variables.tf#L18) | IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone) | string | | "allUsers" | -| [cloudsql_password](variables.tf#L24) | CloudSQL password (will be randomly generated by default) | string | | null | -| [connector](variables.tf#L30) | Existing VPC serverless connector to use if not creating a new one | string | | null | -| [create_connector](variables.tf#L36) | Should a VPC serverless connector be created or not | bool | | true | -| [ip_ranges](variables.tf#L43) | CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC | object({…}) | | {…} | +| [wordpress_image](variables.tf#L92) | Image to run with Cloud Run, starts with \"gcr.io\". | string | ✓ | | +| [cloud_run_invoker](variables.tf#L18) | IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone). | string | | "allUsers" | +| [cloudsql_password](variables.tf#L24) | CloudSQL password (will be randomly generated by default). | string | | null | +| [connector](variables.tf#L30) | Existing VPC serverless connector to use if not creating a new one. | string | | null | +| [create_connector](variables.tf#L36) | Should a VPC serverless connector be created or not. | bool | | true | +| [ip_ranges](variables.tf#L43) | CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC. | object({…}) | | {…} | | [principals](variables.tf#L66) | List of users to give rights to (CloudSQL admin, client and instanceUser, Logging admin, Service Account User and TokenCreator), eg 'user@domain.com'. | list(string) | | [] | | [project_create](variables.tf#L72) | 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#L86) | Region for the created resources | string | | "europe-west4" | -| [wordpress_password](variables.tf#L97) | Password for the Wordpress user (will be randomly generated by default) | string | | null | -| [wordpress_port](variables.tf#L103) | Port for the Wordpress image | number | | 8080 | +| [region](variables.tf#L86) | Region for the created resources. | string | | "europe-west4" | +| [wordpress_password](variables.tf#L97) | Password for the Wordpress user (will be randomly generated by default). | string | | null | +| [wordpress_port](variables.tf#L103) | Port for the Wordpress image. | number | | 8080 | ## Outputs | name | description | sensitive | |---|---|:---:| -| [cloud_run_service](outputs.tf#L17) | CloudRun service URL | ✓ | -| [cloudsql_password](outputs.tf#L23) | CloudSQL password | ✓ | -| [wp_password](outputs.tf#L29) | Wordpress user password | ✓ | -| [wp_user](outputs.tf#L35) | Wordpress username | | +| [cloud_run_service](outputs.tf#L17) | CloudRun service URL. | ✓ | +| [cloudsql_password](outputs.tf#L23) | CloudSQL password. | ✓ | +| [wp_password](outputs.tf#L29) | Wordpress user password. | ✓ | +| [wp_user](outputs.tf#L35) | Wordpress username. | | diff --git a/blueprints/third-party-solutions/wordpress/cloudrun/outputs.tf b/blueprints/third-party-solutions/wordpress/cloudrun/outputs.tf index 3216f79ee0..b08642c7b1 100644 --- a/blueprints/third-party-solutions/wordpress/cloudrun/outputs.tf +++ b/blueprints/third-party-solutions/wordpress/cloudrun/outputs.tf @@ -15,24 +15,24 @@ */ output "cloud_run_service" { - description = "CloudRun service URL" + description = "CloudRun service URL." value = module.cloud_run.service.status[0].url sensitive = true } output "cloudsql_password" { - description = "CloudSQL password" + description = "CloudSQL password." value = var.cloudsql_password == null ? module.cloudsql.user_passwords[local.cloudsql_conf.user] : var.cloudsql_password sensitive = true } output "wp_password" { - description = "Wordpress user password" + description = "Wordpress user password." value = local.wp_pass sensitive = true } output "wp_user" { - description = "Wordpress username" + description = "Wordpress username." value = local.wp_user } diff --git a/blueprints/third-party-solutions/wordpress/cloudrun/variables.tf b/blueprints/third-party-solutions/wordpress/cloudrun/variables.tf index 2327839a7a..abb00d2d1c 100644 --- a/blueprints/third-party-solutions/wordpress/cloudrun/variables.tf +++ b/blueprints/third-party-solutions/wordpress/cloudrun/variables.tf @@ -17,31 +17,31 @@ # Documentation: https://cloud.google.com/run/docs/securing/managing-access#making_a_service_public variable "cloud_run_invoker" { type = string - description = "IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone)" + description = "IAM member authorized to access the end-point (for example, 'user:YOUR_IAM_USER' for only you or 'allUsers' for everyone)." default = "allUsers" } variable "cloudsql_password" { type = string - description = "CloudSQL password (will be randomly generated by default)" + description = "CloudSQL password (will be randomly generated by default)." default = null } variable "connector" { type = string - description = "Existing VPC serverless connector to use if not creating a new one" + description = "Existing VPC serverless connector to use if not creating a new one." default = null } variable "create_connector" { type = bool - description = "Should a VPC serverless connector be created or not" + description = "Should a VPC serverless connector be created or not." default = true } # PSA: documentation: https://cloud.google.com/vpc/docs/configure-private-services-access#allocating-range variable "ip_ranges" { - description = "CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC" + description = "CIDR blocks: VPC serverless connector, Private Service Access(PSA) for CloudSQL, CloudSQL VPC." type = object({ connector = string psa = string @@ -85,23 +85,23 @@ variable "project_id" { variable "region" { type = string - description = "Region for the created resources" + description = "Region for the created resources." default = "europe-west4" } variable "wordpress_image" { type = string - description = "Image to run with Cloud Run, starts with \"gcr.io\"" + description = "Image to run with Cloud Run, starts with \"gcr.io\"." } variable "wordpress_password" { type = string - description = "Password for the Wordpress user (will be randomly generated by default)" + description = "Password for the Wordpress user (will be randomly generated by default)." default = null } variable "wordpress_port" { type = number - description = "Port for the Wordpress image" + description = "Port for the Wordpress image." default = 8080 } diff --git a/fast/stages/00-bootstrap/00-bootstrap-providers.tfx b/fast/stages/00-bootstrap/00-bootstrap-providers.tfx new file mode 120000 index 0000000000..7512a3823b --- /dev/null +++ b/fast/stages/00-bootstrap/00-bootstrap-providers.tfx @@ -0,0 +1 @@ +/Users/jccb/code/cloud-foundation-fabric/fast-configs/jccb/providers/00-bootstrap-providers.tf \ No newline at end of file diff --git a/fast/stages/00-bootstrap/README.md b/fast/stages/00-bootstrap/README.md index 2b8ffb1451..cf4bfd51d7 100644 --- a/fast/stages/00-bootstrap/README.md +++ b/fast/stages/00-bootstrap/README.md @@ -477,7 +477,7 @@ The remaining configuration is manual, as it regards the repositories themselves | [iam_additive](variables.tf#L152) | Organization-level custom IAM settings in role => [principal] format for non-authoritative bindings. | map(list(string)) | | {} | | | [locations](variables.tf#L158) | Optional locations for GCS, BigQuery, and logging buckets created here. | object({…}) | | {…} | | | [log_sinks](variables.tf#L177) | Org-level log sinks, in name => {type, filter} format. | map(object({…})) | | {…} | | -| [outputs_location](variables.tf#L211) | Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable | string | | null | | +| [outputs_location](variables.tf#L211) | Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable. | string | | null | | | [project_parent_ids](variables.tf#L227) | Optional parents for projects created here in folders/nnnnnnn format. Null values will use the organization as parent. | object({…}) | | {…} | | ## Outputs diff --git a/fast/stages/00-bootstrap/variables.tf b/fast/stages/00-bootstrap/variables.tf index 62d28abfde..0b9f37c20c 100644 --- a/fast/stages/00-bootstrap/variables.tf +++ b/fast/stages/00-bootstrap/variables.tf @@ -209,7 +209,7 @@ variable "organization" { } variable "outputs_location" { - description = "Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable" + description = "Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable." type = string default = null } diff --git a/fast/stages/01-resman/README.md b/fast/stages/01-resman/README.md index 449fa614f5..56772816a3 100644 --- a/fast/stages/01-resman/README.md +++ b/fast/stages/01-resman/README.md @@ -191,7 +191,7 @@ Due to its simplicity, this stage lends itself easily to customizations: adding | [groups](variables.tf#L164) | Group names to grant organization-level permissions. | map(string) | | {…} | 00-bootstrap | | [locations](variables.tf#L179) | Optional locations for GCS, BigQuery, and logging buckets created here. | object({…}) | | {…} | 00-bootstrap | | [organization_policy_configs](variables.tf#L207) | Organization policies customization. | object({…}) | | null | | -| [outputs_location](variables.tf#L215) | Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable | string | | null | | +| [outputs_location](variables.tf#L215) | Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable. | string | | null | | | [tag_names](variables.tf#L232) | Customized names for resource management tags. | object({…}) | | {…} | | | [team_folders](variables.tf#L249) | Team folders to be created. Format is described in a code comment. | map(object({…})) | | null | | diff --git a/fast/stages/01-resman/variables.tf b/fast/stages/01-resman/variables.tf index 6de9a7fad3..8b6f866bda 100644 --- a/fast/stages/01-resman/variables.tf +++ b/fast/stages/01-resman/variables.tf @@ -213,7 +213,7 @@ variable "organization_policy_configs" { } variable "outputs_location" { - description = "Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable" + description = "Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable." type = string default = null } diff --git a/fast/stages/02-networking-nva/README.md b/fast/stages/02-networking-nva/README.md index a8c9d95669..a72519b503 100644 --- a/fast/stages/02-networking-nva/README.md +++ b/fast/stages/02-networking-nva/README.md @@ -379,7 +379,7 @@ DNS configurations are centralised in the `dns-*.tf` files. Spokes delegate DNS | [custom_adv](variables.tf#L34) | Custom advertisement definitions in name => range format. | map(string) | | {…} | | | [custom_roles](variables.tf#L56) | Custom roles defined at the org level, in key => id format. | object({…}) | | null | 00-bootstrap | | [data_dir](variables.tf#L65) | Relative path for the folder storing configuration data for network resources. | string | | "data" | | -| [dns](variables.tf#L71) | Onprem DNS resolvers | map(list(string)) | | {…} | | +| [dns](variables.tf#L71) | Onprem DNS resolvers. | map(list(string)) | | {…} | | | [l7ilb_subnets](variables.tf#L89) | Subnets used for L7 ILBs. | map(list(object({…}))) | | {…} | | | [onprem_cidr](variables.tf#L107) | Onprem addresses in name => range format. | map(string) | | {…} | | | [outputs_location](variables.tf#L125) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | diff --git a/fast/stages/02-networking-nva/variables.tf b/fast/stages/02-networking-nva/variables.tf index 1d94ec034b..90f766764a 100644 --- a/fast/stages/02-networking-nva/variables.tf +++ b/fast/stages/02-networking-nva/variables.tf @@ -69,7 +69,7 @@ variable "data_dir" { } variable "dns" { - description = "Onprem DNS resolvers" + description = "Onprem DNS resolvers." type = map(list(string)) default = { onprem = ["10.0.200.3"] diff --git a/fast/stages/03-data-platform/dev/README.md b/fast/stages/03-data-platform/dev/README.md index d987a5e106..12db8d2923 100644 --- a/fast/stages/03-data-platform/dev/README.md +++ b/fast/stages/03-data-platform/dev/README.md @@ -168,22 +168,22 @@ You can find examples in the `[demo](../../../../blueprints/data-solutions/data- |---|---|:---:|:---:|:---:|:---:| | [automation](variables.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 00-bootstrap | | [billing_account](variables.tf#L25) | Billing account id and organization id ('nnnnnnnn' or null). | object({…}) | ✓ | | 00-globals | -| [folder_ids](variables.tf#L64) | Folder to be used for the networking resources in folders/nnnn format. | object({…}) | ✓ | | 01-resman | -| [host_project_ids](variables.tf#L82) | Shared VPC project ids. | object({…}) | ✓ | | 02-networking | -| [organization](variables.tf#L114) | Organization details. | object({…}) | ✓ | | 00-globals | -| [prefix](variables.tf#L130) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-globals | -| [composer_config](variables.tf#L34) | | object({…}) | | {…} | | -| [data_catalog_tags](variables.tf#L47) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(map(list(string))) | | {…} | | -| [data_force_destroy](variables.tf#L58) | Flag to set 'force_destroy' on data services like BigQery or Cloud Storage. | bool | | false | | -| [groups](variables.tf#L72) | Groups. | map(string) | | {…} | | -| [location](variables.tf#L90) | Location used for multi-regional resources. | string | | "eu" | | -| [network_config_composer](variables.tf#L96) | Network configurations to use for Composer. | object({…}) | | {…} | | -| [outputs_location](variables.tf#L124) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | -| [project_services](variables.tf#L136) | List of core services enabled on all projects. | list(string) | | […] | | -| [region](variables.tf#L147) | Region used for regional resources. | string | | "europe-west1" | | -| [service_encryption_keys](variables.tf#L153) | Cloud KMS to use to encrypt different services. Key location should match service region. | object({…}) | | null | | -| [subnet_self_links](variables.tf#L165) | Shared VPC subnet self links. | object({…}) | | null | 02-networking | -| [vpc_self_links](variables.tf#L174) | Shared VPC self links. | object({…}) | | null | 02-networking | +| [folder_ids](variables.tf#L65) | Folder to be used for the networking resources in folders/nnnn format. | object({…}) | ✓ | | 01-resman | +| [host_project_ids](variables.tf#L83) | Shared VPC project ids. | object({…}) | ✓ | | 02-networking | +| [organization](variables.tf#L115) | Organization details. | object({…}) | ✓ | | 00-globals | +| [prefix](variables.tf#L131) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-globals | +| [composer_config](variables.tf#L34) | Cloud Composer configuration options. | object({…}) | | {…} | | +| [data_catalog_tags](variables.tf#L48) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(map(list(string))) | | {…} | | +| [data_force_destroy](variables.tf#L59) | Flag to set 'force_destroy' on data services like BigQery or Cloud Storage. | bool | | false | | +| [groups](variables.tf#L73) | Groups. | map(string) | | {…} | | +| [location](variables.tf#L91) | Location used for multi-regional resources. | string | | "eu" | | +| [network_config_composer](variables.tf#L97) | Network configurations to use for Composer. | object({…}) | | {…} | | +| [outputs_location](variables.tf#L125) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | +| [project_services](variables.tf#L137) | List of core services enabled on all projects. | list(string) | | […] | | +| [region](variables.tf#L148) | Region used for regional resources. | string | | "europe-west1" | | +| [service_encryption_keys](variables.tf#L154) | Cloud KMS to use to encrypt different services. Key location should match service region. | object({…}) | | null | | +| [subnet_self_links](variables.tf#L166) | Shared VPC subnet self links. | object({…}) | | null | 02-networking | +| [vpc_self_links](variables.tf#L175) | Shared VPC self links. | object({…}) | | null | 02-networking | ## Outputs diff --git a/fast/stages/03-data-platform/dev/variables.tf b/fast/stages/03-data-platform/dev/variables.tf index 19c998fe6d..9495316a91 100644 --- a/fast/stages/03-data-platform/dev/variables.tf +++ b/fast/stages/03-data-platform/dev/variables.tf @@ -32,6 +32,7 @@ variable "billing_account" { } variable "composer_config" { + description = "Cloud Composer configuration options." type = object({ node_count = number airflow_version = string diff --git a/modules/api-gateway/README.md b/modules/api-gateway/README.md index 624246574a..7c15f5814d 100644 --- a/modules/api-gateway/README.md +++ b/modules/api-gateway/README.md @@ -64,12 +64,12 @@ module "gateway" { |---|---|:---:|:---:|:---:| | [api_id](variables.tf#L17) | API identifier. | string | ✓ | | | [project_id](variables.tf#L34) | Project identifier. | string | ✓ | | -| [region](variables.tf#L39) | Region | string | ✓ | | +| [region](variables.tf#L39) | Region. | string | ✓ | | | [spec](variables.tf#L56) | String with the contents of the OpenAPI spec. | string | ✓ | | | [iam](variables.tf#L22) | IAM bindings for the API in {ROLE => [MEMBERS]} format. | map(list(string)) | | null | | [labels](variables.tf#L28) | Map of labels. | map(string) | | null | -| [service_account_create](variables.tf#L44) | Flag indicating whether a service account needs to be created | bool | | false | -| [service_account_email](variables.tf#L50) | Service account for creating API configs | string | | null | +| [service_account_create](variables.tf#L44) | Flag indicating whether a service account needs to be created. | bool | | false | +| [service_account_email](variables.tf#L50) | Service account for creating API configs. | string | | null | ## Outputs diff --git a/modules/api-gateway/variables.tf b/modules/api-gateway/variables.tf index 9625919840..ef5bd41d48 100644 --- a/modules/api-gateway/variables.tf +++ b/modules/api-gateway/variables.tf @@ -37,18 +37,18 @@ variable "project_id" { } variable "region" { - description = "Region" + description = "Region." type = string } variable "service_account_create" { - description = "Flag indicating whether a service account needs to be created" + description = "Flag indicating whether a service account needs to be created." type = bool default = false } variable "service_account_email" { - description = "Service account for creating API configs" + description = "Service account for creating API configs." type = string default = null } diff --git a/modules/apigee/README.md b/modules/apigee/README.md index d521e87194..129a6357ed 100644 --- a/modules/apigee/README.md +++ b/modules/apigee/README.md @@ -153,7 +153,7 @@ module "apigee" { |---|---|:---:| | [envgroups](outputs.tf#L17) | Environment groups. | | | [environments](outputs.tf#L22) | Environment. | | -| [instances](outputs.tf#L27) | Instances | | +| [instances](outputs.tf#L27) | Instances. | | | [org_id](outputs.tf#L32) | Organization ID. | | | [org_name](outputs.tf#L37) | Organization name. | | | [organization](outputs.tf#L42) | Organization. | | diff --git a/modules/apigee/outputs.tf b/modules/apigee/outputs.tf index 5d043f1888..a5e7038818 100644 --- a/modules/apigee/outputs.tf +++ b/modules/apigee/outputs.tf @@ -25,7 +25,7 @@ output "environments" { } output "instances" { - description = "Instances" + description = "Instances." value = try(google_apigee_instance.instances, null) } diff --git a/modules/binauthz/README.md b/modules/binauthz/README.md index 7d8a0b3010..fa0cd71ba9 100644 --- a/modules/binauthz/README.md +++ b/modules/binauthz/README.md @@ -62,10 +62,10 @@ module "binauthz" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L68) | Project ID. | string | ✓ | | -| [admission_whitelist_patterns](variables.tf#L17) | An image name pattern to allowlist | list(string) | | null | -| [attestors_config](variables.tf#L23) | Attestors configuration | map(object({…})) | | null | -| [cluster_admission_rules](variables.tf#L38) | Admission rules | map(object({…})) | | null | -| [default_admission_rule](variables.tf#L48) | Default admission rule | object({…}) | | {…} | +| [admission_whitelist_patterns](variables.tf#L17) | An image name pattern to allowlist. | list(string) | | null | +| [attestors_config](variables.tf#L23) | Attestors configuration. | map(object({…})) | | null | +| [cluster_admission_rules](variables.tf#L38) | Admission rules. | map(object({…})) | | null | +| [default_admission_rule](variables.tf#L48) | Default admission rule. | object({…}) | | {…} | | [global_policy_evaluation_mode](variables.tf#L62) | Global policy evaluation mode. | string | | null | ## Outputs @@ -73,7 +73,7 @@ module "binauthz" { | name | description | sensitive | |---|---|:---:| | [attestors](outputs.tf#L17) | Attestors. | | -| [id](outputs.tf#L25) | Binary Authorization policy ID | | +| [id](outputs.tf#L25) | Binary Authorization policy ID. | | | [notes](outputs.tf#L30) | Notes. | | diff --git a/modules/binauthz/outputs.tf b/modules/binauthz/outputs.tf index 9273e52d19..6a1d7c6de3 100644 --- a/modules/binauthz/outputs.tf +++ b/modules/binauthz/outputs.tf @@ -23,7 +23,7 @@ output "attestors" { } output "id" { - description = "Binary Authorization policy ID" + description = "Binary Authorization policy ID." value = google_binary_authorization_policy.policy.id } diff --git a/modules/binauthz/variables.tf b/modules/binauthz/variables.tf index 9ba38c4b9d..6d21083be8 100644 --- a/modules/binauthz/variables.tf +++ b/modules/binauthz/variables.tf @@ -15,13 +15,13 @@ */ variable "admission_whitelist_patterns" { - description = "An image name pattern to allowlist" + description = "An image name pattern to allowlist." type = list(string) default = null } variable "attestors_config" { - description = "Attestors configuration" + description = "Attestors configuration." type = map(object({ note_reference = string iam = map(list(string)) @@ -36,7 +36,7 @@ variable "attestors_config" { } variable "cluster_admission_rules" { - description = "Admission rules" + description = "Admission rules." type = map(object({ evaluation_mode = string enforcement_mode = string @@ -46,7 +46,7 @@ variable "cluster_admission_rules" { } variable "default_admission_rule" { - description = "Default admission rule" + description = "Default admission rule." type = object({ evaluation_mode = string enforcement_mode = string diff --git a/modules/cloud-function/README.md b/modules/cloud-function/README.md index b813a364f9..75ef371987 100644 --- a/modules/cloud-function/README.md +++ b/modules/cloud-function/README.md @@ -230,10 +230,10 @@ module "cf-http" { | [name](variables.tf#L94) | Name used for cloud function and associated resources. | string | ✓ | | | [project_id](variables.tf#L109) | Project id used for all resources. | string | ✓ | | | [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | -| [build_worker_pool](variables.tf#L31) | Build worker pool, in projects//locations//workerPools/ format | string | | null | +| [build_worker_pool](variables.tf#L31) | Build worker pool, in projects//locations//workerPools/ format. | string | | null | | [description](variables.tf#L46) | Optional description. | string | | "Terraform managed." | | [environment_variables](variables.tf#L52) | Cloud function environment variables. | map(string) | | {} | -| [function_config](variables.tf#L58) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout | object({…}) | | {…} | +| [function_config](variables.tf#L58) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | object({…}) | | {…} | | [iam](variables.tf#L76) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [ingress_settings](variables.tf#L82) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | string | | null | | [labels](variables.tf#L88) | Resource labels. | map(string) | | {} | diff --git a/modules/cloud-function/variables.tf b/modules/cloud-function/variables.tf index 528a594f8b..97a6217a6f 100644 --- a/modules/cloud-function/variables.tf +++ b/modules/cloud-function/variables.tf @@ -29,7 +29,7 @@ variable "bucket_name" { } variable "build_worker_pool" { - description = "Build worker pool, in projects//locations//workerPools/ format" + description = "Build worker pool, in projects//locations//workerPools/ format." type = string default = null } @@ -56,7 +56,7 @@ variable "environment_variables" { } variable "function_config" { - description = "Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout" + description = "Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout." type = object({ entry_point = optional(string, "main") instance_count = optional(number, 1) diff --git a/modules/cloudsql-instance/README.md b/modules/cloudsql-instance/README.md index 2ef627abee..a902f54550 100644 --- a/modules/cloudsql-instance/README.md +++ b/modules/cloudsql-instance/README.md @@ -165,7 +165,7 @@ module "db" { | [labels](variables.tf#L96) | Labels to be attached to all instances. | map(string) | | null | | [prefix](variables.tf#L112) | Optional prefix used to generate instance names. | string | | null | | [replicas](variables.tf#L132) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | map(object({…})) | | {} | -| [root_password](variables.tf#L141) | Root password of the Cloud SQL instance. Required for MS SQL Server | string | | null | +| [root_password](variables.tf#L141) | Root password of the Cloud SQL instance. Required for MS SQL Server. | string | | null | | [users](variables.tf#L152) | 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 diff --git a/modules/cloudsql-instance/variables.tf b/modules/cloudsql-instance/variables.tf index 8b0adbba41..04bff546b2 100644 --- a/modules/cloudsql-instance/variables.tf +++ b/modules/cloudsql-instance/variables.tf @@ -139,7 +139,7 @@ variable "replicas" { } variable "root_password" { - description = "Root password of the Cloud SQL instance. Required for MS SQL Server" + description = "Root password of the Cloud SQL instance. Required for MS SQL Server." type = string default = null } diff --git a/modules/gke-hub/README.md b/modules/gke-hub/README.md index 17069180a9..9fe47344dc 100644 --- a/modules/gke-hub/README.md +++ b/modules/gke-hub/README.md @@ -297,7 +297,6 @@ module "hub" { # tftest modules=8 resources=28 ``` - ## Variables @@ -315,6 +314,6 @@ module "hub" { | name | description | sensitive | |---|---|:---:| -| [cluster_ids](outputs.tf#L17) | | | +| [cluster_ids](outputs.tf#L17) | Ids of all the clusters created. | | diff --git a/modules/gke-hub/outputs.tf b/modules/gke-hub/outputs.tf index 5d2abf15ae..b4fd3462b3 100644 --- a/modules/gke-hub/outputs.tf +++ b/modules/gke-hub/outputs.tf @@ -15,6 +15,7 @@ */ output "cluster_ids" { + description = "Ids of all the clusters created." value = { for k, v in google_gke_hub_membership.default : k => v.id } diff --git a/modules/net-ilb-l7/README.md b/modules/net-ilb-l7/README.md index d7847fdb0b..969a4da4ff 100644 --- a/modules/net-ilb-l7/README.md +++ b/modules/net-ilb-l7/README.md @@ -574,11 +574,7 @@ module "ilb-l7" { | [backend-service.tf](./backend-service.tf) | Backend service resources. | google_compute_region_backend_service | | [health-check.tf](./health-check.tf) | Health check resource. | google_compute_health_check | | [main.tf](./main.tf) | Module-level locals and resources. | google_compute_forwarding_rule · google_compute_instance_group · google_compute_network_endpoint · google_compute_network_endpoint_group · google_compute_region_network_endpoint_group · google_compute_region_ssl_certificate · google_compute_region_target_http_proxy · google_compute_region_target_https_proxy | -| [outputs.tf](./outputs.tf) | Module outputs. | - value = google_compute_forwarding_rule.default -} - -output | +| [outputs.tf](./outputs.tf) | Module outputs. | | | [urlmap.tf](./urlmap.tf) | URL map resources. | google_compute_region_url_map | | [variables-backend-service.tf](./variables-backend-service.tf) | Backend services variables. | | | [variables-health-check.tf](./variables-health-check.tf) | Health check variable. | | @@ -615,7 +611,7 @@ output | |---|---|:---:| | [address](outputs.tf#L17) | Forwarding rule address. | | | [backend_service_ids](outputs.tf#L22) | Backend service resources. | | -| [forwarding_rule](outputs.tf#L29) | Forwarding rule resource | | +| [forwarding_rule](outputs.tf#L29) | Forwarding rule resource. | | | [group_ids](outputs.tf#L34) | Autogenerated instance group ids. | | | [health_check_ids](outputs.tf#L41) | Autogenerated health check ids. | | | [neg_ids](outputs.tf#L48) | Autogenerated network endpoint group ids. | | diff --git a/modules/net-ilb-l7/outputs.tf b/modules/net-ilb-l7/outputs.tf index d505ebd84a..9082dfecac 100644 --- a/modules/net-ilb-l7/outputs.tf +++ b/modules/net-ilb-l7/outputs.tf @@ -27,7 +27,7 @@ output "backend_service_ids" { } output "forwarding_rule" { - description = "Forwarding rule resource" + description = "Forwarding rule resource." value = google_compute_forwarding_rule.default } diff --git a/tools/check_documentation.py b/tools/check_documentation.py index 3733f128b2..d7d859bdb4 100755 --- a/tools/check_documentation.py +++ b/tools/check_documentation.py @@ -37,6 +37,10 @@ class State(enum.IntEnum): FAIL_STALE_README = enum.auto() FAIL_UNSORTED_VARS = enum.auto() FAIL_UNSORTED_OUTPUTS = enum.auto() + FAIL_VARIABLE_COLON = enum.auto() + FAIL_OUTPUT_COLON = enum.auto() + FAIL_VARIABLE_DESCRIPTION = enum.auto() + FAIL_OUTPUT_DESCRIPTION = enum.auto() @property def failed(self): @@ -48,8 +52,12 @@ def label(self): State.SKIP: ' ', State.OK: '✓ ', State.FAIL_STALE_README: '✗R', - State.FAIL_UNSORTED_VARS: '✗V', - State.FAIL_UNSORTED_OUTPUTS: '✗O', + State.FAIL_UNSORTED_VARS: 'SV', + State.FAIL_UNSORTED_OUTPUTS: 'SO', + State.FAIL_VARIABLE_COLON: '.V', + State.FAIL_OUTPUT_COLON: '.O', + State.FAIL_VARIABLE_DESCRIPTION: 'DV', + State.FAIL_OUTPUT_DESCRIPTION: 'DO', }[self.value] @@ -71,10 +79,10 @@ def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False): new_doc = tfdoc.create_doc(readme_path.parent, files, show_extra, exclude_files, readme) # TODO: support variables in multiple files - variables = [ - v.name for v in new_doc.variables if v.file == "variables.tf" - ] - outputs = [o.name for o in new_doc.outputs if o.file == "outputs.tf"] + newvars = new_doc.variables + newouts = new_doc.outputs + variables = [v.name for v in newvars if v.file == "variables.tf"] + outputs = [o.name for o in newouts if o.file == "outputs.tf"] except SystemExit: state = state.SKIP else: @@ -87,6 +95,20 @@ def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False): new_doc.content.split('\n')) diff = '\n'.join([header] + list(ndiff)) + elif empty := [v.name for v in newvars if not v.description]: + state = state.FAIL_VARIABLE_DESCRIPTION + diff = "\n".join([ + f'----- {mod_name} variables missing description -----', + ', '.join(empty), + ]) + + elif empty := [o.name for o in newouts if not o.description]: + state = state.FAIL_VARIABLE_DESCRIPTION + diff = "\n".join([ + f'----- {mod_name} outputs missing description -----', + ', '.join(empty), + ]) + elif variables != sorted(variables): state = state.FAIL_UNSORTED_VARS diff = "\n".join([ @@ -103,6 +125,20 @@ def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False): ', '.join(sorted(outputs)), ]) + elif nc := [v.name for v in newvars if not v.description.endswith('.')]: + state = state.FAIL_VARIABLE_COLON + diff = "\n".join([ + f'----- {mod_name} variables missing colons -----', + ', '.join(nc), + ]) + + elif nc := [o.name for o in newouts if not o.description.endswith('.')]: + state = state.FAIL_VARIABLE_COLON + diff = "\n".join([ + f'----- {mod_name} outputs missing colons -----', + ', '.join(nc), + ]) + yield mod_name, state, diff @@ -128,7 +164,6 @@ def main(dirs, exclude_file=None, files=False, show_diffs=False, if errors: if show_diffs: print('Errored diffs:') - print(errors) print('\n'.join([e[1] for e in errors])) else: print('Errored modules:') From 53d7b99b41729712d097129e46cf21f4288e1217 Mon Sep 17 00:00:00 2001 From: Ludo Date: Thu, 24 Nov 2022 19:26:07 +0100 Subject: [PATCH 2/3] fix comment --- blueprints/cloud-operations/apigee/variables.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blueprints/cloud-operations/apigee/variables.tf b/blueprints/cloud-operations/apigee/variables.tf index 22dea90b35..1c86621bef 100644 --- a/blueprints/cloud-operations/apigee/variables.tf +++ b/blueprints/cloud-operations/apigee/variables.tf @@ -1,4 +1,4 @@ -** +/** * Copyright 2022 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); From 27cf698ce596d21871c3fa1ebd4564dfaa589f16 Mon Sep 17 00:00:00 2001 From: Julio Castillo Date: Fri, 25 Nov 2022 09:36:44 +0100 Subject: [PATCH 3/3] Colon -> Period --- tools/check_documentation.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tools/check_documentation.py b/tools/check_documentation.py index d7d859bdb4..30e7657186 100755 --- a/tools/check_documentation.py +++ b/tools/check_documentation.py @@ -37,8 +37,8 @@ class State(enum.IntEnum): FAIL_STALE_README = enum.auto() FAIL_UNSORTED_VARS = enum.auto() FAIL_UNSORTED_OUTPUTS = enum.auto() - FAIL_VARIABLE_COLON = enum.auto() - FAIL_OUTPUT_COLON = enum.auto() + FAIL_VARIABLE_PERIOD = enum.auto() + FAIL_OUTPUT_PERIOD = enum.auto() FAIL_VARIABLE_DESCRIPTION = enum.auto() FAIL_OUTPUT_DESCRIPTION = enum.auto() @@ -54,8 +54,8 @@ def label(self): State.FAIL_STALE_README: '✗R', State.FAIL_UNSORTED_VARS: 'SV', State.FAIL_UNSORTED_OUTPUTS: 'SO', - State.FAIL_VARIABLE_COLON: '.V', - State.FAIL_OUTPUT_COLON: '.O', + State.FAIL_VARIABLE_PERIOD: '.V', + State.FAIL_OUTPUT_PERIOD: '.O', State.FAIL_VARIABLE_DESCRIPTION: 'DV', State.FAIL_OUTPUT_DESCRIPTION: 'DO', }[self.value] @@ -126,14 +126,14 @@ def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False): ]) elif nc := [v.name for v in newvars if not v.description.endswith('.')]: - state = state.FAIL_VARIABLE_COLON + state = state.FAIL_VARIABLE_PERIOD diff = "\n".join([ f'----- {mod_name} variables missing colons -----', ', '.join(nc), ]) elif nc := [o.name for o in newouts if not o.description.endswith('.')]: - state = state.FAIL_VARIABLE_COLON + state = state.FAIL_VARIABLE_PERIOD diff = "\n".join([ f'----- {mod_name} outputs missing colons -----', ', '.join(nc),