37837f53ee
This variable isn't part of the "fileserver" dictionary argument (i.e. it's not accessed as fileserver.fileserver_leading_path). Move it out in the documentation. Change-Id: I449ce2f383b044d92f0ebb9595ef1d77161c5c7c
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
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.
|
|
|
|
.. zuul:rolevar:: fileserver_leading_path
|
|
|
|
This is an optional variable that will be inserted between the base
|
|
of the path (provided by the `path` variable) and the
|
|
``zuul.project.short_name`` final path element.
|