terraform fmt

Author: msfidelis

variables.tf

@@ -3,14 +3,17 @@
 #########################
 
 variable "cluster_name" {
+  description = "The name of the Amazon EKS cluster. This is a unique identifier for your EKS cluster within the AWS region."
   default = "eks-cluster"
 }
 
 variable "aws_region" {
+  description = "AWS region where the EKS cluster will be deployed. This should be set to the region where you want your Kubernetes resources to reside."
   default = "us-east-1"
 }
 
 variable "k8s_version" {
+  description = "The version of Kubernetes to use for the EKS cluster. This version should be compatible with the AWS EKS service and other infrastructure components."
   default = "1.29"
 }
 
@@ -19,12 +22,14 @@ variable "k8s_version" {
 #########################
 
 variable "nodes_instances_sizes" {
+  description = "A list of EC2 instance types to use for the EKS worker nodes. These instance types should balance between cost, performance, and resource requirements for your workload."
   default = [
     "t3.large"
   ]
 }
 
 variable "auto_scale_options" {
+  description = "Configuration for the EKS cluster auto-scaling. It includes the minimum (min), maximum (max), and desired (desired) number of worker nodes."
   default = {
     min     = 4
     max     = 10
@@ -34,23 +39,24 @@ variable "auto_scale_options" {
 
 variable "cluster_autoscaler_toggle" {
   type        = bool
-  description = "Enable Cluster Autoscaler Installation"
+  description = "Enable or disable the Cluster Autoscaler installation. When true, Cluster Autoscaler is installed to automatically adjust the number of nodes in the cluster."
   default     = false
 }
 
+
 #########################
 ### KARPENTER CONFIGS ###
 #########################
 
 variable "karpenter_toggle" {
   type        = bool
-  description = "Enable Karpenter Installation"
+  description = "Determines whether Karpenter is enabled for the EKS cluster. Karpenter is an open-source auto-scaler for Kubernetes clusters."
   default     = true
 }
 
 variable "karpenter_instance_family" {
   type        = list(any)
-  description = "Instance family list to launch on karpenter"
+  description = "Defines a list of EC2 instance families to be considered by Karpenter for node provisioning. Instance families like 'c6' and 'c5' offer different compute capabilities."
   default = [
     "c6",
     "c6a",
@@ -60,7 +66,7 @@ variable "karpenter_instance_family" {
 
 variable "karpenter_instance_sizes" {
   type        = list(any)
-  description = "Instance sizes to diversify into instance family"
+  description = "Specifies a list of instance sizes within the chosen instance families to allow diversity in the provisioned nodes by Karpenter."
   default = [
     "large",
     "2xlarge"
@@ -69,15 +75,15 @@ variable "karpenter_instance_sizes" {
 
 variable "karpenter_capacity_type" {
   type        = list(any)
-  description = "Capacity Type; Ex spot, on_demand"
+  description = "Defines the capacity types for provisioning instances in the cluster, such as 'spot' or 'on_demand', offering cost-saving options or consistent availability respectively."
   default = [
     "spot"
   ]
 }
 
 variable "karpenter_availability_zones" {
   type        = list(any)
-  description = "Availability zones to launch nodes"
+  description = "A list of AWS availability zones where Karpenter should launch nodes. These zones should be in the same region as the EKS cluster."
   default = [
     "us-east-1a",
     "us-east-1b",
@@ -91,81 +97,91 @@ variable "karpenter_availability_zones" {
 
 variable "nlb_ingress_internal" {
   type    = bool
+  description = "Indicates whether the Network Load Balancer (NLB) for the EKS cluster should be internal, restricting access to within the AWS network."
   default = false
 }
 
 variable "nlb_ingress_type" {
   type    = string
+  description = "Specifies the type of ingress to be used, such as 'network', determining how the NLB handles incoming traffic to the EKS cluster."
   default = "network"
 }
 
 variable "proxy_protocol_v2" {
   type    = bool
+  description = "Enables or disables Proxy Protocol v2 on the Network Load Balancer, used for preserving client IP addresses and other connection information."
   default = false
 }
 
 variable "nlb_ingress_enable_termination_protection" {
   type    = bool
+  description = "Determines if termination protection is enabled for the Network Load Balancer, preventing accidental deletion."
   default = false
 }
 
 variable "enable_cross_zone_load_balancing" {
   type    = bool
+  description = "Controls whether cross-zone load balancing is enabled for the Network Load Balancer, allowing even traffic distribution across all zones."
   default = false
 }
 
+
 #########################
 ###  ROUTE53 CONFIGS  ###
 #########################
 
 variable "cluster_private_zone" {
   type    = string
+  description = "The private DNS zone name for the EKS cluster in AWS Route53. This zone is used for internal DNS resolution within the cluster."
   default = "k8s.cluster"
 }
 
-
 #########################
 ###  ISTIO CONFIGS    ###
 #########################
 
 variable "istio_ingress_min_pods" {
   type        = number
+  description = "The minimum number of pods to maintain for the Istio ingress gateway. This ensures basic availability and load handling."
   default     = 3
-  description = "Minimum pods for istio-ingress-gateway"
 }
 
 variable "istio_ingress_max_pods" {
   type        = number
+  description = "The maximum number of pods to scale up for the Istio ingress gateway. This limits the resources used and manages the scaling behavior."
   default     = 9
-  description = "Maximum pods for istio-ingress-gateway"
 }
 
 #########################
 #  PROMETHEUS CONFIGS   #
 #########################
 
 variable "grafana_virtual_service_host" {
-  type    = string
-  default = "grafana.k8s.raj.ninja"
+  type        = string
+  description = "The hostname for the Grafana virtual service, used in Istio routing. This host is used to access Grafana dashboards for monitoring metrics."
+  default     = "grafana.k8s.raj.ninja"
 }
 
 variable "kiali_virtual_service_host" {
-  type    = string
-  default = "kiali.k8s.raj.ninja"
+  type        = string
+  description = "The hostname for the Kiali virtual service, a part of Istio's service mesh visualization. It provides insights into the mesh topology and performance."
+  default     = "kiali.k8s.raj.ninja"
 }
 
 variable "jaeger_virtual_service_host" {
-  type    = string
-  default = "jaeger.k8s.raj.ninja"
+  type        = string
+  description = "The hostname for the Jaeger virtual service, used for tracing and monitoring microservices within the Istio service mesh."
+  default     = "jaeger.k8s.raj.ninja"
 }
 
 ###############################
 ###  ARGO-ROLLOUTS CONFIGS  ###
 ###############################
 
 variable "argo_rollouts_virtual_service_host" {
-  type    = string
-  default = "argo-rollouts.k8s.raj.ninja"
+  type        = string
+  description = "The hostname for the Argo Rollouts virtual service, used for advanced deployment capabilities like canary and blue-green deployments in Kubernetes."
+  default     = "argo-rollouts.k8s.raj.ninja"
 }
 
 #########################
@@ -174,31 +190,31 @@ variable "argo_rollouts_virtual_service_host" {
 
 variable "descheduler_toggle" {
   type        = bool
-  description = "Enable Descheduler Installation"
+  description = "Controls the installation of the Descheduler, a tool to balance and optimize the distribution of Pods across the cluster for improved efficiency."
   default     = false
 }
 
 variable "chaos_mesh_toggle" {
   type        = bool
-  description = "Enable Chaos Mesh Installation"
+  description = "Determines whether to install Chaos Mesh, a cloud-native Chaos Engineering platform that orchestrates chaos experiments on Kubernetes environments."
   default     = false
 }
 
 variable "node_termination_handler_toggle" {
   type        = bool
-  description = "Enable AWS Node Termination Handler Setup"
+  description = "Enables the AWS Node Termination Handler, which ensures that Kubernetes workloads are gracefully handled during EC2 instance terminations or disruptions."
   default     = true
 }
 
 variable "argo_rollouts_toggle" {
   type        = bool
-  description = "Enable Argo Rollouts Installation"
+  description = "Enables the installation of Argo Rollouts, providing advanced deployment strategies like Canary and Blue-Green deployments in Kubernetes."
   default     = true
 }
 
 variable "keda_toggle" {
   type        = bool
-  description = "Enable Keda Installation"
+  description = "Activates the installation of KEDA (Kubernetes Event-Driven Autoscaling), which adds event-driven scaling capabilities to Kubernetes workloads."
   default     = true
 }
 
@@ -208,29 +224,31 @@ variable "keda_toggle" {
 
 variable "addon_cni_version" {
   type        = string
-  description = "VPC CNI Version"
+  description = "Specifies the version of the AWS VPC CNI (Container Network Interface) plugin to use, which manages the network interfaces for pod networking."
   default     = "v1.14.1-eksbuild.1"
 }
 
 variable "addon_coredns_version" {
   type        = string
-  description = "CoreDNS Version"
+  description = "Defines the version of CoreDNS to use, a DNS server/forwarder that is integral to internal Kubernetes DNS resolution."
   default     = "v1.11.1-eksbuild.4"
 }
 
 variable "addon_kubeproxy_version" {
   type        = string
-  description = "Kubeproxy Version"
+  description = "Sets the version of Kubeproxy to be used, which handles Kubernetes network services like forwarding the requests to correct containers."
   default     = "v1.29.0-eksbuild.1"
 }
 
 variable "addon_csi_version" {
   type        = string
-  description = "CSI Version"
+  description = "Indicates the version of the Container Storage Interface (CSI) driver to use for managing storage volumes in Kubernetes."
   default     = "v1.26.1-eksbuild.1"
 }
 
 variable "default_tags" {
+  type        = map(string)
+  description = "A map of default tags to apply to all resources. These tags can help with identifying and organizing resources within the AWS environment."
   default = {
     Environment = "prod"
     Foo         = "Bar"