Capacity Management Alerts 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/capacityManagementAlerts
Definitions for capacity management alerts.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/config.yaml* |
TYPE:
object (Capacity Management Alerts)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| persistentVolume | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| persistentVolumeEnabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| persistentVolumeLimit | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| disklimit | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| requestlimit | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| requestlimitList | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| requestlimitTerm | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
persistentVolume¶
Configure capacity management alerts on persistent volumes.
persistentVolume
-
is optional
-
Type:
object(Capacity Management Alerts Persistent Volumes) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Capacity Management Alerts Persistent Volumes)
persistentVolumeEnabled¶
persistentVolumeEnabled
-
is optional
-
Type:
boolean(Capacity Management Alerts Persistent Volumes Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Capacity Management Alerts Persistent Volumes Enabled)
DEFAULTS:
The default value is:
true
persistentVolumeLimit¶
Alert when a persistent volume's usage reaches the limit in percent.
persistentVolumeLimit
-
is optional
-
Type:
number(Capacity Management Alerts Persistent Volumes Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (Capacity Management Alerts Persistent Volumes Enabled)
DEFAULTS:
The default value is:
75
disklimit¶
Alert when a disk's usage reaches the limit in percent.
disklimit
-
is optional
-
Type:
number(Capacity Management Alerts Disk Limit) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (Capacity Management Alerts Disk Limit)
DEFAULTS:
The default value is:
75
requestlimit¶
Alert when a node's resource requests reaches the limits in percent.
requestlimit
-
is optional
-
Type:
object(Capacity Management Alerts Request Limit) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Capacity Management Alerts Request Limit)
requestlimitList¶
Configure a list of node patterns and request limits to alert for.
requestlimitList
-
is optional
-
Type:
object[](Capacity Management Alerts Request Limit Term) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object[] (Capacity Management Alerts Request Limit Term)
requestlimitTerm¶
Configure a node pattern and the request limit to alert for.
requestlimitTerm
-
is optional
-
Type:
object(Capacity Management Alerts Request Limit Term) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Capacity Management Alerts Request Limit Term)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main