[DOCS] Refactor rsyslog_server Docs

This commit refactors the current docs in the rsyslog_server role.
Moving forward, specific project configurations are maintained
in the appropriate role book.

Change-Id: I688e7a244828a54692fd466eb534cfd6d9cb351d

README.rst

@@ -1,18 +1,9 @@
+========================
 OpenStack rsyslog server
-########################
-:tags: openstack, rsyslog, server, cloud, ansible
-:category: \*nix
+========================
 
-Role to deploy rsyslog for use within OpenStack when deploying services using
-containers.
+Documentation for the project can be found at:
+  http://docs.openstack.org/developer/openstack-ansible-rsyslog_server/
 
-Linux Distribution Support:  Ubuntu 14.04, EL 7.
-
-.. code-block:: yaml
-
-    - name: Install rsyslog
-      hosts: rsyslog
-      max_fail_percentage: 20
-      user: root
-      roles:
-        - { role: "rsyslog_server", tags: [ "rsyslog-server" ] }
+The project home is at:
+  http://launchpad.net/openstack-ansible

doc/source/index.rst

@@ -1,15 +1,32 @@
-rsyslog_server Docs
-===================
+========================
+OpenStack rsyslog server
+========================
 
-Installation of Rsyslog to receive shipped logs.
+Role to deploy rsyslog for use within OpenStack when deploying services using
+containers.
 
-Basic Role Example
-^^^^^^^^^^^^^^^^^^
+Table of contents
+~~~~~~~~~~~~~~~~~
 
-.. code-block:: yaml
+.. toctree::
+   :maxdepth: 2
 
-    - name: Install rsyslog
-      hosts: localhost
-      user: root
-      roles:
-        - { role: "rsyslog_server", tags: [ "rsyslog-server" ] }
+   ops-logging.rst
+
+Default variables
+~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../../defaults/main.yml
+   :language: yaml
+   :start-after: under the License.
+
+Required varibles
+~~~~~~~~~~~~~~~~~
+
+None
+
+Example playbook
+^^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../examples/playbook.yml
+   :language: yaml

doc/source/ops-logging.rst

@@ -0,0 +1,25 @@
+===================
+Centralized logging
+===================
+
+OpenStack-Ansible configures all instances to send syslog data to a
+container (or group of containers) running rsyslog. The rsyslog server
+containers are specified in the ``log_hosts`` section of the
+``openstack_user_config.yml`` file.
+
+The rsyslog server container(s) have logrotate installed and configured with
+a 14 day retention. All rotated logs are compressed by default.
+
+Finding logs
+~~~~~~~~~~~~
+
+Logs are accessible in multiple locations within an OpenStack-Ansible
+deployment:
+
+* The rsyslog server container collects logs in ``/var/log/log-storage`` within
+  directories named after the container or physical host.
+* Each physical host has the logs from its service containers mounted at
+  ``/openstack/log/``.
+* Each service container has its own logs stored at
+  ``/var/log/<service_name>``.
+

examples/playbook.yml

@@ -0,0 +1,6 @@
+- name: Install rsyslog
+  hosts: rsyslog
+  max_fail_percentage: 20
+  user: root
+  roles:
+    - { role: "rsyslog_server", tags: [ "rsyslog-server" ] }