DeviceRequestArgs

data class DeviceRequestArgs(val adminAccess: Output<Boolean>? = null, val allocationMode: Output<String>? = null, val count: Output<Int>? = null, val deviceClassName: Output<String>? = null, val firstAvailable: Output<List<DeviceSubRequestArgs>>? = null, val name: Output<String>, val selectors: Output<List<DeviceSelectorArgs>>? = null, val tolerations: Output<List<DeviceTolerationArgs>>? = null) : ConvertibleToJava<DeviceRequestArgs>

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.

Constructors

Link copied to clipboard
constructor(adminAccess: Output<Boolean>? = null, allocationMode: Output<String>? = null, count: Output<Int>? = null, deviceClassName: Output<String>? = null, firstAvailable: Output<List<DeviceSubRequestArgs>>? = null, name: Output<String>, selectors: Output<List<DeviceSelectorArgs>>? = null, tolerations: Output<List<DeviceTolerationArgs>>? = null)

Properties

Link copied to clipboard
val adminAccess: Output<Boolean>? = null

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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list. 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.

Link copied to clipboard
val allocationMode: Output<String>? = null

AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:

Link copied to clipboard
val count: Output<Int>? = null

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. This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.

Link copied to clipboard
val deviceClassName: Output<String>? = null

DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A class is required if no subrequests are specified in the firstAvailable list and no class can be set if subrequests are specified in the firstAvailable list. 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.

Link copied to clipboard

FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request. 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 cannot be used. This field may only be set in the entries of DeviceClaim.Requests. 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.

Link copied to clipboard
val name: Output<String>

Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. Must be a DNS label.

Link copied to clipboard
val selectors: Output<List<DeviceSelectorArgs>>? = null

Selectors 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. This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.

Link copied to clipboard
val tolerations: Output<List<DeviceTolerationArgs>>? = null

If 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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list. This is an alpha field and requires enabling the DRADeviceTaints feature gate.

Functions

Link copied to clipboard
open override fun toJava(): DeviceRequestArgs