Merge pull request #1010 from GoogleCloudPlatform/jccb/var-outs-checks

Enforce nonempty descriptions ending in a dot

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. | <code>string</code> |  | <code>&#34;pd-ssd&#34;</code> |
 | [image](variables.tf#L43) | Image. | <code>string</code> |  | <code>&#34;projects&#47;windows-cloud&#47;global&#47;images&#47;family&#47;windows-2022&#34;</code> |
 | [instance_type](variables.tf#L49) | Instance type. | <code>string</code> |  | <code>&#34;n1-standard-2&#34;</code> |
-| [network_config](variables.tf#L55) | Network configuration | <code title="object&#40;&#123;&#10;  network &#61; string&#10;  subnet  &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
+| [network_config](variables.tf#L55) | Network configuration. | <code title="object&#40;&#123;&#10;  network &#61; string&#10;  subnet  &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
 | [project_create](variables.tf#L73) | Parameters for the creation of the new project. | <code title="object&#40;&#123;&#10;  billing_account_id &#61; string&#10;  parent             &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
 | [region](variables.tf#L87) | Region. | <code>string</code> |  | <code>&#34;europe-west1&#34;</code> |
 | [subnet_ip_cidr_block](variables.tf#L93) | Subnet IP CIDR block. | <code>string</code> |  | <code>&#34;10.0.1.0&#47;28&#34;</code> |

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

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. | <code title="map&#40;object&#40;&#123;&#10;  display_name         &#61; optional&#40;string&#41;&#10;  description          &#61; optional&#40;string&#41;&#10;  region               &#61; string&#10;  environments         &#61; list&#40;string&#41;&#10;  psa_ip_cidr_range    &#61; string&#10;  disk_encryption_key  &#61; optional&#40;string&#41;&#10;  consumer_accept_list &#61; optional&#40;list&#40;string&#41;&#41;&#10;&#125;&#41;&#41;">map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | ✓ |  |
 | [project_id](variables.tf#L92) | Project ID. | <code>string</code> | ✓ |  |
 | [psc_config](variables.tf#L98) | PSC configuration. | <code>map&#40;string&#41;</code> | ✓ |  |
-| [datastore_name](variables.tf#L17) | Datastore | <code>string</code> |  | <code>&#34;gcs&#34;</code> |
+| [datastore_name](variables.tf#L17) | Datastore. | <code>string</code> |  | <code>&#34;gcs&#34;</code> |
 | [organization](variables.tf#L60) | Apigee organization. | <code title="object&#40;&#123;&#10;  display_name            &#61; optional&#40;string, &#34;Apigee organization created by tf module&#34;&#41;&#10;  description             &#61; optional&#40;string, &#34;Apigee organization created by tf module&#34;&#41;&#10;  authorized_network      &#61; optional&#40;string, &#34;vpc&#34;&#41;&#10;  runtime_type            &#61; optional&#40;string, &#34;CLOUD&#34;&#41;&#10;  billing_type            &#61; optional&#40;string&#41;&#10;  database_encryption_key &#61; optional&#40;string&#41;&#10;  analytics_region        &#61; optional&#40;string, &#34;europe-west1&#34;&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code title="&#123;&#10;&#125;">&#123;&#8230;&#125;</code> |
 | [path](variables.tf#L76) | Bucket path. | <code>string</code> |  | <code>&#34;&#47;analytics&#34;</code> |
 | [project_create](variables.tf#L83) | Parameters for the creation of the new project. | <code title="object&#40;&#123;&#10;  billing_account_id &#61; string&#10;  parent             &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |

blueprints/cloud-operations/apigee/variables.tf

@@ -15,7 +15,7 @@
  */
 
 variable "datastore_name" {
-  description = "Datastore"
+  description = "Datastore."
   type        = string
   nullable    = false
   default     = "gcs"

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 | <code></code> | ✓ |  |
-| [monitored_projects_list](variables.tf#L36) | ID of the projects to be monitored (where limits and quotas data will be pulled) | <code>list&#40;string&#41;</code> | ✓ |  |
-| [organization_id](variables.tf#L46) | The organization id for the associated services | <code></code> | ✓ |  |
+| [billing_account](variables.tf#L17) | The ID of the billing account to associate this project with. | <code></code> | ✓ |  |
+| [monitored_projects_list](variables.tf#L36) | ID of the projects to be monitored (where limits and quotas data will be pulled). | <code>list&#40;string&#41;</code> | ✓ |  |
+| [organization_id](variables.tf#L46) | The organization id for the associated services. | <code></code> | ✓ |  |
 | [prefix](variables.tf#L50) | Prefix used for resource names. | <code>string</code> | ✓ |  |
 | [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. | <code></code> |  | <code>V1</code> |
-| [monitored_folders_list](variables.tf#L30) | ID of the projects to be monitored (where limits and quotas data will be pulled) | <code>list&#40;string&#41;</code> |  | <code>&#91;&#93;</code> |
-| [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 | <code></code> |  |  |
+| [monitored_folders_list](variables.tf#L30) | ID of the projects to be monitored (where limits and quotas data will be pulled). | <code>list&#40;string&#41;</code> |  | <code>&#91;&#93;</code> |
+| [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. | <code></code> |  |  |
 | [project_monitoring_services](variables.tf#L59) | Service APIs enabled in the monitoring project if it will be created. | <code></code> |  | <code title="&#91;&#10;  &#34;artifactregistry.googleapis.com&#34;,&#10;  &#34;cloudasset.googleapis.com&#34;,&#10;  &#34;cloudbilling.googleapis.com&#34;,&#10;  &#34;cloudbuild.googleapis.com&#34;,&#10;  &#34;cloudfunctions.googleapis.com&#34;,&#10;  &#34;cloudresourcemanager.googleapis.com&#34;,&#10;  &#34;cloudscheduler.googleapis.com&#34;,&#10;  &#34;compute.googleapis.com&#34;,&#10;  &#34;iam.googleapis.com&#34;,&#10;  &#34;iamcredentials.googleapis.com&#34;,&#10;  &#34;logging.googleapis.com&#34;,&#10;  &#34;monitoring.googleapis.com&#34;,&#10;  &#34;pubsub.googleapis.com&#34;,&#10;  &#34;run.googleapis.com&#34;,&#10;  &#34;servicenetworking.googleapis.com&#34;,&#10;  &#34;serviceusage.googleapis.com&#34;,&#10;  &#34;storage-component.googleapis.com&#34;&#10;&#93;">&#91;&#8230;&#93;</code> |
-| [region](variables.tf#L81) | Region used to deploy the cloud functions and scheduler | <code></code> |  | <code>europe-west1</code> |
+| [region](variables.tf#L81) | Region used to deploy the cloud functions and scheduler. | <code></code> |  | <code>europe-west1</code> |
 | [schedule_cron](variables.tf#L86) | Cron format schedule to run the Cloud Function. Default is every 10 minutes. | <code></code> |  | <code>&#42;&#47;10 &#42; &#42; &#42; &#42;</code> |
 
 <!-- END TFDOC -->

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"
 }
 

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. |  |
 
 <!-- END TFDOC -->

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}",

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 | <code>string</code> | ✓ |  |
+| [m4ce_ssh_public_key](variables.tf#L43) | Filesystem path to the public key for the SSH login. | <code>string</code> | ✓ |  |
 | [vcenter_password](variables.tf#L48) | VCenter user password. | <code>string</code> | ✓ |  |
-| [vsphere_environment](variables.tf#L53) | VMVware VSphere connection parameters | <code title="object&#40;&#123;&#10;  vcenter_ip    &#61; string&#10;  vcenter_user  &#61; string&#10;  data_center   &#61; string&#10;  resource_pool &#61; string&#10;  host_ip       &#61; string&#10;  datastore     &#61; string&#10;  virtual_net   &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | ✓ |  |
-| [m4ce_appliance_properties](variables.tf#L15) | M4CE connector OVA image configuration parameters | <code title="object&#40;&#123;&#10;  hostname &#61; string&#10;  ip0      &#61; string&#10;  netmask0 &#61; string&#10;  gateway  &#61; string&#10;  DNS      &#61; string&#10;  proxy    &#61; string&#10;  route0   &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code title="&#123;&#10;  &#34;hostname&#34; &#61; &#34;gcp-m4ce-connector&#34;&#10;  &#34;ip0&#34;      &#61; &#34;0.0.0.0&#34;&#10;  &#34;netmask0&#34; &#61; &#34;0.0.0.0&#34;&#10;  &#34;gateway&#34;  &#61; &#34;0.0.0.0&#34;&#10;  &#34;DNS&#34;      &#61; &#34;&#34;&#10;  &#34;proxy&#34;    &#61; &#34;&#34;&#10;  &#34;route0&#34;   &#61; &#34;&#34;&#10;&#125;">&#123;&#8230;&#125;</code> |
-| [m4ce_connector_ovf_url](variables.tf#L37) | http URL to the public M4CE connector OVA image | <code>string</code> |  | <code>&#34;https:&#47;&#47;storage.googleapis.com&#47;vmmigration-public-artifacts&#47;migrate-connector-2-0-1663.ova&#34;</code> |
+| [vsphere_environment](variables.tf#L53) | VMVware VSphere connection parameters. | <code title="object&#40;&#123;&#10;  vcenter_ip    &#61; string&#10;  vcenter_user  &#61; string&#10;  data_center   &#61; string&#10;  resource_pool &#61; string&#10;  host_ip       &#61; string&#10;  datastore     &#61; string&#10;  virtual_net   &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | ✓ |  |
+| [m4ce_appliance_properties](variables.tf#L15) | M4CE connector OVA image configuration parameters. | <code title="object&#40;&#123;&#10;  hostname &#61; string&#10;  ip0      &#61; string&#10;  netmask0 &#61; string&#10;  gateway  &#61; string&#10;  DNS      &#61; string&#10;  proxy    &#61; string&#10;  route0   &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code title="&#123;&#10;  &#34;hostname&#34; &#61; &#34;gcp-m4ce-connector&#34;&#10;  &#34;ip0&#34;      &#61; &#34;0.0.0.0&#34;&#10;  &#34;netmask0&#34; &#61; &#34;0.0.0.0&#34;&#10;  &#34;gateway&#34;  &#61; &#34;0.0.0.0&#34;&#10;  &#34;DNS&#34;      &#61; &#34;&#34;&#10;  &#34;proxy&#34;    &#61; &#34;&#34;&#10;  &#34;route0&#34;   &#61; &#34;&#34;&#10;&#125;">&#123;&#8230;&#125;</code> |
+| [m4ce_connector_ovf_url](variables.tf#L37) | http URL to the public M4CE connector OVA image. | <code>string</code> |  | <code>&#34;https:&#47;&#47;storage.googleapis.com&#47;vmmigration-public-artifacts&#47;migrate-connector-2-0-1663.ova&#34;</code> |
 
 <!-- END TFDOC -->
 ## Manual Steps

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

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 | <code>list&#40;string&#41;</code> | ✓ |  |
-| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations | <code>list&#40;string&#41;</code> | ✓ |  |
-| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format | <code>list&#40;string&#41;</code> |  | <code>&#91;&#93;</code> |
-| [project_create](variables.tf#L31) | Parameters for the creation of the new project to host the M4CE backend | <code title="object&#40;&#123;&#10;  billing_account_id &#61; string&#10;  parent             &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
-| [project_name](variables.tf#L40) | Name of an existing project or of the new project assigned as M4CE host project | <code>string</code> |  | <code>&#34;m4ce-host-project-000&#34;</code> |
+| [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. | <code>list&#40;string&#41;</code> | ✓ |  |
+| [migration_target_projects](variables.tf#L20) | List of target projects for m4ce workload migrations. | <code>list&#40;string&#41;</code> | ✓ |  |
+| [migration_viewer_users](variables.tf#L25) | List of users authorized to retrive information about M4CE in the Google Cloud Console, in IAM format. | <code>list&#40;string&#41;</code> |  | <code>&#91;&#93;</code> |
+| [project_create](variables.tf#L31) | Parameters for the creation of the new project to host the M4CE backend. | <code title="object&#40;&#123;&#10;  billing_account_id &#61; string&#10;  parent             &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
+| [project_name](variables.tf#L40) | Name of an existing project or of the new project assigned as M4CE host project. | <code>string</code> |  | <code>&#34;m4ce-host-project-000&#34;</code> |
 
 ## 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. |  |
 
 <!-- END TFDOC -->

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"
 }

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"
 }