diff --git a/roles/add-fileserver/README.rst b/roles/add-fileserver/README.rst index d2a457e86..8a7b5ecb1 100644 --- a/roles/add-fileserver/README.rst +++ b/roles/add-fileserver/README.rst @@ -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