Adds rsyslog client role and enables it in all plays

This commit adds the rsyslog_client role to the general stack. This
change is part 3 of 3 role will allow rsyslog to server as a log
shipper within a given host / container. The role has been setup to
allow for logs to be shipped to multiple hosts and or other
providers, e.g. splunk, loggly, etc... All of the plays that need
to support logging have been modified to use the new rsyslog_client
role.

Roles added:
* rsyslog_client

Plays modified:
* playbooks/galera-install.yml
* playbooks/lxc-hosts-setup.yml
* playbooks/os-cinder-install.yml
* playbooks/os-glance-install.yml
* playbooks/os-heat-install.yml
* playbooks/os-horizon-install.yml
* playbooks/os-keystone-install.yml
* playbooks/os-neutron-install.yml
* playbooks/os-nova-install.yml
* playbooks/os-swift-install.yml
* playbooks/os-tempest-install.yml
* playbooks/rabbitmq-install.yml
* playbooks/repo-server.yml

DocImpact
Implements: blueprint rsyslog-update

Change-Id: I4028a58db3825adb8a5aa73dbaabbe353bb33046

playbooks/galera-install.yml

@@ -44,6 +44,14 @@
         - galera-ssh-wait
   roles:
     - { role: "galera_server", tags: [ "galera-server" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/mysql"
+      rsyslog_client_log_files:
+        - /var/log/mysql.log
+        - /var/log/mysql.err
+      rsyslog_client_config_name: "99-galera-rsyslog-client.conf"
+      tags:
+        - "galera-rsyslog-client"
   vars:
     galera_wsrep_node_name: "{{ container_name }}"
     ansible_hostname: "{{ container_name }}"

playbooks/lxc-hosts-setup.yml

@@ -20,5 +20,10 @@
   roles:
     - { role: "lxc_hosts", tags: [ "lxc-host", "host-setup" ] }
     - { role: "py_from_git", tags: [ "lxc-libs" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/lxc"
+      rsyslog_client_config_name: "99-lxc-rsyslog-client.conf"
+      tags:
+        - "lxc-rsyslog-client"
   vars_files:
     - vars/repo_packages/python2_lxc.yml

playbooks/os-cinder-install.yml

@@ -87,6 +87,11 @@
         - cinder-logs
   roles:
     - { role: "os_cinder", tags: [ "os-cinder" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/cinder"
+      rsyslog_client_config_name: "99-cinder-rsyslog-client.conf"
+      tags:
+        - "cinder-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     glance_host: "{{ internal_lb_vip_address }}"

playbooks/os-glance-install.yml

@@ -75,6 +75,11 @@
   roles:
     - { role: "os_glance", tags: [ "os-glance" ] }
     - { role: "openstack_openrc", tags: [ "openstack-openrc" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/glance"
+      rsyslog_client_config_name: "99-glance-rsyslog-client.conf"
+      tags:
+        - "glance-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-heat-install.yml

@@ -50,6 +50,11 @@
         - heat-logs
   roles:
     - { role: "os_heat", tags: [ "os-heat" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/heat"
+      rsyslog_client_config_name: "99-heat-rsyslog-client.conf"
+      tags:
+        - "heat-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-horizon-install.yml

@@ -50,6 +50,11 @@
         - horizon-logs
   roles:
     - { role: "os_horizon", tags: [ "os-horizon" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/apache2"
+      rsyslog_client_config_name: "99-horizon-rsyslog-client.conf"
+      tags:
+        - "horizon-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-keystone-install.yml

@@ -51,6 +51,11 @@
   roles:
     - { role: "os_keystone", tags: [ "os-keystone" ] }
     - { role: "openstack_openrc", tags: [ "openstack-openrc" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/apache2"
+      rsyslog_client_config_name: "99-keystone-rsyslog-client.conf"
+      tags:
+        - "keystone-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-neutron-install.yml

@@ -77,6 +77,11 @@
   roles:
     - { role: "os_neutron", tags: [ "os-neutron" ] }
     - { role: "openstack_openrc", tags: [ "openstack-openrc" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/neutron"
+      rsyslog_client_config_name: "99-neutron-rsyslog-client.conf"
+      tags:
+        - "neutron-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-nova-install.yml

@@ -77,6 +77,11 @@
   roles:
     - { role: "os_nova", tags: [ "os-nova" ] }
     - { role: "openstack_openrc", tags: [ "openstack-openrc" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/nova"
+      rsyslog_client_config_name: "99-nova-rsyslog-client.conf"
+      tags:
+        - "nova-rsyslog-client"
   vars:
     galera_address: "{{ internal_lb_vip_address }}"
     ansible_hostname: "{{ container_name }}"

playbooks/os-swift-install.yml

@@ -47,6 +47,11 @@
         - swift-logs
   roles:
     - { role: "os_swift", tags: [ "os-swift" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/swift"
+      rsyslog_client_config_name: "99-swift-rsyslog-client.conf"
+      tags:
+        - "swift-rsyslog-client"
   vars:
     ansible_hostname: "{{ container_name }}"
     ansible_ssh_host: "{{ container_address }}"

playbooks/os-tempest-install.yml

@@ -19,6 +19,11 @@
   user: root
   roles:
     - { role: "os_tempest", tags: [ "os-tempest" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/utility"
+      rsyslog_client_config_name: "99-tempest-rsyslog-client.conf"
+      tags:
+        - "tempest-rsyslog-client"
   vars_files:
     - vars/repo_packages/openstack_services.yml
   vars:

playbooks/rabbitmq-install.yml

@@ -19,6 +19,11 @@
   user: root
   roles:
     - { role: "rabbitmq_server", tags: [ "rabbitmq-server" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/rabbitmq"
+      rsyslog_client_config_name: "99-rabbitmq-rsyslog-client.conf"
+      tags:
+        - "rabbitmq-rsyslog-client"
   vars:
     ansible_hostname: "{{ container_name }}"
     ansible_ssh_host: "{{ container_address }}"

playbooks/repo-server.yml

@@ -44,6 +44,14 @@
         - repo-ssh-wait
   roles:
     - { role: "repo_server", tags: [ "repo-server" ] }
+    - role: "rsyslog_client"
+      rsyslog_client_log_dir: "/var/log/nginx"
+      rsyslog_client_log_files:
+        - /var/www/repo_builder.log
+        - /var/log/rsyncd.log
+      rsyslog_client_config_name: "99-repo-rsyslog-client.conf"
+      tags:
+        - "repo-rsyslog-client"
   vars:
     pip_no_index: false
     ansible_hostname: "{{ container_name }}"

playbooks/roles/rsyslog_client/CONTRIBUTING.rst

@@ -0,0 +1,85 @@
+OpenStack rsyslog server
+########################
+:tags: openstack, rsyslog, server, cloud, ansible
+:category: \*nix
+
+contributor guidelines
+^^^^^^^^^^^^^^^^^^^^^^
+
+Filing Bugs
+-----------
+
+Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible"
+
+
+When submitting a bug, or working on a bug, please ensure the following criteria are met:
+    * The description clearly states or describes the original problem or root cause of the problem.
+    * Include historical information on how the problem was identified.
+    * Any relevant logs are included.
+    * The provided information should be totally self-contained. External access to web services/sites should not be needed.
+    * Steps to reproduce the problem if possible.
+
+
+Submitting Code
+---------------
+
+Changes to the project should be submitted for review via the Gerrit tool, following
+the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
+
+Pull requests submitted through GitHub will be ignored and closed without regard.
+
+
+Extra
+-----
+
+Tags:
+    If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``).  There are predefined tags that will autocomplete.
+
+Status:
+    Please leave this alone, it should be New till someone triages the issue.
+
+Importance:
+    Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures.
+
+
+Style guide
+-----------
+
+When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format.
+
+Example YAML dictionary format:
+    .. code-block:: yaml
+
+        - name: The name of the tasks
+          module_name:
+            thing1: "some-stuff"
+            thing2: "some-other-stuff"
+          tags:
+            - some-tag
+            - some-other-tag
+
+
+Example **NOT** in YAML dictionary format:
+    .. code-block:: yaml
+
+        - name: The name of the tasks
+          module_name: thing1="some-stuff" thing2="some-other-stuff"
+          tags:
+            - some-tag
+            - some-other-tag
+
+
+Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module.
+
+
+Issues
+------
+
+When submitting an issue, or working on an issue please ensure the following criteria are met:
+    * The description clearly states or describes the original problem or root cause of the problem.
+    * Include historical information on how the problem was identified.
+    * Any relevant logs are included.
+    * If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR).
+    * The provided information should be totally self-contained. External access to web services/sites should not be needed.
+    * If the issue is needed for a hotfix release, add the 'expedite' label.
+    * Steps to reproduce the problem if possible.

playbooks/roles/rsyslog_client/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

playbooks/roles/rsyslog_client/README.rst

@@ -0,0 +1,14 @@
+OpenStack rsyslog client
+########################
+:tags: openstack, rsyslog, server, cloud, ansible
+:category: \*nix
+
+Role to deploy rsyslog for use within OpenStack.
+
+.. code-block:: yaml
+
+    - name: Install rsyslog
+      hosts: rsyslog
+      user: root
+      roles:
+        - { role: "rsyslog_client", tags: [ "rsyslog-client" ] }

playbooks/roles/rsyslog_client/defaults/main.yml

@@ -0,0 +1,64 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+rsyslog_client_apt_repos:
+  - { repo: "ppa:adiscon/v8-stable", state: "present" }
+
+rsyslog_client_apt_packages:
+  - rsyslog
+
+rsyslog_client_spool_directory: /var/spool/rsyslog
+
+# Set the `rsyslog_client_log_dir` variable in to override log file
+# discovery process. This will force the logs from a given directory
+# to be shipped using rsyslog.
+# rsyslog_client_log_dir: /var/log/project
+
+# Set the `rsyslog_client_log_files` variable in list format to skip
+# log discovery all together and ship only log files that are explicitly
+# stated.
+# rsyslog_client_log_files:
+#   - /var/log/project/logfile1.log
+#   - /var/log/project/logfile2.log
+
+# Name of the configuration file that will be used client side.
+rsyslog_client_config_name: 99-rsyslog-client.conf
+
+# provides UDP syslog reception
+rsyslog_client_udp_reception: true
+rsyslog_client_udp_port: 514
+
+# provides TCP syslog reception
+rsyslog_client_tcp_reception: false
+rsyslog_client_tcp_port: 514
+
+# Set the `rsyslog_client_user_defined_targets` to define specific log targets.
+# This option will allow you to define multiple log targets with different templates
+# and options. The value of this variable is a list of hashes with the following
+# required options: name, proto, port, hostname. This variable also has the following
+# optional options: template, action_options. If you set `action_options` make sure you
+# separate options inline with a ";".
+## Example
+# rsyslog_client_user_defined_targets:
+#   - name: "splunk1"
+#     proto: "tcp"
+#     port: "20000"
+#     hostname: "tcp.hostname.data.splunkstorm.com"
+#   - name: "loggly1"
+#     proto: "udp"
+#     port: "514"
+#     hostname: "logs-01.loggly.com"
+#     template: '$template LogglyFormat,"<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [TOKEN@41058 tag=\"TAG\"] %msg%\n"'
+#     action_options: 'LogglyFormat'

playbooks/roles/rsyslog_client/files/50-default.conf

@@ -0,0 +1,16 @@
+auth,authpriv.*  /var/log/auth.log
+*.*;auth,authpriv.none  -/var/log/syslog
+cron.*  /var/log/cron.log
+daemon.*  -/var/log/daemon.log
+kern.*  -/var/log/kern.log
+lpr.*  -/var/log/lpr.log
+mail.*  -/var/log/mail.log
+user.*  -/var/log/user.log
+
+mail.err  /var/log/mail.err
+
+news.crit  /var/log/news/news.crit
+news.err  /var/log/news/news.err
+news.notice  -/var/log/news/news.notice
+
+*.emerg    :omusrmsg:*

playbooks/roles/rsyslog_client/meta/main.yml

@@ -0,0 +1,31 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+galaxy_info:
+  author: rcbops
+  description: Rsyslog log client setup
+  company: Rackspace
+  license: Apache2
+  min_ansible_version: 1.6.6
+  platforms:
+    - name: Ubuntu
+      versions:
+        - trusty
+  categories:
+    - client
+    - rsyslog
+    - development
+    - openstack
+dependencies: []

playbooks/roles/rsyslog_client/tasks/main.yml

@@ -0,0 +1,18 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- include: rsyslog_client_pre_install.yml
+- include: rsyslog_client_install.yml
+- include: rsyslog_client_post_install.yml

playbooks/roles/rsyslog_client/tasks/rsyslog_client_install.yml

@@ -0,0 +1,40 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- name: Rsyslog apt repository
+  apt_repository:
+    repo: "{{ item.repo }}"
+    state: "{{ item.state }}"
+  with_items: rsyslog_client_apt_repos
+  register: add_repos
+  until: add_repos|success
+  retries: 5
+  delay: 2
+  tags:
+    - rsyslog-client-apt-repositories
+
+- name: Install rsyslog packages
+  apt:
+    pkg: "{{ item }}"
+    state: latest
+    update_cache: yes
+    cache_valid_time: 600
+  register: install_packages
+  until: install_packages|success
+  retries: 5
+  delay: 2
+  with_items: rsyslog_client_apt_packages
+  tags:
+    - rsyslog-client-apt-packages

playbooks/roles/rsyslog_client/tasks/rsyslog_client_post_install.yml

@@ -0,0 +1,91 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- name: Stop rsyslog
+  service:
+    name: "rsyslog"
+    state: "stopped"
+  failed_when: false
+  tags:
+    - rsyslog-client-config
+
+- name: Rsyslog Setup
+  copy:
+    src: "{{ item.src }}"
+    dest: "{{ item.dest }}"
+    owner: "root"
+    group: "root"
+  with_items:
+    - { src: "50-default.conf", dest: "/etc/rsyslog.d/50-default.conf" }
+  tags:
+    - rsyslog-client-config
+
+- name: Find all log files
+  shell: |
+    find -L '{{ rsyslog_client_log_dir }}' -type f -name '*.log'
+  register: log_files
+  when: >
+    rsyslog_client_log_dir is defined
+  tags:
+    - rsyslog-client-config
+
+- name: Set fact for combined log files list and found logs
+  set_fact:
+    rsyslog_client_log_files: "{{ log_files.stdout_lines | union(rsyslog_client_log_files) }}"
+  when: >
+    rsyslog_client_log_files is defined and
+    log_files | success
+  tags:
+    - rsyslog-client-config
+
+- name: Set fact for found log files list
+  set_fact:
+    rsyslog_client_log_files: "{{ log_files.stdout_lines }}"
+  when: >
+    rsyslog_client_log_files is not defined and
+    log_files | success
+  tags:
+    - rsyslog-client-config
+
+- name: Check rsyslog_client_log_files is defined
+  fail:
+    msg: >
+      There were no log files defined in `rsyslog_client_log_files`. Please use that
+      variable to set the files that you want rsyslog to begin shipping logs for. This
+      variable is a list that requires the full path to all log files. You can also set
+      `rsyslog_client_log_dir` which will find all "*.log" files using the path
+      provided.
+  when: >
+    rsyslog_client_log_files is not defined
+
+- name: Write rsyslog config for found log files
+  template:
+    src: "{{ item.src }}"
+    dest: "{{ item.dest }}"
+    owner: "root"
+    group: "root"
+  with_items:
+    - { src: "99-rsyslog.conf.j2", dest: "/etc/rsyslog.d/{{ rsyslog_client_config_name }}" }
+    - { src: "os_aggregate_storage.j2", dest: "/etc/logrotate.d/os_aggregate_storage" }
+    - { src: "rsyslog.conf.j2", dest: "/etc/rsyslog.conf" }
+  tags:
+    - rsyslog-client-config
+
+- name: Start rsyslog
+  service:
+    name: "rsyslog"
+    state: "started"
+  tags:
+    - rsyslog-client-config

playbooks/roles/rsyslog_client/tasks/rsyslog_client_pre_install.yml

@@ -0,0 +1,23 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- name: Ensure ownership on working directory is correct
+  file:
+    path: "{{ rsyslog_client_spool_directory }}"
+    state: "directory"
+    owner: "syslog"
+    group: "adm"
+  tags:
+    - rsyslog-client-dirs

playbooks/roles/rsyslog_client/templates/99-rsyslog.conf.j2

@@ -0,0 +1,57 @@
+# {{ ansible_managed }}
+
+$WorkDirectory {{ rsyslog_client_spool_directory }}
+$template RFC3164fmt,"<%PRI%>%TIMESTAMP% %HOSTNAME% %syslogtag%%msg%"
+
+{% if groups['rsyslog_all'] is defined and groups['rsyslog_all'] %}
+# Log shipment rsyslog target servers
+{% for server in groups['rsyslog_all'] %}
+$ActionQueueFileName {{ server }}
+$ActionQueueSaveOnShutdown on
+$ActionQueueType LinkedList
+$ActionResumeRetryCount 250
+{% if rsyslog_client_tcp_reception == true %}
+*.* @@{{ hostvars[server]['ansible_ssh_host'] }}:{{ rsyslog_client_tcp_port }};RFC3164fmt
+{% endif %}
+{% if rsyslog_client_udp_reception == true %}
+*.* @{{ hostvars[server]['ansible_ssh_host'] }}:{{ rsyslog_client_udp_port }};RFC3164fmt
+{% endif %}
+
+{% endfor %}
+{% endif %}
+
+{% if rsyslog_client_user_defined_targets is defined %}
+# Log shipment user defined target servers
+{% for target in rsyslog_client_user_defined_targets %}
+$ActionQueueFileName {{ target.name }}
+$ActionQueueSaveOnShutdown on
+$ActionQueueType LinkedList
+$ActionResumeRetryCount 250
+{% if target.template is defined %}
+{{ target.template }}
+{% endif %}
+{% if target.proto == "udp" %}
+{% set action_sting = '*.* @@' %}
+{% elif target.proto == "tcp" %}
+{% set action_sting = '*.* @' %}
+{% endif %}
+{% if target.action_options is defined %}
+{{ action_sting }}{{ target.hostname }}:{{ target.port }};{{ target.action_options }}
+{% else %}
+{{ action_sting }}{{ target.hostname }}:{{ target.port }}
+{% endif %}
+
+{% endfor %}
+{% endif %}
+
+# Log files
+{% for log_file in rsyslog_client_log_files %}
+$InputFileName {{ log_file }}
+$InputFileTag {{ log_file.split('.log')[0] | basename }}:
+$InputFileStateFile state-{{ log_file.split('.log')[0] | basename }}
+$InputFileFacility local7
+$InputFilePollInterval 1
+$InputFilePersistStateInterval 1
+$InputRunFileMonitor
+
+{% endfor %}

playbooks/roles/rsyslog_client/templates/os_aggregate_storage.j2

@@ -0,0 +1,14 @@
+{% for log_file in rsyslog_client_log_files %}
+{{ log_file }}
+{% endfor %}
+{
+        copytruncate
+        weekly
+        missingok
+        rotate 14
+        compress
+        dateext
+        maxage 60
+        notifempty
+        nocreate
+}

playbooks/roles/rsyslog_client/templates/rsyslog.conf.j2

@@ -0,0 +1,43 @@
+#################
+#### MODULES ####
+#################
+$ModLoad imuxsock # provides support for local system logging
+$ModLoad imklog   # provides kernel logging support
+$ModLoad imfile
+
+# Enable non-kernel facility klog messages
+$KLogPermitNonKernelFacility on
+
+
+###########################
+#### GLOBAL DIRECTIVES ####
+###########################
+#
+# Use traditional timestamp format.
+# To enable high precision timestamps, comment out the following line.
+#
+$ActionFileDefaultTemplate RSYSLOG_TraditionalFileFormat
+
+# Filter duplicated messages
+$RepeatedMsgReduction on
+
+#
+# Set the default permissions for all log files.
+#
+$FileOwner syslog
+$FileGroup adm
+$FileCreateMode 0640
+$DirCreateMode 0755
+$Umask 0022
+$PrivDropToUser syslog
+$PrivDropToGroup syslog
+
+#
+# Where to place spool and state files
+#
+$WorkDirectory {{ rsyslog_client_spool_directory }}
+
+#
+# Include all config files in /etc/rsyslog.d/
+#
+$IncludeConfig /etc/rsyslog.d/*.conf

playbooks/roles/rsyslog_server/CONTRIBUTING.rst

@@ -1,6 +1,6 @@
-OpenStack rsyslog server
+OpenStack rsyslog client
 ########################
-:tags: openstack, rsyslog, server, cloud, ansible
+:tags: openstack, rsyslog, client, cloud, ansible
 :category: \*nix
 
 contributor guidelines