# ResourceClaim

ResourceClaimResourceClaim describes a request for access to resources in the cluster, for use by workloads.apiVersion: resource.k8s.io/v1import "k8s.io/api/resource/v1"ResourceClaimResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.apiVersion: resource.k8s.io/v1kind: ResourceClaimmetadata (ObjectMeta)Standard object metadataspec (ResourceClaimSpec), requiredSpec describes what is being requested and how to configure it. The spec is immutable.status (ResourceClaimStatus)Status describes whether the claim is ready to use and what has been allocated.ResourceClaimSpecResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.devices (DeviceClaim)Devices defines how to request devices.DeviceClaim defines how to request devices with a ResourceClaim.devices.config ([]DeviceClaimConfiguration)Atomic: will be replaced during a mergeThis field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.devices.config.opaque (OpaqueDeviceConfiguration)Opaque provides driver-specific configuration parameters.OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.devices.config.opaque.driver (string), requiredDriver is used to determine which kubelet plugin needs to be passed these configuration parameters.An admission policy provided by the driver developer could use this to decide whether it needs to validate them.Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.devices.config.opaque.parameters (RawExtension), requiredParameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions.The length of the raw data must be smaller or equal to 10 Ki.*RawExtension is used to hold extensions in external versions.To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.// Internal package:type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` } // External package:type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` } // On the wire, the JSON will look something like this:{ "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, } So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*devices.config.requests ([]string)Atomic: will be replaced during a mergeRequests lists the names of requests where the configuration applies. If empty, it applies to all requests.References to subrequests must include the name of the main request and may include the subrequest using the format <main request>[/<subrequest>]. If just the main request is given, the configuration applies to all subrequests.devices.constraints ([]DeviceConstraint)Atomic: will be replaced during a mergeThese constraints must be satisfied by the set of devices that get allocated for the claim.DeviceConstraint must have exactly one field set besides Requests.devices.constraints.distinctAttribute (string)DistinctAttribute requires that all devices in question have this attribute and that its type and value are unique across those devices.This acts as the inverse of MatchAttribute.This constraint is used to avoid allocating multiple requests to the same device by ensuring attribute-level differentiation.This is useful for scenarios where resource requests must be fulfilled by separate physical devices. For example, a container requests two network interfaces that must be allocated from two different physical NICs.devices.constraints.matchAttribute (string)MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices.For example, if you specified "dra.example.com/numa" (a hypothetical example!), then only devices in the same NUMA node will be chosen. A device which does not have that attribute will not be chosen. All devices should use a value of the same type for this attribute because that is part of its specification, but if one device doesn't, then it also will not be chosen.Must include the domain qualifier.devices.constraints.requests ([]string)Atomic: will be replaced during a mergeRequests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim.References to subrequests must include the name of the main request and may include the subrequest using the format <main request>[/<subrequest>]. If just the main request is given, the constraint applies to all subrequests.devices.requests ([]DeviceRequest)Atomic: will be replaced during a mergeRequests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices. With FirstAvailable it is also possible to provide a prioritized list of requests.devices.requests.name (string), requiredName can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.References using the name in the DeviceRequest will uniquely identify a request when the Exactly field is set. When the FirstAvailable field is set, a reference to the name of the DeviceRequest will match whatever subrequest is chosen by the scheduler.Must be a DNS label.devices.requests.exactly (ExactDeviceRequest)Exactly specifies the details for a single request that must be met exactly for the request to be satisfied.One of Exactly or FirstAvailable must be set.ExactDeviceRequest is a request for one or more identical devices.devices.requests.exactly.deviceClassName (string), requiredDeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.A DeviceClassName is required.Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.devices.requests.exactly.adminAccess (boolean)AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations.This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.devices.requests.exactly.allocationMode (string)AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field.All: This request is for all of the matching devices in a pool. At least one device must exist on the node for the allocation to succeed. Allocation will fail if some devices are already allocated, unless adminAccess is requested.If AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.More modes may get added in the future. Clients must refuse to handle requests with unknown modes.devices.requests.exactly.capacity (CapacityRequirements)Capacity define resource requirements against each capacity.If this field is unset and the device supports multiple allocations, the default value will be applied to each capacity according to requestPolicy. For the capacity that has no requestPolicy, default is the full capacity value.Applies to each device allocation. If Count > 1, the request fails if there aren't enough devices that meet the requirements. If AllocationMode is set to All, the request fails if there are devices that otherwise match the request, and have this capacity, with a value >= the requested amount, but which cannot be allocated to this request.CapacityRequirements defines the capacity requirements for a specific device request.devices.requests.exactly.capacity.requests (map[string]Quantity)Requests represent individual device resource requests for distinct resources, all of which must be provided by the device.This value is used as an additional filtering condition against the available capacity on the device. This is semantically equivalent to a CEL selector with device.capacity[\<domain>].\<name>.compareTo(quantity(\<request quantity>)) >= 0. For example, device.capacity['test-driver.cdi.k8s.io'].counters.compareTo(quantity('2')) >= 0.When a requestPolicy is defined, the requested amount is adjusted upward to the nearest valid value based on the policy. If the requested amount cannot be adjusted to a valid value—because it exceeds what the requestPolicy allows— the device is considered ineligible for allocation.For any capacity that is not explicitly requested: - If no requestPolicy is set, the default consumed capacity is equal to the full device capacity (i.e., the whole device is claimed).If a requestPolicy is set, the default consumed capacity is determined according to that policy.If the device allows multiple allocation, the aggregated amount across all requests must not exceed the capacity value. The consumed capacity, which may be adjusted based on the requestPolicy if defined, is recorded in the resource claim’s status.devices[*].consumedCapacity field.devices.requests.exactly.count (int64)Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.devices.requests.exactly.selectors ([]DeviceSelector)Atomic: will be replaced during a mergeSelectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.DeviceSelector must have exactly one field set.devices.requests.exactly.selectors.cel (CELDeviceSelector)CEL contains a CEL expression for selecting a device.CELDeviceSelector contains a CEL expression for selecting a device.devices.requests.exactly.selectors.cel.expression (string), requiredExpression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.The expression's input is an object named "device", which carries the following properties:driver (string): the name of the driver which defines this device.attributes (map[string]object): the device's attributes, grouped by prefix (e.g. device.attributes["dra.example.com"] evaluates to an object with all of the attributes which were prefixed by "dra.example.com".capacity (map[string]object): the device's capacities, grouped by prefix.allowMultipleAllocations (bool): the allowMultipleAllocations property of the device (v1.34+ with the DRAConsumableCapacity feature enabled).Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields:device.driver device.attributes["dra.example.com"].model device.attributes["ext.example.com"].family device.capacity["dra.example.com"].modules The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.A robust expression should check for the existence of attributes before referencing them.For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool) The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps.devices.requests.exactly.tolerations ([]DeviceToleration)Atomic: will be replaced during a mergeIf specified, the request's tolerations.Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.The maximum number of tolerations is 16.This is an alpha field and requires enabling the DRADeviceTaints feature gate.The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .devices.requests.exactly.tolerations.effect (string)Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.devices.requests.exactly.tolerations.key (string)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. Must be a label name.devices.requests.exactly.tolerations.operator (string)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 ResourceClaim can tolerate all taints of a particular category.devices.requests.exactly.tolerations.tolerationSeconds (int64)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. If larger than zero, the time when the pod needs to be evicted is calculated as <time when taint was added> + <toleration seconds>.devices.requests.exactly.tolerations.value (string)Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.devices.requests.firstAvailable ([]DeviceSubRequest)Atomic: will be replaced during a mergeFirstAvailable contains subrequests, of which exactly one will be selected by the scheduler. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the list, the scheduler will only check the second one if it determines that the first one can not be used.DRA does not yet implement scoring, so the scheduler will select the first set of devices that satisfies all the requests in the claim. And if the requirements can be satisfied on more than one node, other scheduling features will determine which node is chosen. This means that the set of devices allocated to a claim might not be the optimal set available to the cluster. Scoring will be implemented later.*DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices.DeviceSubRequest is similar to ExactDeviceRequest, but doesn't expose the AdminAccess field as that one is only supported when requesting a specific device.*devices.requests.firstAvailable.deviceClassName (string), requiredDeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest.A class is required. Which classes are available depends on the cluster.Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.devices.requests.firstAvailable.name (string), requiredName can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format <main request>/<subrequest>.Must be a DNS label.devices.requests.firstAvailable.allocationMode (string)AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are:ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field.All: This subrequest is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested.If AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other subrequests must specify this field.More modes may get added in the future. Clients must refuse to handle requests with unknown modes.devices.requests.firstAvailable.capacity (CapacityRequirements)Capacity define resource requirements against each capacity.If this field is unset and the device supports multiple allocations, the default value will be applied to each capacity according to requestPolicy. For the capacity that has no requestPolicy, default is the full capacity value.Applies to each device allocation. If Count > 1, the request fails if there aren't enough devices that meet the requirements. If AllocationMode is set to All, the request fails if there are devices that otherwise match the request, and have this capacity, with a value >= the requested amount, but which cannot be allocated to this request.CapacityRequirements defines the capacity requirements for a specific device request.devices.requests.firstAvailable.capacity.requests (map[string]Quantity)Requests represent individual device resource requests for distinct resources, all of which must be provided by the device.This value is used as an additional filtering condition against the available capacity on the device. This is semantically equivalent to a CEL selector with device.capacity[\<domain>].\<name>.compareTo(quantity(\<request quantity>)) >= 0. For example, device.capacity['test-driver.cdi.k8s.io'].counters.compareTo(quantity('2')) >= 0.When a requestPolicy is defined, the requested amount is adjusted upward to the nearest valid value based on the policy. If the requested amount cannot be adjusted to a valid value—because it exceeds what the requestPolicy allows— the device is considered ineligible for allocation.For any capacity that is not explicitly requested: - If no requestPolicy is set, the default consumed capacity is equal to the full device capacity (i.e., the whole device is claimed).If a requestPolicy is set, the default consumed capacity is determined according to that policy.If the device allows multiple allocation, the aggregated amount across all requests must not exceed the capacity value. The consumed capacity, which may be adjusted based on the requestPolicy if defined, is recorded in the resource claim’s status.devices[*].consumedCapacity field.devices.requests.firstAvailable.count (int64)Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.devices.requests.firstAvailable.selectors ([]DeviceSelector)Atomic: will be replaced during a mergeSelectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.DeviceSelector must have exactly one field set.devices.requests.firstAvailable.selectors.cel (CELDeviceSelector)CEL contains a CEL expression for selecting a device.CELDeviceSelector contains a CEL expression for selecting a device.devices.requests.firstAvailable.selectors.cel.expression (string), requiredExpression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.The expression's input is an object named "device", which carries the following properties:driver (string): the name of the driver which defines this device.attributes (map[string]object): the device's attributes, grouped by prefix (e.g. device.attributes["dra.example.com"] evaluates to an object with all of the attributes which were prefixed by "dra.example.com".capacity (map[string]object): the device's capacities, grouped by prefix.allowMultipleAllocations (bool): the allowMultipleAllocations property of the device (v1.34+ with the DRAConsumableCapacity feature enabled).Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields:device.driver device.attributes["dra.example.com"].model device.attributes["ext.example.com"].family device.capacity["dra.example.com"].modules The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.A robust expression should check for the existence of attributes before referencing them.For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool) The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps.devices.requests.firstAvailable.tolerations ([]DeviceToleration)Atomic: will be replaced during a mergeIf specified, the request's tolerations.Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.The maximum number of tolerations is 16.This is an alpha field and requires enabling the DRADeviceTaints feature gate.The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .devices.requests.firstAvailable.tolerations.effect (string)Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.devices.requests.firstAvailable.tolerations.key (string)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. Must be a label name.devices.requests.firstAvailable.tolerations.operator (string)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 ResourceClaim can tolerate all taints of a particular category.devices.requests.firstAvailable.tolerations.tolerationSeconds (int64)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. If larger than zero, the time when the pod needs to be evicted is calculated as <time when taint was added> + <toleration seconds>.devices.requests.firstAvailable.tolerations.value (string)Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.ResourceClaimStatusResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.allocation (AllocationResult)Allocation is set once the claim has been allocated successfully.AllocationResult contains attributes of an allocated resource.allocation.allocationTimestamp (Time)AllocationTimestamp stores the time when the resources were allocated. This field is not guaranteed to be set, in which case that time is unknown.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gate.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.allocation.devices (DeviceAllocationResult)Devices is the result of allocating devices.DeviceAllocationResult is the result of allocating devices.allocation.devices.config ([]DeviceAllocationConfiguration)Atomic: will be replaced during a mergeThis field is a combination of all the claim and class configuration parameters. Drivers can distinguish between those based on a flag.This includes configuration parameters for drivers which have no allocated devices in the result because it is up to the drivers which configuration parameters they support. They can silently ignore unknown configuration parameters.DeviceAllocationConfiguration gets embedded in an AllocationResult.allocation.devices.config.source (string), requiredSource records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim.allocation.devices.config.opaque (OpaqueDeviceConfiguration)Opaque provides driver-specific configuration parameters.OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.allocation.devices.config.opaque.driver (string), requiredDriver is used to determine which kubelet plugin needs to be passed these configuration parameters.An admission policy provided by the driver developer could use this to decide whether it needs to validate them.Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.allocation.devices.config.opaque.parameters (RawExtension), requiredParameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions.The length of the raw data must be smaller or equal to 10 Ki.*RawExtension is used to hold extensions in external versions.To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.// Internal package:type MyAPIObject struct { runtime.TypeMeta json:",inline" MyPlugin runtime.Object json:"myPlugin" }type PluginA struct { AOption string json:"aOption" }// External package:type MyAPIObject struct { runtime.TypeMeta json:",inline" MyPlugin runtime.RawExtension json:"myPlugin" }type PluginA struct { AOption string json:"aOption" }// On the wire, the JSON will look something like this:{ "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, }So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*allocation.devices.config.requests ([]string)Atomic: will be replaced during a mergeRequests lists the names of requests where the configuration applies. If empty, its applies to all requests.References to subrequests must include the name of the main request and may include the subrequest using the format <main request>[/<subrequest>]. If just the main request is given, the configuration applies to all subrequests.allocation.devices.results ([]DeviceRequestAllocationResult)Atomic: will be replaced during a mergeResults lists all allocated devices.DeviceRequestAllocationResult contains the allocation result for one request.allocation.devices.results.device (string), requiredDevice references one device instance via its name in the driver's resource pool. It must be a DNS label.allocation.devices.results.driver (string), requiredDriver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.allocation.devices.results.pool (string), requiredThis name together with the driver name and the device name field identify which device was allocated (\<driver name>/\<pool name>/\<device name>).Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.allocation.devices.results.request (string), requiredRequest is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the name of the main request and the subrequest using the format <main request>/<subrequest>.Multiple devices may have been allocated per request.allocation.devices.results.adminAccess (boolean)AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode.This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.allocation.devices.results.bindingConditions ([]string)Atomic: will be replaced during a mergeBindingConditions contains a copy of the BindingConditions from the corresponding ResourceSlice at the time of allocation.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gates.allocation.devices.results.bindingFailureConditions ([]string)Atomic: will be replaced during a mergeBindingFailureConditions contains a copy of the BindingFailureConditions from the corresponding ResourceSlice at the time of allocation.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gates.allocation.devices.results.consumedCapacity (map[string]Quantity)ConsumedCapacity tracks the amount of capacity consumed per device as part of the claim request. The consumed amount may differ from the requested amount: it is rounded up to the nearest valid value based on the device’s requestPolicy if applicable (i.e., may not be less than the requested amount).The total consumed capacity for each device must not exceed the DeviceCapacity's Value.This field is populated only for devices that allow multiple allocations. All capacity entries are included, even if the consumed amount is zero.allocation.devices.results.shareID (string)ShareID uniquely identifies an individual allocation share of the device, used when the device supports multiple simultaneous allocations. It serves as an additional map key to differentiate concurrent shares of the same device.allocation.devices.results.tolerations ([]DeviceToleration)Atomic: will be replaced during a mergeA copy of all tolerations specified in the request at the time when the device got allocated.The maximum number of tolerations is 16.This is an alpha field and requires enabling the DRADeviceTaints feature gate.The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .allocation.devices.results.tolerations.effect (string)Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.allocation.devices.results.tolerations.key (string)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. Must be a label name.allocation.devices.results.tolerations.operator (string)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 ResourceClaim can tolerate all taints of a particular category.allocation.devices.results.tolerations.tolerationSeconds (int64)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. If larger than zero, the time when the pod needs to be evicted is calculated as <time when taint was added> + <toleration seconds>.allocation.devices.results.tolerations.value (string)Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.allocation.nodeSelector (NodeSelector)NodeSelector defines where the allocated resources are available. If unset, they are available everywhere.A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.allocation.nodeSelector.nodeSelectorTerms ([]NodeSelectorTerm), requiredAtomic: will be replaced during a mergeRequired. A list of node selector terms. The terms are ORed.A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.allocation.nodeSelector.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's labels.allocation.nodeSelector.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's fields.devices ([]AllocatedDeviceStatus)Map: unique values on keys driver, device, pool, shareID will be kept during a mergeDevices contains the status of each device allocated for this claim, as reported by the driver. This can include driver-specific information. Entries are owned by their respective drivers.*AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information.The combination of Driver, Pool, Device, and ShareID must match the corresponding key in Status.Allocation.Devices.*devices.device (string), requiredDevice references one device instance via its name in the driver's resource pool. It must be a DNS label.devices.driver (string), requiredDriver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.devices.pool (string), requiredThis name together with the driver name and the device name field identify which device was allocated (\<driver name>/\<pool name>/\<device name>).Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.devices.conditions ([]Condition)Map: unique values on key type will be kept during a mergeConditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the Ready condition should be True.Must not contain more than 8 entries.Condition contains details for one aspect of the current state of this API Resource.devices.conditions.lastTransitionTime (Time), requiredlastTransitionTime 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.devices.conditions.message (string), requiredmessage is a human readable message indicating details about the transition. This may be an empty string.devices.conditions.reason (string), requiredreason 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.devices.conditions.status (string), requiredstatus of the condition, one of True, False, Unknown.devices.conditions.type (string), requiredtype of condition in CamelCase or in foo.example.com/CamelCase.devices.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.devices.data (RawExtension)Data contains arbitrary driver-specific data.The length of the raw data must be smaller or equal to 10 Ki.*RawExtension is used to hold extensions in external versions.To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.// Internal package:type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` } // External package:type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` } // On the wire, the JSON will look something like this:{ "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, } So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*devices.networkData (NetworkDeviceData)NetworkData contains network-related information specific to the device.NetworkDeviceData provides network-related details for the allocated device. This information may be filled by drivers or other components to configure or identify the device within a network context.devices.networkData.hardwareAddress (string)HardwareAddress represents the hardware address (e.g. MAC Address) of the device's network interface.Must not be longer than 128 characters.devices.networkData.interfaceName (string)InterfaceName specifies the name of the network interface associated with the allocated device. This might be the name of a physical or virtual network interface being configured in the pod.Must not be longer than 256 characters.devices.networkData.ips ([]string)Atomic: will be replaced during a mergeIPs lists the network addresses assigned to the device's network interface. This can include both IPv4 and IPv6 addresses. The IPs are in the CIDR notation, which includes both the address and the associated subnet mask. e.g.: "192.0.2.5/24" for IPv4 and "2001:db8::5/64" for IPv6.devices.shareID (string)ShareID uniquely identifies an individual allocation share of the device.reservedFor ([]ResourceClaimConsumerReference)Patch strategy: merge on key uidMap: unique values on key uid will be kept during a mergeReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. A claim that is in use or might be in use because it has been reserved must not get deallocated.In a cluster with multiple scheduler instances, two pods might get scheduled concurrently by different schedulers. When they reference the same ResourceClaim which already has reached its maximum number of consumers, only one pod can be scheduled.Both schedulers try to add their pod to the claim.status.reservedFor field, but only the update that reaches the API server first gets stored. The other one fails with an error and the scheduler which issued it knows that it must put the pod back into the queue, waiting for the ResourceClaim to become usable again.There can be at most 256 such reservations. This may get increased in the future, but not reduced.ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.reservedFor.name (string), requiredName is the name of resource being referenced.reservedFor.resource (string), requiredResource is the type of resource being referenced, for example "pods".reservedFor.uid (string), requiredUID identifies exactly one incarnation of the resource.reservedFor.apiGroup (string)APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.ResourceClaimListResourceClaimList is a collection of claims.apiVersion: resource.k8s.io/v1kind: ResourceClaimListmetadata (ListMeta)Standard list metadataitems ([]ResourceClaim), requiredItems is the list of resource claims.Operationsget read the specified ResourceClaimHTTP RequestGET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}Parametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (ResourceClaim): OK401: Unauthorizedget read status of the specified ResourceClaimHTTP RequestGET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/statusParametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (ResourceClaim): OK401: Unauthorizedlist list or watch objects of kind ResourceClaimHTTP RequestGET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimsParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (ResourceClaimList): OK401: Unauthorizedlist list or watch objects of kind ResourceClaimHTTP RequestGET /apis/resource.k8s.io/v1/resourceclaimsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (ResourceClaimList): OK401: Unauthorizedcreate create a ResourceClaimHTTP RequestPOST /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimsParametersnamespace (in path): string, requirednamespacebody: ResourceClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ResourceClaim): OK201 (ResourceClaim): Created202 (ResourceClaim): Accepted401: Unauthorizedupdate replace the specified ResourceClaimHTTP RequestPUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}Parametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacebody: ResourceClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ResourceClaim): OK201 (ResourceClaim): Created401: Unauthorizedupdate replace status of the specified ResourceClaimHTTP RequestPUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/statusParametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacebody: ResourceClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ResourceClaim): OK201 (ResourceClaim): Created401: Unauthorizedpatch partially update the specified ResourceClaimHTTP RequestPATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}Parametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (ResourceClaim): OK201 (ResourceClaim): Created401: Unauthorizedpatch partially update status of the specified ResourceClaimHTTP RequestPATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/statusParametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (ResourceClaim): OK201 (ResourceClaim): Created401: Unauthorizeddelete delete a ResourceClaimHTTP RequestDELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}Parametersname (in path): string, requiredname of the ResourceClaimnamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (ResourceClaim): OK202 (ResourceClaim): Accepted401: Unauthorizeddeletecollection delete collection of ResourceClaimHTTP RequestDELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimsParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis 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.