Skip to content

feat(pubsub): support global default labels merged with subscription-specific labels #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(pubsub): support global default labels merged with subscription-specific labels #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04f0a0e
feature/add-default-and-custom-subscription-labels
fbtravi Aug 29, 2025
0ccad96
Merge branch 'main' into feature/add-default-and-custom-subscription-…
fbtravi Sep 23, 2025
524f7fa
Merge branch 'main' into feature/add-default-and-custom-subscription-…
fbtravi Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ module "pubsub" {
maximum_backoff = "600s" // optional
minimum_backoff = "300s" // optional
filter = "attributes.domain = \"com\"" // optional
enable_message_ordering = true // optional
enable_message_ordering = true
labels = { environment = "dev"} // optional
}
]
pull_subscriptions = [
Expand Down Expand Up @@ -84,17 +85,17 @@ module "pubsub" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| bigquery\_subscriptions | The list of the Bigquery push subscriptions. | <pre>list(object({<br> name = string,<br> table = string,<br> use_topic_schema = optional(bool),<br> use_table_schema = optional(bool),<br> write_metadata = optional(bool),<br> drop_unknown_fields = optional(bool),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string)<br> }))</pre> | `[]` | no |
| cloud\_storage\_subscriptions | The list of the Cloud Storage push subscriptions. | <pre>list(object({<br> name = string,<br> bucket = string,<br> filename_prefix = optional(string),<br> filename_suffix = optional(string),<br> filename_datetime_format = optional(string),<br> max_duration = optional(string),<br> max_bytes = optional(string),<br> max_messages = optional(string),<br> output_format = optional(string),<br> write_metadata = optional(bool),<br> use_topic_schema = optional(bool),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string)<br> }))</pre> | `[]` | no |
| bigquery\_subscriptions | The list of the Bigquery push subscriptions. | <pre>list(object({<br> name = string,<br> table = string,<br> use_topic_schema = optional(bool),<br> use_table_schema = optional(bool),<br> write_metadata = optional(bool),<br> drop_unknown_fields = optional(bool),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> labels = optional(map(string)),<br> }))</pre> | `[]` | no |
| cloud\_storage\_subscriptions | The list of the Cloud Storage push subscriptions. | <pre>list(object({<br> name = string,<br> bucket = string,<br> filename_prefix = optional(string),<br> filename_suffix = optional(string),<br> filename_datetime_format = optional(string),<br> max_duration = optional(string),<br> max_bytes = optional(string),<br> max_messages = optional(string),<br> output_format = optional(string),<br> write_metadata = optional(bool),<br> use_topic_schema = optional(bool),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> labels = optional(map(string)),<br> }))</pre> | `[]` | no |
| create\_subscriptions | Specify true if you want to create subscriptions. | `bool` | `true` | no |
| create\_topic | Specify true if you want to create a topic. | `bool` | `true` | no |
| grant\_bigquery\_project\_roles | Specify true if you want to add bigquery.metadataViewer and bigquery.dataEditor roles to the default Pub/Sub SA. | `bool` | `true` | no |
| grant\_cloud\_storage\_project\_roles | Specify true if you want to add storage.admin role to the default Pub/Sub SA. | `bool` | `true` | no |
| grant\_token\_creator | Specify true if you want to add token creator role to the default Pub/Sub SA. | `bool` | `true` | no |
| message\_storage\_policy | A map of storage policies. Default - inherit from organization's Resource Location Restriction policy. | `map(any)` | `{}` | no |
| project\_id | The project ID to manage the Pub/Sub resources. | `string` | n/a | yes |
| pull\_subscriptions | The list of the pull subscriptions. | <pre>list(object({<br> name = string,<br> ack_deadline_seconds = optional(number),<br> expiration_policy = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> filter = optional(string),<br> enable_message_ordering = optional(bool),<br> service_account = optional(string),<br> enable_exactly_once_delivery = optional(bool),<br> }))</pre> | `[]` | no |
| push\_subscriptions | The list of the push subscriptions. | <pre>list(object({<br> name = string,<br> ack_deadline_seconds = optional(number),<br> push_endpoint = optional(string),<br> x-goog-version = optional(string),<br> oidc_service_account_email = optional(string),<br> audience = optional(string),<br> expiration_policy = optional(string),<br> dead_letter_topic = optional(string),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> filter = optional(string),<br> enable_message_ordering = optional(bool),<br> no_wrapper = optional(bool),<br> write_metadata = optional(bool),<br> }))</pre> | `[]` | no |
| pull\_subscriptions | The list of the pull subscriptions. | <pre>list(object({<br> name = string,<br> ack_deadline_seconds = optional(number),<br> expiration_policy = optional(string),<br> dead_letter_topic = optional(string),<br> max_delivery_attempts = optional(number),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> filter = optional(string),<br> enable_message_ordering = optional(bool),<br> service_account = optional(string),<br> enable_exactly_once_delivery = optional(bool),<br> labels = optional(map(string)),<br> }))</pre> | `[]` | no |
| push\_subscriptions | The list of the push subscriptions. | <pre>list(object({<br> name = string,<br> ack_deadline_seconds = optional(number),<br> push_endpoint = optional(string),<br> x-goog-version = optional(string),<br> oidc_service_account_email = optional(string),<br> audience = optional(string),<br> expiration_policy = optional(string),<br> dead_letter_topic = optional(string),<br> retain_acked_messages = optional(bool),<br> message_retention_duration = optional(string),<br> max_delivery_attempts = optional(number),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(string),<br> filter = optional(string),<br> enable_message_ordering = optional(bool),<br> no_wrapper = optional(bool),<br> write_metadata = optional(bool),<br> labels = optional(map(string)),<br>}))</pre> | `[]` | no |
| schema | Schema for the topic. | <pre>object({<br> name = string<br> type = string<br> definition = string<br> encoding = string<br> })</pre> | `null` | no |
| subscription\_labels | A map of labels to assign to every Pub/Sub subscription. | `map(string)` | `{}` | no |
| topic | The Pub/Sub topic name. | `string` | n/a | yes |
Expand Down
11 changes: 7 additions & 4 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,13 @@ resource "google_pubsub_topic" "topic" {
resource "google_pubsub_subscription" "push_subscriptions" {
for_each = var.create_subscriptions ? { for i in var.push_subscriptions : i.name => i } : {}

name = each.value.name
topic = var.create_topic ? google_pubsub_topic.topic[0].name : var.topic
project = var.project_id
labels = var.subscription_labels
name = each.value.name
topic = var.create_topic ? google_pubsub_topic.topic[0].name : var.topic
project = var.project_id
labels = merge(
var.subscription_labels, # global default labels
lookup(each.value, "labels", {}) # subscription-specific labels
)
ack_deadline_seconds = each.value.ack_deadline_seconds != null ? each.value.ack_deadline_seconds : local.default_ack_deadline_seconds
message_retention_duration = each.value.message_retention_duration
retain_acked_messages = each.value.retain_acked_messages
Expand Down
8 changes: 6 additions & 2 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ variable "push_subscriptions" {
enable_message_ordering = optional(bool),
no_wrapper = optional(bool),
write_metadata = optional(bool),
labels = optional(map(string)),
}))
description = "The list of the push subscriptions."
default = []
Expand All @@ -80,6 +81,7 @@ variable "pull_subscriptions" {
enable_message_ordering = optional(bool),
service_account = optional(string),
enable_exactly_once_delivery = optional(bool),
labels = optional(map(string)),
}))
description = "The list of the pull subscriptions."
default = []
Expand All @@ -102,7 +104,8 @@ variable "bigquery_subscriptions" {
dead_letter_topic = optional(string),
max_delivery_attempts = optional(number),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
minimum_backoff = optional(string),
labels = optional(map(string)),
}))
description = "The list of the Bigquery push subscriptions."
default = []
Expand Down Expand Up @@ -130,7 +133,8 @@ variable "cloud_storage_subscriptions" {
dead_letter_topic = optional(string),
max_delivery_attempts = optional(number),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
minimum_backoff = optional(string),
labels = optional(map(string)),
}))
description = "The list of the Cloud Storage push subscriptions."
default = []
Expand Down