birdhousebuilder.recipe.docker 0.2.0

******************************
birdhousebuilder.recipe.docker
******************************

.. contents::

Introduction
************

``birdhousebuilder.recipe.docker`` is a `Buildout`_ recipe to generate a `Dockerfile`_ for `Birdhouse`_ applications.

Birdhousebuilder recipes are used to build Web Processing Service components of the Birdhouse project. All Birdhousebuilder recipes need an existing `Anaconda`_ installation.

.. _`Buildout`: http://buildout.org/
.. _`Anaconda`: http://continuum.io/
.. _`Dockerfile`: https://www.docker.com/
.. _`Birdhouse`: http://bird-house.github.io/

Usage
*****

The recipe requires that Anaconda is already installed. It assumes that Anaconda is installed at the default location in your home directory ``~/anaconda``. Otherwise you need to set the Buildout option ``anaconda-home``.

The recipe will generate a Dockerfile for your application. You can find the Dockerfile in the root folder of the application.

The recipe depends on ``birdhousebuilder.recipe.conda``.

Supported options
=================

This recipe supports the following options:

``anaconda-home``
Buildout option with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.

``image-name``
The docker image name. Default is ``ubuntu``.

``image-version``
The docker image version. Default is ``latest``.

``maintainer``
The name of the maintainer.

Example usage
=============

The following example ``buildout.cfg`` generates a Dockerfile for Ubuntu 14.04::

[buildout]
parts = docker

anaconda-home = /home/myself/anaconda

[docker]
recipe = birdhousebuilder.recipe.docker
image-name = ubuntu
image-version = 14.04
maintainer = Generated by MyApp





Authors
*******

Carsten Ehbrecht ehbrecht at dkrz.de

Changes
*******

0.2.0 (2015-03-16)
==================

* Updated Dockerfile template for birdhouse environments.

0.1.1 (2014-11-13)
==================

* Updated Dockerfile template
starts only supervisord.
* Fixed example in Readme.

0.1.0 (2014-11-05)
==================

* Initial Release.