Add support for dynamic tags (#3897)

* Allow creation of dynamic tags

* Extend project factory and related modules to support dynamic values

* Extend folder and organization modules

* project and organization readme

* Simplify dynamic tag support and remove unnecessary restrictions

  • Schemas & Validations: Removed the restriction that forbade combining IAM fields with  allowed_values_regex  on tags. Updated validations in  project  and  organization  modules, and
  simplified all relevant JSON schemas.
  • Module Tag Bindings: Simplified the  tag_value  assignment in  folder ,  project ,  gcs ,  bigquery-dataset , and  kms  modules by removing the defensive  can(regex(...))  check and
  calling  templatestring  directly.
  • Outputs: Removed the  tags_dynamic  output from  project  and  organization  modules, as the same information is now available in  tag_keys .
  • Project Factory: Updated  tag_vars_projects  in  projects.tf  to use the native  namespaced_name  attribute and filtered manually for dynamic tags.

* fix(organization, project): fix linting and tests for dynamic tag support

- Align allowed_values_regex and description extraction in _tags_merged
  locals to use lookup() for consistency with other fields.
- Fix spacing in project context variable (alphabetical ordering).
- Update organization tags test to include the new cost_center tag key
  with allowed_values_regex.
- Update project tags test to include the new cost_center tag key and
  reflect the resolved allowed_values_regex on environment.

* refactor(gcs): refine tag bindings and fix context test

- Add _tag_bindings local to pre-resolve context references, enabling
  templatestring to receive a direct map reference (required by Terraform).
- Use var.context.tag_vars instead of the non-existent local.ctx.tag_vars.
- Fix HCL syntax in context.tfvars (escaped inner quotes).
- Update context test inventory to reflect 3 tag bindings including a
  dynamic value resolved via templatestring.

* refactor: align modules with tag binding context pattern

- Add _tag_bindings local + templatestring dance to cloud-run-v2,
  compute-vm, folder, kms modules (bigquery-dataset already had it)
- Exclude tag_vars from local.ctx in cloud-run-v2, compute-vm, folder,
  kms, project modules (bigquery-dataset already had it)
- Add tag_vars to context variable in cloud-run-v2, compute-vm modules
  (others already had it)
- Update all context tests with dynamic tag binding values using
  var.context.tag_vars

* docs: add module-level tftest.yaml test instructions to GEMINI.md

* docs: regenerate READMEs after tag-regex alignment

- Regenerate variable tables in 7 module READMEs to reflect
  line number shifts from prior tag-regex changes
- Add tag_vars exclusion to gcs ctx local
- Fix whitespace alignment in iam-service-account and
  project-factory tag_vars blocks
- Update tftest resource counts for organization and project
- Remove tags_dynamic from organization/project output tables

* fix(project-factory): update test inventory for tag_bindings module split

- Move tag binding address from folder-2 to folder-2-iam in test
  inventory (tag_bindings moved from creation to IAM modules)
- Update module instance count from 34 to 35
- Regenerate README tables after terraform fmt line shifts
- Apply terraform fmt to variables.tf

* refactor(project-factory): remove unnecessary depends_on from folder-iam modules

Folder IAM modules depend on their own folder creation modules, not
on module.projects. The explicit depends_on was leftover from an
earlier design.

* FAST stages

* Address review comments.

- FAST Stages:
  - Added tag_keys to output-files.tf in 0-org-setup to pass org tags via tfvars.
  - Sorted tag_keys and tag_values in output-files.tf.
  - Updated project-factory, networking, and security stages to use tag_keys.
  - Filtered tag_keys for dynamic tags only.
- Modules:
  - Excluded tag_vars from local.ctx in iam-service-account and organization.
  - Simplified tag_value in iam-service-account.
- Tests:
  - Updated test inventories for 0-org-setup and project-factory.

* Fix tf format

* Fix tfdoc

* docs: add ADR for templatestring vars convention and update status of base path ADR

* More tfdoc

* Update schemas

* Use endswith in context loop

* Address review

* Update FAST readmes

* Update last modules

* Terraform fmt

* Revert alloydb

* Fix whitespace

---------

Co-authored-by: Ludovico Magnocavallo <ludo@qix.it>
This commit is contained in:
Julio Castillo
2026-04-24 22:45:45 +02:00
committed by GitHub
parent fb33752d8d
commit 2eaa0d5e27
118 changed files with 1018 additions and 378 deletions

View File

@@ -417,42 +417,42 @@ module "bucket" {
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [name](variables.tf#L224) | Bucket name suffix. | <code>string</code> | ✓ | |
| [name](variables.tf#L228) | Bucket name suffix. | <code>string</code> | ✓ | |
| [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. | <code>bool</code> | | <code>null</code> |
| [bucket_create](variables.tf#L23) | Create bucket. | <code>bool</code> | | <code>true</code> |
| [context](variables.tf#L30) | Context-specific interpolations. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>&#123;&#125;</code> |
| [cors](variables.tf#L46) | CORS configuration for the bucket. Defaults to null. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [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. | <code>list&#40;string&#41;</code> | | <code>null</code> |
| [default_event_based_hold](variables.tf#L63) | Enable event based hold to new objects added to specific bucket, defaults to false. | <code>bool</code> | | <code>null</code> |
| [enable_hierarchical_namespace](variables.tf#L69) | Enables hierarchical namespace. | <code>bool</code> | | <code>null</code> |
| [enable_object_retention](variables.tf#L75) | Enables object retention on a storage bucket. | <code>bool</code> | | <code>null</code> |
| [encryption_key](variables.tf#L81) | KMS key that will be used for encryption. | <code>string</code> | | <code>null</code> |
| [force_destroy](variables.tf#L87) | Optional map to set force destroy keyed by name, defaults to false. | <code>bool</code> | | <code>false</code> |
| [cors](variables.tf#L50) | CORS configuration for the bucket. Defaults to null. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [custom_placement_config](variables.tf#L61) | 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. | <code>list&#40;string&#41;</code> | | <code>null</code> |
| [default_event_based_hold](variables.tf#L67) | Enable event based hold to new objects added to specific bucket, defaults to false. | <code>bool</code> | | <code>null</code> |
| [enable_hierarchical_namespace](variables.tf#L73) | Enables hierarchical namespace. | <code>bool</code> | | <code>null</code> |
| [enable_object_retention](variables.tf#L79) | Enables object retention on a storage bucket. | <code>bool</code> | | <code>null</code> |
| [encryption_key](variables.tf#L85) | KMS key that will be used for encryption. | <code>string</code> | | <code>null</code> |
| [force_destroy](variables.tf#L91) | Optional map to set force destroy keyed by name, defaults to false. | <code>bool</code> | | <code>false</code> |
| [iam](variables-iam.tf#L17) | IAM bindings in {ROLE => [MEMBERS]} format. | <code>map&#40;list&#40;string&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [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. | <code>map&#40;list&#40;string&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [ip_filter](variables.tf#L93) | The bucket's IP filter configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [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. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [labels](variables.tf#L122) | Labels to be attached to all buckets. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [lifecycle_rules](variables.tf#L128) | Bucket lifecycle rule. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [location](variables.tf#L177) | Bucket location. | <code>string</code> | | <code>null</code> |
| [logging_config](variables.tf#L187) | Bucket logging configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [managed_folders](variables.tf#L196) | Managed folders to create within the bucket in {PATH => CONFIG} format. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [notification_config](variables.tf#L229) | GCS Notification configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [objects_to_upload](variables.tf#L247) | Objects to be uploaded to bucket. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [prefix](variables.tf#L273) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
| [project_id](variables.tf#L283) | Bucket project id. Only required when creating buckets, or notification config topics. | <code>string</code> | | <code>null</code> |
| [public_access_prevention](variables.tf#L302) | Prevents public access to the bucket. | <code>string</code> | | <code>null</code> |
| [requester_pays](variables.tf#L312) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
| [retention_policy](variables.tf#L318) | Bucket retention policy. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [rpo](variables.tf#L327) | Bucket recovery point objective. | <code>string</code> | | <code>null</code> |
| [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. | <code>number</code> | | <code>null</code> |
| [storage_class](variables.tf#L343) | Bucket storage class. | <code>string</code> | | <code>&#34;STANDARD&#34;</code> |
| [tag_bindings](variables.tf#L353) | Tag bindings for this folder, in key => tag value id format. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [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). | <code>bool</code> | | <code>true</code> |
| [versioning](variables.tf#L366) | Enable versioning, defaults to false. | <code>bool</code> | | <code>null</code> |
| [website](variables.tf#L372) | Bucket website. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [ip_filter](variables.tf#L97) | The bucket's IP filter configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [kms_autokeys](variables.tf#L108) | 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. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [labels](variables.tf#L126) | Labels to be attached to all buckets. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [lifecycle_rules](variables.tf#L132) | Bucket lifecycle rule. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [location](variables.tf#L181) | Bucket location. | <code>string</code> | | <code>null</code> |
| [logging_config](variables.tf#L191) | Bucket logging configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [managed_folders](variables.tf#L200) | Managed folders to create within the bucket in {PATH => CONFIG} format. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [notification_config](variables.tf#L233) | GCS Notification configuration. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [objects_to_upload](variables.tf#L251) | Objects to be uploaded to bucket. | <code>map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [prefix](variables.tf#L277) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
| [project_id](variables.tf#L287) | Bucket project id. Only required when creating buckets, or notification config topics. | <code>string</code> | | <code>null</code> |
| [public_access_prevention](variables.tf#L306) | Prevents public access to the bucket. | <code>string</code> | | <code>null</code> |
| [requester_pays](variables.tf#L316) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
| [retention_policy](variables.tf#L322) | Bucket retention policy. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
| [rpo](variables.tf#L331) | Bucket recovery point objective. | <code>string</code> | | <code>null</code> |
| [soft_delete_retention](variables.tf#L341) | 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. | <code>number</code> | | <code>null</code> |
| [storage_class](variables.tf#L347) | Bucket storage class. | <code>string</code> | | <code>&#34;STANDARD&#34;</code> |
| [tag_bindings](variables.tf#L357) | Tag bindings for this folder, in key => tag value id format. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [uniform_bucket_level_access](variables.tf#L364) | 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). | <code>bool</code> | | <code>true</code> |
| [versioning](variables.tf#L370) | Enable versioning, defaults to false. | <code>bool</code> | | <code>null</code> |
| [website](variables.tf#L376) | Bucket website. | <code>object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>null</code> |
## Outputs

View File

@@ -19,7 +19,7 @@ locals {
ctx = {
for k, v in var.context : k => {
for kk, vv in v : "${local.ctx_p}${k}:${kk}" => vv
} if k != "condition_vars"
} if !endswith(k, "_vars")
}
ctx_kms_keys = merge(local.ctx.kms_keys, {
for k, v in google_kms_key_handle.default : "$kms_keys:autokeys/${k}" => v.kms_key

View File

@@ -14,11 +14,19 @@
* limitations under the License.
*/
locals {
_tag_bindings = {
for k, v in var.tag_bindings : k => lookup(local.ctx.tag_values, v, v)
}
}
resource "google_tags_location_tag_binding" "binding" {
for_each = var.tag_bindings
parent = "//storage.googleapis.com/projects/_/buckets/${local._name}"
tag_value = lookup(local.ctx.tag_values, each.value, each.value)
location = lookup(local.ctx.locations, var.location, var.location)
for_each = var.tag_bindings
parent = "//storage.googleapis.com/projects/_/buckets/${local._name}"
tag_value = templatestring(
local._tag_bindings[each.key], var.context.tag_vars
)
location = lookup(local.ctx.locations, var.location, var.location)
depends_on = [
google_storage_bucket.bucket,
google_storage_bucket_iam_binding.bindings

View File

@@ -38,6 +38,10 @@ variable "context" {
project_ids = optional(map(string), {})
storage_buckets = optional(map(string), {})
tag_values = optional(map(string), {})
tag_vars = optional(object({
projects = optional(map(map(string)), {})
organization = optional(map(string), {})
}), {})
})
default = {}
nullable = false