Kured Config Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/kured

Configuration for Kured (Kubernetes Reboot Daemon).

Kured orchestrates node reboots to allow nodes to automatically perform system updates and patches.

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 Config)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Welkin Apps Config
configuration	`object`	Optional	cannot be null	Welkin Apps Config
extraArgs	`array`	Optional	cannot be null	Welkin Apps Config
extraEnvVars	`object`	Optional	cannot be null	Welkin Apps Config
metrics	`object`	Optional	cannot be null	Welkin Apps Config
notification	`object`	Optional	cannot be null	Welkin Apps Config
dsAnnotations	`object`	Optional	cannot be null	Welkin Apps Config
resources	`object`	Optional	cannot be null	Welkin Apps Config
tolerations	`array`	Optional	cannot be null	Welkin Apps Config
nodeSelector	`object`	Optional	cannot be null	Welkin Apps Config
affinity	`object`	Optional	cannot be null	Welkin Apps Config

enabled¶

enabled

is optional
Type: boolean (Kured Enabled)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (Kured Enabled)

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.

configuration

is optional
Type: object (Kured Config)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kured Config)

extraArgs¶

Extra arguments passed to a container

extraArgs

is optional
Type: string[]
cannot be null
defined in: Welkin Apps Config

TYPE:

string[]

extraEnvVars¶

extraEnvVars

is optional
Type: object (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Details)

metrics¶

Configuration for Kured metrics

metrics

is optional
Type: object (Kured Metrics)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kured Metrics)

notification¶

Send notification from Kured when nodes are rebooted.

notification

is optional
Type: object (Kured Notification)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kured Notification)

dsAnnotations¶

dsAnnotations

is optional
Type: object (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Details)

resources¶

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

resources

is optional
Type: object (Kubernetes Resource Requirements)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

tolerations¶

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

an array of merged types (Details)

nodeSelector¶

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

is optional
Type: object (Kubernetes Node Selector)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

is optional
Type: object (Affinity)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Affinity)

Return to the root config schema

Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main