@spine-event-engine/deployment-gke 2.0.0-snapshot.2

package/terraform/main.tf

@@ -0,0 +1,303 @@
+locals {
+  labels = {
+    "app.kubernetes.io/part-of" = "spine-application"
+  }
+}
+
+resource "kubernetes_config_map_v1" "runtime" {
+  metadata {
+    name      = "spine-runtime"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  data = {
+    APPLICATION_PORT          = tostring(var.application_port)
+    APPLICATION_PROCESS_COUNT = tostring(var.application_process_count)
+    BACKEND_DISCOVERY_PORT    = tostring(var.application_port)
+    BACKEND_DISCOVERY_SERVICE = "application.${var.namespace}.svc.cluster.local"
+    DELIVERY_SERVER_URL       = "http://delivery.${var.namespace}.svc.cluster.local:${var.delivery_port}"
+    DELIVERY_SHARD_COUNT      = tostring(var.delivery_shard_count)
+    GATEWAY_PORT              = tostring(var.gateway_port)
+    NODE_ENV                  = "production"
+  }
+}
+
+resource "kubernetes_service_v1" "application" {
+  metadata {
+    name      = "application"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    cluster_ip                  = "None"
+    publish_not_ready_addresses = false
+    selector                    = merge(local.labels, { "app.kubernetes.io/component" = "application" })
+
+    port {
+      name        = "grpc"
+      port        = var.application_port
+      target_port = "coordinator"
+    }
+  }
+}
+
+resource "kubernetes_service_v1" "gateway" {
+  metadata {
+    name      = "gateway"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    selector = merge(local.labels, { "app.kubernetes.io/component" = "gateway" })
+
+    port {
+      name        = "gateway"
+      port        = var.gateway_port
+      target_port = "gateway"
+    }
+  }
+}
+
+resource "kubernetes_service_v1" "delivery" {
+  metadata {
+    name      = "delivery"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    selector = merge(local.labels, { "app.kubernetes.io/component" = "delivery" })
+
+    port {
+      name        = "grpc"
+      port        = var.delivery_port
+      target_port = "grpc"
+    }
+  }
+}
+
+resource "kubernetes_deployment_v1" "application" {
+  metadata {
+    name      = "application"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  lifecycle {
+    precondition {
+      condition     = var.autoscaling_min_replicas <= var.autoscaling_max_replicas
+      error_message = "Autoscaling minimum replicas must not exceed the maximum."
+    }
+  }
+
+  spec {
+    replicas = var.autoscaling_enabled ? null : tostring(var.application_replicas)
+
+    selector {
+      match_labels = merge(local.labels, { "app.kubernetes.io/component" = "application" })
+    }
+
+    template {
+      metadata {
+        labels = merge(local.labels, { "app.kubernetes.io/component" = "application" })
+      }
+
+      spec {
+        service_account_name = var.service_account_name
+
+        container {
+          name  = "application"
+          image = var.application_image
+
+          port {
+            name           = "coordinator"
+            container_port = var.application_port
+          }
+
+          env {
+            name  = "HOST"
+            value = "0.0.0.0"
+          }
+
+          env {
+            name  = "PORT"
+            value = tostring(var.application_port)
+          }
+
+          env_from {
+            config_map_ref {
+              name = kubernetes_config_map_v1.runtime.metadata[0].name
+            }
+          }
+
+          env_from {
+            secret_ref {
+              name = var.application_secret_name
+            }
+          }
+
+          readiness_probe {
+            tcp_socket {
+              port = "coordinator"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+resource "kubernetes_deployment_v1" "gateway" {
+  metadata {
+    name      = "gateway"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    replicas = 1
+
+    selector {
+      match_labels = merge(local.labels, { "app.kubernetes.io/component" = "gateway" })
+    }
+
+    template {
+      metadata {
+        labels = merge(local.labels, { "app.kubernetes.io/component" = "gateway" })
+      }
+
+      spec {
+        service_account_name = var.service_account_name
+
+        container {
+          name  = "gateway"
+          image = var.gateway_image
+
+          port {
+            name           = "gateway"
+            container_port = var.gateway_port
+          }
+
+          env {
+            name  = "HOST"
+            value = "0.0.0.0"
+          }
+
+          env {
+            name  = "PORT"
+            value = tostring(var.gateway_port)
+          }
+
+          env_from {
+            config_map_ref {
+              name = kubernetes_config_map_v1.runtime.metadata[0].name
+            }
+          }
+
+          env_from {
+            secret_ref {
+              name = var.gateway_secret_name
+            }
+          }
+
+          readiness_probe {
+            tcp_socket {
+              port = "gateway"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+resource "kubernetes_deployment_v1" "delivery" {
+  metadata {
+    name      = "delivery"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    replicas = 1
+
+    selector {
+      match_labels = merge(local.labels, { "app.kubernetes.io/component" = "delivery" })
+    }
+
+    template {
+      metadata {
+        labels = merge(local.labels, { "app.kubernetes.io/component" = "delivery" })
+      }
+
+      spec {
+        service_account_name = var.service_account_name
+
+        container {
+          name  = "delivery"
+          image = var.delivery_image
+
+          port {
+            name           = "grpc"
+            container_port = var.delivery_port
+          }
+
+          env {
+            name  = "HOST"
+            value = "0.0.0.0"
+          }
+
+          env {
+            name  = "PORT"
+            value = tostring(var.delivery_port)
+          }
+
+          readiness_probe {
+            tcp_socket {
+              port = "grpc"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+resource "kubernetes_horizontal_pod_autoscaler_v2" "application" {
+  count = var.autoscaling_enabled ? 1 : 0
+
+  metadata {
+    name      = "application"
+    namespace = var.namespace
+    labels    = local.labels
+  }
+
+  spec {
+    min_replicas = var.autoscaling_min_replicas
+    max_replicas = var.autoscaling_max_replicas
+
+    scale_target_ref {
+      api_version = "apps/v1"
+      kind        = "Deployment"
+      name        = kubernetes_deployment_v1.application.metadata[0].name
+    }
+
+    metric {
+      type = "External"
+
+      external {
+        metric {
+          name = var.autoscaling_metric
+        }
+
+        target {
+          type          = "AverageValue"
+          average_value = var.autoscaling_target
+        }
+      }
+    }
+  }
+}

package/terraform/terraform.tfvars.example

@@ -0,0 +1,27 @@
+# Create these Secrets separately. Terraform deliberately never receives their values.
+application_secret_name = "my-application-runtime"
+gateway_secret_name     = "my-gateway-runtime"
+
+# Replace every image with an immutable image published by your delivery pipeline.
+application_image = "REGION-docker.pkg.dev/PROJECT/spine/application@sha256:REPLACE"
+gateway_image     = "REGION-docker.pkg.dev/PROJECT/spine/gateway@sha256:REPLACE"
+delivery_image    = "REGION-docker.pkg.dev/PROJECT/spine/simple-delivery@sha256:REPLACE"
+
+# Choose a context created by `gcloud container clusters get-credentials`.
+kubeconfig_context = "gke_PROJECT_REGION_CLUSTER"
+
+# This value controls manual capacity while autoscaling_enabled is false.
+application_replicas = 2
+
+# Set both values deliberately. One Pod starts this many complete application
+# children, while the application builds its contexts with this many Delivery shards.
+application_process_count = 2
+delivery_shard_count      = 2
+
+# The template creates no HPA unless you explicitly enable it. Select values
+# that match an external metric adapter already operated by your platform team.
+autoscaling_enabled      = false
+autoscaling_metric       = "requests_per_second"
+autoscaling_target       = "10"
+autoscaling_min_replicas = 1
+autoscaling_max_replicas = 8

package/terraform/variables.tf

@@ -0,0 +1,191 @@
+variable "kubeconfig_path" {
+  description = "Path to the operator's kubeconfig file for the existing GKE cluster."
+  type        = string
+  default     = "~/.kube/config"
+}
+
+variable "kubeconfig_context" {
+  description = "Kubeconfig context for the target GKE cluster."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.kubeconfig_context) != ""
+    error_message = "Kubeconfig context must not be empty."
+  }
+}
+
+variable "namespace" {
+  description = "Existing Kubernetes namespace that receives the private topology."
+  type        = string
+  default     = "spine-app"
+
+  validation {
+    condition     = trimspace(var.namespace) != ""
+    error_message = "Namespace must not be empty."
+  }
+}
+
+variable "service_account_name" {
+  description = "Existing Kubernetes ServiceAccount used by every workload in this template."
+  type        = string
+  default     = "default"
+
+  validation {
+    condition     = trimspace(var.service_account_name) != ""
+    error_message = "ServiceAccount name must not be empty."
+  }
+}
+
+variable "application_image" {
+  description = "Immutable image reference for the application-node process."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.application_image) != ""
+    error_message = "Application image must not be empty."
+  }
+}
+
+variable "gateway_image" {
+  description = "Immutable image reference for the standalone Gateway process."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.gateway_image) != ""
+    error_message = "Gateway image must not be empty."
+  }
+}
+
+variable "delivery_image" {
+  description = "Immutable image reference for the simple in-memory delivery server."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.delivery_image) != ""
+    error_message = "Delivery image must not be empty."
+  }
+}
+
+variable "application_replicas" {
+  description = "Number of identical application nodes when optional autoscaling is disabled."
+  type        = number
+  default     = 2
+
+  validation {
+    condition     = var.application_replicas >= 0 && floor(var.application_replicas) == var.application_replicas
+    error_message = "Application replicas must be zero or greater."
+  }
+}
+
+variable "application_process_count" {
+  description = "Number of complete application replicas started in each application Pod."
+  type        = number
+
+  validation {
+    condition     = var.application_process_count >= 1 && floor(var.application_process_count) == var.application_process_count
+    error_message = "Application process count must be a positive integer."
+  }
+}
+
+variable "delivery_shard_count" {
+  description = "Delivery shard count passed explicitly to each application image's context assembly."
+  type        = number
+
+  validation {
+    condition     = var.delivery_shard_count >= 1 && floor(var.delivery_shard_count) == var.delivery_shard_count
+    error_message = "Delivery shard count must be a positive integer."
+  }
+}
+
+variable "application_port" {
+  description = "Private native gRPC port exposed by each application node."
+  type        = number
+  default     = 8080
+
+  validation {
+    condition     = var.application_port >= 1 && var.application_port <= 65535 && floor(var.application_port) == var.application_port
+    error_message = "Application port must be an integer from 1 through 65535."
+  }
+}
+
+variable "gateway_port" {
+  description = "Private browser Gateway port exposed to an operator-managed edge."
+  type        = number
+  default     = 8081
+
+  validation {
+    condition     = var.gateway_port >= 1 && var.gateway_port <= 65535 && floor(var.gateway_port) == var.gateway_port
+    error_message = "Gateway port must be an integer from 1 through 65535."
+  }
+}
+
+variable "delivery_port" {
+  description = "Private gRPC port exposed by the simple delivery server."
+  type        = number
+  default     = 8484
+
+  validation {
+    condition     = var.delivery_port >= 1 && var.delivery_port <= 65535 && floor(var.delivery_port) == var.delivery_port
+    error_message = "Delivery port must be an integer from 1 through 65535."
+  }
+}
+
+variable "application_secret_name" {
+  description = "Name of an existing Secret containing application-selected configuration."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.application_secret_name) != ""
+    error_message = "Application Secret name must not be empty."
+  }
+}
+
+variable "gateway_secret_name" {
+  description = "Name of an existing Secret containing Gateway session and identity configuration."
+  type        = string
+
+  validation {
+    condition     = trimspace(var.gateway_secret_name) != ""
+    error_message = "Gateway Secret name must not be empty."
+  }
+}
+
+variable "autoscaling_enabled" {
+  description = "Creates the module's optional external-metric HPA when true; never combine it with KEDA."
+  type        = bool
+  default     = false
+}
+
+variable "autoscaling_metric" {
+  description = "External metric name selected by the operator when autoscaling is enabled."
+  type        = string
+  default     = "requests_per_second"
+}
+
+variable "autoscaling_target" {
+  description = "Target average external-metric value selected by the operator."
+  type        = string
+  default     = "10"
+}
+
+variable "autoscaling_min_replicas" {
+  description = "Minimum application-node replicas selected by the operator for the optional HPA."
+  type        = number
+  default     = 1
+
+  validation {
+    condition     = var.autoscaling_min_replicas >= 1 && floor(var.autoscaling_min_replicas) == var.autoscaling_min_replicas
+    error_message = "Autoscaling minimum replicas must be a positive integer."
+  }
+}
+
+variable "autoscaling_max_replicas" {
+  description = "Maximum application-node replicas selected by the operator for the optional HPA."
+  type        = number
+  default     = 8
+
+  validation {
+    condition     = var.autoscaling_max_replicas >= 1 && floor(var.autoscaling_max_replicas) == var.autoscaling_max_replicas
+    error_message = "Autoscaling maximum replicas must be a positive integer."
+  }
+}

package/terraform/versions.tf

@@ -0,0 +1,15 @@
+terraform {
+  required_version = ">= 1.6.0"
+
+  required_providers {
+    kubernetes = {
+      source  = "hashicorp/kubernetes"
+      version = "~> 3.2"
+    }
+  }
+}
+
+provider "kubernetes" {
+  config_path    = var.kubeconfig_path
+  config_context = var.kubeconfig_context
+}