You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,11 +152,11 @@ You need the following permissions to run this module.
152
152
| <aname="input_cloud_monitoring_agent_name"></a> [cloud\_monitoring\_agent\_name](#input\_cloud\_monitoring\_agent\_name)| Cloud Monitoring agent name. Used for naming all kubernetes and helm resources on the cluster. |`string`|`"sysdig-agent"`| no |
153
153
| <aname="input_cloud_monitoring_agent_namespace"></a> [cloud\_monitoring\_agent\_namespace](#input\_cloud\_monitoring\_agent\_namespace)| Namespace where to deploy the Cloud Monitoring agent. Default value is 'ibm-observe' |`string`|`"ibm-observe"`| no |
154
154
| <aname="input_cloud_monitoring_agent_tags"></a> [cloud\_monitoring\_agent\_tags](#input\_cloud\_monitoring\_agent\_tags)| List of tags to associate to all matrics that the agent collects. NOTE: Use the 'cloud\_monitoring\_add\_cluster\_name' variable to add the cluster name as a tag. |`list(string)`|`[]`| no |
155
-
| <aname="input_cloud_monitoring_agent_tolerations"></a> [cloud\_monitoring\_agent\_tolerations](#input\_cloud\_monitoring\_agent\_tolerations)| List of tolerations to apply to Cloud Monitoring agent. | <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> {<br> "effect": "NoSchedule",<br> "key": "node-role.kubernetes.io/master",<br> "operator": "Exists"<br> }<br>]</pre> | no |
155
+
| <aname="input_cloud_monitoring_agent_tolerations"></a> [cloud\_monitoring\_agent\_tolerations](#input\_cloud\_monitoring\_agent\_tolerations)| List of tolerations to apply to Cloud Monitoring agent. | <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/> {<br/> "effect": "NoSchedule",<br/> "key": "node-role.kubernetes.io/master",<br/> "operator": "Exists"<br/> }<br/>]</pre> | no |
156
156
| <aname="input_cloud_monitoring_enabled"></a> [cloud\_monitoring\_enabled](#input\_cloud\_monitoring\_enabled)| Deploy IBM Cloud Monitoring agent |`bool`|`true`| no |
157
157
| <aname="input_cloud_monitoring_endpoint_type"></a> [cloud\_monitoring\_endpoint\_type](#input\_cloud\_monitoring\_endpoint\_type)| Specify the IBM Cloud Monitoring instance endpoint type (public or private) to use. Used to construct the ingestion endpoint. |`string`|`"private"`| no |
158
158
| <aname="input_cloud_monitoring_instance_region"></a> [cloud\_monitoring\_instance\_region](#input\_cloud\_monitoring\_instance\_region)| The IBM Cloud Monitoring instance region. Used to construct the ingestion endpoint. |`string`|`null`| no |
159
-
| <aname="input_cloud_monitoring_metrics_filter"></a> [cloud\_monitoring\_metrics\_filter](#input\_cloud\_monitoring\_metrics\_filter)| To filter custom metrics, specify the Cloud Monitoring metrics to include or to exclude. See https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_inc_exc_metrics.| <pre>list(object({<br> type = string<br> name = string<br> }))</pre> |`[]`| no |
159
+
| <aname="input_cloud_monitoring_metrics_filter"></a> [cloud\_monitoring\_metrics\_filter](#input\_cloud\_monitoring\_metrics\_filter)| To filter custom metrics, specify the Cloud Monitoring metrics to include or to exclude. See https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_inc_exc_metrics.| <pre>list(object({<br/> type = string<br/> name = string<br/> }))</pre> |`[]`| no |
160
160
| <aname="input_cloud_monitoring_secret_name"></a> [cloud\_monitoring\_secret\_name](#input\_cloud\_monitoring\_secret\_name)| The name of the secret which will store the access key. |`string`|`"sysdig-agent"`| no |
161
161
| <aname="input_cluster_config_endpoint_type"></a> [cluster\_config\_endpoint\_type](#input\_cluster\_config\_endpoint\_type)| Specify which type of endpoint to use for for cluster config access: 'default', 'private', 'vpe', 'link'. 'default' value will use the default endpoint of the cluster. |`string`|`"default"`| no |
162
162
| <aname="input_cluster_id"></a> [cluster\_id](#input\_cluster\_id)| The ID of the cluster you wish to deploy the agents in |`string`| n/a | yes |
@@ -168,14 +168,14 @@ You need the following permissions to run this module.
168
168
| <aname="input_log_analysis_agent_name"></a> [log\_analysis\_agent\_name](#input\_log\_analysis\_agent\_name)| DEPRECATED: Log Analysis agent name. Used for naming all kubernetes and helm resources on the cluster. |`string`|`"logdna-agent"`| no |
169
169
| <aname="input_log_analysis_agent_namespace"></a> [log\_analysis\_agent\_namespace](#input\_log\_analysis\_agent\_namespace)| DEPRECATED: Namespace where to deploy the Log Analysis agent. Default value is 'ibm-observe' |`string`|`"ibm-observe"`| no |
170
170
| <aname="input_log_analysis_agent_tags"></a> [log\_analysis\_agent\_tags](#input\_log\_analysis\_agent\_tags)| DEPRECATED: List of tags to associate to all log records that the agent collects so that you can identify the agent's data quicker in the logging UI. NOTE: Use the 'log\_analysis\_add\_cluster\_name' variable to add the cluster name as a tag. |`list(string)`|`[]`| no |
171
-
| <aname="input_log_analysis_agent_tolerations"></a> [log\_analysis\_agent\_tolerations](#input\_log\_analysis\_agent\_tolerations)| DEPRECATED: List of tolerations to apply to Log Analysis agent. | <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 |
171
+
| <aname="input_log_analysis_agent_tolerations"></a> [log\_analysis\_agent\_tolerations](#input\_log\_analysis\_agent\_tolerations)| DEPRECATED: List of tolerations to apply to Log Analysis agent. | <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 |
172
172
| <aname="input_log_analysis_enabled"></a> [log\_analysis\_enabled](#input\_log\_analysis\_enabled)| DEPRECATED: Deploy IBM Cloud Log Analysis agent |`bool`|`false`| no |
173
173
| <aname="input_log_analysis_endpoint_type"></a> [log\_analysis\_endpoint\_type](#input\_log\_analysis\_endpoint\_type)| DEPRECATED: Specify the IBM Log Analysis instance endpoint type (public or private) to use. Used to construct the ingestion endpoint. |`string`|`"private"`| no |
174
174
| <aname="input_log_analysis_ingestion_key"></a> [log\_analysis\_ingestion\_key](#input\_log\_analysis\_ingestion\_key)| DEPRECATED: Ingestion key for the Log Analysis agent to communicate with the instance |`string`|`null`| no |
175
175
| <aname="input_log_analysis_instance_region"></a> [log\_analysis\_instance\_region](#input\_log\_analysis\_instance\_region)| DEPRECATED: The IBM Log Analysis instance region. Used to construct the ingestion endpoint. |`string`|`null`| no |
176
176
| <aname="input_log_analysis_secret_name"></a> [log\_analysis\_secret\_name](#input\_log\_analysis\_secret\_name)| DEPRECATED: The name of the secret which will store the Log Analysis ingestion key. |`string`|`"logdna-agent"`| no |
177
177
| <aname="input_logs_agent_additional_log_source_paths"></a> [logs\_agent\_additional\_log\_source\_paths](#input\_logs\_agent\_additional\_log\_source\_paths)| The list of additional log sources. By default, the Logs agent collects logs from a single source at `/var/log/containers/*.log`. |`list(string)`|`[]`| no |
178
-
| <aname="input_logs_agent_additional_metadata"></a> [logs\_agent\_additional\_metadata](#input\_logs\_agent\_additional\_metadata)| The list of additional metadata fields to add to the routed logs. | <pre>list(object({<br> key = optional(string)<br> value = optional(string)<br> }))</pre> |`[]`| no |
178
+
| <aname="input_logs_agent_additional_metadata"></a> [logs\_agent\_additional\_metadata](#input\_logs\_agent\_additional\_metadata)| The list of additional metadata fields to add to the routed logs. | <pre>list(object({<br/> key = optional(string)<br/> value = optional(string)<br/> }))</pre> |`[]`| no |
179
179
| <aname="input_logs_agent_enable_scc"></a> [logs\_agent\_enable\_scc](#input\_logs\_agent\_enable\_scc)| Whether to enable creation of Security Context Constraints in Openshift. When installing on an OpenShift cluster, this setting is mandatory to configure permissions for pods within your cluster. |`bool`|`true`| no |
180
180
| <aname="input_logs_agent_enabled"></a> [logs\_agent\_enabled](#input\_logs\_agent\_enabled)| Whether to deploy the Logs agent. |`bool`|`true`| no |
181
181
| <aname="input_logs_agent_exclude_log_source_paths"></a> [logs\_agent\_exclude\_log\_source\_paths](#input\_logs\_agent\_exclude\_log\_source\_paths)| The list of log sources to exclude. Specify the paths that the Logs agent ignores. |`list(string)`|`[]`| no |
@@ -186,7 +186,7 @@ You need the following permissions to run this module.
186
186
| <aname="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 |
187
187
| <aname="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 |
188
188
| <aname="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 |
189
-
| <aname="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 |
189
+
| <aname="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 |
190
190
| <aname="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 |
Copy file name to clipboardExpand all lines: modules/logs-agent/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ No modules.
87
87
| <aname="input_cluster_resource_group_id"></a> [cluster\_resource\_group\_id](#input\_cluster\_resource\_group\_id)| The resource group ID of the cluster. |`string`| n/a | yes |
88
88
| <aname="input_is_vpc_cluster"></a> [is\_vpc\_cluster](#input\_is\_vpc\_cluster)| Specify true if the target cluster for the agents is a VPC cluster, false if it is a classic cluster. |`bool`|`true`| no |
89
89
| <aname="input_logs_agent_additional_log_source_paths"></a> [logs\_agent\_additional\_log\_source\_paths](#input\_logs\_agent\_additional\_log\_source\_paths)| The list of additional log sources. By default, the Logs agent collects logs from a single source at `/var/log/containers/*.log`. |`list(string)`|`[]`| no |
90
-
| <aname="input_logs_agent_additional_metadata"></a> [logs\_agent\_additional\_metadata](#input\_logs\_agent\_additional\_metadata)| The list of additional metadata fields to add to the routed logs. | <pre>list(object({<br> key = optional(string)<br> value = optional(string)<br> }))</pre> |`[]`| no |
90
+
| <aname="input_logs_agent_additional_metadata"></a> [logs\_agent\_additional\_metadata](#input\_logs\_agent\_additional\_metadata)| The list of additional metadata fields to add to the routed logs. | <pre>list(object({<br/> key = optional(string)<br/> value = optional(string)<br/> }))</pre> |`[]`| no |
91
91
| <aname="input_logs_agent_enable_scc"></a> [logs\_agent\_enable\_scc](#input\_logs\_agent\_enable\_scc)| Whether to enable creation of Security Context Constraints in Openshift. When installing on an OpenShift cluster, this setting is mandatory to configure permissions for pods within your cluster. |`bool`|`true`| no |
92
92
| <aname="input_logs_agent_exclude_log_source_paths"></a> [logs\_agent\_exclude\_log\_source\_paths](#input\_logs\_agent\_exclude\_log\_source\_paths)| The list of log sources to exclude. Specify the paths that the Logs agent ignores. |`list(string)`|`[]`| no |
93
93
| <aname="input_logs_agent_iam_api_key"></a> [logs\_agent\_iam\_api\_key](#input\_logs\_agent\_iam\_api\_key)| The IBM Cloud API key for the Logs agent to authenticate and communicate with the IBM Cloud Logs. It is required if `logs_agent_iam_mode` is set to `IAMAPIKey`. |`string`|`null`| no |
@@ -97,7 +97,7 @@ No modules.
97
97
| <aname="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 |
98
98
| <aname="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 |
99
99
| <aname="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 |
100
-
| <aname="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 |
100
+
| <aname="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 |
101
101
| <aname="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 |
0 commit comments