K8s app

This is a simple terraform module to deploy a k8s application.

Requirements

• Terraform >= 1.5.0
• Kubernetes provider >= 2.18.0

Usage

module "app" {
  source           = "Arminek/app/k8s"
  app_name         = "your-app-name"
  namespace        = "your-namespace"
  app_docker_image = "your-docker-image"
  replicas         = 2

  hosts     = ["subdomain.your-domain.xyz"]
  tls_hosts = ["subdomain.your-domain.xyz"]
  ingress_annotations = {
    "kubernetes.io/ingress.class" : "traefik"
    "cert-manager.io/cluster-issuer" : "letsencrypt"
  }

  resources_limits = {
    "cpu"    = "1"
    "memory" = "128Mi"
  }
  resources_requests = {
    "cpu"    = "250m"
    "memory" = "64Mi"
  }

  liveness_probe_path                  = "/v1/health"
  liveness_probe_initial_delay_seconds = 60
  liveness_probe_period_seconds        = 60

  readiness_probe_path                  = "/v1/health"
  readiness_probe_initial_delay_seconds = 1
  readiness_probe_period_seconds        = 10

  pdb_enabled = true

  image_pull_secrets = "github-registry"
  node_selector = {
    "purpose" = "workload"
  }
  
  # Multiple volume mounts example with different volume types
  volumes = [
    # PersistentVolumeClaim example
    {
      name       = "data-volume"
      mount_path = "/data"
      volume_source = {
        type       = "persistent_volume_claim"
        claim_name = "data-pvc"
      }
    },
    # ConfigMap example
    {
      name       = "config-volume"
      mount_path = "/config"
      volume_source = {
        type            = "config_map"
        config_map_name = "app-config"
        config_map_items = [
          {
            key  = "config.json"
            path = "config.json"
          },
          {
            key  = "settings.yaml"
            path = "settings.yaml"
          }
        ]
      }
    },
    # Secret example
    {
      name       = "secrets-volume"
      mount_path = "/secrets"
      volume_source = {
        type        = "secret"
        secret_name = "app-secrets"
        secret_items = [
          {
            key  = "api-key"
            path = "api-key"
          }
        ]
      }
    },
    # EmptyDir example
    {
      name       = "temp-volume"
      mount_path = "/tmp"
      volume_source = {
        type = "empty_dir"
      }
    }
  ]
}

Inputs

variable "namespace" {
  description = "Namespace to deploy to"
  type        = string
}

variable "app_name" {
  description = "Name of the application"
  type        = string
}

variable "env" {
  description = "Environment labels"
  type        = string
  default     = "prod"
}

variable "app_docker_image" {
  description = "Docker image to deploy"
  type        = string
}

variable "ingress_enabled" {
  description = "Enable ingress"
  type        = bool
  default     = true
}

variable "hosts" {
  description = "Hosts to add to ingress. Example: [\"example.com\", \"www.example.com\"]"
  type        = set(string)
  default     = []
}

variable "tls_hosts" {
  description = "Hosts to add to ingress with TLS. Example: [\"example.com\", \"www.example.com\"]"
  type        = set(string)
  default     = []
}

variable "ingress_annotations" {
  description = "Annotations to add to ingress"
  type        = any
  default     = {}
}

variable "envs_from_value" {
  description = "Environment variables from value"
  type = set(object({
    name  = string
    value = string
  }))
  default = []
}

variable "envs_from_secrets" {
  description = "Environment variables from secrets"
  type = set(object({
    name        = string
    secret_name = string
    secret_key  = string
  }))
  default = []
}

variable "envs_from_configmaps" {
  description = "Environment variables from configmaps"
  type = set(object({
    name        = string
    config_name = string
    config_key  = string
  }))
  default = []
}

variable "wait_for_load_balancer" {
  description = "Wait for load balancer to be ready before continuing"
  type        = bool
  default     = false
}

variable "wait_for_deployment_rollout" {
  description = "Wait for deployment rollout to finish before continuing"
  type        = bool
  default     = false
}

variable "replicas" {
  description = "Number of replicas"
  type        = number
  default     = 1
}

variable "node_selector" {
  description = "Node selector for pod assignment"
  type        = any
  default     = {}
}

