Add toggle to tfdoc to remove type hints (#3842)
* Add toggle to tfdoc to remove type hints * Update all readmes * Fix python formatting
This commit is contained in:
Julio Castillo
@@ -272,19 +272,19 @@ Security profiles group defined here are exported via output variable file, and
|
||||
|
||||
| name | description | type | required | default | producer |
|
||||
|---|---|:---:|:---:|:---:|:---:|
|
||||
| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | <code title="object({ outputs_bucket = string })">object({…})</code> | ✓ | | <code>0-bootstrap</code> |
|
||||
| [ngfw_config](variables.tf#L113) | Configuration for NGFW Enterprise endpoints. Billing project defaults to the automation project. Network and TLS inspection policy ids support interpolation. | <code title="object({ endpoint_zones = list(string) name = optional(string, "ngfw-0") network_associations = optional(map(object({ vpc_id = string disabled = optional(bool) tls_inspection_policy = optional(string) zones = optional(list(string)) })), {}) })">object({…})</code> | ✓ | | |
|
||||
| [organization](variables-fast.tf#L56) | Organization details. | <code title="object({ domain = string id = number customer_id = string })">object({…})</code> | ✓ | | <code>0-globals</code> |
|
||||
| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | <code>object({…})</code> | ✓ | | <code>0-bootstrap</code> |
|
||||
| [ngfw_config](variables.tf#L113) | Configuration for NGFW Enterprise endpoints. Billing project defaults to the automation project. Network and TLS inspection policy ids support interpolation. | <code>object({…})</code> | ✓ | | |
|
||||
| [organization](variables-fast.tf#L56) | Organization details. | <code>object({…})</code> | ✓ | | <code>0-globals</code> |
|
||||
| [project_id](variables.tf#L134) | Project where the network security resources will be created. | <code>string</code> | ✓ | | |
|
||||
| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | <code title="object({ skip_datasources = optional(bool, false) })">object({…})</code> | | <code>{}</code> | |
|
||||
| [certificate_authorities](variables.tf#L17) | Certificate Authority Service pool and CAs. If host project ids is null identical pools and CAs are created in every host project. | <code title="map(object({ location = string iam = optional(map(list(string)), {}) iam_bindings = optional(map(any), {}) iam_bindings_additive = optional(map(any), {}) iam_by_principals = optional(map(list(string)), {}) ca_configs = map(object({ deletion_protection = optional(string, true) type = optional(string, "SELF_SIGNED") is_ca = optional(bool, true) lifetime = optional(string, null) pem_ca_certificate = optional(string, null) ignore_active_certificates_on_deletion = optional(bool, false) skip_grace_period = optional(bool, true) labels = optional(map(string), null) gcs_bucket = optional(string, null) key_spec = optional(object({ algorithm = optional(string, "RSA_PKCS1_2048_SHA256") kms_key_id = optional(string, null) }), {}) key_usage = optional(object({ cert_sign = optional(bool, true) client_auth = optional(bool, false) code_signing = optional(bool, false) content_commitment = optional(bool, false) crl_sign = optional(bool, true) data_encipherment = optional(bool, false) decipher_only = optional(bool, false) digital_signature = optional(bool, false) email_protection = optional(bool, false) encipher_only = optional(bool, false) key_agreement = optional(bool, false) key_encipherment = optional(bool, true) ocsp_signing = optional(bool, false) server_auth = optional(bool, true) time_stamping = optional(bool, false) }), {}) subject = optional( object({ common_name = string organization = string country_code = optional(string) locality = optional(string) organizational_unit = optional(string) postal_code = optional(string) province = optional(string) street_address = optional(string) }), { common_name = "test.example.com" organization = "Test Example" } ) subject_alt_name = optional(object({ dns_names = optional(list(string), null) email_addresses = optional(list(string), null) ip_addresses = optional(list(string), null) uris = optional(list(string), null) }), null) subordinate_config = optional(object({ root_ca_id = optional(string) pem_issuer_certificates = optional(list(string)) }), null) })) ca_pool_config = optional(object({ create_pool = optional(object({ name = optional(string) tier = optional(string, "DEVOPS") })) use_pool = optional(object({ id = string })) })) }))">map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [certificate_authority_pools](variables-fast.tf#L36) | Certificate authority pools. | <code title="map(object({ id = string ca_ids = map(string) location = string }))">map(object({…}))</code> | | <code>{}</code> | <code>2-security</code> |
|
||||
| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [certificate_authorities](variables.tf#L17) | Certificate Authority Service pool and CAs. If host project ids is null identical pools and CAs are created in every host project. | <code>map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [certificate_authority_pools](variables-fast.tf#L36) | Certificate authority pools. | <code>map(object({…}))</code> | | <code>{}</code> | <code>2-security</code> |
|
||||
| [enable_services](variables.tf#L97) | Configure project by enabling services required for this add-on. | <code>bool</code> | | <code>true</code> | |
|
||||
| [host_project_ids](variables-fast.tf#L48) | Networking stage host project id aliases. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [names](variables.tf#L104) | Configuration for names used for output files. | <code title="object({ output_files_prefix = optional(string, "2-networking-ngfw") })">object({…})</code> | | <code>{}</code> | |
|
||||
| [names](variables.tf#L104) | Configuration for names used for output files. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [outputs_location](variables.tf#L128) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | <code>string</code> | | <code>null</code> | |
|
||||
| [security_profiles](variables.tf#L140) | Security profile groups for Layer 7 inspection. Null environment list means all environments. | <code title="map(object({ description = optional(string) threat_prevention_profile = optional(object({ severity_overrides = optional(map(object({ action = string severity = string }))) threat_overrides = optional(map(object({ action = string threat_id = string }))) }), {}) url_filtering_profile = optional(map(object({ action = string priority = number urls = optional(list(string), ["*"]) })), {}) }))">map(object({…}))</code> | | <code title="{ ngfw-default = {} }">{…}</code> | |
|
||||
| [tls_inspection_policies](variables.tf#L223) | TLS inspection policies configuration. CA pools, trust configs and host project ids support interpolation. | <code title="map(object({ ca_pool_id = string location = string exclude_public_ca_set = optional(bool) trust_config = optional(string) tls = optional(object({ custom_features = optional(list(string)) feature_profile = optional(string) min_version = optional(string) }), {}) }))">map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [trust_configs](variables.tf#L265) | Certificate Manager trust configurations for TLS inspection policies. Project ids and region can reference keys in the relevant FAST variables. | <code title="map(object({ location = string description = optional(string) allowlisted_certificates = optional(map(string)) trust_stores = optional(map(object({ intermediate_cas = optional(map(string)) trust_anchors = optional(map(string)) }))) }))">map(object({…}))</code> | | <code title="{ }">{…}</code> | |
|
||||
| [security_profiles](variables.tf#L140) | Security profile groups for Layer 7 inspection. Null environment list means all environments. | <code>map(object({…}))</code> | | <code>{…}</code> | |
|
||||
| [tls_inspection_policies](variables.tf#L223) | TLS inspection policies configuration. CA pools, trust configs and host project ids support interpolation. | <code>map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [trust_configs](variables.tf#L265) | Certificate Manager trust configurations for TLS inspection policies. Project ids and region can reference keys in the relevant FAST variables. | <code>map(object({…}))</code> | | <code>{…}</code> | |
|
||||
| [vpc_self_links](variables-fast.tf#L66) | VPC network self links. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
<!-- END TFDOC -->
|
||||
|
||||
@@ -151,21 +151,21 @@ terraform apply
|
||||
|
||||
| name | description | type | required | default | producer |
|
||||
|---|---|:---:|:---:|:---:|:---:|
|
||||
| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | <code title="object({ outputs_bucket = string })">object({…})</code> | ✓ | | <code>0-bootstrap</code> |
|
||||
| [certificate_authority](variables.tf#L17) | Optional Certificate Authority Service pool and CA used by SWP. | <code title="object({ iam = optional(map(list(string)), {}) iam_bindings = optional(map(any), {}) iam_bindings_additive = optional(map(any), {}) iam_by_principals = optional(map(list(string)), {}) ca_configs = map(object({ deletion_protection = optional(string, true) type = optional(string, "SELF_SIGNED") is_ca = optional(bool, true) lifetime = optional(string, null) pem_ca_certificate = optional(string, null) ignore_active_certificates_on_deletion = optional(bool, false) skip_grace_period = optional(bool, true) labels = optional(map(string), null) gcs_bucket = optional(string, null) key_spec = optional(object({ algorithm = optional(string, "RSA_PKCS1_2048_SHA256") kms_key_id = optional(string, null) }), {}) key_usage = optional(object({ cert_sign = optional(bool, true) client_auth = optional(bool, false) code_signing = optional(bool, false) content_commitment = optional(bool, false) crl_sign = optional(bool, true) data_encipherment = optional(bool, false) decipher_only = optional(bool, false) digital_signature = optional(bool, false) email_protection = optional(bool, false) encipher_only = optional(bool, false) key_agreement = optional(bool, false) key_encipherment = optional(bool, true) ocsp_signing = optional(bool, false) server_auth = optional(bool, true) time_stamping = optional(bool, false) }), {}) subject = optional( object({ common_name = string organization = string country_code = optional(string) locality = optional(string) organizational_unit = optional(string) postal_code = optional(string) province = optional(string) street_address = optional(string) }), { common_name = "test.example.com" organization = "Test Example" } ) subject_alt_name = optional(object({ dns_names = optional(list(string), null) email_addresses = optional(list(string), null) ip_addresses = optional(list(string), null) uris = optional(list(string), null) }), null) subordinate_config = optional(object({ root_ca_id = optional(string) pem_issuer_certificates = optional(list(string)) }), null) })) ca_pool_config = optional(object({ create_pool = optional(object({ name = optional(string) tier = optional(string, "DEVOPS") })) use_pool = optional(object({ id = string })) })) })">object({…})</code> | ✓ | | |
|
||||
| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | <code>object({…})</code> | ✓ | | <code>0-bootstrap</code> |
|
||||
| [certificate_authority](variables.tf#L17) | Optional Certificate Authority Service pool and CA used by SWP. | <code>object({…})</code> | ✓ | | |
|
||||
| [project_id](variables.tf#L143) | Project where the resources will be created. | <code>string</code> | ✓ | | |
|
||||
| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | <code title="object({ skip_datasources = optional(bool, false) })">object({…})</code> | | <code>{}</code> | |
|
||||
| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [enable_services](variables.tf#L95) | Configure project by enabling services required for this add-on. | <code>bool</code> | | <code>false</code> | |
|
||||
| [factories_config](variables.tf#L102) | SWP factories configuration paths. Keys in the `swp_configs` variable will be appended to derive individual SWP factory paths. | <code title="object({ policy_rules = optional(string, "data/policy-rules") url_lists = optional(string, "data/url-lists") })">object({…})</code> | | <code>{}</code> | |
|
||||
| [factories_config](variables.tf#L102) | SWP factories configuration paths. Keys in the `swp_configs` variable will be appended to derive individual SWP factory paths. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [host_project_ids](variables-fast.tf#L36) | Networking stage host project id aliases. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [locations](variables.tf#L112) | Regions where the resources will be created. Keys are used as short names appended to resource names. Interpolation with FAST region names is supported. | <code>map(string)</code> | | <code>{}</code> | |
|
||||
| [name](variables.tf#L119) | Name used for resource names. | <code>string</code> | | <code>"swp"</code> | |
|
||||
| [outputs_location](variables.tf#L126) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | <code>string</code> | | <code>null</code> | |
|
||||
| [policy_rules_contexts](variables.tf#L132) | Replacement contexts for policy rules matcher arguments. | <code title="object({ secure_tags = optional(map(string), {}) service_accounts = optional(map(string), {}) url_lists = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> | |
|
||||
| [policy_rules_contexts](variables.tf#L132) | Replacement contexts for policy rules matcher arguments. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [regions](variables-fast.tf#L44) | Networking stage region aliases. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [subnet_self_links](variables-fast.tf#L52) | VPC subnetwork self links. | <code>map(map(string))</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [swp_configs](variables.tf#L149) | Secure Web Proxy configuration, one per region. | <code title="map(object({ network_id = string subnetwork_id = string certificates = optional(list(string), []) tls_inspection_policy_id = optional(string, null) gateway_config = optional(object({ addresses = optional(list(string), []) delete_router_on_destroy = optional(bool, true) labels = optional(map(string), {}) next_hop_routing_mode = optional(bool, false) ports = optional(list(string), [443]) scope = optional(string) }), {}) service_attachment = optional(object({ nat_subnets = list(string) automatic_connection = optional(bool, false) consumer_accept_lists = optional(map(string), {}) consumer_reject_lists = optional(list(string)) description = optional(string) domain_name = optional(string) enable_proxy_protocol = optional(bool, false) reconcile_connections = optional(bool) })) }))">map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [tls_inspection_policy](variables.tf#L179) | TLS inspection policy configuration. If a CA pool is not specified a local one must be created via the `certificate_authority` variable. | <code title="object({ ca_pool_id = optional(string) exclude_public_ca_set = optional(bool) tls = optional(object({ custom_features = optional(list(string)) feature_profile = optional(string) min_version = optional(string) })) })">object({…})</code> | | <code>null</code> | |
|
||||
| [swp_configs](variables.tf#L149) | Secure Web Proxy configuration, one per region. | <code>map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [tls_inspection_policy](variables.tf#L179) | TLS inspection policy configuration. If a CA pool is not specified a local one must be created via the `certificate_authority` variable. | <code>object({…})</code> | | <code>null</code> | |
|
||||
| [vpc_self_links](variables-fast.tf#L60) | VPC network self links. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
@@ -97,13 +97,13 @@ terraform apply
|
||||
|
||||
| name | description | type | required | default | producer |
|
||||
|---|---|:---:|:---:|:---:|:---:|
|
||||
| [factories_config](variables.tf#L17) | Configuration for the resource factories. | <code title="object({ instances = optional(string, "data/instances") service_accounts = optional(string, "data/service-accounts") })">object({…})</code> | | <code>{}</code> | |
|
||||
| [factories_config](variables.tf#L17) | Configuration for the resource factories. | <code>object({…})</code> | | <code>{}</code> | |
|
||||
| [host_project_ids](variables-fast.tf#L19) | Networking stage host project id aliases. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [name](variables.tf#L27) | Prefix used for all resource names. | <code>string</code> | | <code>"test"</code> | |
|
||||
| [regions](variables-fast.tf#L27) | Region aliases. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [subnet_self_links](variables-fast.tf#L35) | Subnet self links. | <code>map(map(string))</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
| [test_instances](variables.tf#L34) | Test instances to be created. | <code title="map(object({ project_id = string network_id = string service_account = string subnet_id = string image = optional(string) metadata = optional(map(string), {}) tags = optional(list(string), ["ssh"]) type = optional(string, "e2-micro") user_data_file = optional(string) zones = optional(list(string), ["b"]) }))">map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [test_service_accounts](variables.tf#L52) | Service accounts used by instances. | <code title="map(object({ project_id = string display_name = optional(string) iam_project_roles = optional(map(list(string)), {}) }))">map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [test_instances](variables.tf#L34) | Test instances to be created. | <code>map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [test_service_accounts](variables.tf#L52) | Service accounts used by instances. | <code>map(object({…}))</code> | | <code>{}</code> | |
|
||||
| [vpc_self_links](variables-fast.tf#L43) | VPC network self links. | <code>map(string)</code> | | <code>{}</code> | <code>2-networking</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
Reference in New Issue
Block a user