refs platform/#2586: change values input from string to list(string)

sparkfabrik · Nov 30, 2023 · ab7aa2c · ab7aa2c
1 parent a155929
commit ab7aa2c
Show file tree

Hide file tree

Showing 11 changed files with 347 additions and 129 deletions.
diff --git a/.github/workflows/tflint.yml b/.github/workflows/tflint.yml
@@ -1,8 +1,9 @@
 name: Lint
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
+    types: [opened, synchronize]
 
 jobs:
   tflint:
@@ -13,26 +14,23 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-    - uses: actions/checkout@v3
-      name: Checkout source code
+      - uses: actions/checkout@v4
+        name: Checkout source code
 
-    - uses: actions/cache@v2
-      name: Cache plugin dir
-      with:
-        path: ~/.tflint.d/plugins
-        key: ${{ matrix.os }}-tflint-${{ hashFiles('.tflint.hcl') }}
+      - uses: actions/cache@v3
+        name: Cache plugin dir
+        with:
+          path: ~/.tflint.d/plugins
+          key: ${{ matrix.os }}-tflint-${{ hashFiles('.tflint.hcl') }}
 
-    - uses: terraform-linters/setup-tflint@v1
-      name: Setup TFLint
-      with:
-        tflint_version: v0.29.0
+      - uses: terraform-linters/setup-tflint@v4
+        name: Setup TFLint
 
-    - name: Show version
-      run: tflint --version
+      - name: Show version
+        run: tflint --version
 
-    - name: Init TFLint
-      run: tflint --init
-
-    - name: Run TFLint
-      run: tflint -f compact
+      - name: Init TFLint
+        run: tflint --init
 
