zuul-jobs/playbooks/docker-image/README.rst

2.8 KiB

This is one of a collection of jobs which are designed to work together to build, upload, and promote docker images in a gating context:

  • :zuulbuild-docker-image: Build the images.
  • :zuulupload-docker-image: Build and stage the images on dockerhub.
  • :zuulpromote-docker-image: Promote previously uploaded images.

The :zuulbuild-docker-image job is designed to be used in a check pipeline and simply builds the images to verify that the build functions.

The :zuulupload-docker-image job builds and uploads the images to Docker Hub, but only with a single tag corresponding to the change ID. This job is designed in a gate pipeline so that the build produced by the gate is staged and can later be promoted to production if the change is successful.

The :zuulpromote-docker-image job is designed to be used in a promote pipeline. It requires no nodes and runs very quickly on the Zuul executor. It simply re-tags a previously uploaded image for a change with whatever tags are supplied by :zuulbuild-docker-image.docker_images.tags. It also removes the change ID tag from the repository in Docker Hub, and removes any similar change ID tags more than 24 hours old. This keeps the repository tidy in the case that gated changes fail to merge after uploading their staged images.

They all accept the same input data, principally a list of dictionaries representing the images to build. YAML anchors can be used to supply the same data to all three jobs.

Job Variables