Allow user to provide custom labels and metadata

Provides parameters for lables and metadata that the user can provide
and have merged atop those interally generated.

Author: ody

main.tf

@@ -90,7 +90,6 @@ locals {
   create_network = var.subnet == null ? true : false
   fetch_existing = var.subnet == null ? 0 : 1
   has_lb         = var.disable_lb ? false : data.hiera5_bool.has_compilers.value ? true : false
-  labels         = merge(var.labels, { "stack" = var.stack_name })
 }
 
 # If we didn't create a network then we need to know the network of our
@@ -136,7 +135,8 @@ module "instances" {
   compiler_count     = local.compiler_count
   node_count         = var.node_count
   instance_image     = var.instance_image
-  labels             = local.labels
+  labels             = var.labels
+  metadata           = var.metadata
   project            = var.project
   server_count       = data.hiera5.server_count.value
   database_count     = data.hiera5.database_count.value

modules/instances/main.tf

@@ -1,3 +1,10 @@
+locals {
+  metadata = merge({
+    "ssh-keys"     = "${var.user}:${file(var.ssh_key)}"
+    "VmDnsSetting" = "ZonalPreferred"
+  }, var.metadata)
+}
+
 # PE server instance(s) depending on if a replica is provisioned or not
 resource "google_compute_instance" "server" {
   name         = "pe-server-${var.id}-${count.index}"
@@ -8,11 +15,9 @@ resource "google_compute_instance" "server" {
   # Constructing an FQDN from GCP convention for Zonal DNS and storing it as
   # metadata so it is a property of the instance, making it easy to use later in
   # Bolt
-  metadata = {
-    "ssh-keys"     = "${var.user}:${file(var.ssh_key)}"
-    "VmDnsSetting" = "ZonalPreferred"
+  metadata = merge({
     "internalDNS"  = "pe-server-${var.id}-${count.index}.${element(var.zones, count.index)}.c.${var.project}.internal"
-  }
+  }, local.metadata)
 
   labels = var.labels
 
@@ -51,11 +56,9 @@ resource "google_compute_instance" "psql" {
   count = var.database_count
   zone  = element(var.zones, count.index)
 
-  metadata = {
-    "ssh-keys"     = "${var.user}:${file(var.ssh_key)}"
-    "VmDnsSetting" = "ZonalPreferred"
+  metadata = merge({
     "internalDNS"  = "pe-psql-${var.id}-${count.index}.${element(var.zones, count.index)}.c.${var.project}.internal"
-  }
+  }, local.metadata)
 
   labels = var.labels
 
@@ -88,11 +91,9 @@ resource "google_compute_instance" "compiler" {
   count = var.compiler_count
   zone  = element(var.zones, count.index)
 
-  metadata = {
-    "ssh-keys"     = "${var.user}:${file(var.ssh_key)}"
-    "VmDnsSetting" = "ZonalPreferred"
+  metadata = merge({
     "internalDNS"  = "pe-compiler-${var.id}-${count.index}.${element(var.zones, count.index)}.c.${var.project}.internal"
-  }
+  }, local.metadata)
 
   labels = var.labels
 
@@ -124,11 +125,9 @@ resource "google_compute_instance" "node" {
   count = var.node_count
   zone  = element(var.zones, count.index)
 
-  metadata = {
-    "ssh-keys"     = "${var.user}:${file(var.ssh_key)}"
-    "VmDnsSetting" = "ZonalPreferred"
-    "internalDNS"  = "pe-node-${var.id}-${count.index}.${element(var.zones, count.index)}.c.${var.project}.internal"
-  }
+  metadata = merge({
+    "internalDNS"  = "pe-compiler-${var.id}-${count.index}.${element(var.zones, count.index)}.c.${var.project}.internal"
+  }, local.metadata)
 
   labels = var.labels
 

modules/instances/variables.tf

@@ -36,8 +36,14 @@ variable "instance_image" {
   type        = string
 }
 variable "labels" {
-  description = "A map of labels to apply to the instances"
+  description = "A list of labels that will be applied to virtual instances"
   type        = map
+  default     = {}
+}
+variable "metadata" {
+  description = "A map of user supplied metadata that will be applied to virtual instances"
+  type        = map
+  default     = {}
 }
 variable "project" {
   description = "Name of GCP project that will be used for housing require infrastructure"

variables.tf

@@ -31,11 +31,6 @@ variable "instance_image" {
   type        = string
   default     = "almalinux-cloud/almalinux-8"
 }
-variable "stack_name" {
-  description = "A name that'll help the user identify which instances are are part of a specific PE deployment"
-  type        = string
-  default     = "puppet-enterprise"
-}
 variable "firewall_allow" {
   description = "List of permitted IP subnets, list most include the internal network and single addresses must be passed as a /32"
   type        = list(string)
@@ -72,7 +67,12 @@ variable "cluster_profile" {
   }
 }
 variable "labels" {
-  description = "A map of labels that will be applied to the instances"
+  description = "A list of labels that will be applied to virtual instances"
+  type        = map
+  default     = {}
+}
+variable "metadata" {
+  description = "A map of user supplied metadata that will be applied to virtual instances"
   type        = map
   default     = {}
 }