Disk Alert Pattern Rule Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/prometheus/$defs/diskAlerts/properties/patternRule
Configure disk alerts when disk usage is predicted to reach the limit.
The hours key is only supported when configured under predictLinear.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Disk Alert Pattern Rule)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| hours | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| freeSpacePercentage | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| for | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| severity | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| pattern | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
hours¶
hours
-
is optional
-
Type:
number(Alert Rule Prediction Window) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (Alert Rule Prediction Window)
DEFAULTS:
The default value is:
24
freeSpacePercentage¶
Percentage, 0% - 100%
freeSpacePercentage
-
is optional
-
Type:
number(Percentage) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (Percentage)
CONSTRAINTS:
maximum: the value of this number must smaller than or equal to: 100
minimum: the value of this number must greater than or equal to: 0
DEFAULTS:
The default value is:
5
for¶
An amount of time
for
-
is optional
-
Type:
string(Time Range) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Time Range)
CONSTRAINTS:
pattern: the string must match the following regular expression:
^[0-9]+[hmsd]+$
DEFAULTS:
The default value is:
"1h"
EXAMPLES:
300s
72h
3d
severity¶
severity
-
is optional
-
Type:
string(Alert Rule Severity) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Alert Rule Severity)
DEFAULTS:
The default value is:
"warning"
pattern¶
Select applicable nodes and disks to include or exclude using patterns.
pattern
-
is optional
-
Type:
object(Disk Alert Patterns) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Disk Alert Patterns)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main