org.hobbit.controller.docker

Class ContainerManagerImpl

java.lang.Object

org.hobbit.controller.docker.ContainerManagerImpl

All Implemented Interfaces:

ContainerManager

public class ContainerManagerImpl
extends Object
implements ContainerManager

Created by Timofey Ermilov on 31/08/16

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
private List<ContainerStateObserver>	containerObservers Observers that should be notified if a container terminates.
private static String	DEPLOY_ENV
private static String	DEPLOY_ENV_DEVELOP
static String	DEPLOY_ENV_KEY
private static String	DEPLOY_ENV_TESTING
private static Boolean	DOCKER_AUTOPULL
static String	DOCKER_AUTOPULL_ENV_KEY
private static long	DOCKER_IMAGE_PULL_MAX_WAITING_TIME
private static long	DOCKER_POLL_INTERVAL
private com.spotify.docker.client.DockerClient	dockerClient Docker client instance
private String	experimentId
private String	gelfAddress
private com.spotify.docker.client.messages.RegistryAuth	gitlabAuth Authentication configuration for accessing private repositories.
static String	HOBBIT_DOCKER_NETWORK Default network for new containers
private static org.slf4j.Logger	LOGGER
private static String	LOGGING_DRIVER_GELF
static String	LOGGING_GELF_ADDRESS_KEY
private static String	LOGGING_SEPARATOR Logging separator for type/experiment id.
static String	LOGGING_TAG Logging pattern.
static Set<String>	NEW_TASKS_STATES Task states which are considered as not running yet.
private com.spotify.docker.client.messages.RegistryAuth	nullAuth Empty authentication configuration.
private static Pattern	PORT_PATTERN
static String	REGISTRY_URL_KEY
static Set<String>	UNFINISHED_TASK_STATES Task states which are considered as not finished yet.
static String	USER_EMAIL_KEY
static String	USER_NAME_KEY
static String	USER_PASSWORD_KEY

Fields inherited from interface org.hobbit.controller.docker.ContainerManager

LABEL_PARENT, LABEL_TYPE

Constructor Summary

Constructors

Constructor and Description
ContainerManagerImpl() Constructor that creates new docker client instance

Method Summary

Modifier and Type	Method and Description
void	addContainerObserver(ContainerStateObserver containerObserver) Adds the given observer to the list of internal observers.
static boolean	containsVersionTag(String imageName)
private String	createContainer(String imageName, String containerType, String parentId, String[] env, String[] command) Creates new container using given image and assigns given type and parent
String	getContainerId(String name) Retrieves the container Id for the container with the given name or null if no such container could be found.
com.spotify.docker.client.messages.swarm.Task	getContainerInfo(String taskId) Returns container info
String	getContainerName(String containerId) Returns the name of the container with the given Id or null if such a container can not be found
List<com.spotify.docker.client.messages.swarm.Task>	getContainers(com.spotify.docker.client.messages.swarm.Task.Criteria criteria) Get a list of tasks which fulfill the given filter criteria.
private String	getInstanceName(String imageName) Generates new unique instance name based on image name
com.spotify.docker.client.messages.ContainerStats	getStats(String containerId) Returns statistics of the container with the given Id or null if the container can not be found or an error occurs.
void	pullImage(String imageName) Pulls the image with the given name.
void	removeContainer(String taskId) Removes the container with the given container Id.
void	removeParentAndChildren(String parentId) Removes the parent container and all its children given the parent id
String	startContainer(String imageName) Deprecated.
String	startContainer(String imageName, String[] command) Deprecated.
String	startContainer(String imageName, String type, String parent) Start container with given image, type and parent
String	startContainer(String imageName, String containerType, String parentId, String[] command) Starts the container with the given image name.
String	startContainer(String imageName, String containerType, String parentId, String[] env, String[] command) Starts the container with the given image name.
String	startContainer(String imageName, String containerType, String parentId, String[] env, String[] command, String experimentId) Starts the container with the given image name.
void	stopContainer(String containerId) Deprecated.
void	stopParentAndChildren(String parentId) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hobbit.controller.docker.ContainerManager

getContainers

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

DEPLOY_ENV_KEY

public static final String DEPLOY_ENV_KEY

See Also:

Constant Field Values

DOCKER_AUTOPULL_ENV_KEY

