Skip to content

Commit

Permalink
update tfdoc (GoogleCloudPlatform#404)
Browse files Browse the repository at this point in the history
  • Loading branch information
ludoo authored Dec 30, 2021
1 parent c3115cc commit 2bc5f7d
Show file tree
Hide file tree
Showing 78 changed files with 175 additions and 98 deletions.
3 changes: 2 additions & 1 deletion cloud-operations/asset-inventory-feed-remediation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Run the `subscription_pull` command until it returns nothing, then run the follo
- the `tag_show` command to verify that the function output matches the resource state



<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -73,6 +74,6 @@ Run the `subscription_pull` command until it returns nothing, then run the follo
| tag_add | Instance add tag command. | |
| tag_show | Instance add tag command. | |


<!-- END TFDOC -->


3 changes: 2 additions & 1 deletion cloud-operations/dns-fine-grained-iam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ dig app1.svc.example.org +short
# 127.0.0.7
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -118,5 +119,5 @@ dig app1.svc.example.org +short
| gcloud_commands | Commands used to SSH to the VMs. | |
| vms | VM names. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion cloud-operations/dns-shared-vpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The resources created in this example are shown in the high level diagram below:

Note that Terraform 0.13 at least is required due to the use of `for_each` with modules.


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -39,5 +40,5 @@ Note that Terraform 0.13 at least is required due to the use of `for_each` with
|---|---|:---:|
| teams | Team resources | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion cloud-operations/iam-delegated-role-grants/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ If you get any warnings, check the roles and remove any of them granting any of
- `resourcemanager.organizations.setIamPolicy`



<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -77,5 +78,5 @@ If you get any warnings, check the roles and remove any of them granting any of
| project_create | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
| restricted_role_grant | Role grant to which the restrictions will apply. | <code>string</code> | | <code>&#34;roles&#47;resourcemanager.projectIamAdmin&#34;</code> |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion cloud-operations/onprem-sa-key-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ gcloud auth activate-service-account --key-file data-uploader.json
terraform destroy -var project_id=$GOOGLE_CLOUD_PROJECT
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -78,5 +79,5 @@ terraform destroy -var project_id=$GOOGLE_CLOUD_PROJECT
|---|---|:---:|
| sa-credentials | SA json key templates. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion cloud-operations/packer-image-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The following example assumes that provisioning of a Compute Engine VM requires
the resources over the Internet (i.e. to install OS packages). Since Compute VM has no public IP
address for security reasons, Internet connectivity is done with [Cloud NAT](https://cloud.google.com/nat/docs/overview).


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -93,5 +94,5 @@ address for security reasons, Internet connectivity is done with [Cloud NAT](htt
| compute_subnetwork | Name of a subnetwork for Packer's temporary VM. | |
| compute_zone | Name of a compute engine zone for Packer's temporary VM. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion cloud-operations/quota-monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Clone this repository or [open it in cloud shell](https://ssh.cloud.google.com/c
- `terraform init`
- `terraform apply -var project_id=my-project-id`


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -37,6 +38,6 @@ Clone this repository or [open it in cloud shell](https://ssh.cloud.google.com/c
| region | Compute region used in the example. | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
| schedule_config | Schedule timer configuration in crontab format | <code>string</code> | | <code>&#34;0 &#42; &#42; &#42; &#42;&#34;</code> |


<!-- END TFDOC -->


Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ This is an optional part, created if `cai_gcs_export` is set to `true`. The high




<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -79,6 +80,6 @@ This is an optional part, created if `cai_gcs_export` is set to `true`. The high
| bq-dataset | Bigquery instance details. | |
| cloud-function | Cloud Function instance details. | |


<!-- END TFDOC -->


3 changes: 2 additions & 1 deletion data-solutions/cmek-via-centralized-kms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This sample creates several distinct groups of resources:
- GCS
- One bucket encrypted with a CMEK Cryptokey hosted in Cloud KMS


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -56,5 +57,5 @@ This sample creates several distinct groups of resources:
| vm | GCE VM. | |
| vm_keys | GCE VM Cloud KMS crypto keys. | |


<!-- END TFDOC -->

Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ gcloud access-context-manager perimeters list --format="json" | grep name

The script use 'google_access_context_manager_service_perimeter_resource' terraform resource. If this resource is used alongside the 'vpc-sc' module, remember to uncomment the lifecycle block in the 'vpc-sc' module so they don't fight over which resources should be in the perimeter.


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -70,5 +71,5 @@ The script use 'google_access_context_manager_service_perimeter_resource' terraf
| service_account | Main service account. | |
| service_encryption_key_ids | Cloud KMS encryption keys in {LOCATION => [KEY_URL]} format. | |


<!-- END TFDOC -->

Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Once done testing, you can clean up resources by running `terraform destroy`.
### CMEK configuration
You can configure GCP resources to use existing CMEK keys configuring the 'service_encryption_key_ids' variable. You need to specify a 'global' and a 'multiregional' key.


<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -81,5 +82,5 @@ You can configure GCP resources to use existing CMEK keys configuring the 'servi
| transformation-buckets | List of buckets created for the transformation project. | |
| transformation-vpc | Transformation VPC details | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion data-solutions/gcs-to-bq-with-dataflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ schema_bq_import.json

You can check data imported into Google BigQuery from the Google Cloud Console UI.


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -136,5 +137,5 @@ You can check data imported into Google BigQuery from the Google Cloud Console U
| projects | Project ids. | |
| vm | GCE VM. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion factories/firewall-hierarchical-policies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ web_frontends:
- [email protected]
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -163,5 +164,5 @@ web_frontends:
|---|---|:---:|
| hierarchical-firewall-rules | Generated Hierarchical Firewall Rules | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion factories/firewall-vpc-rules/flat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ web-app-a-ingress:
- [email protected]
```
<!-- BEGIN TFDOC -->
## Variables
Expand All @@ -155,5 +156,5 @@ web-app-a-ingress:
| ingress_allow_rules | Ingress rules with allow blocks. | |
| ingress_deny_rules | Ingress rules with deny blocks. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion factories/firewall-vpc-rules/nested/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ web_frontends:
- [email protected]
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -139,5 +140,5 @@ web_frontends:
|---|---|:---:|
| vpc-firewall-rules | Generated VPC Firewall Rules | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion factories/subnets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ secondary_ip_ranges: # Opt- List of secondary IP ranges
# Secondary ranges in name: cidr format
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -66,5 +67,5 @@ secondary_ip_ranges: # Opt- List of secondary IP ranges
|---|---|:---:|
| subnet | Generated subnets | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion foundations/business-units/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The number of resources in this sample is kept to a minimum so as to make it gen

This sample uses a top-level folder to encapsulate projects that host resources that are not specific to a single environment. If no shared services are needed,the Terraform and audit modules can be easily attached to the root node, and the shared services folder and project removed from `main.tf`.


<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -57,5 +58,5 @@ This sample uses a top-level folder to encapsulate projects that host resources
| shared_resources_project | Project that holdes resources shared across business units. | |
| terraform_project | Project that holds the base Terraform resources. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion foundations/environments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ For more complex setups where multiple shared services projects are needed to en

If no shared services are needed, the shared service project module can of course be removed from `main.tf`.


<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -63,5 +64,5 @@ If no shared services are needed, the shared service project module can of cours
| shared_services_project | Project that holdes resources shared across environments. | |
| terraform_project | Project that holds the base Terraform resources. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/__experimental/net-neg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ module "neg" {
}
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -45,5 +46,5 @@ module "neg" {
| self_lnk | Network endpoint group self link | |
| size | Size of the network endpoint group | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/apigee-organization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ module "apigee-organization" {
# tftest:modules=1:resources=6
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -125,5 +126,5 @@ module "apigee-organization" {
| org_id | Apigee Organization ID. | |
| subscription_type | Apigee subscription type. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/apigee-x-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ module "apigee-x-instance" {
# tftest:modules=1:resources=5
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -66,5 +67,5 @@ module "apigee-x-instance" {
| instance | Apigee instance. | |
| port | Port number of the internal endpoint of the Apigee instance. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/artifact-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ module "docker_artifact_registry" {
# tftest:modules=1:resources=2
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -41,5 +42,5 @@ module "docker_artifact_registry" {
| id | Repository id | |
| name | Repository name | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/bigquery-dataset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ module "bigquery-dataset" {
# tftest:modules=1:resources=3
```


<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -208,6 +209,6 @@ module "bigquery-dataset" {
| view_ids | Map of fully qualified view ids keyed by view ids. | |
| views | View resources. | |


<!-- END TFDOC -->


3 changes: 2 additions & 1 deletion modules/bigtable-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module "bigtable-instance" {
# tftest:modules=1:resources=4
```


<!-- BEGIN TFDOC -->

## Variables
Expand Down Expand Up @@ -61,6 +62,6 @@ module "bigtable-instance" {
| table_ids | Map of fully qualified table ids keyed by table name. | |
| tables | Table resources. | |


<!-- END TFDOC -->


3 changes: 2 additions & 1 deletion modules/billing-budget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ module "pubsub" {
# tftest:modules=2:resources=2
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -87,5 +88,5 @@ module "pubsub" {
| budget | Budget resource. | |
| id | Budget ID. | |


<!-- END TFDOC -->

3 changes: 2 additions & 1 deletion modules/cloud-config-container/coredns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ module "cos-coredns" {
}
```


<!-- BEGIN TFDOC -->

## Variables
Expand All @@ -87,5 +88,5 @@ module "cos-coredns" {
|---|---|:---:|
| cloud_config | Rendered cloud-config file to be passed as user-data instance metadata. | |


<!-- END TFDOC -->

Loading

0 comments on commit 2bc5f7d

Please sign in to comment.