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-vm-instance-template
  annotations:
    config.kubernetes.io/local-config: "true"
spec:
  info:
    title: instance_template
    source:
      repo: https://github.com/terraform-google-modules/terraform-google-vm
      sourceType: git
      dir: /modules/instance_template
    version: 12.1.2
    actuationTool:
      flavor: Terraform
      version: ">=1.3"
    description: {}
  content:
    examples:
      - name: additional_disks
        location: examples/instance_template/additional_disks
      - name: alias_ip_range
        location: examples/instance_template/alias_ip_range
      - name: autoscaler
        location: examples/mig/autoscaler
      - name: confidential_computing
        location: examples/confidential_computing
      - name: confidential_computing
        location: examples/instance_template/confidential_computing
      - name: confidential_computing_intel
        location: examples/confidential_computing_intel
      - name: disk_snapshot
        location: examples/compute_instance/disk_snapshot
      - name: encrypted_disks
        location: examples/instance_template/encrypted_disks
      - name: full
        location: examples/mig/full
      - name: full
        location: examples/umig/full
      - name: healthcheck
        location: examples/mig/healthcheck
      - name: mig_stateful
        location: examples/mig_stateful
      - name: multiple_interfaces
        location: examples/compute_instance/multiple_interfaces
      - name: named_ports
        location: examples/umig/named_ports
      - name: next_hop
        location: examples/compute_instance/next_hop
      - name: simple
        location: examples/compute_instance/simple
      - name: simple
        location: examples/instance_template/simple
      - name: simple
        location: examples/mig/simple
      - name: simple
        location: examples/mig_with_percent/simple
      - name: simple
        location: examples/preemptible_and_regular_instance_templates/simple
      - name: simple
        location: examples/umig/simple
      - name: static_ips
        location: examples/umig/static_ips
      - name: tags
        location: examples/compute_instance/tags
  interfaces:
    variables:
      - name: project_id
        description: The GCP project ID
        varType: string
      - name: region
        description: Region where the instance template should be created.
        varType: string
      - name: name_prefix
        description: Name prefix for the instance template
        varType: string
        defaultValue: default-instance-template
      - name: machine_type
        description: Machine type to create, e.g. n1-standard-1
        varType: string
        defaultValue: n1-standard-1
      - name: spot
        description: Provision a SPOT instance
        varType: bool
        defaultValue: false
      - name: description
        description: The template's description
        varType: string
        defaultValue: ""
      - name: instance_description
        description: Description of the generated instances
        varType: string
        defaultValue: ""
      - name: min_cpu_platform
        description: "Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list: https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform"
        varType: string
      - name: can_ip_forward
        description: Enable IP forwarding, for NAT instances for example
        varType: string
        defaultValue: "false"
      - name: tags
        description: Network tags, provided as a list
        varType: list(string)
        defaultValue: []
      - name: labels
        description: Labels, provided as a map
        varType: map(string)
        defaultValue: {}
      - name: preemptible
        description: Allow the instance to be preempted
        varType: bool
        defaultValue: false
      - name: automatic_restart
        description: (Optional) Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
        varType: bool
        defaultValue: true
      - name: maintenance_interval
        description: Specifies the frequency of planned maintenance events
        varType: string
      - name: on_host_maintenance
        description: Instance availability Policy
        varType: string
        defaultValue: MIGRATE
      - name: spot_instance_termination_action
        description: Action to take when Compute Engine preempts a Spot VM.
        varType: string
        defaultValue: STOP
      - name: enable_nested_virtualization
        description: Defines whether the instance should have nested virtualization enabled.
        varType: bool
        defaultValue: false
      - name: threads_per_core
        description: The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1.
        varType: number
      - name: resource_policies
        description: A list of self_links of resource policies to attach to the instance. Modifying this list will cause the instance to recreate. Currently a max of 1 resource policy is supported.
        varType: list(string)
        defaultValue: []
      - name: source_image
        description: Source disk image. If neither source_image nor source_image_family is specified, defaults to the latest public Rocky Linux 9 optimized for GCP image.
        varType: string
        defaultValue: ""
      - name: source_image_family
        description: Source image family. If neither source_image nor source_image_family is specified, defaults to the latest public Rocky Linux 9 optimized for GCP image.
        varType: string
        defaultValue: rocky-linux-9-optimized-gcp
      - name: source_image_project
        description: Project where the source image comes from. The default project contains Rocky Linux images.
        varType: string
        defaultValue: rocky-linux-cloud
      - name: disk_size_gb
        description: Boot disk size in GB
        varType: string
        defaultValue: "100"
      - name: disk_type
        description: Boot disk type, can be either pd-ssd, local-ssd, or pd-standard
        varType: string
        defaultValue: pd-standard
      - name: disk_labels
        description: Labels to be assigned to boot disk, provided as a map
        varType: map(string)
        defaultValue: {}
      - name: disk_encryption_key
        description: The id of the encryption key that is stored in Google Cloud KMS to use to encrypt all the disks on this instance
        varType: string
      - name: auto_delete
        description: Whether or not the boot disk should be auto-deleted
        varType: string
        defaultValue: "true"
      - name: additional_disks
        description: List of maps of additional disks. See https://www.terraform.io/docs/providers/google/r/compute_instance_template#disk_name
        varType: |-
          list(object({
              auto_delete     = optional(bool, true)
              boot            = optional(bool, false)
              device_name     = optional(string)
              disk_name       = optional(string)
              disk_size_gb    = optional(number)
              disk_type       = optional(string)
              disk_labels     = optional(map(string), {})
              interface       = optional(string)
              mode            = optional(string)
              source          = optional(string)
              source_image    = optional(string)
              source_snapshot = optional(string)
            }))
        defaultValue: []
      - name: disk_resource_policies
        description: A list (short name or id) of resource policies to attach to this disk for automatic snapshot creations
        varType: list(string)
        defaultValue: []
      - name: network
        description: The name or self_link of the network to attach this interface to. Use network attribute for Legacy or Auto subnetted networks and subnetwork for custom subnetted networks.
        varType: string
        defaultValue: ""
      - name: subnetwork
        description: The name of the subnetwork to attach this interface to. The subnetwork must exist in the same region this instance will be created in. Either network or subnetwork must be provided.
        varType: string
        defaultValue: ""
      - name: subnetwork_project
        description: The ID of the project in which the subnetwork belongs. If it is not provided, the provider project is used.
        varType: string
        defaultValue: ""
      - name: network_ip
        description: Private IP address to assign to the instance if desired.
        varType: string
        defaultValue: ""
      - name: nic_type
        description: Valid values are "VIRTIO_NET", "GVNIC" or set to null to accept API default behavior.
        varType: string
      - name: stack_type
        description: The stack type for this network interface to identify whether the IPv6 feature is enabled or not. Values are `IPV4_IPV6` or `IPV4_ONLY`. Default behavior is equivalent to IPV4_ONLY.
        varType: string
      - name: additional_networks
        description: Additional network interface details for GCE, if any.
        varType: |-
          list(object({
              network            = string
              subnetwork         = string
              subnetwork_project = string
              network_ip         = string
              nic_type           = string
              stack_type         = string
              queue_count        = number
              access_config = list(object({
                nat_ip       = string
                network_tier = string
              }))
              ipv6_access_config = list(object({
                network_tier = string
              }))
              alias_ip_range = list(object({
                ip_cidr_range         = string
                subnetwork_range_name = string
              }))
            }))
        defaultValue: []
      - name: total_egress_bandwidth_tier
        description: Egress bandwidth tier setting for supported VM families
        varType: string
        defaultValue: DEFAULT
      - name: startup_script
        description: User startup script to run when instances spin up
        varType: string
        defaultValue: ""
      - name: metadata
        description: Metadata, provided as a map
        varType: map(string)
        defaultValue: {}
        connections:
          - source:
              source: github.com/terraform-google-modules/terraform-google-memorystore
              version: ">= 12.0"
            spec:
              outputExpr: "{\"REDIS_HOST\": host, \"REDIS_PORT\": port}"
          - source:
              source: github.com/terraform-google-modules/terraform-google-sql-db//modules/postgresql
              version: ">= 23.0"
            spec:
              outputExpr: "{\"CLOUD_SQL_DATABASE_HOST\" : instance_first_ip_address, \"CLOUD_SQL_DATABASE_CONNECTION_NAME\" : instance_connection_name, \"CLOUD_SQL_DATABASE_NAME\" : env_vars.CLOUD_SQL_DATABASE_NAME}"
          - source:
              source: github.com/terraform-google-modules/terraform-google-sql-db//modules/mysql
              version: ">= 23.0"
            spec:
              outputExpr: "{\"CLOUD_SQL_DATABASE_HOST\" : instance_first_ip_address, \"CLOUD_SQL_DATABASE_CONNECTION_NAME\" : instance_connection_name, \"CLOUD_SQL_DATABASE_NAME\" : env_vars.CLOUD_SQL_DATABASE_NAME}"
          - source:
              source: github.com/terraform-google-modules/terraform-google-service-accounts//modules/simple-sa
              version: ">= 4.4"
            spec:
              outputExpr: "{\"SERVICE_ACCOUNT_EMAIL\" : email, \"SERVICE_ACCOUNT_IAM_EMAIL\" : iam_email}"
      - name: service_account
        description: Service account to attach to the instance. See https://www.terraform.io/docs/providers/google/r/compute_instance_template#service_account.
        varType: |-
          object({
              email  = string
              scopes = optional(set(string), ["cloud-platform"])
            })
        required: true
        connections:
          - source:
              source: github.com/terraform-google-modules/terraform-google-service-accounts//modules/simple-sa
              version: ">= 4.4"
            spec:
              outputExpr: email
              inputPath: email
      - name: enable_shielded_vm
        description: Whether to enable the Shielded VM configuration on the instance. Note that the instance image must support Shielded VMs. See https://cloud.google.com/compute/docs/images
        varType: bool
        defaultValue: false
      - name: shielded_instance_config
        description: Not used unless enable_shielded_vm is true. Shielded VM configuration for the instance.
        varType: |-
          object({
              enable_secure_boot          = bool
              enable_vtpm                 = bool
              enable_integrity_monitoring = bool
            })
        defaultValue:
          enable_integrity_monitoring: true
          enable_secure_boot: true
          enable_vtpm: true
      - name: enable_confidential_vm
        description: Whether to enable the Confidential VM configuration on the instance. Note that the instance image must support Confidential VMs. See https://cloud.google.com/compute/docs/images
        varType: bool
        defaultValue: false
      - name: confidential_instance_type
        description: Defines the confidential computing technology the instance uses. If this is set to "SEV_SNP", var.min_cpu_platform will be automatically set to "AMD Milan". See https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_instance#confidential_instance_type.
        varType: string
      - name: access_config
        description: Access configurations, i.e. IPs via which the VM instance can be accessed via the Internet.
        varType: |-
          list(object({
              nat_ip       = string
              network_tier = string
            }))
        defaultValue: []
      - name: ipv6_access_config
        description: IPv6 access configurations. Currently a max of 1 IPv6 access configuration is supported. If not specified, the instance will have no external IPv6 Internet access.
        varType: |-
          list(object({
              network_tier = string
            }))
        defaultValue: []
      - name: gpu
        description: GPU information. Type and count of GPU to attach to the instance template. See https://cloud.google.com/compute/docs/gpus more details
        varType: |-
          object({
              type  = string
              count = number
            })
      - name: alias_ip_range
        description: |
          An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
          ip_cidr_range: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. At the time of writing only a netmask (e.g. /24) may be supplied, with a CIDR format resulting in an API error.
          subnetwork_range_name: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
        varType: |-
          object({
              ip_cidr_range         = string
              subnetwork_range_name = string
            })
    outputs:
      - name: name
        description: Name of instance template
        type: string
      - name: self_link
        description: Self-link of instance template
        type: string
      - name: self_link_unique
        description: Unique self-link of instance template (recommended output to use instead of self_link)
        type: string
      - name: tags
        description: Tags that will be associated with instance(s)
        type:
          - list
          - string
  requirements:
    roles:
      - level: Project
        roles:
          - roles/owner
          - roles/compute.admin
          - roles/compute.networkAdmin
          - roles/iam.serviceAccountUser
          - roles/compute.instanceAdmin
    services:
      - cloudresourcemanager.googleapis.com
      - storage-api.googleapis.com
      - serviceusage.googleapis.com
      - compute.googleapis.com
      - iam.googleapis.com
    providerVersions:
      - source: hashicorp/google-beta
        version: ">= 5.36, < 7"