org.eclipse.kura.container.orchestration

Interface ContainerOrchestrationService

@ProviderType
public interface ContainerOrchestrationService

Interface for managing the container lifecycle and interacting with the container manager daemon.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
void	deleteContainer(java.lang.String id) Deletes a container identified by the specified ID
void	deleteImage(java.lang.String imageId) Deletes Image from container engine.
java.util.Optional<java.lang.String>	getContainerIdByName(java.lang.String name) Returns the id of the container corresponding to the specified name.
java.util.List<ContainerInstanceDescriptor>	listContainerDescriptors() Lists all available containers returning the corresponding ContainerInstanceDescriptors
java.util.List<java.lang.String>	listContainersIds() Lists all available containers by id only, like running the cli command 'docker ps -a'
java.util.List<ImageInstanceDescriptor>	listImageInstanceDescriptors() Lists all available images, returning the corresponding ImageInstanceDescriptors
void	pullImage(ImageConfiguration imageConfig) Allows to pull the required image, using the specified tag and credentials.
void	pullImage(java.lang.String imageName, java.lang.String imageTag, int timeOutSeconds, java.util.Optional<RegistryCredentials> registryCredentials) Allows to pull the required image, using the specified tag and credentials.
void	registerListener(ContainerOrchestrationServiceListener dockerListener) Adds a new ContainerOrchestrationServiceListener
java.lang.String	startContainer(ContainerConfiguration containerConfiguration) Starts a container identified by the values provided in a not null ContainerConfiguration object.
void	startContainer(java.lang.String id) Starts a container identified by the specified ID
void	stopContainer(java.lang.String id) Stops a container identified by the specified ID
void	unregisterListener(ContainerOrchestrationServiceListener dockerListener) Removes the ContainerOrchestrationServiceListener specified as parameter

Method Detail

listContainersIds

java.util.List<java.lang.String> listContainersIds()

Lists all available containers by id only, like running the cli command 'docker ps -a'

Returns:

a list of string objects representing the container IDs

listContainerDescriptors

java.util.List<ContainerInstanceDescriptor> listContainerDescriptors()

Lists all available containers returning the corresponding ContainerInstanceDescriptors

Returns:

a list of ContainerInstanceDescriptors representing the available containers

listImageInstanceDescriptors

java.util.List<ImageInstanceDescriptor> listImageInstanceDescriptors()

Lists all available images, returning the corresponding ImageInstanceDescriptors

Returns:

a list of ContainerInstanceDescriptors representing the available containers

Since:

2.4

deleteImage

void deleteImage(java.lang.String imageId)
          throws KuraException

Deletes Image from container engine. Takes ImageID String as parameter. Will throw an error if image is being used by a container.

Parameters:

imageId - string parameter that identifies the image to be deleted

Throws:

KuraException - if the image is used by a container or if the image deletion process fails

Since:

2.4

pullImage

void pullImage(ImageConfiguration imageConfig)
        throws KuraException,
               java.lang.InterruptedException

Allows to pull the required image, using the specified tag and credentials. The image will be downloaded respecting the configured timeout in seconds.

Parameters:

imageConfig - an ImageConfiguration object which contains info such as image name, tag, pull timeout in seconds and registry credentials.

Throws:

KuraException - if the pull operation fails

java.lang.InterruptedException

Since:

2.4

pullImage

void pullImage(java.lang.String imageName,
               java.lang.String imageTag,
               int timeOutSeconds,
               java.util.Optional<RegistryCredentials> registryCredentials)
        throws KuraException,
               java.lang.InterruptedException

Allows to pull the required image, using the specified tag and credentials. The image will be downloaded respecting the configured timeout in seconds.

Parameters:

imageName - the image name to be used. Must not be null.

imageTag - a string representing the image tag. Must not be null.

timeOutSeconds - a non negative integer representing the image download timeout in seconds

registryCredentials - an optional that can contain the registry URL and credentials for authentication

Throws:

KuraException - if the pull operation fails

java.lang.InterruptedException

getContainerIdByName

java.util.Optional<java.lang.String> getContainerIdByName(java.lang.String name)

Returns the id of the container corresponding to the specified name. If no container can be found an Optional#empty( result is returned.

Parameters:

name - the string representing the container name. Must not be null

Returns:

an Optional value that will contain the container ID, if the container exists. Otherwise and Optional.empty()

startContainer

java.lang.String startContainer(ContainerConfiguration containerConfiguration)
                         throws KuraException,
                                java.lang.InterruptedException

Starts a container identified by the values provided in a not null ContainerConfiguration object. If the requested image does not exists, it will be downloaded. A String representing the container ID will be returned if the operation of container creation and start succeed.

Parameters:

containerConfiguration -

Returns:

a String representing the container ID created

Throws:

KuraException - is thrown if the image pull or container creation and start fail

java.lang.InterruptedException

startContainer

void startContainer(java.lang.String id)
             throws KuraException

Starts a container identified by the specified ID

Parameters:

id - the ID of an already existing container. Must not be null

Throws:

KuraException - if the container starting fails

stopContainer

void stopContainer(java.lang.String id)
            throws KuraException

Stops a container identified by the specified ID

Parameters:

id - the ID of an already existing container. Must not be null

Throws:

KuraException - if the container stopping fails

deleteContainer

void deleteContainer(java.lang.String id)
              throws KuraException

Deletes a container identified by the specified ID

Parameters:

id - the ID of an already existing container. Must not be null

Throws:

KuraException - if the container removal fails

registerListener

void registerListener(ContainerOrchestrationServiceListener dockerListener)

Adds a new ContainerOrchestrationServiceListener

Parameters:

dockerListener -

containerName -

unregisterListener

void unregisterListener(ContainerOrchestrationServiceListener dockerListener)

Removes the ContainerOrchestrationServiceListener specified as parameter

Parameters:

dockerListener -