Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terraform provider docs update #2585

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ci/magic-modules/generate-terraform.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ if [ "$GITHUB_ORG" = "terraform-providers" ]; then
# "-wholename": entire relative path - including directory names - matches following wildcard.
# "-name": filename alone matches following string. e.g. -name README.md matches ./README.md *and* ./foo/bar/README.md
# "-exec": for each file found, execute the command following until the literal ';'
find . -type f -not -wholename "./.git*" -not -wholename "./vendor*" -not -name ".travis.yml" -not -name ".golangci.yml" -not -name "CHANGELOG.md" -not -name "GNUmakefile" -not -name "LICENSE" -not -name "README.md" -not -wholename "./examples*" -not -name "go.mod" -not -name "go.sum" -not -name "staticcheck.conf" -not -name ".go-version" -not -name ".hashibot.hcl" -not -name "tools.go" -exec git rm {} \;
find . -type f -not -wholename "./.git*" -not -wholename "./vendor*" -not -name ".travis.yml" -not -name ".golangci.yml" -not -name "CHANGELOG.md" -not -name "GNUmakefile" -not -name "docscheck.sh" -not -name "LICENSE" -not -name "README.md" -not -wholename "./examples*" -not -name "go.mod" -not -name "go.sum" -not -name "staticcheck.conf" -not -name ".go-version" -not -name ".hashibot.hcl" -not -name "tools.go" -exec git rm {} \;
fi

popd
Expand Down
2 changes: 1 addition & 1 deletion build/inspec
2 changes: 1 addition & 1 deletion build/terraform
2 changes: 1 addition & 1 deletion build/terraform-beta
4 changes: 3 additions & 1 deletion templates/terraform/resource.html.markdown.erb
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@
is generated from a ruby function, but skip it on anything that is
directly inserted from YAML.
-%>
<%
<%
tf_product = (@config.legacy_name || product_ns).underscore
tf_subcategory = (object.__product.display_name)
terraform_name = object.legacy_name || "google_#{tf_product}_#{object.name.underscore}"
properties = object.all_user_properties
# In order of preference, use TF override,
Expand All @@ -47,6 +48,7 @@
-%>
---
<%= lines(autogen_notice :yaml) -%>
subcategory: "<%= tf_subcategory -%>"
layout: "google"
page_title: "Google: <%= terraform_name -%>"
sidebar_current: "docs-<%= terraform_name.gsub("_", "-") -%>"
Expand Down
2 changes: 2 additions & 0 deletions templates/terraform/resource_iam.html.markdown.erb
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
-%>
<%
tf_product = (@config.legacy_name || product_ns).underscore
tf_subcategory = (object.__product.display_name)
resource_ns = object.legacy_name || "google_#{tf_product}_#{object.name.underscore}"
resource_ns_iam = "#{resource_ns}_iam"
properties = object.all_user_properties
Expand All @@ -49,6 +50,7 @@
-%>
---
<%= lines(autogen_notice :yaml) -%>
subcategory: "<%= tf_subcategory -%>"
layout: "google"
page_title: "Google: <%= resource_ns_iam -%>"
sidebar_current: "docs-<%= resource_ns_iam.gsub("_", "-") -%>"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_client_config"
sidebar_current: "docs-google-datasource-client-config"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Functions"
layout: "google"
page_title: "Google: google_cloudfunctions_function"
sidebar_current: "docs-google-datasource-cloudfunctions-function"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_address"
sidebar_current: "docs-google-datasource-compute-address"
Expand Down Expand Up @@ -55,4 +56,4 @@ exported:

* `self_link` - The URI of the created resource.
* `address` - The IP of the created resource.
* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_forwarding_rule"
sidebar_current: "docs-google-datasource-compute-forwarding-rule"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_global_address"
sidebar_current: "docs-google-datasource-compute-global-address"
Expand Down Expand Up @@ -52,4 +53,4 @@ exported:

* `self_link` - The URI of the created resource.
* `address` - The IP of the created resource.
* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_image"
sidebar_current: "docs-google-datasource-compute-image"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_instance"
sidebar_current: "docs-google-datasource-compute-instance-x"
Expand Down Expand Up @@ -203,4 +204,4 @@ The `shielded_instance_config` block supports:

* `enable_vtpm` -- Whether the instance uses vTPM.

* `enable_integrity_monitoring` -- Whether integrity monitoring is enabled for the instance.
* `enable_integrity_monitoring` -- Whether integrity monitoring is enabled for the instance.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_compute_lb_ip_ranges"
sidebar_current: "docs-google-datasource-compute-lb-ip-ranges"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_network"
sidebar_current: "docs-google-datasource-compute-network"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_region_instance_group"
sidebar_current: "docs-google-datasource-compute-region-instance-group"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
layout: "google"
subcategory: "Compute Engine"
page_title: "Google: google_compute_router"
sidebar_current: "docs-google-datasource-compute-router"
description: |-
Expand Down Expand Up @@ -27,7 +28,7 @@ The following arguments are supported:

* `network` - (Required) The VPC network on which this router lives.

* `project` - (Optional) The ID of the project in which the resource
* `project` - (Optional) The ID of the project in which the resource
belongs. If it is not provided, the provider project is used.

* `region` - (Optional) The region this router has been created in. If
Expand All @@ -36,4 +37,4 @@ The following arguments are supported:

