Kured Metrics 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/kured/properties/metrics
Configuration for Kured metrics
| 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 (Kured Metrics)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| interval | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| labels | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(Kured Metrics Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Kured Metrics Enabled)
DEFAULTS:
The default value is:
true
interval¶
A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
interval
-
is optional
-
Type:
string(Duration String) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Duration String)
CONSTRAINTS:
pattern: the string must match the following regular expression:
^([-+]?[0-9]+(.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
DEFAULTS:
The default value is:
"60s"
EXAMPLES:
2h45m0s
labels¶
labels
-
is optional
-
Type:
object(Kured Metrics Labels) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Kured Metrics Labels)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main