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

Class ContainerLaunch

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Integer>

Direct Known Subclasses:

ContainerRelaunch, RecoveredContainerLaunch, RecoverPausedContainerLaunch

public class ContainerLaunch
extends java.lang.Object
implements java.util.concurrent.Callable<java.lang.Integer>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContainerLaunch.ShellScriptBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected Application	app
protected java.util.concurrent.atomic.AtomicBoolean	completed
protected Container	container
static java.lang.String	CONTAINER_PRE_LAUNCH_STDERR
static java.lang.String	CONTAINER_PRE_LAUNCH_STDOUT
static java.lang.String	CONTAINER_SCRIPT
protected java.util.concurrent.atomic.AtomicBoolean	containerAlreadyLaunched
protected LocalDirsHandlerService	dirsHandler
protected org.apache.hadoop.yarn.event.Dispatcher	dispatcher
protected ContainerExecutor	exec
static java.lang.String	FINAL_CONTAINER_TOKENS_FILE
static java.lang.String	KEYSTORE_FILE
protected org.apache.hadoop.fs.Path	pidFilePath
protected java.util.concurrent.atomic.AtomicBoolean	shouldPauseContainer
static java.lang.String	SYSFS_DIR
static java.lang.String	TRUSTSTORE_FILE

Constructor Summary

Constructors

Constructor	Description
ContainerLaunch(Context context, org.apache.hadoop.conf.Configuration configuration, org.apache.hadoop.yarn.event.Dispatcher dispatcher, ContainerExecutor exec, Application app, Container container, LocalDirsHandlerService dirsHandler, ContainerManagerImpl containerManager)

Method Summary

Modifier and Type	Method	Description
void	addConfigsToEnv(java.util.Map<java.lang.String,java.lang.String> environment)	There are some configurations (such as "yarn.nodemanager.admin-env") whose values need to be added to the environment variables.
java.lang.Integer	call()
protected void	cleanupContainerFiles(org.apache.hadoop.fs.Path containerWorkDir)	Clean up container's files for container relaunch or cleanup.
static java.lang.String	expandEnvironment(java.lang.String var, org.apache.hadoop.fs.Path containerLogDir)
protected java.util.List<java.lang.String>	getApplicationLocalDirs(java.util.List<java.lang.String> localDirs, java.lang.String appIdStr)
protected java.util.List<java.lang.String>	getContainerLocalDirs(java.util.List<java.lang.String> localDirs)
protected java.util.List<java.lang.String>	getContainerLogDirs(java.util.List<java.lang.String> logDirs)
protected java.lang.String	getContainerPrivateDir(java.lang.String appIdStr, java.lang.String containerIdStr)
protected org.apache.hadoop.fs.Path	getContainerWorkDir()
static java.lang.String	getExitCodeFile(java.lang.String pidFile)
protected java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>>	getLocalizedResources()
protected java.util.List<java.lang.String>	getNMFilecacheDirs(java.util.List<java.lang.String> localDirs)
protected java.lang.String	getPidFileSubpath(java.lang.String appIdStr, java.lang.String containerIdStr)
static java.lang.String	getRelativeContainerLogDir(java.lang.String appIdStr, java.lang.String containerIdStr)
protected java.util.List<java.lang.String>	getUserFilecacheDirs(java.util.List<java.lang.String> localDirs)
protected java.util.List<java.lang.String>	getUserLocalDirs(java.util.List<java.lang.String> localDirs)
protected void	handleContainerExitCode(int exitCode, org.apache.hadoop.fs.Path containerLogDir)
protected void	handleContainerExitWithFailure(org.apache.hadoop.yarn.api.records.ContainerId containerID, int ret, org.apache.hadoop.fs.Path containerLogDir, java.lang.StringBuilder diagnosticInfo)	Tries to tail and fetch TAIL_SIZE_IN_BYTES of data from the error log.
protected int	launchContainer(ContainerStartContext ctx)
void	pauseContainer()	Pause the container.
protected int	prepareForLaunch(ContainerStartContext ctx)
protected int	relaunchContainer(ContainerStartContext ctx)
void	resumeContainer()	Resume the container.
void	sanitizeEnv(java.util.Map<java.lang.String,java.lang.String> environment, org.apache.hadoop.fs.Path pwd, java.util.List<org.apache.hadoop.fs.Path> appDirs, java.util.List<java.lang.String> userLocalDirs, java.util.List<java.lang.String> containerLogDirs, java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>> resources, org.apache.hadoop.fs.Path nmPrivateClasspathJarDir, java.util.Set<java.lang.String> nmVars)
protected void	setContainerCompletedStatus(int exitCode)
void	signalContainer(org.apache.hadoop.yarn.api.records.SignalContainerCommand command)	Send a signal to the container.
static ContainerExecutor.Signal	translateCommandToSignal(org.apache.hadoop.yarn.api.records.SignalContainerCommand command)
protected boolean	validateContainerState()

