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

Interface ContainerRuntime

All Known Subinterfaces:

LinuxContainerRuntime

All Known Implementing Classes:

DefaultLinuxContainerRuntime, DelegatingLinuxContainerRuntime, DockerLinuxContainerRuntime

@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface ContainerRuntime

An abstraction for various container runtime implementations. Examples include Process Tree, Docker, Appc runtimes etc. These implementations are meant for low-level OS container support - dependencies on higher-level node mananger constructs should be avoided.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getIpAndHost(Container container) Return the host and ip of the container
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	signalContainer(ContainerRuntimeContext ctx) Signal a container.
boolean	useWhitelistEnv(Map<String,String> env) Whether to propagate the whitelist of environment variables from the nodemanager environment into the container environment.

Method Detail

prepareContainer

void prepareContainer(ContainerRuntimeContext ctx)
                      throws ContainerExecutionException

Prepare a container to be ready for launch.

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while preparing the container

launchContainer

void launchContainer(ContainerRuntimeContext ctx)
                     throws ContainerExecutionException

Launch a container.

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while launching the container

signalContainer

void signalContainer(ContainerRuntimeContext ctx)
                     throws ContainerExecutionException

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

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while signaling the container

reapContainer

void reapContainer(ContainerRuntimeContext ctx)
                   throws ContainerExecutionException

Perform any container cleanup that may be required.

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while reaping the container

getIpAndHost

String[] getIpAndHost(Container container)
                      throws ContainerExecutionException

Return the host and ip of the container

Parameters:

container - the Container

Throws:

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

useWhitelistEnv

boolean useWhitelistEnv(Map<String,String> env)

Whether to propagate the whitelist of environment variables from the nodemanager environment into the container environment.

Parameters:

env - the container's environment variables

Returns:

true if whitelist variables should be propagated, false otherwise

See Also:

YarnConfiguration.NM_ENV_WHITELIST