Package org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker

Class DockerRunCommand

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker.DockerCommand

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker.DockerRunCommand

public class DockerRunCommand
extends DockerCommand

Constructor Summary

Constructors

Constructor	Description
DockerRunCommand(java.lang.String containerId, java.lang.String user, java.lang.String image)	The following are mandatory:

Method Summary

Modifier and Type	Method	Description
DockerRunCommand	addAllReadOnlyMountLocations(java.util.List<java.lang.String> paths)
DockerRunCommand	addAllReadWriteMountLocations(java.util.List<java.lang.String> paths)
DockerRunCommand	addDevice(java.lang.String sourceDevice, java.lang.String destinationDevice)
void	addEnv(java.util.Map<java.lang.String,java.lang.String> environment)	Add user defined environment variables.
DockerRunCommand	addMountLocation(java.lang.String sourcePath, java.lang.String destinationPath, java.lang.String mode)
DockerRunCommand	addPortsMapping(java.lang.String mapping)
DockerRunCommand	addReadOnlyMountLocation(java.lang.String sourcePath, java.lang.String destinationPath)
DockerRunCommand	addReadOnlyMountLocation(java.lang.String sourcePath, java.lang.String destinationPath, boolean createSource)
DockerRunCommand	addReadWriteMountLocation(java.lang.String sourcePath, java.lang.String destinationPath)
DockerRunCommand	addRuntime(java.lang.String runtime)
DockerRunCommand	addTmpfsMount(java.lang.String mount)
boolean	containsEnv()	Check if user defined environment variables are empty.
DockerRunCommand	detachOnRun()
DockerRunCommand	disableDetach()
DockerRunCommand	enableDetach()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getDockerCommandWithArguments()
java.util.Map<java.lang.String,java.lang.String>	getEnv()	Get user defined environment variables.
DockerRunCommand	groupAdd(java.lang.String[] groups)
DockerRunCommand	removeContainerOnExit()
DockerRunCommand	setCapabilities(java.util.Set<java.lang.String> capabilties)
DockerRunCommand	setCGroupParent(java.lang.String parentPath)
DockerRunCommand	setContainerWorkDir(java.lang.String workdir)
DockerRunCommand	setHostname(java.lang.String hostname)
DockerRunCommand	setLogDir(java.lang.String logDir)
DockerRunCommand	setNetworkType(java.lang.String type)
DockerRunCommand	setOverrideCommandWithArgs(java.util.List<java.lang.String> overrideCommandWithArgs)
DockerRunCommand	setOverrideDisabled(boolean toggle)
DockerRunCommand	setPidNamespace(java.lang.String type)
DockerRunCommand	setPrivileged()
DockerRunCommand	setServiceMode(boolean serviceMode)
DockerRunCommand	setVolumeDriver(java.lang.String volumeDriver)
DockerRunCommand	setYarnSysFS(boolean toggle)

Methods inherited from class org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker.DockerCommand

addCommandArguments, getCommandOption, preparePrivilegedOperation, setClientConfigDir, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerRunCommand

public DockerRunCommand(java.lang.String containerId,
                        java.lang.String user,
                        java.lang.String image)

The following are mandatory:

Method Detail

removeContainerOnExit

public DockerRunCommand removeContainerOnExit()

detachOnRun

public DockerRunCommand detachOnRun()

setContainerWorkDir

public DockerRunCommand setContainerWorkDir(java.lang.String workdir)

setNetworkType

public DockerRunCommand setNetworkType(java.lang.String type)

setPidNamespace

public DockerRunCommand setPidNamespace(java.lang.String type)

addMountLocation

public DockerRunCommand addMountLocation(java.lang.String sourcePath,
                                         java.lang.String destinationPath,
                                         java.lang.String mode)

addReadWriteMountLocation

public DockerRunCommand addReadWriteMountLocation(java.lang.String sourcePath,
                                                  java.lang.String destinationPath)

addAllReadWriteMountLocations

public DockerRunCommand addAllReadWriteMountLocations(java.util.List<java.lang.String> paths)

addReadOnlyMountLocation

public DockerRunCommand addReadOnlyMountLocation(java.lang.String sourcePath,
                                                 java.lang.String destinationPath,
                                                 boolean createSource)

addReadOnlyMountLocation

public DockerRunCommand addReadOnlyMountLocation(java.lang.String sourcePath,
                                                 java.lang.String destinationPath)

addAllReadOnlyMountLocations

public DockerRunCommand addAllReadOnlyMountLocations(java.util.List<java.lang.String> paths)

addTmpfsMount

public DockerRunCommand addTmpfsMount(java.lang.String mount)

setVolumeDriver

public DockerRunCommand setVolumeDriver(java.lang.String volumeDriver)

setCGroupParent

public DockerRunCommand setCGroupParent(java.lang.String parentPath)

setPrivileged

public DockerRunCommand setPrivileged()

setCapabilities

public DockerRunCommand setCapabilities(java.util.Set<java.lang.String> capabilties)

setHostname

public DockerRunCommand setHostname(java.lang.String hostname)

addDevice

public DockerRunCommand addDevice(java.lang.String sourceDevice,
                                  java.lang.String destinationDevice)

enableDetach

public DockerRunCommand enableDetach()

disableDetach

public DockerRunCommand disableDetach()

addPortsMapping

public DockerRunCommand addPortsMapping(java.lang.String mapping)

addRuntime

public DockerRunCommand addRuntime(java.lang.String runtime)

groupAdd

public DockerRunCommand groupAdd(java.lang.String[] groups)

setOverrideCommandWithArgs

public DockerRunCommand setOverrideCommandWithArgs(java.util.List<java.lang.String> overrideCommandWithArgs)

getDockerCommandWithArguments

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getDockerCommandWithArguments()

Overrides:

getDockerCommandWithArguments in class DockerCommand

setOverrideDisabled

public DockerRunCommand setOverrideDisabled(boolean toggle)

setLogDir

public DockerRunCommand setLogDir(java.lang.String logDir)

setServiceMode

public DockerRunCommand setServiceMode(boolean serviceMode)

containsEnv

public boolean containsEnv()

Check if user defined environment variables are empty.

Returns:

true if user defined environment variables are not empty.

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Get user defined environment variables.

Returns:

a map of user defined environment variables

addEnv

public final void addEnv(java.util.Map<java.lang.String,java.lang.String> environment)

Add user defined environment variables.

Parameters:

environment - A map of user defined environment variables

setYarnSysFS

public DockerRunCommand setYarnSysFS(boolean toggle)