1
=== modified file 'charm-helpers-hooks.yaml'
2
--- charm-helpers-hooks.yaml	2014-10-02 09:28:13 +0000
3
+++ charm-helpers-hooks.yaml	2014-11-18 01:29:44 +0000
4
@@ -11,3 +11,4 @@
5
11
    - payload.execd
11
    - payload.execd
6
12
    - contrib.network.ip
12
    - contrib.network.ip
7
13
    - contrib.peerstorage
13
    - contrib.peerstorage
8
14
    - contrib.charmsupport
9
14
15
10
=== modified file 'config.yaml'
11
--- config.yaml	2014-10-02 20:31:24 +0000
12
+++ config.yaml	2014-11-18 01:29:44 +0000
13
@@ -177,3 +177,14 @@
14
177
      order for this charm to function correctly, the privacy extension must be
177
      order for this charm to function correctly, the privacy extension must be
15
178
      disabled and a non-temporary address must be configured/available on
178
      disabled and a non-temporary address must be configured/available on
16
179
      your network interface.
179
      your network interface.
17
180
  nagios_context:
18
181
    default: "juju"
19
182
    type: string
20
183
    description: |
21
184
      Used by the nrpe-external-master subordinate charm.
22
185
      A string that will be prepended to instance name to set the host name
23
186
      in nagios. So for instance the hostname would be something like:
24
187
          juju-myservice-0
25
188
      If you're running multiple environments with the same services in them
26
189
      this allows you to differentiate between them.
27
190
28
180
191
29
=== added directory 'files'
30
=== added directory 'hooks/charmhelpers/contrib/charmsupport'
31
=== added file 'hooks/charmhelpers/contrib/charmsupport/__init__.py'
32
=== added file 'hooks/charmhelpers/contrib/charmsupport/nrpe.py'
33
--- hooks/charmhelpers/contrib/charmsupport/nrpe.py	1970-01-01 00:00:00 +0000
34
+++ hooks/charmhelpers/contrib/charmsupport/nrpe.py	2014-11-18 01:29:44 +0000
35
@@ -0,0 +1,222 @@
36
1
"""Compatibility with the nrpe-external-master charm"""
37
2
# Copyright 2012 Canonical Ltd.
38
3
#
39
4
# Authors:
40
5
#  Matthew Wedgwood <matthew.wedgwood@canonical.com>
41
6
42
7
import subprocess
43
8
import pwd
44
9
import grp
45
10
import os
46
11
import re
47
12
import shlex
48
13
import yaml
49
14
50
15
from charmhelpers.core.hookenv import (
51
16
    config,
52
17
    local_unit,
53
18
    log,
54
19
    relation_ids,
55
20
    relation_set,
56
21
)
57
22
58
23
from charmhelpers.core.host import service
59
24
60
25
# This module adds compatibility with the nrpe-external-master and plain nrpe
61
26
# subordinate charms. To use it in your charm:
62
27
#
63
28
# 1. Update metadata.yaml
64
29
#
65
30
#   provides:
66
31
#     (...)
67
32
#     nrpe-external-master:
68
33
#       interface: nrpe-external-master
69
34
#       scope: container
70
35
#
71
36
#   and/or
72
37
#
73
38
#   provides:
74
39
#     (...)
75
40
#     local-monitors:
76
41
#       interface: local-monitors
77
42
#       scope: container
78
43
79
44
#
80
45
# 2. Add the following to config.yaml
81
46
#
82
47
#    nagios_context:
83
48
#      default: "juju"
84
49
#      type: string
85
50
#      description: |
86
51
#        Used by the nrpe subordinate charms.
87
52
#        A string that will be prepended to instance name to set the host name
88
53
#        in nagios. So for instance the hostname would be something like:
89
54
#            juju-myservice-0
90
55
#        If you're running multiple environments with the same services in them
91
56
#        this allows you to differentiate between them.
92
57
#
93
58
# 3. Add custom checks (Nagios plugins) to files/nrpe-external-master
94
59
#
95
60
# 4. Update your hooks.py with something like this:
96
61
#
97
62
#    from charmsupport.nrpe import NRPE
98
63
#    (...)
99
64
#    def update_nrpe_config():
100
65
#        nrpe_compat = NRPE()
101
66
#        nrpe_compat.add_check(
102
67
#            shortname = "myservice",
103
68
#            description = "Check MyService",
104
69
#            check_cmd = "check_http -w 2 -c 10 http://localhost"
105
70
#            )
106
71
#        nrpe_compat.add_check(
107
72
#            "myservice_other",
108
73
#            "Check for widget failures",
109
74
#            check_cmd = "/srv/myapp/scripts/widget_check"
110
75
#            )
111
76
#        nrpe_compat.write()
112
77
#
113
78
#    def config_changed():
114
79
#        (...)
115
80
#        update_nrpe_config()
116
81
#
117
82
#    def nrpe_external_master_relation_changed():
118
83
#        update_nrpe_config()
119
84
#
120
85
#    def local_monitors_relation_changed():
121
86
#        update_nrpe_config()
122
87
#
123
88
# 5. ln -s hooks.py nrpe-external-master-relation-changed
124
89
#    ln -s hooks.py local-monitors-relation-changed
125
90
126
91
127
92
class CheckException(Exception):
128
93
    pass
