Toleration 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#/$defs/io.k8s.api.core.v1.Toleration
The pod this Toleration is attached to tolerates any taint that matches the triple \
| 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 (Toleration)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| effect | string |
Optional | cannot be null | Welkin Apps Config |
| key | string |
Optional | cannot be null | Welkin Apps Config |
| operator | string |
Optional | cannot be null | Welkin Apps Config |
| tolerationSeconds | integer |
Optional | cannot be null | Welkin Apps Config |
| value | string |
Optional | cannot be null | Welkin Apps Config |
effect¶
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
effect
-
is optional
-
Type:
string -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
key¶
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
key
-
is optional
-
Type:
string -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
operator¶
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
operator
-
is optional
-
Type:
string -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
tolerationSeconds¶
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
tolerationSeconds
-
is optional
-
Type:
integer -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
integer
CONSTRAINTS:
unknown format: the value of this string must follow the format: int64
value¶
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
value
-
is optional
-
Type:
string -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
Return to the root config schema
Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main