Merge pull request #16 from aws-observability/docs-and-wording

Docs and wording

README.md

@@ -47,13 +47,13 @@ module "eks_observability_accelerator" {
   aws_region = "eu-west-1"
   eks_cluster_id = "my-eks-cluster"
 
-  # prevents creation of a new AMP workspace
+  # prevents creation of a new Amazon Managed Prometheus workspace
   enable_managed_prometheus = false
 
-  # reusing existing AMP
+  # reusing existing Amazon Managed Prometheus Workspace
   managed_prometheus_workspace_id     = "ws-abcd123..."
 
-  # prevents creation of a new AMG workspace
+  # prevents creation of a new Amazon Managed Grafana workspace
   enable_managed_grafana       = false
 
   managed_grafana_workspace_id = "g-abcdef123"
@@ -71,8 +71,6 @@ metrics collection, alerting rule and Grafana dashboards.
 
 #### Infrastructure monitoring
 
-
-
 ```hcl
 module "workloads_infra" {
   source = "aws-observability/terrarom-aws-observability-accelerator/workloads/infra"
@@ -153,18 +151,17 @@ If you are interested in contributing to EKS Blueprints, see the Contribution (h
 |------|-------------|------|---------|:--------:|
 | <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS Region | `string` | n/a | yes |
 | <a name="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id) | EKS Cluster Id | `string` | n/a | yes |
-| <a name="input_enable_alertmanager"></a> [enable\_alertmanager](#input\_enable\_alertmanager) | Creates AMP AlertManager for all workloads | `bool` | `false` | no |
+| <a name="input_enable_alertmanager"></a> [enable\_alertmanager](#input\_enable\_alertmanager) | Creates Amazon Managed Service for Prometheus AlertManager for all workloads | `bool` | `false` | no |
 | <a name="input_enable_amazon_eks_adot"></a> [enable\_amazon\_eks\_adot](#input\_enable\_amazon\_eks\_adot) | Enables the ADOT Operator on the EKS Cluster | `bool` | `true` | no |
 | <a name="input_enable_cert_manager"></a> [enable\_cert\_manager](#input\_enable\_cert\_manager) | Allow reusing an existing installation of cert-manager | `bool` | `true` | no |
-| <a name="input_enable_managed_grafana"></a> [enable\_managed\_grafana](#input\_enable\_managed\_grafana) | Creates a new Amazon Managed Grafana (AMG) Workspace | `bool` | `true` | no |
+| <a name="input_enable_managed_grafana"></a> [enable\_managed\_grafana](#input\_enable\_managed\_grafana) | Creates a new Amazon Managed Grafana Workspace | `bool` | `true` | no |
-| <a name="input_enable_managed_prometheus"></a> [enable\_managed\_prometheus](#input\_enable\_managed\_prometheus) | Creates a new AMP workspace | `bool` | `true` | no |
+| <a name="input_enable_managed_prometheus"></a> [enable\_managed\_prometheus](#input\_enable\_managed\_prometheus) | Creates a new Amazon Managed Service for Prometheus Workspace | `bool` | `true` | no |
-| <a name="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key) | Grafana API key for the AMG workspace | `string` | `null` | no |
+| <a name="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key) | Grafana API key for the Amazon Managed Grafana workspace | `string` | `null` | no |
 | <a name="input_irsa_iam_permissions_boundary"></a> [irsa\_iam\_permissions\_boundary](#input\_irsa\_iam\_permissions\_boundary) | IAM permissions boundary for IRSA roles | `string` | `""` | no |
 | <a name="input_irsa_iam_role_path"></a> [irsa\_iam\_role\_path](#input\_irsa\_iam\_role\_path) | IAM role path for IRSA roles | `string` | `"/"` | no |
-| <a name="input_managed_grafana_region"></a> [managed\_grafana\_region](#input\_managed\_grafana\_region) | Region where AMG is deployed | `string` | `null` | no |
+| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana Workspace ID | `string` | `""` | no |
-| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | AMG Workspace ID | `string` | `""` | no |
+| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Service for Prometheus Workspace ID | `string` | `""` | no |
-| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | AMP Workspace ID | `string` | `""` | no |
+| <a name="input_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#input\_managed\_prometheus\_workspace\_region) | Region where Amazon Managed Service for Prometheus is deployed | `string` | `null` | no |
-| <a name="input_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#input\_managed\_prometheus\_workspace\_region) | Region where AMP is deployed | `string` | `null` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `map('BusinessUnit`,`XYZ`) | `map(string)` | `{}` | no |
 
 ## Outputs
@@ -173,12 +170,12 @@ If you are interested in contributing to EKS Blueprints, see the Contribution (h
 |------|-------------|
 | <a name="output_aws_region"></a> [aws\_region](#output\_aws\_region) | EKS Cluster Id |
 | <a name="output_eks_cluster_id"></a> [eks\_cluster\_id](#output\_eks\_cluster\_id) | EKS Cluster Id |
-| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | n/a |
+| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | EKS Cluster version |
-| <a name="output_grafana_dashboards_folder_id"></a> [grafana\_dashboards\_folder\_id](#output\_grafana\_dashboards\_folder\_id) | n/a |
+| <a name="output_grafana_dashboards_folder_id"></a> [grafana\_dashboards\_folder\_id](#output\_grafana\_dashboards\_folder\_id) | Grafana folder ID for automatic dashboards. Required by workload modules |
-| <a name="output_managed_grafana_workspace_endpoint"></a> [managed\_grafana\_workspace\_endpoint](#output\_managed\_grafana\_workspace\_endpoint) | n/a |
+| <a name="output_managed_grafana_workspace_endpoint"></a> [managed\_grafana\_workspace\_endpoint](#output\_managed\_grafana\_workspace\_endpoint) | Amazon Managed Grafana workspace endpoint |
-| <a name="output_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#output\_managed\_prometheus\_workspace\_endpoint) | n/a |
+| <a name="output_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#output\_managed\_prometheus\_workspace\_endpoint) | Amazon Managed Prometheus workspace endpoint |
-| <a name="output_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#output\_managed\_prometheus\_workspace\_id) | n/a |
+| <a name="output_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#output\_managed\_prometheus\_workspace\_id) | Amazon Managed Prometheus workspace ID |
-| <a name="output_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#output\_managed\_prometheus\_workspace\_region) | n/a |
+| <a name="output_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#output\_managed\_prometheus\_workspace\_region) | Amazon Managed Prometheus workspace region |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Contributing

examples/eks-cluster-with-vpc/main.tf

@@ -23,7 +23,7 @@ data "aws_eks_cluster_auth" "this" {
 data "aws_availability_zones" "available" {}
 
 locals {
-  name = basename(path.cwd)
+  name         = basename(path.cwd)
   cluster_name = coalesce(var.cluster_name, local.name)
   region       = var.aws_region
 

examples/existing-cluster-with-base-and-infra/README.md

@@ -131,7 +131,7 @@ add this `managed_prometheus_region=xxx` and `managed_prometheus_workspace_id=ws
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | 1.25.0 |
+| <a name="requirement_grafana"></a> [grafana](#requirement\_grafana) | >= 1.25.0 |
 
 ## Providers
 
@@ -160,11 +160,9 @@ add this `managed_prometheus_region=xxx` and `managed_prometheus_workspace_id=ws
 | <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS Region | `string` | n/a | yes |
 | <a name="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id) | EKS Cluster Id | `string` | n/a | yes |
 | <a name="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key) | API key for authorizing the Grafana provider to make changes to Amazon Managed Grafana | `string` | `""` | no |
-| <a name="input_grafana_endpoint"></a> [grafana\_endpoint](#input\_grafana\_endpoint) | AMG endpoint | `string` | `null` | no |
+| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana Workspace ID | `string` | `""` | no |
-| <a name="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana (AMG) workspace ID | `string` | `""` | no |
+| <a name="input_managed_prometheus_endpoint"></a> [managed\_prometheus\_endpoint](#input\_managed\_prometheus\_endpoint) | Amazon Managed Service for Prometheus Workspace ID | `string` | `""` | no |
-| <a name="input_managed_prometheus_endpoint"></a> [managed\_prometheus\_endpoint](#input\_managed\_prometheus\_endpoint) | AMP workspace ID | `string` | `""` | no |
+| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Service for Prometheus Workspace ID | `string` | `""` | no |
-| <a name="input_managed_prometheus_region"></a> [managed\_prometheus\_region](#input\_managed\_prometheus\_region) | Region where AMP is deployed | `string` | `""` | no |
-| <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Service for Prometheus (AMP) workspace ID | `string` | `""` | no |
 
 ## Outputs
 
@@ -172,7 +170,7 @@ add this `managed_prometheus_region=xxx` and `managed_prometheus_workspace_id=ws
 |------|-------------|
 | <a name="output_aws_region"></a> [aws\_region](#output\_aws\_region) | AWS Region |
 | <a name="output_eks_cluster_id"></a> [eks\_cluster\_id](#output\_eks\_cluster\_id) | EKS Cluster Id |
-| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | n/a |
+| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | EKS Cluster version |
-| <a name="output_prometheus_endpoint"></a> [prometheus\_endpoint](#output\_prometheus\_endpoint) | n/a |
+| <a name="output_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#output\_managed\_prometheus\_workspace\_endpoint) | Amazon Managed Prometheus workspace endpoint |
-| <a name="output_prometheus_id"></a> [prometheus\_id](#output\_prometheus\_id) | n/a |
+| <a name="output_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#output\_managed\_prometheus\_workspace\_id) | Amazon Managed Prometheus workspace ID |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/existing-cluster-with-base-and-infra/main.tf

@@ -34,15 +34,9 @@ terraform {
 }
 
 locals {
-  name   = basename(path.cwd)
+  region               = var.aws_region
-  region = var.aws_region
-
-  eks_oidc_issuer_url  = replace(data.aws_eks_cluster.this.identity[0].oidc[0].issuer, "https://", "")
   eks_cluster_endpoint = data.aws_eks_cluster.this.endpoint
-  eks_cluster_version  = data.aws_eks_cluster.this.version
-
   create_new_workspace = var.managed_prometheus_workspace_id == "" ? true : false
-
   tags = {
     Source = "github.com/aws-observability/terraform-aws-observability-accelerator"
   }
@@ -62,14 +56,14 @@ module "eks_observability_accelerator" {
   # reusing existing certificate manager? defaults to true
   enable_cert_manager = true
 
-  # creates a new AMP workspace, defaults to true
+  # creates a new Amazon Managed Prometheus workspace, defaults to true
   enable_managed_prometheus = local.create_new_workspace
 
-  # reusing existing AMP if specified
+  # reusing existing Amazon Managed Prometheus if specified
   managed_prometheus_workspace_id     = var.managed_prometheus_workspace_id
   managed_prometheus_workspace_region = null # defaults to the current region, useful for cross region scenarios (same account)
 
-  # sets up the AMP alert manager at the workspace level
+  # sets up the Amazon Managed Prometheus alert manager at the workspace level
   enable_alertmanager = true
 
   # reusing existing Amazon Managed Grafana workspace

examples/existing-cluster-with-base-and-infra/outputs.tf

@@ -9,14 +9,16 @@ output "aws_region" {
 }
 
 output "eks_cluster_version" {
-  value = module.eks_observability_accelerator.eks_cluster_version
+  description = "EKS Cluster version"
+  value       = module.eks_observability_accelerator.eks_cluster_version
 }
 
-
+output "managed_prometheus_workspace_endpoint" {
-output "prometheus_endpoint" {
+  description = "Amazon Managed Prometheus workspace endpoint"
-  value = module.eks_observability_accelerator.managed_prometheus_workspace_endpoint
+  value       = module.eks_observability_accelerator.managed_prometheus_workspace_endpoint
 }
 
-output "prometheus_id" {
+output "managed_prometheus_workspace_id" {
-  value = module.eks_observability_accelerator.managed_prometheus_workspace_id
+  description = "Amazon Managed Prometheus workspace ID"
+  value       = module.eks_observability_accelerator.managed_prometheus_workspace_id
 }

examples/existing-cluster-with-base-and-infra/variables.tf

@@ -7,30 +7,20 @@ variable "aws_region" {
   type        = string
 }
 variable "managed_prometheus_workspace_id" {
-  description = "Amazon Managed Service for Prometheus (AMP) workspace ID"
+  description = "Amazon Managed Service for Prometheus Workspace ID"
   type        = string
   default     = ""
 }
 variable "managed_prometheus_endpoint" {
-  description = "AMP workspace ID"
+  description = "Amazon Managed Service for Prometheus Workspace ID"
-  type        = string
-  default     = ""
-}
-variable "managed_prometheus_region" {
-  description = "Region where AMP is deployed"
   type        = string
   default     = ""
 }
 variable "managed_grafana_workspace_id" {
-  description = "Amazon Managed Grafana (AMG) workspace ID"
+  description = "Amazon Managed Grafana Workspace ID"
   type        = string
   default     = ""
 }
-variable "grafana_endpoint" {
-  description = "AMG endpoint"
-  type        = string
-  default     = null
-}
 variable "grafana_api_key" {
   description = "API key for authorizing the Grafana provider to make changes to Amazon Managed Grafana"
   type        = string

locals.tf

@@ -23,15 +23,9 @@ locals {
   amp_ws_id       = var.enable_managed_prometheus ? aws_prometheus_workspace.this[0].id : var.managed_prometheus_workspace_id
   amp_ws_endpoint = "https://aps-workspaces.${local.amp_ws_region}.amazonaws.com/workspaces/${local.amp_ws_id}/"
 
-  # if region is not passed, we assume the current one
-  amg_ws_region = coalesce(var.managed_grafana_region, data.aws_region.current.name)
-
   # if grafana_workspace_id is supplied, we infer the endpoint from
   # computed region, else we create a new workspace
   amg_ws_endpoint = var.managed_grafana_workspace_id == "" ? "https://${module.managed_grafana[0].workspace_endpoint}" : "https://${data.aws_grafana_workspace.this[0].endpoint}"
-  amg_ws_id       = var.managed_grafana_workspace_id == "" ? module.managed_grafana[0].workspace_ : data.aws_grafana_workspace.this[0].endpoint
-
-  amg_api_key = var.grafana_api_key
 
   context = {
     aws_caller_identity_account_id = data.aws_caller_identity.current.account_id

main.tf

@@ -1,5 +1,6 @@
 module "operator" {
   source = "./modules/add-ons/adot-operator"
+  count  = var.enable_amazon_eks_adot ? 1 : 0
 
   enable_cert_manager = var.enable_cert_manager
   kubernetes_version  = local.eks_cluster_version

modules/add-ons/adot-operator/README.md

@@ -61,9 +61,9 @@ the ADOT Operator.
 |------|-------------|------|---------|:--------:|
 | <a name="input_addon_config"></a> [addon\_config](#input\_addon\_config) | Amazon EKS Managed CoreDNS Add-on config | `any` | `{}` | no |
 | <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br>    aws_caller_identity_account_id = string<br>    aws_caller_identity_arn        = string<br>    aws_eks_cluster_endpoint       = string<br>    aws_partition_id               = string<br>    aws_region_name                = string<br>    eks_cluster_id                 = string<br>    eks_oidc_issuer_url            = string<br>    eks_oidc_provider_arn          = string<br>    irsa_iam_role_path             = string<br>    tags                           = map(string)<br>  })</pre> | n/a | yes |
-| <a name="input_enable_cert_manager"></a> [enable\_cert\_manager](#input\_enable\_cert\_manager) | n/a | `bool` | `true` | no |
+| <a name="input_enable_cert_manager"></a> [enable\_cert\_manager](#input\_enable\_cert\_manager) | Enable cert-manager, a requirement for ADOT Operator | `bool` | `true` | no |
-| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config for ADOT Operator AddOn | `any` | `{}` | no |
+| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config for ADOT Operator AddOn | `any` | <pre>{<br>  "version": "v1.8.2"<br>}</pre> | no |
-| <a name="input_kubernetes_version"></a> [kubernetes\_version](#input\_kubernetes\_version) | n/a | `string` | n/a | yes |
+| <a name="input_kubernetes_version"></a> [kubernetes\_version](#input\_kubernetes\_version) | EKS Cluster version | `string` | n/a | yes |
 
 ## Outputs
 

modules/add-ons/adot-operator/main.tf

@@ -2,7 +2,7 @@ module "cert_manager" {
   source = "github.com/aws-ia/terraform-aws-eks-blueprints/modules/kubernetes-addons/cert-manager"
   count  = var.enable_cert_manager ? 1 : 0
 
-  helm_config   = { version = "v1.8.2" }
+  helm_config   = var.helm_config
   addon_context = var.addon_context
 }
 

modules/add-ons/adot-operator/variables.tf

@@ -1,7 +1,7 @@
 variable "helm_config" {
   description = "Helm provider config for ADOT Operator AddOn"
   type        = any
-  default     = {}
+  default     = { version = "v1.8.2" }
 }
 
 variable "addon_context" {
@@ -21,12 +21,14 @@ variable "addon_context" {
 }
 
 variable "enable_cert_manager" {
-  type    = bool
+  description = "Enable cert-manager, a requirement for ADOT Operator"
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "kubernetes_version" {
-  type = string
+  description = "EKS Cluster version"
+  type        = string
 }
 
 variable "addon_config" {

modules/workloads/infra/README.md

@@ -33,16 +33,9 @@ This module provides EKS cluster monitoring with the following resources:
 |------|------|
 | [aws_prometheus_rule_group_namespace.alerting_rules](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/prometheus_rule_group_namespace) | resource |
 | [aws_prometheus_rule_group_namespace.recording_rules](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/prometheus_rule_group_namespace) | resource |
-| [grafana_dashboard.apis](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.cluster](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.clusternw](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.controller](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.coredns](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.etcd](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.kubelet](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.necluster](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.nenode](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.nenodeuse](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.nodes](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.nsnw](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.nsnwworkload](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
@@ -51,9 +44,6 @@ This module provides EKS cluster monitoring with the following resources:
 | [grafana_dashboard.nwworload](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.podnetwork](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.pods](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.proxy](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.pv](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
-| [grafana_dashboard.scheduler](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [grafana_dashboard.workloads](https://registry.terraform.io/providers/grafana/grafana/1.25.0/docs/resources/dashboard) | resource |
 | [helm_release.kube_state_metrics](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
 | [helm_release.prometheus_node_exporter](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
@@ -66,20 +56,21 @@ This module provides EKS cluster monitoring with the following resources:
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_config"></a> [config](#input\_config) | n/a | <pre>object({<br>    helm_config = map(any)<br><br>    kms_create_namespace   = bool<br>    ksm_k8s_namespace      = string<br>    ksm_helm_chart_name    = string<br>    ksm_helm_chart_version = string<br>    ksm_helm_release_name  = string<br>    ksm_helm_repo_url      = string<br>    ksm_helm_settings      = map(string)<br>    ksm_helm_values        = map(any)<br><br>    ne_create_namespace   = bool<br>    ne_k8s_namespace      = string<br>    ne_helm_chart_name    = string<br>    ne_helm_chart_version = string<br>    ne_helm_release_name  = string<br>    ne_helm_repo_url      = string<br>    ne_helm_settings      = map(string)<br>    ne_helm_values        = map(any)<br><br>  })</pre> | <pre>{<br>  "enable_kube_state_metrics": true,<br>  "enable_node_exporter": true,<br>  "helm_config": {},<br>  "kms_create_namespace": true,<br>  "ksm_helm_chart_name": "kube-state-metrics",<br>  "ksm_helm_chart_version": "4.9.2",<br>  "ksm_helm_release_name": "kube-state-metrics",<br>  "ksm_helm_repo_url": "https://prometheus-community.github.io/helm-charts",<br>  "ksm_helm_settings": {},<br>  "ksm_helm_values": {},<br>  "ksm_k8s_namespace": "kube-system",<br>  "ne_create_namespace": true,<br>  "ne_helm_chart_name": "prometheus-node-exporter",<br>  "ne_helm_chart_version": "2.0.3",<br>  "ne_helm_release_name": "prometheus-node-exporter",<br>  "ne_helm_repo_url": "https://prometheus-community.github.io/helm-charts",<br>  "ne_helm_settings": {},<br>  "ne_helm_values": {},<br>  "ne_k8s_namespace": "prometheus-node-exporter"<br>}</pre> | no |
+| <a name="input_dashboards_folder_id"></a> [dashboards\_folder\_id](#input\_dashboards\_folder\_id) | Grafana folder ID for automatic dashboards | `string` | n/a | yes |
-| <a name="input_dashboards_folder_id"></a> [dashboards\_folder\_id](#input\_dashboards\_folder\_id) | n/a | `string` | n/a | yes |
 | <a name="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id) | EKS Cluster Id | `string` | n/a | yes |
-| <a name="input_enable_alerting_rules"></a> [enable\_alerting\_rules](#input\_enable\_alerting\_rules) | n/a | `bool` | `true` | no |
+| <a name="input_enable_alerting_rules"></a> [enable\_alerting\_rules](#input\_enable\_alerting\_rules) | Enables or disables Managed Prometheus alerting rules | `bool` | `true` | no |
-| <a name="input_enable_dashboards"></a> [enable\_dashboards](#input\_enable\_dashboards) | n/a | `bool` | `true` | no |
+| <a name="input_enable_dashboards"></a> [enable\_dashboards](#input\_enable\_dashboards) | Enables or disables curated dashboards | `bool` | `true` | no |
-| <a name="input_enable_kube_state_metrics"></a> [enable\_kube\_state\_metrics](#input\_enable\_kube\_state\_metrics) | n/a | `bool` | `true` | no |
+| <a name="input_enable_kube_state_metrics"></a> [enable\_kube\_state\_metrics](#input\_enable\_kube\_state\_metrics) | Enables or disables Kube State metrics exporter. Disabling this might affect some data in the dashboards | `bool` | `true` | no |
-| <a name="input_enable_node_exporter"></a> [enable\_node\_exporter](#input\_enable\_node\_exporter) | n/a | `bool` | `true` | no |
+| <a name="input_enable_node_exporter"></a> [enable\_node\_exporter](#input\_enable\_node\_exporter) | Enables or disables Node exporter. Disabling this might affect some data in the dashboards | `bool` | `true` | no |
-| <a name="input_enable_recording_rules"></a> [enable\_recording\_rules](#input\_enable\_recording\_rules) | n/a | `bool` | `true` | no |
+| <a name="input_enable_recording_rules"></a> [enable\_recording\_rules](#input\_enable\_recording\_rules) | Enables or disables Managed Prometheus recording rules. Disabling this might affect some data in the dashboards | `bool` | `true` | no |
 | <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm Config for Prometheus | `any` | `{}` | no |
 | <a name="input_irsa_iam_permissions_boundary"></a> [irsa\_iam\_permissions\_boundary](#input\_irsa\_iam\_permissions\_boundary) | IAM permissions boundary for IRSA roles | `string` | `""` | no |
 | <a name="input_irsa_iam_role_path"></a> [irsa\_iam\_role\_path](#input\_irsa\_iam\_role\_path) | IAM role path for IRSA roles | `string` | `"/"` | no |
+| <a name="input_ksm_config"></a> [ksm\_config](#input\_ksm\_config) | Kube State metrics configuration | <pre>object({<br>    create_namespace   = bool<br>    k8s_namespace      = string<br>    helm_chart_name    = string<br>    helm_chart_version = string<br>    helm_release_name  = string<br>    helm_repo_url      = string<br>    helm_settings      = map(string)<br>    helm_values        = map(any)<br>  })</pre> | <pre>{<br>  "create_namespace": true,<br>  "helm_chart_name": "kube-state-metrics",<br>  "helm_chart_version": "4.16.0",<br>  "helm_release_name": "kube-state-metrics",<br>  "helm_repo_url": "https://prometheus-community.github.io/helm-charts",<br>  "helm_settings": {},<br>  "helm_values": {},<br>  "k8s_namespace": "kube-system"<br>}</pre> | no |
 | <a name="input_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#input\_managed\_prometheus\_workspace\_endpoint) | Amazon Managed Prometheus Workspace Endpoint | `string` | `null` | no |
 | <a name="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id) | Amazon Managed Prometheus Workspace ID | `string` | `null` | no |
 | <a name="input_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#input\_managed\_prometheus\_workspace\_region) | Amazon Managed Prometheus Workspace's Region | `string` | `null` | no |
+| <a name="input_ne_config"></a> [ne\_config](#input\_ne\_config) | Node exporter configuration | <pre>object({<br>    create_namespace   = bool<br>    k8s_namespace      = string<br>    helm_chart_name    = string<br>    helm_chart_version = string<br>    helm_release_name  = string<br>    helm_repo_url      = string<br>    helm_settings      = map(string)<br>    helm_values        = map(any)<br>  })</pre> | <pre>{<br>  "create_namespace": true,<br>  "helm_chart_name": "prometheus-node-exporter",<br>  "helm_chart_version": "2.0.3",<br>  "helm_release_name": "prometheus-node-exporter",<br>  "helm_repo_url": "https://prometheus-community.github.io/helm-charts",<br>  "helm_settings": {},<br>  "helm_values": {},<br>  "k8s_namespace": "prometheus-node-exporter"<br>}</pre> | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `map('BusinessUnit`,`XYZ`) | `map(string)` | `{}` | no |
 
 ## Outputs

modules/workloads/infra/dashboards.tf

@@ -68,4 +68,4 @@ resource "grafana_dashboard" "cluster" {
   count       = var.enable_dashboards ? 1 : 0
   folder      = var.dashboards_folder_id
   config_json = file("${path.module}/dashboards/cluster.json")
-}
+}

modules/workloads/infra/dashboards/cluster-networking.json

@@ -1742,4 +1742,4 @@
   "uid": "ff635a025bcfea7bc3dd4f508990a3e9",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/cluster.json

@@ -2944,4 +2944,4 @@
   "uid": "efa86fd1d0c121a26444b636a3f509a8",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/kubelet.json

@@ -1983,4 +1983,4 @@
   "uid": "3138fa155d5915769fbded898ac09fd9",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/namespace-networking.json

@@ -1399,4 +1399,4 @@
   "uid": "8b7a8b326d7a6f1f04244066368c67af",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/namespace-nw-workloads.json

@@ -1632,4 +1632,4 @@
   "uid": "bbb2a765a623ae38130206c7d94a160f",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/namespace-pods.json

@@ -2718,4 +2718,4 @@
   "uid": "85a562078cdf77779eaa1add43ccec1e",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/namespace-workloads.json

@@ -2274,4 +2274,4 @@
   "uid": "a87fb0d919ec0ea5f6543124e16c42a5",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/networking-workloads.json

@@ -1352,4 +1352,4 @@
   "uid": "728bf77cc1166d2f3133bf25846876cc",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/nodes.json

@@ -1049,4 +1049,4 @@
   "uid": "200ac8fdbfbb74b39aff88118e4d1c2c",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/pods-networking.json

@@ -1179,4 +1179,4 @@
   "uid": "7a18067ce943a40ae25454675c19ff5c",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/pods.json

@@ -2483,4 +2483,4 @@
   "uid": "6581e46e4e5c7ba40a07646395ef7b23",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/dashboards/workloads.json

@@ -2031,4 +2031,4 @@
   "uid": "a164a7f0339f99e89cea5cb47e9be617",
   "version": 1,
   "weekStart": ""
-}
+}

modules/workloads/infra/variables.tf

@@ -39,30 +39,36 @@ variable "managed_prometheus_workspace_region" {
 }
 
 variable "dashboards_folder_id" {
-  type = string
+  description = "Grafana folder ID for automatic dashboards"
+  type        = string
 }
 
 variable "enable_recording_rules" {
-  type    = bool
+  description = "Enables or disables Managed Prometheus recording rules. Disabling this might affect some data in the dashboards"
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "enable_alerting_rules" {
-  type    = bool
+  description = "Enables or disables Managed Prometheus alerting rules"
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "enable_dashboards" {
-  type    = bool
+  description = "Enables or disables curated dashboards"
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "enable_kube_state_metrics" {
-  type    = bool
+  description = "Enables or disables Kube State metrics exporter. Disabling this might affect some data in the dashboards"
-  default = true
+  type        = bool
+  default     = true
 }
 
 variable "ksm_config" {
+  description = "Kube State metrics configuration"
   type = object({
     create_namespace   = bool
     k8s_namespace      = string
@@ -88,10 +94,13 @@ variable "ksm_config" {
 }
 
 variable "enable_node_exporter" {
-  type    = bool
+  description = "Enables or disables Node exporter. Disabling this might affect some data in the dashboards"
-  default = true
+  type        = bool
+  default     = true
 }
+
 variable "ne_config" {
+  description = "Node exporter configuration"
   type = object({
     create_namespace   = bool
     k8s_namespace      = string

modules/workloads/java/README.md

@@ -42,7 +42,7 @@ This module provides monitoring for Java based workloads with the following reso
 | <a name="input_amp_endpoint"></a> [amp\_endpoint](#input\_amp\_endpoint) | Amazon Managed Prometheus endpoint | `string` | n/a | yes |
 | <a name="input_amp_id"></a> [amp\_id](#input\_amp\_id) | Managed Prometheus workspace id | `string` | n/a | yes |
 | <a name="input_amp_region"></a> [amp\_region](#input\_amp\_region) | Amazon Managed Prometheus Workspace's Region | `string` | `null` | no |
-| <a name="input_dashboards_folder_id"></a> [dashboards\_folder\_id](#input\_dashboards\_folder\_id) | n/a | `string` | n/a | yes |
+| <a name="input_dashboards_folder_id"></a> [dashboards\_folder\_id](#input\_dashboards\_folder\_id) | Grafana folder ID for automatic dashboards | `string` | n/a | yes |
 | <a name="input_enable_recording_rules"></a> [enable\_recording\_rules](#input\_enable\_recording\_rules) | Enable AMP recording rules | `bool` | `true` | no |
 | <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm Config for Prometheus | `any` | `{}` | no |
 

modules/workloads/java/variables.tf

@@ -27,7 +27,8 @@ variable "amp_region" {
 }
 
 variable "dashboards_folder_id" {
-  type = string
+  description = "Grafana folder ID for automatic dashboards"
+  type        = string
 }
 
 variable "addon_context" {

modules/workloads/nginx/dashboards/default.json

@@ -1451,4 +1451,4 @@
   "uid": "nginx",
   "version": 1,
   "description": "Ingress-nginx supports a rich collection of prometheus metrics. If you have prometheus and grafana installed on your cluster then prometheus will already be scraping this data due to the scrape annotation on the deployment."
-}
+}

outputs.tf

@@ -9,25 +9,31 @@ output "aws_region" {
 }
 
 output "eks_cluster_version" {
-  value = data.aws_eks_cluster.eks_cluster.version
+  description = "EKS Cluster version"
+  value       = data.aws_eks_cluster.eks_cluster.version
 }
 
 output "managed_prometheus_workspace_endpoint" {
-  value = local.amp_ws_endpoint
+  description = "Amazon Managed Prometheus workspace endpoint"
+  value       = local.amp_ws_endpoint
 }
 
 output "managed_prometheus_workspace_id" {
-  value = local.amp_ws_id
+  description = "Amazon Managed Prometheus workspace ID"
+  value       = local.amp_ws_id
 }
 
 output "managed_prometheus_workspace_region" {
-  value = local.amp_ws_region
+  description = "Amazon Managed Prometheus workspace region"
+  value       = local.amp_ws_region
 }
 
 output "managed_grafana_workspace_endpoint" {
-  value = local.amg_ws_endpoint
+  description = "Amazon Managed Grafana workspace endpoint"
+  value       = local.amg_ws_endpoint
 }
 
 output "grafana_dashboards_folder_id" {
-  value = grafana_folder.this.id
+  description = "Grafana folder ID for automatic dashboards. Required by workload modules"
+  value       = grafana_folder.this.id
 }

variables.tf

@@ -33,47 +33,42 @@ variable "enable_cert_manager" {
 }
 
 variable "enable_managed_prometheus" {
-  description = "Creates a new AMP workspace"
+  description = "Creates a new Amazon Managed Service for Prometheus Workspace"
   type        = bool
   default     = true
 }
 
 variable "managed_prometheus_workspace_id" {
-  description = "AMP Workspace ID"
+  description = "Amazon Managed Service for Prometheus Workspace ID"
   type        = string
   default     = ""
 }
 
 variable "managed_prometheus_workspace_region" {
-  description = "Region where AMP is deployed"
+  description = "Region where Amazon Managed Service for Prometheus is deployed"
   type        = string
   default     = null
 }
 
 variable "enable_alertmanager" {
-  description = "Creates AMP AlertManager for all workloads"
+  description = "Creates Amazon Managed Service for Prometheus AlertManager for all workloads"
   type        = bool
   default     = false
 }
 
 variable "enable_managed_grafana" {
-  description = "Creates a new Amazon Managed Grafana (AMG) Workspace"
+  description = "Creates a new Amazon Managed Grafana Workspace"
   type        = bool
   default     = true
 }
 
-variable "managed_grafana_region" {
-  description = "Region where AMG is deployed"
-  type        = string
-  default     = null
-}
 variable "managed_grafana_workspace_id" {
-  description = "AMG Workspace ID"
+  description = "Amazon Managed Grafana Workspace ID"
   type        = string
   default     = ""
 }
 variable "grafana_api_key" {
-  description = "Grafana API key for the AMG workspace"
+  description = "Grafana API key for the Amazon Managed Grafana workspace"
   type        = string
   default     = null
 }