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

Class DelegatingLinuxContainerRuntime

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DelegatingLinuxContainerRuntime

All Implemented Interfaces:

LinuxContainerRuntime, ContainerRuntime

@Private
@Unstable
public class DelegatingLinuxContainerRuntime
extends java.lang.Object
implements LinuxContainerRuntime

This class is a ContainerRuntime implementation that delegates all operations to a DefaultLinuxContainerRuntime instance, a DockerLinuxContainerRuntime instance, a JavaSandboxLinuxContainerRuntime instance, or a custom instance depending on whether each instance believes the operation to be within its scope.

See Also:

LinuxContainerRuntime.isRuntimeRequested(java.util.Map<java.lang.String, java.lang.String>)

Constructor Summary

Constructors

Constructor	Description
DelegatingLinuxContainerRuntime()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair	execContainer(ContainerExecContext ctx)	Run a program in container.
java.lang.String	getExposedPorts(Container container)	Return the exposed ports of the container.
java.lang.String[]	getIpAndHost(Container container)	Return the host and ip of the container.
java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.LocalResource>	getLocalResources(Container container)
void	initialize(org.apache.hadoop.conf.Configuration conf, Context nmContext)	Initialize the runtime.
boolean	isRuntimeRequested(java.util.Map<java.lang.String,java.lang.String> env)	Return whether the given environment variables indicate that the operation is requesting this runtime.
void	launchContainer(ContainerRuntimeContext ctx)	Launch a container.
void	prepareContainer(ContainerRuntimeContext ctx)	Prepare a container to be ready for launch.
void	reapContainer(ContainerRuntimeContext ctx)	Perform any container cleanup that may be required.
void	relaunchContainer(ContainerRuntimeContext ctx)	Relaunch a container.
void	signalContainer(ContainerRuntimeContext ctx)	Signal a container.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingLinuxContainerRuntime

public DelegatingLinuxContainerRuntime()

Method Detail

initialize

public void initialize(org.apache.hadoop.conf.Configuration conf,
                       Context nmContext)
                throws ContainerExecutionException

Description copied from interface: LinuxContainerRuntime

Initialize the runtime.

Specified by:

initialize in interface LinuxContainerRuntime

Parameters:

conf - the Configuration to use

nmContext - NMContext

Throws:

ContainerExecutionException - if an error occurs while initializing the runtime

isRuntimeRequested

public boolean isRuntimeRequested(java.util.Map<java.lang.String,java.lang.String> env)

Description copied from interface: LinuxContainerRuntime

Return whether the given environment variables indicate that the operation is requesting this runtime.

Specified by:

isRuntimeRequested in interface LinuxContainerRuntime

Parameters:

env - the environment variable settings for the operation

Returns:

whether this runtime is requested

prepareContainer

public void prepareContainer(ContainerRuntimeContext ctx)
                      throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Prepare a container to be ready for launch.

Specified by:

prepareContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while preparing the container

launchContainer

public void launchContainer(ContainerRuntimeContext ctx)
                     throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Launch a container.

Specified by:

launchContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while launching the container

relaunchContainer

public void relaunchContainer(ContainerRuntimeContext ctx)
                       throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Relaunch a container.

Specified by:

relaunchContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while relaunching the container

signalContainer

public void signalContainer(ContainerRuntimeContext ctx)
                     throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Signal a container. Signals may be a request to terminate, a status check, etc.

Specified by:

signalContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while signaling the container

reapContainer

public void reapContainer(ContainerRuntimeContext ctx)
                   throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Perform any container cleanup that may be required.

Specified by:

reapContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while reaping the container

getIpAndHost

public java.lang.String[] getIpAndHost(Container container)
                                throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Return the host and ip of the container.

Specified by:

getIpAndHost in interface ContainerRuntime

Parameters:

container - the Container

Throws:

ContainerExecutionException - if an error occurs while getting the ip and hostname

getExposedPorts

public java.lang.String getExposedPorts(Container container)
                                 throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Return the exposed ports of the container.

Specified by:

getExposedPorts in interface ContainerRuntime

Parameters:

container - the Container

Returns:

List of exposed ports

Throws:

ContainerExecutionException - if an error occurs while getting the exposed ports

execContainer

public org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair execContainer(ContainerExecContext ctx)
                                                                        throws ContainerExecutionException

Description copied from interface: ContainerRuntime

Run a program in container.

Specified by:

execContainer in interface ContainerRuntime

Parameters:

ctx - the ContainerExecContext

Returns:

stdin and stdout of container exec

Throws:

ContainerExecutionException

getLocalResources

public java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.LocalResource> getLocalResources(Container container)
                                                                                                         throws java.io.IOException

Specified by:

getLocalResources in interface LinuxContainerRuntime

Throws:

java.io.IOException

start

public void start()

Specified by:

start in interface LinuxContainerRuntime

stop

public void stop()

Specified by:

stop in interface LinuxContainerRuntime