119 lines
5.4 KiB
Markdown
119 lines
5.4 KiB
Markdown
# Google Cloud Pub/Sub Module
|
|
|
|
This module allows managing a single Pub/Sub topic, including multiple subscriptions and IAM bindings at the topic and subscriptions levels.
|
|
|
|
|
|
## Examples
|
|
|
|
### Simple topic with IAM
|
|
|
|
```hcl
|
|
module "pubsub" {
|
|
source = "./modules/pubsub"
|
|
project_id = "my-project"
|
|
name = "my-topic"
|
|
iam = {
|
|
"roles/pubsub.viewer" = ["group:foo@example.com"]
|
|
"roles/pubsub.subscriber" = ["user:user1@example.com"]
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3
|
|
```
|
|
|
|
### Subscriptions
|
|
|
|
Subscriptions are defined with the `subscriptions` variable, allowing optional configuration of per-subscription defaults. Push subscriptions need extra configuration, shown in the following example.
|
|
|
|
```hcl
|
|
module "pubsub" {
|
|
source = "./modules/pubsub"
|
|
project_id = "my-project"
|
|
name = "my-topic"
|
|
subscriptions = {
|
|
test-pull = null
|
|
test-pull-override = {
|
|
labels = { test = "override" }
|
|
options = {
|
|
ack_deadline_seconds = null
|
|
message_retention_duration = null
|
|
retain_acked_messages = true
|
|
expiration_policy_ttl = null
|
|
filter = null
|
|
}
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3
|
|
```
|
|
|
|
### Push subscriptions
|
|
|
|
Push subscriptions need extra configuration in the `push_configs` variable.
|
|
|
|
```hcl
|
|
module "pubsub" {
|
|
source = "./modules/pubsub"
|
|
project_id = "my-project"
|
|
name = "my-topic"
|
|
subscriptions = {
|
|
test-push = null
|
|
}
|
|
push_configs = {
|
|
test-push = {
|
|
endpoint = "https://example.com/foo"
|
|
attributes = null
|
|
oidc_token = null
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Subscriptions with IAM
|
|
|
|
```hcl
|
|
module "pubsub" {
|
|
source = "./modules/pubsub"
|
|
project_id = "my-project"
|
|
name = "my-topic"
|
|
subscriptions = {
|
|
test-1 = null
|
|
test-1 = null
|
|
}
|
|
subscription_iam = {
|
|
test-1 = {
|
|
"roles/pubsub.subscriber" = ["user:user1@ludomagno.net"]
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [name](variables.tf#L62) | PubSub topic name. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L67) | Project used for resources. | <code>string</code> | ✓ | |
|
|
| [dead_letter_configs](variables.tf#L17) | Per-subscription dead letter policy configuration. | <code title="map(object({ topic = string max_delivery_attempts = number }))">map(object({…}))</code> | | <code>{}</code> |
|
|
| [defaults](variables.tf#L26) | Subscription defaults for options. | <code title="object({ ack_deadline_seconds = number message_retention_duration = string retain_acked_messages = bool expiration_policy_ttl = string filter = string })">object({…})</code> | | <code title="{ ack_deadline_seconds = null message_retention_duration = null retain_acked_messages = null expiration_policy_ttl = null filter = null }">{…}</code> |
|
|
| [iam](variables.tf#L44) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
|
| [kms_key](variables.tf#L50) | KMS customer managed encryption key. | <code>string</code> | | <code>null</code> |
|
|
| [labels](variables.tf#L56) | Labels. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [push_configs](variables.tf#L72) | Push subscription configurations. | <code title="map(object({ attributes = map(string) endpoint = string oidc_token = object({ audience = string service_account_email = string }) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
| [regions](variables.tf#L85) | List of regions used to set persistence policy. | <code>list(string)</code> | | <code>[]</code> |
|
|
| [subscription_iam](variables.tf#L91) | IAM bindings for subscriptions in {SUBSCRIPTION => {ROLE => [MEMBERS]}} format. | <code>map(map(list(string)))</code> | | <code>{}</code> |
|
|
| [subscriptions](variables.tf#L97) | Topic subscriptions. Also define push configs for push subscriptions. If options is set to null subscription defaults will be used. Labels default to topic labels if set to null. | <code title="map(object({ labels = map(string) options = object({ ack_deadline_seconds = number message_retention_duration = string retain_acked_messages = bool expiration_policy_ttl = string filter = string }) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [id](outputs.tf#L17) | Topic id. | |
|
|
| [subscription_id](outputs.tf#L25) | Subscription ids. | |
|
|
| [subscriptions](outputs.tf#L35) | Subscription resources. | |
|
|
| [topic](outputs.tf#L43) | Topic resource. | |
|
|
|
|
<!-- END TFDOC -->
|