From a84583eed274328c4921c0e08c251a186749a6c0 Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Fri, 22 Mar 2019 14:49:10 -0700 Subject: [PATCH] Minor improvements to docker-image doc structure Add a local table of contents and adjust the outline so that it makes sennse. Change-Id: I10fab5eb05e5823b405f4efd410df0f66b58c537 --- doc/source/docker-image.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/source/docker-image.rst b/doc/source/docker-image.rst index 14cb24570..b149fb530 100644 --- a/doc/source/docker-image.rst +++ b/doc/source/docker-image.rst @@ -12,6 +12,9 @@ registry, and define local versions of the jobs to use it. The following sections describe how to define those jobs and how the system is intended to work once the jobs are defined. +.. contents:: + :local: + Run an Intermediate Container Registry -------------------------------------- @@ -52,6 +55,9 @@ as the htpassword file with a user and password already present. Once that service is running, create the following four jobs in a Zuul config-project: +Create Parent Jobs +------------------ + .. _yoursite-buildset-registry: yoursite-buildset-registry @@ -273,10 +279,13 @@ is started by a job running on a change. The "Image Build" and change. Essentially, these are image producer or consumer jobs respectively. +Using the Jobs +-------------- + There are two ways to use the jobs described above: A Repository with Producers and Consumers ------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The first is in a repository where images are both produced and consumed. In this case, we can expect that there will be at least one @@ -323,7 +332,7 @@ registry so that it will use the newly built version of any required images. A Repository with Only Producers --------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The second way to use these jobs is in a repository where an image is merely built, but not deployed. In this case, there are no consumers @@ -333,7 +342,7 @@ registry can be run on the job itself. In this case, you may omit the :ref:`yoursite-build-docker-image` job. Publishing an Image -------------------- +~~~~~~~~~~~~~~~~~~~ So far we've covered the image building process. This system also provides two more jobs that are used in publishing images to Docker