salt.modules.dockercompose module¶

Introduction¶

This module allows to deal with docker-compose file in a directory.

This is a first version only, the following commands are missing at the moment but will be built later on if the community is interested in this module:

• run
• logs
• port
• scale

Installation Prerequisites¶

This execution module requires at least version 1.4.0 of both docker-compose and Docker. docker-compose can easily be installed using pip.install:

salt myminion pip.install docker-compose>=1.5.0

How to use this module?¶

In order to use the module if you have no docker-compose file on the server you can issue the command create, it takes two arguments the path where the docker-compose.yml will be stored and the content of this latter:

Then you can execute a list of method defined at the bottom with at least one argument (the path where the docker-compose.yml will be read) and an optional python list which corresponds to the services names:

Docker-compose method supported¶

• up
• restart
• stop
• start
• pause
• unpause
• kill
• rm
• ps
• pull
• build

Functions¶

• docker-compose.yml management

  • dockercompose.create
  • dockercompose.get

• Manage containers

  • dockercompose.restart
  • dockercompose.stop
  • dockercompose.pause
  • dockercompose.unpause
  • dockercompose.start
  • dockercompose.kill
  • dockercompose.rm
  • dockercompose.up

• Manage containers image:

  • dockercompose.pull
  • dockercompose.build

• Gather informations about containers:

  • dockercompose.ps

Detailed Function Documentation¶

salt.modules.dockercompose.build(path, service_names=None)¶

Build image for containers in the docker-compose file, service_names is a python list, if omitted build images for all containers. Please note that at the moment the module does not allow you to upload your Dockerfile, nor any other file you could need with your docker-compose.yml, you will have to make sure the files you need are actually in the directory sepcified in the build keyword

path

Path where the docker-compose file is stored on the server

service_names

If specified will pull only the image for the specified services

CLI Example:

salt myminion dockercompose.build /path/where/docker-compose/stored
salt myminion dockercompose.build /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.create(path, docker_compose)¶

Create and validate a docker-compose file into a directory

path

Path where the docker-compose file will be stored on the server

docker_compose

docker_compose file

CLI Example:

salt myminion dockercompose.create /path/where/docker-compose/stored content

salt.modules.dockercompose.get(path)¶

Get the content of the docker-compose file into a directory

path

Path where the docker-compose file is stored on the server

CLI Example:

salt myminion dockercompose.get /path/where/docker-compose/stored

salt.modules.dockercompose.kill(path, service_names=None)¶

Kill containers in the docker-compose file, service_names is a python list, if omitted kill all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will kill only the specified services

CLI Example:

salt myminion dockercompose.kill /path/where/docker-compose/stored
salt myminion dockercompose.kill /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.pause(path, service_names=None)¶

Pause running containers in the docker-compose file, service_names is a python list, if omitted pause all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will pause only the specified services

CLI Example:

salt myminion dockercompose.pause /path/where/docker-compose/stored
salt myminion dockercompose.pause /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.ps(path)¶

List all running containers and report some information about them

path

Path where the docker-compose file is stored on the server

CLI Example:

salt myminion dockercompose.ps /path/where/docker-compose/stored

salt.modules.dockercompose.pull(path, service_names=None)¶

Pull image for containers in the docker-compose file, service_names is a python list, if omitted pull all images

path

Path where the docker-compose file is stored on the server

service_names

If specified will pull only the image for the specified services

CLI Example:

salt myminion dockercompose.pull /path/where/docker-compose/stored
salt myminion dockercompose.pull /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.restart(path, service_names=None)¶

Restart container(s) in the docker-compose file, service_names is a python list, if omitted restart all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will restart only the specified services

CLI Example:

salt myminion dockercompose.restart /path/where/docker-compose/stored
salt myminion dockercompose.restart /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.rm(path, service_names=None)¶

Remove stopped containers in the docker-compose file, service_names is a python list, if omitted remove all stopped containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will remove only the specified stopped services

CLI Example:

salt myminion dockercompose.rm /path/where/docker-compose/stored
salt myminion dockercompose.rm /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.start(path, service_names=None)¶

Start containers in the docker-compose file, service_names is a python list, if omitted start all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will start only the specified services

CLI Example:

salt myminion dockercompose.start /path/where/docker-compose/stored
salt myminion dockercompose.start /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.stop(path, service_names=None)¶

Stop running containers in the docker-compose file, service_names is a python list, if omitted stop all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will stop only the specified services

CLI Example:

salt myminion dockercompose.stop /path/where/docker-compose/stored
salt myminion dockercompose.stop  /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.unpause(path, service_names=None)¶

Un-Pause containers in the docker-compose file, service_names is a python list, if omitted unpause all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will un-pause only the specified services

CLI Example:

salt myminion dockercompose.pause /path/where/docker-compose/stored
salt myminion dockercompose.pause /path/where/docker-compose/stored '[janus]'

salt.modules.dockercompose.up(path, service_names=None)¶

Create and start containers defined in the the docker-compose.yml file located in path, service_names is a python list, if omitted create and start all containers

path

Path where the docker-compose file is stored on the server

service_names

If specified will create and start only the specified services

CLI Example:

salt myminion dockercompose.up /path/where/docker-compose/stored
salt myminion dockercompose.up /path/where/docker-compose/stored '[janus]'