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

Class DockerCommandExecutor

java.lang.Object

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

public final class DockerCommandExecutor
extends java.lang.Object

Utility class for executing common docker operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerCommandExecutor.DockerContainerStatus	Potential states that the docker status can return.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	executeDockerCommand(DockerCommand dockerCommand, java.lang.String containerId, java.util.Map<java.lang.String,java.lang.String> env, PrivilegedOperationExecutor privilegedOperationExecutor, boolean disableFailureLogging, Context nmContext)	Execute a docker command and return the output.
static DockerCommandExecutor.DockerContainerStatus	getContainerStatus(java.lang.String containerId, PrivilegedOperationExecutor privilegedOperationExecutor, Context nmContext)	Get the status of the docker container.
static boolean	isKillable(DockerCommandExecutor.DockerContainerStatus containerStatus)	Is the container in a killable state?
static boolean	isRemovable(DockerCommandExecutor.DockerContainerStatus containerStatus)	Is the container in a removable state?
static boolean	isStartable(DockerCommandExecutor.DockerContainerStatus containerStatus)	Is the container in a startable state?
static boolean	isStoppable(DockerCommandExecutor.DockerContainerStatus containerStatus)	Is the container in a stoppable state?
static DockerCommandExecutor.DockerContainerStatus	parseContainerStatus(java.lang.String containerStatusStr)	Parses the container status string.

Methods inherited from class java.lang.Object

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

Method Detail

executeDockerCommand

public static java.lang.String executeDockerCommand(DockerCommand dockerCommand,
                                                    java.lang.String containerId,
                                                    java.util.Map<java.lang.String,java.lang.String> env,
                                                    PrivilegedOperationExecutor privilegedOperationExecutor,
                                                    boolean disableFailureLogging,
                                                    Context nmContext)
                                             throws ContainerExecutionException

Execute a docker command and return the output.

Parameters:

dockerCommand - the docker command to run.

containerId - the id of the container.

env - environment for the container.

privilegedOperationExecutor - the privileged operations executor.

disableFailureLogging - disable logging for known rc failures.

Returns:

the output of the operation.

Throws:

ContainerExecutionException - if the operation fails.

getContainerStatus

public static DockerCommandExecutor.DockerContainerStatus getContainerStatus(java.lang.String containerId,
                                                                             PrivilegedOperationExecutor privilegedOperationExecutor,
                                                                             Context nmContext)

Get the status of the docker container. This runs a docker inspect to get the status. If the container no longer exists, docker inspect throws an exception and the nonexistent status is returned.

Parameters:

containerId - the id of the container.

privilegedOperationExecutor - the privileged operations executor.

Returns:

a DockerCommandExecutor.DockerContainerStatus representing the current status.

parseContainerStatus

public static DockerCommandExecutor.DockerContainerStatus parseContainerStatus(java.lang.String containerStatusStr)

Parses the container status string.

Parameters:

containerStatusStr - container status.

Returns:

a DockerCommandExecutor.DockerContainerStatus representing the status.

isStoppable

public static boolean isStoppable(DockerCommandExecutor.DockerContainerStatus containerStatus)

Is the container in a stoppable state?

Parameters:

containerStatus - the container's DockerCommandExecutor.DockerContainerStatus.

Returns:

is the container in a stoppable state.

isKillable

public static boolean isKillable(DockerCommandExecutor.DockerContainerStatus containerStatus)

Is the container in a killable state?

Parameters:

containerStatus - the container's DockerCommandExecutor.DockerContainerStatus.

Returns:

is the container in a killable state.

isRemovable

public static boolean isRemovable(DockerCommandExecutor.DockerContainerStatus containerStatus)

Is the container in a removable state?

Parameters:

containerStatus - the container's DockerCommandExecutor.DockerContainerStatus.

Returns:

is the container in a removable state.

isStartable

public static boolean isStartable(DockerCommandExecutor.DockerContainerStatus containerStatus)

Is the container in a startable state?

Parameters:

containerStatus - the container's DockerCommandExecutor.DockerContainerStatus.

Returns:

is the container in a startable state.