public static final String DOCKER_AUTOPULL_ENV_KEY

See Also:

Constant Field Values

LOGGING_GELF_ADDRESS_KEY

public static final String LOGGING_GELF_ADDRESS_KEY

See Also:

Constant Field Values

USER_NAME_KEY

public static final String USER_NAME_KEY

See Also:

Constant Field Values

USER_EMAIL_KEY

public static final String USER_EMAIL_KEY

See Also:

Constant Field Values

USER_PASSWORD_KEY

public static final String USER_PASSWORD_KEY

See Also:

Constant Field Values

REGISTRY_URL_KEY

public static final String REGISTRY_URL_KEY

See Also:

Constant Field Values

DEPLOY_ENV

private static final String DEPLOY_ENV

DEPLOY_ENV_TESTING

private static final String DEPLOY_ENV_TESTING

See Also:

Constant Field Values

DEPLOY_ENV_DEVELOP

private static final String DEPLOY_ENV_DEVELOP

See Also:

Constant Field Values

LOGGING_DRIVER_GELF

private static final String LOGGING_DRIVER_GELF

See Also:

Constant Field Values

PORT_PATTERN

private static final Pattern PORT_PATTERN

DOCKER_AUTOPULL

private static final Boolean DOCKER_AUTOPULL

DOCKER_POLL_INTERVAL

private static final long DOCKER_POLL_INTERVAL

See Also:

Constant Field Values

DOCKER_IMAGE_PULL_MAX_WAITING_TIME

private static final long DOCKER_IMAGE_PULL_MAX_WAITING_TIME

See Also:

Constant Field Values

HOBBIT_DOCKER_NETWORK

public static final String HOBBIT_DOCKER_NETWORK

Default network for new containers

See Also:

Constant Field Values

LOGGING_TAG

public static final String LOGGING_TAG

Logging pattern.

See Also:

Constant Field Values

NEW_TASKS_STATES

public static final Set<String> NEW_TASKS_STATES

Task states which are considered as not running yet.

UNFINISHED_TASK_STATES

public static final Set<String> UNFINISHED_TASK_STATES

Task states which are considered as not finished yet.

LOGGING_SEPARATOR

private static final String LOGGING_SEPARATOR

Logging separator for type/experiment id.

See Also:

Constant Field Values

dockerClient

private com.spotify.docker.client.DockerClient dockerClient

Docker client instance

gitlabAuth

private final com.spotify.docker.client.messages.RegistryAuth gitlabAuth

Authentication configuration for accessing private repositories.

nullAuth

private final com.spotify.docker.client.messages.RegistryAuth nullAuth

Empty authentication configuration. Docker client's createService() uses ConfigFileRegistryAuthSupplier by default (if auth is omitted) and warns about not being able to use it with swarm each time.

containerObservers

private List<ContainerStateObserver> containerObservers

Observers that should be notified if a container terminates.

gelfAddress

private String gelfAddress

experimentId

private String experimentId

Constructor Detail

ContainerManagerImpl

public ContainerManagerImpl()
                     throws Exception

Constructor that creates new docker client instance

Throws:

Exception

Method Detail

getInstanceName

private String getInstanceName(String imageName)

Generates new unique instance name based on image name

Parameters:

imageName - base image name

Returns:

instance name

pullImage

public void pullImage(String imageName)

Pulls the image with the given name.

Specified by:

pullImage in interface ContainerManager

Parameters:

imageName - the name of the image that should be pulled

createContainer

private String createContainer(String imageName,
                               String containerType,
                               String parentId,
                               String[] env,
                               String[] command)

Creates new container using given image and assigns given type and parent

Parameters:

imageName - image to use as base for container

containerType - container type

parentId - parent id

env - (optional) environment variables

command - (optional) command to be executed with image

Returns:

String the container Id or null if an error occurs

startContainer

@Deprecated
public String startContainer(String imageName)

Deprecated.

Description copied from interface: ContainerManager

Start container with container type Benchmark and no parent

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - Name of the image to start

Returns:

container id

startContainer

@Deprecated
public String startContainer(String imageName,
                                         String[] command)

Deprecated.

Description copied from interface: ContainerManager

Start container with container type Benchmark and no parent

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - name of the image to start

command - command to be executed

