Package org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin

Interface DevicePlugin

All Known Implementing Classes:

NECVEPlugin, NvidiaGPUPluginForRuntimeV2

public interface DevicePlugin

A must interface for vendor plugin to implement.

Method Summary

Modifier and Type	Method	Description
java.util.Set<Device>	getDevices()	Called when update node resource.
DeviceRegisterRequest	getRegisterRequestInfo()	Called first when device plugin framework wants to register.
DeviceRuntimeSpec	onDevicesAllocated(java.util.Set<Device> allocatedDevices, YarnRuntimeType yarnRuntime)	Asking how these devices should be prepared/used before/when container launch.
void	onDevicesReleased(java.util.Set<Device> releasedDevices)	Called after device released.

Method Detail

getRegisterRequestInfo

DeviceRegisterRequest getRegisterRequestInfo()
                                      throws java.lang.Exception

Called first when device plugin framework wants to register.

Returns:

DeviceRegisterRequest DeviceRegisterRequest

Throws:

java.lang.Exception

getDevices

java.util.Set<Device> getDevices()
                          throws java.lang.Exception

Called when update node resource.

Returns:

a set of Device, TreeSet recommended

Throws:

java.lang.Exception

onDevicesAllocated

DeviceRuntimeSpec onDevicesAllocated(java.util.Set<Device> allocatedDevices,
                                     YarnRuntimeType yarnRuntime)
                              throws java.lang.Exception

Asking how these devices should be prepared/used before/when container launch. A plugin can do some tasks in its own or define it in DeviceRuntimeSpec to let the framework do it. For instance, define VolumeSpec to let the framework to create volume before running container.

Parameters:

allocatedDevices - A set of allocated Device.

yarnRuntime - Indicate which runtime YARN will use Could be RUNTIME_DEFAULT or RUNTIME_DOCKER in DeviceRuntimeSpec constants. The default means YARN's non-docker container runtime is used. The docker means YARN's docker container runtime is used.

Returns:

a DeviceRuntimeSpec description about environment, VolumeSpec, MountVolumeSpec. etc

Throws:

java.lang.Exception

onDevicesReleased

void onDevicesReleased(java.util.Set<Device> releasedDevices)
                throws java.lang.Exception

Called after device released.

Parameters:

releasedDevices - A set of released devices

Throws:

java.lang.Exception