Package de.iip_ecosphere.platform.ecsRuntime.docker

Class DockerContainerManager

java.lang.Object

de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager<DockerContainerDescriptor>

de.iip_ecosphere.platform.ecsRuntime.docker.DockerContainerManager

All Implemented Interfaces:

de.iip_ecosphere.platform.ecsRuntime.ContainerManager, de.iip_ecosphere.platform.ecsRuntime.ContainerOperations

public class DockerContainerManager
extends de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager<DockerContainerDescriptor>

Implements a docker-based container manager for IIP-Ecosphere.

Author:

Monika Staciwa, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerContainerManager.FactoryDescriptor	Implements the factory descriptor for hooking the Docker container manager into the ECS factory.

Field Summary

Fields

Modifier and Type	Field	Description
private static DockerSetup	config
private static final de.iip_ecosphere.platform.support.logging.Logger	LOGGER

Fields inherited from interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations

EXC_ALREADY_KNOWN

Constructor Summary

Constructors

Constructor	Description
DockerContainerManager()

Method Summary

Modifier and Type	Method	Description
String	addContainer(URI location)
private void	configure(com.github.dockerjava.api.command.CreateContainerCmd cmd, int port, int port1, DockerContainerDescriptor container)	Configures the create container command.
private static com.github.dockerjava.api.model.AuthConfig	getAuthConfig(String authKey, String registry)	Tries to obtain an authentication config from IdentityStore.
String	getContainerSystemName()
String	getContainerSystemVersion()
com.github.dockerjava.api.DockerClient	getDockerClient()	Returns a Docker API Client.
String	getDockerId(String name)	Returns an id of a Docker container with a given name.
private String	getImageName(DockerContainerDescriptor desc)	Validates and returns the docker image file name.
String	getRuntimeName()
void	migrateContainer(String id, String resourceId)
void	startContainer(String id)
void	stopContainer(String id)
private String	tryPull(DockerSetup setup, com.github.dockerjava.api.DockerClient dockerClient, DockerContainerDescriptor container)	Tries to pull the container if a registry is given.
void	undeployContainer(String id)
void	updateContainer(String id, URI location)

Methods inherited from class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager

addContainer, checkId, getContainer, getContainer, getContainers, getId, getIds, getState, resolveUri, setState, throwExecutionException, throwExecutionException

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager

getVersion

Field Details

config

private static DockerSetup config

LOGGER

private static final de.iip_ecosphere.platform.support.logging.Logger LOGGER

Constructor Details

DockerContainerManager

public DockerContainerManager()

Method Details

getAuthConfig

private static com.github.dockerjava.api.model.AuthConfig getAuthConfig(String authKey,
 String registry)

Tries to obtain an authentication config from IdentityStore.

Parameters:

authKey - the authentication key, may be empty or null and is ignored then

registry - the registry to authenticate for

Returns:

the authentication config or null for none

tryPull

private String tryPull(DockerSetup setup,
 com.github.dockerjava.api.DockerClient dockerClient,
 DockerContainerDescriptor container)
                throws ExecutionException

Tries to pull the container if a registry is given.

Parameters:

setup - the docker setup

dockerClient - the docker client instance to use

container - the actual container to load/add/pull

Returns:

the container id if it was pulled/is there

Throws:

ExecutionException - if pulling the container failed

addContainer

public String addContainer(URI location)
                    throws ExecutionException

Throws:

ExecutionException

getImageName

private String getImageName(DockerContainerDescriptor desc)

Validates and returns the docker image file name.

Parameters:

desc - the descriptor to return the name from

Returns:

the image file name, potentially turned to lower cases

configure

private void configure(com.github.dockerjava.api.command.CreateContainerCmd cmd,
 int port,
 int port1,
 DockerContainerDescriptor container)

Configures the create container command.

Parameters:

cmd - the command instance

port - the port number for the AAS implementation server

port1 - the second optional port number for the AAS implementation server

container - the container descriptor

getDockerClient

public com.github.dockerjava.api.DockerClient getDockerClient()

Returns a Docker API Client. If there is not running Docker daemon on the host it returns null.

Returns:

DockerClient or null if no Docker daemon is running or if the docker dockerHost in the configuration setup cannot be applied, e.g., a Linux socket path on Windows

startContainer

public void startContainer(String id)
                    throws ExecutionException

Throws:

ExecutionException

stopContainer

public void stopContainer(String id)
                   throws ExecutionException

Throws:

ExecutionException

migrateContainer

public void migrateContainer(String id,
 String resourceId)
                      throws ExecutionException

Specified by:

migrateContainer in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations

Overrides:

migrateContainer in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager<DockerContainerDescriptor>

Throws:

ExecutionException

undeployContainer

public void undeployContainer(String id)
                       throws ExecutionException

Specified by:

undeployContainer in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations

Overrides:

undeployContainer in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager<DockerContainerDescriptor>

Throws:

ExecutionException

updateContainer

public void updateContainer(String id,
 URI location)
                     throws ExecutionException

Throws:

ExecutionException

getDockerId

public String getDockerId(String name)
                   throws ExecutionException

Returns an id of a Docker container with a given name.

Parameters:

name - container's name

Returns:

docker container id/NULL

Throws:

ExecutionException - if connecting to Docker API Client failed

getContainerSystemName

public String getContainerSystemName()

getRuntimeName

public String getRuntimeName()

getContainerSystemVersion

public String getContainerSystemVersion()