Available in: Open/CE, Core, BE, SE, SE+, Ultimate/EE
The module lifecycle stage: Generally available version
The module has requirements for installation
Requirements
To the Deckhouse Platform version: 1.74 and above.
To the versions of other modules:
-
console: 1.41.1 and above. -
operator-prometheus: any version. -
prometheus: any version.
Conversions
The module is configured using the ModuleConfig resource, the schema of which contains a version number. When you apply an old version of the ModuleConfig schema in a cluster, automatic transformations are performed. To manually update the ModuleConfig schema version, the following steps must be completed sequentially for each version:
-
Updates from version 1 to 2:
Delete the
.dop.nodeAffinityfield: the agent collects node metrics instead ofnode-exporterand runs on every node of the cluster, restricting the set of nodes is no longer supported.
Parameters
Schema version: 2
-
-
objectsettings.deadMansSwitchSettings for the DeadMansSwitch alerting.
Default:
{}-
booleansettings.deadMansSwitch.enabled
Whether to enable DeadMansSwitch alert handling.
When enabled (default), a DeadMansSwitch heartbeat alert is expected from Prometheus and a PrometheusUnavailable alert is generated if the heartbeat is missing. When disabled, neither DeadMansSwitch nor PrometheusUnavailable alerts are created.
Default:
true
-
-
objectsettings.dopSettings for integration with DOP (Deckhouse Observability Platform).
Default:
{}-
array of objectssettings.dop.destinationsList of DOP destinations for metrics delivery. At least one destination is required.
Example:
destinations: - host: dop.flant.com token: your-api-token-here-
stringsettings.dop.destinations.hostDOP platform host address (must be a valid FQDN, e.g., dop.flant.com).
Length:
1..253Pattern:
^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$ -
stringsettings.dop.destinations.tokenAPI token for the DOP platform (UUID format).
Pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
-
-
booleansettings.dop.hostMetricsWhether to enable nodes metrics collection with okagent.
Default:
true
-
-
objectsettings.externalMetricsAccessSettings for external access to metrics.
Default:
{}-
booleansettings.externalMetricsAccess.enabled
Whether to enable metrics external read access.
If enabled, the
observabilitymodule will expose the metrics via ingress for reading. Metrics can be read using the Prometheus-compatible API. Providing a valid ServiceAccount token via theAuthorization: Bearerheader is mandatory. For details, refer to “External access to metrics”.Default:
false -
array of stringssettings.externalMetricsAccess.whitelistSourceRangesAn array if CIDRs that are allowed to read metrics. If not specified, no restrictions are applied.
Default:
[]Example:
whitelistSourceRanges: - 1.1.1.1/32-
stringsettings.externalMetricsAccess.whitelistSourceRanges.Element of the array
Pattern:
^(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(/([0-9]|[12][0-9]|3[0-2]))?|([0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}(/([0-9]|[1-9][0-9]|1[01][0-9]|12[0-8]))?)$
-
-
-
objectsettings.grafanaGrafana related settings.
Default:
{}-
array of stringssettings.grafana.customPlugins
A list of custom Grafana plugins. Contains plugin names from the official repository.
Here is how you can add custom plugins (in this case, clickhouse-datasource and flowcharting-panel plugins are used):
grafana: customPlugins: - agenty-flowcharting-panel - vertamedia-clickhouse-datasourceYou can also install plugins from other sources by passing a link to the plugin zip archive in the format
<url to plugin zip>;<plugin name>:grafana: customPlugins: - http://10.241.32.16:3000/netsage-bumpchart-panel-1.1.1.zip;netsage-bumpchart-panelExample:
customPlugins: - agenty-flowcharting-panel - vertamedia-clickhouse-datasource
-
-
booleansettings.highAvailability
Manually enable the high availability mode.
By default, the mode is taken from the global
highAvailabilityparameter; if it is not set, the mode is enabled when the cluster control plane is highly available.alert-kube-apiandobservability-webhookalways run in two replicas regardless of this parameter.Examples:
highAvailability: truehighAvailability: false -
objectsettings.https
What certificate type to use with observability module.
This parameter completely overrides the
global.modules.httpssettings.Examples:
customCertificate: secretName: foobar mode: CustomCertificatecertManager: clusterIssuerName: letsencrypt mode: CertManager-
objectsettings.https.certManager
-
stringsettings.https.certManager.clusterIssuerName
What ClusterIssuer to use for the observability module.
Currently,
letsencrypt,letsencrypt-staging,selfsignedare available. Also, you can define your own.Default:
letsencrypt
-
-
objectsettings.https.customCertificate
Default:
{}-
stringsettings.https.customCertificate.secretName
The name of the secret in the
d8-systemnamespace to use with the observability module.This secret must have the kubernetes.io/tls format.
Default:
false
-
-
stringsettings.https.mode
The HTTPS usage mode:
Disabled— the observability module will work over HTTP only;CertManager— the observability module will use HTTPS and get a certificate from the clusterissuer defined in thecertManager.clusterIssuerNameparameter.CustomCertificate— the observability module will use HTTPS using the certificate from thed8-systemnamespace.OnlyInURI— the observability module will work over HTTP (thinking that there is an external HTTPS load balancer in front that terminates HTTPS traffic). All the links in theuser-authnwill be generated using the HTTPS scheme. Load balancer should provide a redirect from HTTP to HTTPS.
Default:
DisabledAllowed values:
Disabled,CertManager,CustomCertificate,OnlyInURI
-
-
stringsettings.ingressClass
The ingress class to use for all ingress resources created by the observability module.
This parameter completely overrides the
global.modules.ingressClasssettings. If not specified, the global ingress class configuration will be used.The value must be a valid Kubernetes resource name (lowercase alphanumeric characters or hyphens, must start and end with alphanumeric character).
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$Examples:
ingressClass: nginxingressClass: nginx-external -
objectsettings.lightweightLogsSettings for lightweight logs collection directly from kubelet.
Default:
{ "enabled": true }-
booleansettings.lightweightLogs.enabledWhether to enable lightweight logs collection from kubelet.
Default:
true
-
-
objectsettings.opagentSettings for the opagent host metrics collector.
Default:
{}-
integersettings.opagent.scrapeInterval
Interval (in seconds) at which opagent collects host metrics.
Should typically match the cluster’s Prometheus scrape_interval to avoid mismatched data density in Grafana dashboards backed by the same datasource.
Default:
30Allowed values:
10 <= X
-
-
objectsettings.polkAnnotationsSettings for Polk-specific alert annotations handling.
Default:
{}-
booleansettings.polkAnnotations.enabled
Whether to keep Polk-specific alert annotations (with the
plk_prefix) in incoming alerts.When enabled (default),
plk_*annotations are preserved in alerts for all notification receivers. When disabled, allplk_*annotations are removed from alerts when sending notifications to any receiver.Default:
true
-
-