The module lifecycle stage: Generally available version
The module has requirements for installation
Deckhouse Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.
ClusterLog
Scope: Cluster
Version: v1alpha1
ClusterObservabilityAlertAdditionalLabels
Short names: coalabels
Scope: Cluster
Version: v1alpha1
Additional labels the module adds to alerts shipped with Deckhouse Platform.
If an alert already contains a label with the same key, its value is preserved.
Warning. Additional labels are applied only to alerts created using the resources labeled with
heritage: deckhouse.
-
objectspec
-
objectspec.additionalLabels
Required value
Additional labels to add to each matching alert.
If an alert already contains a label with the same key, its value is preserved.
-
objectspec.alertSelector
Required value
Alerts that will receive the additional labels.
Matching is performed against alert labels set in the rule and the
alertnamelabel with the alert name.-
array of objectsspec.alertSelector.matchExpressions
Required value
List of label selector requirements.
All requirements must be satisfied.
-
stringspec.alertSelector.matchExpressions.keyLabel name.
-
stringspec.alertSelector.matchExpressions.operator
Comparison operator:
In: Label exists, and its value is invalues.NotIn: Label does not exist, or its value is not invalues.Exists: Label exists.DoesNotExist: Label does not exist.
Allowed values:
In,NotIn,Exists,DoesNotExist -
array of stringsspec.alertSelector.matchExpressions.valuesLabel values for the
InandNotInoperators.
-
-
objectspec.alertSelector.matchLabelsExact key-value pairs that must be present on the alert to add labels.
-
-
ClusterObservabilityDashboard
Scope: Cluster
Version: v1alpha1
Cluster-level dashboard displayed in the Deckhouse web UI. To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface. -metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ClusterObservabilityDiagnosticPlaybook
Short names: codp
Scope: Cluster
Version: v1alpha1
Experimental. Diagnostic playbook for firing alerts.
Tells which alerts it applies to, how the diagnosed Kubernetes object is found from the alert labels, which checks to run in addition to the standard checks of the object kind, and which deterministic findings to derive from the collected facts. The controller validates the playbook and writes the condition Valid; an invalid playbook is not run.
Only the cluster administrator can create playbooks. A playbook runs next to the built-in playbooks of the controller and cannot replace or turn one off: the names of the built-in playbooks and every name that starts with observability- are reserved, and the controller does not run a playbook with such a name (condition Valid is False with reason ReservedName).
A playbook may extend a built-in abstract playbook (spec.extends): it takes its checks and findings, and a check or a finding of its own with the id of one of them replaces it whole.
-
objectspecDefines the playbook.
-
booleanspec.abstractMarks a built-in playbook that other playbooks only extend: it never matches an alert and has no
match,targetorbaseline. Abstract playbooks may extend each other, at most three in a chain. A playbook of the cluster withabstract: trueis not run: conditionValidisFalsewith reasonInvalid. -
stringspec.baselineStandard checks of the target kind:
Autoruns them,Nonekeeps only the alert context.Default:
AutoAllowed values:
Auto,None -
array of objectsspec.checksChecks run in addition to the baseline.
-
objectspec.checks.baselineParameters of the
Baselinecheck: runs a built-in recipe. Its rows join the baseline: findings read them asbaseline.<id>, only when the playbook has the check of the recipe; the report stores them asbaseline/<id>. At most one check per recipe; needsbaselineAutoand, except forVolumeUsage,ScrapeNetworkPoliciesandImageCheckLog,match.scopeCluster.Skippedwith reasonNotOnLinkedObjecton a linked object.-
array of objectsspec.checks.baseline.patternsLines the recipe looks for in the journals it reads, by the keys the recipe reads (
EtcdMembers:staticPod, in the journal of kubelet; the other recipes read none). The journal counts the entries that match each pattern and keeps the newest one underevidence.patterns.<key>with the named groups of the expression.-
stringspec.checks.baseline.patterns.exprRE2 regular expression over the message of a journal entry; the validation of the playbook compiles it.
Length:
1..1024 -
stringspec.checks.baseline.patterns.keyKey of the pattern in
evidence.patterns.Maximum length:
63Pattern:
^[a-z][A-Za-z0-9]*$
-
-
stringspec.checks.baseline.recipe
Required value
Recipe ID; the target it works on and the rows it writes. A recipe tied to a target kind ends its rowNotFoundwith reasonNoSubjecton another target.ChronyTime(Node):chronyctracking and sources from the chrony pod of the node, needs commands in containers; rownode-time.CiliumAgentStatus(Pod ind8-cni-cilium):cilium-health status,cilium-dbg status --brief; rowcilium-agent-status.DeckhouseModule(module of the alert labelmodule, a ModuleRelease or a ModuleConfig): its ModulePullOverride (rowmodule-pull-override) and, when the Module reports an error, its lines in the Deckhouse log (rowcontroller-logs).EtcdMembers: membership and state of the etcd members of the control-plane nodes; rowscontrol-plane-nodes,scrape-targets,etcd-membership,etcd-member-state,etcd-peer-prober,etcd-members,node-journal-kubelet,control-plane-manager.ImageCheckLog(any scope): image-availability-exporter log lines about the alert labelimage; rowexporter-log.NodeLocalDNSUpstreams(Node): forwarding, logs and upstreams of node-local-dns and the cluster DNS backends; rowsnld-forward,nld-logs,dns-backends,nld-caches,nld-upstreams.PrometheusLayout(Prometheus Pod): retention and what the entries of the data volume are, walked by the node agent; rowprometheus-layout.ScrapeClientCertificate(ModuleConfigmonitoring-applicationsormonitoring-custom): whether HTTPS scrape targets accept the client certificate of Prometheus; rowscrape-client-certificate.ScrapeNetworkPolicies(Pod): whether NetworkPolicies let the main Prometheus scrape the port of the alert labelinstance; rowscrape-network-policies.StorageTerminating(any target):storage.deckhouse.ioobjects with a deletion time; rowstorage-terminating.VolumeUsage(PersistentVolumeClaim):df,df -iand the 10 largest directories of the volume, run in the pod of the alert labelpod; rowsvolume-df,volume-inodes,volume-du(Skippedover 400Gi).Allowed values:
ChronyTime,CiliumAgentStatus,DeckhouseModule,EtcdMembers,ImageCheckLog,NodeLocalDNSUpstreams,PrometheusLayout,ScrapeClientCertificate,ScrapeNetworkPolicies,StorageTerminating,VolumeUsage
-
-
objectspec.checks.eventsParameters of the
Eventscheck: events of every type of the last hour of an object, grouped by message.-
integerspec.checks.events.limitMaximum number of event groups.
Allowed values:
1 <= X <= 50 -
objectspec.checks.events.objectObject whose events the check reads, in the namespace of the report.
-
stringspec.checks.events.object.kind
Required value
Kind of the object.Allowed values:
CronJob,Pod -
stringspec.checks.events.object.nameTemplate
Required value
Name of the object, exactly{{ .labels.<name> }}of an alert label, or exactly{{= <CEL> }}over the factswhenreads. The computed value must be a DNS-1123 subdomain; otherwise the check is not run and endsInsufficientInputwith reasonParams. The object is read in the namespace of the report.Maximum length:
256
-
-
-
stringspec.checks.idCheck ID, unique within the playbook. Findings refer to it as
checks.<id>; the report stores it as<playbook>/<id>.Maximum length:
63Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ -
objectspec.checks.listParameters of the
Listcheck: lists objects of an allowlisted kind in the scope of the report, page by page.-
stringspec.checks.list.kind
Required value
Kind of the listed objects:Pod,Deployment,PersistentVolumeClaim,Node,Challenge,Order;CertificateRequest- issuer and issuance conditions, never the CSR or certificate;ClusterLoggingConfig,PodLoggingConfig(across namespaces) - cluster report only;StaticInstance- labels, phase and node, cluster report only;ModuleRelease- name, phase and status message, cluster report only.Allowed values:
Pod,Deployment,PersistentVolumeClaim,Node,CertificateRequest,Challenge,Order,ClusterLoggingConfig,PodLoggingConfig,StaticInstance,ModuleRelease -
stringspec.checks.list.labelSelectorStatic label selector in Kubernetes syntax.
Maximum length:
256 -
integerspec.checks.list.limitMaximum number of objects.
Allowed values:
1 <= X <= 50
-
-
objectspec.checks.metricsParameters of the
Metricscheck: a named recipe of the built-in catalog over the last hour.-
stringspec.checks.metrics.recipe
Required value
Recipe ID.Maximum length:
63 -
stringspec.checks.metrics.subjectObject the recipe reads: the target, or the nodes of the pods of the target.
Allowed values:
Target,Nodes
-
-
objectspec.checks.nodeAgentParameters of the
NodeAgentcheck: one operation of the node agent on the node of the target (a Node, the node of a Pod, or every control-plane node forAudit). Needsmatch.scopeCluster, exceptOOMKillsandListeners.Skippedwith reasonNotOnLinkedObjecton a linked object andNodeAgentDisabledwithalertDiagnostics.nodeAgent.enabledoff. The agent reads only units and paths it allows.-
stringspec.checks.nodeAgent.atTime of
Audit, RFC 3339, or exactly{{= <CEL> }}whose value is one, such as the time of the write ofspec.unschedulableof the target node (baseline.target.evidence.cordonedBy.time); a computed value that is no time ends the checkInsufficientInputwith reasonParams.Maximum length:
256 -
stringspec.checks.nodeAgent.containerContainer of the target pod for
OOMKillsorListeners: a DNS-1123 label or exactly{{= <CEL> }}(an invalid value ends the checkInsufficientInputwith reasonParams, an empty one names no container).OOMKillsputs the newest kill of its last terminated instance underevidence.kill;Listenersreads the sockets through its running instance.Maximum length:
63 -
integerspec.checks.nodeAgent.depthDirectory levels below
paththatDisklists; 3 when not set.Allowed values:
1 <= X <= 3 -
stringspec.checks.nodeAgent.deviceDevice of the file system of
FilesystemErrorsas the alert names it, such as/dev/sdb1, or exactly{{= <CEL> }}whose value is one, at most 256 bytes; an empty computed value names no device. Only a device of/devoutside/dev/mapperhas a name the kernel lines give.Maximum length:
256 -
stringspec.checks.nodeAgent.grepRE2 regular expression
Kernelsends to the agent with the journal of the kernel, at most 256 bytes; the agent returns only the entries whose message matches it. A fixed value: the validation of the playbook compiles it.Length:
1..256 -
stringspec.checks.nodeAgent.linesWhat
Kernelreads in the lines it gets.ConntrackDrops: the count and the time of the newest drop of a packet for a full conntrack table, underevidence.tableFull.FilesystemErrors: the file system and I/O error lines, the newest one and the count of those that namedeviceor its disk, and up to 3 of other devices, underevidence.fsErrors.Allowed values:
ConntrackDrops,FilesystemErrors -
integerspec.checks.nodeAgent.maxLinesNewest entries of the window
Journalasks the node agent for; 200 when not set, at most 500, the limit of the agent. The agent also returns at most 64 KiB of messages, so a journal of long lines may give fewer.Allowed values:
1 <= X <= 500 -
stringspec.checks.nodeAgent.mountpointMount point the walk of
DiskorDiskTreemust be on, aspathor exactly{{= <CEL> }}: an answer of the agent for another file system, or its refusal of the path as no mount point, ends the checkInsufficientInputwith reasonMountNotSeen.Maximum length:
256 -
stringspec.checks.nodeAgent.operation
Required value
Operation of the node agent.Units: states of the systemd unitsunits.Journal: the journal ofunitfrom 30 minutes before the alert start (at most 24 hours) to the run, the newest 200 entries ormaxLines.Disk: file system use ofpathand its largest directories.DiskTree: file system use ofpathas a tree of its largest branches (up to 200 nodes, 8 levels); a walk under 30 minutes old is reused, a rerun asks for a new one.Layers: the largest writable layers of running containers.Kernel: the kernel journal in the window ofJournal, filtered bygrepand read aslinessays.Conntrack: fill of the conntrack table and kernel counters, no connections.OOMKills: oom-kill lines of the kernel for the target Pod in the window ofJournal.Listeners: listening TCP sockets of the target Pod and whether its declared ports are listened on.Audit: patches and updates of the target Node in the kube-apiserver audit log from 2 minutes beforeatto 1 minute after it: user, groups, user agent, source addresses, verb, time and code; the basic DKP audit policy records them only for Deckhouse service accounts.OOMKillsandListenerswork with anymatch.scope.Allowed values:
Units,Journal,Disk,Layers,Kernel,Conntrack,OOMKills,DiskTree,Listeners,Audit -
stringspec.checks.nodeAgent.pathPath
DiskandDiskTreewalk: an absolute clean host path of at most 256 bytes outside/proc,/sys,/dev,/run,/var/run,/etc,/root,/homeand/tmp, or exactly{{= <CEL> }}whose value is one. The agent walks/,/var/lib/containerd,/var/lib/kubelet,/var/log,/opt, and another path only when it is a mount point of ext2, ext3, ext4, xfs or btrfs.Maximum length:
256 -
array of objectsspec.checks.nodeAgent.patternsLines
Journallooks for in the journal. The journal counts the entries that match each pattern and keeps the newest one underevidence.patterns.<key>with the named groups of the expression, up tolinesBeforelines before it, and the number of lines the count is of (linesRead) and whether they are the whole window (windowRead).-
stringspec.checks.nodeAgent.patterns.exprRE2 regular expression over the message of a journal entry; the validation of the playbook compiles it.
Length:
1..1024 -
stringspec.checks.nodeAgent.patterns.keyKey of the pattern in
evidence.patterns.Maximum length:
63Pattern:
^[a-z][A-Za-z0-9]*$ -
integerspec.checks.nodeAgent.patterns.linesBeforeLines before the newest match the check keeps under
evidence.patterns.<key>.before, oldest first: the output since the match before it, without the empty lines and the commands a shell traces (+ …).Allowed values:
0 <= X <= 20
-
-
stringspec.checks.nodeAgent.sortByOrder of the directories of
DiskandDiskTreeand the layers ofLayers, largest first:bytes(when not set) orinodes, or exactly{{= <CEL> }}whose value is one of them.Maximum length:
256 -
integerspec.checks.nodeAgent.topDirectories
Disk, or writable layersLayers, lists; 10 when not set.Allowed values:
1 <= X <= 20 -
stringspec.checks.nodeAgent.unitUnit of
Journal:kubelet,containerd,containerd-deckhouse,bashibleorcloud-init, or exactly{{= <CEL> }}whose value is one of them.Maximum length:
256 -
array of stringsspec.checks.nodeAgent.unitsUnits of
Units, each once:kubelet,containerd,containerd-deckhouse.-
stringspec.checks.nodeAgent.units.Element of the array
Allowed values:
kubelet,containerd,containerd-deckhouse
-
-
-
objectspec.checks.objectParameters of the
Objectcheck: reads one object and stores its allowlisted projection, or finds the objects that name a Secret (bySecretName).-
objectspec.checks.object.bySecretNameFinds the cert-manager Certificates in the namespace of the report whose
spec.secretNameis the Secret. Evidence: the first of them by name, their number (total), their names (sameSecret, up to 5) and the other Certificates of the namespace (others, up to 50). No match ends the checkNotFoundwith reasonNoMatch. The Secret itself is never read.-
stringspec.checks.object.bySecretName.kind
Required value
Kind of the objects that name the Secret.Allowed values:
Certificate -
stringspec.checks.object.bySecretName.secretNameTemplate
Required value
Name of the Secret, a name or exactly{{ .labels.<name> }}of an alert label.Maximum length:
256
-
-
objectspec.checks.object.objectObject the check reads, in the namespace of the report.
-
stringspec.checks.object.object.kind
Required value
Kind of the object.Pod,CronJob: in the namespace of the report.NodeGroup: cluster report only.ClusterLogDestination,IngressNginxController,NodeGroupConfiguration: cluster report only, without secrets.Module: phase, conditions, version, source and release channel of a Deckhouse module; cluster report only.AdmissionObjects: the ValidatingAdmissionPolicy with its bindings, or the webhook with its Service endpoints, named by an API server error, and whose they are (labelsheritage,module); nevercaBundle, URL, rules or parameters; cluster report only.GatekeeperConstraint: the Gatekeeper constraint named by a Gatekeeper refusal, metadata only; cluster report only.Issuer,ClusterIssuer: the ingress class of each ACME HTTP-01 solver and labelsheritage,module, neverprivateKeySecretRef;ClusterIssuerin a cluster report only.ClusterObservabilityDashboard,ClusterObservabilityPropagatedDashboard,ClusterObservabilityMetricsRulesGroup,ClusterObservabilityPropagatedMetricsRulesGroup: metadata only; cluster report only.Allowed values:
Pod,CronJob,NodeGroupConfiguration,NodeGroup,ClusterLogDestination,IngressNginxController,Module,AdmissionObjects,GatekeeperConstraint,Issuer,ClusterIssuer,ClusterObservabilityDashboard,ClusterObservabilityPropagatedDashboard,ClusterObservabilityMetricsRulesGroup,ClusterObservabilityPropagatedMetricsRulesGroup -
stringspec.checks.object.object.nameTemplate
Required value
Name of the object, exactly{{ .labels.<name> }}of an alert label, or exactly{{= <CEL> }}over the factswhenreads. The computed value must be a DNS-1123 subdomain; otherwise the check is not run and endsInsufficientInputwith reasonParams. The object is read in the namespace of the report.Maximum length:
256
-
-
-
objectspec.checks.podExecParameters of the
PodExeccheck: a fixed command in a container. Runs only withalertDiagnostics.podExec.enabled.-
array of stringsspec.checks.podExec.command
Required value
Command as argv. An element{{ .labels.<name> }}is substituted as a whole argument after validation; the controller never adds a shell.-
stringspec.checks.podExec.command.Element of the array
Maximum length:
256
-
-
stringspec.checks.podExec.containerContainer name, or exactly
{{= <CEL> }}over the factswhenreads, whose value must be a DNS-1123 label (otherwise the check endsInsufficientInputwith reasonParams). The validation of the controller requires it.Maximum length:
63 -
integerspec.checks.podExec.limitBytesLimit of stdout and stderr bytes, each.
Allowed values:
1024 <= X <= 65536 -
objectspec.checks.podExec.objectObject named explicitly for
subject: Explicit, in the namespace of the report.-
stringspec.checks.podExec.object.kind
Required value
Kind of the object.Allowed values:
Pod -
stringspec.checks.podExec.object.nameTemplate
Required value
Name of the object, exactly{{ .labels.<name> }}of an alert label, or exactly{{= <CEL> }}over the factswhenreads. The computed value must be a DNS-1123 subdomain; otherwise the check is not run and endsInsufficientInputwith reasonParams. The object is read in the namespace of the report.Maximum length:
256
-
-
stringspec.checks.podExec.subject
Required value
Pod the command runs in: the target pod (the first representative pod for a workload target), or the pod ofobject.Allowed values:
Target,Explicit -
integerspec.checks.podExec.timeoutSecondsCommand timeout in seconds.
Allowed values:
1 <= X <= 60
-
-
objectspec.checks.podLogsParameters of the
PodLogscheck: container logs from the kubelet, at mostalertDiagnostics.logs.maxBytesPerCheckbytes per container.-
stringspec.checks.podLogs.containerContainer name, or exactly
{{= <CEL> }}over the factswhenreads, whose value must be a DNS-1123 label (otherwise the check endsInsufficientInputwith reasonParams). By default the failing container, otherwise the first one.Maximum length:
63 -
stringspec.checks.podLogs.grepRE2 regular expression the kept lines must match.
Maximum length:
128 -
objectspec.checks.podLogs.objectObject named explicitly for
subject: Explicit, in the namespace of the report.-
stringspec.checks.podLogs.object.kind
Required value
Kind of the object.Allowed values:
Pod -
stringspec.checks.podLogs.object.nameTemplate
Required value
Name of the object, exactly{{ .labels.<name> }}of an alert label, or exactly{{= <CEL> }}over the factswhenreads. The computed value must be a DNS-1123 subdomain; otherwise the check is not run and endsInsufficientInputwith reasonParams. The object is read in the namespace of the report.Maximum length:
256
-
-
booleanspec.checks.podLogs.previousRead the previous instance of the container.
-
stringspec.checks.podLogs.subject
Required value
Pods the check reads: the target pod (the representative pods for a workload target), the representative pods of the target, or the pod ofobject.Allowed values:
Target,RepresentativePods,Explicit -
integerspec.checks.podLogs.tailLinesNumber of last lines.
Allowed values:
1 <= X <= 200
-
-
objectspec.checks.scrapeTargetsParameters of the
ScrapeTargetscheck: label values a Prometheus scrape target must have to be read; an unset field matches any value. Targets are read with the permissions of the report, so a namespace report sees only its own targets. Each value is a label value or exactly{{= <CEL> }}; a computed value that is empty or over 256 bytes ends the checkInsufficientInputwith reasonParams.-
stringspec.checks.scrapeTargets.job
Required value
Value of the labeljobof the target.Length:
1..256 -
stringspec.checks.scrapeTargets.namespaceValue of the label
namespaceof the target.Maximum length:
256 -
stringspec.checks.scrapeTargets.podValue of the label
podof the target.Maximum length:
256
-
-
objectspec.checks.serviceBackendsParameters of the
ServiceBackendscheck: endpoints of a Service and the pods behind them. Without parameters, the Service of the target route, or for a Pod target the Services that select the pod.-
stringspec.checks.serviceBackends.serviceFromLabelAlert label that holds the Service name.
Maximum length:
63
-
-
stringspec.checks.titleName of the check for a reader of the report, in sentence case and 1 to 4 words, such as
CronJob of the Job:status.checks[].titleof its row. Plain text without a template. Without it the report names the check by its type and subject (Pod logs,Metrics: memory usage). A check of typeBaselinethat runs has no row of its own: the rows of its recipe are named by the controller.Length:
1..64 -
stringspec.checks.typeCheck type.
Allowed values:
Object,List,Events,PodLogs,PodExec,Metrics,ServiceBackends,ScrapeTargets,Baseline,NodeAgent -
stringspec.checks.whenCEL condition over
baseline.<id>,checks.<id>,values.baseline.<check>.<value>,alertandtarget; the check runs only when it is true, after the checks it reads. A false condition records the checkSkippedwith reasonConditionFalse(this does not make the collectionPartial); a condition that fails to evaluate records itInsufficientInputwith reasonParams.Length:
1..8192
-
-
stringspec.componentPlatform component the playbook diagnoses. Its causes are about this component and the components it covers, so their own failure during the alert does not withdraw such a cause. When a withdrawn cause blames an unready component, it names the report of a firing cluster alert whose playbook has this component. Adds no reads. Not allowed in an abstract playbook.
Allowed values:
kube-apiserver,etcd,kube-dns,node-local-dns,cni-agent,node,deckhouse,ingress-controller,prometheus,cert-manager,kruise-controller,grafana,prometheus-operator,extended-monitoring-exporter,prometheus-longterm,image-availability-exporter,trickster,kube-state-metrics,cluster-autoscaler,machine-controller-manager,bashible-apiserver,caps-controller-manager,cloud-data-discoverer,upmeter,terraform-state-exporter,snapshot-controller,dex,gatekeeper,documentation,stronghold,sds-local-volume,safe-agent-updater,node-exporter,upmeter-agent,log-shipper,cilium-operator,user-authn-controller,dexclient-controller,permission-browser-apiserver,user-authz-controller,user-authz-webhook,dop-tempo,dop-loki,registry-controller,registry-storage,registry-agent,dop-ceph,dop-flow-collector,dop-mimir,dop-alertgate,dop-assistant,dop-auth,dop-backend,dop-reconciler,dop-rsm-engine,dop-metrics-collector,dop-usage-collector,control-plane-manager,node-controller,multitenancy-manager,x509-certificate-exporter,caphc-controller-manager,capi-controller-manager -
stringspec.extendsName of a built-in abstract playbook whose checks and findings this playbook inherits; a playbook of the cluster cannot be a parent. A check or finding with the
idof one of the parent replaces it in place, the others follow.match,targetandbaselineare not inherited. At most 64 findings after the merge. A wrong parent setsValidFalsewith reasonExtendsNotFound,ExtendsNotAbstractorExtendsInvalid.Maximum length:
253Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ -
array of objectsspec.findingsFindings of the playbook.
-
array of stringsspec.findings.actionsWhat to do, Markdown templates.
-
stringspec.findings.actions.Element of the array
Maximum length:
4096
-
-
array of stringsspec.findings.causedByFindings this one follows from: IDs of findings of the same playbook or IDs of built-in findings of the controller (
baseline/<id>). In a report the finding names the causes that hold in the same run and comes after the findings that stand on their own.-
stringspec.findings.causedBy.Element of the array
Maximum length:
72Pattern:
^(baseline/)?[a-z0-9]([-a-z0-9]*[a-z0-9])?$
-
-
array of stringsspec.findings.evidenceAdditions to the checks the finding is based on,
baseline.<id>or<check id>: a check the finding cites without reading it, or one it reads that the report cites first. The checkswhenand the texts read are added after them. The finding is evaluated as soon as all of them are collected.-
stringspec.findings.evidence.Element of the array
Maximum length:
80
-
-
stringspec.findings.explanationMarkdown without HTML; template with
{{ .labels.<name> }}and{{= <CEL> }}.Maximum length:
16384 -
array of objectsspec.findings.factsThe values that prove the finding, which a reader sees next to it in this order: each a label and a value. A fact whose value renders empty is left out of the report, and so is one whose expression fails, which the condition
FindingsEvaluatedreports. The checks the values read are added to the evidence of the finding after those ofwhenand of the texts.-
booleanspec.findings.facts.highlightThe fact carries the problem itself, such as the text of an error, the reason of a refusal or the message of a component: the report keeps the mark in
facts[].highlight, and the console shows the fact first, above the other facts of the finding. At most 2 facts of a finding are marked. -
booleanspec.findings.facts.inPrimaryEvidenceThe fact only repeats what the primary evidence of the finding shows, such as the largest directory of a tree: the report keeps it and marks it
inPrimaryEvidence, and the console leaves it out where it draws that evidence. Set only on a fact of a finding withprimaryEvidence. -
stringspec.findings.facts.labelA short noun phrase a reader of a table understands without the title, such as
Memory limit. Plain text without a template.Length:
1..64 -
stringspec.findings.facts.valueThe value with its unit and nothing else, such as
512 MiB: a template with{{ .labels.<name> }},{{ .target.<field> }}and{{= <CEL> }}, as a title. It renders into one line cut to 256 bytes.Length:
1..1024
-
-
stringspec.findings.hypothesisPlatform hypothesis the finding confirms, in checking order:
Infrastructure(node, network, storage, API, registry),ClientSetting(a setting the user can change: aModuleConfigor module resource),Dependency(another platform component). Only on a target of classPlatform: the earliest step among the causes wins, later ones go tostatus.platformNotes. Default:ClientSettingforConfigurationCause, elseInfrastructure; none forSymptom.Allowed values:
Infrastructure,ClientSetting,Dependency -
stringspec.findings.idFinding ID, unique within the playbook. The report stores it as
<playbook>/<id>.Maximum length:
63Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ -
booleanspec.findings.platformIndependentMarks a cause read from the object itself, independent of the API server, DNS and the platform network (e.g. an OOM kill, the HTTP status of a probe). A basic component not ready before the alert does not withdraw it and is noted in
status.platformNotes. Only for roleCausewith severityWarningorCritical. A finding that replaces one of the parent sets its own value. -
stringspec.findings.primaryEvidenceThe check whose evidence proves the finding, which the console draws with it, such as the tree of a disk:
baseline.<id>or<check id>, as an entry ofevidence. It is among the evidence of the finding, an entry ofevidenceor a check its expressions read, else the playbook is invalid. The report gives its id infindings[].primaryEvidencewhen the run holds the check.Length:
1..80 -
array of objectsspec.findings.referencesUp to 3 links of the finding to a Deckhouse module, in this order. The console builds the URLs to the module settings and documentation; a playbook never gives a URL.
module,setting,resourceKind,resourceVersionandanchorare templates, as in a title. A reference whosemodulerenders empty, or whose expression fails, is dropped.-
stringspec.findings.references.anchor
ModuleDocsonly: the anchor on the page, as in the published documentation.Maximum length:
1024 -
stringspec.findings.references.kind
ModuleSetting: a key of the settings of the module (itsModuleConfig).ModuleResource: a kind of a resource of the module.ModuleDocs: a page of the documentation of the module.Allowed values:
ModuleSetting,ModuleResource,ModuleDocs -
stringspec.findings.references.moduleThe module by its name in
ModuleandModuleConfig, such asupmeteroringress-nginx;globalfor the globalModuleConfig, with the kindModuleSettingonly. A module without documentation (monitoring-deckhouse) is not named.Length:
1..1024 -
stringspec.findings.references.page
ModuleDocsonly: the page of the documentation of the module.Allowed values:
Overview,Configuration,Resources,Usage,FAQ,Examples -
stringspec.findings.references.resourceKind
ModuleResourceonly: the kind of a resource of the module, such asNodeGroup.Maximum length:
1024 -
stringspec.findings.references.resourceVersion
ModuleResourceonly: the version of the API of the resource, such asv1. Without it the controller takes the version of the object of the finding when it is of that kind, else the version it reads the kind with.Maximum length:
1024 -
stringspec.findings.references.setting
ModuleSettingonly: the dot-separated path of the key in the settings of the module, without array indexes, such assmokeMini.storageClass. Never a value.Maximum length:
1024
-
-
stringspec.findings.roleWhat the finding says about the cause of the alert:
Cause- a behaviour cause, turned into a symptom when a basic component on the path of the target was not ready during the alert;ConfigurationCause- a cause in configuration or object state, such as a ResourceQuota or NetworkPolicy, never withdrawn;Symptom- restates what the alert or object shows. A headline from a symptom starts withCause not established:.Default:
CauseAllowed values:
Cause,ConfigurationCause,Symptom -
stringspec.findings.severitySeverity.
Allowed values:
Info,Warning,Critical -
stringspec.findings.titleTitle template, one line. The rendered title is cut to 200 bytes.
Length:
1..1024 -
array of stringsspec.findings.unlessIDs of other findings of the playbook, after the merge with
extends: this finding is not written when any of them is written in the same evaluation for the same target or linked object. A named finding whose condition fails silences nothing. Use it for a fallback; for a consequence that holds together with its cause, usecausedBy.-
stringspec.findings.unless.Element of the array
Maximum length:
63Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
-
-
stringspec.findings.whenCEL expression over
baseline.<id>,checks.<id>,values.baseline.<check>.<value>andalert; the finding holds when it returns true. Required, except in a finding of a playbook withextendsthat replaces a finding of the parent by its id: withoutwhenit takes the condition of the finding it replaces, and nothing else of it.Length:
1..8192
-
-
array of objectsspec.letNamed CEL expressions, read as
let.<name>in the conditions and{{= <CEL> }}expressions of this playbook and of the playbooks that extend it, as if written in place. With the names replaced, an expression has at most 16384 characters. A name must not repeat a name of the parent inextends, and in a playbook that is not abstract every name must be read.-
stringspec.let.exprCEL expression over the variables of a finding (
baseline,checks,values,alert,target) that compiles on its own and reads nolet. The checks and the facts it reads are checked in each expression that reads it, against the target of that playbook.Length:
1..2048 -
stringspec.let.nameName the expressions read as
let.<name>; notin,true,falseornull, which CEL reads as words of its own.Maximum length:
32Pattern:
^[a-z][a-zA-Z0-9]*$
-
-
objectspec.matchAlerts the playbook applies to, and with
objectthe linked objects of a run.-
array of stringsspec.match.alertNamesNames of the alerts; may be omitted with
object, then the playbook never matches an alert by its name.-
stringspec.match.alertNames.Element of the array
Length:
1..253
-
-
objectspec.match.labelSelectorSelector over the alert labels.
-
array of objectsspec.match.labelSelector.matchExpressionsExpressions over labels; all of them must hold.
-
stringspec.match.labelSelector.matchExpressions.keyLabel name.
Maximum length:
63 -
stringspec.match.labelSelector.matchExpressions.operatorOperator.
Allowed values:
In,Exists,DoesNotExist -
array of stringsspec.match.labelSelector.matchExpressions.valuesValues for
In.-
stringspec.match.labelSelector.matchExpressions.values.Element of the array
Maximum length:
256
-
-
-
objectspec.match.labelSelector.matchLabelsLabels and their values.
-
-
objectspec.match.objectApplies the playbook also to a linked object of a run of kind
target.kindthat got the rest of its baseline, with the labelsnamespaceandtarget.nameFromLabelset to the object;{}matches any such object. Needstarget.nameFromLabel.-
objectspec.match.object.labelSelectorSelector over the labels of the object itself.
-
objectspec.match.object.labelSelector.matchLabelsLabels and their values.
-
-
array of integersspec.match.object.portsPorts, one of which must be the port of the address that led to the object or a port a container of its pods declares.
-
integerspec.match.object.ports.Element of the array
Allowed values:
1 <= X <= 65535
-
-
-
array of stringsspec.match.requiredLabelsAlert labels the target needs; an alert without one of them does not address the target, and the playbook does not take part in the run.
-
stringspec.match.requiredLabels.Element of the array
Maximum length:
63
-
-
stringspec.match.scope
Required value
Alerts to match:Namespaced-ObservabilityAlert;Cluster-ClusterObservabilityAlert;Any- both, for a rule whose alert changed scope between DKP versions. The report has the scope of the alert.Anyhas the limits ofNamespaced: the target is in the namespace of the alert (or its labelnamespace); notarget.namespace,target.namespaceFromLabel,target.selector, kindNodeor checks that needCluster.Allowed values:
Namespaced,Cluster,Any -
stringspec.match.targetClassClass of target the playbook applies to:
User- a user workload;Platform- a Deckhouse object (labelheritage: deckhouseon it or its namespace, ad8-*orkube-systemnamespace, aNode, a cluster resource of a Deckhouse API group);Any- either. A playbook of another class does not run, and conditionFindingsEvaluatednames it. Withobject, the class of the linked object counts.Default:
UserAllowed values:
User,Platform,Any
-
-
objectspec.targetHow the diagnosed object is found from the alert labels.
-
stringspec.target.apiVersion
Required value
API version of the object.Maximum length:
128 -
booleanspec.target.followBackendOnly with
kindIngress: also diagnose the backend (the Deployment, StatefulSet or DaemonSet behind the Service of the route): it is linked instatus.run.linkedwith relationBackend, its pods and logs are read, and its built-in causes, such asbackend-errors, become causes of theWarningandCriticalfindings. For alerts about backend answers: 5xx, latency, unavailable backends. -
stringspec.target.kind
Required value
Kind of the object.Allowed values:
Pod,Deployment,StatefulSet,DaemonSet,Job,CronJob,Service,Ingress,PersistentVolumeClaim,Node,DeckhouseRelease,ModuleRelease,NodeGroup,ModuleConfig,Certificate -
stringspec.target.nameFromLabelAlert label that holds the object name.
Maximum length:
63 -
stringspec.target.nameTemplateTemplate that builds the object name from alert labels.
Maximum length:
256 -
stringspec.target.namespaceNamespace of the object; only with
match.scopeCluster.Maximum length:
63 -
stringspec.target.namespaceFromLabelAlert label that holds the namespace of the object; only with
match.scopeCluster.Maximum length:
63 -
stringspec.target.secretNameFromLabelAlert label that holds a Secret name; only with
kindIngress. The target is the Ingress in the namespace of the alert whosespec.tls[].secretNameis that Secret: of several, the first by name whose hosts include the alert labelhost, else the first by name. All matches, up to 50, are listed in the baseline checkpeers. No match leaves the target unresolved. The Secret is never read.Maximum length:
63 -
objectspec.target.selectorSelects the object by labels in a fixed namespace; for
match.scopeClusterand kindsPod,Deployment,StatefulSet,DaemonSetonly. The pod on the node of the alert labelnodeis taken first; all matching objects, up to 50, are listed in the baseline checkpeers.-
objectspec.target.selector.matchLabelsLabels and their values.
-
-
-
-
objectstatusWritten by the controller.
-
array of objectsstatus.checkOrderOrder the checks of the valid playbook run in. A check that reads
checks.<id>inwhenor in a{{= }}parameter runs in a later stage than that check; the checks of one stage run together, in the order of the merged playbook. Absent for an invalid playbook and for one without checks.-
stringstatus.checkOrder.idCheck ID.
Maximum length:
63 -
integerstatus.checkOrder.stage1 for a check that reads no check of the playbook, otherwise one more than the latest stage of the checks it reads.
Allowed values:
1 <= X <= 40
-
-
array of objectsstatus.conditionsConditions.
-
stringstatus.conditions.lastTransitionTimeTime of the last change of the status.
-
stringstatus.conditions.messageMessage for a human.
Maximum length:
32768 -
integerstatus.conditions.observedGenerationGeneration the condition describes.
Allowed values:
0 <= X -
stringstatus.conditions.reasonMachine-readable reason.
Maximum length:
1024 -
stringstatus.conditions.statusStatus.
Allowed values:
True,False,Unknown -
stringstatus.conditions.typeType.
Maximum length:
316
-
-
objectstatus.extendsThe built-in playbook the playbook extends, as the controller merged them, and where each check and finding of the merged playbook comes from. Absent for a playbook that extends none or whose parent is not found, not abstract or invalid.
-
array of objectsstatus.extends.checksChecks of the merged playbook in their order.
-
stringstatus.extends.checks.idCheck ID.
Maximum length:
63 -
stringstatus.extends.checks.origin
Common: a check of the parent;Replaced: a check of the playbook with the id of a check of the parent, in its place;Own: a check of the playbook the parent does not have.Allowed values:
Common,Replaced,Own
-
-
array of objectsstatus.extends.findingsFindings of the merged playbook in their order.
-
stringstatus.extends.findings.idFinding ID.
Maximum length:
63 -
stringstatus.extends.findings.origin
Common: a finding of the parent;Replaced: a finding of the playbook with the id of a finding of the parent, in its place;Own: a finding of the playbook the parent does not have.Allowed values:
Common,Replaced,Own
-
-
stringstatus.extends.name
Required value
Name of the parent.Maximum length:
253 -
stringstatus.extends.specHash
Required value
sha256:<hex>of the spec of the parent the playbook was merged with; it changes when an update of the module changes the parent.Maximum length:
71
-
-
integerstatus.observedGenerationGeneration the conditions describe.
-
ClusterObservabilityDiagnosticReport
Short names: codr
Scope: Cluster
Version: v1alpha1
Experimental. Diagnostic report of a cluster alert (ClusterObservabilityAlert).
The controller creates the report when the alert fires: it finds the object of the alert, collects facts and evaluates the findings of the playbooks. A user with edit rights can create a report with only spec.alert.kind and spec.alert.name set to run the diagnostics manually, or request a new run of an existing report with the annotation observability.deckhouse.io/rerun.
Only the controller writes status.
-
objectspecDefines the report. Immutable once the controller filled the alert snapshot.
-
objectspec.alert
Required value
Reference to the alert object and the snapshot of the alert. A user creating a report sets onlykind,nameandnamespace; the controller fills the snapshot.-
stringspec.alert.alertNameName of the alert.
Maximum length:
253 -
objectspec.alert.annotationsAllowlisted annotations of the alert, each at most 1 KiB and at most 4 KiB together; the controller cuts a longer annotation and ends it with
[truncated]. -
stringspec.alert.createdByWho created the rule of the alert.
Maximum length:
253 -
stringspec.alert.fingerprintFingerprint of the alert.
Maximum length:
64 -
stringspec.alert.kind
Required value
Kind of the alert object.Allowed values:
ClusterObservabilityAlert -
objectspec.alert.labelsLabels of the alert, at most 2 KiB together with their names.
-
stringspec.alert.name
Required value
Name of the alert object.Length:
1..253 -
stringspec.alert.namespaceNamespace of the alert object; for
ObservabilityDiagnosticReportthe namespace of the report.Maximum length:
63 -
objectspec.alert.ruleRule context of the alert.
-
stringspec.alert.rule.descriptionDescription template of the rule when it differs from the annotation.
Maximum length:
2048 -
stringspec.alert.rule.exprExpression of the rule.
Maximum length:
2048 -
stringspec.alert.rule.for
forof the rule.Maximum length:
32 -
stringspec.alert.rule.keepFiringFor
keepFiringForof the rule.Maximum length:
32 -
stringspec.alert.rule.summarySummary template of the rule when it differs from the annotation.
Maximum length:
1024
-
-
stringspec.alert.ruleGroupNameRule group of the alert.
Maximum length:
253 -
stringspec.alert.severitySeverity level of the alert.
Maximum length:
16 -
stringspec.alert.startsAtTime the alert started firing.
-
-
-
objectstatusWritten by the controller only.
-
objectstatus.alertStateState of the alert.
-
stringstatus.alertState.lostAtWhen the report became
Lost: once the alert object has stayed missing for the grace of the controller (3 minutes by default) without resolving. -
stringstatus.alertState.resolvedAtWhen the alert resolved.
-
stringstatus.alertState.stateState.
Allowed values:
Firing,Resolved,Lost
-
-
array of objectsstatus.checksResults of the checks of the current run.
-
objectstatus.checks.coverageHow many objects of the population were checked in detail.
-
integerstatus.checks.coverage.checked
Required value
Checked in detail.Allowed values:
0 <= X -
integerstatus.checks.coverage.total
Required value
Population.Allowed values:
0 <= X
-
-
objectstatus.checks.evidenceAllowlisted projection of the read data; the shape depends on the check type.
-
stringstatus.checks.evidenceKindName of the schema of
evidence, one per shape (Events,PodLogs,Metrics,Deployment,WorkloadPods,Omittedwhen the budget of the run replaced the evidence). Absent on a row without evidence and in a report written before the field existed.Maximum length:
64Pattern:
^[A-Z][A-Za-z0-9]*$ -
booleanThe row is not listed to a reader - a repeat with
sameAs, or the snapshot of the rulebaseline/alert-context. -
stringstatus.checks.id
baseline/<check>,baseline/<kind>-<name>/<check>with several targets (baseline/<kind>-<namespace>-<name>/<check>when another target has its kind and name, with-<hash>after the name when two targets would share a prefix),baseline/<n>-<kind>-<name>/<check>of a linked object, or<playbook>/<check>.Maximum length:
320 -
objectstatus.checks.objectRefObject the check read.
-
stringstatus.checks.objectRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.checks.objectRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.checks.objectRef.name
Required value
Name.Maximum length:
253 -
stringstatus.checks.objectRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.checks.objectRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.checks.objectRef.uidUID.
Maximum length:
64
-
-
stringstatus.checks.observedAtTime the fact was read.
-
stringstatus.checks.originWho planned the check.
Allowed values:
Baseline,Playbook -
stringstatus.checks.outcomeOutcome. Anything other than
OkandProblemFoundmeans “unknown”, not “no problem”.Allowed values:
Ok,ProblemFound,NotFound,InsufficientInput,Forbidden,Timeout,Error,Skipped -
stringstatus.checks.reasonStable CamelCase reason of the outcome.
Maximum length:
63 -
stringstatus.checks.resultVerdict of the check:
Problem- found a deviation, even in a partial read;Ok- a check with its own verdict found nothing;Partial- no deviation, but only part was read or the evidence was cut;NoData- nothing to judge (outcomeInsufficientInput,NotFound,Skipped, or no metric sample in the window);Failed- no answer (outcomeError,Forbidden,Timeout);Context- data without a verdict. Absent in older reports.Allowed values:
Problem,Ok,Partial,NoData,Failed,Context -
stringstatus.checks.sameAsID of an earlier check of the run with the same canonical key; such a check stores no evidence.
Maximum length:
320 -
stringstatus.checks.summaryOne line for a human, in English.
Maximum length:
300 -
objectstatus.checks.targetRefTarget of the run (an entry of
status.run.targets) or linked object (an entry ofstatus.run.linked) the row belongs to. Absent on the rows of the run as a whole (baseline/alert-context,baseline/linked-alerts) and in a report written before the field existed.objectRefstays the object the check read.-
stringstatus.checks.targetRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.checks.targetRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.checks.targetRef.name
Required value
Name.Maximum length:
253 -
stringstatus.checks.targetRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.checks.targetRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.checks.targetRef.uidUID.
Maximum length:
64
-
-
stringstatus.checks.titleName of the check for a reader, in English, 1 to 4 words: of the table of the controller for a row of the baseline,
spec.checks[].titleof the playbook for a check of a playbook, else built from its type and subject. The controller writes it on every row; absent in a report written before the field existed.Maximum length:
64 -
booleanstatus.checks.truncatedEvidence was cut by the limits; the summary names what was removed.
-
stringstatus.checks.typeCheck type;
NodeAgentis a call of the node agent of the node of a Node target,ScrapeTargetsreads the Prometheus scrape targets through label-enforcer,Baselineis a check of a recipe of a playbook that did not run (its condition is false, a parameter failed or the object is linked), whose recipe wrote no row.Allowed values:
Object,Related,List,Events,PodLogs,PodExec,Metrics,RelatedAlerts,WorkloadContext,ServiceBackends,AlertContext,NodeAgent,ScrapeTargets,Baseline
-
-
objectstatus.collectionFact collection of the current run.
-
integerstatus.collection.checksDoneFinished checks.
Allowed values:
0 <= X -
integerstatus.collection.checksTotalPlanned checks.
Allowed values:
0 <= X -
stringstatus.collection.completedAtEnd.
-
stringstatus.collection.messageMessage for a human.
Maximum length:
1024 -
stringstatus.collection.phasePhase.
Allowed values:
Pending,Running,Completed,Partial,Failed -
stringstatus.collection.reasonReason of a failed collection.
Maximum length:
63 -
stringstatus.collection.startedAtStart.
-
-
array of objectsstatus.conditionsConditions.
-
stringstatus.conditions.lastTransitionTimeTime of the last change of the status.
-
stringstatus.conditions.messageMessage for a human.
Maximum length:
32768 -
integerstatus.conditions.observedGenerationGeneration the condition describes.
Allowed values:
0 <= X -
stringstatus.conditions.reasonMachine-readable reason.
Maximum length:
1024 -
stringstatus.conditions.statusStatus.
Allowed values:
True,False,Unknown -
stringstatus.conditions.typeType.
Maximum length:
316
-
-
objectstatus.environmentSnapshot of versions.
-
stringstatus.environment.dkpVersionDeckhouse version.
Maximum length:
64 -
stringstatus.environment.kubernetesVersionKubernetes version.
Maximum length:
64 -
array of objectsstatus.environment.modulesModules the playbooks name.
-
booleanstatus.environment.modules.enabledWhether the module is enabled.
-
stringstatus.environment.modules.nameName.
Maximum length:
63
-
-
stringstatus.environment.observabilityVersionVersion of the module.
Maximum length:
64
-
-
array of objectsstatus.findingsFindings of the current run.
-
array of stringsstatus.findings.actionsWhat to do, in Markdown.
-
stringstatus.findings.actions.Element of the array
Maximum length:
1024
-
-
array of stringsstatus.findings.causedByIDs of the findings of this run the finding follows from. Empty for a finding that stands on its own; such findings come first.
-
stringstatus.findings.causedBy.Element of the array
Maximum length:
128
-
-
stringstatus.findings.demotionWhy a behaviour cause was taken back: the sentence on the basic component that was not ready in the window of the alert.
status.summary.causeGaprepeats it when the finding gives the headline.Maximum length:
512 -
array of stringsstatus.findings.evidenceRefsIDs of the checks the finding is based on.
-
stringstatus.findings.evidenceRefs.Element of the array
Maximum length:
320
-
-
stringstatus.findings.explanationWhy, in Markdown.
Maximum length:
4096 -
array of objectsstatus.findings.factsThe values that prove a finding, in the order of its playbook, or of the file of the texts of the controller for a built-in finding: a fact whose value rendered empty, or whose expression failed, is not here. A built-in finding may carry facts too.
-
stringstatus.findings.facts.checkIdID of the first check the expressions of the value read that the run holds, in the form of
evidenceRefs:baseline/<check>with the prefix of the target or of the linked object, or<playbook>/<check>. Empty for a value that reads no check or none the run holds. For a fact of a built-in finding, the check its value was read from, else the firstevidenceRefsof the finding.Maximum length:
320 -
booleanstatus.findings.facts.highlightThe fact carries the problem itself, such as the text of an error, the reason of a refusal or the message of a component: its playbook, or the file of the texts of the controller for a built-in finding, marks it. A reader shows it first. At most 2 facts of a finding are marked; a fact whose value rendered empty is not here, with its mark.
-
booleanstatus.findings.facts.inPrimaryEvidenceThe fact only repeats what
primaryEvidenceof the finding shows, such as the largest directory of a tree: a reader that draws that evidence with the finding may leave the fact out. Set only when the finding hasprimaryEvidence. -
stringstatus.findings.facts.labelWhat the value is, as the playbook names it.
Maximum length:
64 -
stringstatus.findings.facts.valueThe value in one line.
Maximum length:
256
-
-
stringstatus.findings.id
<playbook>/<finding>,baseline/<finding>for a built-in finding of the controller, orbaseline/<n>-<kind>-<name>/<finding>for a built-in finding of a linked object.Maximum length:
128 -
objectstatus.findings.objectRefObject the finding is about: the target of its playbook run or of the prefix of its id (an entry of
status.run.targets), or the linked object of its playbook run or of its prefix (an entry ofstatus.run.linked). Absent on a built-in finding about no single object and in a report written before the field existed.-
stringstatus.findings.objectRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.findings.objectRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.findings.objectRef.name
Required value
Name.Maximum length:
253 -
stringstatus.findings.objectRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.findings.objectRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.findings.objectRef.uidUID.
Maximum length:
64
-
-
stringstatus.findings.primaryEvidenceID of the check whose evidence proves the finding, in the form of
evidenceRefs: theprimaryEvidenceof its playbook, set only when the run holds that check. The console draws that evidence with the finding. Absent for a built-in finding and when the playbook names none.Maximum length:
320 -
array of objectsstatus.findings.referencesUp to 3 links of the finding to a Deckhouse module, in the order of its playbook. The console builds the URL:
ModuleSetting- the module settings and the parameter in its documentation;ModuleResource- the resource in the module documentation;ModuleDocs- a documentation page. Never a URL or a setting value; a console that does not know akindskips it. Absent in older reports.-
stringstatus.findings.references.anchor
ModuleDocsonly: the anchor on the page, as in the published documentation.Maximum length:
128Pattern:
^[\p{L}\p{N}_][\p{L}\p{N}_.-]*$ -
stringstatus.findings.references.kindWhat the reference points to.
Allowed values:
ModuleSetting,ModuleResource,ModuleDocs -
stringstatus.findings.references.moduleThe module by its name in
ModuleandModuleConfig;globalfor the globalModuleConfig.Maximum length:
64Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ -
stringstatus.findings.references.page
ModuleDocsonly: the page of the documentation of the module.Allowed values:
Overview,Configuration,Resources,Usage,FAQ,Examples -
stringstatus.findings.references.resourceKind
ModuleResourceonly: the kind of a resource of the module.Maximum length:
63Pattern:
^[A-Z][A-Za-z0-9]*$ -
stringstatus.findings.references.resourceVersion
ModuleResourceonly: the version of the API of the resource, such asv1; absent when it is not known.Maximum length:
32Pattern:
^v\d+((alpha|beta)\d+)?$ -
stringstatus.findings.references.setting
ModuleSettingonly: the dot-separated path of the key in the settings of the module, without array indexes. Never a value.Maximum length:
256Pattern:
^[A-Za-z_][A-Za-z0-9_-]*(\.[A-Za-z_][A-Za-z0-9_-]*)*$
-
-
stringstatus.findings.roleWhat the finding says about the cause of the alert:
Cause,ConfigurationCauseorSymptomas set in the playbook (a withdrawn behaviour cause isSymptom);Factfor a built-in fact;ObjectProblemfor a would-be cause found by a fallback playbook: a problem of the object from the alert labels, not the cause of the alert.symptomistrueexactly forSymptom.Allowed values:
Cause,ConfigurationCause,Symptom,Fact,ObjectProblem -
stringstatus.findings.severitySeverity.
Allowed values:
Info,Warning,Critical -
booleanstatus.findings.symptomThe finding only restates what the alert or the object shows and does not establish the root cause by itself. The marker does not change
causedBy. -
stringstatus.findings.titleTitle, one line.
Maximum length:
200
-
-
array of objectsstatus.historyUp to five past runs.
-
stringstatus.history.completedAtEnd.
-
array of objectsstatus.history.findingsFindings.
-
array of stringsstatus.history.findings.evidenceRefsIDs of the checks.
-
stringstatus.history.findings.evidenceRefs.Element of the array
Maximum length:
320
-
-
stringstatus.history.findings.idFinding ID.
Maximum length:
128 -
stringstatus.history.findings.severitySeverity.
Allowed values:
Info,Warning,Critical -
stringstatus.history.findings.titleTitle.
Maximum length:
200
-
-
stringstatus.history.headlineHeadline.
Maximum length:
300 -
stringstatus.history.idRun ID.
Maximum length:
64 -
stringstatus.history.startedAtStart.
-
stringstatus.history.triggerTrigger.
Allowed values:
Alert,Manual
-
-
array of objectsstatus.platformNotesOne-line notes under the findings. For a target of class
Platform, first the findings of a later hypothesis step that were not taken as the cause, one per finding. Then the basic components on the path of a target that were not ready during the alert but did not withdraw a cause, because their failure began after the alert or at an unknown time; one per component and target.-
stringstatus.platformNotes.checkIdID of the
platform-statecheck the note was read from; for a note of a hypothesis, the first evidence of the finding.Maximum length:
320 -
stringstatus.platformNotes.componentName of the component; in a project report only the class of the failure. A note of a hypothesis names the module of the target, else the component of the playbook of the finding, else
platform.Maximum length:
63 -
stringstatus.platformNotes.messageOne sentence: what was not ready, the source it was read from, and that its failure started after the alert or that its start is not known. A project report names only the class of the failure. A note of a hypothesis gives the title of the finding and the title of the cause that comes first in the order of the hypotheses.
Maximum length:
512 -
stringstatus.platformNotes.reportName of the cluster report of the firing alert of the component; never in a project report.
Maximum length:
253 -
stringstatus.platformNotes.sinceThe earliest moment the source proves the component not ready; absent when none is proven.
-
-
stringstatus.rejectedRerunNonceLast rejected value of the annotation
observability.deckhouse.io/rerun.Maximum length:
256 -
objectstatus.runCurrent run.
-
integerstatus.run.attempt
Required value
Execution of the run; a new leader repeats an unfinished run with the next attempt, at most 3.Allowed values:
0 <= X -
stringstatus.run.id
Required value
Run ID.Maximum length:
64 -
array of objectsstatus.run.linkedObjects the run found from its targets, in the order they were found. The ids of the checks and built-in findings of such an object start with its
checkPrefix; their outcomes do not change the phase of the run.-
stringstatus.run.linked.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.linked.checkPrefixPrefix of the ids of its checks and built-in findings:
baseline/<n>-<kind>-<name>/,nis the order of the object, the name is cut to 40 characters.Maximum length:
320 -
stringstatus.run.linked.class
Platformfor an object of Deckhouse: the labelheritage: deckhouseon the object or on its namespace, a namespaced8-*orkube-system, aNode, or a cluster resource of an API group of Deckhouse;Userfor any other object. Written for a linked object that was read. Absent in a report written before the field existed.Allowed values:
Platform,User -
stringstatus.run.linked.kindKind.
Maximum length:
63 -
stringstatus.run.linked.moduleModule of Deckhouse of an object of class
Platform, the labelmoduleof the object. Absent for classUserand when neither names a module.Maximum length:
64 -
stringstatus.run.linked.moduleVersion
properties.versionof theModulenamed bymodule. Absent when theModulewas not found or could not be read, when the scope of the report does not read theModule(a project report whose classPlatformrests on the labels of the object alone), and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.linked.nameName.
Maximum length:
253 -
stringstatus.run.linked.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.linked.of
checkPrefixof the object it was found from:baseline/orbaseline/<kind>-<name>/of a target (baseline/<kind>-<namespace>-<name>/when another target has its kind and name, with-<hash>at the end when two targets would share a prefix), or of another linked object.Maximum length:
320 -
objectstatus.run.linked.parentRefObject it was found from, the target (an entry of
status.run.targets) or the linked object (an entry ofstatus.run.linked) whose prefix isof. Absent in a report written before the field existed.-
stringstatus.run.linked.parentRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.linked.parentRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.run.linked.parentRef.name
Required value
Name.Maximum length:
253 -
stringstatus.run.linked.parentRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.linked.parentRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.run.linked.parentRef.uidUID.
Maximum length:
64
-
-
stringstatus.run.linked.relation
Backend: the workload or the pod behind the Service an Ingress target routes to.Dependency: the object behind an address a log line connects to.Allowed values:
Backend,Dependency -
stringstatus.run.linked.stateCheckIdID in
status.checksof the row that holds the state of the object:<checkPrefix>target, written with the rows of the linked phase. The row is there also when the object was not found (itsoutcometells). Absent when the run wrote no such row (the time or the checks of the run ran out before the object was read) and in a report written before the field existed.Maximum length:
320 -
stringstatus.run.linked.stoppedByWhy the branch does not go on from the object; empty when it goes on.
Allowed values:
NoAddress,External,OutOfScope,Loop,MaxDepth,MaxObjects,TimeSlice,NotFound,MaxChecks,NotRead -
objectstatus.run.linked.viaWhat the object was found through.
-
stringstatus.run.linked.via.check
Required value
ID of the check of the object before it that named it.Maximum length:
320 -
stringstatus.run.linked.via.declaredInWhere the configuration names the address:
<container>: env <NAME>or<container>: args; the value is never stored.Maximum length:
384 -
stringstatus.run.linked.via.hostHost of the address of a log line, for a
Dependency.Maximum length:
253 -
stringstatus.run.linked.via.portPort of the address of a log line or of the configuration, for a
Dependency.Maximum length:
5 -
stringstatus.run.linked.via.serviceService whose pods the object runs.
Maximum length:
63 -
stringstatus.run.linked.via.source
Webhookfor aBackendfound through the configuration of a webhook;Configfor aDependencyfound by the configuration of a container (the literal values of its env, its command and args); omitted for one found by a log line.Allowed values:
Config,Webhook
-
-
-
stringstatus.run.ownerController pod that executes the run.
Maximum length:
253 -
array of objectsstatus.run.playbooksPlaybooks that took part in the run.
-
booleanstatus.run.playbooks.fallback
truefor a built-in playbook that ran on the object the labels of the alert name because no playbook names the alert; its findings describe that object, and a finding that would name a cause has the roleObjectProblem. Absent for a playbook of the alert and in a report written before the field existed. -
integerstatus.run.playbooks.generationGeneration.
Allowed values:
0 <= X -
stringstatus.run.playbooks.nameName.
Maximum length:
253 -
stringstatus.run.playbooks.sourceWhere the playbook comes from -
Builtin, the image of the controller withgeneration0, orCluster, a ClusterObservabilityDiagnosticPlaybook.Allowed values:
Builtin,Cluster
-
-
stringstatus.run.rerunNonceAccepted value of the annotation
observability.deckhouse.io/rerun.Maximum length:
256 -
stringstatus.run.startedAt
Required value
Start of the run. -
stringstatus.run.targetSourceWhere the targets come from -
Playbook, the target a playbook of the alert addresses, orAlertLabels, the object the labels of an alert that no playbook matches name, also when a playbook runs on it as a fallback. Empty for a run without a target.Allowed values:
Playbook,AlertLabels -
array of objectsstatus.run.targetsDiagnosed objects.
-
stringstatus.run.targets.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.targets.class
Platformfor a Deckhouse object (labelheritage: deckhouseon the object or its namespace, ad8-*orkube-systemnamespace, aNode, a cluster resource of a Deckhouse API group);Userotherwise. When the object cannot be read, its namespace decides. Absent in older reports.Allowed values:
Platform,User -
stringstatus.run.targets.kindKind.
Maximum length:
63 -
stringstatus.run.targets.moduleModule of Deckhouse of an object of class
Platform, the module of the component of its playbook, else the labelmoduleof the object, sanitized as the evidence is. Absent for classUser, when neither names a module, and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.targets.moduleVersion
properties.versionof theModulenamed bymodule. Absent when theModulewas not found or could not be read, when the scope of the report does not read theModule(a project report whose classPlatformrests on the labels of the object alone), and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.targets.nameName.
Maximum length:
253 -
stringstatus.run.targets.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.targets.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.run.targets.stateCheckIdID in
status.checksof the row with the state of the object:baseline/target, orbaseline/<kind>-<name>/targetwith several targets; present also when the object was not found (see itsoutcome). Absent until the row is written, when every playbook setsbaseline: None, and in older reports.Maximum length:
320 -
stringstatus.run.targets.uidUID.
Maximum length:
64
-
-
stringstatus.run.trigger
Required value
Alertfor an automatic run,Manualfor a report created by a user or a rerun.Allowed values:
Alert,Manual
-
-
objectstatus.summaryBlock for the UI.
-
booleanstatus.summary.busyA run is in progress.
-
booleanstatus.summary.causeEstablished
trueonly when the headline is a finding that names a cause: not a symptom, not a fact and not a problem of the object (ObjectProblem), andWarningorCriticalor of the roleConfigurationCause. -
stringstatus.summary.causeGapWith
causeEstablishedfalse, one sentence in English on what the report could not read or follow.Maximum length:
300 -
stringstatus.summary.currentActivityWhat the controller does or did, in English.
Maximum length:
200 -
integerstatus.summary.findingsCountNumber of findings.
Allowed values:
0 <= X -
stringstatus.summary.headlineTitle of the main finding: the most severe one without
causedBythat names a cause, else the most severe one withoutcausedBy, else the most severe one; never a built-in fact. Starts withCause not established:when it names no cause, e.g.Cause not established: no playbook matches the alert; with a fallback playbook,No playbook matches the alert:and the title of anObjectProblem. Empty while the report is collecting.Maximum length:
300 -
stringstatus.summary.headlineFindingIdID of the finding the headline comes from. Empty when no finding gives the headline.
Maximum length:
320 -
stringstatus.summary.headlineSource
Findingwhen a finding gives the headline; empty otherwise.Allowed values:
Finding -
objectstatus.summary.progressProgress of the collection.
-
integerstatus.summary.progress.checksDoneFinished checks.
Allowed values:
0 <= X -
integerstatus.summary.progress.checksTotalPlanned checks.
Allowed values:
0 <= X
-
-
stringstatus.summary.severityHighest severity of the findings.
Allowed values:
Info,Warning,Critical -
stringstatus.summary.state
Collectingwhile the run goes,Readywhen it is final,Failedwhen facts could not be collected. Derived fromcollection.phase.Allowed values:
Collecting,Ready,Failed -
stringstatus.summary.updatedAtTime of the last update.
-
-
ClusterObservabilityLogsRulesGroup
Short names: colrg
Scope: Cluster
Version: v1alpha1
Group of log-based recording rules of the cluster scope.
Rules are evaluated by the logs-ruler service, which makes LogQL queries to the log storage backend. The resulting series are exposed as regular Prometheus metrics.
To set up an alert based on the created recording rules, use the ClusterObservabilityMetricsRulesGroup resource.
Used for monitoring logs from kube-*, d8-*, and cluster-level components.
-
objectspecDesired state of a group of the log-based recording rules of the cluster scope.
-
stringspec.interval
Rule evaluation interval.
If not specified, the default value is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of log-based recording rules of the cluster scope.-
stringspec.rules.expr
LogQL expression to evaluate the recording rule.
The expression must explicitly select the intended log streams (for example, by
namespace,app, or other labels available in the query backend).The
namespacevalue is not injected automatically.Minimum length:
1 -
objectspec.rules.labels
Additional labels attached to the recorded metric series.
The following labels are reserved and can’t be set by the user:
scope_typecreated_byrule_group_name
-
stringspec.rules.record
Name of the recording rule.
Must comply with the Prometheus metric naming rules and be unique within the rule group.
Minimum length:
1Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityMetricsRulesGroup
Short names: comrg
Scope: Cluster
Version: v1alpha1
Group of cluster-wide alerting or recording rules for system namespaces.
This resource lets platform administrators manage monitoring rules and alerts
that apply to infrastructure and system namespaces (kube-*, d8-*, and an empty namespace).
-
objectspecDefines the desired state of the cluster rules group.
-
stringspec.interval
Group rule evaluation interval.
For example,
30s.If not specified, the default interval is used.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of cluster-wide alerting or recording rules.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.expr
PromQL expression to evaluate the rule.
Automatically scoped to infrastructure and system namespaces (
kube-*,d8-*, and an empty namespace). -
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusState of the cluster rules group.
-
array of objectsstatus.conditionsThe latest available observed state of the cluster rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTimeLast time a sync of the cluster rules group changed its PrometheusRule or its status. Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this cluster rules group.
-
ClusterObservabilityNotificationChannel
Scope: Cluster
Version: v1alpha1
Notification channel for cluster-level alerts.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by a ClusterObservabilityNotificationPolicy object.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfig
TLS settings of the HTTPS connection to the Zabbix API.
Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (
TLSAccept=cert) is mutual TLS:certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with key.
-
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for cert. Must be set together with cert.
-
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against
cabut do not match the certificate againstserverName.Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of objectsstatus.policiesList of notification policies that are using this channel across all namespaces.
-
stringstatus.policies.nameName of the notification policy.
-
stringstatus.policies.namespace
Namespace of the notification policy.
Empty string for ClusterObservabilityNotificationPolicy.
-
-
ClusterObservabilityNotificationPolicy
Scope: Cluster
Version: v1alpha1
Rules for sending notifications about cluster-level alerts.
Using the policy, the module selects cluster-level alerts by their labels and sends notifications about them to a ClusterObservabilityNotificationChannel.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
“Channel that receives the notifications.”-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object.Default:
ClusterObservabilityNotificationChannelAllowed values:
ClusterObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ClusterObservabilityNotificationSilence
Scope: Cluster
Version: v1alpha1
Temporary silence of notifications about cluster-level alerts.
During the silence, the module does not send notifications about cluster-level alerts if they match spec.selector.
-
objectspecSilence parameters.
-
stringspec.endsAt
Required value
Time when the silence ends. -
objectspec.selector
Required value
Selector of the alerts whose notifications are silenced.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
Notifications about an alert are silenced if the alert meets all of the conditions.
-
stringspec.selector.matchExpressions.keyAlert label name.
-
stringspec.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.selector.matchLabelsLabels and their values that an alert must have for its notifications to be silenced.
-
-
stringspec.startsAt
Required value
Time when the silence starts.
-
ClusterObservabilityPropagatedDashboard
Scope: Cluster
Version: v1alpha1
Dashboard displayed in the Deckhouse web UI at the cluster level and in all namespaces (projects).
To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface.metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ClusterObservabilityPropagatedMetricsRulesGroup
Short names: copmrg
Scope: Cluster
Version: v1alpha1
Cluster-wide group of alerting and recording rules propagated to all namespaces.
Resources with the heritage: deckhouse label are shipped with Deckhouse Platform and can be managed only by the deckhouse ServiceAccount.
-
objectspecPropagated rule group parameters.
-
stringspec.interval
Group rule evaluation interval.
For example,
30s.If not specified, the default interval is used.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules of the group.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.expr
PromQL expression to evaluate the rule.
Propagated rules aren’t restricted by namespaces.
-
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusState of the cluster rules group.
-
array of objectsstatus.conditionsThe latest available observed state of the propagated rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTime
Last time the propagated rules group was successfully synced, which changed its PrometheusRule or its status.
Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this propagated rules group.
-
ClusterObservabilityPropagatedNotificationChannel
Scope: Cluster
Version: v1alpha1
Notification channel available in all namespaces.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by ObservabilityNotificationPolicy objects in any namespace or by a ClusterObservabilityPropagatedNotificationPolicy object.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfigTLS settings of the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (
TLSAccept=cert) is mutual TLS:certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with
key. -
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for cert. Must be set together with
cert. -
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against ca but do not match the certificate against serverName.
Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of objectsstatus.policiesList of notification policies that are using this channel across all namespaces.
-
stringstatus.policies.nameName of the notification policy.
-
stringstatus.policies.namespace
Namespace of the notification policy.
Empty string for ClusterObservabilityPropagatedNotificationPolicy.
-
-
ClusterObservabilityPropagatedNotificationPolicy
Scope: Cluster
Version: v1alpha1
Rules for sending notifications about alerts that apply in every namespace.
Using the policy, the module selects alerts of each namespace by their labels and sends notifications about them to a ClusterObservabilityPropagatedNotificationChannel. In each namespace, the policy works the same way as an ObservabilityNotificationPolicy created in it.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
“Channel that receives the notifications.”-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object.Default:
ClusterObservabilityPropagatedNotificationChannelAllowed values:
ClusterObservabilityPropagatedNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ObservabilityDashboard
Scope: Namespaced
Version: v1alpha1
Dashboard of a single namespace in the Deckhouse web UI. The dashboard is displayed in the project of the namespace where the object is created. To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface. -metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ObservabilityDiagnosticReport
Short names: odr
Scope: Namespaced
Version: v1alpha1
Experimental. Diagnostic report of an alert of the namespace (ObservabilityAlert).
The controller creates the report when the alert fires: it finds the object of the alert, collects facts and evaluates the findings of the playbooks. A user with edit rights can create a report with only spec.alert.kind, spec.alert.name and spec.alert.namespace set to run the diagnostics manually, or request a new run of an existing report with the annotation observability.deckhouse.io/rerun.
Only the controller writes status.
-
objectspecDefines the report. Immutable once the controller filled the alert snapshot.
-
objectspec.alert
Required value
Reference to the alert object and the snapshot of the alert. A user creating a report sets onlykind,nameandnamespace; the controller fills the snapshot.-
stringspec.alert.alertNameName of the alert.
Maximum length:
253 -
objectspec.alert.annotationsAllowlisted annotations of the alert, each at most 1 KiB and at most 4 KiB together; the controller cuts a longer annotation and ends it with
[truncated]. -
stringspec.alert.createdByWho created the rule of the alert.
Maximum length:
253 -
stringspec.alert.fingerprintFingerprint of the alert.
Maximum length:
64 -
stringspec.alert.kind
Required value
Kind of the alert object.Allowed values:
ObservabilityAlert -
objectspec.alert.labelsLabels of the alert, at most 2 KiB together with their names.
-
stringspec.alert.name
Required value
Name of the alert object.Length:
1..253 -
stringspec.alert.namespace
Required value
Namespace of the alert object; forObservabilityDiagnosticReportthe namespace of the report.Maximum length:
63 -
objectspec.alert.ruleRule context of the alert.
-
stringspec.alert.rule.descriptionDescription template of the rule when it differs from the annotation.
Maximum length:
2048 -
stringspec.alert.rule.exprExpression of the rule.
Maximum length:
2048 -
stringspec.alert.rule.for
forof the rule.Maximum length:
32 -
stringspec.alert.rule.keepFiringFor
keepFiringForof the rule.Maximum length:
32 -
stringspec.alert.rule.summarySummary template of the rule when it differs from the annotation.
Maximum length:
1024
-
-
stringspec.alert.ruleGroupNameRule group of the alert.
Maximum length:
253 -
stringspec.alert.severitySeverity level of the alert.
Maximum length:
16 -
stringspec.alert.startsAtTime the alert started firing.
-
-
-
objectstatusWritten by the controller only.
-
objectstatus.alertStateState of the alert.
-
stringstatus.alertState.lostAtWhen the report became
Lost: once the alert object has stayed missing for the grace of the controller (3 minutes by default) without resolving. -
stringstatus.alertState.resolvedAtWhen the alert resolved.
-
stringstatus.alertState.stateState.
Allowed values:
Firing,Resolved,Lost
-
-
array of objectsstatus.checksResults of the checks of the current run.
-
objectstatus.checks.coverageHow many objects of the population were checked in detail.
-
integerstatus.checks.coverage.checked
Required value
Checked in detail.Allowed values:
0 <= X -
integerstatus.checks.coverage.total
Required value
Population.Allowed values:
0 <= X
-
-
objectstatus.checks.evidenceAllowlisted projection of the read data; the shape depends on the check type.
-
stringstatus.checks.evidenceKindName of the schema of
evidence, one per shape (Events,PodLogs,Metrics,Deployment,WorkloadPods,Omittedwhen the budget of the run replaced the evidence). Absent on a row without evidence and in a report written before the field existed.Maximum length:
64Pattern:
^[A-Z][A-Za-z0-9]*$ -
booleanThe row is not listed to a reader - a repeat with
sameAs, or the snapshot of the rulebaseline/alert-context. -
stringstatus.checks.id
baseline/<check>,baseline/<kind>-<name>/<check>with several targets (baseline/<kind>-<namespace>-<name>/<check>when another target has its kind and name, with-<hash>after the name when two targets would share a prefix),baseline/<n>-<kind>-<name>/<check>of a linked object, or<playbook>/<check>.Maximum length:
320 -
objectstatus.checks.objectRefObject the check read.
-
stringstatus.checks.objectRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.checks.objectRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.checks.objectRef.name
Required value
Name.Maximum length:
253 -
stringstatus.checks.objectRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.checks.objectRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.checks.objectRef.uidUID.
Maximum length:
64
-
-
stringstatus.checks.observedAtTime the fact was read.
-
stringstatus.checks.originWho planned the check.
Allowed values:
Baseline,Playbook -
stringstatus.checks.outcomeOutcome. Anything other than
OkandProblemFoundmeans “unknown”, not “no problem”.Allowed values:
Ok,ProblemFound,NotFound,InsufficientInput,Forbidden,Timeout,Error,Skipped -
stringstatus.checks.reasonStable CamelCase reason of the outcome.
Maximum length:
63 -
stringstatus.checks.resultVerdict of the check:
Problem- found a deviation, even in a partial read;Ok- a check with its own verdict found nothing;Partial- no deviation, but only part was read or the evidence was cut;NoData- nothing to judge (outcomeInsufficientInput,NotFound,Skipped, or no metric sample in the window);Failed- no answer (outcomeError,Forbidden,Timeout);Context- data without a verdict. Absent in older reports.Allowed values:
Problem,Ok,Partial,NoData,Failed,Context -
stringstatus.checks.sameAsID of an earlier check of the run with the same canonical key; such a check stores no evidence.
Maximum length:
320 -
stringstatus.checks.summaryOne line for a human, in English.
Maximum length:
300 -
objectstatus.checks.targetRefTarget of the run (an entry of
status.run.targets) or linked object (an entry ofstatus.run.linked) the row belongs to. Absent on the rows of the run as a whole (baseline/alert-context,baseline/linked-alerts) and in a report written before the field existed.objectRefstays the object the check read.-
stringstatus.checks.targetRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.checks.targetRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.checks.targetRef.name
Required value
Name.Maximum length:
253 -
stringstatus.checks.targetRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.checks.targetRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.checks.targetRef.uidUID.
Maximum length:
64
-
-
stringstatus.checks.titleName of the check for a reader, in English, 1 to 4 words: of the table of the controller for a row of the baseline,
spec.checks[].titleof the playbook for a check of a playbook, else built from its type and subject. The controller writes it on every row; absent in a report written before the field existed.Maximum length:
64 -
booleanstatus.checks.truncatedEvidence was cut by the limits; the summary names what was removed.
-
stringstatus.checks.typeCheck type;
NodeAgentis a call of the node agent of the node of a Node target,ScrapeTargetsreads the Prometheus scrape targets through label-enforcer,Baselineis a check of a recipe of a playbook that did not run (its condition is false, a parameter failed or the object is linked), whose recipe wrote no row.Allowed values:
Object,Related,List,Events,PodLogs,PodExec,Metrics,RelatedAlerts,WorkloadContext,ServiceBackends,AlertContext,NodeAgent,ScrapeTargets,Baseline
-
-
objectstatus.collectionFact collection of the current run.
-
integerstatus.collection.checksDoneFinished checks.
Allowed values:
0 <= X -
integerstatus.collection.checksTotalPlanned checks.
Allowed values:
0 <= X -
stringstatus.collection.completedAtEnd.
-
stringstatus.collection.messageMessage for a human.
Maximum length:
1024 -
stringstatus.collection.phasePhase.
Allowed values:
Pending,Running,Completed,Partial,Failed -
stringstatus.collection.reasonReason of a failed collection.
Maximum length:
63 -
stringstatus.collection.startedAtStart.
-
-
array of objectsstatus.conditionsConditions.
-
stringstatus.conditions.lastTransitionTimeTime of the last change of the status.
-
stringstatus.conditions.messageMessage for a human.
Maximum length:
32768 -
integerstatus.conditions.observedGenerationGeneration the condition describes.
Allowed values:
0 <= X -
stringstatus.conditions.reasonMachine-readable reason.
Maximum length:
1024 -
stringstatus.conditions.statusStatus.
Allowed values:
True,False,Unknown -
stringstatus.conditions.typeType.
Maximum length:
316
-
-
objectstatus.environmentSnapshot of versions.
-
stringstatus.environment.dkpVersionDeckhouse version.
Maximum length:
64 -
stringstatus.environment.kubernetesVersionKubernetes version.
Maximum length:
64 -
array of objectsstatus.environment.modulesModules the playbooks name.
-
booleanstatus.environment.modules.enabledWhether the module is enabled.
-
stringstatus.environment.modules.nameName.
Maximum length:
63
-
-
stringstatus.environment.observabilityVersionVersion of the module.
Maximum length:
64
-
-
array of objectsstatus.findingsFindings of the current run.
-
array of stringsstatus.findings.actionsWhat to do, in Markdown.
-
stringstatus.findings.actions.Element of the array
Maximum length:
1024
-
-
array of stringsstatus.findings.causedByIDs of the findings of this run the finding follows from. Empty for a finding that stands on its own; such findings come first.
-
stringstatus.findings.causedBy.Element of the array
Maximum length:
128
-
-
stringstatus.findings.demotionWhy a behaviour cause was taken back: the sentence on the basic component that was not ready in the window of the alert.
status.summary.causeGaprepeats it when the finding gives the headline.Maximum length:
512 -
array of stringsstatus.findings.evidenceRefsIDs of the checks the finding is based on.
-
stringstatus.findings.evidenceRefs.Element of the array
Maximum length:
320
-
-
stringstatus.findings.explanationWhy, in Markdown.
Maximum length:
4096 -
array of objectsstatus.findings.factsThe values that prove a finding, in the order of its playbook, or of the file of the texts of the controller for a built-in finding: a fact whose value rendered empty, or whose expression failed, is not here. A built-in finding may carry facts too.
-
stringstatus.findings.facts.checkIdID of the first check the expressions of the value read that the run holds, in the form of
evidenceRefs:baseline/<check>with the prefix of the target or of the linked object, or<playbook>/<check>. Empty for a value that reads no check or none the run holds. For a fact of a built-in finding, the check its value was read from, else the firstevidenceRefsof the finding.Maximum length:
320 -
booleanstatus.findings.facts.highlightThe fact carries the problem itself, such as the text of an error, the reason of a refusal or the message of a component: its playbook, or the file of the texts of the controller for a built-in finding, marks it. A reader shows it first. At most 2 facts of a finding are marked; a fact whose value rendered empty is not here, with its mark.
-
booleanstatus.findings.facts.inPrimaryEvidenceThe fact only repeats what
primaryEvidenceof the finding shows, such as the largest directory of a tree: a reader that draws that evidence with the finding may leave the fact out. Set only when the finding hasprimaryEvidence. -
stringstatus.findings.facts.labelWhat the value is, as the playbook names it.
Maximum length:
64 -
stringstatus.findings.facts.valueThe value in one line.
Maximum length:
256
-
-
stringstatus.findings.id
<playbook>/<finding>,baseline/<finding>for a built-in finding of the controller, orbaseline/<n>-<kind>-<name>/<finding>for a built-in finding of a linked object.Maximum length:
128 -
objectstatus.findings.objectRefObject the finding is about: the target of its playbook run or of the prefix of its id (an entry of
status.run.targets), or the linked object of its playbook run or of its prefix (an entry ofstatus.run.linked). Absent on a built-in finding about no single object and in a report written before the field existed.-
stringstatus.findings.objectRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.findings.objectRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.findings.objectRef.name
Required value
Name.Maximum length:
253 -
stringstatus.findings.objectRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.findings.objectRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.findings.objectRef.uidUID.
Maximum length:
64
-
-
stringstatus.findings.primaryEvidenceID of the check whose evidence proves the finding, in the form of
evidenceRefs: theprimaryEvidenceof its playbook, set only when the run holds that check. The console draws that evidence with the finding. Absent for a built-in finding and when the playbook names none.Maximum length:
320 -
array of objectsstatus.findings.referencesUp to 3 links of the finding to a Deckhouse module, in the order of its playbook. The console builds the URL:
ModuleSetting- the module settings and the parameter in its documentation;ModuleResource- the resource in the module documentation;ModuleDocs- a documentation page. Never a URL or a setting value; a console that does not know akindskips it. Absent in older reports.-
stringstatus.findings.references.anchor
ModuleDocsonly: the anchor on the page, as in the published documentation.Maximum length:
128Pattern:
^[\p{L}\p{N}_][\p{L}\p{N}_.-]*$ -
stringstatus.findings.references.kindWhat the reference points to.
Allowed values:
ModuleSetting,ModuleResource,ModuleDocs -
stringstatus.findings.references.moduleThe module by its name in
ModuleandModuleConfig;globalfor the globalModuleConfig.Maximum length:
64Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ -
stringstatus.findings.references.page
ModuleDocsonly: the page of the documentation of the module.Allowed values:
Overview,Configuration,Resources,Usage,FAQ,Examples -
stringstatus.findings.references.resourceKind
ModuleResourceonly: the kind of a resource of the module.Maximum length:
63Pattern:
^[A-Z][A-Za-z0-9]*$ -
stringstatus.findings.references.resourceVersion
ModuleResourceonly: the version of the API of the resource, such asv1; absent when it is not known.Maximum length:
32Pattern:
^v\d+((alpha|beta)\d+)?$ -
stringstatus.findings.references.setting
ModuleSettingonly: the dot-separated path of the key in the settings of the module, without array indexes. Never a value.Maximum length:
256Pattern:
^[A-Za-z_][A-Za-z0-9_-]*(\.[A-Za-z_][A-Za-z0-9_-]*)*$
-
-
stringstatus.findings.roleWhat the finding says about the cause of the alert:
Cause,ConfigurationCauseorSymptomas set in the playbook (a withdrawn behaviour cause isSymptom);Factfor a built-in fact;ObjectProblemfor a would-be cause found by a fallback playbook: a problem of the object from the alert labels, not the cause of the alert.symptomistrueexactly forSymptom.Allowed values:
Cause,ConfigurationCause,Symptom,Fact,ObjectProblem -
stringstatus.findings.severitySeverity.
Allowed values:
Info,Warning,Critical -
booleanstatus.findings.symptomThe finding only restates what the alert or the object shows and does not establish the root cause by itself. The marker does not change
causedBy. -
stringstatus.findings.titleTitle, one line.
Maximum length:
200
-
-
array of objectsstatus.historyUp to five past runs.
-
stringstatus.history.completedAtEnd.
-
array of objectsstatus.history.findingsFindings.
-
array of stringsstatus.history.findings.evidenceRefsIDs of the checks.
-
stringstatus.history.findings.evidenceRefs.Element of the array
Maximum length:
320
-
-
stringstatus.history.findings.idFinding ID.
Maximum length:
128 -
stringstatus.history.findings.severitySeverity.
Allowed values:
Info,Warning,Critical -
stringstatus.history.findings.titleTitle.
Maximum length:
200
-
-
stringstatus.history.headlineHeadline.
Maximum length:
300 -
stringstatus.history.idRun ID.
Maximum length:
64 -
stringstatus.history.startedAtStart.
-
stringstatus.history.triggerTrigger.
Allowed values:
Alert,Manual
-
-
array of objectsstatus.platformNotesOne-line notes under the findings. For a target of class
Platform, first the findings of a later hypothesis step that were not taken as the cause, one per finding. Then the basic components on the path of a target that were not ready during the alert but did not withdraw a cause, because their failure began after the alert or at an unknown time; one per component and target.-
stringstatus.platformNotes.checkIdID of the
platform-statecheck the note was read from; for a note of a hypothesis, the first evidence of the finding.Maximum length:
320 -
stringstatus.platformNotes.componentName of the component; in a project report only the class of the failure. A note of a hypothesis names the module of the target, else the component of the playbook of the finding, else
platform.Maximum length:
63 -
stringstatus.platformNotes.messageOne sentence: what was not ready, the source it was read from, and that its failure started after the alert or that its start is not known. A project report names only the class of the failure. A note of a hypothesis gives the title of the finding and the title of the cause that comes first in the order of the hypotheses.
Maximum length:
512 -
stringstatus.platformNotes.reportName of the cluster report of the firing alert of the component; never in a project report.
Maximum length:
253 -
stringstatus.platformNotes.sinceThe earliest moment the source proves the component not ready; absent when none is proven.
-
-
stringstatus.rejectedRerunNonceLast rejected value of the annotation
observability.deckhouse.io/rerun.Maximum length:
256 -
objectstatus.runCurrent run.
-
integerstatus.run.attempt
Required value
Execution of the run; a new leader repeats an unfinished run with the next attempt, at most 3.Allowed values:
0 <= X -
stringstatus.run.id
Required value
Run ID.Maximum length:
64 -
array of objectsstatus.run.linkedObjects the run found from its targets, in the order they were found. The ids of the checks and built-in findings of such an object start with its
checkPrefix; their outcomes do not change the phase of the run.-
stringstatus.run.linked.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.linked.checkPrefixPrefix of the ids of its checks and built-in findings:
baseline/<n>-<kind>-<name>/,nis the order of the object, the name is cut to 40 characters.Maximum length:
320 -
stringstatus.run.linked.class
Platformfor an object of Deckhouse: the labelheritage: deckhouseon the object or on its namespace, a namespaced8-*orkube-system, aNode, or a cluster resource of an API group of Deckhouse;Userfor any other object. Written for a linked object that was read. Absent in a report written before the field existed.Allowed values:
Platform,User -
stringstatus.run.linked.kindKind.
Maximum length:
63 -
stringstatus.run.linked.moduleModule of Deckhouse of an object of class
Platform, the labelmoduleof the object. Absent for classUserand when neither names a module.Maximum length:
64 -
stringstatus.run.linked.moduleVersion
properties.versionof theModulenamed bymodule. Absent when theModulewas not found or could not be read, when the scope of the report does not read theModule(a project report whose classPlatformrests on the labels of the object alone), and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.linked.nameName.
Maximum length:
253 -
stringstatus.run.linked.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.linked.of
checkPrefixof the object it was found from:baseline/orbaseline/<kind>-<name>/of a target (baseline/<kind>-<namespace>-<name>/when another target has its kind and name, with-<hash>at the end when two targets would share a prefix), or of another linked object.Maximum length:
320 -
objectstatus.run.linked.parentRefObject it was found from, the target (an entry of
status.run.targets) or the linked object (an entry ofstatus.run.linked) whose prefix isof. Absent in a report written before the field existed.-
stringstatus.run.linked.parentRef.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.linked.parentRef.kind
Required value
Kind.Maximum length:
63 -
stringstatus.run.linked.parentRef.name
Required value
Name.Maximum length:
253 -
stringstatus.run.linked.parentRef.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.linked.parentRef.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.run.linked.parentRef.uidUID.
Maximum length:
64
-
-
stringstatus.run.linked.relation
Backend: the workload or the pod behind the Service an Ingress target routes to.Dependency: the object behind an address a log line connects to.Allowed values:
Backend,Dependency -
stringstatus.run.linked.stateCheckIdID in
status.checksof the row that holds the state of the object:<checkPrefix>target, written with the rows of the linked phase. The row is there also when the object was not found (itsoutcometells). Absent when the run wrote no such row (the time or the checks of the run ran out before the object was read) and in a report written before the field existed.Maximum length:
320 -
stringstatus.run.linked.stoppedByWhy the branch does not go on from the object; empty when it goes on.
Allowed values:
NoAddress,External,OutOfScope,Loop,MaxDepth,MaxObjects,TimeSlice,NotFound,MaxChecks,NotRead -
objectstatus.run.linked.viaWhat the object was found through.
-
stringstatus.run.linked.via.check
Required value
ID of the check of the object before it that named it.Maximum length:
320 -
stringstatus.run.linked.via.declaredInWhere the configuration names the address:
<container>: env <NAME>or<container>: args; the value is never stored.Maximum length:
384 -
stringstatus.run.linked.via.hostHost of the address of a log line, for a
Dependency.Maximum length:
253 -
stringstatus.run.linked.via.portPort of the address of a log line or of the configuration, for a
Dependency.Maximum length:
5 -
stringstatus.run.linked.via.serviceService whose pods the object runs.
Maximum length:
63 -
stringstatus.run.linked.via.source
Webhookfor aBackendfound through the configuration of a webhook;Configfor aDependencyfound by the configuration of a container (the literal values of its env, its command and args); omitted for one found by a log line.Allowed values:
Config,Webhook
-
-
-
stringstatus.run.ownerController pod that executes the run.
Maximum length:
253 -
array of objectsstatus.run.playbooksPlaybooks that took part in the run.
-
booleanstatus.run.playbooks.fallback
truefor a built-in playbook that ran on the object the labels of the alert name because no playbook names the alert; its findings describe that object, and a finding that would name a cause has the roleObjectProblem. Absent for a playbook of the alert and in a report written before the field existed. -
integerstatus.run.playbooks.generationGeneration.
Allowed values:
0 <= X -
stringstatus.run.playbooks.nameName.
Maximum length:
253 -
stringstatus.run.playbooks.sourceWhere the playbook comes from -
Builtin, the image of the controller withgeneration0, orCluster, a ClusterObservabilityDiagnosticPlaybook.Allowed values:
Builtin,Cluster
-
-
stringstatus.run.rerunNonceAccepted value of the annotation
observability.deckhouse.io/rerun.Maximum length:
256 -
stringstatus.run.startedAt
Required value
Start of the run. -
stringstatus.run.targetSourceWhere the targets come from -
Playbook, the target a playbook of the alert addresses, orAlertLabels, the object the labels of an alert that no playbook matches name, also when a playbook runs on it as a fallback. Empty for a run without a target.Allowed values:
Playbook,AlertLabels -
array of objectsstatus.run.targetsDiagnosed objects.
-
stringstatus.run.targets.apiVersionAPI version.
Maximum length:
128 -
stringstatus.run.targets.class
Platformfor a Deckhouse object (labelheritage: deckhouseon the object or its namespace, ad8-*orkube-systemnamespace, aNode, a cluster resource of a Deckhouse API group);Userotherwise. When the object cannot be read, its namespace decides. Absent in older reports.Allowed values:
Platform,User -
stringstatus.run.targets.kindKind.
Maximum length:
63 -
stringstatus.run.targets.moduleModule of Deckhouse of an object of class
Platform, the module of the component of its playbook, else the labelmoduleof the object, sanitized as the evidence is. Absent for classUser, when neither names a module, and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.targets.moduleVersion
properties.versionof theModulenamed bymodule. Absent when theModulewas not found or could not be read, when the scope of the report does not read theModule(a project report whose classPlatformrests on the labels of the object alone), and when the value is longer than 64 characters.Maximum length:
64 -
stringstatus.run.targets.nameName.
Maximum length:
253 -
stringstatus.run.targets.namespaceNamespace.
Maximum length:
63 -
stringstatus.run.targets.resourceVersionResource version at the time of reading.
Maximum length:
64 -
stringstatus.run.targets.stateCheckIdID in
status.checksof the row with the state of the object:baseline/target, orbaseline/<kind>-<name>/targetwith several targets; present also when the object was not found (see itsoutcome). Absent until the row is written, when every playbook setsbaseline: None, and in older reports.Maximum length:
320 -
stringstatus.run.targets.uidUID.
Maximum length:
64
-
-
stringstatus.run.trigger
Required value
Alertfor an automatic run,Manualfor a report created by a user or a rerun.Allowed values:
Alert,Manual
-
-
objectstatus.summaryBlock for the UI.
-
booleanstatus.summary.busyA run is in progress.
-
booleanstatus.summary.causeEstablished
trueonly when the headline is a finding that names a cause: not a symptom, not a fact and not a problem of the object (ObjectProblem), andWarningorCriticalor of the roleConfigurationCause. -
stringstatus.summary.causeGapWith
causeEstablishedfalse, one sentence in English on what the report could not read or follow.Maximum length:
300 -
stringstatus.summary.currentActivityWhat the controller does or did, in English.
Maximum length:
200 -
integerstatus.summary.findingsCountNumber of findings.
Allowed values:
0 <= X -
stringstatus.summary.headlineTitle of the main finding: the most severe one without
causedBythat names a cause, else the most severe one withoutcausedBy, else the most severe one; never a built-in fact. Starts withCause not established:when it names no cause, e.g.Cause not established: no playbook matches the alert; with a fallback playbook,No playbook matches the alert:and the title of anObjectProblem. Empty while the report is collecting.Maximum length:
300 -
stringstatus.summary.headlineFindingIdID of the finding the headline comes from. Empty when no finding gives the headline.
Maximum length:
320 -
stringstatus.summary.headlineSource
Findingwhen a finding gives the headline; empty otherwise.Allowed values:
Finding -
objectstatus.summary.progressProgress of the collection.
-
integerstatus.summary.progress.checksDoneFinished checks.
Allowed values:
0 <= X -
integerstatus.summary.progress.checksTotalPlanned checks.
Allowed values:
0 <= X
-
-
stringstatus.summary.severityHighest severity of the findings.
Allowed values:
Info,Warning,Critical -
stringstatus.summary.state
Collectingwhile the run goes,Readywhen it is final,Failedwhen facts could not be collected. Derived fromcollection.phase.Allowed values:
Collecting,Ready,Failed -
stringstatus.summary.updatedAtTime of the last update.
-
-
ObservabilityLogsRulesGroup
Short names: olrg
Scope: Namespaced
Version: v1alpha1
Group of log-based recording rules of the namespace scope.
Rules are evaluated by the logs-ruler service, which makes LogQL queries to the log storage backend. The resulting series are exposed as regular Prometheus metrics.
To set up an alert based on the created recording rules, use the ObservabilityMetricsRulesGroup resource.
LogQL expressions are evaluated for logs of a namespace where the resource is created.
-
objectspecParameters of a group of the log-based recording rules.
-
stringspec.interval
Rule evaluation interval.
For example,
30sor1m.If not specified, the default value is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of log-based recording rules.-
stringspec.rules.expr
LogQL expression to evaluate the recording rule.
Do not use the
namespacelabel in the expression. The module adds it automatically based on the resource namespace.Minimum length:
1 -
objectspec.rules.labels
Additional labels attached to the recorded metric series.
The following labels are reserved and can’t be set by the user:
namespacescope_typecreated_byrule_group_name
-
stringspec.rules.record
Name of the recording rule.
Must comply with the Prometheus metric naming rules and be unique within the rule group.
Minimum length:
1Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ObservabilityMetricsRulesGroup
Short names: omrg
Scope: Namespaced
Version: v1alpha1
-
objectspecRule group parameters.
-
stringspec.interval
Group rule evaluation interval.
If not specified, the default interval is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules of the group.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.exprPromQL expression to evaluate the rule.
-
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusRule group state.
-
array of objectsstatus.conditionsThe latest available observed state of the rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTime
Last time the rules group was successfully synced, which changed its PrometheusRule or its status.
Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this rules group.
-
ObservabilityNotificationChannel
Scope: Namespaced
Version: v1alpha1
Notification channel for the alerts of one namespace.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by an ObservabilityNotificationPolicy object in the same namespace.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfigTLS settings for the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (TLSAccept=cert) is mutual TLS:
certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with
key. -
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against
cabut do not match the certificate against serverName.Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of stringsstatus.policiesList of ObservabilityNotificationPolicy objects using this channel.
-
stringstatus.policies.Element of the arrayName of the notification policy.
-
-
ObservabilityNotificationPolicy
Scope: Namespaced
Version: v1alpha1
Rules for sending notifications about the alerts of one namespace.
Using the policy, the module selects alerts of the namespace where the object is created by their labels and sends notifications about them to an ObservabilityNotificationChannel from the same namespace or to a ClusterObservabilityPropagatedNotificationChannel.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
Channel that receives the notifications.-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object:
ObservabilityNotificationChannel: A channel from the namespace of the policy.ClusterObservabilityPropagatedNotificationChannel: A channel available in all namespaces.
Default:
ObservabilityNotificationChannelAllowed values:
ClusterObservabilityPropagatedNotificationChannel,ObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ObservabilityNotificationSilence
Scope: Namespaced
Version: v1alpha1
Temporary silence of notifications about the alerts of one namespace.
During the silence, the module does not send notifications about the alerts of the namespace where the object is created if they match spec.selector.
-
objectspecSilence parameters.
-
stringspec.endsAt
Required value
Time when the silence ends. -
objectspec.selector
Required value
Selector of the alerts whose notifications are silenced.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
Notifications about an alert are silenced if the alert meets all of the conditions.
-
stringspec.selector.matchExpressions.keyAlert label name.
-
stringspec.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.selector.matchLabelsLabels and their values that an alert must have for its notifications to be silenced.
-
-
stringspec.startsAt
Required value
Time when the silence starts.
-