129
94
130
95
131
96
class Check(object):
132
97
    shortname_re = '[A-Za-z0-9-_]+$'
133
98
    service_template = ("""
134
99
#---------------------------------------------------
135
100
# This file is Juju managed
136
101
#---------------------------------------------------
137
102
define service {{
138
103
    use                             active-service
139
104
    host_name                       {nagios_hostname}
140
105
    service_description             {nagios_hostname}[{shortname}] """
141
106
                        """{description}
142
107
    check_command                   check_nrpe!{command}
143
108
    servicegroups                   {nagios_servicegroup}
144
109
}}
145
110
""")
146
111
147
112
    def __init__(self, shortname, description, check_cmd):
148
113
        super(Check, self).__init__()
149
114
        # XXX: could be better to calculate this from the service name
150
115
        if not re.match(self.shortname_re, shortname):
151
116
            raise CheckException("shortname must match {}".format(
152
117
                Check.shortname_re))
153
118
        self.shortname = shortname
154
119
        self.command = "check_{}".format(shortname)
155
120
        # Note: a set of invalid characters is defined by the
156
121
        # Nagios server config
157
122
        # The default is: illegal_object_name_chars=`~!$%^&*"|'<>?,()=
158
123
        self.description = description
159
124
        self.check_cmd = self._locate_cmd(check_cmd)
160
125
161
126
    def _locate_cmd(self, check_cmd):
162
127
        search_path = (
163
128
            '/',
164
129
            os.path.join(os.environ['CHARM_DIR'],
165
130
                         'files/nrpe-external-master'),
166
131
            '/usr/lib/nagios/plugins',
167
132
            '/usr/local/lib/nagios/plugins',
168
133
        )
169
134
        parts = shlex.split(check_cmd)
170
135
        for path in search_path:
171
136
            if os.path.exists(os.path.join(path, parts[0])):
172
137
                command = os.path.join(path, parts[0])
173
138
                if len(parts) > 1:
174
139
                    command += " " + " ".join(parts[1:])
175
140
                return command
176
141
        log('Check command not found: {}'.format(parts[0]))
177
142
        return ''
178
143
179
144
    def write(self, nagios_context, hostname):
180
145
        nrpe_check_file = '/etc/nagios/nrpe.d/{}.cfg'.format(
181
146
            self.command)
182
147
        with open(nrpe_check_file, 'w') as nrpe_check_config:
183
148
            nrpe_check_config.write("# check {}\n".format(self.shortname))
184
149
            nrpe_check_config.write("command[{}]={}\n".format(
185
150
                self.command, self.check_cmd))
186
151
187
152
        if not os.path.exists(NRPE.nagios_exportdir):
188
153
            log('Not writing service config as {} is not accessible'.format(
189
154
                NRPE.nagios_exportdir))
190
155
        else:
191
156
            self.write_service_config(nagios_context, hostname)
192
157
193
158
    def write_service_config(self, nagios_context, hostname):
194
159
        for f in os.listdir(NRPE.nagios_exportdir):
195
160
            if re.search('.*{}.cfg'.format(self.command), f):
196
161
                os.remove(os.path.join(NRPE.nagios_exportdir, f))
