Building Docker Images

Building Docker Images #

Quantum nodes run as Swarm instances, which means that when you want to deploy an application, you’ll have to build Docker images first. Swarm doesn’t allow (or recommend) for building on the nodes as builds are not distributed and due to resource usage can have an impact on the availability of services running on your cluster.

The following guide uses docker commands, please do not use docker-compose build to create images.

There are a few things you should have & know in advance:

  • Docker installed and running
  • Do you have a private Docker registry?
  • Or is the code public?

Private registries #

Gitlab, Github, Docker Hub, or self-hosted — if neither of these options is for you, please get in touch as we offer a private registry for our customers as well.

For private registries, please get the full URL/name of your registry.

For example

To build an image, use the following commands:

$ docker login
# the following assumes a "Dockerfile" is in the same directory
$ docker build -t .
$ docker push

Public registries #

Release code and images as open-source? Great! Here are a few guidelines.

The most well-known options for public registries are:

In order to build an image, use the following commands:

# Docker Hub
$ docker login
$ docker build -t project/image:latest .
$ docker push project/image:latest

Or for

$ docker login
$ docker build -t .
$ docker push in particular provides integration with common SCMs and supports automatic building when you push a commit, branch or tag.

Always consider using CI to build your image. Repeatable builds are the best builds! We have a few notes on or Gitlab in our documentation.

Tips #

  • Better Docker images come with more tags than latest.
  • Keep semantic versioning in mind, you yourself and others will thank you in the future.

Tagging multiple versions #

latest is a standard, but also frowned upon. You may want to provide it for convenience, but also provide an anchor:

$ docker build -t project/image:latest -t project/image:1.1 .

As always, if you run into obstacles along the way — please get in touch with us!