145 lines
6.7 KiB
Markdown
145 lines
6.7 KiB
Markdown
# Google Cloud Storage Module
|
|
## Example
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/gcs"
|
|
project_id = "myproject"
|
|
prefix = "test"
|
|
name = "my-bucket"
|
|
iam = {
|
|
"roles/storage.admin" = ["group:storage@example.com"]
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Example with Cloud KMS
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/gcs"
|
|
project_id = "myproject"
|
|
prefix = "test"
|
|
name = "my-bucket"
|
|
iam = {
|
|
"roles/storage.admin" = ["group:storage@example.com"]
|
|
}
|
|
encryption_key = "my-encryption-key"
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Example with retention policy
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/gcs"
|
|
project_id = "myproject"
|
|
prefix = "test"
|
|
name = "my-bucket"
|
|
iam = {
|
|
"roles/storage.admin" = ["group:storage@example.com"]
|
|
}
|
|
|
|
retention_policy = {
|
|
retention_period = 100
|
|
is_locked = true
|
|
}
|
|
|
|
logging_config = {
|
|
log_bucket = var.bucket
|
|
log_object_prefix = null
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Example with lifecycle rule
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/gcs"
|
|
project_id = "myproject"
|
|
prefix = "test"
|
|
name = "my-bucket"
|
|
|
|
iam = {
|
|
"roles/storage.admin" = ["group:storage@example.com"]
|
|
}
|
|
|
|
lifecycle_rule = {
|
|
action = {
|
|
type = "SetStorageClass"
|
|
storage_class = "STANDARD"
|
|
}
|
|
condition = {
|
|
age = 30
|
|
created_before = null
|
|
with_state = null
|
|
matches_storage_class = null
|
|
num_newer_versions = null
|
|
custom_time_before = null
|
|
days_since_custom_time = null
|
|
days_since_noncurrent_time = null
|
|
noncurrent_time_before = null
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
### Minimal example with GCS notifications
|
|
```hcl
|
|
module "bucket-gcs-notification" {
|
|
source = "./fabric/modules/gcs"
|
|
project_id = "myproject"
|
|
prefix = "test"
|
|
name = "my-bucket"
|
|
notification_config = {
|
|
enabled = true
|
|
payload_format = "JSON_API_V1"
|
|
sa_email = "service-<project-number>@gs-project-accounts.iam.gserviceaccount.com" # GCS SA email must be passed or fetched from projects module.
|
|
topic_name = "gcs-notification-topic"
|
|
event_types = ["OBJECT_FINALIZE"]
|
|
custom_attributes = {}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=4
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [name](variables.tf#L89) | Bucket name suffix. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L117) | Bucket project id. | <code>string</code> | ✓ | |
|
|
| [cors](variables.tf#L17) | CORS configuration for the bucket. Defaults to null. | <code title="object({ origin = list(string) method = list(string) response_header = list(string) max_age_seconds = number })">object({…})</code> | | <code>null</code> |
|
|
| [encryption_key](variables.tf#L28) | KMS key that will be used for encryption. | <code>string</code> | | <code>null</code> |
|
|
| [force_destroy](variables.tf#L34) | Optional map to set force destroy keyed by name, defaults to false. | <code>bool</code> | | <code>false</code> |
|
|
| [iam](variables.tf#L40) | IAM bindings in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
|
| [labels](variables.tf#L46) | Labels to be attached to all buckets. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [lifecycle_rule](variables.tf#L52) | Bucket lifecycle rule. | <code title="object({ action = object({ type = string storage_class = string }) condition = object({ age = number created_before = string with_state = string matches_storage_class = list(string) num_newer_versions = string custom_time_before = string days_since_custom_time = string days_since_noncurrent_time = string noncurrent_time_before = string }) })">object({…})</code> | | <code>null</code> |
|
|
| [location](variables.tf#L74) | Bucket location. | <code>string</code> | | <code>"EU"</code> |
|
|
| [logging_config](variables.tf#L80) | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = string })">object({…})</code> | | <code>null</code> |
|
|
| [notification_config](variables.tf#L94) | GCS Notification configuration. | <code title="object({ enabled = bool payload_format = string topic_name = string sa_email = string event_types = list(string) custom_attributes = map(string) })">object({…})</code> | | <code>null</code> |
|
|
| [prefix](variables.tf#L107) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
|
|
| [retention_policy](variables.tf#L122) | Bucket retention policy. | <code title="object({ retention_period = number is_locked = bool })">object({…})</code> | | <code>null</code> |
|
|
| [storage_class](variables.tf#L131) | Bucket storage class. | <code>string</code> | | <code>"MULTI_REGIONAL"</code> |
|
|
| [uniform_bucket_level_access](variables.tf#L141) | 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#L147) | Enable versioning, defaults to false. | <code>bool</code> | | <code>false</code> |
|
|
| [website](variables.tf#L153) | Bucket website. | <code title="object({ main_page_suffix = string not_found_page = string })">object({…})</code> | | <code>null</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [bucket](outputs.tf#L17) | Bucket resource. | |
|
|
| [id](outputs.tf#L28) | Bucket ID (same as name). | |
|
|
| [name](outputs.tf#L37) | Bucket name. | |
|
|
| [notification](outputs.tf#L46) | GCS Notification self link. | |
|
|
| [topic](outputs.tf#L51) | Topic ID used by GCS. | |
|
|
| [url](outputs.tf#L56) | Bucket URL. | |
|
|
|
|
<!-- END TFDOC -->
|