# ResourceSlice

ResourceSliceResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.apiVersion: resource.k8s.io/v1import "k8s.io/api/resource/v1"ResourceSliceResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple <driver name>, <pool name>, <device name>.Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.apiVersion: resource.k8s.io/v1kind: ResourceSlicemetadata (ObjectMeta)Standard object metadataspec (ResourceSliceSpec), requiredContains the information published by the driver.Changing the spec automatically increments the metadata.generation number.ResourceSliceSpecResourceSliceSpec contains the information published by the driver in one ResourceSlice.driver (string), requiredDriver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name.Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. This field is immutable.pool (ResourcePool), requiredPool describes the pool that this ResourceSlice belongs to.ResourcePool describes the pool that ResourceSlices belong to.pool.generation (int64), requiredGeneration tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part of that pool. Consumers of ResourceSlices should only consider resources from the pool with the highest generation number. The generation may be reset by drivers, which should be fine for consumers, assuming that all ResourceSlices in a pool are updated to match or deleted.Combined with ResourceSliceCount, this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state.pool.name (string), requiredName is used to identify the pool. For node-local devices, this is often the node name, but this is not required.It must not be longer than 253 characters and must consist of one or more DNS sub-domains separated by slashes. This field is immutable.pool.resourceSliceCount (int64), requiredResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero.Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool.allNodes (boolean)AllNodes indicates that all nodes have access to the resources in the pool.Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.devices ([]Device)Atomic: will be replaced during a mergeDevices lists some or all of the devices in this pool.Must not have more than 128 entries.Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.devices.name (string), requiredName is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.devices.allNodes (boolean)AllNodes indicates that all nodes have access to the device.Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.devices.allowMultipleAllocations (boolean)AllowMultipleAllocations marks whether the device is allowed to be allocated to multiple DeviceRequests.If AllowMultipleAllocations is set to true, the device can be allocated more than once, and all of its capacity is consumable, regardless of whether the requestPolicy is defined or not.devices.attributes (map[string]DeviceAttribute)Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set.The maximum number of attributes and capacities combined is 32.DeviceAttribute must have exactly one field set.devices.attributes.bool (boolean)BoolValue is a true/false value.devices.attributes.int (int64)IntValue is a number.devices.attributes.string (string)StringValue is a string. Must not be longer than 64 characters.devices.attributes.version (string)VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.devices.bindingConditions ([]string)Atomic: will be replaced during a mergeBindingConditions defines the conditions for proceeding with binding. All of these conditions must be set in the per-device status conditions with a value of True to proceed with binding the pod to the node while scheduling the pod.The maximum number of binding conditions is 4.The conditions must be a valid condition type string.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gates.devices.bindingFailureConditions ([]string)Atomic: will be replaced during a mergeBindingFailureConditions defines the conditions for binding failure. They may be set in the per-device status conditions. If any is set to "True", a binding failure occurred.The maximum number of binding failure conditions is 4.The conditions must be a valid condition type string.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gates.devices.bindsToNode (boolean)BindsToNode indicates if the usage of an allocation involving this device has to be limited to exactly the node that was chosen when allocating the claim. If set to true, the scheduler will set the ResourceClaim.Status.Allocation.NodeSelector to match the node where the allocation was made.This is an alpha field and requires enabling the DRADeviceBindingConditions and DRAResourceClaimDeviceStatus feature gates.devices.capacity (map[string]DeviceCapacity)Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set.The maximum number of attributes and capacities combined is 32.DeviceCapacity describes a quantity associated with a device.devices.capacity.value (Quantity), requiredValue defines how much of a certain capacity that device has.This field reflects the fixed total capacity and does not change. The consumed amount is tracked separately by scheduler and does not affect this value.devices.capacity.requestPolicy (CapacityRequestPolicy)RequestPolicy defines how this DeviceCapacity must be consumed when the device is allowed to be shared by multiple allocations.The Device must have allowMultipleAllocations set to true in order to set a requestPolicy.If unset, capacity requests are unconstrained: requests can consume any amount of capacity, as long as the total consumed across all allocations does not exceed the device's defined capacity. If request is also unset, default is the full capacity value.*CapacityRequestPolicy defines how requests consume device capacity.Must not set more than one ValidRequestValues.*devices.capacity.requestPolicy.default (Quantity)Default specifies how much of this capacity is consumed by a request that does not contain an entry for it in DeviceRequest's Capacity.devices.capacity.requestPolicy.validRange (CapacityRequestPolicyRange)ValidRange defines an acceptable quantity value range in consuming requests.If this field is set, Default must be defined and it must fall within the defined ValidRange.If the requested amount does not fall within the defined range, the request violates the policy, and this device cannot be allocated.If the request doesn't contain this capacity entry, Default value is used.*CapacityRequestPolicyRange defines a valid range for consumable capacity values.If the requested amount is less than Min, it is rounded up to the Min value.If Step is set and the requested amount is between Min and Max but not aligned with Step, it will be rounded up to the next value equal to Min + (n * Step).If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set).If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy, and the device cannot be allocated.*devices.capacity.requestPolicy.validRange.min (Quantity), requiredMin specifies the minimum capacity allowed for a consumption request.Min must be greater than or equal to zero, and less than or equal to the capacity value. requestPolicy.default must be more than or equal to the minimum.devices.capacity.requestPolicy.validRange.max (Quantity)Max defines the upper limit for capacity that can be requested.Max must be less than or equal to the capacity value. Min and requestPolicy.default must be less than or equal to the maximum.devices.capacity.requestPolicy.validRange.step (Quantity)Step defines the step size between valid capacity amounts within the range.Max (if set) and requestPolicy.default must be a multiple of Step. Min + Step must be less than or equal to the capacity value.devices.capacity.requestPolicy.validValues ([]Quantity)Atomic: will be replaced during a mergeValidValues defines a set of acceptable quantity values in consuming requests.Must not contain more than 10 entries. Must be sorted in ascending order.If this field is set, Default must be defined and it must be included in ValidValues list.If the requested amount does not match any valid value but smaller than some valid values, the scheduler calculates the smallest valid value that is greater than or equal to the request. That is: min(ceil(requestedValue) ∈ validValues), where requestedValue ≤ max(validValues).If the requested amount exceeds all valid values, the request violates the policy, and this device cannot be allocated.devices.consumesCounters ([]DeviceCounterConsumption)Atomic: will be replaced during a mergeConsumesCounters defines a list of references to sharedCounters and the set of counters that the device will consume from those counter sets.There can only be a single entry per counterSet.The total number of device counter consumption entries must be <= 32. In addition, the total number in the entire ResourceSlice must be <= 1024 (for example, 64 devices with 16 counters each).DeviceCounterConsumption defines a set of counters that a device will consume from a CounterSet.devices.consumesCounters.counterSet (string), requiredCounterSet is the name of the set from which the counters defined will be consumed.devices.consumesCounters.counters (map[string]Counter), requiredCounters defines the counters that will be consumed by the device.The maximum number counters in a device is 32. In addition, the maximum number of all counters in all devices is 1024 (for example, 64 devices with 16 counters each).Counter describes a quantity associated with a device.devices.consumesCounters.counters.value (Quantity), requiredValue defines how much of a certain device counter is available.devices.nodeName (string)NodeName identifies the node where the device is available.Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.devices.nodeSelector (NodeSelector)NodeSelector defines the nodes where the device is available.Must use exactly one term.Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.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.devices.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.devices.nodeSelector.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's labels.devices.nodeSelector.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's fields.devices.taints ([]DeviceTaint)Atomic: will be replaced during a mergeIf specified, these are the driver-defined taints.The maximum number of taints is 4.This is an alpha field and requires enabling the DRADeviceTaints feature gate.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.devices.taints.effect (string), requiredThe effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are NoSchedule and NoExecute. PreferNoSchedule as used for nodes is not valid here.devices.taints.key (string), requiredThe taint key to be applied to a device. Must be a label name.devices.taints.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.devices.taints.value (string)The taint value corresponding to the taint key. Must be a label value.nodeName (string)NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node.This field can be used to limit access from nodes to ResourceSlices with the same node name. It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available.Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set. This field is immutable.nodeSelector (NodeSelector)NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node.Must use exactly one term.Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.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.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.nodeSelector.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's labels.nodeSelector.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's fields.perDeviceNodeSelection (boolean)PerDeviceNodeSelection defines whether the access from nodes to resources in the pool is set on the ResourceSlice level or on each device. If it is set to true, every device defined the ResourceSlice must specify this individually.Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.sharedCounters ([]CounterSet)Atomic: will be replaced during a mergeSharedCounters defines a list of counter sets, each of which has a name and a list of counters available.The names of the SharedCounters must be unique in the ResourceSlice.The maximum number of counters in all sets is 32.*CounterSet defines a named set of counters that are available to be used by devices defined in the ResourceSlice.The counters are not allocatable by themselves, but can be referenced by devices. When a device is allocated, the portion of counters it uses will no longer be available for use by other devices.*sharedCounters.counters (map[string]Counter), requiredCounters defines the set of counters for this CounterSet The name of each counter must be unique in that set and must be a DNS label.The maximum number of counters in all sets is 32.Counter describes a quantity associated with a device.sharedCounters.counters.value (Quantity), requiredValue defines how much of a certain device counter is available.sharedCounters.name (string), requiredName defines the name of the counter set. It must be a DNS label.ResourceSliceListResourceSliceList is a collection of ResourceSlices.apiVersion: resource.k8s.io/v1kind: ResourceSliceListmetadata (ListMeta)Standard list metadataitems ([]ResourceSlice), requiredItems is the list of resource ResourceSlices.Operationsget read the specified ResourceSliceHTTP RequestGET /apis/resource.k8s.io/v1/resourceslices/{name}Parametersname (in path): string, requiredname of the ResourceSlicepretty (in query): stringprettyResponse200 (ResourceSlice): OK401: Unauthorizedlist list or watch objects of kind ResourceSliceHTTP RequestGET /apis/resource.k8s.io/v1/resourceslicesParametersallowWatchBookmarks (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 (ResourceSliceList): OK401: Unauthorizedcreate create a ResourceSliceHTTP RequestPOST /apis/resource.k8s.io/v1/resourceslicesParametersbody: ResourceSlice, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ResourceSlice): OK201 (ResourceSlice): Created202 (ResourceSlice): Accepted401: Unauthorizedupdate replace the specified ResourceSliceHTTP RequestPUT /apis/resource.k8s.io/v1/resourceslices/{name}Parametersname (in path): string, requiredname of the ResourceSlicebody: ResourceSlice, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ResourceSlice): OK201 (ResourceSlice): Created401: Unauthorizedpatch partially update the specified ResourceSliceHTTP RequestPATCH /apis/resource.k8s.io/v1/resourceslices/{name}Parametersname (in path): string, requiredname of the ResourceSlicebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (ResourceSlice): OK201 (ResourceSlice): Created401: Unauthorizeddelete delete a ResourceSliceHTTP RequestDELETE /apis/resource.k8s.io/v1/resourceslices/{name}Parametersname (in path): string, requiredname of the ResourceSlicebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (ResourceSlice): OK202 (ResourceSlice): Accepted401: Unauthorizeddeletecollection delete collection of ResourceSliceHTTP RequestDELETE /apis/resource.k8s.io/v1/resourceslicesParametersbody: 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.