Skip to content

Commit 31f625f

Browse files
julioccjuliocc
committed
Link vars and outputs from README
1 parent b56a231 commit 31f625f

File tree

82 files changed

+1243
-1495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+1243
-1495
lines changed

‎examples/cloud-operations/asset-inventory-feed-remediation/README.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -50,30 +50,25 @@ Run the `subscription_pull` command until it returns nothing, then run the follo
5050
- the `tag_add` command
5151
- the `cf_logs` command until the logs show that the change has been picked up, verified, and the compliant tags have been force-set on the instance
5252
- the `tag_show` command to verify that the function output matches the resource state
53-
54-
55-
5653
<!-- BEGIN TFDOC -->
5754

5855
## Variables
5956

6057
| name | description | type | required | default |
6158
|---|---|:---:|:---:|:---:|
62-
| project_id | Project id that references existing project. | <code>string</code> | ✓ | |
63-
| bundle_path | Path used to write the intermediate Cloud Function code bundle. | <code>string</code> | | <code>&#34;.&#47;bundle.zip&#34;</code> |
64-
| name | Arbitrary string used to name created resources. | <code>string</code> | | <code>&#34;asset-feed&#34;</code> |
65-
| project_create | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
66-
| region | Compute region used in the example. | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
59+
| [project_id](variables.tf#L35) | Project id that references existing project. | <code>string</code> | ✓ | |
60+
| [bundle_path](variables.tf#L17) | Path used to write the intermediate Cloud Function code bundle. | <code>string</code> | | <code>&#34;.&#47;bundle.zip&#34;</code> |
61+
| [name](variables.tf#L23) | Arbitrary string used to name created resources. | <code>string</code> | | <code>&#34;asset-feed&#34;</code> |
62+
| [project_create](variables.tf#L29) | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
63+
| [region](variables.tf#L40) | Compute region used in the example. | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
6764

6865
## Outputs
6966

7067
| name | description | sensitive |
7168
|---|---|:---:|
72-
| cf_logs | Cloud Function logs read command. | |
73-
| subscription_pull | Subscription pull command. | |
74-
| tag_add | Instance add tag command. | |
75-
| tag_show | Instance add tag command. | |
69+
| [cf_logs](outputs.tf#L17) | Cloud Function logs read command. | |
70+
| [subscription_pull](outputs.tf#L29) | Subscription pull command. | |
71+
| [tag_add](outputs.tf#L39) | Instance add tag command. | |
72+
| [tag_show](outputs.tf#L49) | Instance add tag command. | |
7673

7774
<!-- END TFDOC -->
78-
79-

‎examples/cloud-operations/dns-fine-grained-iam/README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -98,26 +98,23 @@ dig app1.svc.example.org +short
9898
# 127.0.0.3
9999
# 127.0.0.7
100100
```
101-
102-
103101
<!-- BEGIN TFDOC -->
104102

105103
## Variables
106104

107105
| name | description | type | required | default |
108106
|---|---|:---:|:---:|:---:|
109-
| project_id | Existing project id. | <code>string</code> | ✓ | |
110-
| name | Arbitrary string used to name created resources. | <code>string</code> | | <code>&#34;dns-sd-test&#34;</code> |
111-
| project_create | Create project instead ofusing an existing one. | <code>bool</code> | | <code>false</code> |
112-
| region | Compute region used in the example. | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
113-
| zone_domain | Domain name used for the DNS zone. | <code>string</code> | | <code>&#34;svc.example.org.&#34;</code> |
107+
| [project_id](variables.tf#L29) | Existing project id. | <code>string</code> | ✓ | |
108+
| [name](variables.tf#L17) | Arbitrary string used to name created resources. | <code>string</code> | | <code>&#34;dns-sd-test&#34;</code> |
109+
| [project_create](variables.tf#L23) | Create project instead ofusing an existing one. | <code>bool</code> | | <code>false</code> |
110+
| [region](variables.tf#L34) | Compute region used in the example. | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
111+
| [zone_domain](variables.tf#L40) | Domain name used for the DNS zone. | <code>string</code> | | <code>&#34;svc.example.org.&#34;</code> |
114112

115113
## Outputs
116114

117115
| name | description | sensitive |
118116
|---|---|:---:|
119-
| gcloud_commands | Commands used to SSH to the VMs. | |
120-
| vms | VM names. | |
117+
| [gcloud_commands](outputs.tf#L17) | Commands used to SSH to the VMs. | |
118+
| [vms](outputs.tf#L25) | VM names. | |
121119

122120
<!-- END TFDOC -->
123-

‎examples/cloud-operations/dns-shared-vpc/README.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,24 @@ The resources created in this example are shown in the high level diagram below:
1818
<img src="diagram.png" width="640px">
1919

2020
Note that Terraform 0.13 at least is required due to the use of `for_each` with modules.
21-
22-
2321
<!-- BEGIN TFDOC -->
2422

2523
## Variables
2624

2725
| name | description | type | required | default |
2826
|---|---|:---:|:---:|:---:|
29-
| billing_account_id | Billing account associated with the GCP Projects that will be created for each team. | <code>string</code> | ✓ | |
30-
| folder_id | Folder ID in which DNS projects will be created. | <code>string</code> | ✓ | |
31-
| shared_vpc_link | Shared VPC self link, used for DNS peering. | <code>string</code> | ✓ | |
32-
| dns_domain | DNS domain under which each application team DNS domain will be created. | <code>string</code> | | <code>&#34;example.org&#34;</code> |
33-
| prefix | Customer name to use as prefix for resources' naming. | <code>string</code> | | <code>&#34;test-dns&#34;</code> |
34-
| project_services | Service APIs enabled by default. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;compute.googleapis.com&#34;,&#10; &#34;dns.googleapis.com&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
35-
| teams | List of application teams requiring their own Cloud DNS instance. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;team1&#34;,&#10; &#34;team2&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
27+
| [billing_account_id](variables.tf#L17) | Billing account associated with the GCP Projects that will be created for each team. | <code>string</code> | ✓ | |
28+
| [folder_id](variables.tf#L28) | Folder ID in which DNS projects will be created. | <code>string</code> | ✓ | |
29+
| [shared_vpc_link](variables.tf#L48) | Shared VPC self link, used for DNS peering. | <code>string</code> | ✓ | |
30+
| [dns_domain](variables.tf#L22) | DNS domain under which each application team DNS domain will be created. | <code>string</code> | | <code>&#34;example.org&#34;</code> |
31+
| [prefix](variables.tf#L33) | Customer name to use as prefix for resources' naming. | <code>string</code> | | <code>&#34;test-dns&#34;</code> |
32+
| [project_services](variables.tf#L39) | Service APIs enabled by default. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;compute.googleapis.com&#34;,&#10; &#34;dns.googleapis.com&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
33+
| [teams](variables.tf#L53) | List of application teams requiring their own Cloud DNS instance. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;team1&#34;,&#10; &#34;team2&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
3634

3735
## Outputs
3836

3937
| name | description | sensitive |
4038
|---|---|:---:|
41-
| teams | Team resources | |
39+
| [teams](outputs.tf#L17) | Team resources | |
4240

4341
<!-- END TFDOC -->
44-

‎examples/cloud-operations/iam-delegated-role-grants/README.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,17 @@ If you get any warnings, check the roles and remove any of them granting any of
6262
- `resourcemanager.projects.setIamPolicy`
6363
- `resourcemanager.folders.setIamPolicy`
6464
- `resourcemanager.organizations.setIamPolicy`
65-
66-
67-
6865
<!-- BEGIN TFDOC -->
6966

7067
## Variables
7168

7269
| name | description | type | required | default |
7370
|---|---|:---:|:---:|:---:|
74-
| project_administrators | List identities granted administrator permissions. | <code>list&#40;string&#41;</code> | ✓ | |
75-
| project_id | GCP project id where to grant direct and delegated roles to the users listed in project_administrators. | <code>string</code> | ✓ | |
76-
| delegated_role_grants | List of roles that project administrators will be allowed to grant/revoke. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;roles&#47;storage.admin&#34;,&#10; &#34;roles&#47;storage.hmacKeyAdmin&#34;,&#10; &#34;roles&#47;storage.legacyBucketOwner&#34;,&#10; &#34;roles&#47;storage.objectAdmin&#34;,&#10; &#34;roles&#47;storage.objectCreator&#34;,&#10; &#34;roles&#47;storage.objectViewer&#34;,&#10; &#34;roles&#47;compute.admin&#34;,&#10; &#34;roles&#47;compute.imageUser&#34;,&#10; &#34;roles&#47;compute.instanceAdmin&#34;,&#10; &#34;roles&#47;compute.instanceAdmin.v1&#34;,&#10; &#34;roles&#47;compute.networkAdmin&#34;,&#10; &#34;roles&#47;compute.networkUser&#34;,&#10; &#34;roles&#47;compute.networkViewer&#34;,&#10; &#34;roles&#47;compute.orgFirewallPolicyAdmin&#34;,&#10; &#34;roles&#47;compute.orgFirewallPolicyUser&#34;,&#10; &#34;roles&#47;compute.orgSecurityPolicyAdmin&#34;,&#10; &#34;roles&#47;compute.orgSecurityPolicyUser&#34;,&#10; &#34;roles&#47;compute.orgSecurityResourceAdmin&#34;,&#10; &#34;roles&#47;compute.osAdminLogin&#34;,&#10; &#34;roles&#47;compute.osLogin&#34;,&#10; &#34;roles&#47;compute.osLoginExternalUser&#34;,&#10; &#34;roles&#47;compute.packetMirroringAdmin&#34;,&#10; &#34;roles&#47;compute.packetMirroringUser&#34;,&#10; &#34;roles&#47;compute.publicIpAdmin&#34;,&#10; &#34;roles&#47;compute.securityAdmin&#34;,&#10; &#34;roles&#47;compute.serviceAgent&#34;,&#10; &#34;roles&#47;compute.storageAdmin&#34;,&#10; &#34;roles&#47;compute.viewer&#34;,&#10; &#34;roles&#47;viewer&#34;&#10;&#93;">&#91;&#8230;&#93;</code> |
77-
| direct_role_grants | List of roles granted directly to project administrators. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;roles&#47;compute.admin&#34;,&#10; &#34;roles&#47;storage.admin&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
78-
| project_create | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
79-
| restricted_role_grant | Role grant to which the restrictions will apply. | <code>string</code> | | <code>&#34;roles&#47;resourcemanager.projectIamAdmin&#34;</code> |
71+
| [project_administrators](variables.tf#L62) | List identities granted administrator permissions. | <code>list&#40;string&#41;</code> | ✓ | |
72+
| [project_id](variables.tf#L73) | GCP project id where to grant direct and delegated roles to the users listed in project_administrators. | <code>string</code> | ✓ | |
73+
| [delegated_role_grants](variables.tf#L17) | List of roles that project administrators will be allowed to grant/revoke. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;roles&#47;storage.admin&#34;,&#10; &#34;roles&#47;storage.hmacKeyAdmin&#34;,&#10; &#34;roles&#47;storage.legacyBucketOwner&#34;,&#10; &#34;roles&#47;storage.objectAdmin&#34;,&#10; &#34;roles&#47;storage.objectCreator&#34;,&#10; &#34;roles&#47;storage.objectViewer&#34;,&#10; &#34;roles&#47;compute.admin&#34;,&#10; &#34;roles&#47;compute.imageUser&#34;,&#10; &#34;roles&#47;compute.instanceAdmin&#34;,&#10; &#34;roles&#47;compute.instanceAdmin.v1&#34;,&#10; &#34;roles&#47;compute.networkAdmin&#34;,&#10; &#34;roles&#47;compute.networkUser&#34;,&#10; &#34;roles&#47;compute.networkViewer&#34;,&#10; &#34;roles&#47;compute.orgFirewallPolicyAdmin&#34;,&#10; &#34;roles&#47;compute.orgFirewallPolicyUser&#34;,&#10; &#34;roles&#47;compute.orgSecurityPolicyAdmin&#34;,&#10; &#34;roles&#47;compute.orgSecurityPolicyUser&#34;,&#10; &#34;roles&#47;compute.orgSecurityResourceAdmin&#34;,&#10; &#34;roles&#47;compute.osAdminLogin&#34;,&#10; &#34;roles&#47;compute.osLogin&#34;,&#10; &#34;roles&#47;compute.osLoginExternalUser&#34;,&#10; &#34;roles&#47;compute.packetMirroringAdmin&#34;,&#10; &#34;roles&#47;compute.packetMirroringUser&#34;,&#10; &#34;roles&#47;compute.publicIpAdmin&#34;,&#10; &#34;roles&#47;compute.securityAdmin&#34;,&#10; &#34;roles&#47;compute.serviceAgent&#34;,&#10; &#34;roles&#47;compute.storageAdmin&#34;,&#10; &#34;roles&#47;compute.viewer&#34;,&#10; &#34;roles&#47;viewer&#34;&#10;&#93;">&#91;&#8230;&#93;</code> |
74+
| [direct_role_grants](variables.tf#L53) | List of roles granted directly to project administrators. | <code>list&#40;string&#41;</code> | | <code title="&#91;&#10; &#34;roles&#47;compute.admin&#34;,&#10; &#34;roles&#47;storage.admin&#34;,&#10;&#93;">&#91;&#8230;&#93;</code> |
75+
| [project_create](variables.tf#L67) | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
76+
| [restricted_role_grant](variables.tf#L78) | Role grant to which the restrictions will apply. | <code>string</code> | | <code>&#34;roles&#47;resourcemanager.projectIamAdmin&#34;</code> |
8077

8178
<!-- END TFDOC -->
82-

‎examples/cloud-operations/onprem-sa-key-management/README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -60,24 +60,21 @@ gcloud auth activate-service-account --key-file data-uploader.json
6060
```bash
6161
terraform destroy -var project_id=$GOOGLE_CLOUD_PROJECT
6262
```
63-
64-
6563
<!-- BEGIN TFDOC -->
6664

6765
## Variables
6866

6967
| name | description | type | required | default |
7068
|---|---|:---:|:---:|:---:|
71-
| project_id | Project id. | <code>string</code> | ✓ | |
72-
| project_create | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
73-
| service_accounts | List of service accounts. | <code title="list&#40;object&#40;&#123;&#10; name &#61; string&#10; iam_project_roles &#61; list&#40;string&#41;&#10; public_keys_path &#61; string&#10;&#125;&#41;&#41;">list&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code title="&#91;&#10; &#123;&#10; name &#61; &#34;data-uploader&#34;&#10; iam_project_roles &#61; &#91;&#10; &#34;roles&#47;bigquery.dataOwner&#34;,&#10; &#34;roles&#47;bigquery.jobUser&#34;,&#10; &#34;roles&#47;storage.objectAdmin&#34;&#10; &#93;&#10; public_keys_path &#61; &#34;public-keys&#47;data-uploader&#47;&#34;&#10; &#125;,&#10; &#123;&#10; name &#61; &#34;prisma-security&#34;&#10; iam_project_roles &#61; &#91;&#10; &#34;roles&#47;iam.securityReviewer&#34;&#10; &#93;&#10; public_keys_path &#61; &#34;public-keys&#47;prisma-security&#47;&#34;&#10; &#125;,&#10;&#93;">&#91;&#8230;&#93;</code> |
74-
| services | Service APIs to enable. | <code>list&#40;string&#41;</code> | | <code>&#91;&#93;</code> |
69+
| [project_id](variables.tf#L23) | Project id. | <code>string</code> | ✓ | |
70+
| [project_create](variables.tf#L17) | Create project instead of using an existing one. | <code>bool</code> | | <code>false</code> |
71+
| [service_accounts](variables.tf#L28) | List of service accounts. | <code title="list&#40;object&#40;&#123;&#10; name &#61; string&#10; iam_project_roles &#61; list&#40;string&#41;&#10; public_keys_path &#61; string&#10;&#125;&#41;&#41;">list&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code title="&#91;&#10; &#123;&#10; name &#61; &#34;data-uploader&#34;&#10; iam_project_roles &#61; &#91;&#10; &#34;roles&#47;bigquery.dataOwner&#34;,&#10; &#34;roles&#47;bigquery.jobUser&#34;,&#10; &#34;roles&#47;storage.objectAdmin&#34;&#10; &#93;&#10; public_keys_path &#61; &#34;public-keys&#47;data-uploader&#47;&#34;&#10; &#125;,&#10; &#123;&#10; name &#61; &#34;prisma-security&#34;&#10; iam_project_roles &#61; &#91;&#10; &#34;roles&#47;iam.securityReviewer&#34;&#10; &#93;&#10; public_keys_path &#61; &#34;public-keys&#47;prisma-security&#47;&#34;&#10; &#125;,&#10;&#93;">&#91;&#8230;&#93;</code> |
72+
| [services](variables.tf#L56) | Service APIs to enable. | <code>list&#40;string&#41;</code> | | <code>&#91;&#93;</code> |
7573

7674
## Outputs
7775

7876
| name | description | sensitive |
7977
|---|---|:---:|
80-
| sa-credentials | SA json key templates. | |
78+
| [sa-credentials](outputs.tf#L17) | SA json key templates. | |
8179

8280
<!-- END TFDOC -->
83-

‎examples/cloud-operations/packer-image-builder/README.md

+14-17
Original file line numberDiff line numberDiff line change
@@ -66,33 +66,30 @@ configurations respectively.
6666
The following example assumes that provisioning of a Compute Engine VM requires access to
6767
the resources over the Internet (i.e. to install OS packages). Since Compute VM has no public IP
6868
address for security reasons, Internet connectivity is done with [Cloud NAT](https://cloud.google.com/nat/docs/overview).
69-
70-
7169
<!-- BEGIN TFDOC -->
7270

7371
## Variables
7472

7573
| name | description | type | required | default |
7674
|---|---|:---:|:---:|:---:|
77-
| project_id | Project id that references existing project. | <code>string</code> | ✓ | |
78-
| billing_account | Billing account id used as default for new projects. | <code>string</code> | | <code>null</code> |
79-
| cidrs | CIDR ranges for subnets | <code>map&#40;string&#41;</code> | | <code title="&#123;&#10; image-builder &#61; &#34;10.0.0.0&#47;24&#34;&#10;&#125;">&#123;&#8230;&#125;</code> |
80-
| create_packer_vars | Create packer variables file using template file and terraform output. | <code>bool</code> | | <code>false</code> |
81-
| packer_account_users | List of members that will be allowed to impersonate Packer image builder service account in IAM format, i.e. 'user:{emailid}'. | <code>list&#40;string&#41;</code> | | <code>&#91;&#93;</code> |
82-
| packer_source_cidrs | List of CIDR ranges allowed to connect to the temporary VM for provisioning. | <code>list&#40;string&#41;</code> | | <code>&#91;&#34;0.0.0.0&#47;0&#34;&#93;</code> |
83-
| project_create | Create project instead of using an existing one. | <code>bool</code> | | <code>true</code> |
84-
| region | Default region for resources | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
85-
| root_node | The resource name of the parent folder or organization for project creation, in 'folders/folder_id' or 'organizations/org_id' format. | <code>string</code> | | <code>null</code> |
86-
| use_iap | Use IAP tunnel to connect to Compute Engine instance for provisioning. | <code>bool</code> | | <code>true</code> |
75+
| [project_id](variables.tf#L55) | Project id that references existing project. | <code>string</code> | ✓ | |
76+
| [billing_account](variables.tf#L17) | Billing account id used as default for new projects. | <code>string</code> | | <code>null</code> |
77+
| [cidrs](variables.tf#L23) | CIDR ranges for subnets | <code>map&#40;string&#41;</code> | | <code title="&#123;&#10; image-builder &#61; &#34;10.0.0.0&#47;24&#34;&#10;&#125;">&#123;&#8230;&#125;</code> |
78+
| [create_packer_vars](variables.tf#L31) | Create packer variables file using template file and terraform output. | <code>bool</code> | | <code>false</code> |
79+
| [packer_account_users](variables.tf#L37) | List of members that will be allowed to impersonate Packer image builder service account in IAM format, i.e. 'user:{emailid}'. | <code>list&#40;string&#41;</code> | | <code>&#91;&#93;</code> |
80+
| [packer_source_cidrs](variables.tf#L43) | List of CIDR ranges allowed to connect to the temporary VM for provisioning. | <code>list&#40;string&#41;</code> | | <code>&#91;&#34;0.0.0.0&#47;0&#34;&#93;</code> |
81+
| [project_create](variables.tf#L49) | Create project instead of using an existing one. | <code>bool</code> | | <code>true</code> |
82+
| [region](variables.tf#L60) | Default region for resources | <code>string</code> | | <code>&#34;europe-west1&#34;</code> |
83+
| [root_node](variables.tf#L66) | The resource name of the parent folder or organization for project creation, in 'folders/folder_id' or 'organizations/org_id' format. | <code>string</code> | | <code>null</code> |
84+
| [use_iap](variables.tf#L72) | Use IAP tunnel to connect to Compute Engine instance for provisioning. | <code>bool</code> | | <code>true</code> |
8785

8886
## Outputs
8987

9088
| name | description | sensitive |
9189
|---|---|:---:|
92-
| builder_sa | Packer's service account email. | |
93-
| compute_sa | Packer's temporary VM service account email. | |
94-
| compute_subnetwork | Name of a subnetwork for Packer's temporary VM. | |
95-
| compute_zone | Name of a compute engine zone for Packer's temporary VM. | |
90+
| [builder_sa](outputs.tf#L17) | Packer's service account email. | |
91+
| [compute_sa](outputs.tf#L22) | Packer's temporary VM service account email. | |
92+
| [compute_subnetwork](outputs.tf#L27) | Name of a subnetwork for Packer's temporary VM. | |
93+
| [compute_zone](outputs.tf#L32) | Name of a compute engine zone for Packer's temporary VM. | |
9694

9795
<!-- END TFDOC -->
98-

0 commit comments

Comments
 (0)