Skip to content

Commit

Permalink
pdal docker docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hobu committed Apr 5, 2017
1 parent 4e1e5f9 commit f09cf4e
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions doc/development/docker.rst
Expand Up @@ -9,16 +9,15 @@ PDAL's :ref:`repository <source>` is linked to `DockerHub`_ for automatic buildi
of `Docker`_ containers. PDAL keeps three Docker containers current.

* ``pdal/dependencies:latest`` -- PDAL's dependencies
* ``pdal/pdal:latest`` -- PDAL master, manually specified
* ``pdal/pdal:1.4`` -- PDAL maintenance, automatically generated
* ``pdal/pdal:latest`` -- PDAL master
* ``pdal/pdal:1.5`` -- PDAL maintenance branch




.. _`Docker`: https://www.docker.com/
.. _`DockerHub`: https://hub.docker.com/r/pdal/pdal/

.. figure:: ../images/docker-master-branch.png

.. note::

Expand All @@ -37,7 +36,7 @@ branch Docker containers. The dependencies container is also used during
:ref:`integration` testing by Travis. It is built using the
Dockerfile at https://github.com/PDAL/PDAL/blob/master/scripts/docker/dependencies/Dockerfile

The ``pdal/pdal:dependencies`` image is generated by force-pushing a tag
The ``pdal/dependencies:latest`` image is regenerated by force-pushing a tag
of the SHA you wish to use to have `DockerHub`_ build.

::
Expand All @@ -47,9 +46,8 @@ of the SHA you wish to use to have `DockerHub`_ build.

.. note::

The dependencies container is currently built upon
`Ubuntu Xenial`_. When the next Ubuntu LTS is released,
the PDAL project will likely move to it.
The dependencies container is currently built upon `Ubuntu Xenial`_. When
the next Ubuntu LTS is released, the PDAL project will likely move to it.

.. _`Ubuntu Xenial`: http://releases.ubuntu.com/16.04/

Expand Down Expand Up @@ -78,8 +76,18 @@ used for testing and verification of fixes, and it is recommended that users
looking to depend on PDAL's Docker containers always use known release
versions off of the last stable release branch.

::
.. warning::

git tag -f docker-master
You should be using the `Maintenance`_ Docker container for any
production-oriented operations. Only use the latest one to test
or prototype a latest, unreleased feature.

.. figure:: ../images/docker-master-branch.png

The ``pdal/pdal:latest`` branch is current relative to the
``docker-master`` branch in GitHub.

::

git push origin refs/tags/docker-master -f
$ git tag -f docker-master
$ git push origin refs/tags/docker-master -f

0 comments on commit f09cf4e

Please sign in to comment.