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/v0.41.0/config/schemas/config.yaml#/properties/prometheus/properties/capacityManagementAlerts
Configure 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 |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| predictUsage | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| persistentVolume | object |
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 |
| usagelimit | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| Additional Properties | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(Capacity Management Alerts Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Capacity Management Alerts Enabled)
DEFAULTS:
The default value is:
true
predictUsage¶
predictUsage
-
is optional
-
Type:
boolean(Capacity Management Alerts Predict Usage) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Capacity Management Alerts Predict Usage)
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)
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)
usagelimit¶
usagelimit
-
is optional
-
Type:
number -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number
DEFAULTS:
The default value is:
95
PROPERTIES:
Additional properties are allowed, as long as they follow this schema:
-
is optional
-
Type:
number -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number
Return to the root config schema
Generated Thu Nov 14 16:21:55 UTC 2024 from elastisys/compliantkubernetes-apps@v0.41.0