metadata.yaml

# Copyright 2024 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-cloud-router
  annotations:
    config.kubernetes.io/local-config: "true"
spec:
  info:
    source:
      repo: https://github.com/terraform-google-modules/terraform-google-cloud-router.git
      sourceType: git
    version: 6.2.0
    actuationTool:
      flavor: Terraform
      version: ">= 1.3"
    description: {}
  content:
    subBlueprints:
      - name: interconnect_attachment
        location: modules/interconnect_attachment
      - name: interface
        location: modules/interface
    examples:
      - name: interconnect_attachment
        location: examples/interconnect_attachment
      - name: nat
        location: examples/nat
      - name: simple_example
        location: examples/simple_example
  interfaces:
    variables:
      - name: bgp
        description: BGP information specific to this router.
        varType: |-
          object({
              asn               = string
              advertise_mode    = optional(string, "CUSTOM")
              advertised_groups = optional(list(string))
              advertised_ip_ranges = optional(list(object({
                range       = string
                description = optional(string)
              })), [])
              keepalive_interval = optional(number)
            })
      - name: description
        description: An optional description of this resource
        varType: string
      - name: name
        description: Name of the router
        varType: string
        required: true
      - name: nats
        description: NATs to deploy on this router.
        varType: |-
          list(object({
              name                                = string
              nat_ip_allocate_option              = optional(string)
              source_subnetwork_ip_ranges_to_nat  = optional(string)
              nat_ips                             = optional(list(string), [])
              min_ports_per_vm                    = optional(number)
              max_ports_per_vm                    = optional(number)
              udp_idle_timeout_sec                = optional(number)
              icmp_idle_timeout_sec               = optional(number)
              tcp_established_idle_timeout_sec    = optional(number)
              tcp_transitory_idle_timeout_sec     = optional(number)
              tcp_time_wait_timeout_sec           = optional(number)
              enable_endpoint_independent_mapping = optional(bool)
              enable_dynamic_port_allocation      = optional(bool)

              log_config = optional(object({
                enable = optional(bool, true)
                filter = optional(string, "ALL")
              }), {})

              subnetworks = optional(list(object({
                name                     = string
                source_ip_ranges_to_nat  = list(string)
                secondary_ip_range_names = optional(list(string))
              })), [])

            }))
        defaultValue: []
      - name: network
        description: A reference to the network to which this router belongs
        varType: string
        required: true
      - name: project
        description: The project ID to deploy to
        varType: string
        required: true
      - name: region
        description: Region where the router resides
        varType: string
        required: true
    outputs:
      - name: nat
        description: Created NATs
      - name: router
        description: Created Router
  requirements:
    roles:
      - level: Project
        roles:
          - roles/owner
    services:
      - cloudresourcemanager.googleapis.com
      - serviceusage.googleapis.com
      - compute.googleapis.com