zuul/zuul-jobs
Code Issues Proposed changes

Add build shard log path docs to upload-logs(-swift)

Browse Source 
The upload logs roles can make use of the build logs sharding via their
calls into set-zuul-log-path-fact. Document this.

Change-Id: Ia57fc6a47227657f9fac70074e453cf8d4c16c26
This commit is contained in:
Clark Boylan 2019-09-04 17:50:11 -07:00 committed by Clark Boylan
parent ed1c6867e1
commit fd2b753088
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
roles/upload-logs-swift/README.rst
View File

@ -65,3 +65,14 @@ This uploads logs to an OpenStack Object Store (Swift) container.
Whether to create `index.html` files with directory indexes. If set Whether to create `index.html` files with directory indexes. If set
to false, Swift containers can be marked with a `Web-Listings=true` to false, Swift containers can be marked with a `Web-Listings=true`
property to activate Swift's own directory indexing. property to activate Swift's own directory indexing.
.. zuul:rolevar:: zuul_log_path_shard_build
:default: False
This var is consumed by set-zuul-log-path-fact which upload-logs-swift
calls into. If you set this you will get log paths prefixed with the
first three characters of the build uuid. This will improve log file
sharding.
More details can be found at
:zuul:rolevar:`set-zuul-log-path-fact.zuul_log_path_shard_build`.

11
roles/upload-logs/README.rst
View File

@ -45,3 +45,14 @@ description of the site_logs secret in this example post-run playbook:
when the job has failed. when the job has failed.
.. note:: Intended to be set by admins via site-variables. .. note:: Intended to be set by admins via site-variables.
.. zuul:rolevar:: zuul_log_path_shard_build
:default: False
This var is consumed by set-zuul-log-path-fact which upload-logs
calls into. If you set this you will get log paths prefixed with the
first three characters of the build uuid. This will improve log file
sharding.
More details can be found at
:zuul:rolevar:`set-zuul-log-path-fact.zuul_log_path_shard_build`.