Package org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.deviceframework

Class DeviceResourceDockerRuntimePluginImpl

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.deviceframework.DeviceResourceDockerRuntimePluginImpl

All Implemented Interfaces:

DockerCommandPlugin

public class DeviceResourceDockerRuntimePluginImpl
extends java.lang.Object
implements DockerCommandPlugin

Bridge DevicePlugin and the hooks related to lunch Docker container. When launching Docker container, DockerLinuxContainerRuntime will invoke this class's methods which get needed info back from DevicePlugin.

Constructor Summary

Constructors

Constructor	Description
DeviceResourceDockerRuntimePluginImpl(java.lang.String resourceName, DevicePlugin devicePlugin, DevicePluginAdapter devicePluginAdapter)

Method Summary

Modifier and Type	Method	Description
DockerVolumeCommand	getCleanupDockerVolumesCommand(Container container)	Cleanup volumes created for one docker container
DockerVolumeCommand	getCreateDockerVolumeCommand(Container container)	Create volume when needed.
DeviceRuntimeSpec	getRuntimeSpec(Container container)
protected boolean	requestedDevice(java.lang.String resName, Container container)
void	updateDockerRunCommand(DockerRunCommand dockerRunCommand, Container container)	Update docker run command

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceResourceDockerRuntimePluginImpl

public DeviceResourceDockerRuntimePluginImpl(java.lang.String resourceName,
                                             DevicePlugin devicePlugin,
                                             DevicePluginAdapter devicePluginAdapter)

Method Detail

updateDockerRunCommand

public void updateDockerRunCommand(DockerRunCommand dockerRunCommand,
                                   Container container)
                            throws ContainerExecutionException

Description copied from interface: DockerCommandPlugin

Update docker run command

Specified by:

updateDockerRunCommand in interface DockerCommandPlugin

Parameters:

dockerRunCommand - docker run command

container - NM container

Throws:

ContainerExecutionException - if any issue occurs

getCreateDockerVolumeCommand

public DockerVolumeCommand getCreateDockerVolumeCommand(Container container)
                                                 throws ContainerExecutionException

Description copied from interface: DockerCommandPlugin

Create volume when needed.

Specified by:

getCreateDockerVolumeCommand in interface DockerCommandPlugin

Parameters:

container - container

Returns:

DockerVolumeCommand to create volume

Throws:

ContainerExecutionException - when any issue happens

getCleanupDockerVolumesCommand

public DockerVolumeCommand getCleanupDockerVolumesCommand(Container container)
                                                   throws ContainerExecutionException

Description copied from interface: DockerCommandPlugin

Cleanup volumes created for one docker container

Specified by:

getCleanupDockerVolumesCommand in interface DockerCommandPlugin

Parameters:

container - container

Returns:

DockerVolumeCommand to remove volume

Throws:

ContainerExecutionException - when any issue happens

requestedDevice

protected boolean requestedDevice(java.lang.String resName,
                                  Container container)

getRuntimeSpec

public DeviceRuntimeSpec getRuntimeSpec(Container container)