Skip to content

Commit 5791425

Browse files
Jordan-Williams2claude
authored andcommitted
fix: address PR review feedback for agent_mode variable
Update agent_mode variable descriptions and catalog configuration based on review feedback: - Replace 'Sysdig agent' with 'Monitoring agent' for better abstraction - Simplify variable description and add 'Learn more' documentation link - Add dropdown selection in ibm_catalog.json with valid mode options - Update git submodule to latest version - Auto-generate documentation via pre-commit hooks Addresses review comments from ocofaigh on PR #267 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a2b258c commit 5791425

File tree

4 files changed

+22
-4
lines changed

4 files changed

+22
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ No modules.
114114
| <a name="input_agent_image_tag_digest"></a> [agent\_image\_tag\_digest](#input\_agent\_image\_tag\_digest) | The image tag or digest of agent image to use. If using digest, it must be in the format of `X.Y.Z@sha256:xxxxx`. | `string` | `"14.2.5@sha256:64b9d77bbd1bb22f97a74198144dcfea62bb5cee7629091252694e9040058035"` | no |
115115
| <a name="input_agent_limits_cpu"></a> [agent\_limits\_cpu](#input\_agent\_limits\_cpu) | Specify CPU resource limits for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1"` | no |
116116
| <a name="input_agent_limits_memory"></a> [agent\_limits\_memory](#input\_agent\_limits\_memory) | Specify memory resource limits for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1024Mi"` | no |
117-
| <a name="input_agent_mode"></a> [agent\_mode](#input\_agent\_mode) | The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor\_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig\_container\_net\_http\_url\_request\_count, sysdig\_container\_net\_http\_url\_request\_time, sysdig\_container\_net\_http\_url\_error\_count). Set to null to use the agent's default mode. | `string` | `null` | no |
117+
| <a name="input_agent_mode"></a> [agent\_mode](#input\_agent\_mode) | The operational mode for the monitoring agent. [Learn more](https://docs.sysdig.com/en/docs/sysdig-on-prem/administration/configuration-parameters/#agent-mode). | `string` | `null` | no |
118118
| <a name="input_agent_requests_cpu"></a> [agent\_requests\_cpu](#input\_agent\_requests\_cpu) | Specify CPU resource requests for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1"` | no |
119119
| <a name="input_agent_requests_memory"></a> [agent\_requests\_memory](#input\_agent\_requests\_memory) | Specify memory resource requests for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1024Mi"` | no |
120120
| <a name="input_agent_tags"></a> [agent\_tags](#input\_agent\_tags) | Map of tags to associate to the agent. For example, {"environment": "production"}. NOTE: Use the `add_cluster_name` boolean variable to add the cluster name as a tag. | `map(string)` | `{}` | no |

ibm_catalog.json

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,25 @@
355355
"key": "enable_jmx"
356356
},
357357
{
358-
"key": "agent_mode"
358+
"key": "agent_mode",
359+
"options": [
360+
{
361+
"displayname": "Default",
362+
"value": "__NULL__"
363+
},
364+
{
365+
"displayname": "Monitor",
366+
"value": "monitor"
367+
},
368+
{
369+
"displayname": "Monitor Light",
370+
"value": "monitor_light"
371+
},
372+
{
373+
"displayname": "Troubleshooting",
374+
"value": "troubleshooting"
375+
}
376+
]
359377
},
360378
{
361379
"key": "use_private_endpoint"

solutions/fully-configurable/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ variable "enable_jmx" {
366366

367367
variable "agent_mode" {
368368
type = string
369-
description = "The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig_container_net_http_url_request_count, sysdig_container_net_http_url_request_time, sysdig_container_net_http_url_error_count). Set to null to use the agent's default mode."
369+
description = "The operational mode for the monitoring agent. [Learn more](https://docs.sysdig.com/en/docs/sysdig-on-prem/administration/configuration-parameters/#agent-mode)."
370370
default = null
371371
validation {
372372
condition = var.agent_mode == null ? true : contains(["monitor", "monitor_light", "troubleshooting"], var.agent_mode)

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ variable "enable_jmx" {
371371

372372
variable "agent_mode" {
373373
type = string
374-
description = "The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig_container_net_http_url_request_count, sysdig_container_net_http_url_request_time, sysdig_container_net_http_url_error_count). Set to null to use the agent's default mode."
374+
description = "The operational mode for the monitoring agent. [Learn more](https://docs.sysdig.com/en/docs/sysdig-on-prem/administration/configuration-parameters/#agent-mode)."
375375
default = null
376376
validation {
377377
condition = var.agent_mode == null ? true : contains(["monitor", "monitor_light", "troubleshooting"], var.agent_mode)

0 commit comments

Comments
 (0)