From d8f4f37c4896232401231ef3bc27f36db5ba250f Mon Sep 17 00:00:00 2001 From: Ludovico Magnocavallo Date: Mon, 14 Feb 2022 13:57:07 +0100 Subject: [PATCH] tfdoc --- fast/stages/00-bootstrap/README.md | 8 ++--- fast/stages/01-resman/README.md | 15 +++++---- fast/stages/02-networking-vpn/README.md | 37 +++++++++++---------- fast/stages/03-data-platform/dev/README.md | 38 ++++++++++------------ 4 files changed, 49 insertions(+), 49 deletions(-) diff --git a/fast/stages/00-bootstrap/README.md b/fast/stages/00-bootstrap/README.md index 0add953b..db4e268c 100644 --- a/fast/stages/00-bootstrap/README.md +++ b/fast/stages/00-bootstrap/README.md @@ -350,9 +350,9 @@ Names used in internal references (e.g. `module.foo-prod.id`) are only used by T | name | description | sensitive | consumers | |---|---|:---:|---| -| [billing_dataset](outputs.tf#L89) | BigQuery dataset prepared for billing export. | | | -| [project_ids](outputs.tf#L94) | Projects created by this stage. | | | -| [providers](outputs.tf#L105) | Terraform provider files for this stage and dependent stages. | ✓ | stage-01 | -| [tfvars](outputs.tf#L114) | Terraform variable files for the following stages. | ✓ | | +| [billing_dataset](outputs.tf#L99) | BigQuery dataset prepared for billing export. | | | +| [project_ids](outputs.tf#L104) | Projects created by this stage. | | | +| [providers](outputs.tf#L115) | Terraform provider files for this stage and dependent stages. | ✓ | stage-01 | +| [tfvars](outputs.tf#L124) | Terraform variable files for the following stages. | ✓ | | diff --git a/fast/stages/01-resman/README.md b/fast/stages/01-resman/README.md index 8ff41f7d..002407b9 100644 --- a/fast/stages/01-resman/README.md +++ b/fast/stages/01-resman/README.md @@ -150,6 +150,7 @@ Due to its simplicity, this stage lends itself easily to customizations: adding | name | description | modules | resources | |---|---|---|---| | [billing.tf](./billing.tf) | Billing resources for external billing use cases. | organization | google_billing_account_iam_member | +| [branch-dataplatform.tf](./branch-dataplatform.tf) | Data Platform stages resources. | folder · gcs · iam-service-account | | | [branch-networking.tf](./branch-networking.tf) | Networking stage resources. | folder · gcs · iam-service-account | | | [branch-sandbox.tf](./branch-sandbox.tf) | Sandbox stage resources. | folder · gcs · iam-service-account | | | [branch-security.tf](./branch-security.tf) | Security stage resources. | folder · gcs · iam-service-account | | @@ -177,12 +178,12 @@ Due to its simplicity, this stage lends itself easily to customizations: adding | name | description | sensitive | consumers | |---|---|:---:|---| -| [networking](outputs.tf#L83) | Data for the networking stage. | | 02-networking | -| [project_factories](outputs.tf#L93) | Data for the project factories stage. | | xx-teams | -| [providers](outputs.tf#L110) | Terraform provider files for this stage and dependent stages. | ✓ | 02-networking · 02-security · xx-sandbox · xx-teams | -| [sandbox](outputs.tf#L117) | Data for the sandbox stage. | | xx-sandbox | -| [security](outputs.tf#L127) | Data for the networking stage. | | 02-security | -| [teams](outputs.tf#L137) | Data for the teams stage. | | | -| [tfvars](outputs.tf#L150) | Terraform variable files for the following stages. | ✓ | | +| [networking](outputs.tf#L107) | Data for the networking stage. | | 02-networking | +| [project_factories](outputs.tf#L117) | Data for the project factories stage. | | xx-teams | +| [providers](outputs.tf#L134) | Terraform provider files for this stage and dependent stages. | ✓ | 02-networking · 02-security · xx-sandbox · xx-teams | +| [sandbox](outputs.tf#L141) | Data for the sandbox stage. | | xx-sandbox | +| [security](outputs.tf#L151) | Data for the networking stage. | | 02-security | +| [teams](outputs.tf#L161) | Data for the teams stage. | | | +| [tfvars](outputs.tf#L174) | Terraform variable files for the following stages. | ✓ | | diff --git a/fast/stages/02-networking-vpn/README.md b/fast/stages/02-networking-vpn/README.md index 4b96eba8..79fa57f8 100644 --- a/fast/stages/02-networking-vpn/README.md +++ b/fast/stages/02-networking-vpn/README.md @@ -309,31 +309,32 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| | [billing_account_id](variables.tf#L17) | Billing account id. | string | ✓ | | 00-bootstrap | -| [folder_ids](variables.tf#L61) | Folders to be used for the networking resources in folders/nnnnnnnnnnn format. If null, folder will be created. | map(string) | ✓ | | 01-resman | -| [organization](variables.tf#L85) | Organization details. | object({…}) | ✓ | | 00-bootstrap | -| [prefix](variables.tf#L101) | Prefix used for resources that need unique names. Use 9 characters or less. | string | ✓ | | 00-bootstrap | +| [folder_ids](variables.tf#L68) | Folders to be used for the networking resources in folders/nnnnnnnnnnn format. If null, folder will be created. | map(string) | ✓ | | 01-resman | +| [organization](variables.tf#L92) | Organization details. | object({…}) | ✓ | | 00-bootstrap | +| [prefix](variables.tf#L108) | Prefix used for resources that need unique names. Use 9 characters or less. | string | ✓ | | 00-bootstrap | | [custom_adv](variables.tf#L23) | Custom advertisement definitions in name => range format. | map(string) | | {…} | | | [custom_roles](variables.tf#L40) | Custom roles defined at the org level, in key => id format. | map(string) | | {} | 00-bootstrap | | [data_dir](variables.tf#L47) | Relative path for the folder storing configuration data for network resources. | string | | "data" | | -| [dns](variables.tf#L53) | Onprem DNS resolvers. | map(list(string)) | | {…} | | -| [l7ilb_subnets](variables.tf#L67) | Subnets used for L7 ILBs. | map(list(object({…}))) | | {…} | | -| [outputs_location](variables.tf#L95) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | -| [project_factory_sa](variables.tf#L112) | IAM emails for project factory service accounts. | map(string) | | {} | 01-resman | -| [psa_ranges](variables.tf#L119) | IP ranges used for Private Service Access (e.g. CloudSQL). | map(map(string)) | | {…} | | -| [router_configs](variables.tf#L134) | Configurations for CRs and onprem routers. | map(object({…})) | | {…} | | -| [vpn_onprem_configs](variables.tf#L158) | VPN gateway configuration for onprem interconnection. | map(object({…})) | | {…} | | -| [vpn_spoke_configs](variables.tf#L214) | VPN gateway configuration for spokes. | map(object({…})) | | {…} | | +| [data_platform_sa](variables.tf#L53) | IAM emails for Data Platform service accounts. | map(string) | | {} | 01-resman | +| [dns](variables.tf#L60) | Onprem DNS resolvers. | map(list(string)) | | {…} | | +| [l7ilb_subnets](variables.tf#L74) | Subnets used for L7 ILBs. | map(list(object({…}))) | | {…} | | +| [outputs_location](variables.tf#L102) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | string | | null | | +| [project_factory_sa](variables.tf#L119) | IAM emails for project factory service accounts. | map(string) | | {} | 01-resman | +| [psa_ranges](variables.tf#L126) | IP ranges used for Private Service Access (e.g. CloudSQL). | map(map(string)) | | {…} | | +| [router_configs](variables.tf#L141) | Configurations for CRs and onprem routers. | map(object({…})) | | {…} | | +| [vpn_onprem_configs](variables.tf#L165) | VPN gateway configuration for onprem interconnection. | map(object({…})) | | {…} | | +| [vpn_spoke_configs](variables.tf#L221) | VPN gateway configuration for spokes. | map(object({…})) | | {…} | | ## Outputs | name | description | sensitive | consumers | |---|---|:---:|---| -| [cloud_dns_inbound_policy](outputs.tf#L41) | IP Addresses for Cloud DNS inbound policy. | | | -| [project_ids](outputs.tf#L46) | Network project ids. | | | -| [project_numbers](outputs.tf#L55) | Network project numbers. | | | -| [shared_vpc_host_projects](outputs.tf#L64) | Shared VPC host projects. | | | -| [shared_vpc_self_links](outputs.tf#L74) | Shared VPC host projects. | | | -| [tfvars](outputs.tf#L91) | Network-related variables used in other stages. | ✓ | | -| [vpn_gateway_endpoints](outputs.tf#L84) | External IP Addresses for the GCP VPN gateways. | | | +| [cloud_dns_inbound_policy](outputs.tf#L65) | IP Addresses for Cloud DNS inbound policy. | | | +| [project_ids](outputs.tf#L70) | Network project ids. | | | +| [project_numbers](outputs.tf#L79) | Network project numbers. | | | +| [shared_vpc_host_projects](outputs.tf#L88) | Shared VPC host projects. | | | +| [shared_vpc_self_links](outputs.tf#L98) | Shared VPC host projects. | | | +| [tfvars](outputs.tf#L115) | Network-related variables used in other stages. | ✓ | | +| [vpn_gateway_endpoints](outputs.tf#L108) | External IP Addresses for the GCP VPN gateways. | | | diff --git a/fast/stages/03-data-platform/dev/README.md b/fast/stages/03-data-platform/dev/README.md index 60c91646..84854846 100644 --- a/fast/stages/03-data-platform/dev/README.md +++ b/fast/stages/03-data-platform/dev/README.md @@ -104,7 +104,6 @@ terraform apply |---|---|---|---| | [main.tf](./main.tf) | Data Platformy. | data-platform-foundations | | | [outputs.tf](./outputs.tf) | Output variables. | | local_file | -| [providers.tf](./providers.tf) | Provider configurations. | | | | [variables.tf](./variables.tf) | Terraform Variables. | | | ## Variables @@ -112,29 +111,28 @@ terraform apply | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| | [billing_account_id](variables.tf#L17) | Billing account id. | string | ✓ | | 00-bootstrap | -| [folder_id](variables.tf#L66) | Folder to be used for the networking resources in folders/nnnn format. | string | ✓ | | resman | -| [network_config](variables.tf#L94) | Network configurations to use. Specify a shared VPC to use, if null networks will be created in projects. | object({…}) | ✓ | | | -| [organization](variables.tf#L107) | Organization details. | object({…}) | ✓ | | 00-bootstrap | -| [prefix](variables.tf#L123) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-bootstrap | -| [composer_config](variables.tf#L23) | | object({…}) | | {…} | | -| [data_force_destroy](variables.tf#L54) | Flag to set 'force_destroy' on data services like BiguQery or Cloud Storage. | bool | | false | | -| [enable_cloud_nat](variables.tf#L60) | Network Cloud NAT flag. | bool | | false | | -| [groups](variables.tf#L72) | Groups. | map(string) | | {…} | | -| [location_config](variables.tf#L82) | Locations where resources will be deployed. Map to configure region and multiregion specs. | object({…}) | | {…} | | -| [outputs_location](variables.tf#L117) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | -| [project_id](variables.tf#L129) | Project id, references existing project if `project_create` is null. | object({…}) | | {…} | | -| [project_services](variables.tf#L157) | List of core services enabled on all projects. | list(string) | | […] | | +| [folder_id](variables.tf#L42) | Folder to be used for the networking resources in folders/nnnn format. | string | ✓ | | resman | +| [network_config](variables.tf#L58) | Network configurations to use. Specify a shared VPC to use, if null networks will be created in projects. | object({…}) | ✓ | | | +| [organization_domain](variables.tf#L97) | Organization domain. | string | ✓ | | | +| [prefix](variables.tf#L108) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-bootstrap | +| [composer_config](variables.tf#L23) | | object({…}) | | {…} | | +| [data_force_destroy](variables.tf#L36) | Flag to set 'force_destroy' on data services like BiguQery or Cloud Storage. | bool | | false | | +| [groups](variables.tf#L48) | Groups. | map(string) | | {…} | | +| [network_config_composer](variables.tf#L71) | Network configurations to use for Composer. | object({…}) | | {…} | | +| [outputs_location](variables.tf#L102) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | +| [project_services](variables.tf#L114) | List of core services enabled on all projects. | list(string) | | […] | | +| [region](variables.tf#L125) | Region used for regional resources. | string | | "europe-west1" | | ## Outputs | name | description | sensitive | consumers | |---|---|:---:|---| -| [bigquery_datasets](outputs.tf#L35) | BigQuery datasets. | | | -| [demo_commands](outputs.tf#L65) | Demo commands. | | | -| [gcs_buckets](outputs.tf#L40) | GCS buckets. | | | -| [kms_keys](outputs.tf#L45) | Cloud MKS keys. | | | -| [projects](outputs.tf#L50) | GCP Projects informations. | | | -| [vpc_network](outputs.tf#L55) | VPC network. | | | -| [vpc_subnet](outputs.tf#L60) | VPC subnetworks. | | | +| [bigquery_datasets](outputs.tf#L28) | BigQuery datasets. | | | +| [demo_commands](outputs.tf#L58) | Demo commands. | | | +| [gcs_buckets](outputs.tf#L33) | GCS buckets. | | | +| [kms_keys](outputs.tf#L38) | Cloud MKS keys. | | | +| [projects](outputs.tf#L43) | GCP Projects informations. | | | +| [vpc_network](outputs.tf#L48) | VPC network. | | | +| [vpc_subnet](outputs.tf#L53) | VPC subnetworks. | | |