ebonite.ext.docker.runner module

exception ebonite.ext.docker.runner.DockerRunnerException

Bases: Exception

class ebonite.ext.docker.runner.DockerRunner

Bases: ebonite.build.runner.base.RunnerBase

RunnerBase implementation for docker containers

instance_exists(instance: ebonite.ext.docker.base.DockerContainer, env: ebonite.ext.docker.base.DockerEnv, **kwargs) → bool

Checks if instance exists in environment

Parameters:

• instance – instance params to check
• env – environment to check in

Returns:

boolean flag

remove_instance(instance: ebonite.ext.docker.base.DockerContainer, env: ebonite.ext.docker.base.DockerEnv, **kwargs)

Removes instance

Parameters:

• instance – instance params to remove
• env – environment to remove from

instance_type() → Type[ebonite.ext.docker.base.DockerContainer]

Returns:subtype of RuntimeInstance.Params supported by this runner

create_instance(name: str, port_mapping: Dict[int, int] = None, **kwargs) → ebonite.ext.docker.base.DockerContainer

Creates new runtime instance on given name and args

Parameters:name – name of instance to use Returns:created RuntimeInstance.Params subclass instance

run(instance: ebonite.ext.docker.base.DockerContainer, image: ebonite.ext.docker.base.DockerImage, env: ebonite.ext.docker.base.DockerEnv, rm=True, detach=True, **kwargs)

Runs given image on given environment with params given by instance

Parameters:

• instance – instance params to use for running
• image – image to base instance on
• env – environment to run on

logs(instance: ebonite.ext.docker.base.DockerContainer, env: ebonite.ext.docker.base.DockerEnv, **kwargs) → Generator[str, None, None]

Exposes logs produced by given instance while running on given environment

Parameters:

• instance – instance to expose logs for
• env – environment to expose logs from

Returns:

generator of log strings or string with logs

is_running(instance: ebonite.ext.docker.base.DockerContainer, env: ebonite.ext.docker.base.DockerEnv, **kwargs) → bool

Checks that given instance is running on given environment

Parameters:

• instance – instance to check running of
• env – environment to check running on

Returns:

“is running” flag

stop(instance: ebonite.ext.docker.base.DockerContainer, env: ebonite.ext.docker.base.DockerEnv, **kwargs)

Stops running of given instance on given environment

Parameters:

• instance – instance to stop running of
• env – environment to stop running on