Merge lp:~brad-marshall/charms/trusty/nagios/add-livestatus-support into lp:charms/trusty/nagios

[Brad Marshall]

Add livestatus support, which can't be done via the extraconfig since the broker_module needs to be in the main nagios.cfg file.

[lp:~brad-marshall/charms/trusty/nagios/add-livestatus-support]

21. By Brad Marshall on 2015-05-01

[bradm] Merge from upstream, had started with lp:charms/nagios instead of lp:charms/trusty/nagios

22. By Brad Marshall on 2015-05-04

[bradm] Add test for livestatus config variable

[Brad Marshall (brad-marshall)]

Added tests for the livestatus path existing, although I'm not sure I did the config-get correctly - it feels like there should be a better way in amulet than a unit.run('config-get <var>') - please let me know if there is.

[Adam Israel (aisrael)]

Hi!

I'm doing a triage of reviews in the queue, in the spirit of fail-fast. This is a cursory check of the proposed merge to see if there are any "obvious" things that may prevent the review from being accepted.

The goal is to get you feedback sooner, before an in-depth review has been done. I'm happy to see the addition of a unit test for the new functionality. Could you also add something to the README to explains the usage of this new feature?

Thanks!

[lp:~brad-marshall/charms/trusty/nagios/add-livestatus-support]

23. By Brad Marshall on 2015-05-07

[bradm] Add documentation about livestatus config options, tidy up comments

[Brad Marshall (brad-marshall)]

I've added some basic documentation about the config variables.

[Charles Butler (lazypower)]

Greetings Brad,

I took some time to review this and would like to thank you for the contribution. The test coverage + documentation updates.

In response to your earlier question about running config-get, that is one way of doing it or you can read directly from the config dictionary you supply to the charm in the test. However if you did not supply one - your method was correct. To obtain the data from juju-run.

I found some test failures that seem unrelated to your merge. I filed them under this existing bug about tests failing in CI here: https://bugs.launchpad.net/charms/+source/nagios/+bug/1403574

+1 LGTM. Thank you for taking the time to submit this feature for the nagios charm. We appreciate your work. I've merged this branch and it should be available in the charm store after the next ingestion.

If you have any questions/comments/concerns about the review contact us in #juju on irc.freenode.net or email the mailing list <email address hidden>, or ask a question tagged with "juju" on http://askubuntu.com.

review: Approve

=== modified file 'README.md'
--- README.md	2014-04-11 14:06:48 +0000
+++ README.md	2015-05-07 07:07:58 +0000
@@ -28,6 +28,10 @@
 
 # Configuration
 
