Docs

.dockerignore

@@ -6,4 +6,5 @@ __pycache__
 tests/
 requirements-dev.txt
 *.sh
-.coveragerc
+.coveragerc
+.travis.yml

README.md

@@ -6,6 +6,152 @@
 ![Docker Pulls](https://img.shields.io/docker/pulls/circa10a/ouroboros.svg?style=flat-square)
 [![](https://images.microbadger.com/badges/image/circa10a/ouroboros.svg)](https://microbadger.com/images/circa10a/ouroboros "Get your own image badge on microbadger.com")
 
-A python alternative to [watchtower](https://github.com/v2tec/watchtower)
-
 Automatically update your running Docker containers to the latest available image.
+
+A python-based alternative to [watchtower](https://github.com/v2tec/watchtower)
+
+## Overview
+
+Ouroboros will monitor all running docker containers or those you specify and update said containers to the latest available image in the remote registry using the `latest` tag with the same parameters that were used when the container was first created such as volume/bind mounts, docker network connections, environment variables, restart policies, entrypoints, commands, etc.
+
+- Push your image to your registry and simply wait a couple of minutes for ouroboros to find the new image and redeploy your container autonomously.
+- Limit your server ssh access
+- `ssh -i key server.domainname "docker pull ... && docker run ..."` is for scrubs
+
+## Usage
+
+`Ouroboros` is deployed via docker image like so:
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros
+```
+
+> By default, running containers will be polled every 5 min
+
+### Options
+
+> All arguments can be ran together without conflication
+
+```
+docker run --rm circa10a/ouroboros --help
+```
+
+- `--url`, `-u` Monitor and update containers on a remote system by providing the `url` argument. Default is `unix://var/run/docker.sock`
+- `--interval`, `-i` Change how often ouroboros checks the remote docker registry for image updates (in seconds). Default is `300`
+- `--monitor`, `-m` Only monitor select containers which supports an infinite amount of container names. Default is all containers.
+- `--loglevel`, `-l` The amount of logging details can be supressed or increased Default is `info`.
+- `--runonce`, `-r` Update all your running containers in one go and terminate ouroboros. Default is `False`.
+- `--cleanup`, `-c` Remove the older docker image if a new one is found and updated. Default is `False`.
+
+### Private Registries
+
+If your running containers' docker images are stored in a secure registry that requires a username and password, simply run ouroboros with 2 environment variables(`REPO_USER` and `REPO_PASS`).
+
+```bash
+docker run -d --name ouroboros \
+  -e REPO_USER=myUser -e REPO_PASS=myPassword \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros
+```
+
+## Examples
+
+### Update containers on a remote host
+
+Ouroboros can monitor things other than just local, pass the `--url` argument to update a system with the Docker API exposed.
+
+> Default is unix://var/run/docker.sock
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --url tcp://my-remote-docker-server:2375
+```
+
+### Change update frequency
+
+An `interval` argument can be supplied to change how often ouroboros checks the remote docker registry for image updates (in seconds).
+
+> Default is 300s
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --interval 600
+```
+
+### Monitor select containers
+
+By default, ouroboros will monitor all running docker containers, but can be overridden to only monitor select containers by passing a `monitor` argument which supports an infinite amount of container names.
+
+> Default is all
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --monitor containerA containerB containerC
+```
+
+### Change loglevel
+
+The amount of logging details can be supressed by providing a `loglevel` argument.
+
+> Default is info
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --loglevel debug
+```
+
+### Update all containers and quit ouroboros
+
+If you prefer ouroboros didn't run all the time and only update all of your running containers in one go, provide the `runonce` argument and ouroboros will terminate itself after updating all your containers one time.
+
+> Default is off
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --runonce true
+```
+
+### Remove old docker images
+
+Ouroboros has the option to remove the older docker image if a new one is found and the container is then updated. To tidy up after updates, pass the `cleanup` argument.
+
+> Default is off
+
+```bash
+docker run -d --name ouroboros \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  circa10a/ouroboros --cleanup true
+```
+
+## Execute Tests
+
+> Script will install dependencies from `requirements-dev.txt`
+
+All tests:
+
+```bash
+./run_tests.sh
+```
+
+Unit tests:
+
+```bash
+./run_tests.sh unit
+```
+
+Integration tests:
+
+```bash
+./run_tests.sh integration
+```
+
+## Contributing
+
+All welcome

deploy.sh

@@ -6,7 +6,7 @@ NAMESPACE=${USER}/${PROJECT}
 # Auth
 echo $docker_password | docker login -u=$USER --password-stdin
 # Latest
-docker build -t $NAMESPACE:latest .
+docker build --squash -t $NAMESPACE:latest .
 docker push $NAMESPACE:latest
 # Versioned
 docker tag $NAMESPACE:latest $NAMESPACE:$VERSION

ouroboros/__init__.py

@@ -1 +1 @@
-VERSION='0.0.1'
+VERSION='0.1.0'