197
162
198
163
        templ_vars = {
199
164
            'nagios_hostname': hostname,
200
165
            'nagios_servicegroup': nagios_context,
201
166
            'description': self.description,
202
167
            'shortname': self.shortname,
203
168
            'command': self.command,
204
169
        }
205
170
        nrpe_service_text = Check.service_template.format(**templ_vars)
206
171
        nrpe_service_file = '{}/service__{}_{}.cfg'.format(
207
172
            NRPE.nagios_exportdir, hostname, self.command)
208
173
        with open(nrpe_service_file, 'w') as nrpe_service_config:
209
174
            nrpe_service_config.write(str(nrpe_service_text))
210
175
211
176
    def run(self):
212
177
        subprocess.call(self.check_cmd)
213
178
214
179
215
180
class NRPE(object):
216
181
    nagios_logdir = '/var/log/nagios'
217
182
    nagios_exportdir = '/var/lib/nagios/export'
218
183
    nrpe_confdir = '/etc/nagios/nrpe.d'
219
184
220
185
    def __init__(self, hostname=None):
221
186
        super(NRPE, self).__init__()
222
187
        self.config = config()
223
188
        self.nagios_context = self.config['nagios_context']
224
189
        self.unit_name = local_unit().replace('/', '-')
225
190
        if hostname:
226
191
            self.hostname = hostname
227
192
        else:
228
193
            self.hostname = "{}-{}".format(self.nagios_context, self.unit_name)
229
194
        self.checks = []
230
195
231
196
    def add_check(self, *args, **kwargs):
232
197
        self.checks.append(Check(*args, **kwargs))
233
198
234
199
    def write(self):
235
200
        try:
236
201
            nagios_uid = pwd.getpwnam('nagios').pw_uid
237
202
            nagios_gid = grp.getgrnam('nagios').gr_gid
238
203
        except:
239
204
            log("Nagios user not set up, nrpe checks not updated")
240
205
            return
241
206
242
207
        if not os.path.exists(NRPE.nagios_logdir):
243
208
            os.mkdir(NRPE.nagios_logdir)
244
209
            os.chown(NRPE.nagios_logdir, nagios_uid, nagios_gid)
245
210
246
211
        nrpe_monitors = {}
247
212
        monitors = {"monitors": {"remote": {"nrpe": nrpe_monitors}}}
248
213
        for nrpecheck in self.checks:
249
214
            nrpecheck.write(self.nagios_context, self.hostname)
250
215
            nrpe_monitors[nrpecheck.shortname] = {
251
216
                "command": nrpecheck.command,
252
217
            }
253
218
254
219
        service('restart', 'nagios-nrpe-server')
255
220
256
221
        for rid in relation_ids("local-monitors"):
257
222
            relation_set(relation_id=rid, monitors=yaml.dump(monitors))
258
0
223
259
=== added file 'hooks/charmhelpers/contrib/charmsupport/volumes.py'
260
--- hooks/charmhelpers/contrib/charmsupport/volumes.py	1970-01-01 00:00:00 +0000
261
+++ hooks/charmhelpers/contrib/charmsupport/volumes.py	2014-11-18 01:29:44 +0000
262
@@ -0,0 +1,156 @@
263
1
'''
264
2
Functions for managing volumes in juju units. One volume is supported per unit.
265
3
Subordinates may have their own storage, provided it is on its own partition.
266
4
267
5
Configuration stanzas:
268
6
  volume-ephemeral:
269
7
    type: boolean
270
8
    default: true
271
9
    description: >
272
10
      If false, a volume is mounted as sepecified in "volume-map"
273
11
      If true, ephemeral storage will be used, meaning that log data
274
12
         will only exist as long as the machine. YOU HAVE BEEN WARNED.
275
13
  volume-map:
276
14
    type: string
277
15
    default: {}
278
16
    description: >
279
17
      YAML map of units to device names, e.g:
280
18
        "{ rsyslog/0: /dev/vdb, rsyslog/1: /dev/vdb }"
281
19
      Service units will raise a configure-error if volume-ephemeral
282
20
      is 'true' and no volume-map value is set. Use 'juju set' to set a
283
21
      value and 'juju resolved' to complete configuration.
284
22
285
23
Usage:
286
24
    from charmsupport.volumes import configure_volume, VolumeConfigurationError
287
25
    from charmsupport.hookenv import log, ERROR
288
26
    def post_mount_hook():
289
27
        stop_service('myservice')
290
28
    def post_mount_hook():
291
29
        start_service('myservice')
292
30
293
31
    if __name__ == '__main__':
294
32
        try:
295
33
            configure_volume(before_change=pre_mount_hook,
296
34
                             after_change=post_mount_hook)
297
35
        except VolumeConfigurationError:
298
36
            log('Storage could not be configured', ERROR)
299
37
'''
300
38
301
39
# XXX: Known limitations
302
40
# - fstab is neither consulted nor updated
303
41
304
42
import os
305
43
from charmhelpers.core import hookenv
306
44
from charmhelpers.core import host
307
45
import yaml
308
46
309
47
310
48
MOUNT_BASE = '/srv/juju/volumes'
311
49
312
50
313
51
class VolumeConfigurationError(Exception):
314
52
    '''Volume configuration data is missing or invalid'''
