NetApp Kubernetes Monitoring Operator Configuration Options
The NetApp Kubernetes Monitoring Operator installation and configuration can be customized.
The table below lists the possible options for the AgentConfiguration file:
Component | Option | Description |
---|---|---|
agent |
Configuration options that are common to all components that the operator can install. These can be considered as "global" options. |
|
dockerRepo |
A dockerRepo override to pull images from customers private docker repos as compared to Cloud Insights docker repo. Default is cloud insights docker repo |
|
dockerImagePullSecret |
Optional: A secret for the customers private repo |
|
clusterName |
Free text field that uniquely identifies a cluster across all customers clusters. This should be unique across a cloud insights tenant. Default is what the customer enters in the UI for the "Cluster Name" field |
|
proxy |
Optional to set proxy. This is usually the customer's corporate proxy. |
|
telegraf |
Configuration options that can customize the telegraf installation of the Operator |
|
collectionInterval |
Metrics collection interval, in seconds (Max=60s) |
|
dsCpuLimit |
CPU Limit for telegraf ds |
|
dsMemLimit |
Memory limit for telegraf ds |
|
dsCpuRequest |
CPU request for telegraf ds |
|
dsMemRequest |
Memory request for telegraf ds |
|
rsCpuLimit |
CPU Limit for telegraf rs |
|
rsMemLimit |
Memory limit for telegraf rs |
|
rsCpuRequest |
CPU request for telegraf rs |
|
rsMemRequest |
Memory request for telegraf rs |
|
dockerMountPoint |
an override for dockerMountPoint path. This is for non standard docker installations on k8s platforms like cloud foundry |
|
dockerUnixSocket |
an override for dockerUnixSocket path. This is for non standard docker installations on k8s platforms like cloud foundry. |
|
crioSockPath |
an override for crioSockPath path. This is for non standard docker installations on k8s platforms like cloud foundry. |
|
runPrivileged |
Run the telegraf container in privileged mode. Set this to true if SELinux is enabled on your k8s nodes |
|
batchSize |
||
bufferLimit |
||
roundInterval |
||
collectionJitter |
||
precision |
||
flushInterval |
||
flushJitter |
||
outputTimeout |
||
dockerMetricCollectionEnabled |
Collect Docker metrics. By default, this is set to true and docker metrics will be collected for on-premise, docker-based k8s deployments. To disable docker metric collection, set this to false. |
|
dsTolerations |
telegraf-ds additional tolerations. |
|
rsTolerations |
telegraf-rs additional tolerations. |
|
kube-state-metrics |
Configuration options that can customize the kube state metrics installation of the Operator |
|
cpuLimit |
CPU limit for kube-state-metrics deployment |
|
memLimit |
Mem limit for kube-state-metrics deployment |
|
cpuRequest |
CPU request for kube state metrics deployment |
|
memRequest |
Mem request for kube state metrics deployment |
|
resources |
a comma separated list of resources to capture. |
|
tolerations |
kube-state-metrics additional tolerations. |
|
labels |
a comma separated list of resources that kube-state-metrics should capture example: cronjobs=[*],daemonsets=[*],deployments=[*],ingresses=[*],jobs=[*],namespaces=[*],nodes=[*], persistentvolumeclaims=[*],persistentvolumes=[*],pods=[*],replicasets=[*],resourcequotas=[*],services=[*],statefulsets=[*] |
|
logs |
Configuration options that can customize logs collection and installation of the Operator |
|
readFromHead |
true/false, should fluent bit read the log from head |
|
timeout |
timeout, in secs |
|
dnsMode |
TCP/UDP, mode for DNS |
|
fluent-bit-tolerations |
fluent-bit-ds additional tolerations. |
|
event-exporter-tolerations |
event-exporter additional tolerations. |
|
workload-map |
Configuration options that can customize the workload map collection and installation of the Operator |
|
cpuLimit |
CPU limit for net observer ds |
|
memLimit |
mem limit for net observer ds |
|
cpuRequest |
CPU request for net observer ds |
|
memRequest |
mem request for net observer ds |
|
metricAggregationInterval |
metric aggregation interval, in seconds |
|
bpfPollInterval |
BPF poll interval, in seconds |
|
enableDNSLookup |
true/false, enable DNS lookup |
|
l4-tolerations |
net-observer-l4-ds additional tolerations. |
|
runPrivileged |
true/false - Set runPrivileged to true if SELinux is enabled on your Kubernetes nodes. |
|
change-management |
Configuration options for Kubernetes Change Management and Analysis |
|
cpuLimit |
CPU limit for change-observer-watch-rs |
|
memLimit |
Mem limit for change-observer-watch-rs |
|
cpuRequest |
CPU request for change-observer-watch-rs |
|
memRequest |
mem request for change-observer-watch-rs |
|
failureDeclarationIntervalMins |
Interval in minutes after which a non-successful deployment of a workload will be marked as failed |
|
deployAggrIntervalSeconds |
Frequency at which workload deployment in-progress events are sent |
|
nonWorkloadAggrIntervalSeconds |
Frequency at which non-workload deployments are combined and sent |
|
termsToRedact |
A set of regular expressions used in env names and data maps whose value will be redacted |
|
additionalKindsToWatch |
A comma separated list of additional kinds to watch from the default set of kinds watched by the collector |
|
kindsToIgnoreFromWatch |
A comma separated list of kinds to ignore from watching from the default set of kinds watched by the collector |
|
logRecordAggrIntervalSeconds |
Frequency with which log records are sent to CI from the collector |
|
watch-tolerations |
change-observer-watch-ds additional tolerations. Abbreviated single line format only. |
Sample AgentConfiguration file
Below is a sample AgentConfiguration file.
apiVersion: monitoring.netapp.com/v1alpha1 kind: AgentConfiguration metadata: name: netapp-monitoring-configuration namespace: "NAMESPACE_PLACEHOLDER" labels: installed-by: nkmo-NAMESPACE_PLACEHOLDER spec: # # You can modify the following fields to configure the operator. # # Optional settings are commented out and include default values for reference # # To update them, uncomment the line, change the value, and apply the updated AgentConfiguration. agent: # # [Required Field] A uniquely identifiable user-friendly clustername. # # clusterName must be unique across all clusters in your Cloud Insights environment. clusterName: "CLUSTERNAME_PLACEHOLDER" # # Proxy settings. The proxy that the operator should use to send metrics to Cloud Insights. # # Please see documentation here: https://docs.netapp.com/us-en/cloudinsights/task_config_telegraf_agent_k8s.html#configuring-proxy-support # proxy: # server: # port: # noproxy: # username: # password: # isTelegrafProxyEnabled: # isFluentbitProxyEnabled: # isCollectorsProxyEnabled: # # [Required Field] By default, the operator uses the CI repository. # # To use a private repository, change this field to your repository name. # # Please see documentation here: https://docs.netapp.com/us-en/cloudinsights/task_config_telegraf_agent_k8s.html#using-a-custom-or-private-docker-repository dockerRepo: 'DOCKER_REPO_PLACEHOLDER' # # [Required Field] The name of the imagePullSecret for dockerRepo. # # If you are using a private repository, change this field from 'docker' to the name of your secret. {{ if not (contains .Values.config.cloudType "aws") }}# {{ end -}} dockerImagePullSecret: 'docker' # # Allow the operator to automatically rotate its ApiKey before expiration. # tokenRotationEnabled: '{{ .Values.telegraf_installer.kubernetes.rs.shim_token_rotation }}' # # Number of days before expiration that the ApiKey should be rotated. This must be less than the total ApiKey duration. # tokenRotationThresholdDays: '{{ .Values.telegraf_installer.kubernetes.rs.shim_token_rotation_threshold_days }}' telegraf: # # Settings to fine-tune metrics data collection. Telegraf config names are included in parenthesis. # # See https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md#agent # # The default time telegraf will wait between inputs for all plugins (interval). Max=60 # collectionInterval: '{{ .Values.telegraf_installer.agent_resources.collection_interval }}' # # Maximum number of records per output that telegraf will write in one batch (metric_batch_size). # batchSize: '{{ .Values.telegraf_installer.agent_resources.metric_batch_size }}' # # Maximum number of records per output that telegraf will cache pending a successful write (metric_buffer_limit). # bufferLimit: '{{ .Values.telegraf_installer.agent_resources.metric_buffer_limit }}' # # Collect metrics on multiples of interval (round_interval). # roundInterval: '{{ .Values.telegraf_installer.agent_resources.round_interval }}' # # Each plugin waits a random amount of time between the scheduled collection time and that time + collection_jitter before collecting inputs (collection_jitter). # collectionJitter: '{{ .Values.telegraf_installer.agent_resources.collection_jitter }}' # # Collected metrics are rounded to the precision specified. When set to "0s" precision will be set by the units specified by interval (precision). # precision: '{{ .Values.telegraf_installer.agent_resources.precision }}' # # Time telegraf will wait between writing outputs (flush_interval). Max=collectionInterval # flushInterval: '{{ .Values.telegraf_installer.agent_resources.flush_interval }}' # # Each output waits a random amount of time between the scheduled write time and that time + flush_jitter before writing outputs (flush_jitter). # flushJitter: '{{ .Values.telegraf_installer.agent_resources.flush_jitter }}' # # Timeout for writing to outputs (timeout). # outputTimeout: '{{ .Values.telegraf_installer.http_output_plugin.timeout }}' # # telegraf-ds CPU/Mem limits and requests. # # See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ dsCpuLimit: '{{ .Values.telegraf_installer.telegraf_resources.ds_cpu_limits }}' dsMemLimit: '{{ .Values.telegraf_installer.telegraf_resources.ds_mem_limits }}' dsCpuRequest: '{{ .Values.telegraf_installer.telegraf_resources.ds_cpu_request }}' dsMemRequest: '{{ .Values.telegraf_installer.telegraf_resources.ds_mem_request }}' # # telegraf-rs CPU/Mem limits and requests. rsCpuLimit: '{{ .Values.telegraf_installer.telegraf_resources.rs_cpu_limits }}' rsMemLimit: '{{ .Values.telegraf_installer.telegraf_resources.rs_mem_limits }}' rsCpuRequest: '{{ .Values.telegraf_installer.telegraf_resources.rs_cpu_request }}' rsMemRequest: '{{ .Values.telegraf_installer.telegraf_resources.rs_mem_request }}' # # telegraf additional tolerations. Use the following abbreviated single line format only. # # Inspect telegraf-rs/-ds to view tolerations which are always present. # # Example: '{key: taint1, operator: Exists, effect: NoSchedule},{key: taint2, operator: Exists, effect: NoExecute}' # dsTolerations: '' # rsTolerations: '' # # Set runPrivileged to true if SELinux is enabled on your Kubernetes nodes. # runPrivileged: 'false' # # Collect NFS IO metrics. # dsNfsIOEnabled: '{{ .Values.telegraf_installer.kubernetes.ds.shim_nfs_io_processing }}' # # Collect kubernetes.system_container metrics and objects in the kube-system|cattle-system namespaces for managed kubernetes clusters (EKS, AKS, GKE, managed Rancher). Set this to true if you want collect these metrics. # managedK8sSystemMetricCollectionEnabled: '{{ .Values.telegraf_installer.kubernetes.shim_managed_k8s_system_metric_collection }}' # # Collect kubernetes.pod_volume (pod ephemeral storage) metrics. Set this to true if you want to collect these metrics. # podVolumeMetricCollectionEnabled: '{{ .Values.telegraf_installer.kubernetes.shim_pod_volume_metric_collection }}' # # Declare Rancher cluster as managed. Set this to true if your Rancher cluster is managed as opposed to on-premise. # isManagedRancher: '{{ .Values.telegraf_installer.kubernetes.is_managed_rancher }}' # kube-state-metrics: # # kube-state-metrics CPU/Mem limits and requests. By default, when unset, kube-state-metrics has no CPU/Mem limits nor request. # cpuLimit: # memLimit: # cpuRequest: # memRequest: # # Comma-separated list of metrics to enable. # # See metric-allowlist in https://github.com/kubernetes/kube-state-metrics/blob/main/docs/cli-arguments.md # resources: 'cronjobs,daemonsets,deployments,ingresses,jobs,namespaces,nodes,persistentvolumeclaims,persistentvolumes,pods,replicasets,resourcequotas,services,statefulsets' # # Comma-separated list of Kubernetes label keys that will be used in the resources' labels metric. # # See metric-labels-allowlist in https://github.com/kubernetes/kube-state-metrics/blob/main/docs/cli-arguments.md # labels: 'cronjobs=[*],daemonsets=[*],deployments=[*],ingresses=[*],jobs=[*],namespaces=[*],nodes=[*],persistentvolumeclaims=[*],persistentvolumes=[*],pods=[*],replicasets=[*],resourcequotas=[*],services=[*],statefulsets=[*]' # # kube-state-metrics additional tolerations. Use the following abbreviated single line format only. # # No tolerations are applied by default # # Example: '{key: taint1, operator: Exists, effect: NoSchedule},{key: taint2, operator: Exists, effect: NoExecute}' # tolerations: '' # # Settings for the Events Log feature. # logs: # # If Fluent Bit should read new files from the head, not tail. # # See Read_from_Head in https://docs.fluentbit.io/manual/pipeline/inputs/tail # readFromHead: "true" # # Network protocol that Fluent Bit should use for DNS: "UDP" or "TCP". # dnsMode: "UDP" # # Logs additional tolerations. Use the following abbreviated single line format only. # # Inspect fluent-bit-ds to view tolerations which are always present. No tolerations are applied by default for event-exporter. # # Example: '{key: taint1, operator: Exists, effect: NoSchedule},{key: taint2, operator: Exists, effect: NoExecute}' # fluent-bit-tolerations: '' # event-exporter-tolerations: '' # # Settings for the Network Performance and Map feature. # workload-map: # # net-observer-l4-ds CPU/Mem limits and requests. # # See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # cpuLimit: '500m' # memLimit: '500Mi' # cpuRequest: '100m' # memRequest: '500Mi' # # Metric aggregation interval in seconds. Min=30, Max=120 # metricAggregationInterval: '60' # # Interval for bpf polling. Min=3, Max=15 # bpfPollInterval: '8' # # Enable performing reverse DNS lookups on observed IPs. # enableDNSLookup: 'true' # # net-observer-l4-ds additional tolerations. Use the following abbreviated single line format only. # # Inspect net-observer-l4-ds to view tolerations which are always present. # # Example: '{key: taint1, operator: Exists, effect: NoSchedule},{key: taint2, operator: Exists, effect: NoExecute}' # l4-tolerations: '' # # Set runPrivileged to true if SELinux is enabled on your Kubernetes nodes. # # Note: In OpenShift environments, this is set to true automatically. # runPrivileged: 'false' # change-management: # # change-observer-watch-rs CPU/Mem limits and requests. # # See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # cpuLimit: '500m' # memLimit: '500Mi' # cpuRequest: '100m' # memRequest: '500Mi' # # Interval in minutes after which a non-successful deployment of a workload will be marked as failed # failureDeclarationIntervalMins: '30' # # Frequency at which workload deployment in-progress events are sent # deployAggrIntervalSeconds: '300' # # Frequency at which non-workload deployments are combined and sent # nonWorkloadAggrIntervalSeconds: '15' # # A set of regular expressions used in env names and data maps whose value will be redacted # termsToRedact: '"pwd", "password", "token", "apikey", "api-key", "jwt"' # # A comma separated list of additional kinds to watch from the default set of kinds watched by the collector # # Each kind will have to be prefixed by its apigroup # # Example: 'authorization.k8s.io.subjectaccessreviews' # additionalKindsToWatch: '' # # A comma separated list of kinds to ignore from watching from the default set of kinds watched by the collector # # Each kind will have to be prefixed by its apigroup # # Example: 'networking.k8s.io.networkpolicies,batch.jobs' # kindsToIgnoreFromWatch: '' # # Frequency with which log records are sent to CI from the collector # logRecordAggrIntervalSeconds: '20' # # change-observer-watch-ds additional tolerations. Use the following abbreviated single line format only. # # Inspect change-observer-watch-ds to view tolerations which are always present. # # Example: '{key: taint1, operator: Exists, effect: NoSchedule},{key: taint2, operator: Exists, effect: NoExecute}' # watch-tolerations: ''----