Add docker image build jobs

These are generic docker image build and upload jobs which use
the recently added roles of the same names.  With the new
pass-to-parent feature, child jobs can add their own credentials
to these jobs.

Change-Id: I669a9e6616a031837adab8c5c5806431fcca2150
This commit is contained in:
James E. Blair 2019-01-21 13:33:01 -08:00
parent cb54c59577
commit 2b7689ba00
8 changed files with 148 additions and 4 deletions

View File

@ -0,0 +1,80 @@
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:
* :zuul:job:`build-docker-image`: Build the images.
* :zuul:job:`upload-docker-image`: Build and stage the images on dockerhub.
* :zuul:job:`promote-docker-image`: Promote previously uploaded images.
The :zuul:job:`build-docker-image` job is designed to be used in
a `check` pipeline and simply builds the images to verify that
the build functions.
The :zuul:job:`upload-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 :zuul:job:`promote-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
:zuul:jobvar:`build-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**
.. zuul:jobvar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The project directory. Serves as the base for
:zuul:jobvar:`build-docker-image.docker_images.context`.
.. zuul:jobvar:: docker_images
:type: list
A list of images to build. Each item in the list should have:
.. zuul:jobvar:: context
The docker build context; this should be a directory underneath
:zuul:jobvar:`build-docker-image.zuul_work_dir`.
.. zuul:jobvar:: repository
The name of the target repository in dockerhub for the
image. Supply this even if the image is not going to be
uploaded (it will be tagged with this in the local
registry).
.. zuul:jobvar:: path
Optional: the directory that should be passed to docker build.
Useful for building images with a Dockerfile in the context
directory but a source repository elsewhere.
.. zuul:jobvar:: build_args
:type: list
Optional: a list of values to pass to the docker ``--build-arg``
parameter.
.. zuul:jobvar:: target
Optional: the target for a multi-stage build.
.. zuul:jobvar:: tags
:type: list
:default: ['latest']
A list of tags to be added to the image when promoted.
.. _anchors: https://yaml.org/spec/1.2/spec.html#&%20anchor//

View File

@ -0,0 +1,22 @@
.. zuul:jobvar:: docker_credentials
:type: dict
This is expected to be a Zuul Secret with these keys:
.. zuul:jobvar:: username
The Docker Hub username.
.. zuul:jobvar:: password
The Docker Hub password.
.. zuul:jobvar:: repository
Optional; if supplied this is a regular expression which
restricts to what repositories the image may be uploaded. The
following example allows projects to upload images to
repositories within an organization based on their own names::
repository: "^myorgname/{{ zuul.project.short_name }}.*"

View File

@ -0,0 +1,3 @@
- hosts: all
roles:
- install-docker

View File

@ -0,0 +1,3 @@
- hosts: localhost
roles:
- promote-docker-image

View File

@ -0,0 +1,3 @@
- hosts: all
roles:
- build-docker-image

View File

@ -0,0 +1,3 @@
- hosts: all
roles:
- upload-docker-image

View File

@ -20,8 +20,8 @@ production if the change is successful.
The :zuul:role:`promote-docker-image` role is designed to be used in a The :zuul:role:`promote-docker-image` role is designed to be used in a
`promote` pipeline. It requires no nodes and runs very quickly on the `promote` pipeline. It requires no nodes and runs very quickly on the
Zuul executor. It simply re-tags a previously uploaded image for a Zuul executor. It simply re-tags a previously uploaded image for a
change with whatever tags are supplied by the change with whatever tags are supplied by
:zuul:rolevar:`build-docker-image.docker_images.context`. It also :zuul:rolevar:`build-docker-image.docker_images.tags`. It also
removes the change ID tag from the repository in Docker Hub, and 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 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 the repository tidy in the case that gated changes fail to merge after
@ -88,7 +88,7 @@ using this role.
Useful for building images with a Dockerfile in the context Useful for building images with a Dockerfile in the context
directory but a source repository elsewhere. directory but a source repository elsewhere.
.. zuul:jobvar:: build_args .. zuul:rolevar:: build_args
:type: list :type: list
Optional: a list of values to pass to the docker ``--build-arg`` Optional: a list of values to pass to the docker ``--build-arg``
@ -98,7 +98,7 @@ using this role.
Optional: the target for a multi-stage build. Optional: the target for a multi-stage build.
.. zuul:jobvar:: tags .. zuul:rolevar:: tags
:type: list :type: list
:default: ['latest'] :default: ['latest']

View File

@ -20,6 +20,36 @@
pre-run: playbooks/unittests/pre.yaml pre-run: playbooks/unittests/pre.yaml
post-run: playbooks/unittests/post.yaml post-run: playbooks/unittests/post.yaml
- job:
name: build-docker-image
description: |
Build a docker image.
.. include:: ../../playbooks/docker-image/README.rst
pre-run: playbooks/docker-image/pre.yaml
run: playbooks/docker-image/run.yaml
- job:
name: upload-docker-image
parent: build-docker-image
description: |
Build and upload a docker image.
.. include:: ../../playbooks/docker-image/README.rst
.. include:: ../../playbooks/docker-image/credentials.rst
post-run: playbooks/zuul/docker-image/upload.yaml
- job:
name: promote-docker-image
description: |
Retag a previously-uploaded docker image.
.. include:: ../../playbooks/docker-image/README.rst
.. include:: ../../playbooks/docker-image/credentials.rst
run: playbooks/zuul/build-image/promote.yaml
nodeset:
nodes: []
- job: - job:
name: tox name: tox
parent: unittests parent: unittests