From 15ba9559c5ff61d9d377e4f75d79d252ae3edf20 Mon Sep 17 00:00:00 2001 From: Lorenzo Caggioni Date: Fri, 1 Apr 2022 18:44:18 +0200 Subject: [PATCH] Update READMEs --- .../data-platform-foundations/README.md | 21 ++++++++------- fast/stages/03-data-platform/dev/README.md | 27 ++++++++++--------- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/examples/data-solutions/data-platform-foundations/README.md b/examples/data-solutions/data-platform-foundations/README.md index a776a405..feaaa02b 100644 --- a/examples/data-solutions/data-platform-foundations/README.md +++ b/examples/data-solutions/data-platform-foundations/README.md @@ -238,17 +238,18 @@ Description of commands: | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [billing_account_id](variables.tf#L17) | Billing account id. | string | ✓ | | -| [folder_id](variables.tf#L42) | Folder to be used for the networking resources in folders/nnnn format. | string | ✓ | | -| [organization_domain](variables.tf#L87) | Organization domain. | string | ✓ | | -| [prefix](variables.tf#L92) | Unique prefix used for resource names. | string | ✓ | | +| [folder_id](variables.tf#L53) | Folder to be used for the networking resources in folders/nnnn format. | string | ✓ | | +| [organization_domain](variables.tf#L98) | Organization domain. | string | ✓ | | +| [prefix](variables.tf#L103) | Unique prefix used for resource names. | string | ✓ | | | [composer_config](variables.tf#L22) | Cloud Composer config. | 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#L53) | User groups. | map(string) | | {…} | -| [location](variables.tf#L47) | Location used for multi-regional resources. | string | | "eu" | -| [network_config](variables.tf#L63) | Shared VPC network configurations to use. If null networks will be created in projects with preconfigured values. | object({…}) | | null | -| [project_services](variables.tf#L97) | List of core services enabled on all projects. | list(string) | | […] | -| [project_suffix](variables.tf#L108) | Suffix used only for project ids. | string | | null | -| [region](variables.tf#L114) | Region used for regional resources. | string | | "europe-west1" | +| [data_catalog_tags](variables.tf#L36) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(map(list(string))) | | {…} | +| [data_force_destroy](variables.tf#L47) | Flag to set 'force_destroy' on data services like BiguQery or Cloud Storage. | bool | | false | +| [groups](variables.tf#L64) | User groups. | map(string) | | {…} | +| [location](variables.tf#L58) | Location used for multi-regional resources. | string | | "eu" | +| [network_config](variables.tf#L74) | Shared VPC network configurations to use. If null networks will be created in projects with preconfigured values. | object({…}) | | null | +| [project_services](variables.tf#L108) | List of core services enabled on all projects. | list(string) | | […] | +| [project_suffix](variables.tf#L119) | Suffix used only for project ids. | string | | null | +| [region](variables.tf#L125) | Region used for regional resources. | string | | "europe-west1" | ## Outputs diff --git a/fast/stages/03-data-platform/dev/README.md b/fast/stages/03-data-platform/dev/README.md index 57010a9a..1d833a2a 100644 --- a/fast/stages/03-data-platform/dev/README.md +++ b/fast/stages/03-data-platform/dev/README.md @@ -145,20 +145,21 @@ terraform apply | name | description | type | required | default | producer | |---|---|:---:|:---:|:---:|:---:| | [billing_account](variables.tf#L17) | Billing account id and organization id ('nnnnnnnn' or null). | object({…}) | ✓ | | 00-globals | -| [folder_ids](variables.tf#L45) | Folder to be used for the networking resources in folders/nnnn format. | object({…}) | ✓ | | 01-resman | -| [host_project_ids](variables.tf#L63) | Shared VPC project ids. | object({…}) | ✓ | | 02-networking | -| [organization](variables.tf#L89) | Organization details. | object({…}) | ✓ | | 00-globals | -| [prefix](variables.tf#L105) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-globals | +| [folder_ids](variables.tf#L56) | Folder to be used for the networking resources in folders/nnnn format. | object({…}) | ✓ | | 01-resman | +| [host_project_ids](variables.tf#L74) | Shared VPC project ids. | object({…}) | ✓ | | 02-networking | +| [organization](variables.tf#L100) | Organization details. | object({…}) | ✓ | | 00-globals | +| [prefix](variables.tf#L116) | Unique prefix used for resource names. Not used for projects if 'project_create' is null. | string | ✓ | | 00-globals | | [composer_config](variables.tf#L26) | | object({…}) | | {…} | | -| [data_force_destroy](variables.tf#L39) | Flag to set 'force_destroy' on data services like BigQery or Cloud Storage. | bool | | false | | -| [groups](variables.tf#L53) | Groups. | map(string) | | {…} | | -| [network_config_composer](variables.tf#L71) | Network configurations to use for Composer. | object({…}) | | {…} | | -| [outputs_location](variables.tf#L99) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | -| [project_services](variables.tf#L111) | List of core services enabled on all projects. | list(string) | | […] | | -| [region](variables.tf#L122) | Region used for regional resources. | string | | "europe-west1" | | -| [service_encryption_keys](variables.tf#L128) | Cloud KMS to use to encrypt different services. Key location should match service region. | object({…}) | | null | | -| [subnet_self_links](variables.tf#L140) | Shared VPC subnet self links. | object({…}) | | null | 02-networking | -| [vpc_self_links](variables.tf#L149) | Shared VPC self links. | object({…}) | | null | 02-networking | +| [data_catalog_tags](variables.tf#L39) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(map(list(string))) | | {…} | | +| [data_force_destroy](variables.tf#L50) | Flag to set 'force_destroy' on data services like BigQery or Cloud Storage. | bool | | false | | +| [groups](variables.tf#L64) | Groups. | map(string) | | {…} | | +| [network_config_composer](variables.tf#L82) | Network configurations to use for Composer. | object({…}) | | {…} | | +| [outputs_location](variables.tf#L110) | Path where providers, tfvars files, and lists for the following stages are written. Leave empty to disable. | string | | null | | +| [project_services](variables.tf#L122) | List of core services enabled on all projects. | list(string) | | […] | | +| [region](variables.tf#L133) | Region used for regional resources. | string | | "europe-west1" | | +| [service_encryption_keys](variables.tf#L139) | Cloud KMS to use to encrypt different services. Key location should match service region. | object({…}) | | null | | +| [subnet_self_links](variables.tf#L151) | Shared VPC subnet self links. | object({…}) | | null | 02-networking | +| [vpc_self_links](variables.tf#L160) | Shared VPC self links. | object({…}) | | null | 02-networking | ## Outputs