From e1e0c38236f46144065312cf68fa0b920143eb5d Mon Sep 17 00:00:00 2001 From: Julio Castillo Date: Mon, 6 Feb 2023 18:08:03 +0100 Subject: [PATCH] Fix README and var order --- .../factories/project-factory/README.md | 26 +++++++++---------- .../factories/project-factory/variables.tf | 14 +++++----- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/blueprints/factories/project-factory/README.md b/blueprints/factories/project-factory/README.md index a7619aae08..2b8c3874e6 100644 --- a/blueprints/factories/project-factory/README.md +++ b/blueprints/factories/project-factory/README.md @@ -223,21 +223,21 @@ vpc: | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [billing_account_id](variables.tf#L17) | Billing account id. | string | ✓ | | -| [prefix](variables.tf#L151) | Prefix used for resource names. | string | ✓ | | -| [project_id](variables.tf#L160) | Project id. | string | ✓ | | +| [prefix](variables.tf#L157) | Prefix used for resource names. | string | ✓ | | +| [project_id](variables.tf#L166) | Project id. | string | ✓ | | | [billing_alert](variables.tf#L22) | Billing alert configuration. | object({…}) | | null | | [defaults](variables.tf#L35) | Project factory default values. | object({…}) | | null | -| [descriptive_name](variables.tf#L165) | Name of the project name. Used for project name instead of `name` variable. | string | | null | -| [dns_zones](variables.tf#L57) | DNS private zones to create as child of var.defaults.environment_dns_zone. | list(string) | | [] | -| [essential_contacts](variables.tf#L63) | Email contacts to be used for billing and GCP notifications. | list(string) | | [] | -| [folder_id](variables.tf#L69) | Folder ID for the folder where the project will be created. | string | | null | -| [group_iam](variables.tf#L75) | Custom IAM settings in group => [role] format. | map(list(string)) | | {} | -| [group_iam_additive](variables.tf#L81) | Custom additive IAM settings in group => [role] format. | map(list(string)) | | {} | -| [iam](variables.tf#L87) | Custom IAM settings in role => [principal] format. | map(list(string)) | | {} | -| [iam_additive](variables.tf#L93) | Custom additive IAM settings in role => [principal] format. | map(list(string)) | | {} | -| [kms_service_agents](variables.tf#L99) | KMS IAM configuration in as service => [key]. | map(list(string)) | | {} | -| [labels](variables.tf#L105) | Labels to be assigned at project level. | map(string) | | {} | -| [org_policies](variables.tf#L111) | Org-policy overrides at project level. | map(object({…})) | | {} | +| [descriptive_name](variables.tf#L57) | Name of the project name. Used for project name instead of `name` variable. | string | | null | +| [dns_zones](variables.tf#L63) | DNS private zones to create as child of var.defaults.environment_dns_zone. | list(string) | | [] | +| [essential_contacts](variables.tf#L69) | Email contacts to be used for billing and GCP notifications. | list(string) | | [] | +| [folder_id](variables.tf#L75) | Folder ID for the folder where the project will be created. | string | | null | +| [group_iam](variables.tf#L81) | Custom IAM settings in group => [role] format. | map(list(string)) | | {} | +| [group_iam_additive](variables.tf#L87) | Custom additive IAM settings in group => [role] format. | map(list(string)) | | {} | +| [iam](variables.tf#L93) | Custom IAM settings in role => [principal] format. | map(list(string)) | | {} | +| [iam_additive](variables.tf#L99) | Custom additive IAM settings in role => [principal] format. | map(list(string)) | | {} | +| [kms_service_agents](variables.tf#L105) | KMS IAM configuration in as service => [key]. | map(list(string)) | | {} | +| [labels](variables.tf#L111) | Labels to be assigned at project level. | map(string) | | {} | +| [org_policies](variables.tf#L117) | Org-policy overrides at project level. | map(object({…})) | | {} | | [service_accounts](variables.tf#L171) | Service accounts to be created, and roles assigned them on the project. | map(list(string)) | | {} | | [service_accounts_additive](variables.tf#L177) | Service accounts to be created, and roles assigned them on the project additively. | map(list(string)) | | {} | | [service_accounts_iam](variables.tf#L183) | IAM bindings on service account resources. Format is KEY => {ROLE => [MEMBERS]}. | map(map(list(string))) | | {} | diff --git a/blueprints/factories/project-factory/variables.tf b/blueprints/factories/project-factory/variables.tf index 6475e246cc..3aa3fa36b4 100644 --- a/blueprints/factories/project-factory/variables.tf +++ b/blueprints/factories/project-factory/variables.tf @@ -1,5 +1,5 @@ /** - * Copyright 2022 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -54,6 +54,12 @@ variable "defaults" { default = null } +variable "descriptive_name" { + description = "Name of the project name. Used for project name instead of `name` variable." + type = string + default = null +} + variable "dns_zones" { description = "DNS private zones to create as child of var.defaults.environment_dns_zone." type = list(string) @@ -162,12 +168,6 @@ variable "project_id" { type = string } -variable "descriptive_name" { - description = "Name of the project name. Used for project name instead of `name` variable." - type = string - default = null -} - variable "service_accounts" { description = "Service accounts to be created, and roles assigned them on the project." type = map(list(string))