devops-stack-module-kube-prometheus-stack

A DevOps Stack module to deploy and configure kube-prometheus-chart.

The kube-prometheus-stack chart used by this module is shipped in this repository as well, in order to avoid any unwanted behaviors caused by unsupported versions.

Current Chart Version	Original Repository	Default Values
62.2.1	Chart	values.yaml

Since this module is meant to be instantiated using its variants, the usage documentation is available in each variant ( AKS | EKS | KinD | SKS ).

Below you will only find the technical reference automatically generated from the *.tf files on the root module.

Technical Documentation

Requirements

The following requirements are needed by this module:

• argocd (>= 6)

• kubernetes (>= 2)

• null (>= 3)

• random (>= 3)

• utils (>= 1)

Providers

The following providers are used by this module:

• kubernetes (>= 2)

• random (>= 3)

• utils (>= 1)

• argocd (>= 6)

• null (>= 3)

Resources

The following resources are used by this module:

• argocd_application.this (resource)

• argocd_project.this (resource)

• kubernetes_namespace.kube_prometheus_stack_namespace (resource)

• kubernetes_secret.thanos_object_storage_secret (resource)

• null_resource.dependencies (resource)

• null_resource.this (resource)

• random_password.grafana_admin_password (resource)

• random_password.oauth2_cookie_secret (resource)

• utils_deep_merge_yaml.values (data source)

Required Inputs

The following input variables are required:

cluster_name

Description: Name given to the cluster. Value used for naming some the resources created by the module.

Type: string

base_domain

Description: Base domain of the cluster. Value used for the ingress' URL of the application.

Type: string

Optional Inputs

The following input variables are optional (have default values):

subdomain

Description: Subdomain of the cluster. Value used for the ingress' URL of the application.

Type: string

Default: "apps"

argocd_project

Description: Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.

Type: string

Default: null

argocd_labels

Description: Labels to attach to the Argo CD Application resource.

Type: map(string)

Default: {}

destination_cluster

Description: Destination cluster where the application should be deployed.

Type: string

Default: "in-cluster"

target_revision

Description: Override of target revision of the application chart.

Type: string

Default: "v13.0.0"

cluster_issuer

Description: SSL certificate issuer to use. Usually you would configure this value as letsencrypt-staging or letsencrypt-prod on your root *.tf files.

Type: string

Default: "selfsigned-issuer"

helm_values

Description: Helm chart value overrides. They should be passed as a list of HCL structures.

Type: any

Default: []

deep_merge_append_list

Description: A boolean flag to enable/disable appending lists instead of overwriting them.

Type: bool

Default: false

app_autosync

Description: Automated sync options for the Argo CD Application resource.

Type:

object({
    allow_empty = optional(bool)
    prune       = optional(bool)
    self_heal   = optional(bool)
  })

Default:

{
  "allow_empty": false,
  "prune": true,
  "self_heal": true
}

dependency_ids

Description: n/a

Type: map(string)

Default: {}

resources

Description: Resource limits and requests for kube-prometheus-stack’s components. Follow the style on official documentation to understand the format of the values.

Important

These are not production values. You should always adjust them to your needs.

Type:

