address failing pre-commit hook

ocofaigh · fidel-ibm · commit 7b0c65400828 · 2025-03-10T10:24:06.000-04:00
diff --git a/README.md b/README.md
@@ -146,7 +146,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 |
diff --git a/modules/logs-agent/README.md b/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 |
diff --git a/modules/logs-agent/variables.tf b/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
diff --git a/variables.tf b/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

Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ variable "logs_agent_additional_metadata" {`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`variable "logs_agent_resources" {`
`158`		`- description = "The resources configuration for cpu/memory/storage"`
	`158`	`+ 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)"`
`159`	`159`	`type = object({`
`160`	`160`	`limits = object({`
`161`	`161`	`cpu = string`
Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ variable "logs_agent_additional_metadata" {`
`269`	`269`	`}`
`270`	`270`
`271`	`271`	`variable "logs_agent_resources" {`
`272`		`- description = "The resources configuration for cpu/memory/storage"`
	`272`	`+ 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)"`
`273`	`273`	`type = object({`
`274`	`274`	`limits = object({`
`275`	`275`	`cpu = string`