Merge branch 'fidel-ruiz/feat-add-support-logs-agent-resources' of github.com:fidel-ibm/terraform-ibm-observability-agents into fidel-ruiz/feat-add-support-logs-agent-resources

Author: fidel-ibm

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-10-16T12:26:02Z",
+  "generated_at": "2025-03-10T14:14:38Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -1,15 +1,15 @@
 # Terraform IBM Observability agents module
 
-[![Graduated (Supported)](https://img.shields.io/badge/Status-Graduated%20(Supported)-brightgreen)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
+[![Graduated (Supported)](<https://img.shields.io/badge/Status-Graduated%20(Supported)-brightgreen>)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-observability-agents?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-observability-agents/releases/latest)
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 This module deploys the following observability agents to an IBM Cloud Red Hat OpenShift Container Platform or Kubernetes cluster:
 
-- [Logs agent](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-agent-about)
-- [Monitoring agent](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metrics)
+-   [Logs agent](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-agent-about)
+-   [Monitoring agent](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metrics)
 
 <!-- Below content is automatically populated via pre-commit hook -->
 <!-- BEGIN OVERVIEW HOOK -->
@@ -80,14 +80,15 @@ module "observability_agents" {
 ```
 
 ### Required IAM access policies
+
 You need the following permissions to run this module.
 
-- Service
-    - **Resource group only**
-        - `Viewer` access on the specific resource group
-    - **Kubernetes** service
-        - `Viewer` platform access
-        - `Manager` service access
+-   Service
+    -   **Resource group only**
+        -   `Viewer` access on the specific resource group
+    -   **Kubernetes** service
+        -   `Viewer` platform access
+        -   `Manager` service access
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ### Requirements
@@ -146,7 +147,7 @@ You need the following permissions to run this module.
 | <a name="input_logs_agent_log_source_namespaces"></a> [logs\_agent\_log\_source\_namespaces](#input\_logs\_agent\_log\_source\_namespaces) | The list of namespaces from which logs should be forwarded by agent. If namespaces are not listed, logs from all namespaces will be sent. | `list(string)` | `[]` | no |
 | <a name="input_logs_agent_name"></a> [logs\_agent\_name](#input\_logs\_agent\_name) | The name of the Logs agent. The name is used in all Kubernetes and Helm resources in the cluster. | `string` | `"logs-agent"` | no |
 | <a name="input_logs_agent_namespace"></a> [logs\_agent\_namespace](#input\_logs\_agent\_namespace) | The namespace where the Logs agent is deployed. The default value is `ibm-observe`. | `string` | `"ibm-observe"` | no |
-| <a name="input_logs_agent_resources"></a> [logs\_agent\_resources](#input\_logs\_agent\_resources) | The resources configuration for cpu/memory/storage | <pre>object({<br>    limits = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>    requests = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>  })</pre> | <pre>{<br>  "limits": {<br>    "cpu": "500m",<br>    "ephemeral_storage": "10Gi",<br>    "memory": "3Gi"<br>  },<br>  "requests": {<br>    "cpu": "100m",<br>    "ephemeral_storage": "2Gi",<br>    "memory": "1Gi"<br>  }<br>}</pre> | no |
+| <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>      ephemeral_storage = string<br>    })<br>    requests = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>  })</pre> | <pre>{<br>  "limits": {<br>    "cpu": "500m",<br>    "ephemeral_storage": "10Gi",<br>    "memory": "3Gi"<br>  },<br>  "requests": {<br>    "cpu": "100m",<br>    "ephemeral_storage": "2Gi",<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 |
@@ -158,8 +159,8 @@ You need the following permissions to run this module.
 No outputs.
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
-
 <!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow -->
+
 ## Contributing
 
 You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).

modules/logs-agent/README.md

@@ -96,7 +96,7 @@ No modules.
 | <a name="input_logs_agent_log_source_namespaces"></a> [logs\_agent\_log\_source\_namespaces](#input\_logs\_agent\_log\_source\_namespaces) | The list of namespaces from which logs should be forwarded by agent. If namespaces are not listed, logs from all namespaces will be sent. | `list(string)` | `[]` | no |
 | <a name="input_logs_agent_name"></a> [logs\_agent\_name](#input\_logs\_agent\_name) | The name of the Logs agent. The name is used in all Kubernetes and Helm resources in the cluster. | `string` | `"logs-agent"` | no |
 | <a name="input_logs_agent_namespace"></a> [logs\_agent\_namespace](#input\_logs\_agent\_namespace) | The namespace where the Logs agent is deployed. The default value is `ibm-observe`. | `string` | `"ibm-observe"` | no |
-| <a name="input_logs_agent_resources"></a> [logs\_agent\_resources](#input\_logs\_agent\_resources) | The resources configuration for cpu/memory/storage | <pre>object({<br>    limits = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>    requests = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>  })</pre> | <pre>{<br>  "limits": {<br>    "cpu": "500m",<br>    "ephemeral_storage": "10Gi",<br>    "memory": "3Gi"<br>  },<br>  "requests": {<br>    "cpu": "100m",<br>    "ephemeral_storage": "2Gi",<br>    "memory": "1Gi"<br>  }<br>}</pre> | no |
+| <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>      ephemeral_storage = string<br>    })<br>    requests = object({<br>      cpu               = string<br>      memory            = string<br>      ephemeral_storage = string<br>    })<br>  })</pre> | <pre>{<br>  "limits": {<br>    "cpu": "500m",<br>    "ephemeral_storage": "10Gi",<br>    "memory": "3Gi"<br>  },<br>  "requests": {<br>    "cpu": "100m",<br>    "ephemeral_storage": "2Gi",<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 |

modules/logs-agent/main.tf

@@ -112,6 +112,11 @@ resource "helm_release" "logs_agent" {
     value = var.logs_agent_enable_scc
   }
 
+  set {
+    name  = "resources"
+    value = jsonencode(var.logs_agent_resources)
+  }
+
   # dummy value hack to force update https://github.com/hashicorp/terraform-provider-helm/issues/515#issuecomment-813088122
   values = [
     yamlencode({

modules/logs-agent/variables.tf

@@ -155,7 +155,7 @@ variable "logs_agent_additional_metadata" {
 }
 
 variable "logs_agent_resources" {
-  description = "The resources configuration for cpu/memory/storage"
+  description = "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)"
   type = object({
     limits = object({
       cpu               = string

variables.tf

@@ -269,7 +269,7 @@ variable "logs_agent_additional_metadata" {
 }
 
 variable "logs_agent_resources" {
-  description = "The resources configuration for cpu/memory/storage"
+  description = "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)"
   type = object({
     limits = object({
       cpu               = string