zuul
/
zuul-jobs
Code Issues Proposed changes

Indent add-fileserver docs more 

There was inconsistent indentaton with the ":default:" tag here.

Change-Id: I07cbe1930f21e64bd4cb62035ffc6363cad04e6c
This commit is contained in:
James E. Blair 2018-09-13 17:12:51 -06:00
parent dd9ebadd6e
commit e202c9fc33
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
roles/add-fileserver/README.rst
View File

@ -5,33 +5,33 @@ in subsequent tasks or roles.
.. 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`.
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
.. zuul:rolevar:: fqdn
The FQDN of the remote host.
The FQDN of the remote host.
.. zuul:rolevar:: path
.. 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``.
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
.. zuul:rolevar:: ssh_known_hosts
String containing known host signature for the remote host.
String containing known host signature for the remote host.
.. zuul:rolevar:: ssh_private_key
.. zuul:rolevar:: ssh_private_key
Contents of the ssh private key to use.
Contents of the ssh private key to use.
.. zuul:rolevar:: ssh_username
:default: ansible_user
.. zuul:rolevar:: ssh_username
:default: ansible_user
Remote ssh user name to use.
Remote ssh user name to use.
.. zuul:rolevar:: fileserver_leading_path