113 lines
4.7 KiB
Markdown
113 lines
4.7 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"]
|
|
}
|
|
}
|
|
```
|
|
|
|
### 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
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### 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
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### 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"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---: |:---:|:---:|
|
|
| name | PubSub topic name. | <code title="">string</code> | ✓ | |
|
|
| project_id | Project used for resources. | <code title="">string</code> | ✓ | |
|
|
| *dead_letter_configs* | Per-subscription dead letter policy configuration. | <code title="map(object({ topic = string max_delivery_attemps = number }))">map(object({...}))</code> | | <code title="">{}</code> |
|
|
| *defaults* | Subscription defaults for options. | <code title="object({ ack_deadline_seconds = number message_retention_duration = number retain_acked_messages = bool expiration_policy_ttl = string })">object({...})</code> | | <code title="{ ack_deadline_seconds = null message_retention_duration = null retain_acked_messages = null expiration_policy_ttl = null }">...</code> |
|
|
| *iam* | IAM bindings for topic in {ROLE => [MEMBERS]} format. | <code title="map(list(string))">map(list(string))</code> | | <code title="">{}</code> |
|
|
| *kms_key* | KMS customer managed encryption key. | <code title="">string</code> | | <code title="">null</code> |
|
|
| *labels* | Labels. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
|
| *push_configs* | 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 title="">{}</code> |
|
|
| *regions* | List of regions used to set persistence policy. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
| *subscription_iam* | IAM bindings for subscriptions in {SUBSCRIPTION => {ROLE => [MEMBERS]}} format. | <code title="map(map(list(string)))">map(map(list(string)))</code> | | <code title="">{}</code> |
|
|
| *subscriptions* | 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 = number retain_acked_messages = bool expiration_policy_ttl = string }) }))">map(object({...}))</code> | | <code title="">{}</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| id | Topic id. | |
|
|
| subscription_id | Subscription ids. | |
|
|
| subscriptions | Subscription resources. | |
|
|
| topic | Topic resource. | |
|
|
<!-- END TFDOC -->
|