+      - name: Run TFLint
+        run: tflint -f compact
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,26 @@
+# Local .terraform directories
+**/.terraform/*
+.terraform.lock.hcl
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+
+# IDE files
 .idea
-/tmp
-.vscode
+
+# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
+# .tfvars files are managed as part of configuration and so should be included in
+# version control.
+#
+# example.tfvars
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
diff --git a/.terraform-docs.yml b/.terraform-docs.yml
@@ -0,0 +1,61 @@
+# Refs: https://github.com/terraform-docs/terraform-docs
+formatter: "" # this is required
+
+version: ""
+
+header-from: main.tf
+footer-from: ""
+
+recursive:
+  enabled: false
+  path: modules
+
+sections:
+  hide: []
+  show: []
+
+content: |-
+  {{ .Providers }}
+
+  {{ .Requirements }}
+
+  {{ .Inputs }}
+
+  {{ .Outputs }}
+
+  {{ .Resources }}
+
+  {{ .Modules }}
+
+  {{ .Footer }}
+
+output:
+  file: ""
+  mode: inject
+  template: |-
+    <!-- BEGIN_TF_DOCS -->
+    {{ .Content }}
+    <!-- END_TF_DOCS -->
+
+output-values:
+  enabled: false
+  from: ""
+
+sort:
+  enabled: true
+  by: name
+
+settings:
+  anchor: true
+  color: true
+  default: true
+  description: false
+  escape: true
+  hide-empty: false
+  html: true
+  indent: 2
+  lockfile: true
+  read-comments: true
+  required: true
+  sensitive: true
+  type: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
----
+## [3.0.0] - 2023-11-30
+
+[Compare with previous version](https://github.com/sparkfabrik/terraform-sparkfabrik-prometheus-stack/compare/2.1.0...3.0.0)
+
+### Changed
+
+- refs platform/#2586: the `prometheus_stack_additional_values` and `prometheus_adapter_additional_values` variables are now lists of strings instead of a single string. This allows to pass multiple values to the chart.
+- The kubernetes resources are now created using the `v1` version.
+- The `template_file` data sources are replaced with `templatefile` function calls.
+
+### Added
+
+- The `versions.tf` file is now present in the module root directory.
 
 ## [2.1.0] - 2023-06-13
 
@@ -28,7 +40,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.1.0] - 2022-09-07
 
-
 ## [1.0.0] - 2022-02-11
 
 ### Added

diff --git a/Makefile b/Makefile
@@ -1,4 +1,11 @@
-.PHONY: lint
-
 lint:
-	docker run --rm -v $${PWD}:/data -t ghcr.io/terraform-linters/tflint
+	docker run --rm -v $${PWD}:/data -t ghcr.io/terraform-linters/tflint --var-file=/data/examples/test.tfvars
+
+tfsec:
+	docker run --rm -it -v "$$(pwd):/src" aquasec/tfsec /src --tfvars-file=/src/examples/test.tfvars
+
+generate-docs: lint
+	docker run --rm -u $$(id -u) \
+		--volume "$(PWD):/terraform-docs" \
+		-w /terraform-docs \
+		quay.io/terraform-docs/terraform-docs:0.16.0 markdown table --config .terraform-docs.yml --output-file README.md --output-mode inject .
diff --git a/README.md b/README.md
@@ -66,8 +66,8 @@ module "kube_prometheus_stack" {
 ```
 
 # Updgrade from 1.1.0 to 2.0.0
- 
-Upgrading to 2.0.0 from 1.1.0 will destroy and recreate the basic auth password, which is now different from Grafana admin password, 
+
+Upgrading to 2.0.0 from 1.1.0 will destroy and recreate the basic auth password, which is now different from Grafana admin password,
 and will update the relative basic auth secret value.
 
 Upgrading to version 2.0.0 will also cause the destruction of the namespace, which now becomes an array.
@@ -80,3 +80,94 @@ moved {
   to   = moudle.MODULE_NAME.kubernetes_namespace.kube_prometheus_stack_namespace[0]
 }
 ```
+
+# Upgrading from 2.X.Y to 3.0.0
+
+Upgrading to `3.0.0` from `2.X.Y` will cause the destruction of the namespace and the basic auth secret.
+You will need to use the `moved` resource, to move the namespace and the secret as shown below:
+
+```hcl
+moved {
+  from = module.MODULE_NAME.kubernetes_namespace.kube_prometheus_stack_namespace[0]
+  to   = moudle.MODULE_NAME.kubernetes_namespace_v1.kube_prometheus_stack_namespace[0]
+}
+
+moved {
+  from = moudle.MODULE_NAME.kubernetes_secret.kube_prometheus_ingress_auth[0]
+  to   = moudle.MODULE_NAME.kubernetes_secret_v1.kube_prometheus_ingress_auth[0]
+}
+```
+
+Because of the change of the the `prometheus_stack_additional_values` and `prometheus_adapter_additional_values` variable types, from `string` to `list(string)`, you will need to change the way you pass the values to the module. If you are using a single value, you only need to wrap it in a list, as shown below:
+
+```hcl
+prometheus_stack_additional_values = [templatefile(
+  "${path.module}/files/kube-prometheus-stack/values.yaml",
+  {
+    var01 = "value01"
+    var02 = "value02"
+  }
+)]
+```
+
+<!-- BEGIN_TF_DOCS -->
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.0 |
+| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | >= 2.23 |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 3.0 |
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.0 |
+| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.0 |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | If true, the namespace will be created. If false, a namespace called as specified in you var.namespace variable, must exists in your Kubernetes cluster. | `bool` | `true` | no |
+| <a name="input_grafana_admin_user"></a> [grafana\_admin\_user](#input\_grafana\_admin\_user) | Grafana basic auth username. If the variable is left empty, the basic auth will not be activated and you will use only the standard Grafana authentication. | `string` | `"admin"` | no |
+| <a name="input_grafana_cluster_issuer_name"></a> [grafana\_cluster\_issuer\_name](#input\_grafana\_cluster\_issuer\_name) | Resource representing the cluster issuer of cert-manager (used to deploy a TLS certificate for Grafana ingress). If the variable is left empty, the annotations will not be added. | `string` | `""` | no |
+| <a name="input_grafana_ingress_basic_auth_message"></a> [grafana\_ingress\_basic\_auth\_message](#input\_grafana\_ingress\_basic\_auth\_message) | Grafana basic auth message. | `string` | `"Authentication Required"` | no |
+| <a name="input_grafana_ingress_basic_auth_username"></a> [grafana\_ingress\_basic\_auth\_username](#input\_grafana\_ingress\_basic\_auth\_username) | Grafana basic auth username. If the variable is left empty, the basic auth will not be activated and you will use only the standard Grafana authentication. | `string` | `"admin"` | no |
+| <a name="input_grafana_ingress_class"></a> [grafana\_ingress\_class](#input\_grafana\_ingress\_class) | Ingress Class | `string` | `"nginx"` | no |
+| <a name="input_grafana_ingress_host"></a> [grafana\_ingress\_host](#input\_grafana\_ingress\_host) | Grafana ingress host. If the variable is left empty, the ingress will not be enabled. | `string` | `""` | no |
+| <a name="input_grafana_tls_secret_name"></a> [grafana\_tls\_secret\_name](#input\_grafana\_tls\_secret\_name) | TLS secret name. If the variable is left empty, the value will be filled by the module using default value. | `string` | `""` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | This is the namespace used to install kube-prometheus-stack. | `string` | `"kube-prometheus-stack"` | no |
+| <a name="input_prometheus_adapter_additional_values"></a> [prometheus\_adapter\_additional\_values](#input\_prometheus\_adapter\_additional\_values) | Override values for prometheus-adapter release. If this variable is not an empy list, it will be merged with the other values. | `list(string)` | `[]` | no |
+| <a name="input_prometheus_adapter_chart_version"></a> [prometheus\_adapter\_chart\_version](#input\_prometheus\_adapter\_chart\_version) | Chart version Prometheus Adapter. If the variable is left empty, the Prometheus Adapter Chart will not be installed. | `string` | `""` | no |
+| <a name="input_prometheus_stack_additional_values"></a> [prometheus\_stack\_additional\_values](#input\_prometheus\_stack\_additional\_values) | Override values for kube-prometheus-stack release. If this variable is not an empy list, it will be merged with the other values. | `list(string)` | `[]` | no |
+| <a name="input_prometheus_stack_chart_version"></a> [prometheus\_stack\_chart\_version](#input\_prometheus\_stack\_chart\_version) | Chart version Prometheus-stack. | `string` | n/a | yes |
+| <a name="input_regcred"></a> [regcred](#input\_regcred) | Name of the secret of the docker credentials. | `string` | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_grafana_admin_password"></a> [grafana\_admin\_password](#output\_grafana\_admin\_password) | Grafana administrator password |
+| <a name="output_grafana_admin_user"></a> [grafana\_admin\_user](#output\_grafana\_admin\_user) | Grafana administrator username |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [helm_release.kube_prometheus_stack](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
+| [helm_release.prometheus_adapter](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
+| [kubernetes_namespace_v1.kube_prometheus_stack_namespace](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace_v1) | resource |
+| [kubernetes_secret_v1.kube_prometheus_ingress_auth](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret_v1) | resource |
+| [random_password.basic_auth_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
+| [random_password.grafana_admin_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
+
+## Modules
+
+No modules.
+
+
+<!-- END_TF_DOCS -->
diff --git a/examples/main.tf b/examples/main.tf
@@ -1,15 +1,15 @@
 locals {
   prometheus_stack_additional_values = yamlencode({
-    commonLabels: {
-      label1: "this-is-my-first-label"
-      label2: "this-is-my-second-label"
+    commonLabels : {
+      label1 : "this-is-my-first-label"
+      label2 : "this-is-my-second-label"
     }
   })
   prometheus_adapter_additional_values = yamlencode({
-    resources: {
-      requests: {
-        cpu: "10m",
-        memory: "32Mi"
+    resources : {
+      requests : {
+        cpu : "10m",
+        memory : "32Mi"
       }
     }
   })
@@ -18,16 +18,16 @@ locals {
 module "kube_prometheus_stack" {
   source = "sparkfabrik/terraform-sparkfabrik-prometheus-stack"
 
-  prometheus_stack_chart_version          = var.prometheus_stack_chart_version
-  prometheus_adapter_chart_version        = var.prometheus_adapter_chart_version
-  namespace                               = var.namespace
-  regcred                                 = var.regcred
-  grafana_ingress_host                    = var.grafana_ingress_host
-  grafana_ingress_class                   = var.grafana_ingress_class
-  grafana_cluster_issuer_name             = var.grafana_cluster_issuer_name
-  grafana_tls_secret_name                 = var.grafana_tls_secret_name
-  grafana_ingress_basic_auth_username     = var.grafana_ingress_basic_auth_username
-  grafana_ingress_basic_auth_message      = var.grafana_ingress_basic_auth_message
-  prometheus_stack_additional_values      = local.prometheus_stack_additional_values
-  prometheus_adapter_additional_values    = local.prometheus_adapter_additional_values
+  prometheus_stack_chart_version       = var.prometheus_stack_chart_version
+  prometheus_adapter_chart_version     = var.prometheus_adapter_chart_version
+  namespace                            = var.namespace
+  regcred                              = var.regcred
+  grafana_ingress_host                 = var.grafana_ingress_host
+  grafana_ingress_class                = var.grafana_ingress_class
+  grafana_cluster_issuer_name          = var.grafana_cluster_issuer_name
+  grafana_tls_secret_name              = var.grafana_tls_secret_name
+  grafana_ingress_basic_auth_username  = var.grafana_ingress_basic_auth_username
+  grafana_ingress_basic_auth_message   = var.grafana_ingress_basic_auth_message
+  prometheus_stack_additional_values   = [local.prometheus_stack_additional_values]
+  prometheus_adapter_additional_values = [local.prometheus_adapter_additional_values]
 }
diff --git a/examples/test.tfvars b/examples/test.tfvars
@@ -1,10 +1,10 @@
-prometheus_stack_chart_version = "31.0.0"
-prometheus_adapter_chart_version = "3.0.1"
-namespace = "kube-prometheus-stack"
-regcred = "regcred-secret"
-grafana_ingress_host = "monitoring.example.com"
-grafana_ingress_class = "nginx"
-grafana_cluster_issuer_name = "prod-certmanager"
-grafana_tls_secret_name = "monitoring-tls"
+prometheus_stack_chart_version      = "31.0.0"
+prometheus_adapter_chart_version    = "3.0.1"
+namespace                           = "kube-prometheus-stack"
+regcred                             = "regcred-secret"
+grafana_ingress_host                = "monitoring.example.com"
+grafana_ingress_class               = "nginx"
+grafana_cluster_issuer_name         = "prod-certmanager"
+grafana_tls_secret_name             = "monitoring-tls"
 grafana_ingress_basic_auth_username = "admin"
-grafana_ingress_basic_auth_message = "Grafana basic auth"
+grafana_ingress_basic_auth_message  = "Grafana basic auth"