Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 5.1 KB

README.md

File metadata and controls

113 lines (77 loc) · 5.1 KB
Raw

Shepherd for the Atsign swarms

Instructions

Edit

shepherd.yaml

Run

docker stack deploy --compose-file shepherd.yaml shepherd

Check the logs

docker service logs -f shepherd_shepherd

Sit back a relax and let shepherd update your secondaries...

Shepherd (original README)

Build Status Docker Stars Docker Pulls

A Docker swarm service for automatically updating your services whenever their base image is refreshed.

Usage

    docker service create --name shepherd \
                          --constraint "node.role==manager" \
                          --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock,ro \
                          mazzolino/shepherd

Or with docker-compose

    version: "3"
    services:
      ...
      shepherd:
        build: .
        image: mazzolino/shepherd
        volumes:
          - /var/run/docker.sock:/var/run/docker.sock
        deploy:
          placement:
            constraints:
            - node.role == manager

Configuration

Shepherd will try to update your services every 5 minutes by default. You can adjust this value using the SLEEP_TIME variable.

You can prevent services from being updated by appending them to the IGNORELIST_SERVICES variable. This should be a space-separated list of service names.

Alternatively you can specify a filter for the services you want updated using the FILTER_SERVICES variable. This can be anything accepted by the filtering flag in docker service ls.

You can set Shepherd to roll back a service to the previous version if the update fails by setting the ROLLBACK_ON_FAILURE variable.

You can enable private registry authentication by setting the WITH_REGISTRY_AUTH variable.

If you need to authenticate to a registry (for example in order to get around the Docker Hub rate limits), you can set the variable REGISTRY_USER and store the password either in a docker secret named shepherd_registry_password or in the environment variable REGISTRY_PASSWORD. If you are not using Docker Hub but a private registry, set REGISTRY_HOST to the hostname of your registry.

You can enable connection to insecure private registry by setting the WITH_INSECURE_REGISTRY variable.

You can force image deployment whatever the architecture by setting the WITH_NO_RESOLVE_IMAGE variable.

You can enable notifications on service update with apprise, using the apprise microservice and the APPRISE_SIDECAR_URL variable. See the file docker-compose.apprise.yml for an example.

You can enable old image autocleaning on service update by setting the IMAGE_AUTOCLEAN_LIMIT variable.

You can go faster by setting the DONT_WAIT variable so that Docker services converge behind the scenes.

You can enable one shot running with RUN_ONCE_AND_EXIT variable.

If you care about log entries having the right timezone, you can set the TZ variable to the correct value (make sure to not include quotation marks in the variable value).

Example:

docker service create --name shepherd \
                    --constraint "node.role==manager" \
                    --env SLEEP_TIME="5m" \
                    --env IGNORELIST_SERVICES="shepherd my-other-service" \
                    --env WITH_REGISTRY_AUTH="true" \
                    --env WITH_INSECURE_REGISTRY="true" \
                    --env WITH_NO_RESOLVE_IMAGE="true" \
                    --env FILTER_SERVICES="label=com.mydomain.autodeploy" \
                    --env APPRISE_SIDECAR_URL="apprise-microservice:5000" \
                    --env IMAGE_AUTOCLEAN_LIMIT="5" \
                    --env RUN_ONCE_AND_EXIT="true" \
                    --env ROLLBACK_ON_FAILURE="true" \
                    --env TZ=Europe/Berlin \
                    --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock,ro \
                    --mount type=bind,source=/root/.docker/config.json,target=/root/.docker/config.json,ro \
                    mazzolino/shepherd

How does it work?

Shepherd just triggers updates by updating the image specification for each service, removing the current digest.

Most of the work is thankfully done by Docker which resolves the image tag, checks the registry for a newer version and updates running container tasks as needed.

Also, Docker handles all the work of applying rolling updates. So at least with replicated services, there should be no noticeable downtime.