+- `enable_livestatus` - Setting to enable the [livestatus module](https://mathias-kettner.de/checkmk_livestatus.html). This is an easy interface to get data out of Nagios.
+
+- `livestatus_path` - Configuration of where the livestatus module is stored - defaults to /var/lib/nagios3/livestatus/socket.
+
 ### SSL Configuration
 
 - `ssl` - Determinant configuration for enabling SSL. Valid options are "on", "off", "only". The "only" option disables HTTP traffic on Apache in favor of HTTPS. This setting may cause unexpected behavior with existing nagios charm deployments. 

=== modified file 'config.yaml'
--- config.yaml	2014-03-04 21:33:40 +0000
+++ config.yaml	2015-05-07 07:07:58 +0000
@@ -34,3 +34,13 @@
         description: |
             base64 encoded chain certificates file.  If ssl_cert is
             blank, this will be ignored.
+    enable_livestatus:
+        type: boolean
+        default: false
+        description: |
+            Config variable to enable livestatus module or not.
+    livestatus_path:
+        type: string
+        default: "/var/lib/nagios3/livestatus/socket"
+        description: |
+            Default path to livestatus socket, if enabled via enable_livestatus

=== modified file 'hooks/install'
--- hooks/install	2014-10-13 23:19:09 +0000
+++ hooks/install	2015-05-07 07:07:58 +0000
@@ -37,6 +37,24 @@
     rm -v /etc/nagios3/conf.d/extinfo_nagios2.cfg
 fi
 
+enable_livestatus=$(config-get enable_livestatus)
+livestatus_path=$(config-get livestatus_path)
+livestatus_dir=$(dirname $livestatus_path)
+
+if [ "$enable_livestatus" ]; then 
+    # install check-mk-livestatus
+    DEBIAN_FRONTEND=noninteractive apt-get -qy install check-mk-livestatus
+    # enable livestatus broker
+    if ! grep '^broker_module=' /etc/nagios3/nagios.cfg ; then
+        echo "broker_module=/usr/lib/check_mk/livestatus.o $livestatus_path" >> /etc/nagios3/nagios.cfg
+    fi
+    # fix permissions on the livestatus directory
+    mkdir -p $livestatus_dir
+    chown nagios:www-data $livestatus_dir
+    chmod g+w $livestatus_dir
+    chmod g+s $livestatus_dir
+fi
+
 if [ -f $CHARM_DIR/files/index.html ]; then
     # Replace the default index.html file to redirect to nagios3/
     cp -v $CHARM_DIR/files/index.html /var/www/html/index.html

=== modified file 'hooks/upgrade-charm'
--- hooks/upgrade-charm	2014-10-14 17:18:28 +0000
+++ hooks/upgrade-charm	2015-05-07 07:07:58 +0000
@@ -5,19 +5,28 @@
 import base64
 from jinja2 import Template
 import os
-import shutil
+import re
+import pwd
+import grp
+import stat
+import errno
+# import shutil
 import subprocess
 from charmhelpers.contrib import ssl
 from charmhelpers.core import hookenv, host
+from charmhelpers import fetch
 
 from common import update_localhost
 
 # Gather facts
 legacy_relations = hookenv.config('legacy')
 extra_config = hookenv.config('extraconfig')
+enable_livestatus = hookenv.config('enable_livestatus')
+livestatus_path = hookenv.config('livestatus_path')
 ssl_config = hookenv.config('ssl')
 charm_dir = os.environ['CHARM_DIR']
 cert_domain = hookenv.unit_get('public-address')
+nagios_cfg = "/etc/nagios3/nagios.cfg"
 
 
 # Checks the charm relations for legacy relations
@@ -44,6 +53,66 @@
         host.write_file('/etc/nagios3/conf.d/extra.cfg', extra_config)
 
 
+# Equivalent of mkdir -p, since we can't rely on
+# python 3.2 os.makedirs exist_ok argument
+def mkdir_p(path):
+    try:
+        os.makedirs(path)
+    except OSError as exc:  # Python >2.5
+        if exc.errno == errno.EEXIST and os.path.isdir(path):
+            pass
+        else:
+            raise
+
+
+# Fix the path to be world executable
+def fixpath(path):
+    if os.path.isdir(path):
+        st = os.stat(path)
+        os.chmod(path, st.st_mode | stat.S_IXOTH)
+    if path != "/":
+        fixpath(os.path.split(path)[0])
+
+
+def enable_livestatus_config():
+    if enable_livestatus:
+        hookenv.log("Livestatus is enabled")
+        fetch.apt_update()
+        fetch.apt_install('check-mk-livestatus')
+        broker = re.compile("^broker_module=")
+        broker_found = False
+        for line in open(nagios_cfg):
+            if broker.match(line):
+                broker_found = True
+                hookenv.log("broker_module line exists, not adding..")
+                break
+
+        if not broker_found:
+            with open(nagios_cfg, "a") as nagiosfile:
+                broker_str = "broker_module=/usr/lib/check_mk/livestatus.o " . livestatus_path
+                nagiosfile.write(broker_str)
+            nagiosfile.close()
+
+        # Make the directory and fix perms on it
+        hookenv.log("Fixing perms on livestatus_path")
+        livestatus_path = hookenv.config('livestatus_path')
+        livestatus_dir = os.path.dirname(livestatus_path)
+        if not os.path.isdir(livestatus_dir):
+            hookenv.log("Making path for livestatus_dir")
+            mkdir_p(livestatus_dir)
+        fixpath(livestatus_dir)
+
+        # Fix the perms on the socket
+        hookenv.log("Fixing perms on the socket")
+        uid = pwd.getpwnam("nagios").pw_uid
+        gid = grp.getgrnam("www-data").gr_gid
+        os.chown(livestatus_path, uid, gid)
+        os.chown(livestatus_dir, uid, gid)
+        st = os.stat(livestatus_path)
+        os.chmod(livestatus_path, st.st_mode | stat.S_IRGRP)
+        os.chmod(livestatus_dir, st.st_mode | stat.S_IRGRP | stat.S_ISGID)
+
+
 def ssl_configured():
     allowed_options = ["on", "only"]
     if str(ssl_config).lower() in allowed_options:
@@ -89,7 +158,7 @@
 def enable_ssl():
     # Set the basename of all ssl files
 
-    #Validate that we have configs, and generate a self signed certificate.
+    # Validate that we have configs, and generate a self signed certificate.
     if not hookenv.config('ssl_cert'):
         # bail if keys already exist
         if os.path.exists(cert_file):
@@ -143,6 +212,7 @@
 
 warn_legacy_relations()
 write_extra_config()
+enable_livestatus_config()
 if ssl_configured():
     enable_ssl()
 update_apache()

=== added file 'tests/23-livestatus-test'
--- tests/23-livestatus-test	1970-01-01 00:00:00 +0000
+++ tests/23-livestatus-test	2015-05-07 07:07:58 +0000
@@ -0,0 +1,43 @@
+#!/usr/bin/python3
+
+import amulet
+# import requests
+
+seconds = 20000
+
+d = amulet.Deployment(series='trusty')
+
+d.add('nagios')
+
+d.expose('nagios')
+
+try:
+    d.setup(timeout=seconds)
+    d.sentry.wait()
+except amulet.helpers.TimeoutError:
+    amulet.raise_status(amulet.SKIP, msg="Environment wasn't stood up in time")
+except:
+    raise
+
+
+##
+# Set relationship aliases
+##
+nagios_unit = d.sentry.unit['nagios/0']
+
+d.configure('nagios', {
+    'enable_livestatus': True
+})
+
+d.sentry.wait()
+
+
+def test_livestatus_file_exists():
+    livestatus_path = nagios_unit.run('config-get livestatus_path')
+    try:
+        livestatus_file = nagios_unit.file(livestatus_path[0])
+    except OSError:
+        message = "Can't find livestatus file"
+        amulet.raise_status(amulet.FAIL, msg=message)
+
+test_livestatus_file_exists()