variable "image_pull_policy" {
  description = "The image pull policy for the container. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise."
  type        = string
  default     = "IfNotPresent"
}

variable "container_port" {
  type    = number
  default = 8080
}

variable "resources_limits" {
  description = "Resources limits"
  type        = any
  default     = {}
}

variable "resources_requests" {
  description = "Resources requests"
  type        = any
  default     = {}
}

variable "image_pull_secrets_enabled" {
  type    = bool
  default = true
}

variable "image_pull_secrets" {
  type    = string
  default = ""
}

variable "service_port" {
  type    = number
  default = 80
}

variable "service_type" {
  type    = string
  default = "ClusterIP"
}

variable "service_enabled" {
  type    = bool
  default = true
}

variable "readiness_probe_enabled" {
  type    = bool
  default = true
}

variable "readiness_probe_path" {
  type    = string
  default = "/"
}

variable "readiness_probe_initial_delay_seconds" {
  type    = number
  default = 30
}

variable "readiness_probe_period_seconds" {
  type    = number
  default = 10
}

variable "readiness_probe_timeout_seconds" {
  type    = number
  default = 5
}

variable "readiness_probe_success_threshold" {
  type    = number
  default = 1
}

variable "readiness_probe_failure_threshold" {
  type    = number
  default = 3
}

variable "liveness_probe_enabled" {
  type    = bool
  default = true
}

variable "liveness_probe_path" {
  type    = string
  default = "/"
}

variable "liveness_probe_initial_delay_seconds" {
  type    = number
  default = 30
}

variable "liveness_probe_period_seconds" {
  type    = number
  default = 10
}

variable "liveness_probe_timeout_seconds" {
  type    = number
  default = 5
}

variable "liveness_probe_success_threshold" {
  type    = number
  default = 1
}

variable "liveness_probe_failure_threshold" {
  type    = number
  default = 3
}

variable "hpa_enabled" {
  type    = bool
  default = false
}

variable "pdb_enabled" {
  type    = bool
  default = false
}

variable "pdb_max_unavailable" {
  type    = string
  default = "50%"
}

variable "volume_enabled" {
  type    = bool
  default = false
}

variable "volumes" {
  description = "List of volumes to mount with their configurations. Examples include:
  
  # PersistentVolumeClaim
  {
    name       = \"data-volume\"
    mount_path = \"/data\"
    volume_source = {
      type       = \"persistent_volume_claim\"
      claim_name = \"data-pvc\"
    }
  }
  
  # ConfigMap
  {
    name       = \"config-volume\"
    mount_path = \"/config\"
    volume_source = {
      type            = \"config_map\"
      config_map_name = \"app-config\"
      config_map_items = [
        {
          key  = \"config.json\"
          path = \"config.json\"
        }
      ]
    }
  }
  
  # Secret
  {
    name       = \"secrets-volume\"
    mount_path = \"/secrets\"
    volume_source = {
      type        = \"secret\"
      secret_name = \"app-secrets\"
      secret_items = [
        {
          key  = \"api-key\"
          path = \"api-key\"
        }
      ]
    }
  }
  
  # EmptyDir
  {
    name       = \"temp-volume\"
    mount_path = \"/tmp\"
    volume_source = {
      type = \"empty_dir\"
    }
  }"
  type = list(object({
    name       = string
    mount_path = string
    volume_source = object({
      type = string # Can be "persistent_volume_claim", "config_map", "secret", "empty_dir"
      
      # For persistent_volume_claim
      claim_name = optional(string)
      
      # For config_map
      config_map_name = optional(string)
      config_map_items = optional(list(object({
        key  = string
        path = string
      })), [])
      
      # For secret
      secret_name = optional(string)
      secret_items = optional(list(object({
        key  = string
        path = string
      })), [])
      
      # For empty_dir
      medium = optional(string, "")
      size_limit = optional(string, "")
    })
  }))
  default = []
}

variable "volume_name" {
  type    = string
  default = ""
}

variable "persistent_volume_claim_name" {
  type    = string
  default = ""
}

variable "volume_mount_path" {
  type    = string
  default = ""
}

variable "runtime_class_name" {
  description = "The name of the runtime class to use for the pod"
  type        = string
  default     = null
}