## Attributes Reference

See [google_compute_router](https://www.terraform.io/docs/providers/google/r/compute_router.html) resource for details of the available attributes.
See [google_compute_router](https://www.terraform.io/docs/providers/google/r/compute_router.html) resource for details of the available attributes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_ssl_certificate"
sidebar_current: "docs-google-datasource-compute-ssl-certificate"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_ssl_policy"
sidebar_current: "docs-google-datasource-compute-ssl-policy"
Expand Down Expand Up @@ -48,4 +49,4 @@ In addition to the arguments listed above, the following attributes are exported

* `fingerprint` - Fingerprint of this resource.

* `self_link` - The URI of the created resource.
* `self_link` - The URI of the created resource.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_subnetwork"
sidebar_current: "docs-google-datasource-compute-subnetwork"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_vpn_gateway"
sidebar_current: "docs-google-datasource-compute-vpn-gateway"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_client_openid_userinfo"
sidebar_current: "docs-google-datasource-client-openid-userinfo"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Composer"
layout: "google"
page_title: "Google: google_composer_image_versions"
sidebar_current: "docs-google-datasource-composer-image-versions"
Expand Down Expand Up @@ -43,4 +44,4 @@ The following attributes are exported:

* `image_versions` - A list of composer image versions available in the given project and location. Each `image_version` contains:
* `image_version_id` - The string identifier of the image version, in the form: "composer-x.y.z-airflow-a.b(.c)"
* `supported_python_versions` - Supported python versions for this image version
* `supported_python_versions` - Supported python versions for this image version
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_backend_service"
sidebar_current: "docs-google-datasource-compute-backend-service"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_network_endpoint_group"
sidebar_current: "docs-google-datasource-compute-network-endpoint-group"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_folder_organization_policy"
sidebar_current: "docs-google-datasource-folder-organization-policy"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_iam_role"
sidebar_current: "docs-google-datasource-iam-role"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_netblock_ip_ranges"
sidebar_current: "docs-google-datasource-netblock-ip-ranges"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_project_organization_policy"
sidebar_current: "docs-google-datasource-project-organization-policy"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_service_account"
sidebar_current: "docs-google-datasource-service-account"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_service_account_access_token"
sidebar_current: "docs-google-service-account-access-token"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_service_account_key"
sidebar_current: "docs-google-datasource-service-account-key"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_tpu_tensorflow_versions"
sidebar_current: "docs-google-datasource-tpu-tensorflow-versions"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud DNS"
layout: "google"
page_title: "Google: google_dns_managed_zone"
sidebar_current: "docs-google-datasource-dns-managed-zone"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_active_folder"
sidebar_current: "docs-google-datasource-active-folder"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_billing_account"
sidebar_current: "docs-google-datasource-billing-account"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_compute_default_service_account"
sidebar_current: "docs-google-datasource-compute-default-service-account"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_instance_group"
sidebar_current: "docs-google-datasource-compute-instance-group"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_node_types"
sidebar_current: "docs-google-datasource-compute-node-types"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_regions"
sidebar_current: "docs-google-datasource-compute-regions"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
layout: "google"
subcategory: "Cloud Platform"
page_title: "Google: google_compute_resource_policy"
sidebar_current: "docs-google-datasource-compute-resource-policy"
description: |-
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Compute Engine"
layout: "google"
page_title: "Google: google_compute_zones"
sidebar_current: "docs-google-datasource-compute-zones"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Kubernetes (Container) Engine"
layout: "google"
page_title: "Google: google_container_cluster"
sidebar_current: "docs-google-datasource-container-cluster"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Kubernetes (Container) Engine"
layout: "google"
page_title: "Google: google_container_engine_versions"
sidebar_current: "docs-google-datasource-container-versions"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Container Registry"
layout: "google"
page_title: "Google: google_container_registry_image"
sidebar_current: "docs-google-datasource-container-image"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Container Registry"
layout: "google"
page_title: "Google: google_container_registry_repository"
sidebar_current: "docs-google-datasource-container-repo"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_folder"
sidebar_current: "docs-google-datasource-folder"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud Platform"
layout: "google"
page_title: "Google: google_iam_policy"
sidebar_current: "docs-google-datasource-iam-policy"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud KMS"
layout: "google"
page_title: "Google: google_kms_crypto_key"
sidebar_current: "docs-google-datasource-kms-crypto-key"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud KMS"
layout: "google"
page_title: "Google: google_kms_crypto_key_version"
sidebar_current: "docs-google-datasource-kms-crypto-key-version"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud KMS"
layout: "google"
page_title: "Google: google_kms_key_ring"
sidebar_current: "docs-google-datasource-kms-key-ring"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud KMS"
layout: "google"
page_title: "Google: google_kms_secret"
sidebar_current: "docs-google-kms-secret"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
subcategory: "Cloud KMS"
layout: "google"
page_title: "Google: google_kms_secret_ciphertext"
sidebar_current: "docs-google-kms-secret-ciphertext"
Expand Down Expand Up @@ -61,7 +62,7 @@ resource "google_compute_instance" "instance" {
access_config {
}
}

metadata = {
password = "${data.google_kms_secret_ciphertext.my_password.ciphertext}"
}
Expand Down
Loading