upload-afs-synchronize: expand documentation
The upload-afs-synchronize role was added with I493d8829e3fd98e84f1b8f0e776e7ba41abf16c2 and used as part of the artifact promote process for tarballs and other uploads. However the role is useful as a generic way to upload results to AFS and avoid some commonly hit caveats such as getting permissions flags wrong. Expand the README to explain things a little more. Change-Id: Ia643b02b503560d1057697fc5a7d143fd728b177
This commit is contained in:
parent
09b4be329e
commit
c19ea2e6f9
@ -1,8 +1,17 @@
|
|||||||
Copy contents from ``{{ zuul.executor.work_root }}/artifacts/`` to AFS
|
Copy contents of a directory hierarchy to AFS
|
||||||
|
|
||||||
|
This role uses the ``synchronzie`` module to copy directory contents
|
||||||
|
to a remote AFS locations. It ensures the ``synchronize`` flags,
|
||||||
|
particularly relating to group and world permissions, are appropriate
|
||||||
|
for copying to AFS locations.
|
||||||
|
|
||||||
|
See also :zuul:role:`upload-afs-roots` which is a similar role giving
|
||||||
|
more fine-grained control over which directories are synchronized.
|
||||||
|
|
||||||
**Role Variables**
|
**Role Variables**
|
||||||
|
|
||||||
.. zuul:rolevar:: afs_source
|
.. zuul:rolevar:: afs_source
|
||||||
|
:default: ``{{ zuul.executor.work_root }}/artifacts/``
|
||||||
|
|
||||||
Path to local source directory.
|
Path to local source directory.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user