Merge pull request #9 from dnephin/add_container

Add install instructions to the README

.dockerignore

@@ -0,0 +1,4 @@
+.git
+.tox
+tox.ini
+dist

Dockerfile

@@ -0,0 +1,10 @@
+
+FROM    alpine:3.2
+MAINTAINER  Daniel Nephin <dnephin@gmail.com>
+
+RUN     apk add -U python py-pip
+ADD     requirements.txt /code/requirements.txt
+RUN     pip install -r /code/requirements.txt
+ADD     docker_custodian/ /code/docker_custodian/
+ADD     setup.py /code/
+RUN     pip install --no-deps -e /code

Makefile

@@ -2,6 +2,9 @@
 
 PACKAGE_VERSION = $(shell python setup.py --version)
 
+DOCKER_REPO ?= ${USER}
+BUILD_TAG ?= ${PACKAGE_VERSION}
+
 all: test
 
 clean:
@@ -16,3 +19,8 @@ test:
 	tox
 
 tests: test
+
+
+.PHONY: build
+build:
+	docker build -t ${DOCKER_REPO}/docker-custodian:${BUILD_TAG} .

README.rst

@@ -10,6 +10,43 @@ Keep docker hosts tidy.
 .. contents::
     :backlinks: none
 
+Install
+-------
+
+There are three installation options
+
+Container
+~~~~~~~~~
+
+.. code::
+
+    docker pull dnephin/docker-custodian
+    docker run -ti \
+        -v /var/run/docker.sock:/var/run/docker.sock \
+        dnephin/docker-custodian dcgc --help
+
+Debian/Ubuntu package
+~~~~~~~~~~~~~~~~~~~~~
+
+First build the package (requires `dh-virtualenv`)
+
+.. code:: sh
+
+    dpkg-buildpackage -us -uc
+
+Then install it
+
+.. code:: sh
+
+    dpkg -i ../docker-custodian_*.deb
+
+
+Source
+~~~~~~
+
+.. code:: sh
+
+    pip install git+https://github.com/Yelp/docker-custodian.git
 
 
 dcgc