From 88f0e2a4c786049ce0b411ff3dd469ddfafe4782 Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Mon, 23 Mar 2020 15:55:01 -0700 Subject: [PATCH] Add generate-zuul-manifest to quick-start We need this role in order for the new log browsing features in the web UI to work. Also, update the text to account for multiple log storage systems supported by zuul-jobs now. Change-Id: Ieb542bb80d46f487b8f49b51fd0de8de2e4f2708 --- .../zuul-config/playbooks/base/post-logs.yaml | 1 + doc/source/tutorials/quick-start.rst | 17 +++++++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/source/examples/zuul-config/playbooks/base/post-logs.yaml b/doc/source/examples/zuul-config/playbooks/base/post-logs.yaml index 2d287e0dfd..b920f04dac 100644 --- a/doc/source/examples/zuul-config/playbooks/base/post-logs.yaml +++ b/doc/source/examples/zuul-config/playbooks/base/post-logs.yaml @@ -1,5 +1,6 @@ - hosts: localhost gather_facts: False roles: + - generate-zuul-manifest - role: upload-logs zuul_log_url: "http://localhost:8000" diff --git a/doc/source/tutorials/quick-start.rst b/doc/source/tutorials/quick-start.rst index 4e843d477b..e7c227518f 100644 --- a/doc/source/tutorials/quick-start.rst +++ b/doc/source/tutorials/quick-start.rst @@ -459,6 +459,11 @@ create a second post-run playbook for it. Copy the following to .. literalinclude:: /examples/zuul-config/playbooks/base/post-logs.yaml :language: yaml +The first role in this playbook generates some metadata about the logs +which are about to be uploaded. Zuul uses this metadata in its web +interface to nicely render the logs and other information about the +build. + This tutorial is running an Apache webserver in a container which will serve build logs from a volume that is shared with the Zuul executor. That volume is mounted at `/srv/static/logs`, which is the default @@ -467,12 +472,12 @@ files to a remote server via SCP; see the role documentation for how to configure it. For this simple case, the only option we need to provide is the URL where the logs can ultimately be found. -.. note:: Zuul-jobs also contains a `role - `_ - to upload logs to an OpenStack Object Storage (swift) - container. If you create a role to upload logs to another - system, please feel free to contribute it to the zuul-jobs - repository for others to use. +.. note:: Zuul-jobs also contains `roles + `_ to + upload logs to a OpenStack Object Storage (swift) or Google + Cloud Storage containers. If you create a role to upload + logs to another system, please feel free to contribute it to + the zuul-jobs repository for others to use. .. _upload-logs: https://zuul-ci.org/docs/zuul-jobs/roles.html#role-upload-logs