315
53
    pass
316
54
317
55
318
56
def get_config():
319
57
    '''Gather and sanity-check volume configuration data'''
320
58
    volume_config = {}
321
59
    config = hookenv.config()
322
60
323
61
    errors = False
324
62
325
63
    if config.get('volume-ephemeral') in (True, 'True', 'true', 'Yes', 'yes'):
326
64
        volume_config['ephemeral'] = True
327
65
    else:
328
66
        volume_config['ephemeral'] = False
329
67
330
68
    try:
331
69
        volume_map = yaml.safe_load(config.get('volume-map', '{}'))
332
70
    except yaml.YAMLError as e:
333
71
        hookenv.log("Error parsing YAML volume-map: {}".format(e),
334
72
                    hookenv.ERROR)
335
73
        errors = True
336
74
    if volume_map is None:
337
75
        # probably an empty string
338
76
        volume_map = {}
339
77
    elif not isinstance(volume_map, dict):
340
78
        hookenv.log("Volume-map should be a dictionary, not {}".format(
341
79
            type(volume_map)))
342
80
        errors = True
343
81
344
82
    volume_config['device'] = volume_map.get(os.environ['JUJU_UNIT_NAME'])
345
83
    if volume_config['device'] and volume_config['ephemeral']:
346
84
        # asked for ephemeral storage but also defined a volume ID
347
85
        hookenv.log('A volume is defined for this unit, but ephemeral '
348
86
                    'storage was requested', hookenv.ERROR)
349
87
        errors = True
350
88
    elif not volume_config['device'] and not volume_config['ephemeral']:
351
89
        # asked for permanent storage but did not define volume ID
352
90
        hookenv.log('Ephemeral storage was requested, but there is no volume '
353
91
                    'defined for this unit.', hookenv.ERROR)
354
92
        errors = True
355
93
356
94
    unit_mount_name = hookenv.local_unit().replace('/', '-')
357
95
    volume_config['mountpoint'] = os.path.join(MOUNT_BASE, unit_mount_name)
358
96
359
97
    if errors:
360
98
        return None
361
99
    return volume_config
362
100
363
101
364
102
def mount_volume(config):
365
103
    if os.path.exists(config['mountpoint']):
366
104
        if not os.path.isdir(config['mountpoint']):
367
105
            hookenv.log('Not a directory: {}'.format(config['mountpoint']))
368
106
            raise VolumeConfigurationError()
369
107
    else:
370
108
        host.mkdir(config['mountpoint'])
371
109
    if os.path.ismount(config['mountpoint']):
372
110
        unmount_volume(config)
373
111
    if not host.mount(config['device'], config['mountpoint'], persist=True):
374
112
        raise VolumeConfigurationError()
375
113
376
114
377
115
def unmount_volume(config):
378
116
    if os.path.ismount(config['mountpoint']):
379
117
        if not host.umount(config['mountpoint'], persist=True):
380
118
            raise VolumeConfigurationError()
381
119
382
120
383
121
def managed_mounts():
384
122
    '''List of all mounted managed volumes'''
385
123
    return filter(lambda mount: mount[0].startswith(MOUNT_BASE), host.mounts())
