metadata.yaml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintMetadata
metadata:
  name: terraform-google-pubsub
  annotations:
    config.kubernetes.io/local-config: "true"
spec:
  info:
    title: terraform-google-pubsub
    source:
      repo: https://github.com/terraform-google-modules/terraform-google-pubsub
      sourceType: git
    version: 7.0.0
    actuationTool:
      flavor: Terraform
      version: ">= 0.13"
    description: {}
  content:
    examples:
      - name: bigquery
        location: examples/bigquery
      - name: cloud_storage
        location: examples/cloud_storage
      - name: kms
        location: examples/kms
      - name: simple
        location: examples/simple
      - name: subscriptions_only
        location: examples/subscriptions_only
  interfaces:
    variables:
      - name: project_id
        description: The project ID to manage the Pub/Sub resources.
        varType: string
        required: true
      - name: topic
        description: The Pub/Sub topic name.
        varType: string
        required: true
      - name: create_topic
        description: Specify true if you want to create a topic.
        varType: bool
        defaultValue: true
      - name: create_subscriptions
        description: Specify true if you want to create subscriptions.
        varType: bool
        defaultValue: true
      - name: topic_labels
        description: A map of labels to assign to the Pub/Sub topic.
        varType: map(string)
        defaultValue: {}
      - name: push_subscriptions
        description: The list of the push subscriptions.
        varType: list(map(string))
        defaultValue: []
      - name: pull_subscriptions
        description: The list of the pull subscriptions.
        varType: list(map(string))
        defaultValue: []
      - name: bigquery_subscriptions
        description: The list of the Bigquery push subscriptions.
        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(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)
        defaultValue: {}
      - name: topic_message_retention_duration
        description: The minimum duration in seconds to retain a message after it is published to the topic.
        varType: string
      - name: message_storage_policy
        description: A map of storage policies. Default - inherit from organization's Resource Location Restriction policy.
        varType: map(any)
        defaultValue: {}
      - name: topic_kms_key_name
        description: The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
        varType: string
      - name: grant_bigquery_project_roles
        description: Specify true if you want to add bigquery.metadataViewer and bigquery.dataEditor roles to the default Pub/Sub SA.
        varType: bool
        defaultValue: true
      - name: grant_token_creator
        description: Specify true if you want to add token creator role to the default Pub/Sub SA.
        varType: bool
        defaultValue: true
      - name: schema
        description: Schema for the topic.
        varType: |-
          object({
              name       = string
              type       = string
              definition = string
              encoding   = string
            })
    outputs:
      - name: id
        description: The ID of the Pub/Sub topic
        type: string
      - name: subscription_names
        description: The name list of Pub/Sub subscriptions
        type:
          - tuple
          - []
      - name: subscription_paths
        description: The path list of Pub/Sub subscriptions
        type:
          - tuple
          - []
      - name: topic
        description: The name of the Pub/Sub topic
        type: string
      - name: topic_labels
        description: Labels assigned to the Pub/Sub topic
      - name: uri
        description: The URI of the Pub/Sub topic
        type: string
  requirements:
    roles:
      - level: Project
        roles:
          - roles/pubsub.admin
          - roles/resourcemanager.projectIamAdmin
          - roles/bigquery.admin
          - roles/storage.admin
    services:
      - cloudresourcemanager.googleapis.com
      - pubsub.googleapis.com
      - serviceusage.googleapis.com
      - bigquery.googleapis.com
      - storage.googleapis.com
    providerVersions:
      - source: hashicorp/google
        version: ">= 6.2, < 7"