docker-image-updater 0.0.1

Update docker images and trigger commands in response to updates

A utility to update docker images automatically. Supports execution of arbitrary commands when an image is updated, in order to restart running containers or trigger other custom behaviour.

Installation

Docker image updater can be installed from the Python Package Index using:

pip install docker-image-updater

Usage

usage: docker-image-updater [-h] [-f FILE] [--debug]

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  the config file to use
  --debug               show debug messages

Docker image updater requires a configuration file to specify which images to watch and what commands to execute. By default it will look for config.yml in the current directory.

Configuration format

Configuration is expressed through a YAML file such as the following:

config:
  docker:
    base_url: "unix://var/run/docker.sock"
    version: "1.16"
watch:
  my-app:
    images:
     - my-app
     - redis
    commands:
     - restart my-app

The item watch defines sets of images to watch. This is a dictionary where the keys (my-app in the example above) are arbitrary values for human reference. Under each of these keys a dictonary with the items images and commands is expected.

images defines a list of docker images to check for updates. You can specify these as image:tag or simply as image, in which case Docker will use the latest tag automatically.

commands defines a list of shell commands to execute whenever one of the listed images was updated. These will be run sequentially, in order.

All items under config.docker are passed to the Docker client. For supported options, refer to the docker-py documentation.

License

The MIT License (MIT)

Copyright (c) 2015 Nick Groenen <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.