diff --git a/modules/gcs/README.md b/modules/gcs/README.md index 4985f26ad..8c7d2104c 100644 --- a/modules/gcs/README.md +++ b/modules/gcs/README.md @@ -332,11 +332,11 @@ module "bucket" { ```hcl module "bucket" { - source = "./fabric/modules/gcs" - project_id = var.project_id - prefix = var.prefix - name = "my-bucket" - location = "EU" + source = "./fabric/modules/gcs" + bucket_create = false + prefix = var.prefix + name = "my-bucket" + location = "EU" managed_folders = { folder1 = { iam = { @@ -370,41 +370,41 @@ module "bucket" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [name](variables.tf#L203) | Bucket name suffix. | string | ✓ | | -| [project_id](variables.tf#L261) | Bucket project id. | string | ✓ | | +| [name](variables.tf#L204) | 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#L29) | Context-specific interpolations. | object({…}) | | {} | -| [cors](variables.tf#L43) | CORS configuration for the bucket. Defaults to null. | object({…}) | | null | -| [custom_placement_config](variables.tf#L54) | 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#L60) | Enable event based hold to new objects added to specific bucket, defaults to false. | bool | | null | -| [enable_hierarchical_namespace](variables.tf#L66) | Enables hierarchical namespace. | bool | | null | -| [enable_object_retention](variables.tf#L72) | Enables object retention on a storage bucket. | bool | | null | -| [encryption_key](variables.tf#L78) | KMS key that will be used for encryption. | string | | null | -| [force_destroy](variables.tf#L84) | Optional map to set force destroy keyed by name, defaults to false. | bool | | false | +| [context](variables.tf#L30) | Context-specific interpolations. | object({…}) | | {} | +| [cors](variables.tf#L44) | CORS configuration for the bucket. Defaults to null. | object({…}) | | null | +| [custom_placement_config](variables.tf#L55) | 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#L61) | Enable event based hold to new objects added to specific bucket, defaults to false. | bool | | null | +| [enable_hierarchical_namespace](variables.tf#L67) | Enables hierarchical namespace. | bool | | null | +| [enable_object_retention](variables.tf#L73) | Enables object retention on a storage bucket. | bool | | null | +| [encryption_key](variables.tf#L79) | KMS key that will be used for encryption. | string | | null | +| [force_destroy](variables.tf#L85) | 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_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#L90) | The bucket's IP filter configuration. | object({…}) | | null | -| [labels](variables.tf#L101) | Labels to be attached to all buckets. | map(string) | | {} | -| [lifecycle_rules](variables.tf#L107) | Bucket lifecycle rule. | map(object({…})) | | {} | -| [location](variables.tf#L156) | Bucket location. | string | | null | -| [logging_config](variables.tf#L166) | Bucket logging configuration. | object({…}) | | null | -| [managed_folders](variables.tf#L175) | Managed folders to create within the bucket in {PATH => CONFIG} format. | map(object({…})) | | {} | -| [notification_config](variables.tf#L208) | GCS Notification configuration. | object({…}) | | null | -| [objects_to_upload](variables.tf#L225) | Objects to be uploaded to bucket. | map(object({…})) | | {} | -| [prefix](variables.tf#L251) | Optional prefix used to generate the bucket name. | string | | null | -| [public_access_prevention](variables.tf#L266) | Prevents public access to the bucket. | string | | null | -| [requester_pays](variables.tf#L276) | Enables Requester Pays on a storage bucket. | bool | | null | -| [retention_policy](variables.tf#L282) | Bucket retention policy. | object({…}) | | null | -| [rpo](variables.tf#L291) | Bucket recovery point objective. | string | | null | -| [soft_delete_retention](variables.tf#L301) | 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#L307) | Bucket storage class. | string | | "STANDARD" | -| [tag_bindings](variables.tf#L317) | Tag bindings for this folder, in key => tag value id format. | map(string) | | {} | -| [uniform_bucket_level_access](variables.tf#L324) | 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#L330) | Enable versioning, defaults to false. | bool | | null | -| [website](variables.tf#L336) | Bucket website. | object({…}) | | null | +| [ip_filter](variables.tf#L91) | The bucket's IP filter configuration. | object({…}) | | null | +| [labels](variables.tf#L102) | Labels to be attached to all buckets. | map(string) | | {} | +| [lifecycle_rules](variables.tf#L108) | Bucket lifecycle rule. | map(object({…})) | | {} | +| [location](variables.tf#L157) | Bucket location. | string | | null | +| [logging_config](variables.tf#L167) | Bucket logging configuration. | object({…}) | | null | +| [managed_folders](variables.tf#L176) | Managed folders to create within the bucket in {PATH => CONFIG} format. | map(object({…})) | | {} | +| [notification_config](variables.tf#L209) | GCS Notification configuration. | object({…}) | | null | +| [objects_to_upload](variables.tf#L227) | Objects to be uploaded to bucket. | map(object({…})) | | {} | +| [prefix](variables.tf#L253) | Optional prefix used to generate the bucket name. | string | | null | +| [project_id](variables.tf#L263) | Bucket project id. Only required when creating buckets, or notification config topics. | string | | null | +| [public_access_prevention](variables.tf#L282) | Prevents public access to the bucket. | string | | null | +| [requester_pays](variables.tf#L292) | Enables Requester Pays on a storage bucket. | bool | | null | +| [retention_policy](variables.tf#L298) | Bucket retention policy. | object({…}) | | null | +| [rpo](variables.tf#L307) | Bucket recovery point objective. | string | | null | +| [soft_delete_retention](variables.tf#L317) | 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#L323) | Bucket storage class. | string | | "STANDARD" | +| [tag_bindings](variables.tf#L333) | Tag bindings for this folder, in key => tag value id format. | map(string) | | {} | +| [uniform_bucket_level_access](variables.tf#L340) | 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#L346) | Enable versioning, defaults to false. | bool | | null | +| [website](variables.tf#L352) | Bucket website. | object({…}) | | null | ## Outputs diff --git a/modules/gcs/main.tf b/modules/gcs/main.tf index 440db500e..756227603 100644 --- a/modules/gcs/main.tf +++ b/modules/gcs/main.tf @@ -21,11 +21,13 @@ locals { for kk, vv in v : "${local.ctx_p}${k}:${kk}" => vv } if k != "condition_vars" } - ctx_p = "$" - prefix = var.prefix == null ? "" : "${var.prefix}-" - project_id = lookup(local.ctx.project_ids, var.project_id, var.project_id) + ctx_p = "$" + prefix = var.prefix == null ? "" : "${var.prefix}-" + project_id = var.project_id == null ? null : lookup( + local.ctx.project_ids, var.project_id, var.project_id + ) notification = try(var.notification_config.enabled, false) - topic_create = try(var.notification_config.create_topic, null) != null + topic_create = try(var.notification_config.create_topic.create, null) == true bucket = ( var.bucket_create ? { name = try(google_storage_bucket.bucket[0].name, null) diff --git a/modules/gcs/variables.tf b/modules/gcs/variables.tf index 08ec0366b..ea29ed5af 100644 --- a/modules/gcs/variables.tf +++ b/modules/gcs/variables.tf @@ -23,6 +23,7 @@ variable "autoclass" { variable "bucket_create" { description = "Create bucket." type = bool + nullable = false default = true } @@ -158,8 +159,8 @@ variable "location" { type = string default = null validation { - condition = ((var.bucket_create == true) == (var.location != null)) - error_message = "Bucket location is required if and only if bucket_create is true." + condition = var.bucket_create != true || var.location != null + error_message = "Bucket location needs to be defined when creating a bucket." } } @@ -213,6 +214,7 @@ variable "notification_config" { sa_email = string topic_name = string create_topic = optional(object({ + create = optional(bool, true) kms_key_id = optional(string) }), {}) event_types = optional(list(string)) @@ -259,8 +261,22 @@ variable "prefix" { } variable "project_id" { - description = "Bucket project id." + description = "Bucket project id. Only required when creating buckets, or notification config topics." type = string + nullable = true + default = null + validation { + condition = ( + var.bucket_create != true || var.project_id != null + ) + error_message = "Project id needs to be defined when creating a bucket." + } + validation { + condition = ( + try(var.notification_config.create_topic.create, null) != true || var.project_id != null + ) + error_message = "Project id needs to be defined when creating a notification topic." + } } variable "public_access_prevention" { diff --git a/tests/modules/gcs/examples/managed-folders.yaml b/tests/modules/gcs/examples/managed-folders.yaml index 6b6422d35..c386a771b 100644 --- a/tests/modules/gcs/examples/managed-folders.yaml +++ b/tests/modules/gcs/examples/managed-folders.yaml @@ -13,25 +13,6 @@ # limitations under the License. values: - module.bucket.google_storage_bucket.bucket[0]: - autoclass: [] - cors: [] - custom_placement_config: [] - default_event_based_hold: null - enable_object_retention: null - encryption: [] - force_destroy: false - labels: null - lifecycle_rule: [] - location: EU - logging: [] - name: test-my-bucket - project: project-id - requester_pays: null - retention_policy: [] - storage_class: STANDARD - timeouts: null - uniform_bucket_level_access: true module.bucket.google_storage_managed_folder.folder["folder1/"]: bucket: test-my-bucket force_destroy: false @@ -51,10 +32,9 @@ values: role: roles/storage.admin counts: - google_storage_bucket: 1 google_storage_managed_folder: 2 google_storage_managed_folder_iam_binding: 1 modules: 1 - resources: 4 + resources: 3 outputs: {}