143 lines
6.5 KiB
Markdown
143 lines
6.5 KiB
Markdown
# Google Cloud Storage Module
|
|
## Example
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./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 = "./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 = "./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 = "./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 = "./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 | Bucket name suffix. | <code title="">string</code> | ✓ | |
|
|
| project_id | Bucket project id. | <code title="">string</code> | ✓ | |
|
|
| *cors* | 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 title="">null</code> |
|
|
| *encryption_key* | KMS key that will be used for encryption. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *force_destroy* | Optional map to set force destroy keyed by name, defaults to false. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *iam* | IAM bindings in {ROLE => [MEMBERS]} format. | <code title="map(list(string))">map(list(string))</code> | | <code title="">{}</code> |
|
|
| *labels* | Labels to be attached to all buckets. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
|
| *lifecycle_rule* | 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 title="">null</code> |
|
|
| *location* | Bucket location. | <code title="">string</code> | | <code title="">EU</code> |
|
|
| *logging_config* | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = string })">object({...})</code> | | <code title="">null</code> |
|
|
| *notification_config* | 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 title="">null</code> |
|
|
| *prefix* | Prefix used to generate the bucket name. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *retention_policy* | Bucket retention policy. | <code title="object({ retention_period = number is_locked = bool })">object({...})</code> | | <code title="">null</code> |
|
|
| *storage_class* | Bucket storage class. | <code title="">string</code> | | <code title="MULTI_REGIONAL validation { condition = contains(["STANDARD", "MULTI_REGIONAL", "REGIONAL", "NEARLINE", "COLDLINE", "ARCHIVE"], var.storage_class) error_message = "Storage class must be one of STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE." }">...</code> |
|
|
| *uniform_bucket_level_access* | 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 title="">bool</code> | | <code title="">true</code> |
|
|
| *versioning* | Enable versioning, defaults to false. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *website* | Bucket website. | <code title="object({ main_page_suffix = string not_found_page = string })">object({...})</code> | | <code title="">null</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| bucket | Bucket resource. | |
|
|
| name | Bucket name. | |
|
|
| notification | GCS Notification self link. | |
|
|
| topic | Topic ID used by GCS. | |
|
|
| url | Bucket URL. | |
|
|
<!-- END TFDOC -->
|