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

Interface DockerCommandPlugin

All Known Implementing Classes:

DeviceResourceDockerRuntimePluginImpl, NvidiaDockerV1CommandPlugin, NvidiaDockerV2CommandPlugin

public interface DockerCommandPlugin

Interface to make different resource plugins (e.g. GPU) can update docker run command without adding logic to Docker runtime.

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.
void	updateDockerRunCommand(DockerRunCommand dockerRunCommand, Container container)	Update docker run command

Method Details

updateDockerRunCommand

void updateDockerRunCommand(DockerRunCommand dockerRunCommand,
 Container container)
                     throws ContainerExecutionException

Update docker run command

Parameters:

dockerRunCommand - docker run command

container - NM container

Throws:

ContainerExecutionException - if any issue occurs

getCreateDockerVolumeCommand

DockerVolumeCommand getCreateDockerVolumeCommand(Container container)
                                          throws ContainerExecutionException

Create volume when needed.

Parameters:

container - container

Returns:

DockerVolumeCommand to create volume

Throws:

ContainerExecutionException - when any issue happens

getCleanupDockerVolumesCommand

DockerVolumeCommand getCleanupDockerVolumesCommand(Container container)
                                            throws ContainerExecutionException

Cleanup volumes created for one docker container

Parameters:

container - container

Returns:

DockerVolumeCommand to remove volume

Throws:

ContainerExecutionException - when any issue happens