dockerman package¶

Subpackages¶

dockerman.tests package

Submodules¶

dockerman.base module¶

dockerman.container module¶

Representation of a Docker container.

class dockerman.container.Container(image, [command, ]**kwargs)¶

Bases: syn.base.b.base.Base

Positional Arguments:

image: basestring: The image to run
command [Optional]: basestring: The command to be run in the container

Keyword-Only Arguments:

_status: ContainerStatus cpu_shares [Optional]: int

CPU shares (relative weight)

detach (default = False): bool: Detached mode
dns [Optional]: list (basestring): DNS name servers
domainname [Optional]: basestring: Custom DNS search domains
entrypoint [Optional]: basestring: Container entrypoint
environment [Optional]: dict (any => basestring): Environment variables to set in the container
hostname [Optional]: basestring: Optional hostname for the container
id [Optional]: basestring: The id of the running container
labels [Optional]: dict (any => basestring): A dictionary of name-value labels
mac_address [Optional]: basestring: MAC address to assign to the container
mem_limit [Optional]: float | basestring: Memory limit

memswap_limit [Optional]: int name: basestring

A name for the container

network_disabled (default = False): bool: Disable networking
ports [Optional]: list (int): A list of port numbers
stdin_open (default = False): bool: Keep STDIN open even if not attached
stop_signal [Optional]: basestring: The signal used to stop the container
tty (default = False): bool: Allocate a pseudo-TTY
user [Optional]: basestring | int: Username or UID
volume_driver [Optional]: basestring: The name of a volume driver/plugin
volumes [Optional]: list (basestring): Volume names
volumes_from [Optional]: list (basestring): List of container names or Ids to get volumes from
working_dir [Optional]: basestring: Path to working directory

Class Options:

args: (‘image’, ‘command’)
autodoc: True
coerce_args: True
id_equality: False
init_validate: True
make_hashable: False
make_type_object: True
optional_none: True
register_subclasses: False
repr_template:
coerce_hooks: ()
create_hooks: ()
init_hooks: ()
init_order: ()
metaclass_lookup: (‘coerce_hooks’, ‘init_hooks’, ‘create_hooks’, ‘setstate_hooks’)
setstate_hooks: ()

Groups:

_all: _status, command, cpu_shares, detach, dns, domainname, entrypoint, environment, hostname, id, image, labels, mac_address, mem_limit, memswap_limit, name, network_disabled, ports, stdin_open, stop_signal, tty, user, volume_driver, volumes, volumes_from, working_dir
run_args: command, cpu_shares, detach, dns, entrypoint, environment, hostname, image, labels, mac_address, mem_limit, memswap_limit, name, stdin_open, stop_signal, tty, user, volume_driver, volumes, volumes_from, working_dir
create_container: command, cpu_shares, detach, dns, domainname, entrypoint, environment, hostname, image, labels, mac_address, mem_limit, memswap_limit, name, network_disabled, ports, stdin_open, stop_signal, tty, user, volume_driver, volumes, volumes_from, working_dir
_internal: id

is_port_live(port)¶

marshal_args(group)¶

pause(**kwargs)¶

poll(port, **kwargs)¶

remove(**kwargs)¶

run(**kwargs)¶

start(**kwargs)¶

status¶

stop(**kwargs)¶

unpause(**kwargs)¶

class dockerman.container.ContainerStatus(**kwargs)¶