fix: address feedback

Author: Jordan-Williams2

README.md

@@ -63,7 +63,7 @@ module "logs_agent_module" {
   # update this with the Id of your IBM Cloud resource group
   cluster_resource_group_id = "resource group id"
   # Logs Agent variables
-  logs_agent_trusted_profile  = "XXXXXXXX"
+  logs_agent_trusted_profile_id  = "XXXXXXXX"
   cloud_logs_ingress_endpoint = "<cloud-logs-instance-guid>.ingress.us-south.logs.cloud.ibm.com"
   cloud_logs_ingress_port     = 443
 }
@@ -128,7 +128,7 @@ No modules.
 | <a name="input_logs_agent_resources"></a> [logs\_agent\_resources](#input\_logs\_agent\_resources) | The resources configuration for cpu/memory/storage. [Learn More](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-agent-helm-template-clusters#agent-helm-template-clusters-chart-options-resources) | <pre>object({<br/>    limits = object({<br/>      cpu    = string<br/>      memory = string<br/>    })<br/>    requests = object({<br/>      cpu    = string<br/>      memory = string<br/>    })<br/>  })</pre> | <pre>{<br/>  "limits": {<br/>    "cpu": "500m",<br/>    "memory": "3Gi"<br/>  },<br/>  "requests": {<br/>    "cpu": "100m",<br/>    "memory": "1Gi"<br/>  }<br/>}</pre> | no |
 | <a name="input_logs_agent_selected_log_source_paths"></a> [logs\_agent\_selected\_log\_source\_paths](#input\_logs\_agent\_selected\_log\_source\_paths) | The list of specific log sources paths. Logs will only be collected from the specified log source paths. If no paths are specified, it will send logs from `/var/log/containers`. | `list(string)` | `[]` | no |
 | <a name="input_logs_agent_tolerations"></a> [logs\_agent\_tolerations](#input\_logs\_agent\_tolerations) | List of tolerations to apply to Logs agent. The default value means a pod will run on every node. | <pre>list(object({<br/>    key               = optional(string)<br/>    operator          = optional(string)<br/>    value             = optional(string)<br/>    effect            = optional(string)<br/>    tolerationSeconds = optional(number)<br/>  }))</pre> | <pre>[<br/>  {<br/>    "operator": "Exists"<br/>  }<br/>]</pre> | no |
-| <a name="input_logs_agent_trusted_profile"></a> [logs\_agent\_trusted\_profile](#input\_logs\_agent\_trusted\_profile) | The IBM Cloud trusted profile ID. Used only when `logs_agent_iam_mode` is set to `TrustedProfile`. The trusted profile must have an IBM Cloud Logs `Sender` role. | `string` | `null` | no |
+| <a name="input_logs_agent_trusted_profile_id"></a> [logs\_agent\_trusted\_profile\_id](#input\_logs\_agent\_trusted\_profile\_id) | The IBM Cloud trusted profile ID. Used only when `logs_agent_iam_mode` is set to `TrustedProfile`. The trusted profile must have an IBM Cloud Logs `Sender` role. | `string` | `null` | no |
 | <a name="input_wait_till"></a> [wait\_till](#input\_wait\_till) | To avoid long wait times when you run your Terraform code, you can specify the stage when you want Terraform to mark the cluster resource creation as completed. Depending on what stage you choose, the cluster creation might not be fully completed and continues to run in the background. However, your Terraform code can continue to run without waiting for the cluster to be fully created. Supported args are `MasterNodeReady`, `OneWorkerNodeReady`, `IngressReady` and `Normal` | `string` | `"Normal"` | no |
 | <a name="input_wait_till_timeout"></a> [wait\_till\_timeout](#input\_wait\_till\_timeout) | Timeout for wait\_till in minutes. | `number` | `90` | no |
 

examples/logs-agent-ocp/main.tf

@@ -178,11 +178,11 @@ module "logs_agent" {
   cluster_id                = module.ocp_base.cluster_id
   cluster_resource_group_id = module.resource_group.resource_group_id
   # Logs agent
-  logs_agent_trusted_profile  = module.trusted_profile.trusted_profile.id
-  logs_agent_namespace        = local.logs_agent_namespace
-  logs_agent_name             = local.logs_agent_name
-  cloud_logs_ingress_endpoint = module.cloud_logs.ingress_private_endpoint
-  cloud_logs_ingress_port     = 443
+  logs_agent_trusted_profile_id = module.trusted_profile.trusted_profile.id
+  logs_agent_namespace          = local.logs_agent_namespace
+  logs_agent_name               = local.logs_agent_name
+  cloud_logs_ingress_endpoint   = module.cloud_logs.ingress_private_endpoint
+  cloud_logs_ingress_port       = 443
   # example of how to add additional metadata to the logs agent
   logs_agent_additional_metadata = [{
     key   = "cluster_id"

main.tf

@@ -26,7 +26,7 @@ data "ibm_container_cluster_config" "cluster_config" {
 locals {
   logs_agent_selected_log_source_paths = distinct(concat([for namespace in var.logs_agent_log_source_namespaces : "/var/log/containers/*_${namespace}_*.log"], var.logs_agent_selected_log_source_paths))
   logs_agent_iam_api_key               = var.logs_agent_iam_api_key != null ? var.logs_agent_iam_api_key : ""
-  logs_agent_trusted_profile           = var.logs_agent_trusted_profile != null ? var.logs_agent_trusted_profile : ""
+  logs_agent_trusted_profile_id        = var.logs_agent_trusted_profile_id != null ? var.logs_agent_trusted_profile_id : ""
   cloud_logs_ingress_endpoint          = var.cloud_logs_ingress_endpoint != null ? var.cloud_logs_ingress_endpoint : ""
   logs_agent_additional_metadata = length(var.logs_agent_additional_metadata) > 0 ? merge([
     for metadata in var.logs_agent_additional_metadata : {
@@ -74,7 +74,7 @@ resource "helm_release" "logs_agent" {
   set {
     name  = "env.trustedProfileID"
     type  = "string"
-    value = local.logs_agent_trusted_profile
+    value = local.logs_agent_trusted_profile_id
   }
   set {
     name  = "env.iamMode"

solutions/fully-configurable/main.tf

@@ -26,7 +26,7 @@ module "logs_agent" {
   logs_agent_image_version               = var.logs_agent_image_version
   logs_agent_name                        = var.logs_agent_name
   logs_agent_namespace                   = var.logs_agent_namespace
-  logs_agent_trusted_profile             = var.logs_agent_trusted_profile_id
+  logs_agent_trusted_profile_id          = var.logs_agent_trusted_profile_id
   logs_agent_iam_api_key                 = var.logs_agent_iam_api_key
   logs_agent_tolerations                 = var.logs_agent_tolerations
   logs_agent_additional_log_source_paths = var.logs_agent_additional_log_source_paths

tests/scripts/pre-validation-deploy-ocp-and-logs-instances.sh

@@ -28,23 +28,23 @@ TF_VARS_FILE="terraform.tfvars"
   cluster_id_value=$(terraform output -state=terraform.tfstate -raw workload_cluster_id)
   cluster_resource_group_id_var_name="cluster_resource_group_id"
   cluster_resource_group_id_value=$(terraform output -state=terraform.tfstate -raw cluster_resource_group_id)
-  logs_agent_trusted_profile_var_name="logs_agent_trusted_profile"
-  logs_agent_trusted_profile_value=$(terraform output -state=terraform.tfstate -raw trusted_profile_id)
+  logs_agent_trusted_profile_id_var_name="logs_agent_trusted_profile_id"
+  logs_agent_trusted_profile_id_value=$(terraform output -state=terraform.tfstate -raw trusted_profile_id)
   cloud_logs_ingress_endpoint_var_name="cloud_logs_ingress_endpoint"
   cloud_logs_ingress_endpoint_value=$(terraform output -state=terraform.tfstate -raw cloud_logs_ingress_private_endpoint)
 
-  echo "Appending '${cluster_id_var_name}' '${cluster_resource_group_id_var_name}', '${logs_agent_trusted_profile_var_name}', and '${cloud_logs_ingress_endpoint_var_name}' input variable values to ${JSON_FILE}.."
+  echo "Appending '${cluster_id_var_name}' '${cluster_resource_group_id_var_name}', '${logs_agent_trusted_profile_id_var_name}', and '${cloud_logs_ingress_endpoint_var_name}' input variable values to ${JSON_FILE}.."
 
   cd "${cwd}"
   jq -r --arg cluster_id_var_name "${cluster_id_var_name}" \
         --arg cluster_id_value "${cluster_id_value}" \
         --arg cluster_resource_group_id_var_name "${cluster_resource_group_id_var_name}" \
         --arg cluster_resource_group_id_value "${cluster_resource_group_id_value}" \
-        --arg logs_agent_trusted_profile_var_name "${logs_agent_trusted_profile_var_name}" \
-        --arg logs_agent_trusted_profile_value "${logs_agent_trusted_profile_value}" \
+        --arg logs_agent_trusted_profile_id_var_name "${logs_agent_trusted_profile_id_var_name}" \
+        --arg logs_agent_trusted_profile_id_value "${logs_agent_trusted_profile_id_value}" \
         --arg cloud_logs_ingress_endpoint_var_name "${cloud_logs_ingress_endpoint_var_name}" \
         --arg cloud_logs_ingress_endpoint_value "${cloud_logs_ingress_endpoint_value}" \
-        '. + {($cluster_id_var_name): $cluster_id_value, ($cluster_resource_group_id_var_name): $cluster_resource_group_id_value, ($logs_agent_trusted_profile_var_name): $logs_agent_trusted_profile_value, ($cloud_logs_ingress_endpoint_var_name): $cloud_logs_ingress_endpoint_value}' "${JSON_FILE}" > tmpfile && mv tmpfile "${JSON_FILE}" || exit 1
+        '. + {($cluster_id_var_name): $cluster_id_value, ($cluster_resource_group_id_var_name): $cluster_resource_group_id_value, ($logs_agent_trusted_profile_id_var_name): $logs_agent_trusted_profile_id_value, ($cloud_logs_ingress_endpoint_var_name): $cloud_logs_ingress_endpoint_value}' "${JSON_FILE}" > tmpfile && mv tmpfile "${JSON_FILE}" || exit 1
 
   echo "Pre-validation complete successfully"
 )

variables.tf

@@ -97,13 +97,13 @@ variable "logs_agent_namespace" {
   nullable    = false
 }
 
-variable "logs_agent_trusted_profile" {
+variable "logs_agent_trusted_profile_id" {
   type        = string
   description = "The IBM Cloud trusted profile ID. Used only when `logs_agent_iam_mode` is set to `TrustedProfile`. The trusted profile must have an IBM Cloud Logs `Sender` role."
   default     = null
   validation {
-    condition     = !(var.logs_agent_trusted_profile == null && var.logs_agent_iam_mode == "TrustedProfile")
-    error_message = "The `logs_agent_trusted_profile` is required when `logs_agent_iam_mode` is set to `TrustedProfile`."
+    condition     = !(var.logs_agent_trusted_profile_id == null && var.logs_agent_iam_mode == "TrustedProfile")
+    error_message = "The `logs_agent_trusted_profile_id` is required when `logs_agent_iam_mode` is set to `TrustedProfile`."
   }
 }