Jump to navigation ↓

DeviceTaintRule resource.k8s.io/v1alpha3

Other versions: v1beta2

DeviceTaintRule adds one taint to all devices which match the selector. This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.

Fields

apiVersion: resource.k8s.io/v1alpha3
kind: DeviceTaintRule
metadata (ObjectMeta)

Standard object metadata

spec (DeviceTaintRuleSpec)

Spec specifies the selector and one taint.

Changing the spec automatically increments the metadata.generation number.

status (DeviceTaintRuleStatus)

Status provides information about what was requested in the spec.

DeviceTaintRuleSpec

DeviceTaintRuleSpec specifies the selector and one taint.

taint (DeviceTaint)

The taint that gets applied to matching devices.

deviceSelector (DeviceTaintSelector)

DeviceSelector defines which device(s) the taint is applied to. All selector criteria must be satisfied for a device to match. The empty selector matches all devices. Without a selector, no devices are matches.

DeviceTaintSelector defines which device(s) a DeviceTaintRule applies to. The empty selector matches all devices. Without a selector, no devices are matched.

deviceSelector.device (string)

If device is set, only devices with that name are selected. This field corresponds to slice.spec.devices[].name.

Setting also driver and pool may be required to avoid ambiguity, but is not required.

deviceSelector.driver (string)

If driver is set, only devices from that driver are selected. This fields corresponds to slice.spec.driver.

deviceSelector.pool (string)

If pool is set, only devices in that pool are selected.

Also setting the driver name may be useful to avoid ambiguity when different drivers use the same pool name, but this is not required because selecting pools from different drivers may also be useful, for example when drivers with node-local devices use the node name as their pool name.

DeviceTaint

The device this taint is attached to has the "effect" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.

effect (string)

The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them.

Valid effects are None, NoSchedule and NoExecute. PreferNoSchedule as used for nodes is not valid here. More effects may get added in the future. Consumers must treat unknown effects like None.

key (string)

The taint key to be applied to a device. Must be a label name.

timeAdded (Time)

TimeAdded represents the time at which the taint was added or (only in a DeviceTaintRule) the effect was modified. Added automatically during create or update if not set.

In addition, in a DeviceTaintRule a value provided during an update gets replaced with the current time if the provided value is the same as the old one and the new effect is different. Changing the key and/or value while keeping the effect unchanged is possible and does not update the time stamp because the eviction which uses it is either already started (NoExecute) or not started yet (NoEffect, NoSchedule).

value (string)

The taint value corresponding to the taint key. Must be a label value.

DeviceTaintRuleStatus

DeviceTaintRuleStatus provides information about an on-going pod eviction.

conditions ([]Condition)

Conditions provide information about the state of the DeviceTaintRule and the cluster at some point in time, in a machine-readable and human-readable format.

The following condition is currently defined as part of this API, more may get added: - Type: EvictionInProgress - Status: True if there are currently pods which need to be evicted, False otherwise (includes the effects which don't cause eviction).

  • Reason: not specified, may change - Message: includes information about number of pending pods and already evicted pods in a human-readable format, updated periodically, may change

For effect: None, the condition above gets set once for each change to the spec, with the message containing information about what would happen if the effect was NoExecute. This feedback can be used to decide whether changing the effect to NoExecute will work as intended. It only gets set once to avoid having to constantly update the status.

Must have 8 or fewer entries.

DeviceTaintRuleList

DeviceTaintRuleList is a collection of DeviceTaintRules.

apiVersion: resource.k8s.io/v1alpha3
kind: DeviceTaintRuleList
metadata (ListMeta)

Standard list metadata

items ([]DeviceTaintRule)

Items is the list of DeviceTaintRules.