Kured Config 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/configuration
Kured configuration parameters.
See the upstream documentation for reference.
Most parameters are mapped from camelCase to --kebab-case, others can be set via extraArgs.
| 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 (Kured Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| drainTimeout | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| timeZone | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| startTime | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| endTime | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| rebootDays | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| period | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| lockReleaseDelay | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
drainTimeout¶
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".
drainTimeout
-
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:
"0"
EXAMPLES:
2h45m0s
timeZone¶
timeZone
-
is optional
-
Type:
string(Kured Schedule Time Zone) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Kured Schedule Time Zone)
DEFAULTS:
The default value is:
"UTC"
startTime¶
Schedule reboots only after this time of day.
startTime
-
is optional
-
Type:
string(Kured Schedule Start Time) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Kured Schedule Start Time)
DEFAULTS:
The default value is:
"0:00"
endTime¶
Schedule reboots only before this time of day.
endTime
-
is optional
-
Type:
string(Kured Schedule End Time) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Kured Schedule End Time)
DEFAULTS:
The default value is:
"23:59:59"
rebootDays¶
Only reboot on these days.
rebootDays
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[]
DEFAULTS:
The default value is:
[
"mo",
"tu",
"we",
"th",
"fr",
"sa",
"su"
]
period¶
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".
period
-
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:
"1h"
EXAMPLES:
2h45m0s
lockReleaseDelay¶
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".
lockReleaseDelay
-
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:
"5m"
EXAMPLES:
2h45m0s
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main