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

Interface ContainerRuntime

All Known Subinterfaces:

LinuxContainerRuntime

All Known Implementing Classes:

DefaultLinuxContainerRuntime, DelegatingLinuxContainerRuntime, DockerLinuxContainerRuntime, JavaSandboxLinuxContainerRuntime, OCIContainerRuntime, RuncContainerRuntime

@Private
@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 manager constructs should be avoided.

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.
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.

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

relaunchContainer

void relaunchContainer(ContainerRuntimeContext ctx)
                throws ContainerExecutionException

Relaunch a container.

Parameters:

ctx - the ContainerRuntimeContext

Throws:

ContainerExecutionException - if an error occurs while relaunching 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

execContainer

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

Run a program in container.

Parameters:

ctx - the ContainerExecContext

Returns:

stdin and stdout of container exec

Throws:

ContainerExecutionException

getIpAndHost

java.lang.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

getExposedPorts

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

Return the exposed ports of the container.

Parameters:

container - the Container

Returns:

List of exposed ports

Throws:

ContainerExecutionException - if an error occurs while getting the exposed ports