386
124
387
125
388
126
def configure_volume(before_change=lambda: None, after_change=lambda: None):
389
127
    '''Set up storage (or don't) according to the charm's volume configuration.
390
128
       Returns the mount point or "ephemeral". before_change and after_change
391
129
       are optional functions to be called if the volume configuration changes.
392
130
    '''
393
131
394
132
    config = get_config()
395
133
    if not config:
396
134
        hookenv.log('Failed to read volume configuration', hookenv.CRITICAL)
397
135
        raise VolumeConfigurationError()
398
136
399
137
    if config['ephemeral']:
400
138
        if os.path.ismount(config['mountpoint']):
401
139
            before_change()
402
140
            unmount_volume(config)
403
141
            after_change()
404
142
        return 'ephemeral'
405
143
    else:
406
144
        # persistent storage
407
145
        if os.path.ismount(config['mountpoint']):
408
146
            mounts = dict(managed_mounts())
409
147
            if mounts.get(config['mountpoint']) != config['device']:
410
148
                before_change()
411
149
                unmount_volume(config)
412
150
                mount_volume(config)
413
151
                after_change()
414
152
        else:
415
153
            before_change()
416
154
            mount_volume(config)
417
155
            after_change()
418
156
        return config['mountpoint']
419
0
157
420
=== added symlink 'hooks/nrpe-external-master-relation-changed'
421
=== target is u'swift_hooks.py'
422
=== added symlink 'hooks/nrpe-external-master-relation-joined'
423
=== target is u'swift_hooks.py'
424
=== modified file 'hooks/swift_hooks.py'
425
--- hooks/swift_hooks.py	2014-10-23 16:17:57 +0000
426
+++ hooks/swift_hooks.py	2014-11-18 01:29:44 +0000
427
@@ -11,6 +11,7 @@
428
11
from swift_utils import (
11
from swift_utils import (
429
12
    register_configs,
12
    register_configs,
430
13
    restart_map,
13
    restart_map,
431
14
    services,
432
14
    determine_packages,
15
    determine_packages,
433
15
    ensure_swift_dir,
16
    ensure_swift_dir,
434
16
    SWIFT_RINGS, get_www_dir,
17
    SWIFT_RINGS, get_www_dir,
435
@@ -35,10 +36,16 @@
436
35
    relation_set,
36
    relation_set,
437
36
    relation_ids,
37
    relation_ids,
438
37
    relation_get,
38
    relation_get,
439
39
<<<<<<< TREE
440
38
    log,
40
    log,
441
39
    INFO,
41
    INFO,
442
40
    WARNING,
42
    WARNING,
443
41
    ERROR,
43
    ERROR,
444
44
=======
445
45
    relations_of_type,
446
46
    local_unit,
447
47
    log, ERROR,
448
48
>>>>>>> MERGE-SOURCE
449
42
    Hooks, UnregisteredHookError,
49
    Hooks, UnregisteredHookError,
450
43
    open_port
50
    open_port
451
44
)
51
)
452
@@ -69,6 +76,8 @@
453
69
76
454
70
from charmhelpers.contrib.openstack.context import ADDRESS_TYPES
77
from charmhelpers.contrib.openstack.context import ADDRESS_TYPES
455
71
78
456
79
from charmhelpers.contrib.charmsupport.nrpe import NRPE
457
80
458
72
extra_pkgs = [
81
extra_pkgs = [
459
73
    "haproxy",
82
    "haproxy",
460
74
    "python-jinja2"
83
    "python-jinja2"
461
@@ -275,6 +284,7 @@
462
275
284
463
276
    configure_https()
285
    configure_https()
464
277
    open_port(config('bind-port'))
286
    open_port(config('bind-port'))
465
287
    update_nrpe_config()
466
278
    # Determine whether or not we should do an upgrade, based on the
288
    # Determine whether or not we should do an upgrade, based on the
467
279
    # the version offered in keyston-release.
289
    # the version offered in keyston-release.
468
280
    if (openstack.openstack_upgrade_available('python-swift')):
290
    if (openstack.openstack_upgrade_available('python-swift')):
469
@@ -454,6 +464,57 @@
470
454
    write_rc_script()
464
    write_rc_script()
471
455
465
472
456
466
473
467
@hooks.hook('nrpe-external-master-relation-joined',
474
468
            'nrpe-external-master-relation-changed')
475
469
def update_nrpe_config():
476
470
    apt_install('python-dbus')
477
471
    # Find out if nrpe set nagios_hostname
478
472
    hostname = None
479
473
    host_context = None
480
474
    for rel in relations_of_type('nrpe-external-master'):
481
475
        if 'nagios_hostname' in rel:
482
476
            hostname = rel['nagios_hostname']
483
477
            host_context = rel['nagios_host_context']
484
478
            break
485
479
    nrpe = NRPE(hostname=hostname)
486
480
487
481
    if host_context:
488
482
        current_unit = "%s:%s" % (host_context, local_unit())
489
483
    else:
490
484
        current_unit = local_unit()
491
485
492
486
    services_to_monitor = services()
493
487
    for service in services_to_monitor:
494
488
        upstart_init = '/etc/init/%s.conf' % service
495
489
        sysv_init = '/etc/init.d/%s' % service
496
490
497
491
        if os.path.exists(upstart_init):
498
492
            nrpe.add_check(
499
493
                shortname=service,
500
494
                description='process check {%s}' % current_unit,
501
495
                check_cmd='check_upstart_job %s' % service,
502
496
                )
503
497
        elif os.path.exists(sysv_init):
504
498
            cronpath = '/etc/cron.d/nagios-service-check-%s' % service
505
499
            checkpath = os.path.join(os.environ['CHARM_DIR'],
506
500
                                     'files/nrpe-external-master',
507
501
                                     'check_exit_status.pl'),
508
502
            cron_template = '*/5 * * * * root \
509
503
/usr/local/lib/nagios/plugins/check_exit_status.pl -s /etc/init.d/%s \
510
504
status > /var/lib/nagios/service-check-%s.txt\n' % (service, service)
511
505
            f = open(cronpath, 'w')
512
506
            f.write(cron_template)
513
507
            f.close()
514
508
            nrpe.add_check(
515
509
                shortname=service,
516
510
                description='process check {%s}' % current_unit,
517
511
                check_cmd='check_status_file.py -f \
518
512
/var/lib/nagios/service-check-%s.txt' % service,
519
513
                )
520
514
521
515
    nrpe.write()
522
516
523
517
524
457
def main():
518
def main():
525
458
    try:
519
    try:
526
459
        hooks.execute(sys.argv)
520
        hooks.execute(sys.argv)
527
460
521
528
=== modified file 'hooks/swift_utils.py'
529
--- hooks/swift_utils.py	2014-10-21 08:32:52 +0000
530
+++ hooks/swift_utils.py	2014-11-18 01:29:44 +0000
531
@@ -166,6 +166,14 @@
532
166
    return OrderedDict(_map)
166
    return OrderedDict(_map)
533
167
167
534
168
168
535
169
def services():
536
170
    ''' Returns a list of services associate with this charm '''
537
171
    _services = []
538
172
    for v in restart_map().values():
539
173
        _services = _services + v
540
174
    return list(set(_services))
541
175
542
176
543
169
def swift_user(username='swift'):
177
def swift_user(username='swift'):
544
170
    user = pwd.getpwnam(username)
178
    user = pwd.getpwnam(username)
545
171
    return (user.pw_uid, user.pw_gid)
179
    return (user.pw_uid, user.pw_gid)
546
172
180
547
=== modified file 'metadata.yaml'
548
--- metadata.yaml	2013-07-11 19:18:37 +0000
549
+++ metadata.yaml	2014-11-18 01:29:44 +0000
550
@@ -7,6 +7,9 @@
551
7
categories:
7
categories:
552
8
    - cache-proxy
8
    - cache-proxy
553
9
provides:
9
provides:
554
10
  nrpe-external-master:
555
11
    interface: nrpe-external-master
556
12
    scope: container
557
10
  object-store:
13
  object-store:
558
11
    interface: swift-proxy
14
    interface: swift-proxy
559
12
requires:
15
requires:
Reviewer	Review Type	Date Requested	Status
Liam Young (community)		2014-11-12	Disapprove on 2015-01-09
Review via email: mp+241484@code.launchpad.net