This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
docker-ci-deploy
================

`|PyPI| <https://pypi.python.org/pypi/docker-ci-deploy>`_ `|Build
Status| <https://travis-ci.org/praekeltfoundation/docker-ci-deploy>`_
`|codecov| <https://codecov.io/gh/praekeltfoundation/docker-ci-deploy>`_

A command-line tool to help generate tags and push Docker images to a
registry. Simplifies deployment of Docker images from CI services such
as Travis CI.

In a single command, ``docker-ci-deploy`` can: \* Change the tags on
images \* Add version information to image tags \* Add registry
addresses to image tags \* Login to a registry \* Push tags to a
registry

The best way to try out ``docker-ci-deploy`` is to give it a spin with
the ``--dry-run`` flag and observe all the ``docker`` commands that it
*would* invoke: \`\`\` > $ docker-ci-deploy --tag-version 2.7.13
--tag-semver --tag-latest
--registry registry:5000 --login 'janedoe:pa$$word' --dry-run
praekeltorg/alpine-python
praekeltorg/alpine-python:onbuild

docker tag praekeltorg/alpine-python
registry:5000/praekeltorg/alpine-python:2.7.13 docker tag
praekeltorg/alpine-python registry:5000/praekeltorg/alpine-python:2.7
docker tag praekeltorg/alpine-python
registry:5000/praekeltorg/alpine-python:2 docker tag
praekeltorg/alpine-python registry:5000/praekeltorg/alpine-python:latest
docker tag praekeltorg/alpine-python:onbuild
registry:5000/praekeltorg/alpine-python:2.7.13-onbuild docker tag
praekeltorg/alpine-python:onbuild
registry:5000/praekeltorg/alpine-python:2.7-onbuild docker tag
praekeltorg/alpine-python:onbuild
registry:5000/praekeltorg/alpine-python:2-onbuild docker tag
praekeltorg/alpine-python:onbuild
registry:5000/praekeltorg/alpine-python:onbuild docker login --username
janedoe --password registry:5000 docker push
registry:5000/praekeltorg/alpine-python:2.7.13 docker push
registry:5000/praekeltorg/alpine-python:2.7 docker push
registry:5000/praekeltorg/alpine-python:2 docker push
registry:5000/praekeltorg/alpine-python:latest docker push
registry:5000/praekeltorg/alpine-python:2.7.13-onbuild docker push
registry:5000/praekeltorg/alpine-python:2.7-onbuild docker push
registry:5000/praekeltorg/alpine-python:2-onbuild docker push
registry:5000/praekeltorg/alpine-python:onbuild \`\`\`

If you want to make your commands even shorter, the ``docker-ci-deploy``
command is also available as just ``dcd``, and most options have a short
form: \`\`\` > $ dcd -V 3.6.0 -S -L -r registry:5000 -l
'janedoe:pa$$word' --dry-run alpine-python

docker tag alpine-python registry:5000/alpine-python:3.6.0 docker tag
alpine-python registry:5000/alpine-python:3.6 docker tag alpine-python
registry:5000/alpine-python:3 docker tag alpine-python
registry:5000/alpine-python:latest docker login --username janedoe
--password registry:5000 docker push registry:5000/alpine-python:3.6.0
docker push registry:5000/alpine-python:3.6 docker push
registry:5000/alpine-python:3 docker push
registry:5000/alpine-python:latest \`\`\`

Use the ``-h``/``--help`` option to see all available options.

Installation
------------

::

pip install docker-ci-deploy==0.2.0

The script is self-contained and has no dependencies. It can be run by
simply executing the `main file <docker-ci-deploy/__main__.py>`_.

Usage
-----

The script can tag an existing image, login to a registry, and push the
tags to the registry, depending on what arguments are passed to it.

There is one required argument: the image to push.

Pushing an image
^^^^^^^^^^^^^^^^

::

docker-ci-deploy my-image:latest

This will simply push the image ``my-image:latest`` to the default
registry (https://hub.docker.com).

Logging in
^^^^^^^^^^

On a CI service you are unlikely to be logged in to the registry. You
can login using the ``--login`` parameter, which takes an argument of
the form ``<username>:<password>``.
``docker-ci-deploy --login 'janedoe:pa$$word' my-image:latest`` The
script will then login before pushing the image.

Tagging
^^^^^^^

\`\`\` docker-ci-deploy --login 'janedoe:pa$$word'
--tag alpine --tag $(git rev-parse --short HEAD) my-image:latest

\`\```This will result in the tags``my-image:alpine``and``my-image:eea981f``(for example) being created and pushed (**Note:** the original tag``my-image:latest\`
is *not* pushed).

Version tags
^^^^^^^^^^^^

``docker-ci-deploy --login 'janedoe:pa$$word' \ --tag alpine --tag-version 1.2.3 my-image``
This will result in the tag ``my-image:1.2.3-alpine`` being created and
pushed. If a version is already present in the start of a tag, it will
not be added. For example, in the above example if
``--tag 1.2.3-alpine`` were provided, the image would still be tagged
with ``1.2.3-alpine``, not ``1.2.3-1.2.3-alpine``.

You can also push the tags without the version information so that they
are considered the "latest" tag:
``docker-ci-deploy --tag-version 1.2.3 --tag-latest my-image`` This will
result in the tags ``my-image:1.2.3`` and ``my-image:latest`` being
pushed.

Semantic version tags
^^^^^^^^^^^^^^^^^^^^^

``docker-ci-deploy --tag alpine --tag-version 1.2.3 --tag-semver my-image``
This will result in the tags ``my-image:1.2.3-alpine``,
``my-image:1.2-alpine``, and ``my-image:1-alpine`` being created and
pushed. If part of the version is already present in the start of a tag,
it will not be added. For example, in the above example if
``--tag 1.2-alpine`` were provided, the image would still be tagged with
``1.2.3-alpine``, not ``1.2.3-1.2-alpine``.

This works by stripping pieces from the front of the version string
using the regex ``[.-]?\w+$``. This means that version strings with some
text in them are also supported. For example, a tag such as
``8.7.1-jessie`` will produce the tags/tag prefixes ``8.7.1-jessie``,
``8.7.1``, ``8.7``, and ``8``.

Note that this will **not** tag a version ``0``.

This can be used in combination with ``--tag-latest``.

Custom registry
^^^^^^^^^^^^^^^

``docker-ci-deploy --login 'janedoe:pa$$word' \ --tag alpine --tag $(git rev-parse --short HEAD) \ --registry my-registry.example.com:5000 \ my-image:latest``
This will result in the tags
``my-registry.example.com:5000/my-image:alpine`` and
``my-registry.example.com:5000/my-image:eea981f`` being created and
pushed. A login request will be made to
``my-registry.example.com:5000``.

**NOTE:** The reference grammar for Docker image tags (as of Docker
1.13.0) is not strict enough to distinguish between a registry address
and an image name component in all cases. For example, the tag
``praekeltorg/alpine-python`` could refer to the image with name
``alpine-python`` stored in the registry with hostname ``praekeltorg``
*or* it could be an image called ``praekeltorg/alpine-python`` stored in
the default registry. ``docker-ci-deploy`` will first just prepend the
registry address to the tag and only attempt to remove an existing
registry address from the tag if the new tag is invalid.

Multiple images
^^^^^^^^^^^^^^^

You can provide multiple images to ``docker-ci-deploy`` and it will tag
and push all of them:
``docker-ci-deploy --tag $(git rev-parse --short HEAD) my-image my-other-image``
This will result in the tags ``my-image:eea981f`` and
``my-other-image:eea981f`` being created and pushed.

Debugging
^^^^^^^^^

Use the ``--dry-run`` and ``--verbose`` parameters to see what the
script will do before you use it. For more help try
``docker-ci-deploy --help``.

Travis CI
---------

The script could be used in any CI service that provides access to the
standard Docker CLI but was developed with Travis in mind.

For Travis CI this config should get you started pushing images to
Docker Hub: \`\`\`yaml sudo: required services: - docker language:
python env: global: - DOCKER\_USER=janedoe - secret: #
DOCKER\_PASS=pa$$word

before\_install: - sudo apt-get update - sudo apt-get install -o
Dpkg::Options::="--force-confold" -y docker-engine - pip install
docker-ci-deploy

script: - docker build -t janedoe/my-image .

deploy: provider: script script: docker-ci-deploy --tag
:math:`(git rev-parse --short HEAD) --tag latest --login "`\ DOCKER\_USER:$DOCKER\_PASS"
janedoe/my-image \`\`\`

.. |PyPI| image:: https://img.shields.io/pypi/v/docker-ci-deploy.svg
.. |Build
Status| image:: https://travis-ci.org/praekeltfoundation/docker-ci-deploy.svg?branch=develop
.. |codecov| image:: https://codecov.io/gh/praekeltfoundation/docker-ci-deploy/branch/develop/graph/badge.svg
Release History

Release History

0.2.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
docker-ci-deploy-0.2.0.tar.gz (11.4 kB) Copy SHA256 Checksum SHA256 Source Feb 14, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting