feat: new bool variable logdna_add_cluster_name can be used to add the cluster name as a logdna tag + fixed issue where sysdig was using cluster ID instead of name (#99)

Author: Aashiq-J

README.md

@@ -124,6 +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_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

@@ -105,4 +105,5 @@ module "observability_agents" {
   sysdig_instance_name      = module.observability_instances.sysdig_name
   sysdig_access_key         = module.observability_instances.sysdig_access_key
   logdna_agent_tags         = var.logdna_agent_tags
+  logdna_add_cluster_name   = true
 }

main.tf

@@ -43,13 +43,14 @@ data "ibm_resource_instance" "sysdig_instance" {
 
 locals {
   logdna_secret_name            = "logdna-agent" #checkov:skip=CKV_SECRET_6
-  cluster_name                  = data.ibm_container_vpc_cluster.cluster.name
+  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 : ""))
   sysdig_chart_location         = "${path.module}/chart/sysdig-agent"
@@ -103,7 +104,7 @@ resource "helm_release" "logdna_agent" {
   set {
     name  = "agent.tags"
     type  = "string"
-    value = join("\\,", var.logdna_agent_tags)
+    value = local.logdna_agent_tags
   }
 
   provisioner "local-exec" {

module-metadata.json

@@ -35,6 +35,16 @@
       "cloud_data_type": "resource_group",
       "computed": true
     },
+    "logdna_add_cluster_name": {
+      "name": "logdna_add_cluster_name",
+      "type": "bool",
+      "description": "Add cluster name to the list of tags",
+      "default": true,
+      "pos": {
+        "filename": "variables.tf",
+        "line": 55
+      }
+    },
     "logdna_agent_tags": {
       "name": "logdna_agent_tags",
       "type": "list(string)",
@@ -114,7 +124,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 81
+        "line": 87
       }
     },
     "sysdig_agent_version": {
@@ -124,7 +134,7 @@
       "default": "12.10.1",
       "pos": {
         "filename": "variables.tf",
-        "line": 73
+        "line": 79
       }
     },
     "sysdig_enabled": {
@@ -138,7 +148,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 55
+        "line": 61
       }
     },
     "sysdig_instance_name": {
@@ -151,7 +161,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 61
+        "line": 67
       }
     },
     "sysdig_resource_group_id": {
@@ -160,7 +170,7 @@
       "description": "Resource group that the IBM Cloud Monitoring is in. Defaults to Clusters group",
       "pos": {
         "filename": "variables.tf",
-        "line": 67
+        "line": 73
       }
     }
   },
@@ -195,7 +205,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 67
+        "line": 68
       }
     },
     "helm_release.sysdig_agent": {
@@ -210,7 +220,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 121
+        "line": 122
       }
     }
   },

tests/pr_test.go

@@ -63,9 +63,6 @@ func TestRunBasicAgents(t *testing.T) {
 func TestRunUpgrade(t *testing.T) {
 	t.Parallel()
 
-	// TODO: Remove this line after the first merge to primary branch is complete to enable upgrade test
-	t.Skip("Skipping upgrade test until initial code is in primary branch")
-
 	options := setupOptions(t, "observ-agents-upg", terraformDirOther)
 
 	output, err := options.RunTestUpgrade()

variables.tf

@@ -52,6 +52,12 @@ variable "logdna_ingestion_key" {
   default     = null
 }
 
+variable "logdna_add_cluster_name" {
+  type        = bool
+  description = "Add cluster name to the list of tags"
+  default     = true
+}
+
 variable "sysdig_enabled" {
   type        = bool
   description = "Deploy IBM Cloud Monitoring agent"