object({

    prometheus = optional(object({
      requests = optional(object({
        cpu    = optional(string, "250m")
        memory = optional(string, "512Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "1024Mi")
      }), {})
    }), {})

    prometheus_operator = optional(object({
      requests = optional(object({
        cpu    = optional(string, "50m")
        memory = optional(string, "128Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "128Mi")
      }), {})
    }), {})

    thanos_sidecar = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    alertmanager = optional(object({
      requests = optional(object({
        cpu    = optional(string, "50m")
        memory = optional(string, "128Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "256Mi")
      }), {})
    }), {})

    kube_state_metrics = optional(object({
      requests = optional(object({
        cpu    = optional(string, "50m")
        memory = optional(string, "128Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "128Mi")
      }), {})
    }), {})

    grafana = optional(object({
      requests = optional(object({
        cpu    = optional(string, "250m")
        memory = optional(string, "512Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    node_exporter = optional(object({
      requests = optional(object({
        cpu    = optional(string, "50m")
        memory = optional(string, "128Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "128Mi")
      }), {})
    }), {})

  })

Default: {}

grafana

Description: Grafana settings

Type: any

Default: {}

prometheus

Description: Prometheus settings

Type: any

Default: {}

alertmanager

Description: Object containing Alertmanager settings. The following attributes are supported:

• enabled: whether Alertmanager is deployed or not (default: true).

• domain: domain name configured in the Ingress (default: prometheus.apps.${var.cluster_name}.${var.base_domain}).

• oidc: OIDC configuration to be used by OAuth2 Proxy in front of Alertmanager (required).

• deadmanssnitch_url: url of a Dead Man’s Snitch service Alertmanager should report to (by default this reporing is disabled).

• slack_routes: list of objects configuring routing of alerts to Slack channels, with the following attributes:

• name: name of the configured route.

• channel: channel where the alerts will be sent (with '#').

• api_url: slack URL you received when configuring a webhook integration.

• matchers: list of strings for filtering which alerts will be sent.

• continue: whether an alert should continue matching subsequent sibling nodes.

Type: any

Default: {}

metrics_storage_main

Description: Storage settings for the Thanos sidecar. Needs to be of type any because the structure is different depending on the variant used.

Type: any

Default: {}

dataproxy_timeout

Description: Variable to set the time when a query times out. This applies to all the Grafana’s data sources and can be manually configured per data source if desired.

Type: number

Default: 30

Outputs

The following outputs are exported:

id

Description: ID to pass other modules in order to refer to this module as a dependency.

grafana_admin_password

Description: The admin password for Grafana.

Reference in table format

Show tables

= Requirements

Name	Version
argocd	>= 6
kubernetes	>= 2
null	>= 3
random	>= 3
utils	>= 1

= Providers

Name	Version
kubernetes	>= 2
random	>= 3
utils	>= 1
argocd	>= 6
null	>= 3

= Resources

Name	Type
argocd_application.this	resource
argocd_project.this	resource
kubernetes_namespace.kube_prometheus_stack_namespace	resource
kubernetes_secret.thanos_object_storage_secret	resource
null_resource.dependencies	resource
null_resource.this	resource
random_password.grafana_admin_password	resource
random_password.oauth2_cookie_secret	resource
utils_deep_merge_yaml.values	data source

= Inputs

Name	Description	Type	Default	Required
cluster_name	Name given to the cluster. Value used for naming some the resources created by the module.	string	n/a	yes
base_domain	Base domain of the cluster. Value used for the ingress' URL of the application.	string	n/a	yes
subdomain	Subdomain of the cluster. Value used for the ingress' URL of the application.	string	"apps"	no
argocd_project	Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.	string	null	no
argocd_labels	Labels to attach to the Argo CD Application resource.	map(string)	{}	no
destination_cluster	Destination cluster where the application should be deployed.	string	"in-cluster"	no
target_revision	Override of target revision of the application chart.	string	"v13.0.0"	no
cluster_issuer	SSL certificate issuer to use. Usually you would configure this value as letsencrypt-staging or letsencrypt-prod on your root *.tf files.	string	"selfsigned-issuer"	no
helm_values	Helm chart value overrides. They should be passed as a list of HCL structures.	any	[]	no
deep_merge_append_list	A boolean flag to enable/disable appending lists instead of overwriting them.	bool	false	no
app_autosync	Automated sync options for the Argo CD Application resource.	object({ allow_empty = optional(bool) prune = optional(bool) self_heal = optional(bool) })	{ "allow_empty": false, "prune": true, "self_heal": true }	no
dependency_ids	n/a	map(string)	{}	no
resources	Resource limits and requests for kube-prometheus-stack’s components. Follow the style on official documentation to understand the format of the values. Important These are not production values. You should always adjust them to your needs.	object({ prometheus = optional(object({ requests = optional(object({ cpu = optional(string, "250m") memory = optional(string, "512Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "1024Mi") }), {}) }), {}) prometheus_operator = optional(object({ requests = optional(object({ cpu = optional(string, "50m") memory = optional(string, "128Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "128Mi") }), {}) }), {}) thanos_sidecar = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) alertmanager = optional(object({ requests = optional(object({ cpu = optional(string, "50m") memory = optional(string, "128Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "256Mi") }), {}) }), {}) kube_state_metrics = optional(object({ requests = optional(object({ cpu = optional(string, "50m") memory = optional(string, "128Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "128Mi") }), {}) }), {}) grafana = optional(object({ requests = optional(object({ cpu = optional(string, "250m") memory = optional(string, "512Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) node_exporter = optional(object({ requests = optional(object({ cpu = optional(string, "50m") memory = optional(string, "128Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "128Mi") }), {}) }), {}) })	{}	no
grafana	Grafana settings	any	{}	no
prometheus	Prometheus settings	any	{}	no
alertmanager	Object containing Alertmanager settings. The following attributes are supported: enabled: whether Alertmanager is deployed or not (default: true). domain: domain name configured in the Ingress (default: prometheus.apps.${var.cluster_name}.${var.base_domain}). oidc: OIDC configuration to be used by OAuth2 Proxy in front of Alertmanager (required). deadmanssnitch_url: url of a Dead Man’s Snitch service Alertmanager should report to (by default this reporing is disabled). slack_routes: list of objects configuring routing of alerts to Slack channels, with the following attributes: name: name of the configured route. channel: channel where the alerts will be sent (with '#'). api_url: slack URL you received when configuring a webhook integration. matchers: list of strings for filtering which alerts will be sent. continue: whether an alert should continue matching subsequent sibling nodes.	any	{}	no
metrics_storage_main	Storage settings for the Thanos sidecar. Needs to be of type any because the structure is different depending on the variant used.	any	{}	no
dataproxy_timeout	Variable to set the time when a query times out. This applies to all the Grafana’s data sources and can be manually configured per data source if desired.	number	30	no

= Outputs

Name	Description
id	ID to pass other modules in order to refer to this module as a dependency.
grafana_admin_password	The admin password for Grafana.