zuul-jobs/roles/add-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

35 lines
965 B
ReStructuredText

Add a remote fileserver to the inventory so that content can be uploaded
in subsequent tasks or roles.
**Role Variables**
.. zuul:rolevar:: fileserver
Complex argument which contains the information about the remote
destination as well as the authentication information needed. It is
expected that this argument comes from a `Secret`.
.. zuul:rolevar:: fqdn
The FQDN of the remote host.
.. zuul:rolevar:: 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``.
.. zuul:rolevar:: ssh_known_hosts
String containing known host signature for the remote host.
.. zuul:rolevar:: ssh_private_key
Contents of the ssh private key to use.
.. zuul:rolevar:: ssh_username
:default: ansible_user
Remote ssh user name to use.