docker_launch.launch

Start, watch and terminate distributed containers.

Most of launch functionalities involve network communications, so they are run concurrently in multi-threads.

class Containers(config_path)[source]

Bases: object

Parameters

config_path (Union[PathLike, str]) –

Return type

None

property config: Dict[Hashable, List[Dict[Literal['image', 'cmd', 'machine'], str]]]
start(**docker_run_kwargs)[source]
Return type

Dict[str, List[ContainerCollection]]

stop()[source]
Return type

None

remove()[source]
Return type

None

ping()[source]
Return type

Dict[str, List[ContainerCollection]]

watch()[source]
classmethod launch(config_path, **kwargs)[source]

Launch containers described in config_path.

Warning

To stop all the containers, press Ctrl+C. Killing the process will leave the launched containers unmanaged.

Parameters

config_path (Union[PathLike, str]) –

Return type

None

launch_containers(config_path, **kwargs)

Launch containers described in config_path.

Warning

To stop all the containers, press Ctrl+C. Killing the process will leave the launched containers unmanaged.

Parameters

config_path (Union[PathLike, str]) –

Return type

None

previous

docker_launch.exceptions

next

docker_launch.ssh