package v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

DevicePlugin is the service advertised by Device Plugins

• rpc GetDevicePluginOptions (Empty, DevicePluginOptions)

  api.proto:53

  GetDevicePluginOptions returns options to be communicated with Device Manager

• rpc ListAndWatch (Empty, stream ListAndWatchResponse)

  api.proto:58

  ListAndWatch returns a stream of List of Devices Whenever a Device state change or a Device disappears, ListAndWatch returns the new list

  message ListAndWatchResponse

  api.proto:81

  ListAndWatch returns a stream of List of Devices Whenever a Device state change or a Device disappears, ListAndWatch returns the new list

  • repeated Device devices = 1

• rpc GetPreferredAllocation (PreferredAllocationRequest, PreferredAllocationResponse)

  api.proto:65

  GetPreferredAllocation returns a preferred set of devices to allocate from a list of available ones. The resulting preferred allocation is not guaranteed to be the allocation ultimately performed by the devicemanager. It is only designed to help the devicemanager make a more informed allocation decision when possible.

  message PreferredAllocationRequest

  api.proto:129

  PreferredAllocationRequest is passed via a call to GetPreferredAllocation() at pod admission time. The device plugin should take the list of `available_deviceIDs` and calculate a preferred allocation of size 'allocation_size' from them, making sure to include the set of devices listed in 'must_include_deviceIDs'.

  • repeated ContainerPreferredAllocationRequest container_requests = 1

  message PreferredAllocationResponse

  api.proto:144

  PreferredAllocationResponse returns a preferred allocation, resulting from a PreferredAllocationRequest.

  • repeated ContainerPreferredAllocationResponse container_responses = 1

• rpc Allocate (AllocateRequest, AllocateResponse)

  api.proto:70

  Allocate is called during container creation so that the Device Plugin can run device specific operations and instruct Kubelet of the steps to make the Device available in the container

  message AllocateRequest

  api.proto:158

  - Allocate is expected to be called during pod creation since allocation failures for any container would result in pod startup failure. - Allocate allows kubelet to exposes additional artifacts in a pod's environment as directed by the plugin. - Allocate allows Device Plugin to run device specific operations on the Devices requested

  • repeated ContainerAllocateRequest container_requests = 1

  message AllocateResponse

  api.proto:174

  AllocateResponse includes the artifacts that needs to be injected into a container for accessing 'deviceIDs' that were mentioned as part of 'AllocateRequest'. Failure Handling: if Kubelet sends an allocation request for dev1 and dev2. Allocation on dev1 succeeds but allocation on dev2 fails. The Device plugin should send a ListAndWatch update and fail the Allocation request

  • repeated ContainerAllocateResponse container_responses = 1

• rpc PreStartContainer (PreStartContainerRequest, PreStartContainerResponse)

  api.proto:75

  PreStartContainer is called, if indicated by Device Plugin during registeration phase, before each container start. Device plugin can run device specific operations such as resetting the device before making devices available to the container

  message PreStartContainerRequest

  api.proto:116

  - PreStartContainer is expected to be called before each container start if indicated by plugin during registration phase. - PreStartContainer allows kubelet to pass reinitialized devices to containers. - PreStartContainer allows Device Plugin to run device specific operations on the Devices requested

  • repeated string devicesIDs = 1

  message PreStartContainerResponse

  api.proto:121

  PreStartContainerResponse will be send by plugin in response to PreStartContainerRequest

  (message has no fields)

Registration is the service advertised by the Kubelet Only when Kubelet answers with a success code to a Register Request may Device Plugins start their service Registration may fail when device plugin version is not supported by Kubelet or the registered resourceName is already taken by another active device plugin. Device plugin is expected to terminate upon registration failure

• rpc Register (RegisterRequest, Empty)

  api.proto:24

  message RegisterRequest

  api.proto:34

  • string version = 1

    Version of the API the Device Plugin was built against

  • string endpoint = 2

    Name of the unix socket the device plugin is listening on PATH = path.Join(DevicePluginPath, endpoint)

  • string resource_name = 3

    Schedulable resource name. As of now it's expected to be a DNS Label

  • optional DevicePluginOptions options = 4

    Options to be communicated with Device Manager

Used in: AllocateRequest

• repeated string devicesIDs = 1

Used in: AllocateResponse

• map<string, string> envs = 1

  List of environment variable to be set in the container to access one of more devices.

• repeated Mount mounts = 2

  Mounts for the container.

• repeated DeviceSpec devices = 3

  Devices for the container.

• map<string, string> annotations = 4

  Container annotations to pass to the container runtime

Used in: PreferredAllocationRequest

• repeated string available_deviceIDs = 1

  List of available deviceIDs from which to choose a preferred allocation

• repeated string must_include_deviceIDs = 2

  List of deviceIDs that must be included in the preferred allocation

• int32 allocation_size = 3

  Number of devices to include in the preferred allocation

Used in: PreferredAllocationResponse

• repeated string deviceIDs = 1

E.g: struct Device { ID: "GPU-fef8089b-4820-abfc-e83e-94318197576e", Health: "Healthy", Topology: Node: ID: 1 }

Used in: ListAndWatchResponse

• string ID = 1

  A unique ID assigned by the device plugin used to identify devices during the communication Max length of this field is 63 characters

• string health = 2

  Health of the device, can be healthy or unhealthy, see constants.go

• optional TopologyInfo topology = 3

  Topology for device

Used as response type in: DevicePlugin.GetDevicePluginOptions

Used as field type in: RegisterRequest

• bool pre_start_required = 1

  Indicates if PreStartContainer call is required before each container start

• bool get_preferred_allocation_available = 2

  Indicates if GetPreferredAllocation is implemented and available for calling

DeviceSpec specifies a host device to mount into a container.

Used in: ContainerAllocateResponse

• string container_path = 1

  Path of the device within the container.

• string host_path = 2

  Path of the device on the host.

• string permissions = 3

  Cgroups permissions of the device, candidates are one or more of * r - allows container to read from the specified device. * w - allows container to write to the specified device. * m - allows container to create device files that do not yet exist.

Used as request type in: DevicePlugin.GetDevicePluginOptions, DevicePlugin.ListAndWatch

Used as response type in: Registration.Register

(message has no fields)

Mount specifies a host volume to mount into a container. where device library or tools are installed on host and container

Used in: ContainerAllocateResponse

• string container_path = 1

  Path of the mount within the container.

• string host_path = 2

  Path of the mount on the host.

• bool read_only = 3

  If set, the mount is read-only.

Used in: TopologyInfo

• int64 ID = 1

Used in: Device

• repeated NUMANode nodes = 1