zuul-jobs/roles/build-docker-image/common.rst

This is one of a collection of roles 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: Stage the images on dockerhub.
• :zuulpromote-docker-image: Promote previously uploaded images.

The :zuulbuild-docker-image role is designed to be used in check and gate pipelines and simply builds the images. It can be used to verify that the build functions, or it can be followed by the use of subsequent roles to upload the images to Docker Hub.

The :zuulupload-docker-image role uploads the images to Docker Hub, but only with a single tag corresponding to the change ID. This role is designed to be used in a job 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 role 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 the :zuulbuild-docker-image.docker_images.context. 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.

Use the :zuulinstall-docker role to install Docker before using this role.

Role Variables