summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2019-01-24 07:36:59 +0000
committerGerrit Code Review <review@openstack.org>2019-01-24 07:36:59 +0000
commitcaebca1387f0ec1bbf218ee963381169856a36c4 (patch)
tree97feff508a1d57b6366f4a3825d1e7c1f9963219
parent0ac452ea28c73f4819892b0a86634fbaf47e5aa0 (diff)
parent2ef4caed78c09487339cb321bc49fb5d7333db64 (diff)
Merge "Document upload-logs reliance on add-fileserver"
-rw-r--r--roles/add-fileserver/README.rst18
-rw-r--r--roles/upload-logs/README.rst18
2 files changed, 34 insertions, 2 deletions
diff --git a/roles/add-fileserver/README.rst b/roles/add-fileserver/README.rst
index 8a7b5ec..ae7d741 100644
--- a/roles/add-fileserver/README.rst
+++ b/roles/add-fileserver/README.rst
@@ -7,7 +7,23 @@ in subsequent tasks or roles.
7 7
8 Complex argument which contains the information about the remote 8 Complex argument which contains the information about the remote
9 destination as well as the authentication information needed. It is 9 destination as well as the authentication information needed. It is
10 expected that this argument comes from a `Secret`. 10 expected that this argument comes from a `Secret
11 <https://zuul-ci.org/docs/zuul/user/config.html#secret>`_
12
13 Example:
14
15 .. code-block:: yaml
16
17 - secret:
18 name: site_logs
19 data:
20 fqdn: logs.example.org
21 path: /srv/static/logs
22 ssh_known_hosts: |
23 logs.example.org ssh-rsa ...
24 ssh_username: zuul
25 ssh_private_key: !encrypted/pkcs1-oaep
26 - ...
11 27
12 .. zuul:rolevar:: fqdn 28 .. zuul:rolevar:: fqdn
13 29
diff --git a/roles/upload-logs/README.rst b/roles/upload-logs/README.rst
index e9e51f4..6669f3d 100644
--- a/roles/upload-logs/README.rst
+++ b/roles/upload-logs/README.rst
@@ -1,6 +1,22 @@
1Upload logs to a static webserver 1Upload logs to a static webserver
2 2
3This uploads logs to a static webserver using SSH. 3This uploads logs to a static server using SSH. The server must have
4been previously added to the inventory; this can be done with the
5:zuul:role:`add-fileserver` role; see that role's documentation for a
6description of the site_logs secret in this example post-run playbook:
7
8.. code-block:: yaml
9
10 - hosts: localhost
11 roles:
12 - role: add-fileserver
13 fileserver: "{{ site_logs }}"
14
15 - hosts: "{{ site_logs.fqdn }}"
16 gather_facts: False
17 roles:
18 - role: upload-logs
19 zuul_log_url: "http://logs.example.org"
4 20
5**Role Variables** 21**Role Variables**
6 22