zuul/zuul-jobs
Code Issues Proposed changes
Files
f50d0b2248b6048c2fd1136570937c1c3b80d602
zuul-jobs/roles/build-docker-image/common.rst
Jan Gutter f50d0b2248 Make buildx builder image configurable 
* Some users might want to override this in an environment where the
  builder images are managed
* This adds the same configuration to the `docker-` and `container-`
  jobs and roles. Converting between them should follow the same pattern
as with the other job/role vars.

Change-Id: I72fd59c36452e4520d077b645fb7627ba6a5443c
2025-09-12 17:05:06 +01:00

5.7 KiB
Raw Blame History

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: Upload the images to Dockeer Hub.
  • :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. It can be used in one of two modes: by default it will upload with a single tag corresponding to the change ID. In this mode, the role 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 other mode allows for use of this job in a release pipeline to directly upload a release build with the final set of tags.

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 :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.

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

Role Variables