DeviceTaintRule v1alpha3
apiVersion: resource.k8s.io/v1alpha3
import "k8s.io/api/resource/v1alpha3"
DeviceTaintRule
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.
apiVersion: resource.k8s.io/v1alpha3
kind: DeviceTaintRule
metadata (ObjectMeta)
Standard object metadata
spec (DeviceTaintRuleSpec), required
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), required
The taint that gets applied to matching devices.
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.
taint.effect (string), required
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.
Possible enum values:
"NoExecute"Evict any already-running pods that do not tolerate the device taint."NoSchedule"Do not allow new pods to schedule which use a tainted device unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running."None"No effect, the taint is purely informational.
taint.key (string), required
The taint key to be applied to a device. Must be a label name.
taint.timeAdded (Time)
TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
taint.value (string)
The taint value corresponding to the taint key. Must be a label value.
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.
DeviceTaintRuleStatus
DeviceTaintRuleStatus provides information about an on-going pod eviction.
conditions ([]Condition)
Patch strategy: merge on key
typeMap: unique values on key type will be kept during a merge
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 wasNoExecute. This feedback can be used to decide whether changing the effect toNoExecutewill work as intended. It only gets set once to avoid having to constantly update the status.Must have 8 or fewer entries.
Condition contains details for one aspect of the current state of this API Resource.
conditions.lastTransitionTime (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
conditions.message (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
conditions.reason (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
conditions.status (string), required
status of the condition, one of True, False, Unknown.
conditions.type (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
conditions.observedGeneration (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
DeviceTaintRuleList
DeviceTaintRuleList is a collection of DeviceTaintRules.
apiVersion: resource.k8s.io/v1alpha3
kind: DeviceTaintRuleList
metadata (ListMeta)
Standard list metadata
items ([]DeviceTaintRule), required
Items is the list of DeviceTaintRules.
Operations
get read the specified DeviceTaintRule
HTTP Request
GET /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}
Parameters
name (in path): string, required
name of the DeviceTaintRule
pretty (in query): string
Response
200 (DeviceTaintRule): OK
401: Unauthorized
get read status of the specified DeviceTaintRule
HTTP Request
GET /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status
Parameters
name (in path): string, required
name of the DeviceTaintRule
pretty (in query): string
Response
200 (DeviceTaintRule): OK
401: Unauthorized
list list or watch objects of kind DeviceTaintRule
HTTP Request
GET /apis/resource.k8s.io/v1alpha3/devicetaintrules
Parameters
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (DeviceTaintRuleList): OK
401: Unauthorized
create create a DeviceTaintRule
HTTP Request
POST /apis/resource.k8s.io/v1alpha3/devicetaintrules
Parameters
body: DeviceTaintRule, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (DeviceTaintRule): OK
201 (DeviceTaintRule): Created
202 (DeviceTaintRule): Accepted
401: Unauthorized
update replace the specified DeviceTaintRule
HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}
Parameters
name (in path): string, required
name of the DeviceTaintRule
body: DeviceTaintRule, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (DeviceTaintRule): OK
201 (DeviceTaintRule): Created
401: Unauthorized
update replace status of the specified DeviceTaintRule
HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status
Parameters
name (in path): string, required
name of the DeviceTaintRule
body: DeviceTaintRule, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (DeviceTaintRule): OK
201 (DeviceTaintRule): Created
401: Unauthorized
patch partially update the specified DeviceTaintRule
HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}
Parameters
name (in path): string, required
name of the DeviceTaintRule
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (DeviceTaintRule): OK
201 (DeviceTaintRule): Created
401: Unauthorized
patch partially update status of the specified DeviceTaintRule
HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status
Parameters
name (in path): string, required
name of the DeviceTaintRule
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (DeviceTaintRule): OK
201 (DeviceTaintRule): Created
401: Unauthorized
delete delete a DeviceTaintRule
HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}
Parameters
name (in path): string, required
name of the DeviceTaintRule
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
pretty (in query): string
propagationPolicy (in query): string
Response
200 (DeviceTaintRule): OK
202 (DeviceTaintRule): Accepted
401: Unauthorized
deletecollection delete collection of DeviceTaintRule
HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/devicetaintrules
Parameters
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
Response
200 (Status): OK
401: Unauthorized
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.