fix: Minor adjustments to some variable descriptions (#98)

Author: vburckhardt

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-04-05T23:25:49Z",
+  "generated_at": "2023-04-06T21:27:25Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -124,7 +124,7 @@ No modules.
 |------|-------------|------|---------|:--------:|
 | <a name="input_cluster_id"></a> [cluster\_id](#input\_cluster\_id) | Cluster id to add to agents to | `string` | n/a | yes |
 | <a name="input_cluster_resource_group_id"></a> [cluster\_resource\_group\_id](#input\_cluster\_resource\_group\_id) | Resource group of the cluster | `string` | n/a | yes |
-| <a name="input_logdna_add_cluster_name"></a> [logdna\_add\_cluster\_name](#input\_logdna\_add\_cluster\_name) | Add cluster name to the list of tags | `bool` | `true` | no |
+| <a name="input_logdna_add_cluster_name"></a> [logdna\_add\_cluster\_name](#input\_logdna\_add\_cluster\_name) | If true, configure the logdna agent to attach a tag containing the cluster name to all log messages. | `bool` | `true` | no |
 | <a name="input_logdna_agent_tags"></a> [logdna\_agent\_tags](#input\_logdna\_agent\_tags) | array of tags to group the host logs pushed by the logdna agent | `list(string)` | `[]` | no |
 | <a name="input_logdna_agent_version"></a> [logdna\_agent\_version](#input\_logdna\_agent\_version) | Version of the agent to deploy. To lookup version run: `ibmcloud cr images --restrict ext/logdna-agent`. If null, the default value is used. | `string` | `"3.8.0-20230206.cbc937fa5513f636"` | no |
 | <a name="input_logdna_enabled"></a> [logdna\_enabled](#input\_logdna\_enabled) | Deploy IBM Cloud Logging agent | `bool` | `true` | no |

examples/basic/main.tf

@@ -95,6 +95,7 @@ resource "time_sleep" "wait_operators" {
 # Observability Agents
 ##############################################################################
 
+
 module "observability_agents" {
   source                    = "../.."
   depends_on                = [time_sleep.wait_operators]

main.tf

@@ -1,7 +1,6 @@
 ##############################################################################
 # observability-agents-module
 #
-# Module Description
 ##############################################################################
 
 data "ibm_container_vpc_cluster" "cluster" {
@@ -42,17 +41,18 @@ data "ibm_resource_instance" "sysdig_instance" {
 }
 
 locals {
-  logdna_secret_name            = "logdna-agent" #checkov:skip=CKV_SECRET_6
+  logdna_secret_name = "logdna-agent" #checkov:skip=CKV_SECRET_6
+  # Not publically documented in provider. See https://github.com/IBM-Cloud/terraform-provider-ibm/issues/4485
   cluster_name                  = data.ibm_container_vpc_cluster.cluster.resource_name
   logdna_chart_location         = "${path.module}/chart/logdna-agent"
   logdna_resource_group_id      = var.logdna_resource_group_id != null ? var.logdna_resource_group_id : var.cluster_resource_group_id
   logdna_agent_namespace        = "ibm-observe"
   logdna_agent_registry         = "icr.io/ext/logdna-agent"
   logdna_key_validate_condition = var.logdna_enabled == true && var.logdna_ingestion_key == null
   logdna_key_validate_msg       = "Values for 'logdna_ingestion_key' variables must be passed when 'logdna_enabled = true'"
-  logdna_agent_tags             = var.logdna_add_cluster_name ? join("\\,", concat(var.logdna_agent_tags, formatlist(local.cluster_name))) : join("\\,", var.logdna_agent_tags)
   # tflint-ignore: terraform_unused_declarations
   logdna_key_validate_check     = regex("^${local.logdna_key_validate_msg}$", (!local.logdna_key_validate_condition ? local.logdna_key_validate_msg : ""))
+  logdna_agent_tags             = var.logdna_add_cluster_name ? concat([local.cluster_name], var.logdna_agent_tags) : var.logdna_agent_tags
   sysdig_chart_location         = "${path.module}/chart/sysdig-agent"
   sysdig_resource_group_id      = var.sysdig_resource_group_id != null ? var.sysdig_resource_group_id : var.cluster_resource_group_id
   sysdig_agent_registry         = "icr.io/ext/sysdig/agent"
@@ -104,7 +104,7 @@ resource "helm_release" "logdna_agent" {
   set {
     name  = "agent.tags"
     type  = "string"
-    value = local.logdna_agent_tags
+    value = join("\\,", local.logdna_agent_tags)
   }
 
   provisioner "local-exec" {

module-metadata.json

@@ -38,11 +38,11 @@
     "logdna_add_cluster_name": {
       "name": "logdna_add_cluster_name",
       "type": "bool",
-      "description": "Add cluster name to the list of tags",
+      "description": "If true, configure the logdna agent to attach a tag containing the cluster name to all log messages.",
       "default": true,
       "pos": {
         "filename": "variables.tf",
-        "line": 55
+        "line": 56
       }
     },
     "logdna_agent_tags": {
@@ -89,7 +89,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 48
+        "line": 49
       }
     },
     "logdna_instance_name": {
@@ -124,7 +124,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 87
+        "line": 88
       }
     },
     "sysdig_agent_version": {
@@ -134,7 +134,7 @@
       "default": "12.10.1",
       "pos": {
         "filename": "variables.tf",
-        "line": 79
+        "line": 80
       }
     },
     "sysdig_enabled": {
@@ -148,7 +148,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 61
+        "line": 62
       }
     },
     "sysdig_instance_name": {
@@ -161,7 +161,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 67
+        "line": 68
       }
     },
     "sysdig_resource_group_id": {
@@ -170,7 +170,7 @@
       "description": "Resource group that the IBM Cloud Monitoring is in. Defaults to Clusters group",
       "pos": {
         "filename": "variables.tf",
-        "line": 73
+        "line": 74
       }
     }
   },
@@ -238,7 +238,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 12
+        "line": 11
       }
     },
     "data.ibm_container_vpc_cluster.cluster": {
@@ -254,7 +254,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 7
+        "line": 6
       }
     },
     "data.ibm_resource_instance.logdna_instance": {
@@ -271,7 +271,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 28
+        "line": 27
       }
     },
     "data.ibm_resource_instance.sysdig_instance": {
@@ -288,7 +288,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 36
+        "line": 35
       }
     }
   },

variables.tf

@@ -43,6 +43,7 @@ variable "logdna_agent_tags" {
   type        = list(string)
   description = "array of tags to group the host logs pushed by the logdna agent"
   default     = []
+  nullable    = false
 }
 
 variable "logdna_ingestion_key" {
@@ -54,7 +55,7 @@ variable "logdna_ingestion_key" {
 
 variable "logdna_add_cluster_name" {
   type        = bool
-  description = "Add cluster name to the list of tags"
+  description = "If true, configure the logdna agent to attach a tag containing the cluster name to all log messages."
   default     = true
 }