Make project id optional in GCS module (#3369)
* make project id optional in GCS module * tfdoc
This commit is contained in:
Ludovico Magnocavallo
committed by
GitHub
GitHub
parent
505ee02fef
commit
08ccec3922
@@ -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. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L261) | Bucket project id. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L204) | 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#L29) | Context-specific interpolations. | <code title="object({ condition_vars = optional(map(map(string)), {}) custom_roles = optional(map(string), {}) iam_principals = optional(map(string), {}) locations = optional(map(string), {}) project_ids = optional(map(string), {}) tag_values = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [cors](variables.tf#L43) | CORS configuration for the bucket. Defaults to null. | <code title="object({ origin = optional(list(string)) method = optional(list(string)) response_header = optional(list(string)) max_age_seconds = optional(number) })">object({…})</code> | | <code>null</code> |
|
||||
| [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. | <code>list(string)</code> | | <code>null</code> |
|
||||
| [default_event_based_hold](variables.tf#L60) | 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#L66) | Enables hierarchical namespace. | <code>bool</code> | | <code>null</code> |
|
||||
| [enable_object_retention](variables.tf#L72) | Enables object retention on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
||||
| [encryption_key](variables.tf#L78) | KMS key that will be used for encryption. | <code>string</code> | | <code>null</code> |
|
||||
| [force_destroy](variables.tf#L84) | Optional map to set force destroy keyed by name, defaults to false. | <code>bool</code> | | <code>false</code> |
|
||||
| [context](variables.tf#L30) | Context-specific interpolations. | <code title="object({ condition_vars = optional(map(map(string)), {}) custom_roles = optional(map(string), {}) iam_principals = optional(map(string), {}) locations = optional(map(string), {}) project_ids = optional(map(string), {}) tag_values = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [cors](variables.tf#L44) | CORS configuration for the bucket. Defaults to null. | <code title="object({ origin = optional(list(string)) method = optional(list(string)) response_header = optional(list(string)) max_age_seconds = optional(number) })">object({…})</code> | | <code>null</code> |
|
||||
| [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. | <code>list(string)</code> | | <code>null</code> |
|
||||
| [default_event_based_hold](variables.tf#L61) | 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#L67) | Enables hierarchical namespace. | <code>bool</code> | | <code>null</code> |
|
||||
| [enable_object_retention](variables.tf#L73) | Enables object retention on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
||||
| [encryption_key](variables.tf#L79) | KMS key that will be used for encryption. | <code>string</code> | | <code>null</code> |
|
||||
| [force_destroy](variables.tf#L85) | 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(list(string))</code> | | <code>{}</code> |
|
||||
| [iam_bindings](variables-iam.tf#L23) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | <code title="map(object({ members = list(string) role = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [iam_bindings_additive](variables-iam.tf#L38) | Individual additive IAM bindings. Keys are arbitrary. | <code title="map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</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(list(string))</code> | | <code>{}</code> |
|
||||
| [ip_filter](variables.tf#L90) | The bucket's IP filter configuration. | <code title="object({ allow_cross_org_vpcs = optional(bool) allow_all_service_agent_access = optional(bool) public_network_sources = optional(list(string)) vpc_network_sources = optional(map(list(string)), {}) })">object({…})</code> | | <code>null</code> |
|
||||
| [labels](variables.tf#L101) | Labels to be attached to all buckets. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [lifecycle_rules](variables.tf#L107) | Bucket lifecycle rule. | <code title="map(object({ action = object({ type = string storage_class = optional(string) }) condition = object({ age = optional(number) created_before = optional(string) custom_time_before = optional(string) days_since_custom_time = optional(number) days_since_noncurrent_time = optional(number) matches_prefix = optional(list(string)) matches_storage_class = optional(list(string)) # STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, DURABLE_REDUCED_AVAILABILITY matches_suffix = optional(list(string)) noncurrent_time_before = optional(string) num_newer_versions = optional(number) with_state = optional(string) # "LIVE", "ARCHIVED", "ANY" }) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [location](variables.tf#L156) | Bucket location. | <code>string</code> | | <code>null</code> |
|
||||
| [logging_config](variables.tf#L166) | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [managed_folders](variables.tf#L175) | Managed folders to create within the bucket in {PATH => CONFIG} format. | <code title="map(object({ force_destroy = optional(bool, false) iam = optional(map(list(string)), {}) iam_bindings = optional(map(object({ members = list(string) role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) iam_bindings_additive = optional(map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [notification_config](variables.tf#L208) | GCS Notification configuration. | <code title="object({ enabled = bool payload_format = string sa_email = string topic_name = string create_topic = optional(object({ kms_key_id = optional(string) }), {}) event_types = optional(list(string)) custom_attributes = optional(map(string)) object_name_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [objects_to_upload](variables.tf#L225) | Objects to be uploaded to bucket. | <code title="map(object({ name = string metadata = optional(map(string)) content = optional(string) source = optional(string) cache_control = optional(string) content_disposition = optional(string) content_encoding = optional(string) content_language = optional(string) content_type = optional(string) event_based_hold = optional(bool) temporary_hold = optional(bool) detect_md5hash = optional(string) storage_class = optional(string) kms_key_name = optional(string) customer_encryption = optional(object({ encryption_algorithm = optional(string) encryption_key = string })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [prefix](variables.tf#L251) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
|
||||
| [public_access_prevention](variables.tf#L266) | Prevents public access to the bucket. | <code>string</code> | | <code>null</code> |
|
||||
| [requester_pays](variables.tf#L276) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
||||
| [retention_policy](variables.tf#L282) | Bucket retention policy. | <code title="object({ retention_period = string is_locked = optional(bool) })">object({…})</code> | | <code>null</code> |
|
||||
| [rpo](variables.tf#L291) | Bucket recovery point objective. | <code>string</code> | | <code>null</code> |
|
||||
| [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. | <code>number</code> | | <code>null</code> |
|
||||
| [storage_class](variables.tf#L307) | Bucket storage class. | <code>string</code> | | <code>"STANDARD"</code> |
|
||||
| [tag_bindings](variables.tf#L317) | Tag bindings for this folder, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [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). | <code>bool</code> | | <code>true</code> |
|
||||
| [versioning](variables.tf#L330) | Enable versioning, defaults to false. | <code>bool</code> | | <code>null</code> |
|
||||
| [website](variables.tf#L336) | Bucket website. | <code title="object({ main_page_suffix = optional(string) not_found_page = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [ip_filter](variables.tf#L91) | The bucket's IP filter configuration. | <code title="object({ allow_cross_org_vpcs = optional(bool) allow_all_service_agent_access = optional(bool) public_network_sources = optional(list(string)) vpc_network_sources = optional(map(list(string)), {}) })">object({…})</code> | | <code>null</code> |
|
||||
| [labels](variables.tf#L102) | Labels to be attached to all buckets. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [lifecycle_rules](variables.tf#L108) | Bucket lifecycle rule. | <code title="map(object({ action = object({ type = string storage_class = optional(string) }) condition = object({ age = optional(number) created_before = optional(string) custom_time_before = optional(string) days_since_custom_time = optional(number) days_since_noncurrent_time = optional(number) matches_prefix = optional(list(string)) matches_storage_class = optional(list(string)) # STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, DURABLE_REDUCED_AVAILABILITY matches_suffix = optional(list(string)) noncurrent_time_before = optional(string) num_newer_versions = optional(number) with_state = optional(string) # "LIVE", "ARCHIVED", "ANY" }) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [location](variables.tf#L157) | Bucket location. | <code>string</code> | | <code>null</code> |
|
||||
| [logging_config](variables.tf#L167) | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [managed_folders](variables.tf#L176) | Managed folders to create within the bucket in {PATH => CONFIG} format. | <code title="map(object({ force_destroy = optional(bool, false) iam = optional(map(list(string)), {}) iam_bindings = optional(map(object({ members = list(string) role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) iam_bindings_additive = optional(map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [notification_config](variables.tf#L209) | GCS Notification configuration. | <code title="object({ enabled = bool payload_format = string sa_email = string topic_name = string create_topic = optional(object({ create = optional(bool, true) kms_key_id = optional(string) }), {}) event_types = optional(list(string)) custom_attributes = optional(map(string)) object_name_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [objects_to_upload](variables.tf#L227) | Objects to be uploaded to bucket. | <code title="map(object({ name = string metadata = optional(map(string)) content = optional(string) source = optional(string) cache_control = optional(string) content_disposition = optional(string) content_encoding = optional(string) content_language = optional(string) content_type = optional(string) event_based_hold = optional(bool) temporary_hold = optional(bool) detect_md5hash = optional(string) storage_class = optional(string) kms_key_name = optional(string) customer_encryption = optional(object({ encryption_algorithm = optional(string) encryption_key = string })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [prefix](variables.tf#L253) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
|
||||
| [project_id](variables.tf#L263) | Bucket project id. Only required when creating buckets, or notification config topics. | <code>string</code> | | <code>null</code> |
|
||||
| [public_access_prevention](variables.tf#L282) | Prevents public access to the bucket. | <code>string</code> | | <code>null</code> |
|
||||
| [requester_pays](variables.tf#L292) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
||||
| [retention_policy](variables.tf#L298) | Bucket retention policy. | <code title="object({ retention_period = string is_locked = optional(bool) })">object({…})</code> | | <code>null</code> |
|
||||
| [rpo](variables.tf#L307) | Bucket recovery point objective. | <code>string</code> | | <code>null</code> |
|
||||
| [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. | <code>number</code> | | <code>null</code> |
|
||||
| [storage_class](variables.tf#L323) | Bucket storage class. | <code>string</code> | | <code>"STANDARD"</code> |
|
||||
| [tag_bindings](variables.tf#L333) | Tag bindings for this folder, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [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). | <code>bool</code> | | <code>true</code> |
|
||||
| [versioning](variables.tf#L346) | Enable versioning, defaults to false. | <code>bool</code> | | <code>null</code> |
|
||||
| [website](variables.tf#L352) | Bucket website. | <code title="object({ main_page_suffix = optional(string) not_found_page = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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" {
|
||||
|
||||
@@ -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: {}
|
||||
|
||||
Reference in New Issue
Block a user