DeviceRequest is a request for devices required for a claim.
Known subtypes:
Known usages:
All versions:
This is typically a request for a single resource like a device, but can also ask for several identical devices.
A DeviceClassName is currently required.
Clients must check that it is indeed set.
It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.
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.
Allocation will fail if some devices are already allocated,
unless adminAccess is requested.
If AlloctionMode 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.
DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
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.
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.
DeviceRequest is a request for devices required for a claim.