Skip to content

chore: add connection metadata #222

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

Merged
merged 15 commits into from
Feb 7, 2025
Merged

chore: add connection metadata #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c9501c4
chore: add output type metada
ktinubu Jan 24, 2025
1e581d9
enable metadata for lint generate docs docker commands
ktinubu Jan 24, 2025
b671424
chore: add connection metadata
ktinubu Jan 28, 2025
e43ada3
fix connections, change bq sub to list(object))
ktinubu Jan 28, 2025
c429a99
fix
ktinubu Jan 28, 2025
d41828a
fix: add generic subscription configs to bq and cloud storage sub inputs
ktinubu Jan 29, 2025
91ef367
fix
ktinubu Jan 29, 2025
ca24340
fix
ktinubu Jan 29, 2025
89bedde
Merge branch 'main' into chore/add-connection-metadata
ktinubu Jan 31, 2025
0e18976
Merge branch 'main' into chore/add-connection-metadata
ktinubu Jan 31, 2025
b5ec326
use correct name format for bq table and kms key
ktinubu Jan 31, 2025
b83bab9
use external_table_ids for bq table connection
ktinubu Feb 4, 2025
7dd9b36
remove topic_kms_key_name connection
ktinubu Feb 4, 2025
65e6ed2
Require bigquery version 10.0.0 for connection metadata
ktinubu Feb 4, 2025
409a54b
use `=` instead of `:` for object variables
ktinubu Feb 7, 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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ module "pubsub" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| bigquery\_subscriptions | The list of the Bigquery push subscriptions. | `list(map(string))` | `[]` | no |
| cloud\_storage\_subscriptions | The list of the Cloud Storage push subscriptions. | `list(map(string))` | `[]` | 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, true),<br> use_table_schema = optional(bool, false),<br> write_metadata = optional(bool, false),<br> drop_unknown_fields = optional(bool, false),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool, false),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool, false),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<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, false),<br> use_topic_schema = optional(bool, false),<br> ack_deadline_seconds = optional(number),<br> retain_acked_messages = optional(bool, false),<br> message_retention_duration = optional(string),<br> enable_message_ordering = optional(bool, false),<br> expiration_policy = optional(string),<br> filter = optional(string),<br> dead_letter_topic = optional(string),<br> maximum_backoff = optional(string),<br> minimum_backoff = optional(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 |
Expand Down
10 changes: 5 additions & 5 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ resource "google_pubsub_topic_iam_member" "pull_topic_binding" {
}

resource "google_pubsub_topic_iam_member" "bigquery_topic_binding" {
for_each = var.create_topic ? { for i in var.bigquery_subscriptions : i.name => i if try(i.dead_letter_topic, "") != "" } : {}
for_each = var.create_topic ? { for i in var.bigquery_subscriptions : i.name => i if i.dead_letter_topic != null } : {}

project = var.project_id
topic = each.value.dead_letter_topic
Expand Down Expand Up @@ -345,14 +345,14 @@ resource "google_pubsub_subscription" "bigquery_subscriptions" {
)
dynamic "expiration_policy" {
// check if the 'expiration_policy' key exists, if yes, return a list containing it.
for_each = contains(keys(each.value), "expiration_policy") ? [each.value.expiration_policy] : []
for_each = each.value.expiration_policy != null ? [each.value.expiration_policy] : []
content {
ttl = expiration_policy.value
}
}

dynamic "dead_letter_policy" {
for_each = (lookup(each.value, "dead_letter_topic", "") != "") ? [each.value.dead_letter_topic] : []
for_each = each.value.dead_letter_topic != null ? [each.value.dead_letter_topic] : []
content {
dead_letter_topic = lookup(each.value, "dead_letter_topic", "")
max_delivery_attempts = lookup(each.value, "max_delivery_attempts", "5")
Expand Down Expand Up @@ -416,14 +416,14 @@ resource "google_pubsub_subscription" "cloud_storage_subscriptions" {
)
dynamic "expiration_policy" {
// check if the 'expiration_policy' key exists, if yes, return a list containing it.
for_each = contains(keys(each.value), "expiration_policy") ? [each.value.expiration_policy] : []
for_each = each.value.expiration_policy != null ? [each.value.expiration_policy] : []
content {
ttl = expiration_policy.value
}
}

dynamic "dead_letter_policy" {
for_each = (lookup(each.value, "dead_letter_topic", "") != "") ? [each.value.dead_letter_topic] : []
for_each = each.value.dead_letter_topic != null ? [each.value.dead_letter_topic] : []
content {
dead_letter_topic = lookup(each.value, "dead_letter_topic", "")
max_delivery_attempts = lookup(each.value, "max_delivery_attempts", "5")
Expand Down
57 changes: 55 additions & 2 deletions metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,65 @@ spec:
defaultValue: []
- name: bigquery_subscriptions
description: The list of the Bigquery push subscriptions.
varType: list(map(string))
varType: |-
list(object({
name = string,
table = string,
use_topic_schema = optional(bool, true),
use_table_schema = optional(bool, false),
write_metadata = optional(bool, false),
drop_unknown_fields = optional(bool, false),
ack_deadline_seconds = optional(number),
retain_acked_messages = optional(bool, false),
message_retention_duration = optional(string),
enable_message_ordering = optional(bool, false),
expiration_policy = optional(string),
filter = optional(string),
dead_letter_topic = optional(string),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
}))
defaultValue: []
connections:
- source:
source: github.com/terraform-google-modules/terraform-google-bigquery
version: ">= 10.0.0"
spec:
outputExpr: external_table_ids[0]
inputPath: table
- name: cloud_storage_subscriptions
description: The list of the Cloud Storage push subscriptions.
varType: list(map(string))
varType: |-
list(object({
name = string,
bucket = string,
filename_prefix = optional(string),
filename_suffix = optional(string),
filename_datetime_format = optional(string),
max_duration = optional(string),
max_bytes = optional(string),
max_messages = optional(string),
output_format = optional(string),
write_metadata = optional(bool, false),
use_topic_schema = optional(bool, false),
ack_deadline_seconds = optional(number),
retain_acked_messages = optional(bool, false),
message_retention_duration = optional(string),
enable_message_ordering = optional(bool, false),
expiration_policy = optional(string),
filter = optional(string),
dead_letter_topic = optional(string),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
}))
defaultValue: []
connections:
- source:
source: github.com/terraform-google-modules/terraform-google-cloud-storage//modules/simple_bucket
version: ">= 9.0.1"
spec:
outputExpr: name
inputPath: bucket
- name: subscription_labels
description: A map of labels to assign to every Pub/Sub subscription.
varType: map(string)
Expand Down
41 changes: 39 additions & 2 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,50 @@ variable "pull_subscriptions" {
}

variable "bigquery_subscriptions" {
type = list(map(string))
type = list(object({
name = string,
table = string,
use_topic_schema = optional(bool, true),
use_table_schema = optional(bool, false),
write_metadata = optional(bool, false),
drop_unknown_fields = optional(bool, false),
ack_deadline_seconds = optional(number),
retain_acked_messages = optional(bool, false),
message_retention_duration = optional(string),
enable_message_ordering = optional(bool, false),
expiration_policy = optional(string),
filter = optional(string),
dead_letter_topic = optional(string),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
}))
description = "The list of the Bigquery push subscriptions."
default = []
}

variable "cloud_storage_subscriptions" {
type = list(map(string))
type = list(object({
name = string,
bucket = string,
filename_prefix = optional(string),
filename_suffix = optional(string),
filename_datetime_format = optional(string),
max_duration = optional(string),
max_bytes = optional(string),
max_messages = optional(string),
output_format = optional(string),
write_metadata = optional(bool, false),
use_topic_schema = optional(bool, false),
ack_deadline_seconds = optional(number),
retain_acked_messages = optional(bool, false),
message_retention_duration = optional(string),
enable_message_ordering = optional(bool, false),
expiration_policy = optional(string),
filter = optional(string),
dead_letter_topic = optional(string),
maximum_backoff = optional(string),
minimum_backoff = optional(string)
}))
description = "The list of the Cloud Storage push subscriptions."
default = []
}
Expand Down