slight change to readme thanks to tfdoc
This commit is contained in:
Dave Gulli
parent
8c264da200
commit
3c0391db5c
|
|
@ -20,6 +20,7 @@ This module allows creation and management of VPC networks including subnetworks
|
|||
- [Private Google Access routes](#private-google-access-routes)
|
||||
- [Allow Firewall Policy to be evaluated before Firewall Rules](#allow-firewall-policy-to-be-evaluated-before-firewall-rules)
|
||||
- [IPv6](#ipv6)
|
||||
- [Files](#files)
|
||||
- [Variables](#variables)
|
||||
- [Outputs](#outputs)
|
||||
<!-- END TOC -->
|
||||
|
|
@ -531,6 +532,18 @@ module "vpc" {
|
|||
# tftest modules=1 resources=5 inventory=ipv6.yaml
|
||||
```
|
||||
<!-- BEGIN TFDOC -->
|
||||
## Files
|
||||
|
||||
| name | description | resources |
|
||||
|---|---|---|
|
||||
| [main.tf](./main.tf) | Module-level locals and resources. | <code>google_compute_network</code> · <code>google_compute_network_peering</code> · <code>google_compute_shared_vpc_host_project</code> · <code>google_compute_shared_vpc_service_project</code> · <code>google_dns_policy</code> |
|
||||
| [outputs.tf](./outputs.tf) | Module outputs. | |
|
||||
| [psa.tf](./psa.tf) | Private Service Access resources. | <code>google_compute_global_address</code> · <code>google_compute_network_peering_routes_config</code> · <code>google_service_networking_connection</code> |
|
||||
| [routes.tf](./routes.tf) | Route resources. | <code>google_compute_route</code> |
|
||||
| [subnets.tf](./subnets.tf) | Subnet resources. | <code>google_compute_subnetwork</code> · <code>google_compute_subnetwork_iam_binding</code> · <code>google_compute_subnetwork_iam_member</code> |
|
||||
| [variables.tf](./variables.tf) | Module variables. | |
|
||||
| [versions.tf](./versions.tf) | Version pins. | |
|
||||
|
||||
## Variables
|
||||
|
||||
| name | description | type | required | default |
|
||||
|
|
@ -556,9 +569,10 @@ module "vpc" {
|
|||
| [subnet_iam_bindings](variables.tf#L173) | Authoritative IAM bindings in {REGION/NAME => {ROLE => {members = [], condition = {}}}}. | <code title="map(map(object({ members = list(string) condition = optional(object({ expression = string title = string description = optional(string) })) })))">map(map(object({…})))</code> | | <code>{}</code> |
|
||||
| [subnet_iam_bindings_additive](variables.tf#L187) | Individual additive IAM bindings. Keys are arbitrary. | <code title="map(object({ member = string role = string subnet = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [subnets](variables.tf#L203) | Subnet configuration. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) enable_private_access = optional(bool, true) flow_logs_config = optional(object({ aggregation_interval = optional(string) filter_expression = optional(string) flow_sampling = optional(number) metadata = optional(string) metadata_fields = optional(list(string)) })) ipv6 = optional(object({ access_type = optional(string, "INTERNAL") })) secondary_ip_ranges = optional(map(string)) }))">list(object({…}))</code> | | <code>[]</code> |
|
||||
| [subnets_global_proxy_only](variables.tf#L243) | List of proxy-only subnets for Cross-region Internal HTTPS load balancers. Note: Only one proxy-only subnet for each VPC network in each region can be active. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) active = bool }))">list(object({…}))</code> | | <code>[]</code> |
|
||||
| [subnets_proxy_only](variables.tf#L230) | List of proxy-only subnets for Regional HTTPS or Internal HTTPS load balancers. Note: Only one proxy-only subnet for each VPC network in each region can be active. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) active = bool }))">list(object({…}))</code> | | <code>[]</code> |
|
||||
| [subnets_psc](variables.tf#L243) | List of subnets for Private Service Connect service producers. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) }))">list(object({…}))</code> | | <code>[]</code> |
|
||||
| [vpc_create](variables.tf#L255) | Create VPC. When set to false, uses a data source to reference existing VPC. | <code>bool</code> | | <code>true</code> |
|
||||
| [subnets_psc](variables.tf#L255) | List of subnets for Private Service Connect service producers. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) }))">list(object({…}))</code> | | <code>[]</code> |
|
||||
| [vpc_create](variables.tf#L267) | Create VPC. When set to false, uses a data source to reference existing VPC. | <code>bool</code> | | <code>true</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
|
@ -577,6 +591,7 @@ module "vpc" {
|
|||
| [subnet_secondary_ranges](outputs.tf#L110) | Map of subnet secondary ranges keyed by name. | |
|
||||
| [subnet_self_links](outputs.tf#L121) | Map of subnet self links keyed by name. | |
|
||||
| [subnets](outputs.tf#L126) | Subnet resources. | |
|
||||
| [subnets_global_proxy_only](outputs.tf#L141) | Cross-region internal L7 ILB resources | |
|
||||
| [subnets_proxy_only](outputs.tf#L131) | L7 ILB or L7 Regional LB subnet resources. | |
|
||||
| [subnets_psc](outputs.tf#L136) | Private Service Connect subnet resources. | |
|
||||
<!-- END TFDOC -->
|
||||
|
|
|
|||
|
|
@ -139,6 +139,6 @@ output "subnets_psc" {
|
|||
}
|
||||
|
||||
output "subnets_global_proxy_only" {
|
||||
description = "Cross-region internal L7 ILB"
|
||||
description = "Cross-region internal L7 ILB resources"
|
||||
value = { for k, v in google_compute_subnetwork.global_proxy_only : k => v }
|
||||
}
|
||||
Loading…
Reference in New Issue