feat: add variable to set resources with default values (#76)

* feat: add variable to set resources with default values

Having default values is good practice to prevent that our components could eventually starve other workloads on the cluster. However, these should probably be adapted in production clusters and are only a safeguard in case someone forgets to set them.

* docs(terraform-docs): generate docs and write to README.adoc

---------

Co-authored-by: lentidas <lentidas@users.noreply.github.com>

README.adoc

@@ -65,7 +65,7 @@ Description: Override of target revision of the application chart.
 
 Type: `string`
 
-Default: `"v6.1.1"`
+Default: `"v6.2.0"`
 
 ==== [[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
 
@@ -123,6 +123,29 @@ Type: `number`
 
 Default: `2`
 
+==== [[input_resources]] <<input_resources,resources>>
+
+Description: Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+Type:
+[source,hcl]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+Default: `{}`
+
 ==== [[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 
 Description: Enable HTTP to HTTPS redirection on all ingresses.
@@ -198,7 +221,7 @@ Description: ID to pass other modules in order to refer to this module as a depe
 |[[input_target_revision]] <<input_target_revision,target_revision>>
 |Override of target revision of the application chart.
 |`string`
-|`"v6.1.1"`
+|`"v6.2.0"`
 |no
 
 |[[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
@@ -251,6 +274,30 @@ object({
 |`2`
 |no
 
+|[[input_resources]] <<input_resources,resources>>
+|Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+|
+
+[source]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+|`{}`
+|no
+
 |[[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 |Enable HTTP to HTTPS redirection on all ingresses.
 |`bool`

aks/README.adoc

@@ -69,7 +69,7 @@ Description: Override of target revision of the application chart.
 
 Type: `string`
 
-Default: `"v6.1.1"`
+Default: `"v6.2.0"`
 
 ==== [[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
 
@@ -127,6 +127,29 @@ Type: `number`
 
 Default: `2`
 
+==== [[input_resources]] <<input_resources,resources>>
+
+Description: Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+Type:
+[source,hcl]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+Default: `{}`
+
 ==== [[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 
 Description: Enable HTTP to HTTPS redirection on all ingresses.
@@ -200,7 +223,7 @@ Description: ID to pass other modules in order to refer to this module as a depe
 |[[input_target_revision]] <<input_target_revision,target_revision>>
 |Override of target revision of the application chart.
 |`string`
-|`"v6.1.1"`
+|`"v6.2.0"`
 |no
 
 |[[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
@@ -253,6 +276,30 @@ object({
 |`2`
 |no
 
+|[[input_resources]] <<input_resources,resources>>
+|Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+|
+
+[source]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+|`{}`
+|no
+
 |[[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 |Enable HTTP to HTTPS redirection on all ingresses.
 |`bool`

aks/main.tf

@@ -1,12 +1,15 @@
 module "traefik" {
   source = "../"
 
-  argocd_project           = var.argocd_project
-  argocd_labels            = var.argocd_labels
-  destination_cluster      = var.destination_cluster
-  target_revision          = var.target_revision
-  enable_service_monitor   = var.enable_service_monitor
-  app_autosync             = var.app_autosync
+  argocd_project         = var.argocd_project
+  argocd_labels          = var.argocd_labels
+  destination_cluster    = var.destination_cluster
+  target_revision        = var.target_revision
+  enable_service_monitor = var.enable_service_monitor
+  app_autosync           = var.app_autosync
+
+  replicas                 = var.replicas
+  resources                = var.resources
   enable_https_redirection = var.enable_https_redirection
 
   helm_values = concat(local.helm_values, var.helm_values)

eks/README.adoc

@@ -53,7 +53,7 @@ Description: Override of target revision of the application chart.
 
 Type: `string`
 
-Default: `"v6.1.1"`
+Default: `"v6.2.0"`
 
 ==== [[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
 
@@ -111,6 +111,29 @@ Type: `number`
 
 Default: `2`
 
+==== [[input_resources]] <<input_resources,resources>>
+
+Description: Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+Type:
+[source,hcl]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+Default: `{}`
+
 ==== [[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 
 Description: Enable HTTP to HTTPS redirection on all ingresses.
@@ -172,7 +195,7 @@ Description: ID to pass other modules in order to refer to this module as a depe
 |[[input_target_revision]] <<input_target_revision,target_revision>>
 |Override of target revision of the application chart.
 |`string`
-|`"v6.1.1"`
+|`"v6.2.0"`
 |no
 
 |[[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
@@ -225,6 +248,30 @@ object({
 |`2`
 |no
 
+|[[input_resources]] <<input_resources,resources>>
+|Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+|
+
+[source]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+|`{}`
+|no
+
 |[[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 |Enable HTTP to HTTPS redirection on all ingresses.
 |`bool`

eks/main.tf

@@ -1,12 +1,15 @@
 module "traefik" {
   source = "../nodeport/"
 
-  argocd_project           = var.argocd_project
-  argocd_labels            = var.argocd_labels
-  destination_cluster      = var.destination_cluster
-  target_revision          = var.target_revision
-  enable_service_monitor   = var.enable_service_monitor
-  app_autosync             = var.app_autosync
+  argocd_project         = var.argocd_project
+  argocd_labels          = var.argocd_labels
+  destination_cluster    = var.destination_cluster
+  target_revision        = var.target_revision
+  enable_service_monitor = var.enable_service_monitor
+  app_autosync           = var.app_autosync
+
+  replicas                 = var.replicas
+  resources                = var.resources
   enable_https_redirection = var.enable_https_redirection
 
   helm_values = concat(local.helm_values, var.helm_values)

kind/README.adoc

@@ -65,7 +65,7 @@ Description: Override of target revision of the application chart.
 
 Type: `string`
 
-Default: `"v6.1.1"`
+Default: `"v6.2.0"`
 
 ==== [[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
 
@@ -123,6 +123,29 @@ Type: `number`
 
 Default: `2`
 
+==== [[input_resources]] <<input_resources,resources>>
+
+Description: Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+Type:
+[source,hcl]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+Default: `{}`
+
 ==== [[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 
 Description: Enable HTTP to HTTPS redirection on all ingresses.
@@ -204,7 +227,7 @@ Description: External IP address of Traefik LB service.
 |[[input_target_revision]] <<input_target_revision,target_revision>>
 |Override of target revision of the application chart.
 |`string`
-|`"v6.1.1"`
+|`"v6.2.0"`
 |no
 
 |[[input_enable_service_monitor]] <<input_enable_service_monitor,enable_service_monitor>>
@@ -257,6 +280,30 @@ object({
 |`2`
 |no
 
+|[[input_resources]] <<input_resources,resources>>
+|Resource limits and requests for Traefik's pods. Follow the style on https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[official documentation] to understand the format of the values.
+
+IMPORTANT: These are not production values. You should always adjust them to your needs.
+
+|
+
+[source]
+----
+object({
+    requests = optional(object({
+      cpu    = optional(string, "150m")
+      memory = optional(string, "128Mi")
+    }), {})
+    limits = optional(object({
+      cpu    = optional(string)
+      memory = optional(string, "256Mi")
+    }), {})
+  })
+----
+
+|`{}`
+|no
+
 |[[input_enable_https_redirection]] <<input_enable_https_redirection,enable_https_redirection>>
 |Enable HTTP to HTTPS redirection on all ingresses.
 |`bool`

kind/main.tf

@@ -1,12 +1,15 @@
 module "traefik" {
   source = "../"
 
-  argocd_project           = var.argocd_project
-  argocd_labels            = var.argocd_labels
-  destination_cluster      = var.destination_cluster
-  target_revision          = var.target_revision
-  enable_service_monitor   = var.enable_service_monitor
-  app_autosync             = var.app_autosync
+  argocd_project         = var.argocd_project
+  argocd_labels          = var.argocd_labels
+  destination_cluster    = var.destination_cluster
+  target_revision        = var.target_revision
+  enable_service_monitor = var.enable_service_monitor
+  app_autosync           = var.app_autosync
+
+  replicas                 = var.replicas
+  resources                = var.resources
   enable_https_redirection = var.enable_https_redirection
 
   helm_values = concat(local.helm_values, var.helm_values)