Skip to main content

Yaml based way to build Docker images.

Project description

https://travis-ci.org/NLeSC/boatswain.svg?branch=master https://ci.appveyor.com/api/projects/status/5n7uj8ownch05e34/branch/master?svg=true https://api.codacy.com/project/badge/Grade/3271fedeb94b4d8ba24273d9cba0c852 https://zenodo.org/badge/80722427.svg

Boatswain

Boatswain is a simple build system for docker images.

It is especially usefull when you have multiple docker images that depend on each other.

Installation

Boatswain is a simple python script you can install with pip

$ pip install boatswain

Usage

Create a file called boatswain.yml for your project with the following syntax, which is heavily based on docker-compose.

version: 1.0                    # The version of the boatswain yaml
organisation: boatswain         # Your dockerhub organisation
images:
    image1:pytest:              # the key will be used to tag the image
        context: docker/image1  # The path of the dockerfile
    image2:pytest:
        context: docker/image2
        from: image1:pytest     # This image depends on the other image
    image3:pytest:
        context: docker/image3
        from: image2:pytest
    image4:pytest:
        context: docker/image4
        tag: image12:pytest     # This image will be tagged with this

Building

You can build the images defined in the boatswain file using the following command. This invokes the docker build process for each image in the order so the dependencies are built before the dependent image.

$ boatswain build

Cleaning

You can clean the images that are defined in the boatswain file.

$ boatswain clean

Pushing

You can push the built images to dockerhub using the push command. It will be pushed to organisation/imagetag on dockerhub.

$ boatswain push

Extra Options

-h

Display the options

-q, --quiet

Don’t display any output

-k, --keep_building

Keep building images even if an error occurs

--dryrun

Do not actually execute the command, just go through the motions

-b <boatswain_file>, --boatswain_file <boatswain_file>

Override the default boatswain file (boatswain.yml)

-f, --force

Force building the images, even if they already exist (only for build)

Debugging your build

When your build does not go the way you expected boatswain can display some more information by using:

-v

Verbose mode, displays a build progress for each image

-vv

Very verbose mode, displays the output of the docker build process

--debug

Debug mode, displays debug information of boatswain as well as the output of the docker build process

Change Log

This document records all notable changes to Boatswain.

This project adheres to Semantic Versioning.

1.0.4 * Updated dynamic string message to variable

1.0.3 * Added a non-zero exit code when a build fails * Added a build summary show succesful and non-succesfully built images * Added a keep-building (-k) command line argument * Building now stops at the first failed image by default

1.0.2 * Correct citation.cff file

1.0.1

  • Fixed some packaging things

1.0.0

  • Fixed help text of push command

  • Fixed extraction of image id from docker response in some cases

  • Windows compatibility

  • Appveyor windows tests are passing

0.7.0 (2017-04-03)

  • Added a ‘before’ and ‘command’ key to the build definition. This is a list of commands that need to be staged into the context directory.

  • Default verbosity only shows 1 progress bar for all images

  • Changed progress indication to full white block

0.6.0 (2017-03-09)

  • Added the tree command which will print the tree of the boatswain file

  • Added quiet and extra verbose modes

0.5.1 (2017-02-10)

  • Fixed issue with printing unicode text from the docker stream

0.5.0 (2017-02-10)

  • Implemented push command

  • Build will now greedily try to build images instead of throwing an exception at the first error.

  • Added error messages to failing builds

  • Standardized return values (e.g. always a list)

  • Refactored to reduce code duplication in boatswain class

0.4.0 (2017-02-09)

  • Progress timer now increases every second

  • Improved error reporting (No longer uses an exception)

0.3.0 (2017-02-08)

  • Added a whole bunch of tests

  • Added the clean command

  • Changed file layout from recursive to using from

0.2.0 (2017-02-06)

  • Added dry-run option

  • Added ability to build only one image

0.1.0 (2017-02-02)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boatswain-1.0.4.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

boatswain-1.0.4-py2.py3-none-any.whl (18.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file boatswain-1.0.4.tar.gz.

File metadata

  • Download URL: boatswain-1.0.4.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4

File hashes

Hashes for boatswain-1.0.4.tar.gz
Algorithm Hash digest
SHA256 a11ab910ebc1c24e5ede33913b93f21ddb1d06e523cf5473c655b529f863f623
MD5 e7ba0e2bfd406aca58221d772d0a2168
BLAKE2b-256 dac4d6bc02a4ca94b094ab2274a4d264dd13a45ab83a97b63f909847668615f4

See more details on using hashes here.

Provenance

File details

Details for the file boatswain-1.0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: boatswain-1.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4

File hashes

Hashes for boatswain-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f8603cee1191b23e5505b7dcb35bf3c6238aca504ecce5470225ccff74dd6af5
MD5 45736aca85ce6736169faa350ac2d22d
BLAKE2b-256 bf9dcbd14619be079784ed4785957120bc7b5e40488342de2aa96106264c5905

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page