zuul-jobs/roles/publish-artifacts-to-fileserver/README.rst
Monty Taylor fa7507fd98
Document and update fileserver roles
The add-fileserver role needs to be used by a job in a config repo as it
performs local actions such as adding a host to the inventory and needs to
be run on localhost.

publish-artifacts-to-fileserver doesn't have any special requirements, but
it's fairly useless without the first role.

Change-Id: I0e37ee297b13dceb70300a4f8f4accc233254df3
2017-08-18 18:21:50 -05:00

16 lines
639 B
ReStructuredText

Publish contents of ``{{ zuul.executor.work_root }}/artifacts/`` dir using
rsync over ssh to a remote fileserver that has previously been added to
the inventory by :zuul:role:`add-fileserver`.
**Role Variables**
:zuul:role:`add-fileserver` sets the following variable in the hostvars of the
hosts it adds, but it is documented for reference.
.. zuul:rolevar:: zuul_fileserver_project_path
The remote path. Content will be put into a directory below this path
that matches ``zuul.project.short_name``. The full path including
the project short name will be added to the hostvars of the host
as ``zuul_fileserver_project_path``.