Skip to content

Latest commit

 

History

History
122 lines (96 loc) · 6.69 KB

README.md

File metadata and controls

122 lines (96 loc) · 6.69 KB
Raw

Compose Updater

A solution for watching your Docker® containers running via Docker Compose for image updates and automatically restarting the compositions whenever an image is refreshed.

Overview

Compose Updater is an application which continuously monitors your running docker containers. When an image is updated, the updated version gets pulled (or built via --pull) from the registry and the docker compose composition gets restarted (via down and up -d).

Compose Updater is useful for your when you're using image tags which are updated regularly (such as image:latest or a specific major version like image:v3).

Currently, Compose Updater doesn't help you when your're using image tags that won't change (such as an unchangable SemVer, i.e. image:1.2.3). It won't update your Docker Compose files to use newer image tags.

Usage

1. Prepare your services

You'll need to add two labels to the services you want to watch:

version: '3'
services:
  web:
    image: nginx:alpine
    labels:
      - "docker-compose-watcher.watch=1"
      - "docker-compose-watcher.dir=/home/docker/dir"

docker-compose-watcher.watch=1 exposes the service to Compose Updater.

docker-compose-watcher.dir specifies the path to the directory where this docker-compose.yml lives. If the file is not named docker-compose.yml, you can instead use the label docker-compose-watcher.file to specify the correct path and file name. This is necessary because it's not possible to find the docker-compose.yml from a running container.

2. Run Compose Updater

Run Docker Compose Watcher using compose:

version: '3'
services:
  watcher:
    image: virtualzone/compose-updater
    restart: always
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
      - "/home/docker:/home/docker:ro"
    environment:
      INTERVAL: 60

It's important to mount /var/run/docker.sock and the directory your compose files reside in (/home/docker in the example above).

If the registry you're pulling from require authentification, you could mount ~/.docker/config.json from the host inside the watcher service. Assuming your host user is called ubuntu, adding this line to the volumes declaration of the watcher service should work :

volumes:
  # Mount repository configuration (including http(s) settings and credentials) from the host to the container (assuming the host user is called ubuntu)
  - "/home/ubuntu/.docker/config.json:/root/.docker/config.json:ro"

Note: You'll only need one Compose Updater instance for all your compose services (not one per docker-compose.yml).

Settings

Configure Compose Updater via environment variables (recommended) or command line arguments:

Env Param Default Meaning
INTERVAL -interval 60 Minutes between checks
CLEANUP -cleanup 0 Run docker system prune -a -f after each run
ONCE -once 0 Run once and exit
PRINT_SETTINGS  -printSettings 1 Print settings on start
UPDATE_LOG -updateLog '' Log file for updates and restarts
BUILD -build 0 Build the image of a service with "build:" section in YAML file every run
MQTT_BROKER -mqttBroker '' MQTT Broker address (i.e. tcp://127.0.0.1:1883)
MQTT_CLIENT_ID -mqttClientId composeupdater MQTT Client ID
MQTT_TOPIC_PREFIX -mqttTopicPrefix composeupdater MQTT Topic Prefix
MQTT_USERNAME -mqttUsername '' MQTT Username
MQTT_PASSWORD -mqttPassword '' MQTT Password

Connecting an MQTT Broker

You can connect Compose Updater to an MQTT Broker (such as Eclispe Mosquitto or HiveMQ). This way, the actions of each run (i.e. image pulls, composition restarts) are published to an MQTT topic. You can use these informations to send push notifications using a solution like mqttwarn or Home Assistant.

To connect to an MQTT broker, specify the required connection parameters in the settings (see above).

Compose Updater published the following topics:

Topic Corresponding event Example content
update On update run start and done 'start' or 'done'
update/composition/start On start checking for updates for a specific Docker Composition YAML File Path
update/composition/restart/dry On skipping composition restart due to dry-run YAML File Path
update/composition/restart/skip On skipping composition restart due to no updated found YAML File Path
update/composition/restart/start On restarting a composition {"composeFile": "/path/to/docker-compose.yml", "services":[{"name": "service1", "image": "image:tag"}]}
update/composition/restart/done On finished restarting a composition {"composeFile": "/path/to/docker-compose.yml", "services":[{"name": "service1", "image": "image:tag"}]}
update/composition/service/built On service's image built {"composeFile": "/path/to/docker-compose.yml", "services":[{"name": "service1", "image": "image:tag"}]}
update/composition/service/pulled On service's image pulled {"composeFile": "/path/to/docker-compose.yml", "services":[{"name": "service1", "image": "image:tag"}]}

Push notification example

The following Home Assistant configuration sends a message via Telegram whenever a Docker composition has been restarted after updating at least one image:

automation:
  - alias: "Docker Compose Update"
    trigger:
      - platform: mqtt
        topic: "composeupdater/update/composition/restart/done"
        value_template: "{{ value_json.composeFile }}"
    action:
      - service: notify.telegram_bot
        data:
          message: "Docker images updated: {{ trigger.payload_json.composeFile }}"

Read more about how to set up the MQTT and Telegram integrations in Home Assistant.

License

GNU General Public License v3.0

Docker® is a trademark of Docker, Inc.

This project is not affiliated with Docker, Inc.