diff --git a/fast/addons/2-networking-ngfw/README.md b/fast/addons/2-networking-ngfw/README.md index 93f6540bb..17cc71965 100644 --- a/fast/addons/2-networking-ngfw/README.md +++ b/fast/addons/2-networking-ngfw/README.md @@ -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. | object({…}) | ✓ | | 0-bootstrap | -| [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. | object({…}) | ✓ | | | -| [organization](variables-fast.tf#L56) | Organization details. | object({…}) | ✓ | | 0-globals | +| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-bootstrap | +| [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. | object({…}) | ✓ | | | +| [organization](variables-fast.tf#L56) | Organization details. | object({…}) | ✓ | | 0-globals | | [project_id](variables.tf#L134) | Project where the network security resources will be created. | string | ✓ | | | -| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | object({…}) | | {} | | -| [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. | map(object({…})) | | {} | | -| [certificate_authority_pools](variables-fast.tf#L36) | Certificate authority pools. | map(object({…})) | | {} | 2-security | +| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | object({…}) | | {} | | +| [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. | map(object({…})) | | {} | | +| [certificate_authority_pools](variables-fast.tf#L36) | Certificate authority pools. | map(object({…})) | | {} | 2-security | | [enable_services](variables.tf#L97) | Configure project by enabling services required for this add-on. | bool | | true | | | [host_project_ids](variables-fast.tf#L48) | Networking stage host project id aliases. | map(string) | | {} | 2-networking | -| [names](variables.tf#L104) | Configuration for names used for output files. | object({…}) | | {} | | +| [names](variables.tf#L104) | Configuration for names used for output files. | object({…}) | | {} | | | [outputs_location](variables.tf#L128) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | -| [security_profiles](variables.tf#L140) | Security profile groups for Layer 7 inspection. Null environment list means all environments. | map(object({…})) | | {…} | | -| [tls_inspection_policies](variables.tf#L223) | TLS inspection policies configuration. CA pools, trust configs and host project ids support interpolation. | map(object({…})) | | {} | | -| [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. | map(object({…})) | | {…} | | +| [security_profiles](variables.tf#L140) | Security profile groups for Layer 7 inspection. Null environment list means all environments. | map(object({…})) | | {…} | | +| [tls_inspection_policies](variables.tf#L223) | TLS inspection policies configuration. CA pools, trust configs and host project ids support interpolation. | map(object({…})) | | {} | | +| [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. | map(object({…})) | | {…} | | | [vpc_self_links](variables-fast.tf#L66) | VPC network self links. | map(string) | | {} | 2-networking | diff --git a/fast/addons/2-networking-swp/README.md b/fast/addons/2-networking-swp/README.md index 3070a4d28..89ff9ce4f 100644 --- a/fast/addons/2-networking-swp/README.md +++ b/fast/addons/2-networking-swp/README.md @@ -151,21 +151,21 @@ terraform apply | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-bootstrap | -| [certificate_authority](variables.tf#L17) | Optional Certificate Authority Service pool and CA used by SWP. | object({…}) | ✓ | | | +| [automation](variables-fast.tf#L28) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-bootstrap | +| [certificate_authority](variables.tf#L17) | Optional Certificate Authority Service pool and CA used by SWP. | object({…}) | ✓ | | | | [project_id](variables.tf#L143) | Project where the resources will be created. | string | ✓ | | | -| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | object({…}) | | {} | | +| [_fast_debug](variables-fast.tf#L19) | Internal FAST variable used for testing and debugging. Do not use. | object({…}) | | {} | | | [enable_services](variables.tf#L95) | Configure project by enabling services required for this add-on. | bool | | false | | -| [factories_config](variables.tf#L102) | SWP factories configuration paths. Keys in the `swp_configs` variable will be appended to derive individual SWP factory paths. | object({…}) | | {} | | +| [factories_config](variables.tf#L102) | SWP factories configuration paths. Keys in the `swp_configs` variable will be appended to derive individual SWP factory paths. | object({…}) | | {} | | | [host_project_ids](variables-fast.tf#L36) | Networking stage host project id aliases. | map(string) | | {} | 2-networking | | [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. | map(string) | | {} | | | [name](variables.tf#L119) | Name used for resource names. | string | | "swp" | | | [outputs_location](variables.tf#L126) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | -| [policy_rules_contexts](variables.tf#L132) | Replacement contexts for policy rules matcher arguments. | object({…}) | | {} | | +| [policy_rules_contexts](variables.tf#L132) | Replacement contexts for policy rules matcher arguments. | object({…}) | | {} | | | [regions](variables-fast.tf#L44) | Networking stage region aliases. | map(string) | | {} | 2-networking | | [subnet_self_links](variables-fast.tf#L52) | VPC subnetwork self links. | map(map(string)) | | {} | 2-networking | -| [swp_configs](variables.tf#L149) | Secure Web Proxy configuration, one per region. | map(object({…})) | | {} | | -| [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. | object({…}) | | null | | +| [swp_configs](variables.tf#L149) | Secure Web Proxy configuration, one per region. | map(object({…})) | | {} | | +| [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. | object({…}) | | null | | | [vpc_self_links](variables-fast.tf#L60) | VPC network self links. | map(string) | | {} | 2-networking | ## Outputs diff --git a/fast/addons/2-networking-test/README.md b/fast/addons/2-networking-test/README.md index b03b21887..f0313e5da 100644 --- a/fast/addons/2-networking-test/README.md +++ b/fast/addons/2-networking-test/README.md @@ -97,13 +97,13 @@ terraform apply | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [factories_config](variables.tf#L17) | Configuration for the resource factories. | object({…}) | | {} | | +| [factories_config](variables.tf#L17) | Configuration for the resource factories. | object({…}) | | {} | | | [host_project_ids](variables-fast.tf#L19) | Networking stage host project id aliases. | map(string) | | {} | 2-networking | | [name](variables.tf#L27) | Prefix used for all resource names. | string | | "test" | | | [regions](variables-fast.tf#L27) | Region aliases. | map(string) | | {} | 2-networking | | [subnet_self_links](variables-fast.tf#L35) | Subnet self links. | map(map(string)) | | {} | 2-networking | -| [test_instances](variables.tf#L34) | Test instances to be created. | map(object({…})) | | {} | | -| [test_service_accounts](variables.tf#L52) | Service accounts used by instances. | map(object({…})) | | {} | | +| [test_instances](variables.tf#L34) | Test instances to be created. | map(object({…})) | | {} | | +| [test_service_accounts](variables.tf#L52) | Service accounts used by instances. | map(object({…})) | | {} | | | [vpc_self_links](variables-fast.tf#L43) | VPC network self links. | map(string) | | {} | 2-networking | ## Outputs diff --git a/fast/extras/0-cicd-github/README.md b/fast/extras/0-cicd-github/README.md index 3e1acd477..ee788c2ac 100644 --- a/fast/extras/0-cicd-github/README.md +++ b/fast/extras/0-cicd-github/README.md @@ -149,7 +149,6 @@ terraform state list | grep github_repository_file | awk '{print "terraform stat ``` - ## Files | name | description | resources | @@ -165,15 +164,14 @@ terraform state list | grep github_repository_file | awk '{print "terraform stat | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [organization](variables.tf#L51) | GitHub organization. | string | ✓ | | -| [commit_config](variables.tf#L17) | Configure commit metadata. | object({…}) | | {} | -| [modules_config](variables.tf#L28) | Configure access to repository module via key, and replacement for modules sources in stage repositories. | object({…}) | | null | -| [pull_request_config](variables.tf#L56) | Configure pull request metadata. | object({…}) | | {} | -| [repositories](variables.tf#L69) | Repositories to create. | map(object({…})) | | {} | +| [commit_config](variables.tf#L17) | Configure commit metadata. | object({…}) | | {} | +| [modules_config](variables.tf#L28) | Configure access to repository module via key, and replacement for modules sources in stage repositories. | object({…}) | | null | +| [pull_request_config](variables.tf#L56) | Configure pull request metadata. | object({…}) | | {} | +| [repositories](variables.tf#L69) | Repositories to create. | map(object({…})) | | {} | ## Outputs | name | description | sensitive | |---|---|:---:| | [clone](outputs.tf#L17) | Clone repository commands. | | - diff --git a/fast/extras/0-cicd-gitlab/README.md b/fast/extras/0-cicd-gitlab/README.md index 1808eccf9..c0ccb1647 100644 --- a/fast/extras/0-cicd-gitlab/README.md +++ b/fast/extras/0-cicd-gitlab/README.md @@ -312,11 +312,11 @@ check if the plan pipeline executes successfully. | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [gitlab_config](variables.tf#L28) | Gitlab config. | object({…}) | ✓ | | -| [groups](variables.tf#L45) | Gitlab groups. | map(object({…})) | ✓ | | -| [commit_config](variables.tf#L17) | Configure commit metadata. | object({…}) | | {} | -| [modules_config](variables.tf#L54) | Gitlab modules config. | object({…}) | | null | -| [projects](variables.tf#L79) | Gitlab projects to create. | map(object({…})) | | {} | +| [gitlab_config](variables.tf#L28) | Gitlab config. | object({…}) | ✓ | | +| [groups](variables.tf#L45) | Gitlab groups. | map(object({…})) | ✓ | | +| [commit_config](variables.tf#L17) | Configure commit metadata. | object({…}) | | {} | +| [modules_config](variables.tf#L54) | Gitlab modules config. | object({…}) | | null | +| [projects](variables.tf#L79) | Gitlab projects to create. | map(object({…})) | | {} | ## Outputs diff --git a/fast/project-templates/data-mongodb/README.md b/fast/project-templates/data-mongodb/README.md index a44ae55dc..c8b2635b1 100644 --- a/fast/project-templates/data-mongodb/README.md +++ b/fast/project-templates/data-mongodb/README.md @@ -49,9 +49,9 @@ vpc_config = { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [atlas_config](variables.tf#L17) | MongoDB Atlas configuration. | object({…}) | ✓ | | +| [atlas_config](variables.tf#L17) | MongoDB Atlas configuration. | object({…}) | ✓ | | | [project_id](variables.tf#L40) | Project id where the registries will be created. | string | ✓ | | -| [vpc_config](variables.tf#L45) | VPC configuration. | object({…}) | ✓ | | +| [vpc_config](variables.tf#L45) | VPC configuration. | object({…}) | ✓ | | | [name](variables.tf#L33) | Prefix used for all resource names. | string | | "mongodb" | ## Outputs diff --git a/fast/project-templates/devops-azure-wif/self-hosted-agents/README.md b/fast/project-templates/devops-azure-wif/self-hosted-agents/README.md index b8cece6c4..ec9b53a43 100644 --- a/fast/project-templates/devops-azure-wif/self-hosted-agents/README.md +++ b/fast/project-templates/devops-azure-wif/self-hosted-agents/README.md @@ -169,15 +169,14 @@ fi ### GCP Infrastructure Scale-up Another customization area is on the GCP infrastructure side, where the simple instance code in this example can be easily changed to an instance template, and then wrapped into a Managed Instance Group to provide autohealing, easier scaling, or even autoscaling. This is very easy to do by leveraging the examples in the [`compute-vm`](../../../../modules/compute-vm/) and [`compute-mig`](../../../../modules/compute-mig/) modules. - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [agent_config](variables.tf#L17) | Agent configuration. | object({…}) | ✓ | | +| [agent_config](variables.tf#L17) | Agent configuration. | object({…}) | ✓ | | | [project_id](variables.tf#L58) | Project id where resources will be created. | string | ✓ | | -| [instance_config](variables.tf#L30) | Instance configuration. | object({…}) | | null | +| [instance_config](variables.tf#L30) | Instance configuration. | object({…}) | | null | | [location](variables.tf#L45) | Location used for regional resources. | string | | "europe-west8" | | [name](variables.tf#L51) | Prefix used for resource names. | string | | "azd" | @@ -190,7 +189,6 @@ Another customization area is on the GCP infrastructure side, where the simple i | [ssh_command](outputs.tf#L27) | Command to SSH to the agent instance. | | | [vpcsc_command](outputs.tf#L35) | Command to allow egress to remotes from inside a perimeter. | | - ## Test ```hcl diff --git a/fast/project-templates/gce-workstation-cluster/README.md b/fast/project-templates/gce-workstation-cluster/README.md index 73669b247..a6bcfd36f 100644 --- a/fast/project-templates/gce-workstation-cluster/README.md +++ b/fast/project-templates/gce-workstation-cluster/README.md @@ -57,17 +57,17 @@ network_config = { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [network_config](variables.tf#L72) | VPC and subnet for the cluster. | object({…}) | ✓ | | +| [network_config](variables.tf#L72) | VPC and subnet for the cluster. | object({…}) | ✓ | | | [project_id](variables.tf#L92) | Project id where the cluster will be created. | string | ✓ | | | [annotations](variables.tf#L17) | Workstation cluster annotations. | map(string) | | {} | -| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | | [display_name](variables.tf#L38) | Display name. | string | | null | | [domain](variables.tf#L44) | Domain. | string | | null | -| [factories_config](variables.tf#L50) | Path to folder with YAML resource description data files. | object({…}) | | {} | +| [factories_config](variables.tf#L50) | Path to folder with YAML resource description data files. | object({…}) | | {} | | [id](variables.tf#L59) | Workstation cluster ID. | string | | "ws-cluster-0" | | [labels](variables.tf#L66) | Workstation cluster labels. | map(string) | | {} | -| [private_cluster_config](variables.tf#L82) | Private cluster config. | object({…}) | | {} | -| [service_accounts](variables.tf#L98) | Project factory managed service accounts to populate context. | map(object({…})) | | {} | +| [private_cluster_config](variables.tf#L82) | Private cluster config. | object({…}) | | {} | +| [service_accounts](variables.tf#L98) | Project factory managed service accounts to populate context. | map(object({…})) | | {} | ## Outputs diff --git a/fast/project-templates/os-apt-registries/README.md b/fast/project-templates/os-apt-registries/README.md index 269d028ec..6bad9e672 100644 --- a/fast/project-templates/os-apt-registries/README.md +++ b/fast/project-templates/os-apt-registries/README.md @@ -58,7 +58,7 @@ apt_remote_registries = [ | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L56) | Project id where the registries will be created. | string | ✓ | | -| [apt_remote_registries](variables.tf#L17) | Remote artifact registry configurations. | list(object({…})) | | […] | +| [apt_remote_registries](variables.tf#L17) | Remote artifact registry configurations. | list(object({…})) | | […] | | [location](variables.tf#L43) | Region where the registries will be created. | string | | "europe-west8" | | [name](variables.tf#L49) | Prefix used for all resource names. | string | | "apt-remote" | @@ -69,7 +69,6 @@ apt_remote_registries = [ | [apt_configs](outputs.tf#L23) | APT configurations for remote registries. | | | [vpcsc_command](outputs.tf#L33) | Command to allow egress to remotes from inside a perimeter. | | - ## Test ```hcl diff --git a/fast/project-templates/secops-anonymization-pipeline/README.md b/fast/project-templates/secops-anonymization-pipeline/README.md index cad6e9dbf..590f5af26 100644 --- a/fast/project-templates/secops-anonymization-pipeline/README.md +++ b/fast/project-templates/secops-anonymization-pipeline/README.md @@ -93,7 +93,6 @@ terraform apply #### Step 5: Test solution Test the solution triggering an export from the Cloud Scheduler page, after few hours (according to the size of the export) logs should be available on secops-export bucket. Please check for any issue during export using the corresponding APIs and the export ID. - ## Variables @@ -101,12 +100,12 @@ Test the solution triggering an export from the Cloud Scheduler page, after few |---|---|:---:|:---:|:---:| | [prefix](variables.tf#L59) | Prefix used for resource names. | string | ✓ | | | [project_id](variables.tf#L78) | Project id that references existing project. | string | ✓ | | -| [secops_config](variables.tf#L95) | SecOps config. | object({…}) | ✓ | | -| [anonymization_scheduler](variables.tf#L17) | Schedule for triggering export, anonymization and import of data. | object({…}) | | {…} | -| [cloud_function_config](variables.tf#L31) | Optional Cloud Function configuration. | object({…}) | | {} | -| [dlp_config](variables.tf#L49) | Data Loss prevention configuration. | object({…}) | | null | -| [project_create_config](variables.tf#L69) | Create project instead of using an existing one. | object({…}) | | null | -| [regions](variables.tf#L83) | Regions: primary for all resources and secondary for clouds scheduler since the latter is available in few regions. | object({…}) | | {…} | +| [secops_config](variables.tf#L95) | SecOps config. | object({…}) | ✓ | | +| [anonymization_scheduler](variables.tf#L17) | Schedule for triggering export, anonymization and import of data. | object({…}) | | {…} | +| [cloud_function_config](variables.tf#L31) | Optional Cloud Function configuration. | object({…}) | | {} | +| [dlp_config](variables.tf#L49) | Data Loss prevention configuration. | object({…}) | | null | +| [project_create_config](variables.tf#L69) | Create project instead of using an existing one. | object({…}) | | null | +| [regions](variables.tf#L83) | Regions: primary for all resources and secondary for clouds scheduler since the latter is available in few regions. | object({…}) | | {…} | | [skip_anonymization](variables.tf#L111) | Whether to skip anonymization step and just import data exported from source tenant. | bool | | false | ## Outputs diff --git a/fast/stages/0-org-setup/README.md b/fast/stages/0-org-setup/README.md index a30fbb9b4..95d60330d 100644 --- a/fast/stages/0-org-setup/README.md +++ b/fast/stages/0-org-setup/README.md @@ -913,8 +913,8 @@ Define values for the `var.environments` variable in a tfvars file. | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | -| [factories_config](variables.tf#L40) | Configuration for the resource factories or external data. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [factories_config](variables.tf#L40) | Configuration for the resource factories or external data. | object({…}) | | {} | | [org_policies_imports](variables.tf#L59) | List of org policies to import. These need to also be defined in data files. | list(string) | | [] | ## Outputs diff --git a/fast/stages/1-vpcsc/README.md b/fast/stages/1-vpcsc/README.md index da47341ac..a63575717 100644 --- a/fast/stages/1-vpcsc/README.md +++ b/fast/stages/1-vpcsc/README.md @@ -456,18 +456,18 @@ Some references that might be useful in setting up this stage: | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [organization](variables-fast.tf#L35) | Organization details. | object({…}) | ✓ | | 0-org-setup | -| [access_levels](variables.tf#L17) | Access level definitions. | map(object({…})) | | {} | | +| [organization](variables-fast.tf#L35) | Organization details. | object({…}) | ✓ | | 0-org-setup | +| [access_levels](variables.tf#L17) | Access level definitions. | map(object({…})) | | {} | | | [access_policy](variables.tf#L67) | Access policy id (used for tenant-level VPC-SC configurations). | number | | null | | -| [context](variables.tf#L73) | External context used in replacements. | object({…}) | | {} | | -| [egress_policies](variables.tf#L87) | Egress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | | -| [factories_config](variables.tf#L130) | Paths to folders that enable factory functionality. | object({…}) | | {} | | +| [context](variables.tf#L73) | External context used in replacements. | object({…}) | | {} | | +| [egress_policies](variables.tf#L87) | Egress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | | +| [factories_config](variables.tf#L130) | Paths to folders that enable factory functionality. | object({…}) | | {} | | | [iam_principals](variables-fast.tf#L17) | Org-level IAM principals. | map(string) | | {} | 0-org-setup | -| [ingress_policies](variables.tf#L147) | Ingress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | | -| [logging](variables-fast.tf#L25) | Log writer identities for organization / folders. | object({…}) | | null | 0-org-setup | -| [perimeters](variables.tf#L189) | Perimeter definitions. | map(object({…})) | | {} | | +| [ingress_policies](variables.tf#L147) | Ingress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | | +| [logging](variables-fast.tf#L25) | Log writer identities for organization / folders. | object({…}) | | null | 0-org-setup | +| [perimeters](variables.tf#L189) | Perimeter definitions. | map(object({…})) | | {} | | | [project_numbers](variables-fast.tf#L46) | Project numbers. | map(number) | | {} | 0-org-setup | -| [resource_discovery](variables.tf#L223) | Automatic discovery of perimeter projects. | object({…}) | | {} | | +| [resource_discovery](variables.tf#L223) | Automatic discovery of perimeter projects. | object({…}) | | {} | | | [root_node](variables-fast.tf#L54) | Root node for the hierarchy, if running in tenant mode. | string | | null | 0-org-setup | | [service_accounts](variables-fast.tf#L68) | Org-level service accounts. | map(string) | | {} | 0-org-setup | | [storage_buckets](variables-fast.tf#L76) | Storage buckets created in the bootstrap stage. | map(string) | | {} | 0-org-setup | diff --git a/fast/stages/2-networking/README.md b/fast/stages/2-networking/README.md index 166979295..0ea3bbeb5 100644 --- a/fast/stages/2-networking/README.md +++ b/fast/stages/2-networking/README.md @@ -379,12 +379,12 @@ Internally created resources are mapped to context namespaces, and use specific | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [billing_account](variables-fast.tf#L17) | Billing account id. | object({…}) | ✓ | | -| [organization](variables-fast.tf#L58) | Organization details. | object({…}) | ✓ | | +| [billing_account](variables-fast.tf#L17) | Billing account id. | object({…}) | ✓ | | +| [organization](variables-fast.tf#L58) | Organization details. | object({…}) | ✓ | | | [prefix](variables-fast.tf#L75) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [custom_roles](variables-fast.tf#L25) | Custom roles defined at the org level, in key => id format. | map(string) | | {} | -| [factories_config](variables.tf#L37) | Configuration for the resource factories or external data. | object({…}) | | {} | +| [factories_config](variables.tf#L37) | Configuration for the resource factories or external data. | object({…}) | | {} | | [folder_ids](variables-fast.tf#L33) | Folders created in the bootstrap stage. | map(string) | | {} | | [iam_principals](variables-fast.tf#L41) | IAM-format principals. | map(string) | | {} | | [kms_keys](variables-fast.tf#L50) | KMS key ids. | map(string) | | {} | @@ -394,7 +394,7 @@ Internally created resources are mapped to context namespaces, and use specific | [storage_buckets](variables-fast.tf#L101) | Storage buckets created in the bootstrap stage. | map(string) | | {} | | [tag_keys](variables-fast.tf#L109) | FAST-managed resource manager tag keys. | map(string) | | {} | | [tag_values](variables-fast.tf#L117) | FAST-managed resource manager tag values. | map(string) | | {} | -| [universe](variables-fast.tf#L125) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | +| [universe](variables-fast.tf#L125) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | ## Outputs diff --git a/fast/stages/2-project-factory/README.md b/fast/stages/2-project-factory/README.md index 11c14c32d..a41d9bad4 100644 --- a/fast/stages/2-project-factory/README.md +++ b/fast/stages/2-project-factory/README.md @@ -478,16 +478,16 @@ Pattern-based files make specific assumptions: | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | -| [billing_account](variables-fast.tf#L26) | Billing account id. | object({…}) | ✓ | | 0-globals | -| [organization](variables-fast.tf#L74) | Organization details. | object({…}) | ✓ | | 0-globals | +| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | +| [billing_account](variables-fast.tf#L26) | Billing account id. | object({…}) | ✓ | | 0-globals | +| [organization](variables-fast.tf#L74) | Organization details. | object({…}) | ✓ | | 0-globals | | [prefix](variables-fast.tf#L92) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | 0-globals | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | | [custom_roles](variables-fast.tf#L34) | Custom roles defined at the org level, in key => id format. | map(string) | | {} | 0-org-setup | -| [data_defaults](variables-projects.tf#L17) | Optional default values used when corresponding project or folder data from files are missing. | object({…}) | | {} | | -| [data_merges](variables-projects.tf#L93) | Optional values that will be merged with corresponding data from files. Combines with `data_defaults`, file data, and `data_overrides`. | object({…}) | | {} | | -| [data_overrides](variables-projects.tf#L112) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | | -| [factories_config](variables.tf#L37) | Path to folder with YAML resource description data files. | object({…}) | | {} | | +| [data_defaults](variables-projects.tf#L17) | Optional default values used when corresponding project or folder data from files are missing. | object({…}) | | {} | | +| [data_merges](variables-projects.tf#L93) | Optional values that will be merged with corresponding data from files. Combines with `data_defaults`, file data, and `data_overrides`. | object({…}) | | {} | | +| [data_overrides](variables-projects.tf#L112) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | | +| [factories_config](variables.tf#L37) | Path to folder with YAML resource description data files. | object({…}) | | {} | | | [folder_ids](variables-fast.tf#L42) | Folders created in the bootstrap stage. | map(string) | | {} | 0-org-setup | | [host_project_ids](variables-fast.tf#L58) | Host project for the shared VPC. | map(string) | | {} | 2-networking | | [iam_principals](variables-fast.tf#L50) | IAM-format principals. | map(string) | | {} | 0-org-setup | @@ -498,7 +498,7 @@ Pattern-based files make specific assumptions: | [stage_name](variables.tf#L58) | FAST stage name. Used to separate output files across different factories. | string | | "2-project-factory" | | | [subnet_self_links](variables-fast.tf#L118) | Shared VPC subnet IDs. | map(map(string)) | | {} | 2-networking | | [tag_values](variables-fast.tf#L126) | FAST-managed resource manager tag values. | map(string) | | {} | 0-org-setup | -| [universe](variables-fast.tf#L134) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | 0-globals | +| [universe](variables-fast.tf#L134) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | 0-globals | ## Outputs diff --git a/fast/stages/2-security/README.md b/fast/stages/2-security/README.md index 4526bfb54..3eea3cbab 100644 --- a/fast/stages/2-security/README.md +++ b/fast/stages/2-security/README.md @@ -187,11 +187,11 @@ A reference Certificate Authority Services (CAS) is also part of this stage, all | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [billing_account](variables-fast.tf#L17) | Billing account id. | object({…}) | ✓ | | 0-org-setup | +| [billing_account](variables-fast.tf#L17) | Billing account id. | object({…}) | ✓ | | 0-org-setup | | [prefix](variables-fast.tf#L57) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | 0-org-setup | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | | [custom_roles](variables-fast.tf#L25) | Custom roles defined at the org level, in key => id format. | map(string) | | {} | 0-org-setup | -| [factories_config](variables.tf#L36) | Configuration for the resource factories or external data. | object({…}) | | {} | | +| [factories_config](variables.tf#L36) | Configuration for the resource factories or external data. | object({…}) | | {} | | | [folder_ids](variables-fast.tf#L33) | Folders created in the bootstrap stage. | map(string) | | {} | 0-org-setup | | [iam_principals](variables-fast.tf#L41) | IAM-format principals. | map(string) | | {} | 0-org-setup | | [perimeters](variables-fast.tf#L49) | Optional VPC-SC perimeter ids. | map(string) | | {} | 1-vpcsc | @@ -200,7 +200,7 @@ A reference Certificate Authority Services (CAS) is also part of this stage, all | [storage_buckets](variables-fast.tf#L83) | Storage buckets created in the bootstrap stage. | map(string) | | {} | 0-org-setup | | [tag_keys](variables-fast.tf#L91) | FAST-managed resource manager tag keys. | map(string) | | {} | 0-org-setup | | [tag_values](variables-fast.tf#L99) | FAST-managed resource manager tag values. | map(string) | | {} | 0-org-setup | -| [universe](variables-fast.tf#L107) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | 0-org-setup | +| [universe](variables-fast.tf#L107) | GCP universe where to deploy projects. The prefix will be prepended to the project id. | object({…}) | | null | 0-org-setup | ## Outputs diff --git a/fast/stages/3-data-platform-dev/README.md b/fast/stages/3-data-platform-dev/README.md index fef424ed1..6182510c8 100644 --- a/fast/stages/3-data-platform-dev/README.md +++ b/fast/stages/3-data-platform-dev/README.md @@ -343,23 +343,23 @@ The following table lists the available substitutions. | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | -| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | -| [environments](variables-fast.tf#L34) | Environment names. | object({…}) | ✓ | | 0-org-setup | +| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | +| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | +| [environments](variables-fast.tf#L34) | Environment names. | object({…}) | ✓ | | 0-org-setup | | [prefix](variables-fast.tf#L69) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | 0-org-setup | -| [aspect_types](variables.tf#L17) | Aspect templates. Merged with those defined via the factory. | map(object({…})) | | {} | | -| [central_project_config](variables.tf#L48) | Configuration for the top-level central project. | object({…}) | | {} | | -| [encryption_keys](variables.tf#L90) | Default encryption keys for services, in service => { region => key id } format. Overridable on a per-object basis. | object({…}) | | {} | | -| [exposure_config](variables.tf#L101) | Data exposure configuration. | object({…}) | | {} | | -| [factories_config](variables.tf#L119) | Configuration for the resource factories. | object({…}) | | {} | | +| [aspect_types](variables.tf#L17) | Aspect templates. Merged with those defined via the factory. | map(object({…})) | | {} | | +| [central_project_config](variables.tf#L48) | Configuration for the top-level central project. | object({…}) | | {} | | +| [encryption_keys](variables.tf#L90) | Default encryption keys for services, in service => { region => key id } format. Overridable on a per-object basis. | object({…}) | | {} | | +| [exposure_config](variables.tf#L101) | Data exposure configuration. | object({…}) | | {} | | +| [factories_config](variables.tf#L119) | Configuration for the resource factories. | object({…}) | | {} | | | [folder_ids](variables-fast.tf#L45) | Folder name => id mappings. | map(string) | | {} | 0-org-setup | | [host_project_ids](variables-fast.tf#L53) | Shared VPC host project name => id mappings. | map(string) | | {} | 2-networking | | [kms_keys](variables-fast.tf#L61) | KMS key ids. | map(string) | | {} | 2-security | | [location](variables.tf#L134) | Default location used when no location is specified. | string | | "europe-west1" | | | [outputs_location](variables.tf#L141) | Enable writing provider, tfvars and CI/CD workflow files to local filesystem. Leave null to disable. | string | | null | | | [regions](variables-fast.tf#L79) | Region mappings. | map(string) | | {} | 2-networking | -| [secure_tags](variables.tf#L147) | Resource manager tags created in the central project. | map(object({…})) | | {} | | -| [stage_config](variables.tf#L168) | Stage configuration used to find environment and resource ids, and to generate names. | object({…}) | | {…} | | +| [secure_tags](variables.tf#L147) | Resource manager tags created in the central project. | map(object({…})) | | {} | | +| [stage_config](variables.tf#L168) | Stage configuration used to find environment and resource ids, and to generate names. | object({…}) | | {…} | | | [subnet_self_links](variables-fast.tf#L87) | Subnet VPC name => { name => self link } mappings. | map(map(string)) | | {} | 2-networking | | [tag_values](variables-fast.tf#L95) | FAST-managed resource manager tag values. | map(string) | | {} | 0-org-setup | | [vpc_self_links](variables-fast.tf#L103) | Shared VPC name => self link mappings. | map(string) | | {} | 2-networking | diff --git a/fast/stages/3-data-platform-dev/demo/README.md b/fast/stages/3-data-platform-dev/demo/README.md index 373a338ff..297f6f785 100644 --- a/fast/stages/3-data-platform-dev/demo/README.md +++ b/fast/stages/3-data-platform-dev/demo/README.md @@ -170,12 +170,12 @@ gcloud composer environments describe $COMPOSER_ENV_NAME \ | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| | [authorized_dataset_on_curated](variables.tf#L16) | Authorized Dataset. | string | ✓ | | | -| [composer_config](variables.tf#L21) | Composer environment configuration. | object({…}) | ✓ | | | +| [composer_config](variables.tf#L21) | Composer environment configuration. | object({…}) | ✓ | | | | [dp_processing_service_account](variables.tf#L30) | Service account for data processing via Composer impersonation. | string | ✓ | | | | [impersonate_service_account](variables.tf#L47) | Service account to impersonate for Google Cloud providers. | string | ✓ | | | | [prefix](variables.tf#L60) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | | | [project_id](variables.tf#L69) | Project ID to deploy resources. | string | ✓ | | | -| [encryption_keys](variables.tf#L36) | Default encryption keys for services, in service => { region => key id } format. Overridable on a per-object basis. | object({…}) | | {} | | +| [encryption_keys](variables.tf#L36) | Default encryption keys for services, in service => { region => key id } format. Overridable on a per-object basis. | object({…}) | | {} | | | [location](variables.tf#L53) | Default location used when no location is specified. | string | | "europe-west8" | | ## Outputs diff --git a/fast/stages/3-gcve-dev/README.md b/fast/stages/3-gcve-dev/README.md index 568a0f892..df885204a 100644 --- a/fast/stages/3-gcve-dev/README.md +++ b/fast/stages/3-gcve-dev/README.md @@ -172,16 +172,16 @@ terraform apply | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L19) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | -| [billing_account](variables-fast.tf#L28) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | -| [environments](variables-fast.tf#L36) | Long environment names. | object({…}) | ✓ | | 0-org-setup | +| [automation](variables-fast.tf#L19) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | +| [billing_account](variables-fast.tf#L28) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | +| [environments](variables-fast.tf#L36) | Long environment names. | object({…}) | ✓ | | 0-org-setup | | [prefix](variables-fast.tf#L53) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | 0-org-setup | | [folder_ids](variables-fast.tf#L46) | Folders used by FAST stages in folders/nnnnnnnnnnn format. | map(string) | | {} | 0-org-setup | | [iam](variables.tf#L17) | Project-level authoritative IAM bindings for users and service accounts in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | | [iam_by_principals](variables.tf#L24) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | -| [network_peerings](variables.tf#L31) | The network peerings between users' VPCs and the VMware Engine networks. Key is used for the peering name suffix. Network is expanded for FAST defined networks. | map(object({…})) | | {…} | | -| [private_cloud_configs](variables.tf#L54) | The VMware private cloud configurations. Key is used for the private cloud name suffix. | map(object({…})) | | {} | | -| [stage_config](variables.tf#L76) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | +| [network_peerings](variables.tf#L31) | The network peerings between users' VPCs and the VMware Engine networks. Key is used for the peering name suffix. Network is expanded for FAST defined networks. | map(object({…})) | | {…} | | +| [private_cloud_configs](variables.tf#L54) | The VMware private cloud configurations. Key is used for the private cloud name suffix. | map(object({…})) | | {} | | +| [stage_config](variables.tf#L76) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | | [vpc_self_links](variables-fast.tf#L63) | FAST host VPC self links. | map(string) | | {} | 2-networking | ## Outputs diff --git a/fast/stages/3-gke-dev/README.md b/fast/stages/3-gke-dev/README.md index e131daaf9..6b31801c6 100644 --- a/fast/stages/3-gke-dev/README.md +++ b/fast/stages/3-gke-dev/README.md @@ -181,22 +181,22 @@ Clusters can then be configured for fleet registration and one of the config man | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | -| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | -| [environments](variables-fast.tf#L34) | Long environment names. | object({…}) | ✓ | | 0-org-setup | +| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | +| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | ✓ | | 0-org-setup | +| [environments](variables-fast.tf#L34) | Long environment names. | object({…}) | ✓ | | 0-org-setup | | [prefix](variables-fast.tf#L60) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | string | ✓ | | 0-org-setup | -| [clusters](variables.tf#L17) | Clusters configuration. Refer to the gke-cluster module for type details. | map(object({…})) | | {} | | +| [clusters](variables.tf#L17) | Clusters configuration. Refer to the gke-cluster module for type details. | map(object({…})) | | {} | | | [deletion_protection](variables.tf#L106) | Prevent Terraform from destroying data resources. | bool | | false | | -| [fleet_config](variables-fleet.tf#L19) | Fleet configuration. | object({…}) | | null | | -| [fleet_configmanagement_templates](variables-fleet.tf#L35) | Sets of fleet configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | | +| [fleet_config](variables-fleet.tf#L19) | Fleet configuration. | object({…}) | | null | | +| [fleet_configmanagement_templates](variables-fleet.tf#L35) | Sets of fleet configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | | | [folder_ids](variables-fast.tf#L44) | Folder name => id mappings. | map(string) | | {} | 0-org-setup | | [host_project_ids](variables-fast.tf#L52) | Shared VPC host project name => id mappings. | map(string) | | {} | 2-networking | | [iam](variables.tf#L113) | Project-level authoritative IAM bindings for users and service accounts in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | | [iam_by_principals](variables.tf#L120) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | -| [nodepools](variables.tf#L127) | Nodepools configuration. Refer to the gke-nodepool module for type details. | map(map(object({…}))) | | {} | | -| [stage_config](variables.tf#L176) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | +| [nodepools](variables.tf#L127) | Nodepools configuration. Refer to the gke-nodepool module for type details. | map(map(object({…}))) | | {} | | +| [stage_config](variables.tf#L176) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | | [subnet_self_links](variables-fast.tf#L70) | Subnet VPC name => { name => self link } mappings. | map(map(string)) | | {} | 2-networking | -| [vpc_config](variables.tf#L188) | VPC-level configuration for project and clusters. | object({…}) | | {…} | | +| [vpc_config](variables.tf#L188) | VPC-level configuration for project and clusters. | object({…}) | | {…} | | | [vpc_self_links](variables-fast.tf#L78) | Shared VPC name => self link mappings. | map(string) | | {} | 2-networking | ## Outputs diff --git a/fast/stages/3-secops-dev/README.md b/fast/stages/3-secops-dev/README.md index 8a54b0f29..e03fb028b 100644 --- a/fast/stages/3-secops-dev/README.md +++ b/fast/stages/3-secops-dev/README.md @@ -131,17 +131,17 @@ Please be aware the Service Account Client ID needed during domain wide delegati | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| -| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | +| [automation](variables-fast.tf#L17) | Automation resources created by the bootstrap stage. | object({…}) | ✓ | | 0-org-setup | | [prefix](variables-fast.tf#L67) | Prefix for organization projects. | string | ✓ | | 0-org-setup | -| [tenant_config](variables.tf#L139) | SecOps Tenant configuration. | object({…}) | ✓ | | | -| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | | {} | 0-org-setup | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | +| [tenant_config](variables.tf#L139) | SecOps Tenant configuration. | object({…}) | ✓ | | | +| [billing_account](variables-fast.tf#L26) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | object({…}) | | {} | 0-org-setup | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | | [custom_roles](variables-fast.tf#L35) | Custom roles defined at the org level, in key => id format. | map(string) | | {} | 0-org-setup | -| [data_rbac_config](variables.tf#L30) | SecOps Data RBAC scope and labels config. | object({…}) | | {} | | -| [factories_config](variables.tf#L64) | Paths to YAML config expected in 'rules' and 'reference_lists'. Path to folders containing rules definitions (yaral files) and reference lists content (txt files) for the corresponding _defs keys. | object({…}) | | {…} | | +| [data_rbac_config](variables.tf#L30) | SecOps Data RBAC scope and labels config. | object({…}) | | {} | | +| [factories_config](variables.tf#L64) | Paths to YAML config expected in 'rules' and 'reference_lists'. Path to folders containing rules definitions (yaral files) and reference lists content (txt files) for the corresponding _defs keys. | object({…}) | | {…} | | | [folder_ids](variables-fast.tf#L43) | Folders created in the bootstrap stage. | map(string) | | {} | 0-org-setup | -| [iam](variables.tf#L81) | SecOps IAM configuration in {PRINCIPAL => {roles => [ROLES], scopes => [SCOPES]}} format. | map(object({…})) | | {} | | -| [iam_default](variables.tf#L91) | Groups ID in IdP assigned to SecOps admins, editors, viewers roles. | object({…}) | | {} | | +| [iam](variables.tf#L81) | SecOps IAM configuration in {PRINCIPAL => {roles => [ROLES], scopes => [SCOPES]}} format. | map(object({…})) | | {} | | +| [iam_default](variables.tf#L91) | Groups ID in IdP assigned to SecOps admins, editors, viewers roles. | object({…}) | | {} | | | [iam_principals](variables-fast.tf#L51) | IAM-format principals. | map(string) | | {} | 0-org-setup | | [kms_keys](variables-fast.tf#L59) | KMS key ids. | map(string) | | {} | 2-security | | [parent_folder](variables.tf#L101) | Folder to use for created project. | string | | "$folder_ids:secops/dev" | | @@ -149,8 +149,8 @@ Please be aware the Service Account Client ID needed during domain wide delegati | [project_ids](variables-fast.tf#L74) | Projects created in the bootstrap stage. | map(string) | | {} | 0-org-setup | | [project_reuse](variables.tf#L115) | Whether to use an existing project. | map(string) | | null | | | [region](variables.tf#L121) | Google Cloud region definition for resources. | string | | "europe-west8" | | -| [stage_config](variables.tf#L127) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | -| [workspace_integration_config](variables.tf#L147) | SecOps Feeds configuration for Workspace logs and entities ingestion. | object({…}) | | null | | +| [stage_config](variables.tf#L127) | FAST stage configuration used to find resource ids. Must match name defined for the stage in resource management. | object({…}) | | {…} | | +| [workspace_integration_config](variables.tf#L147) | SecOps Feeds configuration for Workspace logs and entities ingestion. | object({…}) | | null | | ## Outputs diff --git a/modules/__experimental_deprecated/alloydb-instance/README.md b/modules/__experimental_deprecated/alloydb-instance/README.md index ff576f39f..016fbf0e3 100644 --- a/modules/__experimental_deprecated/alloydb-instance/README.md +++ b/modules/__experimental_deprecated/alloydb-instance/README.md @@ -57,23 +57,22 @@ module "alloydb" { - [ ] Add IAM support - [ ] support password in output - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [cluster_id](variables.tf#L35) | The ID of the alloydb cluster. | string | ✓ | | | [network_self_link](variables.tf#L83) | Network ID where the AlloyDb cluster will be deployed. | string | ✓ | | -| [primary_instance_config](variables.tf#L88) | Primary cluster configuration that supports read and write operations. | object({…}) | ✓ | | +| [primary_instance_config](variables.tf#L88) | Primary cluster configuration that supports read and write operations. | object({…}) | ✓ | | | [project_id](variables.tf#L110) | The ID of the project in which to provision resources. | string | ✓ | | -| [automated_backup_policy](variables.tf#L17) | The automated backup policy for this cluster. | object({…}) | | null | +| [automated_backup_policy](variables.tf#L17) | The automated backup policy for this cluster. | object({…}) | | null | | [display_name](variables.tf#L44) | Human readable display name for the Alloy DB Cluster. | string | | null | | [encryption_key_name](variables.tf#L50) | The fully-qualified resource name of the KMS key for cluster encryption. | string | | null | -| [initial_user](variables.tf#L56) | Alloy DB Cluster Initial User Credentials. | object({…}) | | null | +| [initial_user](variables.tf#L56) | Alloy DB Cluster Initial User Credentials. | object({…}) | | null | | [labels](variables.tf#L65) | User-defined labels for the alloydb cluster. | map(string) | | {} | | [location](variables.tf#L71) | Location where AlloyDb cluster will be deployed. | string | | "europe-west2" | | [network_name](variables.tf#L77) | The network name of the project in which to provision resources. | string | | "multiple-readpool" | -| [read_pool_instance](variables.tf#L115) | List of Read Pool Instances to be created. | list(object({…})) | | [] | +| [read_pool_instance](variables.tf#L115) | List of Read Pool Instances to be created. | list(object({…})) | | [] | ## Outputs @@ -84,6 +83,4 @@ module "alloydb" { | [primary_instance](outputs.tf#L28) | Primary instance created. | | | [primary_instance_id](outputs.tf#L33) | ID of the primary instance created. | | | [read_pool_instance_ids](outputs.tf#L38) | IDs of the read instances created. | | - - diff --git a/modules/__experimental_deprecated/net-neg/README.md b/modules/__experimental_deprecated/net-neg/README.md index cb271c505..7ee109575 100644 --- a/modules/__experimental_deprecated/net-neg/README.md +++ b/modules/__experimental_deprecated/net-neg/README.md @@ -25,12 +25,11 @@ module "neg" { # tftest skip ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [endpoints](variables.tf#L17) | List of (instance, port, address) of the NEG. | list(object({…})) | ✓ | | +| [endpoints](variables.tf#L17) | List of (instance, port, address) of the NEG. | list(object({…})) | ✓ | | | [name](variables.tf#L26) | NEG name. | string | ✓ | | | [network](variables.tf#L31) | Name or self link of the VPC used for the NEG. Use the self link for Shared VPC. | string | ✓ | | | [project_id](variables.tf#L36) | NEG project id. | string | ✓ | | @@ -44,5 +43,4 @@ module "neg" { | [id](outputs.tf#L17) | Network endpoint group ID. | | | [self_lnk](outputs.tf#L22) | Network endpoint group self link. | | | [size](outputs.tf#L27) | Size of the network endpoint group. | | - diff --git a/modules/agent-engine/README.md b/modules/agent-engine/README.md index ee067b161..26536e38f 100644 --- a/modules/agent-engine/README.md +++ b/modules/agent-engine/README.md @@ -352,18 +352,18 @@ The module allows you to dynamically reference context values for resources crea | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [agent_engine_config](variables.tf#L17) | The agent configuration. | object({…}) | ✓ | | +| [agent_engine_config](variables.tf#L17) | The agent configuration. | object({…}) | ✓ | | | [name](variables.tf#L122) | The name of the agent. | string | ✓ | | | [project_id](variables.tf#L141) | The id of the project where to deploy the agent. | string | ✓ | | | [region](variables.tf#L147) | The region where to deploy the agent. | string | ✓ | | -| [bucket_config](variables.tf#L40) | The GCS bucket configuration. | object({…}) | | {} | -| [context](variables.tf#L52) | Context-specific interpolations. | object({…}) | | {} | -| [deployment_files](variables.tf#L65) | The to source files path and names. | object({…}) | | {…} | +| [bucket_config](variables.tf#L40) | The GCS bucket configuration. | object({…}) | | {} | +| [context](variables.tf#L52) | Context-specific interpolations. | object({…}) | | {} | +| [deployment_files](variables.tf#L65) | The to source files path and names. | object({…}) | | {…} | | [description](variables.tf#L102) | The Agent Engine description. | string | | "Terraform managed." | | [encryption_key](variables.tf#L109) | The full resource name of the Cloud KMS CryptoKey. | string | | null | | [managed](variables.tf#L115) | Whether the Terraform module should control the code updates. | bool | | true | -| [networking_config](variables.tf#L128) | Networking configuration. | object({…}) | | null | -| [service_account_config](variables-serviceaccount.tf#L18) | Service account configurations. | object({…}) | | {} | +| [networking_config](variables.tf#L128) | Networking configuration. | object({…}) | | null | +| [service_account_config](variables-serviceaccount.tf#L18) | Service account configurations. | object({…}) | | {} | ## Outputs diff --git a/modules/ai-applications/README.md b/modules/ai-applications/README.md index 1523b50a0..472f2963d 100644 --- a/modules/ai-applications/README.md +++ b/modules/ai-applications/README.md @@ -327,9 +327,9 @@ module "ai-applications" { |---|---|:---:|:---:|:---:| | [name](variables.tf#L483) | The name of the resources. | string | ✓ | | | [project_id](variables.tf#L489) | The ID of the project where the data stores and the agents will be created. | string | ✓ | | -| [chat_agent_security_configs](variables.tf#L17) | The DLP security configurations for (Dialogflow CX) chat agents. | object({…}) | | {} | -| [data_stores_configs](variables.tf#L305) | The ai-applications datastore configurations. | map(object({…})) | | {} | -| [engines_configs](variables.tf#L410) | The AI applications engines configurations. | object({…}) | | {} | +| [chat_agent_security_configs](variables.tf#L17) | The DLP security configurations for (Dialogflow CX) chat agents. | object({…}) | | {} | +| [data_stores_configs](variables.tf#L305) | The ai-applications datastore configurations. | map(object({…})) | | {} | +| [engines_configs](variables.tf#L410) | The AI applications engines configurations. | object({…}) | | {} | | [location](variables.tf#L477) | Location where the data stores and agents will be created. | string | | "global" | ## Outputs diff --git a/modules/alloydb/README.md b/modules/alloydb/README.md index 35f2390ac..3483c2cd6 100644 --- a/modules/alloydb/README.md +++ b/modules/alloydb/README.md @@ -346,34 +346,34 @@ module "alloydb" { | [cluster_name](variables.tf#L84) | Name of the primary cluster. | string | ✓ | | | [instance_name](variables.tf#L211) | Name of primary instance. | string | ✓ | | | [location](variables.tf#L223) | Region or zone of the cluster and instance. | string | ✓ | | -| [network_config](variables.tf#L268) | Network configuration for cluster and instance. Only one between psa_config and psc_config can be used. | object({…}) | ✓ | | +| [network_config](variables.tf#L268) | Network configuration for cluster and instance. Only one between psa_config and psc_config can be used. | object({…}) | ✓ | | | [project_id](variables.tf#L303) | The ID of the project where this instances will be created. | string | ✓ | | | [annotations](variables.tf#L17) | Map FLAG_NAME=>VALUE for annotations which allow client tools to store small amount of arbitrary data. | map(string) | | null | -| [automated_backup_configuration](variables.tf#L23) | Automated backup settings for cluster. | object({…}) | | {} | +| [automated_backup_configuration](variables.tf#L23) | Automated backup settings for cluster. | object({…}) | | {} | | [availability_type](variables.tf#L61) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | string | | "REGIONAL" | -| [client_connection_config](variables.tf#L67) | Client connection config. | object({…}) | | null | +| [client_connection_config](variables.tf#L67) | Client connection config. | object({…}) | | null | | [cluster_display_name](variables.tf#L78) | Display name of the primary cluster. | string | | null | -| [continuous_backup_configuration](variables.tf#L90) | Continuous backup settings for cluster. | object({…}) | | {} | -| [cross_region_replication](variables.tf#L100) | Cross region replication config. | object({…}) | | {} | +| [continuous_backup_configuration](variables.tf#L90) | Continuous backup settings for cluster. | object({…}) | | {} | +| [cross_region_replication](variables.tf#L100) | Cross region replication config. | object({…}) | | {} | | [database_version](variables.tf#L157) | Database type and version to create. | string | | "POSTGRES_15" | | [deletion_policy](variables.tf#L163) | AlloyDB cluster and instance deletion policy. | string | | null | | [deletion_protection](variables.tf#L169) | Whether Terraform will be prevented from destroying the cluster. When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the cluster will fail. When the field is set to false, deleting the cluster is allowed. | bool | | null | | [display_name](variables.tf#L175) | AlloyDB instance display name. | string | | null | -| [encryption_config](variables.tf#L181) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | object({…}) | | null | +| [encryption_config](variables.tf#L181) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | object({…}) | | null | | [flags](variables.tf#L190) | Map FLAG_NAME=>VALUE for database-specific tuning. | map(string) | | null | | [gce_zone](variables.tf#L196) | The GCE zone that the instance should serve from. This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. | string | | null | -| [initial_user](variables.tf#L202) | AlloyDB cluster initial user credentials. | object({…}) | | null | +| [initial_user](variables.tf#L202) | AlloyDB cluster initial user credentials. | object({…}) | | null | | [labels](variables.tf#L217) | Labels to be attached to all instances. | map(string) | | null | -| [machine_config](variables.tf#L229) | AlloyDB machine config. | object({…}) | | {} | -| [maintenance_config](variables.tf#L243) | Set maintenance window configuration. | object({…}) | | {} | +| [machine_config](variables.tf#L229) | AlloyDB machine config. | object({…}) | | {} | +| [maintenance_config](variables.tf#L243) | Set maintenance window configuration. | object({…}) | | {} | | [prefix](variables.tf#L293) | Optional prefix used to generate instance names. | string | | null | | [project_number](variables.tf#L308) | The project number of the project where this instances will be created. Only used for testing purposes. | string | | null | -| [query_insights_config](variables.tf#L314) | Query insights config. | object({…}) | | {} | -| [read_pool](variables.tf#L325) | Map of read pool instances to create in the primary cluster. | map(object({…})) | | {} | +| [query_insights_config](variables.tf#L314) | Query insights config. | object({…}) | | {} | +| [read_pool](variables.tf#L325) | Map of read pool instances to create in the primary cluster. | map(object({…})) | | {} | | [skip_await_major_version_upgrade](variables.tf#L370) | Set to true to skip awaiting on the major version upgrade of the cluster. | bool | | true | | [subscription_type](variables.tf#L376) | The subscription type of cluster. Possible values are: 'STANDARD' or 'TRIAL'. | string | | "STANDARD" | | [tag_bindings](variables.tf#L382) | Tag bindings for this service, in key => tag value id format. | map(string) | | {} | -| [users](variables.tf#L389) | Map of users to create in the primary instance (and replicated to other replicas). Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'ALLOYDB_BUILT_IN' or 'ALLOYDB_IAM_USER'. | map(object({…})) | | {} | +| [users](variables.tf#L389) | Map of users to create in the primary instance (and replicated to other replicas). Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'ALLOYDB_BUILT_IN' or 'ALLOYDB_IAM_USER'. | map(object({…})) | | {} | ## Outputs diff --git a/modules/analytics-hub/README.md b/modules/analytics-hub/README.md index 7774b7c6c..0e6c2fde7 100644 --- a/modules/analytics-hub/README.md +++ b/modules/analytics-hub/README.md @@ -199,13 +199,13 @@ restricted_export_config: | [region](variables.tf#L93) | Region for the data exchange. | string | ✓ | | | [description](variables.tf#L17) | Resource description for data exchange. | string | | null | | [documentation](variables.tf#L23) | Documentation describing the data exchange. | string | | null | -| [factories_config](variables.tf#L29) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [factories_config](variables.tf#L29) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | | [iam](variables-iam.tf#L17) | Authoritative IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = []}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L34) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = []}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L34) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L44) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [icon](variables.tf#L38) | Base64 encoded image representing the data exchange. | string | | null | -| [listings](variables.tf#L44) | Listings definitions in the form {LISTING_ID => LISTING_CONFIGS}. LISTING_ID must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping or characters outside of ASCII spaces. | map(object({…})) | | {} | +| [listings](variables.tf#L44) | Listings definitions in the form {LISTING_ID => LISTING_CONFIGS}. LISTING_ID must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping or characters outside of ASCII spaces. | map(object({…})) | | {} | | [prefix](variables.tf#L76) | Optional prefix for data exchange ID. | string | | null | | [primary_contact](variables.tf#L82) | Email or URL of the primary point of contact of the data exchange. | string | | null | diff --git a/modules/api-gateway/recipe-multi-region/README.md b/modules/api-gateway/recipe-multi-region/README.md index e2811f081..6ced44732 100644 --- a/modules/api-gateway/recipe-multi-region/README.md +++ b/modules/api-gateway/recipe-multi-region/README.md @@ -20,7 +20,7 @@ Once deployed do the following to see that it works: |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L27) | Identifier of the project. | string | ✓ | | | [regions](variables.tf#L32) | List of regions to deploy the proxy in. | list(string) | ✓ | | -| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | +| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | ## Outputs diff --git a/modules/apigee/README.md b/modules/apigee/README.md index 7ffa6b09a..42a71bc27 100644 --- a/modules/apigee/README.md +++ b/modules/apigee/README.md @@ -389,13 +389,13 @@ module "apigee" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L148) | Project ID. | string | ✓ | | -| [addons_config](variables.tf#L17) | Addons configuration. | object({…}) | | null | -| [dns_zones](variables.tf#L29) | DNS zones. | map(object({…})) | | {} | -| [endpoint_attachments](variables.tf#L41) | Endpoint attachments. | map(object({…})) | | {} | +| [addons_config](variables.tf#L17) | Addons configuration. | object({…}) | | null | +| [dns_zones](variables.tf#L29) | DNS zones. | map(object({…})) | | {} | +| [endpoint_attachments](variables.tf#L41) | Endpoint attachments. | map(object({…})) | | {} | | [envgroups](variables.tf#L51) | Environment groups (NAME => [HOSTNAMES]). | map(list(string)) | | {} | -| [environments](variables.tf#L58) | Environments. | map(object({…})) | | {} | -| [instances](variables.tf#L86) | Instances ([REGION] => [INSTANCE]). | map(object({…})) | | {} | -| [organization](variables.tf#L116) | Apigee organization. If set to null the organization must already exist. | object({…}) | | null | +| [environments](variables.tf#L58) | Environments. | map(object({…})) | | {} | +| [instances](variables.tf#L86) | Instances ([REGION] => [INSTANCE]). | map(object({…})) | | {} | +| [organization](variables.tf#L116) | Apigee organization. If set to null the organization must already exist. | object({…}) | | null | ## Outputs diff --git a/modules/apigee/recipe-apigee-swp/README.md b/modules/apigee/recipe-apigee-swp/README.md index 121d54532..a16513f75 100644 --- a/modules/apigee/recipe-apigee-swp/README.md +++ b/modules/apigee/recipe-apigee-swp/README.md @@ -26,9 +26,9 @@ Once the terraform configuration is applied you can verify that all is working b |---|---|:---:|:---:|:---:| | [analytics_region](variables.tf#L27) | Region. | string | ✓ | | | [instance_region](variables.tf#L32) | Region. | string | ✓ | | -| [network_config](variables.tf#L37) | Network configuration. | object({…}) | ✓ | | +| [network_config](variables.tf#L37) | Network configuration. | object({…}) | ✓ | | | [project_id](variables.tf#L46) | Project ID. | string | ✓ | | -| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | +| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | ## Outputs diff --git a/modules/artifact-registry/README.md b/modules/artifact-registry/README.md index 6d4ebc350..def8441a4 100644 --- a/modules/artifact-registry/README.md +++ b/modules/artifact-registry/README.md @@ -311,23 +311,23 @@ module "additive_iam" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [cleanup_policies](variables.tf#L17) | Object containing details about the cleanup policies for an Artifact Registry repository. | map(object({…default = null | ✓ | | -| [format](variables.tf#L79) | Repository format. | object({…}) | ✓ | | +| [cleanup_policies](variables.tf#L17) | Object containing details about the cleanup policies for an Artifact Registry repository. | map(object({…default = null | ✓ | | +| [format](variables.tf#L79) | Repository format. | object({…}) | ✓ | | | [location](variables.tf#L229) | Registry location. Use `gcloud beta artifacts locations list' to get valid values. | string | ✓ | | | [name](variables.tf#L234) | Registry name. | string | ✓ | | | [project_id](variables.tf#L239) | Registry project id. | string | ✓ | | | [cleanup_policy_dry_run](variables.tf#L38) | If true, the cleanup pipeline is prevented from deleting versions in this repository. | bool | | null | -| [context](variables.tf#L44) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L44) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L61) | An optional description for the repository. | string | | "Terraform-managed registry" | | [enable_vulnerability_scanning](variables.tf#L67) | Whether vulnerability scanning should be enabled in the repository. | bool | | null | | [encryption_key](variables.tf#L73) | The KMS key name to use for encryption at rest. | string | | null | | [iam](variables-iam.tf#L36) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L43) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L58) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L43) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L58) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L73) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [labels](variables.tf#L223) | Labels to be attached to the registry. | map(string) | | {} | | [tag_bindings](variables.tf#L244) | Tag bindings for this repository, in key => tag value id format. | map(string) | | {} | -| [universe](variables.tf#L251) | GCP universe where to deploy the project. The prefix will be prepended to the project id. | object({…}) | | null | +| [universe](variables.tf#L251) | GCP universe where to deploy the project. The prefix will be prepended to the project id. | object({…}) | | null | ## Outputs diff --git a/modules/backup-dr/README.md b/modules/backup-dr/README.md index ca6f68f42..4110ae07f 100644 --- a/modules/backup-dr/README.md +++ b/modules/backup-dr/README.md @@ -178,7 +178,6 @@ module "dr_example" { } # tftest inventory=server.yaml ``` - ## Variables @@ -186,11 +185,11 @@ module "dr_example" { |---|---|:---:|:---:|:---:| | [location](variables.tf#L47) | Location for the Backup Vault and Plans (e.g. us-central1). | string | ✓ | | | [project_id](variables.tf#L71) | Project ID. | string | ✓ | | -| [backup_plans](variables.tf#L17) | Map of Backup Plans to create in this Vault. | map(object({…})) | | {} | -| [management_server_config](variables.tf#L52) | Configuration to create a Management Server. If null, no server is created. | object({…}) | | null | +| [backup_plans](variables.tf#L17) | Map of Backup Plans to create in this Vault. | map(object({…})) | | {} | +| [management_server_config](variables.tf#L52) | Configuration to create a Management Server. If null, no server is created. | object({…}) | | null | | [name](variables.tf#L65) | Name of the Backup Vault to create. Leave null if reusing an existing vault via `vault_reuse`. | string | | null | -| [vault_config](variables.tf#L76) | Configuration for the Backup Vault. Only used if `vault_reuse` is null. | object({…}) | | {} | -| [vault_reuse](variables.tf#L93) | Configuration to reuse an existing Backup Vault. | object({…}) | | null | +| [vault_config](variables.tf#L76) | Configuration for the Backup Vault. Only used if `vault_reuse` is null. | object({…}) | | {} | +| [vault_reuse](variables.tf#L93) | Configuration to reuse an existing Backup Vault. | object({…}) | | null | ## Outputs diff --git a/modules/biglake-catalog/README.md b/modules/biglake-catalog/README.md index efb391ead..88c544a5e 100644 --- a/modules/biglake-catalog/README.md +++ b/modules/biglake-catalog/README.md @@ -81,7 +81,7 @@ module "biglake_catalog" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [databases](variables.tf#L17) | Databases. | map(object({…})) | ✓ | | +| [databases](variables.tf#L17) | Databases. | map(object({…})) | ✓ | | | [location](variables.tf#L38) | Location. | string | ✓ | | | [name](variables.tf#L43) | Name. | string | ✓ | | | [project_id](variables.tf#L48) | Project ID. | string | ✓ | | diff --git a/modules/bigquery-connection/README.md b/modules/bigquery-connection/README.md index 43e8ebdd4..ca6c357df 100644 --- a/modules/bigquery-connection/README.md +++ b/modules/bigquery-connection/README.md @@ -131,14 +131,14 @@ module "bigquery-connection" { | [connection_id](variables.tf#L59) | The ID of the connection. | string | ✓ | | | [location](variables.tf#L132) | The geographic location where the connection should reside. | string | ✓ | | | [project_id](variables.tf#L137) | The ID of the project in which the resource belongs. | string | ✓ | | -| [connection_config](variables.tf#L17) | Connection properties. | object({…}) | | {} | -| [context](variables.tf#L64) | Context-specific interpolations. | object({…}) | | {} | +| [connection_config](variables.tf#L17) | Connection properties. | object({…}) | | {} | +| [context](variables.tf#L64) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L73) | A description of the connection. | string | | null | | [encryption_key](variables.tf#L79) | The name of the KMS key used for encryption. | string | | null | | [friendly_name](variables.tf#L85) | A descriptive name for the connection. | string | | null | | [iam](variables.tf#L91) | IAM bindings for the connection in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables.tf#L97) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables.tf#L111) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables.tf#L97) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables.tf#L111) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables.tf#L125) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | ## Outputs diff --git a/modules/bigquery-dataset/README.md b/modules/bigquery-dataset/README.md index 633ba60db..d43dfe1c9 100644 --- a/modules/bigquery-dataset/README.md +++ b/modules/bigquery-dataset/README.md @@ -361,28 +361,28 @@ module "bigquery-dataset" { |---|---|:---:|:---:|:---:| | [id](variables.tf#L111) | Dataset id. | string | ✓ | | | [project_id](variables.tf#L175) | Id of the project where datasets will be created. | string | ✓ | | -| [access](variables.tf#L17) | Map of access rules with role and identity type. Keys are arbitrary and must match those in the `access_identities` variable, types are `domain`, `group`, `special_group`, `user`, `view`. | map(object({…})) | | {} | +| [access](variables.tf#L17) | Map of access rules with role and identity type. Keys are arbitrary and must match those in the `access_identities` variable, types are `domain`, `group`, `special_group`, `user`, `view`. | map(object({…})) | | {} | | [access_identities](variables.tf#L33) | Map of access identities used for basic access roles. View identities have the format 'project_id\|dataset_id\|table_id'. | map(string) | | {} | -| [authorized_datasets](variables.tf#L39) | An array of datasets to be authorized on the dataset. | list(object({…})) | | [] | -| [authorized_routines](variables.tf#L48) | An array of routines to be authorized on the dataset. | list(object({…})) | | [] | -| [authorized_views](variables.tf#L58) | An array of views to be authorized on the dataset. | list(object({…})) | | [] | -| [context](variables.tf#L68) | Context-specific interpolations. | object({…}) | | {} | +| [authorized_datasets](variables.tf#L39) | An array of datasets to be authorized on the dataset. | list(object({…})) | | [] | +| [authorized_routines](variables.tf#L48) | An array of routines to be authorized on the dataset. | list(object({…})) | | [] | +| [authorized_views](variables.tf#L58) | An array of views to be authorized on the dataset. | list(object({…})) | | [] | +| [context](variables.tf#L68) | Context-specific interpolations. | object({…}) | | {} | | [dataset_access](variables.tf#L83) | Set access in the dataset resource instead of using separate resources. | bool | | false | | [description](variables.tf#L89) | Optional description. | string | | "Terraform managed." | | [encryption_key](variables.tf#L95) | Self link of the KMS key that will be used to protect destination table. | string | | null | | [friendly_name](variables.tf#L101) | Dataset friendly name. | string | | null | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. Mutually exclusive with the access_* variables used for basic roles. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L53) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [labels](variables.tf#L116) | Dataset labels. | map(string) | | {} | | [location](variables.tf#L122) | Dataset location. | string | | "EU" | -| [materialized_views](variables.tf#L128) | Materialized views definitions. | map(object({…})) | | {} | -| [options](variables.tf#L161) | Dataset options. | object({…}) | | {} | -| [routines](variables.tf#L180) | Routine definitions. | map(object({…})) | | {} | -| [tables](variables.tf#L219) | Table definitions. Options and partitioning default to null. Partitioning can only use `range` or `time`, set the unused one to null. | map(object({…})) | | {} | +| [materialized_views](variables.tf#L128) | Materialized views definitions. | map(object({…})) | | {} | +| [options](variables.tf#L161) | Dataset options. | object({…}) | | {} | +| [routines](variables.tf#L180) | Routine definitions. | map(object({…})) | | {} | +| [tables](variables.tf#L219) | Table definitions. Options and partitioning default to null. Partitioning can only use `range` or `time`, set the unused one to null. | map(object({…})) | | {} | | [tag_bindings](variables.tf#L304) | Tag bindings for this dataset, in key => tag value id format. | map(string) | | {} | -| [views](variables.tf#L311) | View definitions. | map(object({…})) | | {} | +| [views](variables.tf#L311) | View definitions. | map(object({…})) | | {} | ## Outputs diff --git a/modules/bigtable-instance/README.md b/modules/bigtable-instance/README.md index 42ad0975d..9e1ac75be 100644 --- a/modules/bigtable-instance/README.md +++ b/modules/bigtable-instance/README.md @@ -229,17 +229,17 @@ module "bigtable-instance" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [clusters](variables.tf#L17) | Clusters to be created in the BigTable instance. Set more than one cluster to enable replication. If you set autoscaling, num_nodes will be ignored. | map(object({…})) | ✓ | | +| [clusters](variables.tf#L17) | Clusters to be created in the BigTable instance. Set more than one cluster to enable replication. If you set autoscaling, num_nodes will be ignored. | map(object({…})) | ✓ | | | [name](variables.tf#L87) | The name of the Cloud Bigtable instance. | string | ✓ | | | [project_id](variables.tf#L92) | Id of the project where datasets will be created. | string | ✓ | | -| [default_autoscaling](variables.tf#L33) | Default settings for autoscaling of clusters. This will be the default autoscaling for any cluster not specifying any autoscaling details. | object({…}) | | null | -| [default_gc_policy](variables.tf#L44) | Default garbage collection policy, to be applied to all column families and all tables. Can be override in the tables variable for specific column families. | object({…}) | | null | +| [default_autoscaling](variables.tf#L33) | Default settings for autoscaling of clusters. This will be the default autoscaling for any cluster not specifying any autoscaling details. | object({…}) | | null | +| [default_gc_policy](variables.tf#L44) | Default garbage collection policy, to be applied to all column families and all tables. Can be override in the tables variable for specific column families. | object({…}) | | null | | [deletion_protection](variables.tf#L56) | Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. | bool | | true | | [display_name](variables.tf#L63) | The human-readable display name of the Bigtable instance. | string | | null | | [encryption_key](variables.tf#L69) | The KMS key id to used for encryption of the Bigtable instance. | string | | null | | [iam](variables.tf#L75) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [labels](variables.tf#L81) | Labels to be attached to the instance. | map(string) | | {} | -| [tables](variables.tf#L97) | Tables to be created in the BigTable instance. | map(object({…})) | | {} | +| [tables](variables.tf#L97) | Tables to be created in the BigTable instance. | map(object({…})) | | {} | ## Outputs diff --git a/modules/billing-account/README.md b/modules/billing-account/README.md index 563370fac..07e352784 100644 --- a/modules/billing-account/README.md +++ b/modules/billing-account/README.md @@ -282,15 +282,15 @@ update_rules: | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [id](variables.tf#L165) | Billing account id. | string | ✓ | | -| [budget_notification_channels](variables.tf#L17) | Notification channels used by budget alerts. | map(object({…})) | | {} | -| [budgets](variables.tf#L47) | Billing budgets. Notification channels are either keys in corresponding variable, or external ids. | map(object({…})) | | {} | -| [context](variables.tf#L139) | Context-specific interpolations. | object({…}) | | {} | -| [factories_config](variables.tf#L156) | Path to folder containing budget alerts data files. | object({…}) | | {} | +| [budget_notification_channels](variables.tf#L17) | Notification channels used by budget alerts. | map(object({…})) | | {} | +| [budgets](variables.tf#L47) | Billing budgets. Notification channels are either keys in corresponding variable, or external ids. | map(object({…})) | | {} | +| [context](variables.tf#L139) | Context-specific interpolations. | object({…}) | | {} | +| [factories_config](variables.tf#L156) | Path to folder containing budget alerts data files. | object({…}) | | {} | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L54) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | -| [logging_sinks](variables.tf#L170) | Logging sinks to create for the billing account. | map(object({…})) | | {} | +| [logging_sinks](variables.tf#L170) | Logging sinks to create for the billing account. | map(object({…})) | | {} | | [projects](variables.tf#L203) | Projects associated with this billing account. | list(string) | | [] | ## Outputs diff --git a/modules/binauthz/README.md b/modules/binauthz/README.md index 470d59440..cf43d93b4 100644 --- a/modules/binauthz/README.md +++ b/modules/binauthz/README.md @@ -61,9 +61,9 @@ module "binauthz" { |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L62) | Project ID. | string | ✓ | | | [admission_whitelist_patterns](variables.tf#L17) | An image name pattern to allowlist. | list(string) | | null | -| [attestors_config](variables.tf#L23) | Attestors configuration. | map(object({…})) | | null | -| [cluster_admission_rules](variables.tf#L38) | Admission rules. | map(object({…})) | | null | -| [default_admission_rule](variables.tf#L48) | Default admission rule. | object({…}) | | {…} | +| [attestors_config](variables.tf#L23) | Attestors configuration. | map(object({…})) | | null | +| [cluster_admission_rules](variables.tf#L38) | Admission rules. | map(object({…})) | | null | +| [default_admission_rule](variables.tf#L48) | Default admission rule. | object({…}) | | {…} | ## Outputs diff --git a/modules/certificate-authority-service/README.md b/modules/certificate-authority-service/README.md index 2bfb7abce..97822b834 100644 --- a/modules/certificate-authority-service/README.md +++ b/modules/certificate-authority-service/README.md @@ -113,14 +113,14 @@ module "cas" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [ca_pool_config](variables.tf#L105) | The CA pool config. Either use_pool or create_pool need to be used. Use pool takes precedence if both are defined. | object({…}) | ✓ | | +| [ca_pool_config](variables.tf#L105) | The CA pool config. Either use_pool or create_pool need to be used. Use pool takes precedence if both are defined. | object({…}) | ✓ | | | [location](variables.tf#L134) | The location of the CAs. | string | ✓ | | | [project_id](variables.tf#L139) | Project id. | string | ✓ | | -| [ca_configs](variables.tf#L17) | The CA configurations. | map(object({…})) | | {…} | -| [context](variables.tf#L119) | Context-specific interpolations. | object({…}) | | {} | +| [ca_configs](variables.tf#L17) | The CA configurations. | map(object({…})) | | {…} | +| [context](variables.tf#L119) | Context-specific interpolations. | object({…}) | | {} | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L54) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | ## Outputs diff --git a/modules/certificate-manager/README.md b/modules/certificate-manager/README.md index 4445b1f0c..3bc8c3f42 100644 --- a/modules/certificate-manager/README.md +++ b/modules/certificate-manager/README.md @@ -228,10 +228,10 @@ module "certificate-manager" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L113) | Project id. | string | ✓ | | -| [certificates](variables.tf#L17) | Certificates. | map(object({…})) | | {} | -| [dns_authorizations](variables.tf#L63) | DNS authorizations. | map(object({…})) | | {} | -| [issuance_configs](variables.tf#L76) | Issuance configs. | map(object({…})) | | {} | -| [map](variables.tf#L91) | Map attributes. | object({…}) | | null | +| [certificates](variables.tf#L17) | Certificates. | map(object({…})) | | {} | +| [dns_authorizations](variables.tf#L63) | DNS authorizations. | map(object({…})) | | {} | +| [issuance_configs](variables.tf#L76) | Issuance configs. | map(object({…})) | | {} | +| [map](variables.tf#L91) | Map attributes. | object({…}) | | null | ## Outputs diff --git a/modules/cloud-build-v2-connection/README.md b/modules/cloud-build-v2-connection/README.md index d2052f0a7..1043258cf 100644 --- a/modules/cloud-build-v2-connection/README.md +++ b/modules/cloud-build-v2-connection/README.md @@ -532,15 +532,15 @@ module "cb_connection" { | [name](variables.tf#L108) | Name. | string | ✓ | | | [project_id](variables.tf#L113) | Project ID. | string | ✓ | | | [annotations](variables.tf#L17) | Annotations. | map(string) | | {} | -| [connection_config](variables.tf#L23) | Connection configuration. | object({…}) | | {} | +| [connection_config](variables.tf#L23) | Connection configuration. | object({…}) | | {} | | [connection_create](variables.tf#L78) | Create connection. | bool | | true | -| [context](variables.tf#L85) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L85) | Context-specific interpolations. | object({…}) | | {} | | [disabled](variables.tf#L97) | Flag indicating whether the connection is disabled or not. | bool | | false | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L53) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | -| [repositories](variables.tf#L118) | Repositories. | map(object({…})) | | {} | +| [repositories](variables.tf#L118) | Repositories. | map(object({…})) | | {} | ## Outputs diff --git a/modules/cloud-config-container/__need_fixing/onprem/README.md b/modules/cloud-config-container/__need_fixing/onprem/README.md index 1f6308ca6..979eec031 100644 --- a/modules/cloud-config-container/__need_fixing/onprem/README.md +++ b/modules/cloud-config-container/__need_fixing/onprem/README.md @@ -69,16 +69,15 @@ module "vm" { # tftest skip ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [vpn_config](variables.tf#L35) | VPN configuration, type must be one of 'dynamic' or 'static'. | object({…}) | ✓ | | +| [vpn_config](variables.tf#L35) | VPN configuration, type must be one of 'dynamic' or 'static'. | object({…}) | ✓ | | | [config_variables](variables.tf#L17) | Additional variables used to render the cloud-config and CoreDNS templates. | map(any) | | {} | | [coredns_config](variables.tf#L23) | CoreDNS configuration path, if null default will be used. | string | | null | | [local_ip_cidr_range](variables.tf#L29) | IP CIDR range used for the Docker onprem network. | string | | "192.168.192.0/24" | -| [vpn_dynamic_config](variables.tf#L46) | BGP configuration for dynamic VPN, ignored if VPN type is 'static'. | object({…}) | | {…} | +| [vpn_dynamic_config](variables.tf#L46) | BGP configuration for dynamic VPN, ignored if VPN type is 'static'. | object({…}) | | {…} | | [vpn_static_ranges](variables.tf#L70) | Remote CIDR ranges for static VPN, ignored if VPN type is 'dynamic'. | list(string) | | ["10.0.0.0/8"] | ## Outputs @@ -86,5 +85,4 @@ module "vm" { | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/__need_fixing/squid/README.md b/modules/cloud-config-container/__need_fixing/squid/README.md index dd0ac01b7..866712f7e 100644 --- a/modules/cloud-config-container/__need_fixing/squid/README.md +++ b/modules/cloud-config-container/__need_fixing/squid/README.md @@ -54,7 +54,6 @@ module "vm" { # tftest modules=1 resources=1 ``` - ## Variables | name | description | type | required | default | @@ -65,8 +64,8 @@ module "vm" { | [config_variables](variables.tf#L36) | Additional variables used to render the cloud-config and Squid templates. | map(any) | | {} | | [default_action](variables.tf#L42) | Default action for domains not matching neither the allow or deny lists. | string | | "deny" | | [deny](variables.tf#L52) | List of domains Squid will deny connections to. | list(string) | | [] | -| [file_defaults](variables.tf#L58) | Default owner and permissions for files. | object({…}) | | {…} | -| [files](variables.tf#L70) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [file_defaults](variables.tf#L58) | Default owner and permissions for files. | object({…}) | | {…} | +| [files](variables.tf#L70) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | | [squid_config](variables.tf#L80) | Squid configuration path, if null default will be used. | string | | null | ## Outputs @@ -74,5 +73,4 @@ module "vm" { | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/bindplane/README.md b/modules/cloud-config-container/bindplane/README.md index 62af89ed2..533563452 100644 --- a/modules/cloud-config-container/bindplane/README.md +++ b/modules/cloud-config-container/bindplane/README.md @@ -81,14 +81,14 @@ module "bindplane" { |---|---|:---:|:---:|:---:| | [bindplane_license](variables.tf#L29) | BindPlane server license. | string | ✓ | | | [password](variables.tf#L68) | Default admin user password. | string | ✓ | | -| [bindplane_config](variables.tf#L17) | Bindplane configurations. | object({…}) | | {} | +| [bindplane_config](variables.tf#L17) | Bindplane configurations. | object({…}) | | {} | | [cloud_config](variables.tf#L34) | Cloud config template path. If null default will be used. | string | | null | | [config_variables](variables.tf#L40) | Additional variables used to render the cloud-config and Nginx templates. | map(any) | | {} | -| [file_defaults](variables.tf#L46) | Default owner and permissions for files. | object({…}) | | {…} | -| [files](variables.tf#L58) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [file_defaults](variables.tf#L46) | Default owner and permissions for files. | object({…}) | | {…} | +| [files](variables.tf#L58) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | | [runcmd_post](variables.tf#L73) | Extra commands to run after starting nginx. | list(string) | | [] | | [runcmd_pre](variables.tf#L79) | Extra commands to run before starting nginx. | list(string) | | [] | -| [users](variables.tf#L85) | List of additional usernames to be created. | list(object({…})) | | […] | +| [users](variables.tf#L85) | List of additional usernames to be created. | list(object({…})) | | […] | ## Outputs diff --git a/modules/cloud-config-container/coredns/README.md b/modules/cloud-config-container/coredns/README.md index 2717b0735..ae36018d0 100644 --- a/modules/cloud-config-container/coredns/README.md +++ b/modules/cloud-config-container/coredns/README.md @@ -73,7 +73,6 @@ module "cos-coredns" { # tftest modules=0 resources=0 ``` - ## Variables | name | description | type | required | default | @@ -81,13 +80,12 @@ module "cos-coredns" { | [cloud_config](variables.tf#L17) | Cloud config template path. If null default will be used. | string | | null | | [config_variables](variables.tf#L23) | Additional variables used to render the cloud-config and CoreDNS templates. | map(any) | | {} | | [coredns_config](variables.tf#L29) | CoreDNS configuration path, if null default will be used. | string | | null | -| [file_defaults](variables.tf#L35) | Default owner and permissions for files. | object({…}) | | {…} | -| [files](variables.tf#L47) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [file_defaults](variables.tf#L35) | Default owner and permissions for files. | object({…}) | | {…} | +| [files](variables.tf#L47) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | ## Outputs | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/cos-generic-metadata/README.md b/modules/cloud-config-container/cos-generic-metadata/README.md index 88073986d..1a28b88cc 100644 --- a/modules/cloud-config-container/cos-generic-metadata/README.md +++ b/modules/cloud-config-container/cos-generic-metadata/README.md @@ -51,7 +51,6 @@ module "cos-envoy" { # tftest modules=0 resources=0 ``` - ## Variables | name | description | type | required | default | @@ -63,18 +62,17 @@ module "cos-envoy" { | [config_variables](variables.tf#L35) | Additional variables used to render the template passed via `cloud_config`. | map(any) | | {} | | [container_args](variables.tf#L41) | Arguments for container. | string | | "" | | [container_name](variables.tf#L52) | Name of the container to be run. | string | | "container" | -| [container_volumes](variables.tf#L58) | List of volumes. | list(object({…})) | | [] | +| [container_volumes](variables.tf#L58) | List of volumes. | list(object({…})) | | [] | | [docker_args](variables.tf#L67) | Extra arguments to be passed for docker. | string | | null | -| [file_defaults](variables.tf#L73) | Default owner and permissions for files. | object({…}) | | {…} | -| [files](variables.tf#L85) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [file_defaults](variables.tf#L73) | Default owner and permissions for files. | object({…}) | | {…} | +| [files](variables.tf#L85) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | | [run_as_first_user](variables.tf#L95) | Run as the first user if users are specified. | bool | | true | | [run_commands](variables.tf#L101) | List of cloud-init `runcmd`s. | list(string) | | [] | -| [users](variables.tf#L107) | List of usernames to be created. If provided, first user will be used to run the container. | list(object({…})) | | […] | +| [users](variables.tf#L107) | List of usernames to be created. If provided, first user will be used to run the container. | list(object({…})) | | […] | ## Outputs | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/mysql/README.md b/modules/cloud-config-container/mysql/README.md index 827e5cc3b..f772ac9b8 100644 --- a/modules/cloud-config-container/mysql/README.md +++ b/modules/cloud-config-container/mysql/README.md @@ -76,7 +76,6 @@ module "cos-mysql" { # tftest modules=0 resources=0 ``` - ## Variables | name | description | type | required | default | @@ -85,7 +84,7 @@ module "cos-mysql" { | [cloud_config](variables.tf#L17) | Cloud config template path. If null default will be used. | string | | null | | [config_variables](variables.tf#L23) | Additional variables used to render the cloud-config template. | map(any) | | {} | | [image](variables.tf#L29) | MySQL container image. | string | | "mysql:5.7" | -| [kms_config](variables.tf#L35) | Optional KMS configuration to decrypt passed-in password. Leave null if a plaintext password is used. | object({…}) | | null | +| [kms_config](variables.tf#L35) | Optional KMS configuration to decrypt passed-in password. Leave null if a plaintext password is used. | object({…}) | | null | | [mysql_config](variables.tf#L46) | MySQL configuration file content, if null container default will be used. | string | | null | | [mysql_data_disk](variables.tf#L52) | MySQL data disk name in /dev/disk/by-id/ including the google- prefix. If null the boot disk will be used for data. | string | | null | @@ -94,5 +93,4 @@ module "cos-mysql" { | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/nginx-tls/README.md b/modules/cloud-config-container/nginx-tls/README.md index d9e343e30..90bb5b6ec 100644 --- a/modules/cloud-config-container/nginx-tls/README.md +++ b/modules/cloud-config-container/nginx-tls/README.md @@ -38,12 +38,11 @@ module "vm-nginx-tls" { # tftest modules=1 resources=1 ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [files](variables.tf#L17) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [files](variables.tf#L17) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | | [hello](variables.tf#L28) | Behave like the nginx hello image by returning plain text informative responses. | bool | | true | | [image](variables.tf#L35) | Nginx container image to use. | string | | "nginx:1.23.1" | @@ -52,5 +51,4 @@ module "vm-nginx-tls" { | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/nginx/README.md b/modules/cloud-config-container/nginx/README.md index 5d8b45958..bd13ed5c0 100644 --- a/modules/cloud-config-container/nginx/README.md +++ b/modules/cloud-config-container/nginx/README.md @@ -54,25 +54,23 @@ module "vm-nginx-tls" { # tftest modules=1 resources=1 ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [cloud_config](variables.tf#L17) | Cloud config template path. If null default will be used. | string | | null | | [config_variables](variables.tf#L23) | Additional variables used to render the cloud-config and Nginx templates. | map(any) | | {} | -| [file_defaults](variables.tf#L29) | Default owner and permissions for files. | object({…}) | | {…} | -| [files](variables.tf#L41) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [file_defaults](variables.tf#L29) | Default owner and permissions for files. | object({…}) | | {…} | +| [files](variables.tf#L41) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | | [image](variables.tf#L51) | Nginx container image. | string | | "nginxdemos/hello:plain-text" | | [nginx_config](variables.tf#L57) | Nginx configuration path, if null container default will be used. | string | | null | | [runcmd_post](variables.tf#L63) | Extra commands to run after starting nginx. | list(string) | | [] | | [runcmd_pre](variables.tf#L69) | Extra commands to run before starting nginx. | list(string) | | [] | -| [users](variables.tf#L75) | List of additional usernames to be created. | list(object({…})) | | […] | +| [users](variables.tf#L75) | List of additional usernames to be created. | list(object({…})) | | […] | ## Outputs | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-config-container/simple-nva/README.md b/modules/cloud-config-container/simple-nva/README.md index 06501a167..c8ce4e856 100644 --- a/modules/cloud-config-container/simple-nva/README.md +++ b/modules/cloud-config-container/simple-nva/README.md @@ -163,17 +163,16 @@ Check FRR running configuration with `show running-config` from vtysh. Please al Sample frr.conf file is based on the documentation available [here](https://docs.frrouting.org/en/latest/basic.html). It configures a BGP service with ASN 65001 on FRR container establishing a BGP session with a remote neighbor with IP address 10.128.0.2 and ASN 65002. Check BGP status for FRR with `show bgp summary` from vtysh. - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [network_interfaces](variables.tf#L75) | Network interfaces configuration. | list(object({…})) | ✓ | | +| [network_interfaces](variables.tf#L75) | Network interfaces configuration. | list(object({…})) | ✓ | | | [cloud_config](variables.tf#L17) | Cloud config template path. If null default will be used. | string | | null | | [enable_health_checks](variables.tf#L23) | Configures routing to enable responses to health check probes. | bool | | false | -| [files](variables.tf#L29) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | -| [frr_config](variables.tf#L39) | FRR configuration for container running on the NVA. | object({…}) | | null | -| [open_ports](variables.tf#L84) | Optional firewall ports to open. | object({…}) | | {…} | +| [files](variables.tf#L29) | Map of extra files to create on the instance, path as key. Owner and permissions will use defaults if null. | map(object({…})) | | {} | +| [frr_config](variables.tf#L39) | FRR configuration for container running on the NVA. | object({…}) | | null | +| [open_ports](variables.tf#L84) | Optional firewall ports to open. | object({…}) | | {…} | | [run_cmds](variables.tf#L96) | Optional cloud init run commands to execute. | list(string) | | [] | ## Outputs @@ -181,5 +180,4 @@ Sample frr.conf file is based on the documentation available [here](https://docs | name | description | sensitive | |---|---|:---:| | [cloud_config](outputs.tf#L17) | Rendered cloud-config file to be passed as user-data instance metadata. | | - diff --git a/modules/cloud-deploy/README.md b/modules/cloud-deploy/README.md index 268e53dcc..3cdaf0c71 100644 --- a/modules/cloud-deploy/README.md +++ b/modules/cloud-deploy/README.md @@ -432,16 +432,16 @@ module "cloud_run" { | [project_id](variables.tf#L201) | Project id used for resources, if not explicitly specified. | string | ✓ | | | [region](variables.tf#L206) | Region used for resources, if not explicitly specified. | string | ✓ | | | [annotations](variables.tf#L17) | Resource annotations. | map(string) | | {} | -| [automations](variables.tf#L24) | Configuration for automations associated with the deployment pipeline in a name => attributes format. | map(object({…})) | | {} | -| [deploy_policies](variables.tf#L84) | Configurations for Deployment Policies in a name => attributes format. | map(object({…})) | | {} | +| [automations](variables.tf#L24) | Configuration for automations associated with the deployment pipeline in a name => attributes format. | map(object({…})) | | {} | +| [deploy_policies](variables.tf#L84) | Configurations for Deployment Policies in a name => attributes format. | map(object({…})) | | {} | | [description](variables.tf#L165) | Cloud Deploy Delivery Pipeline description. | string | | "Terraform managed." | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L54) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [labels](variables.tf#L176) | Cloud Deploy Delivery Pipeline resource labels. | map(string) | | {} | | [suspended](variables.tf#L211) | Configuration to suspend a delivery pipeline. | bool | | false | -| [targets](variables.tf#L218) | Configuration for new targets associated with the delivery pipeline in a list format. Order of the targets are defined by the order within the list. | list(object({…})) | | [] | +| [targets](variables.tf#L218) | Configuration for new targets associated with the delivery pipeline in a list format. Order of the targets are defined by the order within the list. | list(object({…})) | | [] | ## Outputs diff --git a/modules/cloud-function-v1/README.md b/modules/cloud-function-v1/README.md index f4c7582fc..b15ee08d2 100644 --- a/modules/cloud-function-v1/README.md +++ b/modules/cloud-function-v1/README.md @@ -479,29 +479,29 @@ module "cf_http" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [bucket_name](variables.tf#L27) | Name of the bucket that will be used for the function code. It will be created with prefix prepended if bucket_config is not null. | string | ✓ | | -| [bundle_config](variables.tf#L45) | Cloud function source. Path can point to a GCS object URI, or a local path. A local path to a zip archive will generate a GCS object using its basename, a folder will be zipped and the GCS object name inferred when not specified. | object({…}) | ✓ | | +| [bundle_config](variables.tf#L45) | Cloud function source. Path can point to a GCS object URI, or a local path. A local path to a zip archive will generate a GCS object using its basename, a folder will be zipped and the GCS object name inferred when not specified. | object({…}) | ✓ | | | [name](variables.tf#L158) | Name used for cloud function and associated resources. | string | ✓ | | | [project_id](variables.tf#L173) | Project id used for all resources. | string | ✓ | | | [region](variables.tf#L178) | Region used for all resources. | string | ✓ | | -| [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | +| [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | | [build_environment_variables](variables.tf#L33) | A set of key/value environment variable pairs available during build time. | map(string) | | {} | | [build_worker_pool](variables.tf#L39) | Build worker pool, in projects//locations//workerPools/ format. | string | | null | -| [context](variables.tf#L78) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L78) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L96) | Optional description. | string | | "Terraform managed." | | [environment_variables](variables.tf#L102) | Cloud function environment variables. | map(string) | | {} | -| [function_config](variables.tf#L108) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | object({…}) | | {…} | +| [function_config](variables.tf#L108) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | object({…}) | | {…} | | [https_security_level](variables.tf#L128) | The security level for the function: Allowed values are SECURE_ALWAYS, SECURE_OPTIONAL. | string | | null | | [iam](variables.tf#L134) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [ingress_settings](variables.tf#L140) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | string | | null | | [kms_key](variables.tf#L146) | Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources in key id format. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. | string | | null | | [labels](variables.tf#L152) | Resource labels. | map(string) | | {} | | [prefix](variables.tf#L163) | Optional prefix used for resource names. | string | | null | -| [repository_settings](variables.tf#L183) | Docker Registry to use for storing the function's Docker images and specific repository. If kms_key is provided, the repository must have already been encrypted with the key. | object({…}) | | {…} | -| [secrets](variables.tf#L194) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | -| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | -| [trigger_config](variables.tf#L206) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | -| [vpc_connector](variables.tf#L216) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | {} | -| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | +| [repository_settings](variables.tf#L183) | Docker Registry to use for storing the function's Docker images and specific repository. If kms_key is provided, the repository must have already been encrypted with the key. | object({…}) | | {…} | +| [secrets](variables.tf#L194) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | +| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | +| [trigger_config](variables.tf#L206) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | +| [vpc_connector](variables.tf#L216) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | {} | +| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | ## Outputs diff --git a/modules/cloud-function-v2/README.md b/modules/cloud-function-v2/README.md index 050e26b5b..c0dd83e4a 100644 --- a/modules/cloud-function-v2/README.md +++ b/modules/cloud-function-v2/README.md @@ -436,30 +436,30 @@ module "cf_http" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [bucket_name](variables.tf#L27) | Name of the bucket that will be used for the function code. It will be created with prefix prepended if bucket_config is not null. | string | ✓ | | -| [bundle_config](variables.tf#L51) | Cloud function source. Path can point to a GCS object URI, or a local path. A local path to a zip archive will generate a GCS object using its basename, a folder will be zipped and the GCS object name inferred when not specified. | object({…}) | ✓ | | +| [bundle_config](variables.tf#L51) | Cloud function source. Path can point to a GCS object URI, or a local path. A local path to a zip archive will generate a GCS object using its basename, a folder will be zipped and the GCS object name inferred when not specified. | object({…}) | ✓ | | | [name](variables.tf#L186) | Name used for cloud function and associated resources. | string | ✓ | | | [project_id](variables.tf#L201) | Project id used for all resources. | string | ✓ | | | [region](variables.tf#L206) | Region used for all resources. | string | ✓ | | -| [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | +| [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | | [build_environment_variables](variables.tf#L33) | A set of key/value environment variable pairs available during build time. | map(string) | | {} | | [build_service_account](variables.tf#L39) | Build service account email. | string | | null | | [build_worker_pool](variables.tf#L45) | Build worker pool, in projects//locations//workerPools/ format. | string | | null | -| [context](variables.tf#L84) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L84) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L102) | Optional description. | string | | "Terraform managed." | -| [direct_vpc_egress](variables.tf#L108) | Direct VPC egress configuration. | object({…}) | | null | +| [direct_vpc_egress](variables.tf#L108) | Direct VPC egress configuration. | object({…}) | | null | | [docker_repository_id](variables.tf#L126) | User managed repository created in Artifact Registry. | string | | null | -| [environment_variables](variables.tf#L132) | Cloud function environment variables. | map(string) | | {…} | -| [function_config](variables.tf#L140) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | object({…}) | | {…} | +| [environment_variables](variables.tf#L132) | Cloud function environment variables. | map(string) | | {…} | +| [function_config](variables.tf#L140) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | object({…}) | | {…} | | [iam](variables.tf#L162) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [ingress_settings](variables.tf#L168) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | string | | null | | [kms_key](variables.tf#L174) | Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources in key id format. If specified, you must also provide an artifact registry repository using the docker_repository_id field that was created with the same KMS crypto key. | string | | null | | [labels](variables.tf#L180) | Resource labels. | map(string) | | {} | | [prefix](variables.tf#L191) | Optional prefix used for resource names. | string | | null | -| [secrets](variables.tf#L211) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | -| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | -| [trigger_config](variables.tf#L223) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | -| [vpc_connector](variables.tf#L241) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | {} | -| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | +| [secrets](variables.tf#L211) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | +| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | +| [trigger_config](variables.tf#L223) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | +| [vpc_connector](variables.tf#L241) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | {} | +| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | ## Outputs diff --git a/modules/cloud-run-v2/README.md b/modules/cloud-run-v2/README.md index 62032e084..5ae3d8359 100644 --- a/modules/cloud-run-v2/README.md +++ b/modules/cloud-run-v2/README.md @@ -986,23 +986,23 @@ module "worker" { | [name](variables.tf#L178) | Name used for Cloud Run service. | string | ✓ | | | [project_id](variables.tf#L183) | Project id used for all resources. | string | ✓ | | | [region](variables.tf#L188) | Region used for all resources. | string | ✓ | | -| [containers](variables.tf#L17) | Containers in name => attributes format. | map(object({…})) | | {} | -| [context](variables.tf#L97) | Context-specific interpolations. | object({…}) | | {} | +| [containers](variables.tf#L17) | Containers in name => attributes format. | map(object({…})) | | {} | +| [context](variables.tf#L97) | Context-specific interpolations. | object({…}) | | {} | | [deletion_protection](variables.tf#L115) | Deletion protection setting for this Cloud Run service. | string | | null | | [encryption_key](variables.tf#L121) | The full resource name of the Cloud KMS CryptoKey. | string | | null | | [iam](variables.tf#L127) | IAM bindings for Cloud Run service in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [job_config](variables.tf#L133) | Cloud Run Job specific configuration. | object({…}) | | {} | +| [job_config](variables.tf#L133) | Cloud Run Job specific configuration. | object({…}) | | {} | | [labels](variables.tf#L148) | Resource labels. | map(string) | | {} | | [launch_stage](variables.tf#L154) | The launch stage as defined by Google Cloud Platform Launch Stages. | string | | null | | [managed_revision](variables.tf#L171) | Whether the Terraform module should control the deployment of revisions. | bool | | true | -| [revision](variables.tf#L193) | Revision template configurations. | object({…}) | | {} | -| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | -| [service_config](variables.tf#L260) | Cloud Run service specific configuration options. | object({…}) | | {} | +| [revision](variables.tf#L193) | Revision template configurations. | object({…}) | | {} | +| [service_account_config](variables-serviceaccount.tf#L17) | Service account configurations. | object({…}) | | {} | +| [service_config](variables.tf#L260) | Cloud Run service specific configuration options. | object({…}) | | {} | | [tag_bindings](variables.tf#L323) | Tag bindings for this service, in key => tag value id format. | map(string) | | {} | | [type](variables.tf#L330) | Type of Cloud Run resource to deploy: JOB, SERVICE or WORKERPOOL. | string | | "SERVICE" | -| [volumes](variables.tf#L340) | Named volumes in containers in name => attributes format. | map(object({…})) | | {} | -| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | -| [workerpool_config](variables.tf#L374) | Cloud Run Worker Pool specific configuration. | object({…}) | | {} | +| [volumes](variables.tf#L340) | Named volumes in containers in name => attributes format. | map(object({…})) | | {} | +| [vpc_connector_create](variables-vpcconnector.tf#L17) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | +| [workerpool_config](variables.tf#L374) | Cloud Run Worker Pool specific configuration. | object({…}) | | {} | ## Outputs diff --git a/modules/cloudsql-instance/README.md b/modules/cloudsql-instance/README.md index fe31ef1b8..b1c4db15d 100644 --- a/modules/cloudsql-instance/README.md +++ b/modules/cloudsql-instance/README.md @@ -415,16 +415,16 @@ module "db" { |---|---|:---:|:---:|:---:| | [database_version](variables.tf#L85) | Database type and version to create. | string | ✓ | | | [name](variables.tf#L201) | Name of primary instance. | string | ✓ | | -| [network_config](variables.tf#L206) | Network configuration for the instance. Only one between private_network and psc_config can be used. | object({…}) | ✓ | | +| [network_config](variables.tf#L206) | Network configuration for the instance. Only one between private_network and psc_config can be used. | object({…}) | ✓ | | | [project_id](variables.tf#L249) | The ID of the project where this instances will be created. | string | ✓ | | | [region](variables.tf#L254) | Region of the primary instance. | string | ✓ | | | [tier](variables.tf#L306) | The machine type to use for the instances. | string | ✓ | | | [activation_policy](variables.tf#L17) | This variable specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND. Default is ALWAYS. | string | | "ALWAYS" | | [availability_type](variables.tf#L28) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | string | | "ZONAL" | -| [backup_configuration](variables.tf#L34) | Backup settings for primary instance. Set to null to leave existing GCP backup settings unmanaged. When set, all fields are managed by Terraform including disabling backups when enabled=false. | object({…}) | | null | +| [backup_configuration](variables.tf#L34) | Backup settings for primary instance. Set to null to leave existing GCP backup settings unmanaged. When set, all fields are managed by Terraform including disabling backups when enabled=false. | object({…}) | | null | | [collation](variables.tf#L54) | The name of server instance collation. | string | | null | | [connector_enforcement](variables.tf#L60) | Specifies if connections must use Cloud SQL connectors. | string | | null | -| [context](variables.tf#L66) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L66) | Context-specific interpolations. | object({…}) | | {} | | [data_cache](variables.tf#L78) | Enable data cache. Only used for Enterprise MYSQL and PostgreSQL. | bool | | false | | [databases](variables.tf#L90) | Databases to create once the primary instance is created. | list(string) | | null | | [disk_autoresize_limit](variables.tf#L96) | The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. | number | | 0 | @@ -434,18 +434,18 @@ module "db" { | [encryption_key_name](variables.tf#L120) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | string | | null | | [flags](variables.tf#L126) | Map FLAG_NAME=>VALUE for database-specific tuning. | map(string) | | null | | [gcp_deletion_protection](variables.tf#L132) | Set Google's deletion protection attribute which applies across all surfaces (UI, API, & Terraform). | bool | | true | -| [insights_config](variables.tf#L139) | Query Insights configuration. Defaults to null which disables Query Insights. | object({…}) | | null | +| [insights_config](variables.tf#L139) | Query Insights configuration. Defaults to null which disables Query Insights. | object({…}) | | null | | [labels](variables.tf#L150) | Labels to be attached to all instances. | map(string) | | null | -| [maintenance_config](variables.tf#L156) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | object({…}) | | {} | -| [managed_connection_pooling_config](variables.tf#L191) | Configuration for Managed Connection Pooling. NOTE: This feature is only available for PostgreSQL on Enterprise Plus edition instances. | object({…}) | | {} | -| [password_validation_policy](variables.tf#L225) | Password validation policy configuration for instances. | object({…}) | | null | +| [maintenance_config](variables.tf#L156) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | object({…}) | | {} | +| [managed_connection_pooling_config](variables.tf#L191) | Configuration for Managed Connection Pooling. NOTE: This feature is only available for PostgreSQL on Enterprise Plus edition instances. | object({…}) | | {} | +| [password_validation_policy](variables.tf#L225) | Password validation policy configuration for instances. | object({…}) | | null | | [prefix](variables.tf#L239) | Optional prefix used to generate instance names. | string | | null | -| [replicas](variables.tf#L259) | Map of NAME=> {REGION, KMS_KEY, AVAILABILITY_TYPE} for additional read replicas. Set to null to disable replica creation. | map(object({…})) | | {} | -| [root_password](variables.tf#L270) | Root password of the Cloud SQL instance, or flag to create a random password. Required for MS SQL Server. | object({…}) | | {} | -| [ssl](variables.tf#L284) | Setting to enable SSL, set config and certificates. | object({…}) | | {} | +| [replicas](variables.tf#L259) | Map of NAME=> {REGION, KMS_KEY, AVAILABILITY_TYPE} for additional read replicas. Set to null to disable replica creation. | map(object({…})) | | {} | +| [root_password](variables.tf#L270) | Root password of the Cloud SQL instance, or flag to create a random password. Required for MS SQL Server. | object({…}) | | {} | +| [ssl](variables.tf#L284) | Setting to enable SSL, set config and certificates. | object({…}) | | {} | | [terraform_deletion_protection](variables.tf#L299) | Prevent terraform from deleting instances. | bool | | true | | [time_zone](variables.tf#L311) | The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format. | string | | null | -| [users](variables.tf#L317) | Map of users to create in the primary instance (and replicated to other replicas). For MySQL, anything after the first `@` (if present) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | map(object({…})) | | {} | +| [users](variables.tf#L317) | Map of users to create in the primary instance (and replicated to other replicas). For MySQL, anything after the first `@` (if present) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | map(object({…})) | | {} | ## Outputs diff --git a/modules/compute-mig/README.md b/modules/compute-mig/README.md index 68f86f3b9..682b3f0d6 100644 --- a/modules/compute-mig/README.md +++ b/modules/compute-mig/README.md @@ -471,23 +471,23 @@ module "nginx-mig" { | [location](variables.tf#L217) | Compute zone or region. | string | ✓ | | | [name](variables.tf#L222) | Managed group name. | string | ✓ | | | [project_id](variables.tf#L233) | Project id. | string | ✓ | | -| [all_instances_config](variables.tf#L17) | Metadata and labels set to all instances in the group. | object({…}) | | null | -| [auto_healing_policies](variables.tf#L26) | Auto-healing policies for this group. | object({…}) | | null | -| [autoscaler_config](variables.tf#L35) | Optional autoscaler configuration. | object({…}) | | null | +| [all_instances_config](variables.tf#L17) | Metadata and labels set to all instances in the group. | object({…}) | | null | +| [auto_healing_policies](variables.tf#L26) | Auto-healing policies for this group. | object({…}) | | null | +| [autoscaler_config](variables.tf#L35) | Optional autoscaler configuration. | object({…}) | | null | | [default_version_name](variables.tf#L83) | Name used for the default version. | string | | "default" | | [description](variables.tf#L89) | Optional description used for all resources managed by this module. | string | | "Terraform managed." | -| [distribution_policy](variables.tf#L95) | Distribution policy for regional MIG. | object({…}) | | null | -| [health_check_config](variables.tf#L104) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | null | -| [instance_flexibility_policy_selections](variables.tf#L177) | Instance flexibility policy selections. Only applicable to regional instances. | map(object({…})) | | {} | -| [instance_lifecycle_policy](variables.tf#L191) | The instance lifecycle policy for the MIG. | object({…}) | | null | +| [distribution_policy](variables.tf#L95) | Distribution policy for regional MIG. | object({…}) | | null | +| [health_check_config](variables.tf#L104) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | null | +| [instance_flexibility_policy_selections](variables.tf#L177) | Instance flexibility policy selections. Only applicable to regional instances. | map(object({…})) | | {} | +| [instance_lifecycle_policy](variables.tf#L191) | The instance lifecycle policy for the MIG. | object({…}) | | null | | [named_ports](variables.tf#L227) | Named ports. | map(number) | | null | -| [stateful_config](variables.tf#L238) | Stateful configuration for individual instances. | map(object({…})) | | {} | +| [stateful_config](variables.tf#L238) | Stateful configuration for individual instances. | map(object({…})) | | {} | | [stateful_disks](variables.tf#L257) | Stateful disk configuration applied at the MIG level to all instances, in device name => on permanent instance delete rule as boolean. | map(bool) | | {} | | [target_pools](variables.tf#L264) | Optional list of URLs for target pools to which new instances in the group are added. | list(string) | | [] | | [target_size](variables.tf#L270) | Group target size, leave null when using an autoscaler. | number | | null | -| [update_policy](variables.tf#L276) | Update policy. Minimal action and type are required. | object({…}) | | null | -| [versions](variables.tf#L297) | Additional application versions, target_size is optional. | map(object({…})) | | {} | -| [wait_for_instances](variables.tf#L310) | Wait for all instances to be created/updated before returning. | object({…}) | | null | +| [update_policy](variables.tf#L276) | Update policy. Minimal action and type are required. | object({…}) | | null | +| [versions](variables.tf#L297) | Additional application versions, target_size is optional. | map(object({…})) | | {} | +| [wait_for_instances](variables.tf#L310) | Wait for all instances to be created/updated before returning. | object({…}) | | null | ## Outputs diff --git a/modules/compute-vm/README.md b/modules/compute-vm/README.md index 9b2e918e3..92a33a9ac 100644 --- a/modules/compute-vm/README.md +++ b/modules/compute-vm/README.md @@ -1191,27 +1191,27 @@ module "sole-tenancy" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L353) | Instance name. | string | ✓ | | -| [network_interfaces](variables.tf#L365) | Network interfaces configuration. Use self links for Shared VPC, set addresses to null if not needed. | list(object({…})) | ✓ | | +| [network_interfaces](variables.tf#L365) | Network interfaces configuration. Use self links for Shared VPC, set addresses to null if not needed. | list(object({…})) | ✓ | | | [project_id](variables.tf#L405) | Project id. | string | ✓ | | | [zone](variables.tf#L562) | Compute zone. | string | ✓ | | -| [attached_disks](variables.tf#L17) | Additional disks. Source type is one of 'image' (zonal disks in vms and template), 'snapshot' (vm), 'existing', and null. | map(object({…})) | | {} | -| [boot_disk](variables.tf#L56) | Boot disk properties. | object({…}) | | {} | +| [attached_disks](variables.tf#L17) | Additional disks. Source type is one of 'image' (zonal disks in vms and template), 'snapshot' (vm), 'existing', and null. | map(object({…})) | | {} | +| [boot_disk](variables.tf#L56) | Boot disk properties. | object({…}) | | {} | | [can_ip_forward](variables.tf#L113) | Enable IP forwarding. | bool | | false | | [confidential_compute](variables.tf#L119) | Confidential Compute configuration. Set to 'SEV' or 'SEV_SNP' to enable. | string | | null | -| [context](variables.tf#L129) | Context-specific interpolations. | object({…}) | | {} | -| [create_template](variables.tf#L146) | Create instance template instead of instances. Defaults to a global template. | object({…}) | | null | +| [context](variables.tf#L129) | Context-specific interpolations. | object({…}) | | {} | +| [create_template](variables.tf#L146) | Create instance template instead of instances. Defaults to a global template. | object({…}) | | null | | [description](variables.tf#L155) | Description of a Compute Instance. | string | | "Managed by the compute-vm Terraform module." | | [enable_display](variables.tf#L161) | Enable virtual display on the instances. | bool | | false | -| [encryption](variables.tf#L167) | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | object({…}) | | null | -| [gpu](variables.tf#L178) | GPU information. Based on https://cloud.google.com/compute/docs/gpus. | object({…}) | | null | -| [group](variables.tf#L213) | Instance group configuration. Set 'named_ports' to create a new unmanaged instance group, or provide an existing group self_link/id in 'membership' to join one. | object({…}) | | null | +| [encryption](variables.tf#L167) | Encryption options. Only one of kms_key_self_link and disk_encryption_key_raw may be set. If needed, you can specify to encrypt or not the boot disk. | object({…}) | | null | +| [gpu](variables.tf#L178) | GPU information. Based on https://cloud.google.com/compute/docs/gpus. | object({…}) | | null | +| [group](variables.tf#L213) | Instance group configuration. Set 'named_ports' to create a new unmanaged instance group, or provide an existing group self_link/id in 'membership' to join one. | object({…}) | | null | | [hostname](variables.tf#L222) | Instance FQDN name. | string | | null | | [iam](variables.tf#L228) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [instance_schedule](variables.tf#L234) | Assign or create and assign an instance schedule policy. Set active to null to detach a policy from vm before destroying. | object({…}) | | null | -| [kms_autokeys](variables.tf#L258) | KMS Autokey key handles. If location is not specified it will be inferred from the zone. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | map(object({…})) | | {} | +| [instance_schedule](variables.tf#L234) | Assign or create and assign an instance schedule policy. Set active to null to detach a policy from vm before destroying. | object({…}) | | null | +| [kms_autokeys](variables.tf#L258) | KMS Autokey key handles. If location is not specified it will be inferred from the zone. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | map(object({…})) | | {} | | [labels](variables.tf#L276) | Instance labels. | map(string) | | {} | -| [lifecycle_config](variables.tf#L282) | Instance lifecycle and operational configurations. | object({…}) | | {} | -| [machine_features_config](variables.tf#L304) | Machine-level configuration. | object({…}) | | {} | +| [lifecycle_config](variables.tf#L282) | Instance lifecycle and operational configurations. | object({…}) | | {} | +| [machine_features_config](variables.tf#L304) | Machine-level configuration. | object({…}) | | {} | | [machine_type](variables.tf#L328) | Machine type. | string | | "e2-micro" | | [metadata](variables.tf#L334) | Instance metadata. | map(string) | | {} | | [metadata_startup_script](variables.tf#L340) | Instance startup script. Will trigger recreation on change, even after importing. | string | | null | @@ -1221,11 +1221,11 @@ module "sole-tenancy" { | [network_tag_bindings](variables.tf#L398) | Resource manager tag bindings in arbitrary key => tag key or value id format. Set on both the instance only for networking purposes, and modifiable without impacting the main resource lifecycle. | map(string) | | {} | | [project_number](variables.tf#L410) | Project number. Used in tag bindings to avoid a permadiff. | string | | null | | [resource_policies](variables.tf#L416) | Resource policies to attach to the instance or template. | list(string) | | null | -| [scheduling_config](variables.tf#L423) | Scheduling configuration for the instance. | object({…}) | | {} | -| [scratch_disks](variables.tf#L458) | Scratch disks configuration. | object({…}) | | {…} | -| [service_account](variables.tf#L471) | Service account email and scopes. If email is null, the default Compute service account will be used unless auto_create is true, in which case a service account will be created. Set the variable to null to avoid attaching a service account. | object({…}) | | {} | -| [shielded_config](variables.tf#L482) | Shielded VM configuration of the instances. | object({…}) | | null | -| [snapshot_schedules](variables.tf#L492) | Snapshot schedule resource policies that can be attached to disks. | map(object({…})) | | {} | +| [scheduling_config](variables.tf#L423) | Scheduling configuration for the instance. | object({…}) | | {} | +| [scratch_disks](variables.tf#L458) | Scratch disks configuration. | object({…}) | | {…} | +| [service_account](variables.tf#L471) | Service account email and scopes. If email is null, the default Compute service account will be used unless auto_create is true, in which case a service account will be created. Set the variable to null to avoid attaching a service account. | object({…}) | | {} | +| [shielded_config](variables.tf#L482) | Shielded VM configuration of the instances. | object({…}) | | null | +| [snapshot_schedules](variables.tf#L492) | Snapshot schedule resource policies that can be attached to disks. | map(object({…})) | | {} | | [tag_bindings](variables.tf#L535) | Resource manager tag bindings in arbitrary key => tag key or value id format. Set on both the instance and zonal disks, and modifiable without impacting the main resource lifecycle. | map(string) | | {} | | [tag_bindings_immutable](variables.tf#L542) | Immutable resource manager tag bindings, in tagKeys/id => tagValues/id format. These are set on the instance or instance template at creation time, and trigger recreation if changed. | map(string) | | null | | [tags](variables.tf#L556) | Instance network tags for firewall rule targets. | list(string) | | [] | diff --git a/modules/data-catalog-policy-tag/README.md b/modules/data-catalog-policy-tag/README.md index 207ab0aef..717e95ab2 100644 --- a/modules/data-catalog-policy-tag/README.md +++ b/modules/data-catalog-policy-tag/README.md @@ -85,13 +85,13 @@ module "cmn-dc" { | [name](variables.tf#L58) | Name of this taxonomy. | string | ✓ | | | [project_id](variables.tf#L64) | GCP project id. | string | ✓ | | | [activated_policy_types](variables.tf#L17) | A list of policy types that are activated for this taxonomy. | list(string) | | ["FINE_GRAINED_ACCESS_CONTROL"] | -| [context](variables.tf#L32) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L32) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L45) | Description of this taxonomy. | string | | "Taxonomy - Terraform managed" | | [iam](variables-iam.tf#L23) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L29) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L44) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L29) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L44) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L17) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | -| [tags](variables.tf#L70) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(object({…})) | | {} | +| [tags](variables.tf#L70) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(object({…})) | | {} | ## Outputs diff --git a/modules/data-catalog-tag-template/README.md b/modules/data-catalog-tag-template/README.md index 86651830a..2f8be2738 100644 --- a/modules/data-catalog-tag-template/README.md +++ b/modules/data-catalog-tag-template/README.md @@ -132,9 +132,9 @@ fields: | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L29) | Id of the project where Tag Templates will be created. | string | ✓ | | -| [factories_config](variables.tf#L17) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [factories_config](variables.tf#L17) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | | [region](variables.tf#L34) | Default region for tag templates. | string | | null | -| [tag_templates](variables.tf#L40) | Tag templates definitions in the form {TAG_TEMPLATE_ID => TEMPLATE_DEFINITION}. | map(object({…})) | | {} | +| [tag_templates](variables.tf#L40) | Tag templates definitions in the form {TAG_TEMPLATE_ID => TEMPLATE_DEFINITION}. | map(object({…})) | | {} | ## Outputs diff --git a/modules/data-catalog-tag/README.md b/modules/data-catalog-tag/README.md index 8833404e4..a9703acd4 100644 --- a/modules/data-catalog-tag/README.md +++ b/modules/data-catalog-tag/README.md @@ -140,8 +140,8 @@ fields: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [factories_config](variables.tf#L17) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | -| [tags](variables.tf#L26) | Tags definitions in the form {TAG => TAG_DEFINITION}. | map(object({…})) | | {} | +| [factories_config](variables.tf#L17) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [tags](variables.tf#L26) | Tags definitions in the form {TAG => TAG_DEFINITION}. | map(object({…})) | | {} | ## Outputs diff --git a/modules/dataform-repository/README.md b/modules/dataform-repository/README.md index f6e271791..c9684ef62 100644 --- a/modules/dataform-repository/README.md +++ b/modules/dataform-repository/README.md @@ -67,8 +67,8 @@ module "dataform" { | [project_id](variables.tf#L59) | Id of the project where resources will be created. | string | ✓ | | | [region](variables.tf#L64) | The repository's region. | string | ✓ | | | [iam](variables.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. Mutually exclusive with the access_* variables used for basic roles. | map(list(string)) | | {} | -| [iam_bindings](variables.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables.tf#L39) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | -| [remote_repository_settings](variables.tf#L69) | Remote settings required to attach the repository to a remote repository. | object({…}) | | null | +| [iam_bindings](variables.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables.tf#L39) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [remote_repository_settings](variables.tf#L69) | Remote settings required to attach the repository to a remote repository. | object({…}) | | null | | [service_account](variables.tf#L81) | Service account used to execute the dataform workflow. | string | | "" | diff --git a/modules/dataplex-aspect-types/README.md b/modules/dataplex-aspect-types/README.md index 0dc341694..274470003 100644 --- a/modules/dataplex-aspect-types/README.md +++ b/modules/dataplex-aspect-types/README.md @@ -159,9 +159,9 @@ metadata_template: | | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L77) | Project id where resources will be created. | string | ✓ | | -| [aspect_types](variables.tf#L17) | Aspect templates. Merged with those defined via the factory. | map(object({…})) | | {} | -| [context](variables.tf#L48) | Context-specific interpolations. | object({…}) | | {} | -| [factories_config](variables.tf#L61) | Paths to folders for the optional factories. | object({…}) | | {} | +| [aspect_types](variables.tf#L17) | Aspect templates. Merged with those defined via the factory. | map(object({…})) | | {} | +| [context](variables.tf#L48) | Context-specific interpolations. | object({…}) | | {} | +| [factories_config](variables.tf#L61) | Paths to folders for the optional factories. | object({…}) | | {} | | [location](variables.tf#L70) | Location for aspect types. | string | | "global" | ## Outputs diff --git a/modules/dataplex-datascan/README.md b/modules/dataplex-datascan/README.md index e36ded9ac..20d640bee 100644 --- a/modules/dataplex-datascan/README.md +++ b/modules/dataplex-datascan/README.md @@ -461,18 +461,18 @@ module "dataplex-datascan" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [data](variables.tf#L17) | The data source for DataScan. The source can be either a Dataplex `entity` or a BigQuery `resource`. | object({…}) | ✓ | | +| [data](variables.tf#L17) | The data source for DataScan. The source can be either a Dataplex `entity` or a BigQuery `resource`. | object({…}) | ✓ | | | [name](variables.tf#L122) | Name of Dataplex Scan. | string | ✓ | | | [project_id](variables.tf#L133) | The ID of the project where the Dataplex DataScan will be created. | string | ✓ | | | [region](variables.tf#L138) | Region for the Dataplex DataScan. | string | ✓ | | -| [data_profile_spec](variables.tf#L29) | DataProfileScan related setting. Variable descriptions are provided in https://cloud.google.com/dataplex/docs/reference/rest/v1/DataProfileSpec. | object({…}) | | null | -| [data_quality_spec](variables.tf#L38) | DataQualityScan related setting. Variable descriptions are provided in https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpec. | object({…}) | | null | +| [data_profile_spec](variables.tf#L29) | DataProfileScan related setting. Variable descriptions are provided in https://cloud.google.com/dataplex/docs/reference/rest/v1/DataProfileSpec. | object({…}) | | null | +| [data_quality_spec](variables.tf#L38) | DataQualityScan related setting. Variable descriptions are provided in https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpec. | object({…}) | | null | | [description](variables.tf#L88) | Custom description for DataScan. | string | | null | | [execution_schedule](variables.tf#L94) | Schedule DataScan to run periodically based on a cron schedule expression. If not specified, the DataScan is created with `on_demand` schedule, which means it will not run until the user calls `dataScans.run` API. | string | | null | -| [factories_config](variables.tf#L100) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [factories_config](variables.tf#L100) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | | [iam](variables-iam.tf#L24) | Dataplex DataScan IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L17) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [incremental_field](variables.tf#L109) | The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time. If not specified, a data scan will run for all data in the table. | string | | null | | [labels](variables.tf#L115) | Resource labels. | map(string) | | {} | diff --git a/modules/dataplex/README.md b/modules/dataplex/README.md index d67bda400..8050f8ad1 100644 --- a/modules/dataplex/README.md +++ b/modules/dataplex/README.md @@ -116,7 +116,6 @@ module "dataplex" { - [ ] support multi-regions - ## Variables | name | description | type | required | default | @@ -124,7 +123,7 @@ module "dataplex" { | [name](variables.tf#L30) | Name of Dataplex Lake. | string | ✓ | | | [project_id](variables.tf#L41) | The ID of the project where this Dataplex Lake will be created. | string | ✓ | | | [region](variables.tf#L46) | Region of the Dataplax Lake. | string | ✓ | | -| [zones](variables.tf#L51) | Dataplex lake zones, such as `RAW` and `CURATED`. | map(object({…})) | ✓ | | +| [zones](variables.tf#L51) | Dataplex lake zones, such as `RAW` and `CURATED`. | map(object({…})) | ✓ | | | [iam](variables.tf#L17) | Dataplex lake IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [location_type](variables.tf#L24) | The location type of the Dataplax Lake. | string | | "SINGLE_REGION" | | [prefix](variables.tf#L35) | Optional prefix used to generate Dataplex Lake. | string | | null | @@ -137,5 +136,4 @@ module "dataplex" { | [id](outputs.tf#L22) | Fully qualified Dataplex Lake id. | | | [lake](outputs.tf#L27) | The lake name of Dataplex Lake. | | | [zones](outputs.tf#L32) | The zone name of Dataplex Lake. | | - diff --git a/modules/dataproc/README.md b/modules/dataproc/README.md index 17d124c05..2141ced6c 100644 --- a/modules/dataproc/README.md +++ b/modules/dataproc/README.md @@ -304,10 +304,10 @@ module "processing-dp-cluster" { | [name](variables.tf#L189) | Cluster name. | string | ✓ | | | [project_id](variables.tf#L194) | Project ID. | string | ✓ | | | [region](variables.tf#L199) | Dataproc region. | string | ✓ | | -| [dataproc_config](variables.tf#L17) | Dataproc cluster config. | object({…}) | | {} | +| [dataproc_config](variables.tf#L17) | Dataproc cluster config. | object({…}) | | {} | | [iam](variables-iam.tf#L24) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L17) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [labels](variables.tf#L183) | The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs. | map(string) | | {} | diff --git a/modules/dns-response-policy/README.md b/modules/dns-response-policy/README.md index 0cce4c060..05ccb497f 100644 --- a/modules/dns-response-policy/README.md +++ b/modules/dns-response-policy/README.md @@ -148,12 +148,12 @@ restricted: | [name](variables.tf#L49) | Policy name. | string | ✓ | | | [project_id](variables.tf#L68) | Project id for the zone. | string | ✓ | | | [clusters](variables.tf#L17) | Map of GKE clusters to which this policy is applied in name => id format. | map(string) | | {} | -| [context](variables.tf#L24) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L24) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L34) | Policy description. | string | | "Terraform managed." | -| [factories_config](variables.tf#L40) | Path to folder containing rules data files for the optional factory. | object({…}) | | {} | +| [factories_config](variables.tf#L40) | Path to folder containing rules data files for the optional factory. | object({…}) | | {} | | [networks](variables.tf#L54) | Map of VPC self links to which this policy is applied in name => self link format. | map(string) | | {} | | [policy_create](variables.tf#L61) | Set to false to use the existing policy matching name and only manage rules. | bool | | true | -| [rules](variables.tf#L73) | Map of policy rules in name => rule format. Local data takes precedence over behavior and is in the form record type => attributes. | map(object({…})) | | {} | +| [rules](variables.tf#L73) | Map of policy rules in name => rule format. Local data takes precedence over behavior and is in the form record type => attributes. | map(object({…})) | | {} | ## Outputs diff --git a/modules/dns/README.md b/modules/dns/README.md index c358709e0..65955171f 100644 --- a/modules/dns/README.md +++ b/modules/dns/README.md @@ -192,13 +192,13 @@ module "public-dns" { |---|---|:---:|:---:|:---:| | [name](variables.tf#L53) | Zone name, must be unique within the project. | string | ✓ | | | [project_id](variables.tf#L58) | Project id for the zone. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L29) | Domain description. | string | | "Terraform managed." | | [force_destroy](variables.tf#L35) | Set this to true to delete all records in the zone upon zone destruction. | bool | | null | | [iam](variables.tf#L41) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | null | | [labels](variables.tf#L47) | Labels to be assigned to the zone. | map(string) | | {} | -| [recordsets](variables.tf#L63) | Map of DNS recordsets in \"type name\" => {ttl, [records]} format. | map(object({…})) | | {} | -| [zone_config](variables.tf#L120) | DNS zone configuration. | object({…}) | | null | +| [recordsets](variables.tf#L63) | Map of DNS recordsets in \"type name\" => {ttl, [records]} format. | map(object({…})) | | {} | +| [zone_config](variables.tf#L120) | DNS zone configuration. | object({…}) | | null | ## Outputs diff --git a/modules/endpoints/README.md b/modules/endpoints/README.md index 2b687966e..25d94c477 100644 --- a/modules/endpoints/README.md +++ b/modules/endpoints/README.md @@ -33,14 +33,13 @@ host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog" [Here](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/endpoints/getting-started/openapi.yaml) you can find an example of an openapi.yaml file. Once created the endpoint, remember to activate the service at project level. - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [openapi_config](variables.tf#L32) | The configuration for an OpenAPI endopoint. Either this or grpc_config must be specified. | object({…}) | ✓ | | +| [openapi_config](variables.tf#L32) | The configuration for an OpenAPI endopoint. Either this or grpc_config must be specified. | object({…}) | ✓ | | | [service_name](variables.tf#L45) | The name of the service. Usually of the form '$apiname.endpoints.$projectid.cloud.goog'. | string | ✓ | | -| [grpc_config](variables.tf#L17) | The configuration for a gRPC endpoint. Either this or openapi_config must be specified. | object({…}) | | null | +| [grpc_config](variables.tf#L17) | The configuration for a gRPC endpoint. Either this or openapi_config must be specified. | object({…}) | | null | | [iam](variables.tf#L26) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [project_id](variables.tf#L39) | The project ID that the service belongs to. | string | | null | @@ -51,5 +50,4 @@ host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog" | [endpoints](outputs.tf#L17) | A list of Endpoint objects. | | | [endpoints_service](outputs.tf#L22) | The Endpoint service resource. | | | [service_name](outputs.tf#L27) | The name of the service.. | | - diff --git a/modules/firestore/README.md b/modules/firestore/README.md index 474bc3428..2db4eb652 100644 --- a/modules/firestore/README.md +++ b/modules/firestore/README.md @@ -151,13 +151,13 @@ module "firestore" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [database](variables.tf#L41) | Database attributes. | object({…}) | ✓ | | +| [database](variables.tf#L41) | Database attributes. | object({…}) | ✓ | | | [project_id](variables.tf#L228) | Project id. | string | ✓ | | -| [backup_schedule](variables.tf#L17) | Backup schedule. | object({…}) | | null | +| [backup_schedule](variables.tf#L17) | Backup schedule. | object({…}) | | null | | [database_create](variables.tf#L95) | Flag indicating whether the database should be created of not. | string | | "true" | -| [documents](variables.tf#L101) | Documents. | map(object({…})) | | {} | -| [fields](variables.tf#L112) | Fields. | map(object({…})) | | {} | -| [indexes](variables.tf#L164) | Indexes. | map(object({…})) | | {} | +| [documents](variables.tf#L101) | Documents. | map(object({…})) | | {} | +| [fields](variables.tf#L112) | Fields. | map(object({…})) | | {} | +| [indexes](variables.tf#L164) | Indexes. | map(object({…})) | | {} | ## Outputs diff --git a/modules/folder/README.md b/modules/folder/README.md index 75a9cb504..4c2dde157 100644 --- a/modules/folder/README.md +++ b/modules/folder/README.md @@ -733,33 +733,33 @@ module "folder" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | -| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | -| [assured_workload_config](variables.tf#L61) | Create AssuredWorkloads folder instead of regular folder when value is provided. Incompatible with folder_create=false. | object({…}) | | null | -| [autokey_config](variables.tf#L144) | Enable autokey support for this folder's children. Project accepts either project id or number. | object({…}) | | null | +| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | +| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | +| [assured_workload_config](variables.tf#L61) | Create AssuredWorkloads folder instead of regular folder when value is provided. Incompatible with folder_create=false. | object({…}) | | null | +| [autokey_config](variables.tf#L144) | Enable autokey support for this folder's children. Project accepts either project id or number. | object({…}) | | null | | [contacts](variables.tf#L153) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | -| [context](variables.tf#L172) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L172) | Context-specific interpolations. | object({…}) | | {} | | [deletion_protection](variables.tf#L193) | Deletion protection setting for this folder. | bool | | false | -| [factories_config](variables.tf#L199) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | -| [firewall_policy](variables.tf#L211) | Hierarchical firewall policy to associate to this folder. | object({…}) | | null | +| [factories_config](variables.tf#L199) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [firewall_policy](variables.tf#L211) | Hierarchical firewall policy to associate to this folder. | object({…}) | | null | | [folder_create](variables.tf#L222) | Create folder. When set to false, uses id to reference an existing folder. | bool | | true | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L61) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [iam_by_principals_additive](variables-iam.tf#L54) | Additive IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam_bindings_additive` variable. | map(list(string)) | | {} | -| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | +| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | | [id](variables.tf#L232) | Folder ID in case you use folder_create=false. | string | | null | -| [logging_data_access](variables-logging.tf#L17) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | +| [logging_data_access](variables-logging.tf#L17) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | | [logging_exclusions](variables-logging.tf#L28) | Logging exclusions for this folder in the form {NAME -> FILTER}. | map(string) | | {} | -| [logging_settings](variables-logging.tf#L35) | Default settings for logging resources. | object({…}) | | null | -| [logging_sinks](variables-logging.tf#L45) | Logging sinks to create for the folder. | map(object({…})) | | {} | +| [logging_settings](variables-logging.tf#L35) | Default settings for logging resources. | object({…}) | | null | +| [logging_sinks](variables-logging.tf#L45) | Logging sinks to create for the folder. | map(object({…})) | | {} | | [name](variables.tf#L238) | Folder name. | string | | null | -| [org_policies](variables.tf#L244) | Organization policies applied to this folder keyed by policy name. | map(object({…})) | | {} | -| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | +| [org_policies](variables.tf#L244) | Organization policies applied to this folder keyed by policy name. | map(object({…})) | | {} | +| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | | [parent](variables.tf#L272) | Parent in folders/folder_id or organizations/org_id format. | string | | null | -| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | -| [scc_sha_custom_modules](variables-scc.tf#L27) | SCC custom modules keyed by module name. | map(object({…})) | | {} | +| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | +| [scc_sha_custom_modules](variables-scc.tf#L27) | SCC custom modules keyed by module name. | map(object({…})) | | {} | | [tag_bindings](variables.tf#L286) | Tag bindings for this folder, in key => tag value id format. | map(string) | | null | ## Outputs diff --git a/modules/gcs/README.md b/modules/gcs/README.md index a2f865b73..7bb5a7824 100644 --- a/modules/gcs/README.md +++ b/modules/gcs/README.md @@ -420,8 +420,8 @@ module "bucket" { | [name](variables.tf#L224) | Bucket name suffix. | string | ✓ | | | [autoclass](variables.tf#L17) | Enable autoclass to automatically transition objects to appropriate storage classes based on their access pattern. If set to true, storage_class must be set to STANDARD. Defaults to false. | bool | | null | | [bucket_create](variables.tf#L23) | Create bucket. | bool | | true | -| [context](variables.tf#L30) | Context-specific interpolations. | object({…}) | | {} | -| [cors](variables.tf#L46) | CORS configuration for the bucket. Defaults to null. | object({…}) | | null | +| [context](variables.tf#L30) | Context-specific interpolations. | object({…}) | | {} | +| [cors](variables.tf#L46) | CORS configuration for the bucket. Defaults to null. | object({…}) | | null | | [custom_placement_config](variables.tf#L57) | The bucket's custom location configuration, which specifies the individual regions that comprise a dual-region bucket. If the bucket is designated as REGIONAL or MULTI_REGIONAL, the parameters are empty. | list(string) | | null | | [default_event_based_hold](variables.tf#L63) | Enable event based hold to new objects added to specific bucket, defaults to false. | bool | | null | | [enable_hierarchical_namespace](variables.tf#L69) | Enables hierarchical namespace. | bool | | null | @@ -429,30 +429,30 @@ module "bucket" { | [encryption_key](variables.tf#L81) | KMS key that will be used for encryption. | string | | null | | [force_destroy](variables.tf#L87) | Optional map to set force destroy keyed by name, defaults to false. | bool | | false | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L53) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | -| [ip_filter](variables.tf#L93) | The bucket's IP filter configuration. | object({…}) | | null | -| [kms_autokeys](variables.tf#L104) | KMS Autokey key handles. If location is not specified the bucket location will be used. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | map(object({…})) | | {} | +| [ip_filter](variables.tf#L93) | The bucket's IP filter configuration. | object({…}) | | null | +| [kms_autokeys](variables.tf#L104) | KMS Autokey key handles. If location is not specified the bucket location will be used. Key handle names will be added to the kms_keys context with an `autokeys/` prefix. | map(object({…})) | | {} | | [labels](variables.tf#L122) | Labels to be attached to all buckets. | map(string) | | {} | -| [lifecycle_rules](variables.tf#L128) | Bucket lifecycle rule. | map(object({…})) | | {} | +| [lifecycle_rules](variables.tf#L128) | Bucket lifecycle rule. | map(object({…})) | | {} | | [location](variables.tf#L177) | Bucket location. | string | | null | -| [logging_config](variables.tf#L187) | Bucket logging configuration. | object({…}) | | null | -| [managed_folders](variables.tf#L196) | Managed folders to create within the bucket in {PATH => CONFIG} format. | map(object({…})) | | {} | -| [notification_config](variables.tf#L229) | GCS Notification configuration. | object({…}) | | null | -| [objects_to_upload](variables.tf#L247) | Objects to be uploaded to bucket. | map(object({…})) | | {} | +| [logging_config](variables.tf#L187) | Bucket logging configuration. | object({…}) | | null | +| [managed_folders](variables.tf#L196) | Managed folders to create within the bucket in {PATH => CONFIG} format. | map(object({…})) | | {} | +| [notification_config](variables.tf#L229) | GCS Notification configuration. | object({…}) | | null | +| [objects_to_upload](variables.tf#L247) | Objects to be uploaded to bucket. | map(object({…})) | | {} | | [prefix](variables.tf#L273) | Optional prefix used to generate the bucket name. | string | | null | | [project_id](variables.tf#L283) | Bucket project id. Only required when creating buckets, or notification config topics. | string | | null | | [public_access_prevention](variables.tf#L302) | Prevents public access to the bucket. | string | | null | | [requester_pays](variables.tf#L312) | Enables Requester Pays on a storage bucket. | bool | | null | -| [retention_policy](variables.tf#L318) | Bucket retention policy. | object({…}) | | null | +| [retention_policy](variables.tf#L318) | Bucket retention policy. | object({…}) | | null | | [rpo](variables.tf#L327) | Bucket recovery point objective. | string | | null | | [soft_delete_retention](variables.tf#L337) | The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Set to 0 to override the default and disable. | number | | null | | [storage_class](variables.tf#L343) | Bucket storage class. | string | | "STANDARD" | | [tag_bindings](variables.tf#L353) | Tag bindings for this folder, in key => tag value id format. | map(string) | | {} | | [uniform_bucket_level_access](variables.tf#L360) | Allow using object ACLs (false) or not (true, this is the recommended behavior) , defaults to true (which is the recommended practice, but not the behavior of storage API). | bool | | true | | [versioning](variables.tf#L366) | Enable versioning, defaults to false. | bool | | null | -| [website](variables.tf#L372) | Bucket website. | object({…}) | | null | +| [website](variables.tf#L372) | Bucket website. | object({…}) | | null | ## Outputs diff --git a/modules/gcve-private-cloud/README.md b/modules/gcve-private-cloud/README.md index 0461dc852..1fd3aa7c2 100644 --- a/modules/gcve-private-cloud/README.md +++ b/modules/gcve-private-cloud/README.md @@ -142,9 +142,9 @@ module "gcve-pc" { |---|---|:---:|:---:|:---:| | [prefix](variables.tf#L17) | Prefix used in resource names. | string | ✓ | | | [project_id](variables.tf#L22) | Project id. | string | ✓ | | -| [vmw_network_config](variables.tf#L27) | VMware Engine network configuration. | object({…}) | | {} | -| [vmw_network_peerings](variables.tf#L44) | The network peerings towards users' VPCs or other VMware Engine networks. The key is the peering name suffix. | map(object({…})) | | {} | -| [vmw_private_cloud_configs](variables.tf#L60) | The VMware private cloud configurations. The key is the unique private cloud name suffix. | map(object({…})) | | {…} | +| [vmw_network_config](variables.tf#L27) | VMware Engine network configuration. | object({…}) | | {} | +| [vmw_network_peerings](variables.tf#L44) | The network peerings towards users' VPCs or other VMware Engine networks. The key is the peering name suffix. | map(object({…})) | | {} | +| [vmw_private_cloud_configs](variables.tf#L60) | The VMware private cloud configurations. The key is the unique private cloud name suffix. | map(object({…})) | | {…} | ## Outputs diff --git a/modules/gke-cluster-autopilot/README.md b/modules/gke-cluster-autopilot/README.md index 922c1d369..2f7c9b6a9 100644 --- a/modules/gke-cluster-autopilot/README.md +++ b/modules/gke-cluster-autopilot/README.md @@ -294,21 +294,21 @@ module "cluster-1" { | [location](variables.tf#L186) | Autopilot clusters are always regional. | string | ✓ | | | [name](variables.tf#L265) | Cluster name. | string | ✓ | | | [project_id](variables.tf#L298) | Cluster project ID. | string | ✓ | | -| [vpc_config](variables.tf#L314) | VPC-level configuration. | object({…}) | ✓ | | -| [access_config](variables.tf#L17) | Control plane endpoint and nodes access configurations. | object({…}) | | {} | -| [backup_configs](variables.tf#L49) | Configuration for Backup for GKE. | object({…}) | | {} | +| [vpc_config](variables.tf#L314) | VPC-level configuration. | object({…}) | ✓ | | +| [access_config](variables.tf#L17) | Control plane endpoint and nodes access configurations. | object({…}) | | {} | +| [backup_configs](variables.tf#L49) | Configuration for Backup for GKE. | object({…}) | | {} | | [deletion_protection](variables.tf#L71) | Whether or not to allow Terraform to destroy the cluster. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. | bool | | true | | [description](variables.tf#L78) | Cluster description. | string | | null | -| [enable_addons](variables.tf#L84) | Addons enabled in the cluster (true means enabled). | object({…}) | | {} | -| [enable_features](variables.tf#L98) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {} | +| [enable_addons](variables.tf#L84) | Addons enabled in the cluster (true means enabled). | object({…}) | | {} | +| [enable_features](variables.tf#L98) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {} | | [fleet_project](variables.tf#L168) | The name of the fleet host project where this cluster will be registered. | string | | null | | [issue_client_certificate](variables.tf#L174) | Enable issuing client certificate. | bool | | false | | [labels](variables.tf#L180) | Cluster resource labels. | map(string) | | null | -| [logging_config](variables.tf#L191) | Logging configuration. | object({…}) | | {} | -| [maintenance_config](variables.tf#L202) | Maintenance window configuration. | object({…}) | | {…} | +| [logging_config](variables.tf#L191) | Logging configuration. | object({…}) | | {} | +| [maintenance_config](variables.tf#L202) | Maintenance window configuration. | object({…}) | | {…} | | [min_master_version](variables.tf#L225) | Minimum version of the master, defaults to the version of the most recent official release. | string | | null | -| [monitoring_config](variables.tf#L231) | Monitoring configuration. System metrics collection cannot be disabled. Control plane metrics are optional. Kube state metrics are optional. Google Cloud Managed Service for Prometheus is enabled by default. | object({…}) | | {} | -| [node_config](variables.tf#L270) | Configuration for nodes and nodepools. | object({…}) | | {} | +| [monitoring_config](variables.tf#L231) | Monitoring configuration. System metrics collection cannot be disabled. Control plane metrics are optional. Kube state metrics are optional. Google Cloud Managed Service for Prometheus is enabled by default. | object({…}) | | {} | +| [node_config](variables.tf#L270) | Configuration for nodes and nodepools. | object({…}) | | {} | | [node_locations](variables.tf#L291) | Zones in which the cluster's nodes are located. | list(string) | | [] | | [release_channel](variables.tf#L303) | Release channel for GKE upgrades. Clusters created in the Autopilot mode must use a release channel. Choose between \"RAPID\", \"REGULAR\", and \"STABLE\". | string | | "REGULAR" | diff --git a/modules/gke-cluster-standard/README.md b/modules/gke-cluster-standard/README.md index 4bffeccd7..99e3a86f8 100644 --- a/modules/gke-cluster-standard/README.md +++ b/modules/gke-cluster-standard/README.md @@ -518,26 +518,26 @@ module "cluster-1" { | [location](variables.tf#L304) | Cluster zone or region. | string | ✓ | | | [name](variables.tf#L419) | Cluster name. | string | ✓ | | | [project_id](variables.tf#L471) | Cluster project id. | string | ✓ | | -| [vpc_config](variables.tf#L482) | VPC-level configuration. | object({…}) | ✓ | | -| [access_config](variables.tf#L17) | Control plane endpoint and nodes access configurations. | object({…}) | | {} | -| [backup_configs](variables.tf#L49) | Configuration for Backup for GKE. | object({…}) | | {} | -| [cluster_autoscaling](variables.tf#L72) | Enable and configure limits for Node Auto-Provisioning with Cluster Autoscaler. | object({…}) | | null | -| [default_nodepool](variables.tf#L152) | Enable default nodepool. | object({…}) | | {} | +| [vpc_config](variables.tf#L482) | VPC-level configuration. | object({…}) | ✓ | | +| [access_config](variables.tf#L17) | Control plane endpoint and nodes access configurations. | object({…}) | | {} | +| [backup_configs](variables.tf#L49) | Configuration for Backup for GKE. | object({…}) | | {} | +| [cluster_autoscaling](variables.tf#L72) | Enable and configure limits for Node Auto-Provisioning with Cluster Autoscaler. | object({…}) | | null | +| [default_nodepool](variables.tf#L152) | Enable default nodepool. | object({…}) | | {} | | [deletion_protection](variables.tf#L170) | Whether or not to allow Terraform to destroy the cluster. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. | bool | | true | | [description](variables.tf#L177) | Cluster description. | string | | null | -| [enable_addons](variables.tf#L183) | Addons enabled in the cluster (true means enabled). | object({…}) | | {} | -| [enable_features](variables.tf#L205) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {} | +| [enable_addons](variables.tf#L183) | Addons enabled in the cluster (true means enabled). | object({…}) | | {} | +| [enable_features](variables.tf#L205) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {} | | [fleet_project](variables.tf#L285) | The name of the fleet host project where this cluster will be registered. | string | | null | | [issue_client_certificate](variables.tf#L291) | Enable issuing client certificate. | bool | | false | | [labels](variables.tf#L297) | Cluster resource labels. | map(string) | | {} | -| [logging_config](variables.tf#L309) | Logging configuration. | object({…}) | | {} | -| [maintenance_config](variables.tf#L330) | Maintenance window configuration. | object({…}) | | {…} | +| [logging_config](variables.tf#L309) | Logging configuration. | object({…}) | | {} | +| [maintenance_config](variables.tf#L330) | Maintenance window configuration. | object({…}) | | {…} | | [max_pods_per_node](variables.tf#L353) | Maximum number of pods per node in this cluster. | number | | 110 | | [min_master_version](variables.tf#L359) | Minimum version of the master, defaults to the version of the most recent official release. | string | | null | -| [monitoring_config](variables.tf#L365) | Monitoring configuration. Google Cloud Managed Service for Prometheus is enabled by default. | object({…}) | | {} | -| [node_config](variables.tf#L424) | Node-level configuration. | object({…}) | | {} | +| [monitoring_config](variables.tf#L365) | Monitoring configuration. Google Cloud Managed Service for Prometheus is enabled by default. | object({…}) | | {} | +| [node_config](variables.tf#L424) | Node-level configuration. | object({…}) | | {} | | [node_locations](variables.tf#L447) | Zones in which the cluster's nodes are located. | list(string) | | [] | -| [node_pool_auto_config](variables.tf#L454) | Node pool configs that apply to auto-provisioned node pools in autopilot clusters and node auto-provisioning-enabled clusters. | object({…}) | | {} | +| [node_pool_auto_config](variables.tf#L454) | Node pool configs that apply to auto-provisioned node pools in autopilot clusters and node auto-provisioning-enabled clusters. | object({…}) | | {} | | [release_channel](variables.tf#L476) | Release channel for GKE upgrades. | string | | null | ## Outputs diff --git a/modules/gke-hub/README.md b/modules/gke-hub/README.md index f01783f0f..1156d0831 100644 --- a/modules/gke-hub/README.md +++ b/modules/gke-hub/README.md @@ -806,13 +806,13 @@ module "hub" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L207) | GKE hub project ID. | string | ✓ | | -| [clusters](variables.tf#L17) | A map of GKE clusters to register with GKE Hub and their associated feature configurations. The key is a logical name for the cluster, and the value is an object describing the cluster and its features. | map(object({…})) | | {} | -| [configmanagement_templates](variables.tf#L30) | Sets of config management configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | -| [features](variables.tf#L64) | Enable and configure fleet features. | object({…}) | | {} | -| [fleet_default_member_config](variables.tf#L79) | Fleet default member config. | object({…}) | | null | +| [clusters](variables.tf#L17) | A map of GKE clusters to register with GKE Hub and their associated feature configurations. The key is a logical name for the cluster, and the value is an object describing the cluster and its features. | map(object({…})) | | {} | +| [configmanagement_templates](variables.tf#L30) | Sets of config management configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | +| [features](variables.tf#L64) | Enable and configure fleet features. | object({…}) | | {} | +| [fleet_default_member_config](variables.tf#L79) | Fleet default member config. | object({…}) | | null | | [location](variables.tf#L151) | GKE hub location, will also be used for the membership location. | string | | null | -| [policycontroller_templates](variables.tf#L158) | Sets of Policy Controller configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | -| [servicemesh_templates](variables.tf#L212) | Sets of Service Mesh configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | +| [policycontroller_templates](variables.tf#L158) | Sets of Policy Controller configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | +| [servicemesh_templates](variables.tf#L212) | Sets of Service Mesh configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | ## Outputs diff --git a/modules/gke-nodepool/README.md b/modules/gke-nodepool/README.md index 632332e2a..b52b74733 100644 --- a/modules/gke-nodepool/README.md +++ b/modules/gke-nodepool/README.md @@ -211,7 +211,6 @@ module "cluster-1-nodepool-hyperdisk" { } # tftest modules=1 resources=1 inventory=hyperdisk.yaml ``` - ## Variables @@ -226,17 +225,17 @@ module "cluster-1-nodepool-hyperdisk" { | [labels](variables.tf#L41) | The resource labels to be applied each node (vm). | map(string) | | {} | | [max_pods_per_node](variables.tf#L53) | Maximum number of pods per node. | number | | null | | [name](variables.tf#L59) | Optional nodepool name. | string | | null | -| [network_config](variables.tf#L65) | Network configuration. | object({…}) | | null | -| [node_config](variables.tf#L89) | Node-level configuration. | object({…}) | | {} | -| [node_count](variables.tf#L169) | Number of nodes per instance group. Initial value can only be changed by recreation, current is ignored when autoscaling is used. | object({…}) | | {…} | +| [network_config](variables.tf#L65) | Network configuration. | object({…}) | | null | +| [node_config](variables.tf#L89) | Node-level configuration. | object({…}) | | {} | +| [node_count](variables.tf#L169) | Number of nodes per instance group. Initial value can only be changed by recreation, current is ignored when autoscaling is used. | object({…}) | | {…} | | [node_locations](variables.tf#L181) | Node locations. | list(string) | | null | -| [nodepool_config](variables.tf#L187) | Nodepool-level configuration. | object({…}) | | null | -| [reservation_affinity](variables.tf#L228) | Configuration of the desired reservation which instances could take capacity from. | object({…}) | | null | +| [nodepool_config](variables.tf#L187) | Nodepool-level configuration. | object({…}) | | null | +| [reservation_affinity](variables.tf#L228) | Configuration of the desired reservation which instances could take capacity from. | object({…}) | | null | | [resource_manager_tags](variables.tf#L238) | A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. | map(string) | | null | -| [service_account](variables.tf#L244) | Nodepool service account. If this variable is set to null, the default GCE service account will be used. If set and email is null, a service account will be created. If scopes are null a default will be used. | object({…}) | | {} | +| [service_account](variables.tf#L244) | Nodepool service account. If this variable is set to null, the default GCE service account will be used. If set and email is null, a service account will be created. If scopes are null a default will be used. | object({…}) | | {} | | [sole_tenant_nodegroup](variables.tf#L256) | Sole tenant node group. | string | | null | | [tags](variables.tf#L262) | Network tags applied to nodes. | list(string) | | null | -| [taints](variables.tf#L268) | Kubernetes taints applied to all nodes. | map(object({…})) | | {} | +| [taints](variables.tf#L268) | Kubernetes taints applied to all nodes. | map(object({…})) | | {} | ## Outputs diff --git a/modules/iam-service-account/README.md b/modules/iam-service-account/README.md index 3befecf07..38e28713c 100644 --- a/modules/iam-service-account/README.md +++ b/modules/iam-service-account/README.md @@ -152,14 +152,14 @@ module "service-account-with-tags" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L58) | Name of the service account to create. | string | ✓ | | -| [context](variables.tf#L17) | External context used in replacements. | object({…}) | | {} | +| [context](variables.tf#L17) | External context used in replacements. | object({…}) | | {} | | [create_ignore_already_exists](variables.tf#L33) | If set to true, skip service account creation if a service account with the same email already exists. | bool | | null | | [description](variables.tf#L44) | Optional description. | string | | null | | [display_name](variables.tf#L51) | Display name of the service account to create. | string | | "Terraform-managed." | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [iam_billing_roles](variables-iam.tf#L24) | Billing account roles granted to this service account, by billing account id. Non-authoritative. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L31) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L46) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [iam_by_principals_additive](variables-iam.tf#L61) | Additive IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam_bindings_additive` variable. | map(list(string)) | | {} | | [iam_folder_roles](variables-iam.tf#L75) | Folder roles granted to this service account, by folder id. Non-authoritative. | map(list(string)) | | {} | @@ -170,7 +170,7 @@ module "service-account-with-tags" { | [prefix](variables.tf#L64) | Prefix applied to service account names. | string | | null | | [project_id](variables.tf#L75) | Project id where service account will be created. This can be left null when reusing service accounts. | string | | null | | [project_number](variables.tf#L89) | Project number of var.project_id. Set this to avoid permadiffs when creating tag bindings. This can be left null when reusing service accounts and tags are not used. | string | | null | -| [service_account_reuse](variables.tf#L96) | Reuse existing service account if not null. Data source can be forced disabled if tag bindings are not used, or unique id is set. | object({…}) | | null | +| [service_account_reuse](variables.tf#L96) | Reuse existing service account if not null. Data source can be forced disabled if tag bindings are not used, or unique id is set. | object({…}) | | null | | [tag_bindings](variables.tf#L112) | Tag bindings for this service accounts, in key => tag value id format. | map(string) | | {} | ## Outputs diff --git a/modules/kms/README.md b/modules/kms/README.md index f115e5570..b7bb14629 100644 --- a/modules/kms/README.md +++ b/modules/kms/README.md @@ -167,15 +167,15 @@ module "kms" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [keyring](variables.tf#L80) | Keyring attributes. | object({…}) | ✓ | | +| [keyring](variables.tf#L80) | Keyring attributes. | object({…}) | ✓ | | | [project_id](variables.tf#L149) | Project id where the keyring will be created. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [iam](variables.tf#L33) | Keyring IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables.tf#L40) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables.tf#L55) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | -| [import_job](variables.tf#L70) | Keyring import job attributes. | object({…}) | | null | +| [iam_bindings](variables.tf#L40) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables.tf#L55) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [import_job](variables.tf#L70) | Keyring import job attributes. | object({…}) | | null | | [keyring_create](variables.tf#L89) | Set to false to manage keys and IAM bindings in an existing keyring. | bool | | true | -| [keys](variables.tf#L95) | Key names and base attributes. Set attributes to null if not needed. | map(object({…})) | | {} | +| [keys](variables.tf#L95) | Key names and base attributes. Set attributes to null if not needed. | map(object({…})) | | {} | | [tag_bindings](variables.tf#L154) | Tag bindings for this keyring, in key => tag value id format. | map(string) | | {} | ## Outputs diff --git a/modules/logging-bucket/README.md b/modules/logging-bucket/README.md index abd1a4fd2..629170c25 100644 --- a/modules/logging-bucket/README.md +++ b/modules/logging-bucket/README.md @@ -120,16 +120,16 @@ module "bucket" { |---|---|:---:|:---:|:---:| | [name](variables.tf#L71) | Name of the logging bucket. | string | ✓ | | | [parent](variables.tf#L76) | ID of the parent resource containing the bucket in the format 'project_id' 'folders/folder_id', 'organizations/organization_id' or 'billing_account_id'. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L32) | Human-readable description for the logging bucket. | string | | null | | [kms_key_name](variables.tf#L38) | To enable CMEK for a project logging bucket, set this field to a valid name. The associated service account requires cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. | string | | null | | [location](variables.tf#L44) | Location of the bucket. | string | | "global" | | [locked](variables.tf#L50) | Whether the bucket is locked. Locked buckets may only be deleted if they are empty. This can only be set for project-level buckets. | bool | | null | -| [log_analytics](variables.tf#L60) | Enable and configure Analytics Log. | object({…}) | | {} | +| [log_analytics](variables.tf#L60) | Enable and configure Analytics Log. | object({…}) | | {} | | [parent_type](variables.tf#L84) | Parent object type for the bucket (project, folder, organization, billing_account). | string | | "project" | | [retention](variables.tf#L91) | Retention time in days for the logging bucket. | number | | 30 | | [tag_bindings](variables.tf#L97) | Tag bindings for this bucket, in key => tag value id format. | map(string) | | {} | -| [views](variables.tf#L104) | Log views for this bucket. | map(object({…})) | | {} | +| [views](variables.tf#L104) | Log views for this bucket. | map(object({…})) | | {} | ## Outputs diff --git a/modules/looker-core/README.md b/modules/looker-core/README.md index 4974e59f3..63cd7fd50 100644 --- a/modules/looker-core/README.md +++ b/modules/looker-core/README.md @@ -186,18 +186,18 @@ module "looker" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L113) | Name of the looker core instance. | string | ✓ | | -| [network_config](variables.tf#L118) | Network configuration for cluster and instance. Only one between psa_config, psc_config and public can be used. | object({…}) | ✓ | | -| [oauth_config](variables.tf#L147) | Looker Core Oauth config. | object({…}) | ✓ | | +| [network_config](variables.tf#L118) | Network configuration for cluster and instance. Only one between psa_config, psc_config and public can be used. | object({…}) | ✓ | | +| [oauth_config](variables.tf#L147) | Looker Core Oauth config. | object({…}) | ✓ | | | [project_id](variables.tf#L190) | The ID of the project where this instances will be created. | string | ✓ | | | [region](variables.tf#L195) | Region for the Looker core instance. | string | ✓ | | -| [admin_settings](variables.tf#L17) | Looker Core admins settings. | object({…}) | | null | -| [controlled_egress](variables.tf#L26) | Controlled egress configuration. | object({…}) | | null | +| [admin_settings](variables.tf#L17) | Looker Core admins settings. | object({…}) | | null | +| [controlled_egress](variables.tf#L26) | Controlled egress configuration. | object({…}) | | null | | [custom_domain](variables.tf#L36) | Looker core instance custom domain. | string | | null | -| [encryption_config](variables.tf#L42) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | object({…}) | | null | +| [encryption_config](variables.tf#L42) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | object({…}) | | null | | [fips_enabled](variables.tf#L51) | FIPS 140-2 Encryption enablement for Looker (Google Cloud Core). | bool | | null | | [gemini_enabled](variables.tf#L57) | Gemini enablement for Looker (Google Cloud Core). | bool | | null | -| [maintenance_config](variables.tf#L63) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | object({…}) | | {} | -| [periodic_export_config](variables.tf#L155) | Configuration for periodic export. | object({…}) | | null | +| [maintenance_config](variables.tf#L63) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | object({…}) | | {} | +| [periodic_export_config](variables.tf#L155) | Configuration for periodic export. | object({…}) | | null | | [platform_edition](variables.tf#L170) | Platform editions for a Looker instance. Each edition maps to a set of instance features, like its size. | string | | "LOOKER_CORE_TRIAL" | | [prefix](variables.tf#L180) | Optional prefix used to generate instance names. | string | | null | diff --git a/modules/managed-kafka/README.md b/modules/managed-kafka/README.md index e3cad47a0..d3990c40c 100644 --- a/modules/managed-kafka/README.md +++ b/modules/managed-kafka/README.md @@ -168,17 +168,17 @@ module "kafka-cluster-with-connect" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [capacity_config](variables.tf#L17) | Capacity configuration for the Kafka cluster. | object({…}) | ✓ | | +| [capacity_config](variables.tf#L17) | Capacity configuration for the Kafka cluster. | object({…}) | ✓ | | | [cluster_id](variables.tf#L25) | The ID of the Kafka cluster. | string | ✓ | | | [location](variables.tf#L79) | The GCP region for the Kafka cluster. | string | ✓ | | | [project_id](variables.tf#L84) | The ID of the project where the Kafka cluster will be created. | string | ✓ | | | [subnets](variables.tf#L95) | List of VPC subnets for the Kafka cluster network configuration. | list(string) | ✓ | | -| [connect_clusters](variables.tf#L30) | Map of Kafka Connect cluster configurations to create. | map(object({…})) | | {} | -| [connect_connectors](variables.tf#L46) | Map of Kafka Connect Connectors to create. | map(object({…})) | | {} | +| [connect_clusters](variables.tf#L30) | Map of Kafka Connect cluster configurations to create. | map(object({…})) | | {} | +| [connect_connectors](variables.tf#L46) | Map of Kafka Connect Connectors to create. | map(object({…})) | | {} | | [kms_key](variables.tf#L67) | Customer-managed encryption key (CMEK) used for the Kafka cluster. | string | | null | | [labels](variables.tf#L73) | Labels to apply to the Kafka cluster. | map(string) | | null | | [rebalance_mode](variables.tf#L89) | Rebalancing mode for the Kafka cluster. | string | | null | -| [topics](variables.tf#L100) | Map of Kafka topics to create within the cluster. | map(object({…})) | | {} | +| [topics](variables.tf#L100) | Map of Kafka topics to create within the cluster. | map(object({…})) | | {} | ## Outputs diff --git a/modules/ncc-spoke-ra/README.md b/modules/ncc-spoke-ra/README.md index f20585242..f0d0ade82 100644 --- a/modules/ncc-spoke-ra/README.md +++ b/modules/ncc-spoke-ra/README.md @@ -143,13 +143,13 @@ module "spoke-ra" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [hub](variables.tf#L23) | The NCC hub. You should either provide an existing hub id or a hub name if create is true. | object({…}) | ✓ | | +| [hub](variables.tf#L23) | The NCC hub. You should either provide an existing hub id or a hub name if create is true. | object({…}) | ✓ | | | [name](variables.tf#L37) | The name of the NCC spoke. | string | ✓ | | | [project_id](variables.tf#L42) | The ID of the project where the NCC hub & spokes will be created. | string | ✓ | | | [region](variables.tf#L47) | Region where the spoke is located. | string | ✓ | | -| [router_appliances](variables.tf#L52) | List of router appliances this spoke is associated with. | list(object({…})) | ✓ | | -| [router_config](variables.tf#L60) | Configuration of the Cloud Router. | object({…}) | ✓ | | -| [vpc_config](variables.tf#L76) | Network and subnetwork for the CR interfaces. | object({…}) | ✓ | | +| [router_appliances](variables.tf#L52) | List of router appliances this spoke is associated with. | list(object({…})) | ✓ | | +| [router_config](variables.tf#L60) | Configuration of the Cloud Router. | object({…}) | ✓ | | +| [vpc_config](variables.tf#L76) | Network and subnetwork for the CR interfaces. | object({…}) | ✓ | | | [data_transfer](variables.tf#L17) | Site-to-site data transfer feature, available only in some regions. | bool | | false | ## Outputs diff --git a/modules/net-address/README.md b/modules/net-address/README.md index 9bd21af4c..fcbbcb94b 100644 --- a/modules/net-address/README.md +++ b/modules/net-address/README.md @@ -231,13 +231,13 @@ module "addresses" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L97) | Project where the addresses will be created. | string | ✓ | | -| [external_addresses](variables.tf#L17) | Map of external addresses, keyed by name. | map(object({…})) | | {} | -| [global_addresses](variables.tf#L40) | List of global addresses to create. | map(object({…})) | | {} | -| [internal_addresses](variables.tf#L50) | Map of internal addresses to create, keyed by name. | map(object({…})) | | {} | -| [ipsec_interconnect_addresses](variables.tf#L65) | Map of internal addresses used for HPA VPN over Cloud Interconnect. | map(object({…})) | | {} | -| [network_attachments](variables.tf#L84) | PSC network attachments, names as keys. | map(object({…})) | | {} | -| [psa_addresses](variables.tf#L102) | Map of internal addresses used for Private Service Access. | map(object({…})) | | {} | -| [psc_addresses](variables.tf#L114) | Map of internal addresses used for Private Service Connect. | map(object({…})) | | {} | +| [external_addresses](variables.tf#L17) | Map of external addresses, keyed by name. | map(object({…})) | | {} | +| [global_addresses](variables.tf#L40) | List of global addresses to create. | map(object({…})) | | {} | +| [internal_addresses](variables.tf#L50) | Map of internal addresses to create, keyed by name. | map(object({…})) | | {} | +| [ipsec_interconnect_addresses](variables.tf#L65) | Map of internal addresses used for HPA VPN over Cloud Interconnect. | map(object({…})) | | {} | +| [network_attachments](variables.tf#L84) | PSC network attachments, names as keys. | map(object({…})) | | {} | +| [psa_addresses](variables.tf#L102) | Map of internal addresses used for Private Service Access. | map(object({…})) | | {} | +| [psc_addresses](variables.tf#L114) | Map of internal addresses used for Private Service Connect. | map(object({…})) | | {} | ## Outputs diff --git a/modules/net-cloudnat/README.md b/modules/net-cloudnat/README.md index dd1e88922..163d11022 100644 --- a/modules/net-cloudnat/README.md +++ b/modules/net-cloudnat/README.md @@ -193,17 +193,17 @@ module "nat" { | [project_id](variables.tf#L126) | Project where resources will be created. | string | ✓ | | | [region](variables.tf#L131) | Region where resources will be created. | string | ✓ | | | [addresses](variables.tf#L17) | Optional list of external address self links. | list(string) | | [] | -| [config_port_allocation](variables.tf#L24) | Configuration for how to assign ports to virtual machines. min_ports_per_vm and max_ports_per_vm have no effect unless enable_dynamic_port_allocation is set to 'true'. | object({…}) | | {} | -| [config_source_subnetworks](variables.tf#L40) | Subnetwork configuration. | object({…}) | | {} | -| [config_timeouts](variables.tf#L70) | Timeout configurations. | object({…}) | | {} | -| [context](variables.tf#L83) | Context-specific interpolations. | object({…}) | | {} | +| [config_port_allocation](variables.tf#L24) | Configuration for how to assign ports to virtual machines. min_ports_per_vm and max_ports_per_vm have no effect unless enable_dynamic_port_allocation is set to 'true'. | object({…}) | | {} | +| [config_source_subnetworks](variables.tf#L40) | Subnetwork configuration. | object({…}) | | {} | +| [config_timeouts](variables.tf#L70) | Timeout configurations. | object({…}) | | {} | +| [context](variables.tf#L83) | Context-specific interpolations. | object({…}) | | {} | | [endpoint_types](variables.tf#L96) | Specifies the endpoint Types supported by the NAT Gateway. Supported values include: ENDPOINT_TYPE_VM, ENDPOINT_TYPE_SWG, ENDPOINT_TYPE_MANAGED_PROXY_LB. | list(string) | | null | | [logging_filter](variables.tf#L115) | Enables logging if not null, value is one of 'ERRORS_ONLY', 'TRANSLATIONS_ONLY', 'ALL'. | string | | null | | [router_asn](variables.tf#L136) | Router ASN used for auto-created router. | number | | null | | [router_create](variables.tf#L142) | Create router. | bool | | true | | [router_name](variables.tf#L148) | Router name, leave blank if router will be created to use auto generated name. | string | | null | | [router_network](variables.tf#L154) | Name of the VPC used for auto-created router. | string | | null | -| [rules](variables.tf#L160) | List of rules associated with this NAT. | list(object({…})) | | [] | +| [rules](variables.tf#L160) | List of rules associated with this NAT. | list(object({…})) | | [] | | [type](variables.tf#L180) | Whether this Cloud NAT is used for public or private IP translation. One of 'PUBLIC' or 'PRIVATE'. | string | | "PUBLIC" | ## Outputs diff --git a/modules/net-firewall-policy/README.md b/modules/net-firewall-policy/README.md index 2cfae1032..b272165cc 100644 --- a/modules/net-firewall-policy/README.md +++ b/modules/net-firewall-policy/README.md @@ -512,13 +512,13 @@ The following variable is defined at the top level of the rule (not within the ` | [name](variables.tf#L197) | Policy name. | string | ✓ | | | [parent_id](variables.tf#L203) | Parent node where the policy will be created, `folders/nnn` or `organizations/nnn` for hierarchical policy, project id for a network policy. | string | ✓ | | | [attachments](variables.tf#L17) | Ids of the resources to which this policy will be attached, in descriptive name => self link format. Specify folders or organization for hierarchical policy, VPCs for network policy. | map(string) | | {} | -| [context](variables.tf#L24) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L24) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L40) | Policy description. | string | | null | -| [egress_mirroring_rules](variables.tf#L46) | List of egress packet mirroring rule definitions, action can be 'mirror', 'do_not_mirror', or 'goto_next'. | map(object({…})) | | {} | -| [egress_rules](variables.tf#L77) | List of egress rule definitions, action can be 'allow', 'deny', 'goto_next' or 'apply_security_profile_group'. The match.layer4configs map is in protocol => optional [ports] format. | map(object({…})) | | {} | -| [factories_config](variables.tf#L115) | Paths to folders for the optional factories. | object({…}) | | {} | -| [ingress_mirroring_rules](variables.tf#L128) | List of ingress packet mirroring rule definitions, action can be 'mirror', 'do_not_mirror', or 'goto_next'. | map(object({…})) | | {} | -| [ingress_rules](variables.tf#L159) | List of ingress rule definitions, action can be 'allow', 'deny', 'goto_next' or 'apply_security_profile_group'. | map(object({…})) | | {} | +| [egress_mirroring_rules](variables.tf#L46) | List of egress packet mirroring rule definitions, action can be 'mirror', 'do_not_mirror', or 'goto_next'. | map(object({…})) | | {} | +| [egress_rules](variables.tf#L77) | List of egress rule definitions, action can be 'allow', 'deny', 'goto_next' or 'apply_security_profile_group'. The match.layer4configs map is in protocol => optional [ports] format. | map(object({…})) | | {} | +| [factories_config](variables.tf#L115) | Paths to folders for the optional factories. | object({…}) | | {} | +| [ingress_mirroring_rules](variables.tf#L128) | List of ingress packet mirroring rule definitions, action can be 'mirror', 'do_not_mirror', or 'goto_next'. | map(object({…})) | | {} | +| [ingress_rules](variables.tf#L159) | List of ingress rule definitions, action can be 'allow', 'deny', 'goto_next' or 'apply_security_profile_group'. | map(object({…})) | | {} | | [region](variables.tf#L209) | Policy region. Leave null for hierarchical policy, set to 'global' for a global network policy. | string | | null | | [security_profile_group_ids](variables.tf#L215) | The optional security groups ids to be referenced in factories. | map(string) | | {} | diff --git a/modules/net-ipsec-over-interconnect/README.md b/modules/net-ipsec-over-interconnect/README.md index f48107eb9..9ac7fd754 100644 --- a/modules/net-ipsec-over-interconnect/README.md +++ b/modules/net-ipsec-over-interconnect/README.md @@ -110,14 +110,14 @@ module "vpngw-a" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [interconnect_attachments](variables.tf#L17) | VLAN attachments used by the VPN Gateway. | object({…}) | ✓ | | +| [interconnect_attachments](variables.tf#L17) | VLAN attachments used by the VPN Gateway. | object({…}) | ✓ | | | [name](variables.tf#L25) | Common name to identify the VPN Gateway. | string | ✓ | | | [network](variables.tf#L30) | The VPC name to which resources are associated to. | string | ✓ | | -| [peer_gateway_config](variables.tf#L35) | IP addresses for the external peer gateway. | object({…}) | ✓ | | +| [peer_gateway_config](variables.tf#L35) | IP addresses for the external peer gateway. | object({…}) | ✓ | | | [project_id](variables.tf#L54) | The project id. | string | ✓ | | | [region](variables.tf#L59) | GCP Region. | string | ✓ | | -| [router_config](variables.tf#L64) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | -| [tunnels](variables.tf#L79) | VPN tunnel configurations. | map(object({…})) | | {} | +| [router_config](variables.tf#L64) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | +| [tunnels](variables.tf#L79) | VPN tunnel configurations. | map(object({…})) | | {} | ## Outputs diff --git a/modules/net-lb-app-ext-regional/README.md b/modules/net-lb-app-ext-regional/README.md index 9f2a6b9d1..d240e5c75 100644 --- a/modules/net-lb-app-ext-regional/README.md +++ b/modules/net-lb-app-ext-regional/README.md @@ -837,19 +837,19 @@ For deploying changes to load balancer configuration please refer to [net-lb-app | [region](variables.tf#L217) | Region where the load balancer is created. | string | ✓ | | | [vpc](variables.tf#L237) | VPC-level configuration. | string | ✓ | | | [address](variables.tf#L17) | Optional IP address used for the forwarding rule. | string | | null | -| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | +| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | | [description](variables.tf#L23) | Optional description used for resources. | string | | "Terraform managed." | -| [group_configs](variables.tf#L29) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | -| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | -| [http_proxy_config](variables.tf#L43) | HTTP proxy configuration. | object({…}) | | {} | -| [https_proxy_config](variables.tf#L53) | HTTPS proxy connfiguration. | object({…}) | | {} | +| [group_configs](variables.tf#L29) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | +| [http_proxy_config](variables.tf#L43) | HTTP proxy configuration. | object({…}) | | {} | +| [https_proxy_config](variables.tf#L53) | HTTPS proxy connfiguration. | object({…}) | | {} | | [labels](variables.tf#L67) | Labels set on resources. | map(string) | | {} | -| [neg_configs](variables.tf#L78) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [neg_configs](variables.tf#L78) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [network_tier_standard](variables.tf#L182) | Use standard network tier. | bool | | true | | [ports](variables.tf#L189) | Optional ports for HTTP load balancer. | list(string) | | null | | [protocol](variables.tf#L204) | Protocol supported by this load balancer. | string | | "HTTP" | -| [ssl_certificates](variables.tf#L222) | SSL target proxy certificates (only if protocol is HTTPS) for existing, custom, and managed certificates. | object({…}) | | {} | -| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | +| [ssl_certificates](variables.tf#L222) | SSL target proxy certificates (only if protocol is HTTPS) for existing, custom, and managed certificates. | object({…}) | | {} | +| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | ## Outputs diff --git a/modules/net-lb-app-ext/README.md b/modules/net-lb-app-ext/README.md index ba28d6096..a1e312244 100644 --- a/modules/net-lb-app-ext/README.md +++ b/modules/net-lb-app-ext/README.md @@ -1090,19 +1090,19 @@ After provisioning this change, and verifying that the new certificate is provis |---|---|:---:|:---:|:---:| | [name](variables.tf#L126) | Load balancer name. | string | ✓ | | | [project_id](variables.tf#L241) | Project id. | string | ✓ | | -| [backend_buckets_config](variables.tf#L17) | Backend buckets configuration. | map(object({…})) | | {} | -| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | +| [backend_buckets_config](variables.tf#L17) | Backend buckets configuration. | map(object({…})) | | {} | +| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | | [description](variables.tf#L52) | Optional description used for resources. | string | | "Terraform managed." | -| [forwarding_rules_config](variables.tf#L58) | The optional forwarding rules configuration. | map(object({…})) | | {…} | -| [group_configs](variables.tf#L79) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | -| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | -| [http_proxy_config](variables.tf#L93) | HTTP proxy configuration. Only used for non-classic load balancers. | object({…}) | | {} | -| [https_proxy_config](variables.tf#L104) | HTTPS proxy connfiguration. | object({…}) | | {} | +| [forwarding_rules_config](variables.tf#L58) | The optional forwarding rules configuration. | map(object({…})) | | {…} | +| [group_configs](variables.tf#L79) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | +| [http_proxy_config](variables.tf#L93) | HTTP proxy configuration. Only used for non-classic load balancers. | object({…}) | | {} | +| [https_proxy_config](variables.tf#L104) | HTTPS proxy connfiguration. | object({…}) | | {} | | [labels](variables.tf#L120) | Labels set on resources. | map(string) | | {} | -| [neg_configs](variables.tf#L131) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [neg_configs](variables.tf#L131) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [protocol](variables.tf#L246) | Protocol supported by this load balancer. | string | | "HTTP" | -| [ssl_certificates](variables.tf#L259) | SSL target proxy certificates (only if protocol is HTTPS) for existing, custom, and managed certificates. | object({…}) | | {} | -| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | +| [ssl_certificates](variables.tf#L259) | SSL target proxy certificates (only if protocol is HTTPS) for existing, custom, and managed certificates. | object({…}) | | {} | +| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | | [use_classic_version](variables.tf#L277) | Use classic Global Load Balancer. | bool | | true | ## Outputs diff --git a/modules/net-lb-app-ext/recipe-cloud-run-iap/README.md b/modules/net-lb-app-ext/recipe-cloud-run-iap/README.md index 13fc06d72..0098f1b9c 100644 --- a/modules/net-lb-app-ext/recipe-cloud-run-iap/README.md +++ b/modules/net-lb-app-ext/recipe-cloud-run-iap/README.md @@ -32,7 +32,7 @@ This recipe addresses common requirements of backends protected by IAP: | [project_id](variables.tf#L39) | Project ID. | string | ✓ | | | [region](variables.tf#L44) | Region. | string | ✓ | | | [support_email](variables.tf#L49) | Support email for IAP brand. | string | ✓ | | -| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | +| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | | [accessors](variables.tf#L27) | List of identities able to access the service via IAP (e.g. group:mygroup@myorg.com). | list(string) | | [] | | [impersonators](variables.tf#L33) | List of identities able to impersonate the service account for programmatica access. | list(string) | | [] | diff --git a/modules/net-lb-app-int-cross-region/README.md b/modules/net-lb-app-int-cross-region/README.md index e4fd58cdf..dabcc8374 100644 --- a/modules/net-lb-app-int-cross-region/README.md +++ b/modules/net-lb-app-int-cross-region/README.md @@ -821,21 +821,21 @@ When deploying changes to load balancer configuration please refer to [net-lb-ap |---|---|:---:|:---:|:---:| | [name](variables.tf#L74) | Load balancer name. | string | ✓ | | | [project_id](variables.tf#L155) | Project id. | string | ✓ | | -| [vpc_config](variables.tf#L197) | VPC-level configuration. | object({…}) | ✓ | | +| [vpc_config](variables.tf#L197) | VPC-level configuration. | object({…}) | ✓ | | | [addresses](variables.tf#L17) | Optional IP address used for the forwarding rule. | map(string) | | null | -| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | +| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | | [description](variables.tf#L23) | Optional description used for resources. | string | | "Terraform managed." | -| [group_configs](variables.tf#L29) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | -| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | -| [http_proxy_config](variables.tf#L43) | HTTP proxy configuration. | object({…}) | | {} | -| [https_proxy_config](variables.tf#L54) | HTTPS proxy configuration. | object({…}) | | {} | +| [group_configs](variables.tf#L29) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | +| [http_proxy_config](variables.tf#L43) | HTTP proxy configuration. | object({…}) | | {} | +| [https_proxy_config](variables.tf#L54) | HTTPS proxy configuration. | object({…}) | | {} | | [labels](variables.tf#L68) | Labels set on resources. | map(string) | | {} | -| [neg_configs](variables.tf#L79) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [neg_configs](variables.tf#L79) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [ports](variables.tf#L145) | Optional ports for HTTP load balancer. | list(string) | | null | | [protocol](variables.tf#L160) | Protocol supported by this load balancer. | string | | "HTTP" | -| [service_attachment](variables.tf#L173) | PSC service attachments. | object({…}) | | null | -| [service_directory_registration](variables.tf#L188) | Service directory namespace and service used to register this load balancer. | object({…}) | | null | -| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | +| [service_attachment](variables.tf#L173) | PSC service attachments. | object({…}) | | null | +| [service_directory_registration](variables.tf#L188) | Service directory namespace and service used to register this load balancer. | object({…}) | | null | +| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | ## Outputs diff --git a/modules/net-lb-app-int-cross-region/recipe-cross-reg-int-app-lb-vm-dns/README.md b/modules/net-lb-app-int-cross-region/recipe-cross-reg-int-app-lb-vm-dns/README.md index 075c91b30..05b5ee1d3 100644 --- a/modules/net-lb-app-int-cross-region/recipe-cross-reg-int-app-lb-vm-dns/README.md +++ b/modules/net-lb-app-int-cross-region/recipe-cross-reg-int-app-lb-vm-dns/README.md @@ -161,9 +161,9 @@ If the backends are unhealthy and the necessary firewall rules are in place, che | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L49) | Project used to create resources. | string | ✓ | | -| [vpc_config](variables.tf#L55) | VPC configuration for load balancer and instances. Subnets are keyed by region. | object({…}) | ✓ | | -| [dns_config](variables.tf#L17) | DNS configuration. | object({…}) | | {} | -| [instances_config](variables.tf#L28) | Configuration for instances. | object({…}) | | {} | +| [vpc_config](variables.tf#L55) | VPC configuration for load balancer and instances. Subnets are keyed by region. | object({…}) | ✓ | | +| [dns_config](variables.tf#L17) | DNS configuration. | object({…}) | | {} | +| [instances_config](variables.tf#L28) | Configuration for instances. | object({…}) | | {} | | [prefix](variables.tf#L42) | Prefix used for resource names. | string | | "lb-xr-00" | ## Outputs diff --git a/modules/net-lb-app-int/README.md b/modules/net-lb-app-int/README.md index ee9b391fe..11fad9443 100644 --- a/modules/net-lb-app-int/README.md +++ b/modules/net-lb-app-int/README.md @@ -934,25 +934,25 @@ For deploying changes to load balancer configuration please refer to [net-lb-app | [name](variables.tf#L91) | Load balancer name. | string | ✓ | | | [project_id](variables.tf#L193) | Project id. | string | ✓ | | | [region](variables.tf#L211) | The region where to allocate the ILB resources. | string | ✓ | | -| [vpc_config](variables.tf#L254) | VPC-level configuration. | object({…}) | ✓ | | +| [vpc_config](variables.tf#L254) | VPC-level configuration. | object({…}) | ✓ | | | [address](variables.tf#L17) | Optional IP address used for the forwarding rule. | string | | null | -| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | -| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | +| [backend_service_configs](variables-backend-service.tf#L19) | Backend service level configuration. | map(object({…})) | | {} | +| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L36) | Optional description used for resources. | string | | "Terraform managed." | | [global_access](variables.tf#L43) | Allow client access from all regions. | bool | | null | -| [group_configs](variables.tf#L49) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | -| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | -| [http_proxy_config](variables.tf#L63) | HTTP proxy configuration. Only used for non-classic load balancers. | object({…}) | | {} | -| [https_proxy_config](variables.tf#L73) | HTTPS proxy configuration. | object({…}) | | {} | +| [group_configs](variables.tf#L49) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [health_check_configs](variables-health-check.tf#L19) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | map(object({…})) | | {…} | +| [http_proxy_config](variables.tf#L63) | HTTP proxy configuration. Only used for non-classic load balancers. | object({…}) | | {} | +| [https_proxy_config](variables.tf#L73) | HTTPS proxy configuration. | object({…}) | | {} | | [labels](variables.tf#L85) | Labels set on resources. | map(string) | | {} | -| [neg_configs](variables.tf#L96) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [neg_configs](variables.tf#L96) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [network_tier_premium](variables.tf#L176) | Use premium network tier. Defaults to true. | bool | | true | | [ports](variables.tf#L183) | Optional ports for HTTP load balancer. | list(string) | | null | | [protocol](variables.tf#L198) | Protocol supported by this load balancer. | string | | "HTTP" | -| [service_attachment](variables.tf#L216) | PSC service attachment. | object({…}) | | null | -| [service_directory_registration](variables.tf#L231) | Service directory namespace and service used to register this load balancer. | object({…}) | | null | -| [ssl_certificates](variables.tf#L240) | SSL target proxy certificates (only if protocol is HTTPS). | object({…}) | | {} | -| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | +| [service_attachment](variables.tf#L216) | PSC service attachment. | object({…}) | | null | +| [service_directory_registration](variables.tf#L231) | Service directory namespace and service used to register this load balancer. | object({…}) | | null | +| [ssl_certificates](variables.tf#L240) | SSL target proxy certificates (only if protocol is HTTPS). | object({…}) | | {} | +| [urlmap_config](variables-urlmap.tf#L19) | The URL map configuration. | object({…}) | | {…} | ## Outputs diff --git a/modules/net-lb-ext/README.md b/modules/net-lb-ext/README.md index c8dcfccc5..30b4b61d7 100644 --- a/modules/net-lb-ext/README.md +++ b/modules/net-lb-ext/README.md @@ -208,12 +208,12 @@ For deploying changes to load balancer configuration please refer to [net-lb-app | [name](variables.tf#L198) | Name used for all resources. | string | ✓ | | | [project_id](variables.tf#L203) | Project id where resources will be created. | string | ✓ | | | [region](variables.tf#L208) | GCP region. | string | ✓ | | -| [backend_service_config](variables.tf#L17) | Backend service level configuration. | object({…}) | | {} | -| [backends](variables.tf#L68) | Load balancer backends. | list(object({…})) | | [] | -| [forwarding_rules_config](variables.tf#L79) | The optional forwarding rules configuration. | map(object({…})) | | {…} | -| [group_configs](variables.tf#L95) | Optional unmanaged groups to create. Can be referenced in backends via outputs. | map(object({…})) | | {} | +| [backend_service_config](variables.tf#L17) | Backend service level configuration. | object({…}) | | {} | +| [backends](variables.tf#L68) | Load balancer backends. | list(object({…})) | | [] | +| [forwarding_rules_config](variables.tf#L79) | The optional forwarding rules configuration. | map(object({…})) | | {…} | +| [group_configs](variables.tf#L95) | Optional unmanaged groups to create. Can be referenced in backends via outputs. | map(object({…})) | | {} | | [health_check](variables.tf#L108) | Name of existing health check to use, disables auto-created health check. | string | | null | -| [health_check_config](variables.tf#L114) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | +| [health_check_config](variables.tf#L114) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | | [labels](variables.tf#L192) | Labels set on resources. | map(string) | | {} | ## Outputs diff --git a/modules/net-lb-int/README.md b/modules/net-lb-int/README.md index c4345fd76..f571f5af0 100644 --- a/modules/net-lb-int/README.md +++ b/modules/net-lb-int/README.md @@ -405,17 +405,17 @@ One other issue is a `Provider produced inconsistent final plan` error which is | [name](variables.tf#L203) | Name used for all resources. | string | ✓ | | | [project_id](variables.tf#L208) | Project id where resources will be created. | string | ✓ | | | [region](variables.tf#L213) | GCP region. | string | ✓ | | -| [vpc_config](variables.tf#L239) | VPC-level configuration. | object({…}) | ✓ | | -| [backend_service_config](variables.tf#L17) | Backend service level configuration. | object({…}) | | {} | -| [backends](variables.tf#L53) | Load balancer backends. | list(object({…})) | | [] | -| [context](variables.tf#L64) | Context-specific interpolations. | object({…}) | | {} | +| [vpc_config](variables.tf#L239) | VPC-level configuration. | object({…}) | ✓ | | +| [backend_service_config](variables.tf#L17) | Backend service level configuration. | object({…}) | | {} | +| [backends](variables.tf#L53) | Load balancer backends. | list(object({…})) | | [] | +| [context](variables.tf#L64) | Context-specific interpolations. | object({…}) | | {} | | [description](variables.tf#L77) | Optional description used for resources. | string | | "Terraform managed." | -| [forwarding_rules_config](variables.tf#L83) | The optional forwarding rules configuration. | map(object({…})) | | {…} | -| [group_configs](variables.tf#L99) | Optional unmanaged groups to create. Can be referenced in backends via outputs. | map(object({…})) | | {} | +| [forwarding_rules_config](variables.tf#L83) | The optional forwarding rules configuration. | map(object({…})) | | {…} | +| [group_configs](variables.tf#L99) | Optional unmanaged groups to create. Can be referenced in backends via outputs. | map(object({…})) | | {} | | [health_check](variables.tf#L112) | Name of existing health check to use, disables auto-created health check. Also set `health_check_config = null` when cross-referencing an health check from another load balancer module to avoid a Terraform error. | string | | null | -| [health_check_config](variables.tf#L118) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | +| [health_check_config](variables.tf#L118) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | | [labels](variables.tf#L197) | Labels set on resources. | map(string) | | {} | -| [service_attachments](variables.tf#L218) | PSC service attachments, keyed by forwarding rule. | map(object({…})) | | null | +| [service_attachments](variables.tf#L218) | PSC service attachments, keyed by forwarding rule. | map(object({…})) | | null | | [service_label](variables.tf#L233) | Optional prefix of the fully qualified forwarding rule name. | string | | null | ## Outputs diff --git a/modules/net-lb-int/recipe-ilb-next-hop/README.md b/modules/net-lb-int/recipe-ilb-next-hop/README.md index ba853c272..54688d7f2 100644 --- a/modules/net-lb-int/recipe-ilb-next-hop/README.md +++ b/modules/net-lb-int/recipe-ilb-next-hop/README.md @@ -66,10 +66,10 @@ A sample testing session using `tmux`: |---|---|:---:|:---:|:---:| | [prefix](variables.tf#L48) | Prefix used for resource names. | string | ✓ | | | [project_id](variables.tf#L57) | Existing project id. | string | ✓ | | -| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | +| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | | [ilb_right_enable](variables.tf#L27) | Route right to left traffic through ILB. | bool | | false | | [ilb_session_affinity](variables.tf#L33) | Session affinity configuration for ILBs. | string | | "CLIENT_IP" | -| [ip_ranges](variables.tf#L39) | IP CIDR ranges used for VPC subnets. | map(string) | | {…} | +| [ip_ranges](variables.tf#L39) | IP CIDR ranges used for VPC subnets. | map(string) | | {…} | | [region](variables.tf#L62) | Region used for resources. | string | | "europe-west1" | | [zones](variables.tf#L68) | Zone suffixes used for instances. | list(string) | | ["b", "c"] | diff --git a/modules/net-lb-proxy-int/README.md b/modules/net-lb-proxy-int/README.md index 5ba2d513b..c6edab939 100644 --- a/modules/net-lb-proxy-int/README.md +++ b/modules/net-lb-proxy-int/README.md @@ -337,18 +337,18 @@ For deploying changes to load balancer configuration please refer to [net-lb-app | [name](variables.tf#L203) | Load balancer name. | string | ✓ | | | [project_id](variables.tf#L272) | Project id. | string | ✓ | | | [region](variables.tf#L277) | The region where to allocate the ILB resources. | string | ✓ | | -| [vpc_config](variables.tf#L297) | VPC-level configuration. | object({…}) | ✓ | | +| [vpc_config](variables.tf#L297) | VPC-level configuration. | object({…}) | ✓ | | | [address](variables.tf#L17) | Optional IP address used for the forwarding rule. | string | | null | -| [backend_service_config](variables.tf#L23) | Backend service level configuration. | object({…}) | | {} | +| [backend_service_config](variables.tf#L23) | Backend service level configuration. | object({…}) | | {} | | [description](variables.tf#L77) | Optional description used for resources. | string | | "Terraform managed." | | [global_access](variables.tf#L84) | Allow client access from all regions. | bool | | null | -| [group_configs](variables.tf#L90) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [group_configs](variables.tf#L90) | Optional unmanaged groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [health_check](variables.tf#L104) | Name of existing health check to use, disables auto-created health check. | string | | null | -| [health_check_config](variables.tf#L110) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | +| [health_check_config](variables.tf#L110) | Optional auto-created health check configurations, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | object({…}) | | {…} | | [labels](variables.tf#L197) | Labels set on resources. | map(string) | | {} | -| [neg_configs](variables.tf#L208) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | +| [neg_configs](variables.tf#L208) | Optional network endpoint groups to create. Can be referenced in backends via key or outputs. | map(object({…})) | | {} | | [port](variables.tf#L266) | Port. | number | | 80 | -| [service_attachment](variables.tf#L282) | PSC service attachment. | object({…}) | | null | +| [service_attachment](variables.tf#L282) | PSC service attachment. | object({…}) | | null | ## Outputs diff --git a/modules/net-swp/README.md b/modules/net-swp/README.md index 3a1aa06ef..75e74c606 100644 --- a/modules/net-swp/README.md +++ b/modules/net-swp/README.md @@ -419,7 +419,7 @@ matcher_args: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [gateway_config](variables.tf#L40) | Optional Secure Web Gateway configuration. | object({…}) | ✓ | | +| [gateway_config](variables.tf#L40) | Optional Secure Web Gateway configuration. | object({…}) | ✓ | | | [name](variables.tf#L53) | Name of the Secure Web Proxy resource. | string | ✓ | | | [network](variables.tf#L58) | Name of the network the Secure Web Proxy is deployed into. | string | ✓ | | | [project_id](variables.tf#L108) | Project id of the project that holds the network. | string | ✓ | | @@ -427,12 +427,12 @@ matcher_args: | [subnetwork](variables.tf#L133) | Name of the subnetwork the Secure Web Proxy is deployed into. | string | ✓ | | | [certificates](variables.tf#L17) | List of certificates to be used for Secure Web Proxy. | list(string) | | [] | | [description](variables.tf#L24) | Optional description for the created resources. | string | | "Managed by Terraform." | -| [factories_config](variables.tf#L30) | Path to folder with YAML resource description data files. | object({…}) | | {} | -| [policy_rules](variables.tf#L63) | Policy rules definitions. Merged with policy rules defined via the factory. | map(object({…})) | | {} | -| [policy_rules_contexts](variables.tf#L97) | Replacement contexts for policy rules matcher arguments. | object({…}) | | {} | -| [service_attachment](variables.tf#L118) | PSC service attachment configuration. | object({…}) | | null | -| [tls_inspection_config](variables.tf#L138) | TLS inspection configuration. | object({…}) | | {} | -| [url_lists](variables.tf#L159) | URL lists. | map(object({…})) | | {} | +| [factories_config](variables.tf#L30) | Path to folder with YAML resource description data files. | object({…}) | | {} | +| [policy_rules](variables.tf#L63) | Policy rules definitions. Merged with policy rules defined via the factory. | map(object({…})) | | {} | +| [policy_rules_contexts](variables.tf#L97) | Replacement contexts for policy rules matcher arguments. | object({…}) | | {} | +| [service_attachment](variables.tf#L118) | PSC service attachment configuration. | object({…}) | | null | +| [tls_inspection_config](variables.tf#L138) | TLS inspection configuration. | object({…}) | | {} | +| [url_lists](variables.tf#L159) | URL lists. | map(object({…})) | | {} | ## Outputs diff --git a/modules/net-vlan-attachment/README.md b/modules/net-vlan-attachment/README.md index 67cf4ae28..e3be8614c 100644 --- a/modules/net-vlan-attachment/README.md +++ b/modules/net-vlan-attachment/README.md @@ -661,14 +661,14 @@ module "example-va-b" { | [peer_asn](variables.tf#L118) | The on-premises underlay router ASN. | string | ✓ | | | [project_id](variables.tf#L123) | The project id where resources are created. | string | ✓ | | | [region](variables.tf#L128) | The region where resources are created. | string | ✓ | | -| [router_config](variables.tf#L133) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | +| [router_config](variables.tf#L133) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | | [admin_enabled](variables.tf#L17) | Whether the VLAN attachment is enabled. | bool | | true | -| [bgp_peer](variables.tf#L23) | BGP peer configuration for the VLAN attachment. | object({…}) | | null | -| [context](variables.tf#L48) | Context-specific interpolations. | object({…}) | | {} | -| [dedicated_interconnect_config](variables.tf#L60) | Dedicated interconnect configuration. | object({…}) | | null | +| [bgp_peer](variables.tf#L23) | BGP peer configuration for the VLAN attachment. | object({…}) | | null | +| [context](variables.tf#L48) | Context-specific interpolations. | object({…}) | | {} | +| [dedicated_interconnect_config](variables.tf#L60) | Dedicated interconnect configuration. | object({…}) | | null | | [ipsec_gateway_ip_ranges](variables.tf#L84) | IPSec Gateway IP Ranges. | map(string) | | {} | | [mtu](variables.tf#L90) | The MTU associated to the VLAN attachment (1440 / 1500). | number | | 1500 | -| [partner_interconnect_config](variables.tf#L106) | Partner interconnect configuration. | object({…}) | | null | +| [partner_interconnect_config](variables.tf#L106) | Partner interconnect configuration. | object({…}) | | null | | [vpn_gateways_ip_range](variables.tf#L152) | The IP range (cidr notation) to be used for the GCP VPN gateways. If null IPSec over Interconnect is not enabled. | string | | null | ## Outputs diff --git a/modules/net-vpc-factory/README.md b/modules/net-vpc-factory/README.md index ca6e2cd39..cfc3baab3 100644 --- a/modules/net-vpc-factory/README.md +++ b/modules/net-vpc-factory/README.md @@ -182,10 +182,10 @@ ingress: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | -| [data_defaults](variables.tf#L27) | Optional default values used when corresponding vpc data from files are missing. | object({…}) | | {} | -| [data_overrides](variables.tf#L62) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | -| [factories_config](variables.tf#L97) | Path to folder with YAML resource description data files. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [data_defaults](variables.tf#L27) | Optional default values used when corresponding vpc data from files are missing. | object({…}) | | {} | +| [data_overrides](variables.tf#L62) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | +| [factories_config](variables.tf#L97) | Path to folder with YAML resource description data files. | object({…}) | | {} | ## Outputs diff --git a/modules/net-vpc-firewall/README.md b/modules/net-vpc-firewall/README.md index 9928c906e..d1b06a68a 100644 --- a/modules/net-vpc-firewall/README.md +++ b/modules/net-vpc-firewall/README.md @@ -271,12 +271,12 @@ module "firewall" { |---|---|:---:|:---:|:---:| | [network](variables.tf#L124) | Name of the network this set of firewall rules applies to. | string | ✓ | | | [project_id](variables.tf#L129) | Project id of the project that holds the network. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | -| [default_rules_config](variables.tf#L30) | Optionally created convenience rules. Set the 'disabled' attribute to true, or individual rule attributes to empty lists to disable. | object({…}) | | {} | -| [egress_rules](variables.tf#L50) | List of egress rule definitions, default to deny action. Null destination ranges will be replaced with 0/0. | map(object({…})) | | {} | -| [factories_config](variables.tf#L73) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | -| [ingress_rules](variables.tf#L83) | List of ingress rule definitions, default to allow action. Null source ranges will be replaced with 0/0. | map(object({…})) | | {} | -| [named_ranges](variables.tf#L107) | Define mapping of names to ranges that can be used in custom rules. | map(list(string)) | | {…} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [default_rules_config](variables.tf#L30) | Optionally created convenience rules. Set the 'disabled' attribute to true, or individual rule attributes to empty lists to disable. | object({…}) | | {} | +| [egress_rules](variables.tf#L50) | List of egress rule definitions, default to deny action. Null destination ranges will be replaced with 0/0. | map(object({…})) | | {} | +| [factories_config](variables.tf#L73) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [ingress_rules](variables.tf#L83) | List of ingress rule definitions, default to allow action. Null source ranges will be replaced with 0/0. | map(object({…})) | | {} | +| [named_ranges](variables.tf#L107) | Define mapping of names to ranges that can be used in custom rules. | map(list(string)) | | {…} | ## Outputs diff --git a/modules/net-vpc-peering/README.md b/modules/net-vpc-peering/README.md index 869ad1563..00da8cdbd 100644 --- a/modules/net-vpc-peering/README.md +++ b/modules/net-vpc-peering/README.md @@ -79,10 +79,10 @@ module "peering" { |---|---|:---:|:---:|:---:| | [local_network](variables.tf#L17) | Resource link of the network to add a peering to. | string | ✓ | | | [peer_network](variables.tf#L38) | Resource link of the peer network. | string | ✓ | | -| [name](variables.tf#L22) | Optional names for the the peering resources. If not set, peering names will be generated based on the network names. | object({…}) | | {} | +| [name](variables.tf#L22) | Optional names for the the peering resources. If not set, peering names will be generated based on the network names. | object({…}) | | {} | | [peer_create_peering](variables.tf#L32) | Create the peering on the remote side. If false, only the peering from this network to the remote network is created. | bool | | true | | [prefix](variables.tf#L43) | Optional name prefix for the network peerings. | string | | null | -| [routes_config](variables.tf#L53) | Control import/export for local and remote peer. Remote configuration is only used when creating remote peering. | object({…}) | | {} | +| [routes_config](variables.tf#L53) | Control import/export for local and remote peer. Remote configuration is only used when creating remote peering. | object({…}) | | {} | | [stack_type](variables.tf#L73) | IP version(s) of traffic and routes that are allowed to be imported or exported between peer networks. Possible values: IPV4_ONLY, IPV4_IPV6. | string | | null | ## Outputs diff --git a/modules/net-vpc/README.md b/modules/net-vpc/README.md index ae38c8105..fb2964c2b 100644 --- a/modules/net-vpc/README.md +++ b/modules/net-vpc/README.md @@ -963,30 +963,30 @@ secondary_ip_ranges: | [name](variables.tf#L184) | The name of the network being created. | string | ✓ | | | [project_id](variables.tf#L261) | The ID of the project where this VPC will be created. | string | ✓ | | | [auto_create_subnetworks](variables.tf#L17) | Set to true to create an auto mode subnet, defaults to custom mode. | bool | | false | -| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | -| [create_googleapis_routes](variables.tf#L45) | Toggle creation of googleapis private/restricted routes. Disabled when vpc creation is turned off, or when set to null. | object({…}) | | {} | +| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | +| [create_googleapis_routes](variables.tf#L45) | Toggle creation of googleapis private/restricted routes. Disabled when vpc creation is turned off, or when set to null. | object({…}) | | {} | | [delete_default_routes_on_create](variables.tf#L58) | Set to true to delete the default routes at creation time. | bool | | false | | [description](variables.tf#L64) | An optional description of this resource (triggers recreation on change). | string | | "Terraform-managed." | -| [dns_policy](variables.tf#L70) | DNS policy setup for the VPC. | object({…}) | | null | -| [factories_config](variables.tf#L83) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [dns_policy](variables.tf#L70) | DNS policy setup for the VPC. | object({…}) | | null | +| [factories_config](variables.tf#L83) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | | [firewall_policy_enforcement_order](variables.tf#L92) | Order that Firewall Rules and Firewall Policies are evaluated. Can be either 'BEFORE_CLASSIC_FIREWALL' or 'AFTER_CLASSIC_FIREWALL'. | string | | "AFTER_CLASSIC_FIREWALL" | -| [internal_ranges](variables.tf#L104) | Internal range configuration for IPAM operations within the VPC network. | list(object({…})) | | [] | -| [ipv6_config](variables.tf#L168) | Optional IPv6 configuration for this network. | object({…}) | | {} | +| [internal_ranges](variables.tf#L104) | Internal range configuration for IPAM operations within the VPC network. | list(object({…})) | | [] | +| [ipv6_config](variables.tf#L168) | Optional IPv6 configuration for this network. | object({…}) | | {} | | [mtu](variables.tf#L178) | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 (the default) and the maximum value is 1500 bytes. | number | | null | -| [network_attachments](variables.tf#L189) | PSC network attachments, names as keys. | map(object({…})) | | {} | -| [peering_config](variables.tf#L202) | VPC peering configuration. | object({…}) | | null | -| [policy_based_routes](variables.tf#L213) | Policy based routes, keyed by name. | map(object({…})) | | {} | -| [psa_configs](variables.tf#L266) | The Private Service Access configuration. | list(object({…})) | | [] | -| [routes](variables.tf#L298) | Network routes, keyed by name. | map(object({…})) | | {} | +| [network_attachments](variables.tf#L189) | PSC network attachments, names as keys. | map(object({…})) | | {} | +| [peering_config](variables.tf#L202) | VPC peering configuration. | object({…}) | | null | +| [policy_based_routes](variables.tf#L213) | Policy based routes, keyed by name. | map(object({…})) | | {} | +| [psa_configs](variables.tf#L266) | The Private Service Access configuration. | list(object({…})) | | [] | +| [routes](variables.tf#L298) | Network routes, keyed by name. | map(object({…})) | | {} | | [routing_mode](variables.tf#L319) | The network routing mode (default 'GLOBAL'). | string | | "GLOBAL" | -| [service_connection_policies](variables.tf#L329) | Service connection policies, keyed by name. | map(object({…})) | | {} | +| [service_connection_policies](variables.tf#L329) | Service connection policies, keyed by name. | map(object({…})) | | {} | | [shared_vpc_host](variables.tf#L371) | Enable shared VPC for this project. | bool | | false | | [shared_vpc_service_projects](variables.tf#L377) | Shared VPC service projects to register with this host. | list(string) | | [] | -| [subnets](variables.tf#L383) | Subnet configuration. | list(object({…})) | | [] | -| [subnets_private_nat](variables.tf#L463) | List of private NAT subnets. | list(object({…})) | | [] | -| [subnets_proxy_only](variables.tf#L475) | 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. | list(object({…})) | | [] | -| [subnets_psc](variables.tf#L509) | List of subnets for Private Service Connect service producers. | list(object({…})) | | [] | -| [vpc_reuse](variables.tf#L549) | Reuse existing VPC if not null. If the network_id number is not passed in, a data source is used. | object({…}) | | null | +| [subnets](variables.tf#L383) | Subnet configuration. | list(object({…})) | | [] | +| [subnets_private_nat](variables.tf#L463) | List of private NAT subnets. | list(object({…})) | | [] | +| [subnets_proxy_only](variables.tf#L475) | 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. | list(object({…})) | | [] | +| [subnets_psc](variables.tf#L509) | List of subnets for Private Service Connect service producers. | list(object({…})) | | [] | +| [vpc_reuse](variables.tf#L549) | Reuse existing VPC if not null. If the network_id number is not passed in, a data source is used. | object({…}) | | null | ## Outputs diff --git a/modules/net-vpn-dynamic/README.md b/modules/net-vpn-dynamic/README.md index 89e64527a..fccccf59c 100644 --- a/modules/net-vpn-dynamic/README.md +++ b/modules/net-vpn-dynamic/README.md @@ -131,10 +131,10 @@ module "vpn-dynamic" { | [network](variables.tf#L34) | VPC used for the gateway and routes. | string | ✓ | | | [project_id](variables.tf#L39) | Project where resources will be created. | string | ✓ | | | [region](variables.tf#L44) | Region used for resources. | string | ✓ | | -| [router_config](variables.tf#L49) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | +| [router_config](variables.tf#L49) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | | [gateway_address](variables.tf#L17) | Optional address assigned to the VPN gateway. Ignored unless gateway_address_create is set to false. | string | | null | | [gateway_address_create](variables.tf#L23) | Create external address assigned to the VPN gateway. Needs to be explicitly set to false to use address in gateway_address variable. | bool | | true | -| [tunnels](variables.tf#L64) | VPN tunnel configurations. | map(object({…})) | | {} | +| [tunnels](variables.tf#L64) | VPN tunnel configurations. | map(object({…})) | | {} | ## Outputs diff --git a/modules/net-vpn-ha/README.md b/modules/net-vpn-ha/README.md index 93b253a23..d6fb4cdf4 100644 --- a/modules/net-vpn-ha/README.md +++ b/modules/net-vpn-ha/README.md @@ -318,12 +318,12 @@ You can optionally avoid to specify MD5 keys and the module will automatically g | [network](variables.tf#L36) | VPC used for the gateway and routes. | string | ✓ | | | [project_id](variables.tf#L62) | Project where resources will be created. | string | ✓ | | | [region](variables.tf#L67) | Region used for resources. | string | ✓ | | -| [router_config](variables.tf#L72) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | -| [peer_gateways](variables.tf#L41) | Configuration of the (external or GCP) peer gateway. | map(object({…})) | | {} | -| [tunnels](variables.tf#L88) | VPN tunnel configurations. | map(object({…})) | | {} | +| [router_config](variables.tf#L72) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…}) | ✓ | | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [peer_gateways](variables.tf#L41) | Configuration of the (external or GCP) peer gateway. | map(object({…})) | | {} | +| [tunnels](variables.tf#L88) | VPN tunnel configurations. | map(object({…})) | | {} | | [vpn_gateway](variables.tf#L142) | HA VPN Gateway Self Link for using an existing HA VPN Gateway. Ignored if `vpn_gateway_create` is set to `true`. | string | | null | -| [vpn_gateway_create](variables.tf#L148) | Create HA VPN Gateway. Set to null to avoid creation. | object({…}) | | {} | +| [vpn_gateway_create](variables.tf#L148) | Create HA VPN Gateway. Set to null to avoid creation. | object({…}) | | {} | ## Outputs diff --git a/modules/net-vpn-ha/recipe-vpn-aws-gcp/README.md b/modules/net-vpn-ha/recipe-vpn-aws-gcp/README.md index d2496c969..f2c4ec16d 100644 --- a/modules/net-vpn-ha/recipe-vpn-aws-gcp/README.md +++ b/modules/net-vpn-ha/recipe-vpn-aws-gcp/README.md @@ -17,7 +17,7 @@ The architecture deployed by this recipe is the one depicted below: | [gcp_region](variables.tf#L47) | GCP Region. | string | ✓ | | | [project_id](variables.tf#L52) | Project ID. | string | ✓ | | | [shared_secret](variables.tf#L63) | Shared secret. | string | ✓ | | -| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | +| [_testing](variables.tf#L17) | Populate this variable to avoid triggering the data source. | object({…}) | | null | | [propagate_routes](variables.tf#L57) | Flag indicating whether routed received by AWS's Virtual Private Gateway should be propagated to main route table. | bool | | false | ## Outputs diff --git a/modules/net-vpn-static/README.md b/modules/net-vpn-static/README.md index 961e1b379..7e241aaf6 100644 --- a/modules/net-vpn-static/README.md +++ b/modules/net-vpn-static/README.md @@ -99,7 +99,7 @@ module "vpn" { | [gateway_address_create](variables.tf#L23) | Create external address assigned to the VPN gateway. Needs to be explicitly set to false to use address in gateway_address variable. | bool | | true | | [remote_ranges](variables.tf#L49) | Remote IP CIDR ranges. | list(string) | | [] | | [route_priority](variables.tf#L56) | Route priority, defaults to 1000. | number | | 1000 | -| [tunnels](variables.tf#L62) | VPN tunnel configurations. | map(object({…})) | | {} | +| [tunnels](variables.tf#L62) | VPN tunnel configurations. | map(object({…})) | | {} | ## Outputs diff --git a/modules/organization/README.md b/modules/organization/README.md index 3f951d087..1e5b5e2f5 100644 --- a/modules/organization/README.md +++ b/modules/organization/README.md @@ -1007,33 +1007,33 @@ module "org" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [organization_id](variables.tf#L173) | Organization id in organizations/nnnnnn format. | string | ✓ | | -| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | -| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | +| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | +| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | | [contacts](variables.tf#L61) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | -| [context](variables.tf#L79) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L79) | Context-specific interpolations. | object({…}) | | {} | | [custom_roles](variables.tf#L100) | Map of role name => list of permissions to create in this project. | map(list(string)) | | {} | -| [factories_config](variables.tf#L107) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | -| [firewall_policy](variables.tf#L122) | Hierarchical firewall policies to associate to the organization. | object({…}) | | null | +| [factories_config](variables.tf#L107) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [firewall_policy](variables.tf#L122) | Hierarchical firewall policies to associate to the organization. | object({…}) | | null | | [iam](variables-iam.tf#L17) | Authoritative IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L61) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [iam_by_principals_additive](variables-iam.tf#L54) | Additive IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam_bindings_additive` variable. | map(list(string)) | | {} | -| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | -| [logging_data_access](variables-logging.tf#L17) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | +| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | +| [logging_data_access](variables-logging.tf#L17) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | | [logging_exclusions](variables-logging.tf#L28) | Logging exclusions for this organization in the form {NAME -> FILTER}. | map(string) | | {} | -| [logging_settings](variables-logging.tf#L35) | Default settings for logging resources. | object({…}) | | null | -| [logging_sinks](variables-logging.tf#L45) | Logging sinks to create for the organization. | map(object({…})) | | {} | -| [network_tags](variables-tags.tf#L17) | Network tags by key name. If `id` is provided, key creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | -| [org_policies](variables.tf#L131) | Organization policies applied to this organization keyed by policy name. | map(object({…})) | | {} | -| [org_policy_custom_constraints](variables.tf#L159) | Organization policy custom constraints keyed by constraint name. | map(object({…})) | | {} | -| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | -| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | -| [scc_sha_custom_modules](variables-scc.tf#L28) | SCC custom modules keyed by module name. | map(object({…})) | | {} | +| [logging_settings](variables-logging.tf#L35) | Default settings for logging resources. | object({…}) | | null | +| [logging_sinks](variables-logging.tf#L45) | Logging sinks to create for the organization. | map(object({…})) | | {} | +| [network_tags](variables-tags.tf#L17) | Network tags by key name. If `id` is provided, key creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | +| [org_policies](variables.tf#L131) | Organization policies applied to this organization keyed by policy name. | map(object({…})) | | {} | +| [org_policy_custom_constraints](variables.tf#L159) | Organization policy custom constraints keyed by constraint name. | map(object({…})) | | {} | +| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | +| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | +| [scc_sha_custom_modules](variables-scc.tf#L28) | SCC custom modules keyed by module name. | map(object({…})) | | {} | | [tag_bindings](variables-tags.tf#L89) | Tag bindings for this organization, in key => tag value id format. | map(string) | | {} | -| [tags](variables-tags.tf#L96) | Tags by key name. If `id` is provided, key or value creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | -| [tags_config](variables-tags.tf#L161) | Fine-grained control on tag resource and IAM creation. | object({…}) | | {} | -| [workforce_identity_config](variables-identity-providers.tf#L17) | Workforce Identity Federation pool and providers. | object({…}) | | null | +| [tags](variables-tags.tf#L96) | Tags by key name. If `id` is provided, key or value creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | +| [tags_config](variables-tags.tf#L161) | Fine-grained control on tag resource and IAM creation. | object({…}) | | {} | +| [workforce_identity_config](variables-identity-providers.tf#L17) | Workforce Identity Federation pool and providers. | object({…}) | | null | ## Outputs diff --git a/modules/project-factory/README.md b/modules/project-factory/README.md index 12eb9919f..94512fd73 100644 --- a/modules/project-factory/README.md +++ b/modules/project-factory/README.md @@ -878,14 +878,14 @@ compute.disableSerialPortAccess: | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [factories_config](variables.tf#L165) | Path to folder with YAML resource description data files. | object({…}) | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | -| [data_defaults](variables.tf#L42) | Optional default values used when corresponding project or folder data from files are missing. | object({…}) | | {} | -| [data_merges](variables.tf#L107) | Optional values that will be merged with corresponding data from files. Combines with `data_defaults`, file data, and `data_overrides`. | object({…}) | | {} | -| [data_overrides](variables.tf#L126) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | -| [folders](variables-folders.tf#L17) | Folders data merged with factory data. | map(object({…})) | | {} | -| [notification_channels](variables-billing.tf#L17) | Notification channels used by budget alerts. | map(object({…})) | | {} | -| [projects](variables-projects.tf#L17) | Projects data merged with factory data. | map(object({…})) | | {} | +| [factories_config](variables.tf#L165) | Path to folder with YAML resource description data files. | object({…}) | ✓ | | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [data_defaults](variables.tf#L42) | Optional default values used when corresponding project or folder data from files are missing. | object({…}) | | {} | +| [data_merges](variables.tf#L107) | Optional values that will be merged with corresponding data from files. Combines with `data_defaults`, file data, and `data_overrides`. | object({…}) | | {} | +| [data_overrides](variables.tf#L126) | Optional values that override corresponding data from files. Takes precedence over file data and `data_defaults`. | object({…}) | | {} | +| [folders](variables-folders.tf#L17) | Folders data merged with factory data. | map(object({…})) | | {} | +| [notification_channels](variables-billing.tf#L17) | Notification channels used by budget alerts. | map(object({…})) | | {} | +| [projects](variables-projects.tf#L17) | Projects data merged with factory data. | map(object({…})) | | {} | ## Outputs diff --git a/modules/project/README.md b/modules/project/README.md index b18e20d3a..aa6955046 100644 --- a/modules/project/README.md +++ b/modules/project/README.md @@ -2283,59 +2283,59 @@ module "project" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L248) | Project name and id suffix. | string | ✓ | | -| [alerts](variables-observability.tf#L17) | Monitoring alerts. | map(object({…})) | | {} | -| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | -| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | +| [alerts](variables-observability.tf#L17) | Monitoring alerts. | map(object({…})) | | {} | +| [asset_feeds](variables.tf#L18) | Cloud Asset Inventory feeds. | map(object({…})) | | {} | +| [asset_search](variables.tf#L51) | Cloud Asset Inventory search configurations. | map(object({…})) | | {} | | [auto_create_network](variables.tf#L61) | Whether to create the default network for the project. | bool | | false | -| [bigquery_reservations](variables.tf#L67) | BigQuery reservations and assignments. Assignment specified as {JOB_TYPE = ['projects/PROJECT_ID']}. | map(object({…})) | | {} | +| [bigquery_reservations](variables.tf#L67) | BigQuery reservations and assignments. Assignment specified as {JOB_TYPE = ['projects/PROJECT_ID']}. | map(object({…})) | | {} | | [billing_account](variables.tf#L104) | Billing account id. | string | | null | | [compute_metadata](variables.tf#L110) | Optional compute metadata key/values. Only usable if compute API has been enabled. | map(string) | | {} | | [contacts](variables.tf#L117) | List of essential contacts for this resource. Must be in the form EMAIL -> [NOTIFICATION_TYPES]. Valid notification types are ALL, SUSPENSION, SECURITY, TECHNICAL, BILLING, LEGAL, PRODUCT_UPDATES. | map(list(string)) | | {} | -| [context](variables.tf#L135) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L135) | Context-specific interpolations. | object({…}) | | {} | | [custom_roles](variables.tf#L158) | Map of role name => list of permissions to create in this project. | map(list(string)) | | {} | | [default_network_tier](variables.tf#L165) | Default compute network tier for the project. | string | | null | | [default_service_account](variables.tf#L171) | Project default service account setting: can be one of `delete`, `deprivilege`, `disable`, or `keep`. | string | | "keep" | | [deletion_policy](variables.tf#L184) | Deletion policy setting for this project. | string | | "DELETE" | | [descriptive_name](variables.tf#L195) | Descriptive project name. Set when name differs from project id. | string | | null | -| [factories_config](variables.tf#L201) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | +| [factories_config](variables.tf#L201) | Paths to data files and folders that enable factory functionality. | object({…}) | | {} | | [iam](variables-iam.tf#L17) | Authoritative IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L61) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [iam_by_principals_additive](variables-iam.tf#L54) | Additive IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid errors. Merged internally with the `iam_bindings_additive` variable. | map(list(string)) | | {} | -| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | -| [kms_autokeys](variables.tf#L217) | KMS Autokey key handles. | map(object({…})) | | {} | +| [iam_by_principals_conditional](variables-iam.tf#L68) | Authoritative IAM binding in {PRINCIPAL => {roles = [roles], condition = {cond}}} format. Principals need to be statically defined to avoid errors. Condition is required. | map(object({…})) | | {} | +| [kms_autokeys](variables.tf#L217) | KMS Autokey key handles. | map(object({…})) | | {} | | [labels](variables.tf#L235) | Resource labels. | map(string) | | {} | | [lien_reason](variables.tf#L242) | If non-empty, creates a project lien with this description. | string | | null | -| [log_scopes](variables-observability.tf#L117) | Log scopes under this project. | map(object({…})) | | {} | -| [logging_data_access](variables-observability.tf#L127) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | +| [log_scopes](variables-observability.tf#L117) | Log scopes under this project. | map(object({…})) | | {} | +| [logging_data_access](variables-observability.tf#L127) | Control activation of data access logs. The special 'allServices' key denotes configuration for all services. | map(object({…})) | | {} | | [logging_exclusions](variables-observability.tf#L138) | Logging exclusions for this project in the form {NAME -> FILTER}. | map(string) | | {} | -| [logging_metrics](variables-observability.tf#L145) | Log-based metrics. | map(object({…})) | | {} | -| [logging_sinks](variables-observability.tf#L185) | Logging sinks to create for this project. | map(object({…})) | | {} | +| [logging_metrics](variables-observability.tf#L145) | Log-based metrics. | map(object({…})) | | {} | +| [logging_sinks](variables-observability.tf#L185) | Logging sinks to create for this project. | map(object({…})) | | {} | | [metric_scopes](variables-observability.tf#L216) | List of projects that will act as metric scopes for this project. | list(string) | | [] | -| [network_tags](variables-tags.tf#L17) | Network tags by key name. If `id` is provided, key creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | -| [notification_channels](variables-observability.tf#L223) | Monitoring notification channels. | map(object({…})) | | {} | -| [org_policies](variables.tf#L253) | Organization policies applied to this project keyed by policy name. | map(object({…})) | | {} | -| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | +| [network_tags](variables-tags.tf#L17) | Network tags by key name. If `id` is provided, key creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | +| [notification_channels](variables-observability.tf#L223) | Monitoring notification channels. | map(object({…})) | | {} | +| [org_policies](variables.tf#L253) | Organization policies applied to this project keyed by policy name. | map(object({…})) | | {} | +| [pam_entitlements](variables-pam.tf#L17) | Privileged Access Manager entitlements for this resource, keyed by entitlement ID. | map(object({…})) | | {} | | [parent](variables.tf#L281) | Parent folder or organization in 'folders/folder_id' or 'organizations/org_id' format. | string | | null | | [prefix](variables.tf#L295) | Optional prefix used to generate project id and name. | string | | null | -| [project_reuse](variables.tf#L305) | Reuse existing project if not null. If name and number are not passed in, a data source is used. | object({…}) | | null | -| [quotas](variables-quotas.tf#L17) | Service quota configuration. | map(object({…})) | | {} | -| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | -| [scc_sha_custom_modules](variables-scc.tf#L28) | SCC custom modules keyed by module name. | map(object({…})) | | {} | -| [service_agents_config](variables.tf#L325) | Automatic service agent configuration options. | object({…}) | | {} | -| [service_config](variables.tf#L336) | Configure service API activation. | object({…}) | | {…} | +| [project_reuse](variables.tf#L305) | Reuse existing project if not null. If name and number are not passed in, a data source is used. | object({…}) | | null | +| [quotas](variables-quotas.tf#L17) | Service quota configuration. | map(object({…})) | | {} | +| [scc_mute_configs](variables-scc.tf#L17) | SCC mute configurations keyed by name. | map(object({…})) | | {} | +| [scc_sha_custom_modules](variables-scc.tf#L28) | SCC custom modules keyed by module name. | map(object({…})) | | {} | +| [service_agents_config](variables.tf#L325) | Automatic service agent configuration options. | object({…}) | | {} | +| [service_config](variables.tf#L336) | Configure service API activation. | object({…}) | | {…} | | [service_encryption_key_ids](variables.tf#L348) | Service Agents to be granted encryption/decryption permissions over Cloud KMS encryption keys. Format {SERVICE_AGENT => [KEY_ID]}. | map(list(string)) | | {} | | [services](variables.tf#L355) | Service APIs to enable. | list(string) | | [] | -| [shared_vpc_host_config](variables.tf#L361) | Configures this project as a Shared VPC host project (mutually exclusive with shared_vpc_service_project). | object({…}) | | null | -| [shared_vpc_service_config](variables.tf#L371) | Configures this project as a Shared VPC service project (mutually exclusive with shared_vpc_host_config). | object({…}) | | {…} | +| [shared_vpc_host_config](variables.tf#L361) | Configures this project as a Shared VPC host project (mutually exclusive with shared_vpc_service_project). | object({…}) | | null | +| [shared_vpc_service_config](variables.tf#L371) | Configures this project as a Shared VPC service project (mutually exclusive with shared_vpc_host_config). | object({…}) | | {…} | | [skip_delete](variables.tf#L408) | Deprecated. Use deletion_policy. | bool | | null | | [tag_bindings](variables-tags.tf#L89) | Tag bindings for this project, in key => tag value id format. | map(string) | | null | -| [tags](variables-tags.tf#L96) | Tags by key name. If `id` is provided, key or value creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | -| [tags_config](variables-tags.tf#L161) | Fine-grained control on tag resource and IAM creation. | object({…}) | | {} | -| [universe](variables.tf#L420) | GCP universe where to deploy the project. The prefix will be prepended to the project id. | object({…}) | | null | -| [vpc_sc](variables.tf#L431) | VPC-SC configuration for the project, use when `ignore_changes` for resources is set in the VPC-SC module. | object({…}) | | null | -| [workload_identity_pools](variables-identity-providers.tf#L17) | Workload Identity Federation pools and providers. | map(object({…})) | | {} | +| [tags](variables-tags.tf#L96) | Tags by key name. If `id` is provided, key or value creation is skipped. The `iam` attribute behaves like the similarly named one at module level. | map(object({…})) | | {} | +| [tags_config](variables-tags.tf#L161) | Fine-grained control on tag resource and IAM creation. | object({…}) | | {} | +| [universe](variables.tf#L420) | GCP universe where to deploy the project. The prefix will be prepended to the project id. | object({…}) | | null | +| [vpc_sc](variables.tf#L431) | VPC-SC configuration for the project, use when `ignore_changes` for resources is set in the VPC-SC module. | object({…}) | | null | +| [workload_identity_pools](variables-identity-providers.tf#L17) | Workload Identity Federation pools and providers. | map(object({…})) | | {} | ## Outputs diff --git a/modules/pubsub/README.md b/modules/pubsub/README.md index de43c0f60..5d57c4ab7 100644 --- a/modules/pubsub/README.md +++ b/modules/pubsub/README.md @@ -230,18 +230,18 @@ module "pubsub" { |---|---|:---:|:---:|:---:| | [name](variables.tf#L55) | PubSub topic name. | string | ✓ | | | [project_id](variables.tf#L60) | Project used for resources. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [iam](variables-iam.tf#L17) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L54) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | | [kms_key](variables.tf#L30) | KMS customer managed encryption key. | string | | null | | [labels](variables.tf#L36) | Labels. | map(string) | | {} | | [message_retention_duration](variables.tf#L43) | Minimum duration to retain a message after it is published to the topic. | string | | null | | [message_storage_enforce_in_transit](variables.tf#L49) | If true, var.regions is also used to enforce in-transit guarantees for messages. | bool | | null | | [regions](variables.tf#L65) | List of regions used to set persistence policy. | list(string) | | [] | -| [schema](variables.tf#L72) | Topic schema. If set, all messages in this topic should follow this schema. | object({…}) | | null | -| [subscriptions](variables.tf#L82) | Topic subscriptions. Also define push configs for push subscriptions. If options is set to null subscription defaults will be used. Labels default to topic labels if set to null. | map(object({…})) | | {} | +| [schema](variables.tf#L72) | Topic schema. If set, all messages in this topic should follow this schema. | object({…}) | | null | +| [subscriptions](variables.tf#L82) | Topic subscriptions. Also define push configs for push subscriptions. If options is set to null subscription defaults will be used. Labels default to topic labels if set to null. | map(object({…})) | | {} | ## Outputs diff --git a/modules/secops-rules/README.md b/modules/secops-rules/README.md index 40c3a1878..796371a58 100644 --- a/modules/secops-rules/README.md +++ b/modules/secops-rules/README.md @@ -210,8 +210,8 @@ fe80::/10 | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L29) | Project used for resources. | string | ✓ | | -| [tenant_config](variables.tf#L66) | SecOps Tenant configuration. | object({…}) | ✓ | | -| [factories_config](variables.tf#L17) | Paths to YAML config expected in 'rules' and 'reference_lists'. Path to folders containing rules definitions (yaral files) and reference lists content (txt files) for the corresponding _defs keys. | object({…}) | | {} | -| [reference_lists_config](variables.tf#L34) | SecOps Reference lists configuration. | map(object({…})) | | {} | -| [rules_config](variables.tf#L49) | SecOps Detection rules configuration. | map(object({…})) | | {} | +| [tenant_config](variables.tf#L66) | SecOps Tenant configuration. | object({…}) | ✓ | | +| [factories_config](variables.tf#L17) | Paths to YAML config expected in 'rules' and 'reference_lists'. Path to folders containing rules definitions (yaral files) and reference lists content (txt files) for the corresponding _defs keys. | object({…}) | | {} | +| [reference_lists_config](variables.tf#L34) | SecOps Reference lists configuration. | map(object({…})) | | {} | +| [rules_config](variables.tf#L49) | SecOps Detection rules configuration. | map(object({…})) | | {} | diff --git a/modules/secret-manager/README.md b/modules/secret-manager/README.md index ab231726e..430554c37 100644 --- a/modules/secret-manager/README.md +++ b/modules/secret-manager/README.md @@ -215,9 +215,9 @@ module "secret-manager" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [project_id](variables.tf#L40) | Project id where the keyring will be created. | string | ✓ | | -| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L17) | Context-specific interpolations. | object({…}) | | {} | | [project_number](variables.tf#L45) | Project number of var.project_id. Set this to avoid permadiffs when creating tag bindings. | string | | null | -| [secrets](variables.tf#L51) | Map of secrets to manage. Defaults to global secrets unless region is set. | map(object({…})) | | {} | +| [secrets](variables.tf#L51) | Map of secrets to manage. Defaults to global secrets unless region is set. | map(object({…})) | | {} | ## Outputs diff --git a/modules/secure-source-manager-instance/README.md b/modules/secure-source-manager-instance/README.md index 73b102fd6..a0043270f 100644 --- a/modules/secure-source-manager-instance/README.md +++ b/modules/secure-source-manager-instance/README.md @@ -224,14 +224,14 @@ module "ssm_instance" { | [instance_id](variables.tf#L23) | Instance ID. | string | ✓ | | | [location](variables.tf#L40) | Location. | string | ✓ | | | [project_id](variables.tf#L55) | Project ID. | string | ✓ | | -| [repositories](variables.tf#L60) | Repositories. | map(object({…})) | ✓ | | +| [repositories](variables.tf#L60) | Repositories. | map(object({…})) | ✓ | | | [iam](variables-iam.tf#L17) | IAM bindings. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L23) | IAM bindings. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L32) | IAM bindings. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L23) | IAM bindings. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L32) | IAM bindings. | map(object({…})) | | {} | | [instance_create](variables.tf#L17) | Create SSM Instance. When set to false, uses instance_id to reference existing SSM instance. | bool | | true | | [kms_key](variables.tf#L28) | KMS key. | string | | null | | [labels](variables.tf#L34) | Instance labels. | map(string) | | null | -| [private_configs](variables.tf#L45) | The configurations for SSM private instances. | object({…}) | | {} | +| [private_configs](variables.tf#L45) | The configurations for SSM private instances. | object({…}) | | {} | ## Outputs diff --git a/modules/service-directory/README.md b/modules/service-directory/README.md index c89fe1435..e64e80e09 100644 --- a/modules/service-directory/README.md +++ b/modules/service-directory/README.md @@ -138,11 +138,11 @@ Note that the `network` argument is unusual in that it requires the project numb | [location](variables.tf#L41) | Namespace location. | string | ✓ | | | [name](variables.tf#L46) | Namespace name. | string | ✓ | | | [project_id](variables.tf#L51) | Project used for resources. | string | ✓ | | -| [endpoint_config](variables.tf#L18) | Map of endpoint attributes, keys are in service/endpoint format. | map(object({…})) | | {} | +| [endpoint_config](variables.tf#L18) | Map of endpoint attributes, keys are in service/endpoint format. | map(object({…})) | | {} | | [iam](variables.tf#L29) | IAM bindings for namespace, in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | | [labels](variables.tf#L35) | Labels. | map(string) | | {} | | [service_iam](variables.tf#L56) | IAM bindings for services, in {SERVICE => {ROLE => [MEMBERS]}} format. | map(map(list(string))) | | {} | -| [services](variables.tf#L62) | Service configuration, using service names as keys. | map(object({…})) | | {} | +| [services](variables.tf#L62) | Service configuration, using service names as keys. | map(object({…})) | | {} | ## Outputs diff --git a/modules/source-repository/README.md b/modules/source-repository/README.md index 31c384da2..439e03ace 100644 --- a/modules/source-repository/README.md +++ b/modules/source-repository/README.md @@ -79,10 +79,10 @@ module "repo" { | [name](variables.tf#L17) | Repository name. | string | ✓ | | | [project_id](variables.tf#L22) | Project used for resources. | string | ✓ | | | [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables-iam.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables-iam.tf#L39) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [iam_by_principals](variables-iam.tf#L54) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | map(list(string)) | | {} | -| [triggers](variables.tf#L27) | Cloud Build triggers. | map(object({…})) | | {} | +| [triggers](variables.tf#L27) | Cloud Build triggers. | map(object({…})) | | {} | ## Outputs diff --git a/modules/spanner-instance/README.md b/modules/spanner-instance/README.md index e568f9ce1..d021b8da8 100644 --- a/modules/spanner-instance/README.md +++ b/modules/spanner-instance/README.md @@ -168,12 +168,12 @@ module "spanner_instance" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [instance](variables.tf#L89) | Instance attributes. | object({…}) | ✓ | | +| [instance](variables.tf#L89) | Instance attributes. | object({…}) | ✓ | | | [project_id](variables.tf#L134) | Project id. | string | ✓ | | -| [databases](variables.tf#L17) | Databases. | map(object({…})) | | {} | +| [databases](variables.tf#L17) | Databases. | map(object({…})) | | {} | | [iam](variables.tf#L63) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables.tf#L69) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables.tf#L79) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings](variables.tf#L69) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables.tf#L79) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [instance_create](variables.tf#L127) | Set to false to manage databases and IAM bindings in an existing instance. | bool | | true | ## Outputs diff --git a/modules/vpc-sc/README.md b/modules/vpc-sc/README.md index 921467a1f..ab05d35fa 100644 --- a/modules/vpc-sc/README.md +++ b/modules/vpc-sc/README.md @@ -403,16 +403,16 @@ to: | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [access_policy](variables.tf#L68) | Access Policy name, set to null if creating one. | string | ✓ | | -| [access_levels](variables.tf#L17) | Access level definitions. | map(object({…})) | | {} | -| [access_policy_create](variables.tf#L73) | Access Policy configuration, fill in to create. Parent is in 'organizations/123456' format, scopes are in 'folders/456789' or 'projects/project_id' format. | object({…}) | | null | -| [context](variables.tf#L83) | External context used in replacements. | object({…}) | | {} | -| [egress_policies](variables.tf#L98) | Egress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | -| [factories_config](variables.tf#L141) | Paths to folders that enable factory functionality. | object({…}) | | {} | +| [access_levels](variables.tf#L17) | Access level definitions. | map(object({…})) | | {} | +| [access_policy_create](variables.tf#L73) | Access Policy configuration, fill in to create. Parent is in 'organizations/123456' format, scopes are in 'folders/456789' or 'projects/project_id' format. | object({…}) | | null | +| [context](variables.tf#L83) | External context used in replacements. | object({…}) | | {} | +| [egress_policies](variables.tf#L98) | Egress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | +| [factories_config](variables.tf#L141) | Paths to folders that enable factory functionality. | object({…}) | | {} | | [iam](variables.tf#L153) | IAM bindings in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [iam_bindings](variables.tf#L159) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | -| [iam_bindings_additive](variables.tf#L174) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | -| [ingress_policies](variables.tf#L189) | Ingress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | -| [perimeters](variables.tf#L231) | Regular service perimeters. | map(object({…})) | | {} | +| [iam_bindings](variables.tf#L159) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} | +| [iam_bindings_additive](variables.tf#L174) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | +| [ingress_policies](variables.tf#L189) | Ingress policy definitions that can be referenced in perimeters. | map(object({…})) | | {} | +| [perimeters](variables.tf#L231) | Regular service perimeters. | map(object({…})) | | {} | | [project_id_search_scope](variables.tf#L265) | Set this to an organization or folder ID to use Cloud Asset Inventory to automatically translate project ids to numbers. | string | | null | ## Outputs diff --git a/modules/workstation-cluster/README.md b/modules/workstation-cluster/README.md index 7a513626e..baff290a6 100644 --- a/modules/workstation-cluster/README.md +++ b/modules/workstation-cluster/README.md @@ -174,16 +174,16 @@ module "workstation-cluster" { |---|---|:---:|:---:|:---:| | [id](variables.tf#L59) | Workstation cluster ID. | string | ✓ | | | [location](variables.tf#L70) | Location. | string | ✓ | | -| [network_config](variables.tf#L75) | Network configuration. | object({…}) | ✓ | | +| [network_config](variables.tf#L75) | Network configuration. | object({…}) | ✓ | | | [project_id](variables.tf#L92) | Cluster ID. | string | ✓ | | | [annotations](variables.tf#L17) | Workstation cluster annotations. | map(string) | | {} | -| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | +| [context](variables.tf#L23) | Context-specific interpolations. | object({…}) | | {} | | [display_name](variables.tf#L38) | Display name. | string | | null | | [domain](variables.tf#L44) | Domain. | string | | null | -| [factories_config](variables.tf#L50) | Path to folder with YAML resource description data files. | object({…}) | | {} | +| [factories_config](variables.tf#L50) | Path to folder with YAML resource description data files. | object({…}) | | {} | | [labels](variables.tf#L64) | Workstation cluster labels. | map(string) | | {} | -| [private_cluster_config](variables.tf#L83) | Private cluster config. | object({…}) | | null | -| [workstation_configs](variables.tf#L97) | Workstation configurations. | map(object({…})) | | {} | +| [private_cluster_config](variables.tf#L83) | Private cluster config. | object({…}) | | null | +| [workstation_configs](variables.tf#L97) | Workstation configurations. | map(object({…})) | | {} | ## Outputs diff --git a/tools/tfdoc.py b/tools/tfdoc.py index dc3e06ed5..ce61b61af 100755 --- a/tools/tfdoc.py +++ b/tools/tfdoc.py @@ -216,7 +216,7 @@ def create_toc(readme, skip=['contents']): def create_tfref(module_path, files=False, show_extra=False, exclude_files=None, - readme=None): + readme=None, hover=False): 'Return tfdoc mark and generated content.' if readme: # check for overrides in doc @@ -245,7 +245,7 @@ def create_tfref(module_path, files=False, show_extra=False, exclude_files=None, def format_tfref(outputs, variables, files, fixtures, recipes=None, - show_extra=False): + show_extra=False, hover=False): 'Return formatted document.' buffer = [] if recipes: @@ -256,7 +256,7 @@ def format_tfref(outputs, variables, files, fixtures, recipes=None, buffer += list(format_tfref_files(files)) if variables: buffer += ['', '## Variables', ''] - buffer += list(format_tfref_variables(variables, show_extra)) + buffer += list(format_tfref_variables(variables, show_extra, hover)) if outputs: buffer += ['', '## Outputs', ''] buffer += list(format_tfref_outputs(outputs, show_extra)) @@ -320,7 +320,7 @@ def format_tfref_recipes(recipes): yield f'- [{r.title}]({r.path})' -def format_tfref_variables(items, show_extra=True): +def format_tfref_variables(items, show_extra=True, hover=False): 'Format variables table.' if not items: return @@ -345,7 +345,10 @@ def format_tfref_variables(items, show_extra=True): value = '…' else: value = f'{value[0]}…{value[-1].strip()}' - vars[k] = f'{_escape(value)}' + if hover: + vars[k] = f'{_escape(value)}' + else: + vars[k] = f'{_escape(value)}' format = ( f'| [{i.name}]({i.file}#L{i.line}) | {i.description or ""} | {vars["type"]} ' f'| {vars["required"]} | {vars["default"]} |') @@ -543,8 +546,9 @@ def render_toc(readme, toc): @click.option('--show-extra/--no-show-extra', default=False) @click.option('--toc-only', is_flag=True, default=False) @click.option('--toc-skip', multiple=True, default=['contents']) +@click.option('--hover', is_flag=True, default=False) def main(module_paths=None, exclude_file=None, files=False, replace=True, - show_extra=True, toc_only=False, toc_skip=['contents']): + show_extra=True, toc_only=False, toc_skip=['contents'], hover=False): 'Program entry point.' if not module_paths: return @@ -555,7 +559,8 @@ def main(module_paths=None, exclude_file=None, files=False, replace=True, readme_path = os.path.join(module_path, 'README.md') readme = get_readme(readme_path) if not toc_only: - doc = create_tfref(module_path, files, show_extra, exclude_file, readme) + doc = create_tfref(module_path, files, show_extra, exclude_file, readme, + hover) readme = render_tfref(readme, doc.content) toc = create_toc(readme, toc_skip) readme = render_toc(readme, toc)