Returns:

container id

startContainer

public String startContainer(String imageName,
                             String type,
                             String parent)

Description copied from interface: ContainerManager

Start container with given image, type and parent

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - name of the image to start

type - container type

parent - parent id

Returns:

container id

startContainer

public String startContainer(String imageName,
                             String containerType,
                             String parentId,
                             String[] command)

Description copied from interface: ContainerManager

Starts the container with the given image name.

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

command - commands that should be executed

Returns:

container Id or null if an error occurred.

startContainer

public String startContainer(String imageName,
                             String containerType,
                             String parentId,
                             String[] env,
                             String[] command)

Description copied from interface: ContainerManager

Starts the container with the given image name.

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

env - environment variables of the schema "key=value"

command - commands that should be executed

Returns:

container Id or null if an error occurred.

startContainer

public String startContainer(String imageName,
                             String containerType,
                             String parentId,
                             String[] env,
                             String[] command,
                             String experimentId)

Description copied from interface: ContainerManager

Starts the container with the given image name.

Specified by:

startContainer in interface ContainerManager

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

env - environment variables of the schema "key=value"

command - commands that should be executed

experimentId - experimentId to add to GELF tag

Returns:

container Id or null if an error occurred.

removeContainer

public void removeContainer(String taskId)

Description copied from interface: ContainerManager

Removes the container with the given container Id.

Specified by:

removeContainer in interface ContainerManager

Parameters:

taskId - id of the container that should be removed

stopContainer

@Deprecated
public void stopContainer(String containerId)

Deprecated.

Description copied from interface: ContainerManager

Stops the container with the given container Id.

Specified by:

stopContainer in interface ContainerManager

Parameters:

containerId - id of the container that should be stopped

stopParentAndChildren

@Deprecated
public void stopParentAndChildren(String parentId)

Deprecated.

Description copied from interface: ContainerManager

Stops the parent container and all its children given the parent id

Specified by:

stopParentAndChildren in interface ContainerManager

Parameters:

parentId - id of the parent container

removeParentAndChildren

public void removeParentAndChildren(String parentId)

Description copied from interface: ContainerManager

Removes the parent container and all its children given the parent id

Specified by:

removeParentAndChildren in interface ContainerManager

Parameters:

parentId - id of the parent container

getContainerInfo

public com.spotify.docker.client.messages.swarm.Task getContainerInfo(String taskId)
                                                               throws InterruptedException,
                                                                      com.spotify.docker.client.exceptions.DockerException

Description copied from interface: ContainerManager

Returns container info

Specified by:

getContainerInfo in interface ContainerManager

Throws:

InterruptedException

com.spotify.docker.client.exceptions.DockerException

getContainers

public List<com.spotify.docker.client.messages.swarm.Task> getContainers(com.spotify.docker.client.messages.swarm.Task.Criteria criteria)

Description copied from interface: ContainerManager

Get a list of tasks which fulfill the given filter criteria.

Specified by:

getContainers in interface ContainerManager

getContainerId

public String getContainerId(String name)

Description copied from interface: ContainerManager

Retrieves the container Id for the container with the given name or null if no such container could be found.

Specified by:

getContainerId in interface ContainerManager

getContainerName

public String getContainerName(String containerId)

Description copied from interface: ContainerManager

Returns the name of the container with the given Id or null if such a container can not be found

Specified by:

getContainerName in interface ContainerManager

Parameters:

containerId - the Id of the container for which the name should be retrieved

Returns:

the name of the container with the given Id or null if such a container can not be found

addContainerObserver

public void addContainerObserver(ContainerStateObserver containerObserver)

Description copied from interface: ContainerManager

Adds the given observer to the list of internal observers.

Specified by:

addContainerObserver in interface ContainerManager

Parameters:

containerObserver - the observer that should be added to the internal list

containsVersionTag

public static boolean containsVersionTag(String imageName)

getStats

public com.spotify.docker.client.messages.ContainerStats getStats(String containerId)

Description copied from interface: ContainerManager

Returns statistics of the container with the given Id or null if the container can not be found or an error occurs.

Specified by:

getStats in interface ContainerManager

Parameters:

containerId - the Id of the container for which statistics should be requested

Returns:

statistics of the container with the given Id or null if the container can not be found or an error occurs.