This role uses skopeo to perform image operations. Also update the container roles docs to add missing documentation for the already existing upload-container-image role. Clarify some ambiguity about the registry and repository attributes of the container images data structure. Change-Id: Ib66c85daf0edacf0dd797ab34b0d629f99c7111b Co-Authored-By: James E. Blair <jim@acmegating.com>
5.7 KiB
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:
- :zuul
build-docker-image
: Build the images. - :zuul
upload-docker-image
: Upload the images to Dockeer Hub. - :zuul
promote-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