Methods inherited from class java.lang.Object

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

Field Detail

CONTAINER_PRE_LAUNCH_STDOUT

public static final java.lang.String CONTAINER_PRE_LAUNCH_STDOUT

See Also:

Constant Field Values

CONTAINER_PRE_LAUNCH_STDERR

public static final java.lang.String CONTAINER_PRE_LAUNCH_STDERR

See Also:

Constant Field Values

CONTAINER_SCRIPT

public static final java.lang.String CONTAINER_SCRIPT

FINAL_CONTAINER_TOKENS_FILE

public static final java.lang.String FINAL_CONTAINER_TOKENS_FILE

See Also:

Constant Field Values

SYSFS_DIR

public static final java.lang.String SYSFS_DIR

See Also:

Constant Field Values

KEYSTORE_FILE

public static final java.lang.String KEYSTORE_FILE

See Also:

Constant Field Values

TRUSTSTORE_FILE

public static final java.lang.String TRUSTSTORE_FILE

See Also:

Constant Field Values

dispatcher

protected final org.apache.hadoop.yarn.event.Dispatcher dispatcher

exec

protected final ContainerExecutor exec

app

protected final Application app

container

protected final Container container

containerAlreadyLaunched

protected java.util.concurrent.atomic.AtomicBoolean containerAlreadyLaunched

shouldPauseContainer

protected java.util.concurrent.atomic.AtomicBoolean shouldPauseContainer

completed

protected java.util.concurrent.atomic.AtomicBoolean completed

pidFilePath

protected org.apache.hadoop.fs.Path pidFilePath

dirsHandler

protected final LocalDirsHandlerService dirsHandler

Constructor Detail

ContainerLaunch

public ContainerLaunch(Context context,
                       org.apache.hadoop.conf.Configuration configuration,
                       org.apache.hadoop.yarn.event.Dispatcher dispatcher,
                       ContainerExecutor exec,
                       Application app,
                       Container container,
                       LocalDirsHandlerService dirsHandler,
                       ContainerManagerImpl containerManager)

Method Detail

expandEnvironment

@VisibleForTesting
public static java.lang.String expandEnvironment(java.lang.String var,
                                                 org.apache.hadoop.fs.Path containerLogDir)

call

public java.lang.Integer call()

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Integer>

validateContainerState

protected boolean validateContainerState()

getContainerLogDirs

protected java.util.List<java.lang.String> getContainerLogDirs(java.util.List<java.lang.String> logDirs)

getContainerLocalDirs

protected java.util.List<java.lang.String> getContainerLocalDirs(java.util.List<java.lang.String> localDirs)

getUserLocalDirs

protected java.util.List<java.lang.String> getUserLocalDirs(java.util.List<java.lang.String> localDirs)

getNMFilecacheDirs

protected java.util.List<java.lang.String> getNMFilecacheDirs(java.util.List<java.lang.String> localDirs)

getUserFilecacheDirs

protected java.util.List<java.lang.String> getUserFilecacheDirs(java.util.List<java.lang.String> localDirs)

getApplicationLocalDirs

protected java.util.List<java.lang.String> getApplicationLocalDirs(java.util.List<java.lang.String> localDirs,
                                                                   java.lang.String appIdStr)

