Files
terraform-aws-observability…/modules/eks-monitoring/variables.tf
T
Rodrigue Koffi 739b581988 K8s operator metrics (#185)
* Add kube admin metrics

* Update chart version

* Variable verbosity level for adot collector
2023-06-29 08:52:41 -04:00

451 lines
13 KiB
Terraform

variable "eks_cluster_id" {
description = "EKS Cluster Id"
type = string
}
variable "enable_amazon_eks_adot" {
description = "Enables the ADOT Operator on the EKS Cluster"
type = bool
default = true
}
variable "enable_cert_manager" {
description = "Allow reusing an existing installation of cert-manager"
type = bool
default = true
}
variable "helm_config" {
description = "Helm Config for Prometheus"
type = any
default = {}
}
variable "irsa_iam_role_path" {
description = "IAM role path for IRSA roles"
type = string
default = "/"
}
variable "irsa_iam_permissions_boundary" {
description = "IAM permissions boundary for IRSA roles"
type = string
default = null
}
variable "adot_loglevel" {
description = "Verbosity level for ADOT collector logs"
type = string
default = "warn"
}
variable "managed_prometheus_workspace_endpoint" {
description = "Amazon Managed Prometheus Workspace Endpoint"
type = string
default = ""
}
variable "managed_prometheus_workspace_id" {
description = "Amazon Managed Prometheus Workspace ID"
type = string
default = null
}
variable "managed_prometheus_workspace_region" {
description = "Amazon Managed Prometheus Workspace's Region"
type = string
default = null
}
variable "enable_alerting_rules" {
description = "Enables or disables Managed Prometheus alerting rules"
type = bool
default = true
}
variable "enable_recording_rules" {
description = "Enables or disables Managed Prometheus recording rules"
type = bool
default = true
}
variable "enable_dashboards" {
description = "Enables or disables curated dashboards"
type = bool
default = true
}
variable "flux_kustomization_name" {
description = "Flux Kustomization name"
type = string
default = "grafana-dashboards-infrastructure"
}
variable "flux_gitrepository_name" {
description = "Flux GitRepository name"
type = string
default = "aws-observability-accelerator"
}
variable "flux_gitrepository_url" {
description = "Flux GitRepository URL"
type = string
default = "https://github.com/aws-observability/aws-observability-accelerator"
}
variable "flux_gitrepository_branch" {
description = "Flux GitRepository Branch"
type = string
default = "main"
}
variable "flux_kustomization_path" {
description = "Flux Kustomization Path"
type = string
default = "./artifacts/grafana-operator-manifests/eks/infrastructure"
}
variable "enable_kube_state_metrics" {
description = "Enables or disables Kube State metrics exporter. Disabling this might affect some data in the dashboards"
type = bool
default = true
}
variable "ksm_config" {
description = "Kube State metrics configuration"
type = object({
create_namespace = bool
k8s_namespace = string
helm_chart_name = string
helm_chart_version = string
helm_release_name = string
helm_repo_url = string
helm_settings = map(string)
helm_values = map(any)
scrape_interval = string
scrape_timeout = string
})
default = {
create_namespace = true
helm_chart_name = "kube-state-metrics"
helm_chart_version = "4.24.0"
helm_release_name = "kube-state-metrics"
helm_repo_url = "https://prometheus-community.github.io/helm-charts"
helm_settings = {}
helm_values = {}
k8s_namespace = "kube-system"
scrape_interval = "60s"
scrape_timeout = "15s"
}
nullable = false
}
variable "enable_node_exporter" {
description = "Enables or disables Node exporter. Disabling this might affect some data in the dashboards"
type = bool
default = true
}
variable "ne_config" {
description = "Node exporter configuration"
type = object({
create_namespace = bool
k8s_namespace = string
helm_chart_name = string
helm_chart_version = string
helm_release_name = string
helm_repo_url = string
helm_settings = map(string)
helm_values = map(any)
scrape_interval = string
scrape_timeout = string
})
default = {
create_namespace = true
helm_chart_name = "prometheus-node-exporter"
helm_chart_version = "4.14.0"
helm_release_name = "prometheus-node-exporter"
helm_repo_url = "https://prometheus-community.github.io/helm-charts"
helm_settings = {}
helm_values = {}
k8s_namespace = "prometheus-node-exporter"
scrape_interval = "60s"
scrape_timeout = "60s"
}
nullable = false
}
variable "tags" {
description = "Additional tags (e.g. `map('BusinessUnit`,`XYZ`)"
type = map(string)
default = {}
}
variable "prometheus_config" {
description = "Controls default values such as scrape interval, timeouts and ports globally"
type = object({
global_scrape_interval = string
global_scrape_timeout = string
})
default = {
global_scrape_interval = "60s"
global_scrape_timeout = "15s"
}
nullable = false
}
variable "enable_tracing" {
description = "(Experimental) Enables tracing with AWS X-Ray. This changes the deploy mode of the collector to daemon set. Requirement: adot add-on <= 0.58-build.0"
type = bool
default = false
}
variable "tracing_config" {
description = "Configuration object for traces collection to AWS X-Ray"
type = object({
otlp_grpc_endpoint = string
otlp_http_endpoint = string
send_batch_size = number
timeout = string
})
default = {
otlp_grpc_endpoint = "0.0.0.0:4317"
otlp_http_endpoint = "0.0.0.0:4318"
send_batch_size = 50
timeout = "30s"
}
}
variable "enable_custom_metrics" {
description = "Allows additional metrics collection for config elements in the `custom_metrics_config` config object. Automatic dashboards are not included"
type = bool
default = false
}
variable "custom_metrics_config" {
description = "Configuration object to enable custom metrics collection"
type = object({
ports = list(number)
# paths = optional(list(string), ["/metrics"])
# list of samples to be dropped by label prefix, ex: go_ -> discards go_.*
dropped_series_prefixes = list(string)
})
default = {
ports = []
dropped_series_prefixes = ["unspecified"]
}
}
variable "enable_java" {
description = "Enable Java workloads monitoring, alerting and default dashboards"
type = bool
default = false
}
variable "java_config" {
description = "Configuration object for Java/JMX monitoring"
type = object({
enable_alerting_rules = bool
enable_recording_rules = bool
enable_dashboards = bool
scrape_sample_limit = number
flux_gitrepository_name = string
flux_gitrepository_url = string
flux_gitrepository_branch = string
flux_kustomization_name = string
flux_kustomization_path = string
grafana_dashboard_url = string
prometheus_metrics_endpoint = string
})
# defaults are pre-computed in locals.tf, provide a full definition to override
default = null
}
variable "enable_nginx" {
description = "Enable NGINX workloads monitoring, alerting and default dashboards"
type = bool
default = false
}
variable "nginx_config" {
description = "Configuration object for NGINX monitoring"
type = object({
enable_alerting_rules = bool
enable_recording_rules = bool
enable_dashboards = bool
scrape_sample_limit = number
flux_gitrepository_name = string
flux_gitrepository_url = string
flux_gitrepository_branch = string
flux_kustomization_name = string
flux_kustomization_path = string
grafana_dashboard_url = string
prometheus_metrics_endpoint = string
})
# defaults are pre-computed in locals.tf, provide a full definition to override
default = null
}
variable "enable_logs" {
description = "Using AWS For FluentBit to collect cluster and application logs to Amazon CloudWatch"
type = bool
default = true
}
variable "logs_config" {
description = "Configuration object for logs collection"
type = object({
cw_log_retention_days = number
})
default = {
# Valid values are [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]
cw_log_retention_days = 90
}
}
variable "enable_fluxcd" {
description = "Enables or disables FluxCD. Disabling this might affect some data in the dashboards"
type = bool
default = true
}
variable "flux_config" {
description = "FluxCD configuration"
type = object({
create_namespace = bool
k8s_namespace = string
helm_chart_name = string
helm_chart_version = string
helm_release_name = string
helm_repo_url = string
helm_settings = map(string)
helm_values = map(any)
})
default = {
create_namespace = true
helm_chart_name = "flux2"
helm_chart_version = "2.7.0"
helm_release_name = "observability-fluxcd-addon"
helm_repo_url = "https://fluxcd-community.github.io/helm-charts"
helm_settings = {}
helm_values = {}
k8s_namespace = "flux-system"
}
nullable = false
}
variable "enable_grafana_operator" {
description = "Deploys Grafana Operator to EKS Cluster"
type = bool
default = true
}
variable "go_config" {
description = "Grafana Operator configuration"
type = object({
create_namespace = bool
helm_chart = string
helm_name = string
k8s_namespace = string
helm_release_name = string
helm_chart_version = string
})
default = {
create_namespace = true
helm_chart = "oci://ghcr.io/grafana-operator/helm-charts/grafana-operator"
helm_name = "grafana-operator"
k8s_namespace = "grafana-operator"
helm_release_name = "grafana-operator"
helm_chart_version = "v5.0.0-rc3"
}
nullable = false
}
variable "enable_external_secrets" {
description = "Installs External Secrets to EKS Cluster"
type = bool
default = true
}
variable "grafana_api_key" {
description = "Grafana API key for the Amazon Managed Grafana workspace. Required if `enable_external_secrets = true`"
type = string
default = ""
}
variable "grafana_url" {
description = "Endpoint URL of Amazon Managed Grafana workspace. Required if `enable_grafana_operator = true`"
type = string
default = ""
}
variable "grafana_cluster_dashboard_url" {
description = "Dashboard URL for Cluster Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/cluster.json"
}
variable "grafana_kubelet_dashboard_url" {
description = "Dashboard URL for Kubelet Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/kubelet.json"
}
variable "grafana_namespace_workloads_dashboard_url" {
description = "Dashboard URL for Namespace Workloads Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/namespace-workloads.json"
}
variable "grafana_node_exporter_dashboard_url" {
description = "Dashboard URL for Node Exporter Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/nodeexporter-nodes.json"
}
variable "grafana_nodes_dashboard_url" {
description = "Dashboard URL for Nodes Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/nodes.json"
}
variable "grafana_workloads_dashboard_url" {
description = "Dashboard URL for Workloads Grafana Dashboard JSON"
type = string
default = "https://raw.githubusercontent.com/aws-observability/aws-observability-accelerator/main/artifacts/grafana-dashboards/eks/infrastructure/workloads.json"
}
variable "target_secret_name" {
description = "Target secret in Kubernetes to store the Grafana API Key Secret"
type = string
default = "grafana-admin-credentials"
}
variable "target_secret_namespace" {
description = "Target namespace of secret in Kubernetes to store the Grafana API Key Secret"
type = string
default = "grafana-operator"
}