Dockerfile generator
====================

This is a simple tool to generate `Dockerfile` files from YAML templates.

.. image:: much_files.jpg

Template
--------

TBD

Usage
-----

This tool is shipped as a Docker image registered as :code:`jboss/dogen`.
You can see the :code:`Dockerfile` for this image in the main directory
of the source distribution. This Docker image uses some conventions:

1. The **image template** that should be converted into :code:`Dockerfile` is expected to be
   available at :code:`/input/image.yaml`.
2. The output directory will be :code:`/output`.
3. The directory with (optional) scripts should be available at :code:`/scripts`.

Considering above you need to remember to mount appropriate volumes at the container
start. You are free to change the paths, but please remember to provide new locations
as part of the container's :code:`run` command instruction.

Examples
~~~~~~~~

For image without scripts to be added::

    docker run -it --rm -v PATH_TO_IMAGE_YAML:/input/image.yaml:z -v PATH_TO_TARGET_DIR:/output:z jboss/dogen:1.0.0

For image with scripts to be added::

    docker run -it --rm -v PATH_TO_SCRIPTS_DIR:/scripts:z -v PATH_TO_IMAGE_YAML:/input/image.yaml:z -v PATH_TO_TARGET_DIR:/output:z jboss/dogen:1.0.0


Dogen [dodʒen]
==============

This is a simple tool to generate `Dockerfile` files from YAML templates.

.. image:: much_files.jpg

Usage
-----

This tool is shipped as a Docker image registered as :code:`jboss/dogen`.
You can see the :code:`Dockerfile` for this image in the main directory
of the source distribution. This Docker image uses some conventions:

1. The **image template** that should be converted into :code:`Dockerfile` is expected to be
   available at :code:`/input/image.yaml`.
2. The output directory will be :code:`/output`.
3. The directory with (optional) scripts should be available at :code:`/scripts`.

Considering above you need to remember to mount appropriate volumes at the container
start. You are free to change the paths, but please remember to provide new locations
as part of the container's :code:`run` command instruction.

Examples
~~~~~~~~

For image without scripts to be added::

    docker run -it --rm -v PATH_TO_IMAGE_YAML:/input/image.yaml:z -v PATH_TO_TARGET_DIR:/output:z jboss/dogen:1.0.0

For image with scripts to be added::

    docker run -it --rm -v PATH_TO_SCRIPTS_DIR:/scripts:z -v PATH_TO_IMAGE_YAML:/input/image.yaml:z -v PATH_TO_TARGET_DIR:/output:z jboss/dogen:1.0.0


Make it clear how dogen is spelled
Make it clear how dogen is spelled