getLocalizedResources

protected java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>> getLocalizedResources()
                                                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

launchContainer

protected int launchContainer(ContainerStartContext ctx)
                       throws java.io.IOException,
                              org.apache.hadoop.yarn.exceptions.ConfigurationException

Throws:

java.io.IOException

org.apache.hadoop.yarn.exceptions.ConfigurationException

relaunchContainer

protected int relaunchContainer(ContainerStartContext ctx)
                         throws java.io.IOException,
                                org.apache.hadoop.yarn.exceptions.ConfigurationException

Throws:

java.io.IOException

org.apache.hadoop.yarn.exceptions.ConfigurationException

prepareForLaunch

protected int prepareForLaunch(ContainerStartContext ctx)
                        throws java.io.IOException

Throws:

java.io.IOException

setContainerCompletedStatus

protected void setContainerCompletedStatus(int exitCode)

handleContainerExitCode

protected void handleContainerExitCode(int exitCode,
                                       org.apache.hadoop.fs.Path containerLogDir)

handleContainerExitWithFailure

protected void handleContainerExitWithFailure(org.apache.hadoop.yarn.api.records.ContainerId containerID,
                                              int ret,
                                              org.apache.hadoop.fs.Path containerLogDir,
                                              java.lang.StringBuilder diagnosticInfo)

Tries to tail and fetch TAIL_SIZE_IN_BYTES of data from the error log. ErrorLog filename is not fixed and depends upon app, hence file name pattern is used.

Parameters:

containerID -

ret -

containerLogDir -

diagnosticInfo -

getPidFileSubpath

protected java.lang.String getPidFileSubpath(java.lang.String appIdStr,
                                             java.lang.String containerIdStr)

signalContainer

public void signalContainer(org.apache.hadoop.yarn.api.records.SignalContainerCommand command)
                     throws java.io.IOException

Send a signal to the container.

Throws:

java.io.IOException

translateCommandToSignal

@VisibleForTesting
public static ContainerExecutor.Signal translateCommandToSignal(org.apache.hadoop.yarn.api.records.SignalContainerCommand command)

pauseContainer

public void pauseContainer()
                    throws java.io.IOException

Pause the container. Cancels the launch if the container isn't launched yet. Otherwise asks the executor to pause the container.

Throws:

java.io.IOException - in case of errors.

resumeContainer

public void resumeContainer()
                     throws java.io.IOException

Resume the container. Cancels the launch if the container isn't launched yet. Otherwise asks the executor to pause the container.

Throws:

java.io.IOException - in case of error.

getRelativeContainerLogDir

public static java.lang.String getRelativeContainerLogDir(java.lang.String appIdStr,
                                                          java.lang.String containerIdStr)

getContainerPrivateDir

protected java.lang.String getContainerPrivateDir(java.lang.String appIdStr,
                                                  java.lang.String containerIdStr)

sanitizeEnv

public void sanitizeEnv(java.util.Map<java.lang.String,java.lang.String> environment,
                        org.apache.hadoop.fs.Path pwd,
                        java.util.List<org.apache.hadoop.fs.Path> appDirs,
                        java.util.List<java.lang.String> userLocalDirs,
                        java.util.List<java.lang.String> containerLogDirs,
                        java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>> resources,
                        org.apache.hadoop.fs.Path nmPrivateClasspathJarDir,
                        java.util.Set<java.lang.String> nmVars)
                 throws java.io.IOException

Throws:

java.io.IOException

addConfigsToEnv

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

There are some configurations (such as "yarn.nodemanager.admin-env") whose values need to be added to the environment variables.

Parameters:

environment - The environment variables map to add the configuration values to.

getExitCodeFile

public static java.lang.String getExitCodeFile(java.lang.String pidFile)

getContainerWorkDir

protected org.apache.hadoop.fs.Path getContainerWorkDir()
                                                 throws java.io.IOException

Throws:

java.io.IOException

cleanupContainerFiles

protected void cleanupContainerFiles(org.apache.hadoop.fs.Path containerWorkDir)

Clean up container's files for container relaunch or cleanup.