Dockerator

Dockerator is a tool for configuring and managing Docker containers. You can easily have a common configuration for all containers, containers with the same image or for a specific container. Overloading of parameters is supported and starting / stopping / reloading containers from an initscript or by command line is also made possible by dockerator.

Containers configuration

1. Same configuration for all containers (dockerator.yml):

general:
  action_start: reload
  action_stop: remove
  cid_file: '/run/dockerator/%(DOCKER_NAME)s.cid'
  container_enable: true
  container_restart: always
  docker_url: 'tcp://127.0.0.1:2375'
  #scale:
  #  min: 2
  #  max: 6
  #  host: 0.0.0.0
  #  port: 8000
init:
  action_start: start
  action_stop: kill
  container_enable: false
environment:
  TZ: Europe/Paris
hosts:
  'example.org': 93.184.216.34
volumes:
  '/var/log/dockerator/docker/%(DOCKER_NAME)s/':
    destination: /var/log/
    mode: rw
  '/var/run/mysqld/':
    destination: /var/run/mysqld/
    mode: rw
ivolumes:
   '/home/foo/':
    destination: /var/www/bar/
    mode: ro

2. Common configuration for containers with the same image (e.g.: image.d/php-fpm_5.6.yml):

general:
  host_ip: 127.0.0.1
  container_port: 9000
  image: 'docker-registry.example.org/php-fpm:5.6'
ivolumes:
  '/etc/dockerator/%(DOCKER_NAME)s/config/php_conf.d/*':
    destination: /etc/php5/fpm/conf.d/
    mode: ro
    glob: true
  '/etc/dockerator/%(DOCKER_NAME)s/config/fpm_pool.d/':
    destination: /etc/php5/fpm/pool.d/
    mode: rw
  '/srv/php-fpm/%(DOCKER_NAME)s': '/var/run/php-fpm'

3. Configuration for a specific container (e.g.: conf.d/foobar.yml):

general:
  name: fpm_foobar
  image_cfg_file: 'php-fpm_5.6.yml'
  host_port: 9004
environment:
  PHP_USER_UID: 10000
  PHP_USER_GID: 10000
ports:
  '%(container_port)s': '0.0.0.0:%(host_port)s'
  '%(container_port)s': '%(host_ip)s:8080'
volumes:
  '/var/www/foobar.com/': '/var/www/foobar.com/'

Actually, there are four variables that you can use in configuration files:

• DOCKER_NAME (e.g. fpm_foobar)
• container_port (e.g. 9000)
• host_ip (e.g. 127.0.0.1)
• host_port (e.g. 9004)

Dockerator command line

Usage: dockerator [options] [action]

Options:
  -h, --help            show this help message and exit
  -a ACTION             Choice action on one or many containers: create, kill,
                        list, monit, pull, reload, remove, remove-image,
                        restart, run, start, state, stats, status, stop, top
  -c CONFFILE           Use configuration file <conffile> instead of
                        /etc/dockerator/dockerator.yml
  --configs-dir=CONFSDIR
                        Use configuration directory <confsdir> instead of
                        /etc/dockerator/conf.d
  --docker-url=DOCKERURL
                        Use a specific Docker server
  -f                    Force
  --image-name=IMGNAME  Choice container by image
  --image-configs-dir=IMGCONFSDIR
                        Use configuration directory <imgconfsdir> for images
                        instead of /etc/dockerator/image.d
  -n NAME               Choice container by name
  --logfile=LOGFILE     Use log file <logfile> instead of
                        /var/log/dockerator/dockerator.log
  -l LOGLEVEL           Emit traces with LOGLEVEL details, must be one of:
                        critical, error, warning, info, debug
  --rsc=RESOURCE        Resource information: mem_usage, mem_limit,
                        mem_percent, cpu_percent, io_read, io_write, net_tx,
                        net_rx (only available with actions monit and stats)
  --scale=SCALE         Scaling container (value must be auto or container
                        name, e.g.: auto:1 or foo:2)

Actions:

create:

• All containers:

$ dockerator create

• Containers by image name:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 create

• Container by name:

$ dockerator -n fpm_foobar create

kill:

• All containers:

$ dockerator kill

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 kill

• Container by name:

$ dockerator -n fpm_foobar kill

list:

• All containers:

$ dockerator list

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 list

monit:

Return the value by the return code for cpu_percent and mem_percent otherwise print the value.

• All containers:

$ dockerator monit

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 monit

• Container by name:

$ dockerator -n fpm_foobar monit

• Container by name with ressource memory usage:

$ dockerator -n fpm_foobar monit --rsc=mem_percent

pull:

• All images configured:

$ dockerator pull

• This image configured:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 pull

• Image configured for this container:

$ dockerator -n fpm_foobar pull

• All images configured:

$ dockerator --docker-url=tcp://10.10.10.10:2375 pull

• This image for this server:

$ dockerator --docker-url=tcp://10.10.10.10:2375 --image-name=docker-registry.example.org/php-fpm:5.6 pull

• This image for all configured servers:

$ dockerator -f --image-name=docker-registry.example.org/php-fpm:5.6 pull

reload (stop -> remove -> create -> start):

• All containers:

$ dockerator reload

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 reload

• Container by name:

$ dockerator -n fpm_foobar reload

remove:

• All containers:

$ dockerator remove

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 remove

• Container by name:

$ dockerator -n fpm_foobar remove

remove_image:

• All images configured:

$ dockerator remove_image

• This image configured:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 remove_image

• Image configured for this container:

$ dockerator -n fpm_foobar remove_image

• All images configured:

$ dockerator --docker-url=tcp://10.10.10.10:2375 remove_image

• This image for this server:

$ dockerator --docker-url=tcp://10.10.10.10:2375 --image-name=docker-registry.example.org/php-fpm:5.6 pull

• This image for all configured servers:

$ dockerator -f --image-name=docker-registry.example.org/php-fpm:5.6 pull

restart (stop -> start):

• All containers:

$ dockerator restart

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 restart

• Container by name:

$ dockerator -n fpm_foobar restart

run (create -> start):

• All containers:

$ dockerator run

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 run

• Container by name:

$ dockerator -n fpm_foobar run

• Scaling 2 containers by name:

$ dockerator -n fpm_foobar --scale=auto:2

start:

• All containers:

$ dockerator start

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 start

• Container by name:

$ dockerator -n fpm_foobar start

state:

• All containers:

$ dockerator state

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 state

• Container by name:

$ dockerator -n fpm_foobar state

stats:

• All containers:

$ dockerator stats

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 stats

• Container by name:

$ dockerator -n fpm_foobar stats

• Container by name with ressource memory usage:

$ dockerator -n fpm_foobar stats --rsc=mem_usage

• Container by name with ressources memory percent and cpu percent:

$ dockerator -n fpm_foobar stats --rsc=mem_percent --rsc=cpu_percent

status:

• All containers:

$ dockerator status

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 status

• Container by name:

$ dockerator -n fpm_foobar status

stop:

• All containers:

$ dockerator stop

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 stop

• Container by name:

$ dockerator -n fpm_foobar stop

top:

• All containers:

$ dockerator top

• Containers by image:

$ dockerator --image-name=docker-registry.example.org/php-fpm:5.6 top

• Container by name:

$ dockerator -n fpm_foobar state

Installation

python setup.py install

Requirements

• python2.7
• bitmath
• docker-py 1.6.0
• pyyaml

License

Dockerator is licensed under the Apache License, Version 2.0 - see the LICENSE for details