1
=== modified file 'charm-helpers.yaml'
2
--- charm-helpers.yaml	2015-01-26 10:44:46 +0000
3
+++ charm-helpers.yaml	2015-04-20 00:40:18 +0000
4
@@ -9,3 +9,4 @@
5
9
    - contrib.network.ip
9
    - contrib.network.ip
6
10
    - contrib.openstack.utils
10
    - contrib.openstack.utils
7
11
    - contrib.python.packages
11
    - contrib.python.packages
8
12
    - contrib.charmsupport
9
12
13
10
=== modified file 'config.yaml'
11
--- config.yaml	2015-04-14 10:16:50 +0000
12
+++ config.yaml	2015-04-20 00:40:18 +0000
13
@@ -97,3 +97,19 @@
14
97
    default: False
97
    default: False
15
98
    type: boolean
98
    type: boolean
16
99
    description: Enable debug logging
99
    description: Enable debug logging
17
100
  nagios_context:
18
101
    default: "juju"
19
102
    type: string
20
103
    description: |
21
104
        Used by the nrpe-external-master subordinate charm.
22
105
        A string that will be prepended to instance name to set the host name
23
106
        in nagios. So for instance the hostname would be something like:
24
107
            juju-postgresql-0
25
108
        If you're running multiple environments with the same services in them
26
109
        this allows you to differentiate between them.
27
110
  nagios_servicegroups:
28
111
    default: ""
29
112
    type: string
30
113
    description: |
31
114
        A comma-separated list of nagios servicegroups.
32
115
        If left empty, the nagios_context will be used as the servicegroup
33
100
116
34
=== added directory 'files'
35
=== added directory 'files/nrpe'
36
=== added file 'files/nrpe/check_corosync_rings'
37
--- files/nrpe/check_corosync_rings	1970-01-01 00:00:00 +0000
38
+++ files/nrpe/check_corosync_rings	2015-04-20 00:40:18 +0000
39
@@ -0,0 +1,99 @@
40
1
#!/usr/bin/perl
41
2
#
42
3
# check_corosync_rings
43
4
#
44
5
# Copyright © 2011 Phil Garner, Sysnix Consultants Limited
45
6
#
46
7
#    This program is free software: you can redistribute it and/or modify
47
8
#    it under the terms of the GNU General Public License as published by
48
9
#    the Free Software Foundation, either version 3 of the License, or
49
10
#    (at your option) any later version.
50
11
#
51
12
#    This program is distributed in the hope that it will be useful,
52
13
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
53
14
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
54
15
#    GNU General Public License for more details.
55
16
#
56
17
#    You should have received a copy of the GNU General Public License
57
18
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
58
19
#
59
20
# Authors: Phil Garner - phil@sysnix.com & Peter Mottram peter@sysnix.com
60
21
#
61
22
# v0.1 05/01/2011
62
23
# v0.2 31/10/2011 - additional crit when closing the file handle and additional 
63
24
#                   comments added
64
25
#
65
26
# NOTE:- Requires Perl 5.8 or higher & the Perl Module Nagios::Plugin
66
27
#        Nagios user will need sudo acces - suggest adding line below to
67
28
#        sudoers.
68
29
#        nagios  ALL=(ALL) NOPASSWD: /usr/sbin/corosync-cfgtool -s
69
30
#
70
31
#        In sudoers if requiretty is on (off state is default)
71
32
#        you will also need to add the line below
72
33
#        Defaults:nagios !requiretty
73
34
#
74
35
75
36
use warnings;
76
37
use strict;
77
38
use Nagios::Plugin;
78
39
79
40
# Lines below may need changing if corosync-cfgtool or sudo installed in a
80
41
# diffrent location.
81
42
82
43
my $sudo    = '/usr/bin/sudo';
83
44
my $cfgtool = '/usr/sbin/corosync-cfgtool -s';
84
45
85
46
# Now set up the plugin
86
47
my $np = Nagios::Plugin->new(
87
48
    shortname => 'check_cororings',
88
49
    version   => '0.2',
89
50
    usage     => "Usage: %s <ARGS>\n\t\t--help for help\n",
90
51
    license   => "License - GPL v3 see code for more details",
91
52
    url       => "http://www.sysnix.com",
92
53
    blurb =>
93
54
"\tNagios plugin that checks the status of corosync rings, requires Perl         \t5.8+ and CPAN modules Nagios::Plugin.",
94
55
);
95
56
96
57
#Args
97
58
$np->add_arg(
98
59
    spec => 'rings|r=s',
99
60
    help =>
100
61
'How many rings should be running (optinal) sends Crit if incorrect number of rings found.',
101
62
    required => 0,
102
63
);
103
64
104
65
$np->getopts;
105
66
106
67
my $found = 0;
107
68
my $fh;
108
69
my $rings = $np->opts->rings;
109
70
110
71
# Run cfgtools spin through output and get info needed
111
72
112
73
open( $fh, "$sudo $cfgtool |" )
113
74
  or $np->nagios_exit( CRITICAL, "Running corosync-cfgtool failed" );
114
75
115
76
foreach my $line (<$fh>) {
116
77
    if ( $line =~ m/status\s*=\s*(\S.+)/ ) {
117
78
        my $status = $1;
118
79
        if ( $status =~ m/^ring (\d+) active with no faults/ ) {
119
80
            $np->add_message( OK, "ring $1 OK" );
120
81
        }
121
82
        else {
122
83
            $np->add_message( CRITICAL, $status );
123
84
        }
124
85
        $found++;
125
86
    }
126
87
}
127
88
128
89
close($fh) or $np->nagios_exit( CRITICAL, "Running corosync-cfgtool failed" );
129
90
130
91
# Check we found some rings and apply -r arg if needed
131
92
if ( $found == 0 ) {
132
93
    $np->nagios_exit( CRITICAL, "No Rings Found" );
133
94
}
134
95
elsif ( defined $rings && $rings != $found ) {
135
96
    $np->nagios_exit( CRITICAL, "Expected $rings rings but found $found" );
136
97
}
137
98
138
99
$np->nagios_exit( $np->check_messages() );
139
0
100
140
=== added file 'files/nrpe/check_crm'
141
--- files/nrpe/check_crm	1970-01-01 00:00:00 +0000
142
+++ files/nrpe/check_crm	2015-04-20 00:40:18 +0000
143
@@ -0,0 +1,201 @@
144
1
#!/usr/bin/perl
145
2
#
146
3
# check_crm_v0_7
147
4
#
148
5
# Copyright © 2013 Philip Garner, Sysnix Consultants Limited
149
6
#
150
7
#    This program is free software: you can redistribute it and/or modify
151
8
#    it under the terms of the GNU General Public License as published by
152
9
#    the Free Software Foundation, either version 3 of the License, or
153
10
#    (at your option) any later version.
154
11
#
155
12
#    This program is distributed in the hope that it will be useful,
156
13
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
157
14
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
158
15
#    GNU General Public License for more details.
159
16
#
160
17
#    You should have received a copy of the GNU General Public License
161
18
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
162
19
#
163
20
# Authors: Phil Garner - phil@sysnix.com & Peter Mottram - peter@sysnix.com
164
21
#
165
22
# v0.1 09/01/2011
166
23
# v0.2 11/01/2011
167
24
# v0.3 22/08/2011 - bug fix and changes suggested by Vadym Chepkov
168
25
# v0.4 23/08/2011 - update for spelling and anchor regex capture (Vadym Chepkov)
169
26
# v0.5 29/09/2011 - Add standby warn/crit suggested by Sönke Martens & removal
170
27
#                   of 'our' to 'my' to completely avoid problems with ePN
171
28
# v0.6 14/03/2013 - Change from \w+ to \S+ in stopped check to cope with
172
29
#                   Servers that have non word charachters in.  Suggested by
173
30
#                   Igal Baevsky.
174
31
# v0.7 01/09/2013 - In testing as still not fully tested.  Adds optional 
175
32
#		    constraints check (Boris Wesslowski). Adds fail count 
176
33
#		    threshold ( Zoran Bosnjak & Marko Hrastovec )
177
34
#
178
35
# NOTES: Requires Perl 5.8 or higher & the Perl Module Nagios::Plugin
179
36
#        Nagios user will need sudo acces - suggest adding line below to
180
37
#        sudoers
181
38
#	     nagios  ALL=(ALL) NOPASSWD: /usr/sbin/crm_mon -1 -r -f
182
39
#
183
40
#		if you want to check for location constraints (-c) also add
184
41
#	     nagios  ALL=(ALL) NOPASSWD: /usr/sbin/crm configure show
185
42
#
186
43
#	     In sudoers if requiretty is on (off state is default)
187
44
#	     you will also need to add the line below
188
45
#	     Defaults:nagios !requiretty
189
46
#
190
47
191
48
use warnings;
192
49
use strict;
193
50
use Nagios::Plugin;
194
51
195
52
# Lines below may need changing if crm_mon or sudo installed in a
196
53
# different location.
197
54
198
55
my $sudo               = '/usr/bin/sudo';
199
56
my $crm_mon            = '/usr/sbin/crm_mon -1 -r -f';
200
57
my $crm_configure_show = '/usr/sbin/crm configure show';
201
58
202
59
my $np = Nagios::Plugin->new(
203
60
    shortname => 'check_crm',
204
61
    version   => '0.7',
205
62
    usage     => "Usage: %s <ARGS>\n\t\t--help for help\n",
206
63
);
207
64
208
65
$np->add_arg(
209
66
    spec => 'warning|w',
210
67
    help =>
211
68
'If failed Nodes, stopped Resources detected or Standby Nodes sends Warning instead of Critical (default) as long as there are no other errors and there is Quorum',
212
69
    required => 0,
213
70
);
214
71
215
72
$np->add_arg(
216
73
    spec     => 'standbyignore|s',
217
74
    help     => 'Ignore any node(s) in standby, by default sends Critical',
218
75
    required => 0,
219
76
);
220
77
221
78
$np->add_arg(
222
79
    spec => 'constraint|constraints|c',
223
80
    help => 'Also check configuration for location constraints (caused by migrations) and warn if there are any.  Requires additional privileges see notes',
224
81
    required => 0,
225
82
);
226
83
227
84
$np->add_arg(
228
85
    spec     => 'failcount|failcounts|f=i',
229
86
    help     => 'resource fail count to start warning on [default = 1].',
230
87
    required => 0,
231
88
    default  => 1,
232
89
);
233
90
234
91
$np->getopts;
235
92
my $ConstraintsFlag = $np->opts->constraint;
236
93
237
94
my @standby;
238
95
239
96
# Check for -w option set warn if this is case instead of crit
240
97
my $warn_or_crit = 'CRITICAL';
241
98
$warn_or_crit = 'WARNING' if $np->opts->warning;
242
99
243
100
my $fh;
244
101
245
102
open( $fh, "$sudo $crm_mon |" )
246
103
  or $np->nagios_exit( CRITICAL, "Running $sudo $crm_mon has failed" );
247
104
248
105
foreach my $line (<$fh>) {
249
106
250
107
    if ( $line =~ m/Connection to cluster failed\:(.*)/i ) {
251
108
252
109
        # Check Cluster connected
253
110
        $np->nagios_exit( CRITICAL, "Connection to cluster FAILED: $1" );
254
111
    }
255
112
    elsif ( $line =~ m/Current DC:/ ) {
256
113
257
114
        # Check for Quorum
258
115
        if ( $line =~ m/partition with quorum$/ ) {
259
116
260
117
            # Assume cluster is OK - we only add warn/crit after here
261
118
262
119
            $np->add_message( OK, "Cluster OK" );
263
120
        }
264
121
        else {
265
122
            $np->add_message( CRITICAL, "No Quorum" );
266
123
        }
267
124
    }
268
125
    elsif ( $line =~ m/^offline:\s*\[\s*(\S.*?)\s*\]/i ) {
269
126
270
127
        # Count offline nodes
271
128
        my @offline = split( /\s+/, $1 );
272
129
        my $numoffline = scalar @offline;
273
130
        $np->add_message( $warn_or_crit, ": $numoffline Nodes Offline" );
274
131
    }
275
132
    elsif ( $line =~ m/^node\s+(\S.*):\s*standby/i ) {
276
133
277
134
        # Check for standby nodes (suggested by Sönke Martens)
278
135
        # See later in code for message created from this
279
136
        push @standby, $1;
280
137
    }
281
138
282
139
    elsif ( $line =~ m/\s*(\S+)\s+\(\S+\)\:\s+Stopped/ ) {
283
140
284
141
        # Check Resources Stopped
285
142
        $np->add_message( $warn_or_crit, ": $1 Stopped" );
286
143
    }
287
144
    elsif ( $line =~ m/\s*stopped\:\s*\[(.*)\]/i ) {
288
145
289
146
        # Check Master/Slave stopped
290
147
        $np->add_message( $warn_or_crit, ": $1 Stopped" );
291
148
    }
292
149
    elsif ( $line =~ m/^Failed actions\:/ ) {
293
150
294
151
        # Check Failed Actions
295
152
        $np->add_message( CRITICAL,
296
153
            ": FAILED actions detected or not cleaned up" );
297
154
    }
298
155
    elsif ( $line =~ m/\s*(\S+?)\s+ \(.*\)\:\s+\w+\s+\w+\s+\(unmanaged\)\s+/i )
299
156
    {
300
157
301
158
        # Check Unmanaged
302
159
        $np->add_message( CRITICAL, ": $1 unmanaged FAILED" );
303
160
    }
304
161
    elsif ( $line =~ m/\s*(\S+?)\s+ \(.*\)\:\s+not installed/i ) {
305
162
306
163
        # Check for errors
307
164
        $np->add_message( CRITICAL, ": $1 not installed" );
308
165
    }
309
166
    elsif ( $line =~ m/\s*(\S+?):.*fail-count=(\d+)/i ) {
310
167
        if ( $2 >= $np->opts->failcount ) {
311
168
312
169
            # Check for resource Fail count (suggested by Vadym Chepkov)
313
170
            $np->add_message( WARNING, ": $1 failure detected, fail-count=$2" );
314
171
        }
315
172
    }
316
173
}
317
174
318
175
# If found any Nodes in standby & no -s option used send warn/crit
319
176
if ( scalar @standby > 0 && !$np->opts->standbyignore ) {
320
177
    $np->add_message( $warn_or_crit,
321
178
        ": " . join( ', ', @standby ) . " in Standby" );
322
179
}
323
180
324
181
close($fh) or $np->nagios_exit( CRITICAL, "Running $crm_mon FAILED" );
325
182
326
183
# if -c flag set check configuration for constraints
327
184
if ($ConstraintsFlag) {
328
185
329
186
    open( $fh, "$sudo $crm_configure_show|" )
330
187
      or $np->nagios_exit( CRITICAL,
331
188
        "Running $sudo $crm_configure_show has failed" );
332
189
333
190
    foreach my $line (<$fh>) {
334
191
        if ( $line =~ m/location cli-(prefer|standby)-\S+\s+(\S+)/ ) {
335
192
            $np->add_message( WARNING,
336
193
                ": $2 blocking location constraint detected" );
337
194
        }
338
195
    }
339
196
    close($fh)
340
197
      or $np->nagios_exit( CRITICAL, "Running $crm_configure_show FAILED" );
341
198
}
342
199
343
200
$np->nagios_exit( $np->check_messages() );
344
201
345
0
202
346
=== added directory 'files/sudoers'
347
=== added file 'files/sudoers/nagios'
348
--- files/sudoers/nagios	1970-01-01 00:00:00 +0000
349
+++ files/sudoers/nagios	2015-04-20 00:40:18 +0000
350
@@ -0,0 +1,5 @@
351
1
Defaults:nagios !requiretty
352
2
353
3
nagios  ALL=(ALL) NOPASSWD: /usr/sbin/corosync-cfgtool -s
354
4
nagios  ALL=(ALL) NOPASSWD: /usr/sbin/crm_mon -1 -r -f
355
5
nagios  ALL=(ALL) NOPASSWD: /usr/sbin/crm configure show
356
0
6
357
=== added directory 'hooks/charmhelpers/contrib/charmsupport'
358
=== added file 'hooks/charmhelpers/contrib/charmsupport/__init__.py'
359
--- hooks/charmhelpers/contrib/charmsupport/__init__.py	1970-01-01 00:00:00 +0000
360
+++ hooks/charmhelpers/contrib/charmsupport/__init__.py	2015-04-20 00:40:18 +0000
361
@@ -0,0 +1,15 @@
362
1
# Copyright 2014-2015 Canonical Limited.
363
2
#
364
3
# This file is part of charm-helpers.
365
4
#
366
5
# charm-helpers is free software: you can redistribute it and/or modify
367
6
# it under the terms of the GNU Lesser General Public License version 3 as
368
7
# published by the Free Software Foundation.
369
8
#
370
9
# charm-helpers is distributed in the hope that it will be useful,
371
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
372
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
373
12
# GNU Lesser General Public License for more details.
374
13
#
375
14
# You should have received a copy of the GNU Lesser General Public License
376
15
# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
377
0
16
378
=== added file 'hooks/charmhelpers/contrib/charmsupport/nrpe.py'
379
--- hooks/charmhelpers/contrib/charmsupport/nrpe.py	1970-01-01 00:00:00 +0000
380
+++ hooks/charmhelpers/contrib/charmsupport/nrpe.py	2015-04-20 00:40:18 +0000
381
@@ -0,0 +1,360 @@
382
1
# Copyright 2014-2015 Canonical Limited.
383
2
#
384
3
# This file is part of charm-helpers.
385
4
#
386
5
# charm-helpers is free software: you can redistribute it and/or modify
387
6
# it under the terms of the GNU Lesser General Public License version 3 as
388
7
# published by the Free Software Foundation.
389
8
#
390
9
# charm-helpers is distributed in the hope that it will be useful,
391
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
392
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
393
12
# GNU Lesser General Public License for more details.
394
13
#
395
14
# You should have received a copy of the GNU Lesser General Public License
396
15
# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
397
16
398
17
"""Compatibility with the nrpe-external-master charm"""
399
18
# Copyright 2012 Canonical Ltd.
400
19
#
401
20
# Authors:
402
21
#  Matthew Wedgwood <matthew.wedgwood@canonical.com>
403
22
404
23
import subprocess
405
24
import pwd
406
25
import grp
407
26
import os
408
27
import glob
409
28
import shutil
410
29
import re
411
30
import shlex
412
31
import yaml
413
32
414
33
from charmhelpers.core.hookenv import (
415
34
    config,
416
35
    local_unit,
417
36
    log,
418
37
    relation_ids,
419
38
    relation_set,
420
39
    relations_of_type,
421
40
)
422
41
423
42
from charmhelpers.core.host import service
424
43
425
44
# This module adds compatibility with the nrpe-external-master and plain nrpe
426
45
# subordinate charms. To use it in your charm:
427
46
#
428
47
# 1. Update metadata.yaml
429
48
#
430
49
#   provides:
431
50
#     (...)
432
51
#     nrpe-external-master:
433
52
#       interface: nrpe-external-master
434
53
#       scope: container
435
54
#
436
55
#   and/or
437
56
#
438
57
#   provides:
439
58
#     (...)
440
59
#     local-monitors:
441
60
#       interface: local-monitors
442
61
#       scope: container
443
62
444
63
#
445
64
# 2. Add the following to config.yaml
446
65
#
447
66
#    nagios_context:
448
67
#      default: "juju"
449
68
#      type: string
450
69
#      description: |
451
70
#        Used by the nrpe subordinate charms.
452
71
#        A string that will be prepended to instance name to set the host name
453
72
#        in nagios. So for instance the hostname would be something like:
454
73
#            juju-myservice-0
455
74
#        If you're running multiple environments with the same services in them
456
75
#        this allows you to differentiate between them.
457
76
#    nagios_servicegroups:
458
77
#      default: ""
459
78
#      type: string
460
79
#      description: |
461
80
#        A comma-separated list of nagios servicegroups.
462
81
#        If left empty, the nagios_context will be used as the servicegroup
463
82
#
464
83
# 3. Add custom checks (Nagios plugins) to files/nrpe-external-master
465
84
#
466
85
# 4. Update your hooks.py with something like this:
467
86
#
468
87
#    from charmsupport.nrpe import NRPE
469
88
#    (...)
470
89
#    def update_nrpe_config():
471
90
#        nrpe_compat = NRPE()
472
91
#        nrpe_compat.add_check(
473
92
#            shortname = "myservice",
474
93
#            description = "Check MyService",
475
94
#            check_cmd = "check_http -w 2 -c 10 http://localhost"
476
95
#            )
477
96
#        nrpe_compat.add_check(
478
97
#            "myservice_other",
479
98
#            "Check for widget failures",
480
99
#            check_cmd = "/srv/myapp/scripts/widget_check"
481
100
#            )
482
101
#        nrpe_compat.write()
483
102
#
484
103
#    def config_changed():
485
104
#        (...)
486
105
#        update_nrpe_config()
487
106
#
488
107
#    def nrpe_external_master_relation_changed():
489
108
#        update_nrpe_config()
490
109
#
491
110
#    def local_monitors_relation_changed():
492
111
#        update_nrpe_config()
493
112
#
494
113
# 5. ln -s hooks.py nrpe-external-master-relation-changed
495
114
#    ln -s hooks.py local-monitors-relation-changed
496
115
497
116
498
117
class CheckException(Exception):
499
118
    pass
500
119
501
120
502
121
class Check(object):
503
122
    shortname_re = '[A-Za-z0-9-_]+$'
504
123
    service_template = ("""
505
124
#---------------------------------------------------
506
125
# This file is Juju managed
507
126
#---------------------------------------------------
508
127
define service {{
509
128
    use                             active-service
510
129
    host_name                       {nagios_hostname}
511
130
    service_description             {nagios_hostname}[{shortname}] """
512
131
                        """{description}
513
132
    check_command                   check_nrpe!{command}
514
133
    servicegroups                   {nagios_servicegroup}
515
134
}}
516
135
""")
517
136
518
137
    def __init__(self, shortname, description, check_cmd):
519
138
        super(Check, self).__init__()
520
139
        # XXX: could be better to calculate this from the service name
521
140
        if not re.match(self.shortname_re, shortname):
522
141
            raise CheckException("shortname must match {}".format(
523
142
                Check.shortname_re))
524
143
        self.shortname = shortname
525
144
        self.command = "check_{}".format(shortname)
526
145
        # Note: a set of invalid characters is defined by the
527
146
        # Nagios server config
528
147
        # The default is: illegal_object_name_chars=`~!$%^&*"|'<>?,()=
529
148
        self.description = description
530
149
        self.check_cmd = self._locate_cmd(check_cmd)
531
150
532
151
    def _locate_cmd(self, check_cmd):
533
152
        search_path = (
534
153
            '/usr/lib/nagios/plugins',
535
154
            '/usr/local/lib/nagios/plugins',
536
155
        )
537
156
        parts = shlex.split(check_cmd)
538
157
        for path in search_path:
539
158
            if os.path.exists(os.path.join(path, parts[0])):
540
159
                command = os.path.join(path, parts[0])
541
160
                if len(parts) > 1:
542
161
                    command += " " + " ".join(parts[1:])
543
162
                return command
544
163
        log('Check command not found: {}'.format(parts[0]))
545
164
        return ''
546
165
547
166
    def write(self, nagios_context, hostname, nagios_servicegroups):
548
167
        nrpe_check_file = '/etc/nagios/nrpe.d/{}.cfg'.format(
549
168
            self.command)
550
169
        with open(nrpe_check_file, 'w') as nrpe_check_config:
551
170
            nrpe_check_config.write("# check {}\n".format(self.shortname))
552
171
            nrpe_check_config.write("command[{}]={}\n".format(
553
172
                self.command, self.check_cmd))
554
173
555
174
        if not os.path.exists(NRPE.nagios_exportdir):
556
175
            log('Not writing service config as {} is not accessible'.format(
557
176
                NRPE.nagios_exportdir))
558
177
        else:
559
178
            self.write_service_config(nagios_context, hostname,
560
179
                                      nagios_servicegroups)
561
180
562
181
    def write_service_config(self, nagios_context, hostname,
563
182
                             nagios_servicegroups):
564
183
        for f in os.listdir(NRPE.nagios_exportdir):
565
184
            if re.search('.*{}.cfg'.format(self.command), f):
566
185
                os.remove(os.path.join(NRPE.nagios_exportdir, f))
567
186
568
187
        templ_vars = {
569
188
            'nagios_hostname': hostname,
570
189
            'nagios_servicegroup': nagios_servicegroups,
571
190
            'description': self.description,
572
191
            'shortname': self.shortname,
573
192
            'command': self.command,
574
193
        }
575
194
        nrpe_service_text = Check.service_template.format(**templ_vars)
576
195
        nrpe_service_file = '{}/service__{}_{}.cfg'.format(
577
196
            NRPE.nagios_exportdir, hostname, self.command)
578
197
        with open(nrpe_service_file, 'w') as nrpe_service_config:
579
198
            nrpe_service_config.write(str(nrpe_service_text))
580
199
581
200
    def run(self):
582
201
        subprocess.call(self.check_cmd)
583
202
584
203
585
204
class NRPE(object):
586
205
    nagios_logdir = '/var/log/nagios'
587
206
    nagios_exportdir = '/var/lib/nagios/export'
588
207
    nrpe_confdir = '/etc/nagios/nrpe.d'
589
208
590
209
    def __init__(self, hostname=None):
591
210
        super(NRPE, self).__init__()
592
211
        self.config = config()
593
212
        self.nagios_context = self.config['nagios_context']
594
213
        if 'nagios_servicegroups' in self.config and self.config['nagios_servicegroups']:
595
214
            self.nagios_servicegroups = self.config['nagios_servicegroups']
596
215
        else:
597
216
            self.nagios_servicegroups = self.nagios_context
598
217
        self.unit_name = local_unit().replace('/', '-')
599
218
        if hostname:
600
219
            self.hostname = hostname
601
220
        else:
602
221
            self.hostname = "{}-{}".format(self.nagios_context, self.unit_name)
603
222
        self.checks = []
604
223
605
224
    def add_check(self, *args, **kwargs):
606
225
        self.checks.append(Check(*args, **kwargs))
607
226
608
227
    def write(self):
609
228
        try:
610
229
            nagios_uid = pwd.getpwnam('nagios').pw_uid
611
230
            nagios_gid = grp.getgrnam('nagios').gr_gid
612
231
        except:
613
232
            log("Nagios user not set up, nrpe checks not updated")
614
233
            return
615
234
616
235
        if not os.path.exists(NRPE.nagios_logdir):
617
236
            os.mkdir(NRPE.nagios_logdir)
618
237
            os.chown(NRPE.nagios_logdir, nagios_uid, nagios_gid)
619
238
620
239
        nrpe_monitors = {}
621
240
        monitors = {"monitors": {"remote": {"nrpe": nrpe_monitors}}}
622
241
        for nrpecheck in self.checks:
623
242
            nrpecheck.write(self.nagios_context, self.hostname,
624
243
                            self.nagios_servicegroups)
625
244
            nrpe_monitors[nrpecheck.shortname] = {
626
245
                "command": nrpecheck.command,
627
246
            }
628
247
629
248
        service('restart', 'nagios-nrpe-server')
630
249
631
250
        monitor_ids = relation_ids("local-monitors") + \
632
251
            relation_ids("nrpe-external-master")
633
252
        for rid in monitor_ids:
634
253
            relation_set(relation_id=rid, monitors=yaml.dump(monitors))
635
254
636
255
637
256
def get_nagios_hostcontext(relation_name='nrpe-external-master'):
638
257
    """
639
258
    Query relation with nrpe subordinate, return the nagios_host_context
640
259
641
260
    :param str relation_name: Name of relation nrpe sub joined to
642
261
    """
643
262
    for rel in relations_of_type(relation_name):
644
263
        if 'nagios_hostname' in rel:
645
264
            return rel['nagios_host_context']
646
265
647
266
648
267
def get_nagios_hostname(relation_name='nrpe-external-master'):
649
268
    """
650
269
    Query relation with nrpe subordinate, return the nagios_hostname
651
270
652
271
    :param str relation_name: Name of relation nrpe sub joined to
653
272
    """
654
273
    for rel in relations_of_type(relation_name):
655
274
        if 'nagios_hostname' in rel:
656
275
            return rel['nagios_hostname']
657
276
658
277
659
278
def get_nagios_unit_name(relation_name='nrpe-external-master'):
660
279
    """
661
280
    Return the nagios unit name prepended with host_context if needed
662
281
663
282
    :param str relation_name: Name of relation nrpe sub joined to
664
283
    """
665
284
    host_context = get_nagios_hostcontext(relation_name)
666
285
    if host_context:
667
286
        unit = "%s:%s" % (host_context, local_unit())
668
287
    else:
669
288
        unit = local_unit()
670
289
    return unit
671
290
672
291
673
292
def add_init_service_checks(nrpe, services, unit_name):
674
293
    """
675
294
    Add checks for each service in list
676
295
677
296
    :param NRPE nrpe: NRPE object to add check to
678
297
    :param list services: List of services to check
679
298
    :param str unit_name: Unit name to use in check description
680
299
    """
681
300
    for svc in services:
682
301
        upstart_init = '/etc/init/%s.conf' % svc
683
302
        sysv_init = '/etc/init.d/%s' % svc
684
303
        if os.path.exists(upstart_init):
685
304
            nrpe.add_check(
686
305
                shortname=svc,
687
306
                description='process check {%s}' % unit_name,
688
307
                check_cmd='check_upstart_job %s' % svc
689
308
            )
690
309
        elif os.path.exists(sysv_init):
691
310
            cronpath = '/etc/cron.d/nagios-service-check-%s' % svc
692
311
            cron_file = ('*/5 * * * * root '
693
312
                         '/usr/local/lib/nagios/plugins/check_exit_status.pl '
694
313
                         '-s /etc/init.d/%s status > '
695
314
                         '/var/lib/nagios/service-check-%s.txt\n' % (svc,
696
315
                                                                     svc)
697
316
                         )
698
317
            f = open(cronpath, 'w')
699
318
            f.write(cron_file)
700
319
            f.close()
701
320
            nrpe.add_check(
702
321
                shortname=svc,
703
322
                description='process check {%s}' % unit_name,
704
323
                check_cmd='check_status_file.py -f '
705
324
                          '/var/lib/nagios/service-check-%s.txt' % svc,
706
325
            )
707
326
708
327
709
328
def copy_nrpe_checks():
710
329
    """
711
330
    Copy the nrpe checks into place
712
331
713
332
    """
714
333
    NAGIOS_PLUGINS = '/usr/local/lib/nagios/plugins'
715
334
    nrpe_files_dir = os.path.join(os.getenv('CHARM_DIR'), 'hooks',
716
335
                                  'charmhelpers', 'contrib', 'openstack',
717
336
                                  'files')
718
337
719
338
    if not os.path.exists(NAGIOS_PLUGINS):
720
339
        os.makedirs(NAGIOS_PLUGINS)
721
340
    for fname in glob.glob(os.path.join(nrpe_files_dir, "check_*")):
722
341
        if os.path.isfile(fname):
723
342
            shutil.copy2(fname,
724
343
                         os.path.join(NAGIOS_PLUGINS, os.path.basename(fname)))
725
344
726
345
727
346
def add_haproxy_checks(nrpe, unit_name):
728
347
    """
729
348
    Add checks for each service in list
730
349
731
350
    :param NRPE nrpe: NRPE object to add check to
732
351
    :param str unit_name: Unit name to use in check description
733
352
    """
734
353
    nrpe.add_check(
735
354
        shortname='haproxy_servers',
736
355
        description='Check HAProxy {%s}' % unit_name,
737
356
        check_cmd='check_haproxy.sh')
738
357
    nrpe.add_check(
739
358
        shortname='haproxy_queue',
740
359
        description='Check HAProxy queue depth {%s}' % unit_name,
741
360
        check_cmd='check_haproxy_queue_depth.sh')
742
0
361
743
=== added file 'hooks/charmhelpers/contrib/charmsupport/volumes.py'
744
--- hooks/charmhelpers/contrib/charmsupport/volumes.py	1970-01-01 00:00:00 +0000
745
+++ hooks/charmhelpers/contrib/charmsupport/volumes.py	2015-04-20 00:40:18 +0000
746
@@ -0,0 +1,175 @@
747
1
# Copyright 2014-2015 Canonical Limited.
748
2
#
749
3
# This file is part of charm-helpers.
750
4
#
751
5
# charm-helpers is free software: you can redistribute it and/or modify
752
6
# it under the terms of the GNU Lesser General Public License version 3 as
753
7
# published by the Free Software Foundation.
754
8
#
755
9
# charm-helpers is distributed in the hope that it will be useful,
756
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
757
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
758
12
# GNU Lesser General Public License for more details.
759
13
#
760
14
# You should have received a copy of the GNU Lesser General Public License
761
15
# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
762
16
763
17
'''
764
18
Functions for managing volumes in juju units. One volume is supported per unit.
765
19
Subordinates may have their own storage, provided it is on its own partition.
766
20
767
21
Configuration stanzas::
768
22
769
23
  volume-ephemeral:
770
24
    type: boolean
771
25
    default: true
772
26
    description: >
773
27
      If false, a volume is mounted as sepecified in "volume-map"
774
28
      If true, ephemeral storage will be used, meaning that log data
775
29
         will only exist as long as the machine. YOU HAVE BEEN WARNED.
776
30
  volume-map:
777
31
    type: string
778
32
    default: {}
779
33
    description: >
780
34
      YAML map of units to device names, e.g:
781
35
        "{ rsyslog/0: /dev/vdb, rsyslog/1: /dev/vdb }"
782
36
      Service units will raise a configure-error if volume-ephemeral
783
37
      is 'true' and no volume-map value is set. Use 'juju set' to set a
784
38
      value and 'juju resolved' to complete configuration.
785
39
786
40
Usage::
787
41
788
42
    from charmsupport.volumes import configure_volume, VolumeConfigurationError
789
43
    from charmsupport.hookenv import log, ERROR
790
44
    def post_mount_hook():
791
45
        stop_service('myservice')
792
46
    def post_mount_hook():
793
47
        start_service('myservice')
794
48
795
49
    if __name__ == '__main__':
796
50
        try:
797
51
            configure_volume(before_change=pre_mount_hook,
798
52
                             after_change=post_mount_hook)
799
53
        except VolumeConfigurationError:
800
54
            log('Storage could not be configured', ERROR)
801
55
802
56
'''
803
57
804
58
# XXX: Known limitations
805
59
# - fstab is neither consulted nor updated
806
60
807
61
import os
808
62
from charmhelpers.core import hookenv
809
63
from charmhelpers.core import host
810
64
import yaml
811
65
812
66
813
67
MOUNT_BASE = '/srv/juju/volumes'
814
68
815
69
816
70
class VolumeConfigurationError(Exception):
817
71
    '''Volume configuration data is missing or invalid'''
818
72
    pass
819
73
820
74
821
75
def get_config():
822
76
    '''Gather and sanity-check volume configuration data'''
823
77
    volume_config = {}
824
78
    config = hookenv.config()
825
79
826
80
    errors = False
827
81
828
82
    if config.get('volume-ephemeral') in (True, 'True', 'true', 'Yes', 'yes'):
829
83
        volume_config['ephemeral'] = True
830
84
    else:
831
85
        volume_config['ephemeral'] = False
832
86
833
87
    try:
834
88
        volume_map = yaml.safe_load(config.get('volume-map', '{}'))
835
89
    except yaml.YAMLError as e:
836
90
        hookenv.log("Error parsing YAML volume-map: {}".format(e),
837
91
                    hookenv.ERROR)
838
92
        errors = True
839
93
    if volume_map is None:
840
94
        # probably an empty string
841
95
        volume_map = {}
842
96
    elif not isinstance(volume_map, dict):
843
97
        hookenv.log("Volume-map should be a dictionary, not {}".format(
844
98
            type(volume_map)))
845
99
        errors = True
846
100
847
101
    volume_config['device'] = volume_map.get(os.environ['JUJU_UNIT_NAME'])
848
102
    if volume_config['device'] and volume_config['ephemeral']:
849
103
        # asked for ephemeral storage but also defined a volume ID
850
104
        hookenv.log('A volume is defined for this unit, but ephemeral '
851
105
                    'storage was requested', hookenv.ERROR)
852
106
        errors = True
853
107
    elif not volume_config['device'] and not volume_config['ephemeral']:
854
108
        # asked for permanent storage but did not define volume ID
855
109
        hookenv.log('Ephemeral storage was requested, but there is no volume '
856
110
                    'defined for this unit.', hookenv.ERROR)
857
111
        errors = True
858
112
859
113
    unit_mount_name = hookenv.local_unit().replace('/', '-')
860
114
    volume_config['mountpoint'] = os.path.join(MOUNT_BASE, unit_mount_name)
861
115
862
116
    if errors:
863
117
        return None
864
118
    return volume_config
865
119
866
120
867
121
def mount_volume(config):
868
122
    if os.path.exists(config['mountpoint']):
869
123
        if not os.path.isdir(config['mountpoint']):
870
124
            hookenv.log('Not a directory: {}'.format(config['mountpoint']))
871
125
            raise VolumeConfigurationError()
872
126
    else:
873
127
        host.mkdir(config['mountpoint'])
874
128
    if os.path.ismount(config['mountpoint']):
875
129
        unmount_volume(config)
876
130
    if not host.mount(config['device'], config['mountpoint'], persist=True):
877
131
        raise VolumeConfigurationError()
878
132
879
133
880
134
def unmount_volume(config):
881
135
    if os.path.ismount(config['mountpoint']):
882
136
        if not host.umount(config['mountpoint'], persist=True):
883
137
            raise VolumeConfigurationError()
884
138
885
139
886
140
def managed_mounts():
887
141
    '''List of all mounted managed volumes'''
888
142
    return filter(lambda mount: mount[0].startswith(MOUNT_BASE), host.mounts())
889
143
890
144
891
145
def configure_volume(before_change=lambda: None, after_change=lambda: None):
892
146
    '''Set up storage (or don't) according to the charm's volume configuration.
893
147
       Returns the mount point or "ephemeral". before_change and after_change
894
148
       are optional functions to be called if the volume configuration changes.
895
149
    '''
896
150
897
151
    config = get_config()
898
152
    if not config:
899
153
        hookenv.log('Failed to read volume configuration', hookenv.CRITICAL)
900
154
        raise VolumeConfigurationError()
901
155
902
156
    if config['ephemeral']:
903
157
        if os.path.ismount(config['mountpoint']):
904
158
            before_change()
905
159
            unmount_volume(config)
906
160
            after_change()
907
161
        return 'ephemeral'
908
162
    else:
909
163
        # persistent storage
910
164
        if os.path.ismount(config['mountpoint']):
911
165
            mounts = dict(managed_mounts())
912
166
            if mounts.get(config['mountpoint']) != config['device']:
913
167
                before_change()
914
168
                unmount_volume(config)
915
169
                mount_volume(config)
916
170
                after_change()
917
171
        else:
918
172
            before_change()
919
173
            mount_volume(config)
920
174
            after_change()
921
175
        return config['mountpoint']
922
0
176
923
=== added file 'hooks/charmhelpers/core/strutils.py'
924
--- hooks/charmhelpers/core/strutils.py	1970-01-01 00:00:00 +0000
925
+++ hooks/charmhelpers/core/strutils.py	2015-04-20 00:40:18 +0000
926
@@ -0,0 +1,42 @@
927
1
#!/usr/bin/env python
928
2
# -*- coding: utf-8 -*-
929
3
930
4
# Copyright 2014-2015 Canonical Limited.
931
5
#
932
6
# This file is part of charm-helpers.
933
7
#
934
8
# charm-helpers is free software: you can redistribute it and/or modify
935
9
# it under the terms of the GNU Lesser General Public License version 3 as
936
10
# published by the Free Software Foundation.
937
11
#
938
12
# charm-helpers is distributed in the hope that it will be useful,
939
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
940
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
941
15
# GNU Lesser General Public License for more details.
942
16
#
943
17
# You should have received a copy of the GNU Lesser General Public License
944
18
# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
945
19
946
20
import six
947
21
948
22
949
23
def bool_from_string(value):
950
24
    """Interpret string value as boolean.
951
25
952
26
    Returns True if value translates to True otherwise False.
953
27
    """
954
28
    if isinstance(value, six.string_types):
955
29
        value = six.text_type(value)
956
30
    else:
957
31
        msg = "Unable to interpret non-string value '%s' as boolean" % (value)
958
32
        raise ValueError(msg)
959
33
960
34
    value = value.strip().lower()
961
35
962
36
    if value in ['y', 'yes', 'true', 't', 'on']:
963
37
        return True
964
38
    elif value in ['n', 'no', 'false', 'f', 'off']:
965
39
        return False
966
40
967
41
    msg = "Unable to interpret string value '%s' as boolean" % (value)
968
42
    raise ValueError(msg)
969
0
43
970
=== renamed file 'hooks/charmhelpers/core/strutils.py' => 'hooks/charmhelpers/core/strutils.py.moved'
971
=== added file 'hooks/charmhelpers/core/unitdata.py'
972
--- hooks/charmhelpers/core/unitdata.py	1970-01-01 00:00:00 +0000
973
+++ hooks/charmhelpers/core/unitdata.py	2015-04-20 00:40:18 +0000
974
@@ -0,0 +1,477 @@
975
1
#!/usr/bin/env python
976
2
# -*- coding: utf-8 -*-
977
3
#
978
4
# Copyright 2014-2015 Canonical Limited.
979
5
#
980
6
# This file is part of charm-helpers.
981
7
#
982
8
# charm-helpers is free software: you can redistribute it and/or modify
983
9
# it under the terms of the GNU Lesser General Public License version 3 as
984
10
# published by the Free Software Foundation.
985
11
#
986
12
# charm-helpers is distributed in the hope that it will be useful,
987
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
988
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
989
15
# GNU Lesser General Public License for more details.
990
16
#
991
17
# You should have received a copy of the GNU Lesser General Public License
992
18
# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
993
19
#
994
20
#
995
21
# Authors:
996
22
#  Kapil Thangavelu <kapil.foss@gmail.com>
997
23
#
998
24
"""
999
25
Intro
1000
26
-----
1001
27
1002
28
A simple way to store state in units. This provides a key value
1003
29
storage with support for versioned, transactional operation,
1004
30
and can calculate deltas from previous values to simplify unit logic
1005
31
when processing changes.
1006
32
1007
33
1008
34
Hook Integration
1009
35
----------------
1010
36
1011
37
There are several extant frameworks for hook execution, including
1012
38
1013
39
 - charmhelpers.core.hookenv.Hooks
1014
40
 - charmhelpers.core.services.ServiceManager
1015
41
1016
42
The storage classes are framework agnostic, one simple integration is
1017
43
via the HookData contextmanager. It will record the current hook
1018
44
execution environment (including relation data, config data, etc.),
1019
45
setup a transaction and allow easy access to the changes from
1020
46
previously seen values. One consequence of the integration is the
1021
47
reservation of particular keys ('rels', 'unit', 'env', 'config',
1022
48
'charm_revisions') for their respective values.
1023
49
1024
50
Here's a fully worked integration example using hookenv.Hooks::
1025
51
1026
52
       from charmhelper.core import hookenv, unitdata
1027
53
1028
54
       hook_data = unitdata.HookData()
1029
55
       db = unitdata.kv()
1030
56
       hooks = hookenv.Hooks()
1031
57
1032
58
       @hooks.hook
1033
59
       def config_changed():
1034
60
           # Print all changes to configuration from previously seen
1035
61
           # values.
1036
62
           for changed, (prev, cur) in hook_data.conf.items():
1037
63
               print('config changed', changed,
1038
64
                     'previous value', prev,
1039
65
                     'current value',  cur)
1040
66
1041
67
           # Get some unit specific bookeeping
1042
68
           if not db.get('pkg_key'):
1043
69
               key = urllib.urlopen('https://example.com/pkg_key').read()
1044
70
               db.set('pkg_key', key)
1045
71
1046
72
           # Directly access all charm config as a mapping.
1047
73
           conf = db.getrange('config', True)
1048
74
1049
75
           # Directly access all relation data as a mapping
1050
76
           rels = db.getrange('rels', True)
1051
77
1052
78
       if __name__ == '__main__':
1053
79
           with hook_data():
1054
80
               hook.execute()
1055
81
1056
82
1057
83
A more basic integration is via the hook_scope context manager which simply
1058
84
manages transaction scope (and records hook name, and timestamp)::
1059
85
1060
86
  >>> from unitdata import kv
1061
87
  >>> db = kv()
1062
88
  >>> with db.hook_scope('install'):
1063
89
  ...    # do work, in transactional scope.
1064
90
  ...    db.set('x', 1)
1065
91
  >>> db.get('x')
1066
92
  1
1067
93
1068
94
1069
95
Usage
1070
96
-----
1071
97
1072
98
Values are automatically json de/serialized to preserve basic typing
1073
99
and complex data struct capabilities (dicts, lists, ints, booleans, etc).
1074
100
1075
101
Individual values can be manipulated via get/set::
1076
102
1077
103
   >>> kv.set('y', True)
1078
104
   >>> kv.get('y')
1079
105
   True
1080
106
1081
107
   # We can set complex values (dicts, lists) as a single key.
1082
108
   >>> kv.set('config', {'a': 1, 'b': True'})
1083
109
1084
110
   # Also supports returning dictionaries as a record which
1085
111
   # provides attribute access.
1086
112
   >>> config = kv.get('config', record=True)
1087
113
   >>> config.b
1088
114
   True
1089
115
1090
116
1091
117
Groups of keys can be manipulated with update/getrange::
1092
118
1093
119
   >>> kv.update({'z': 1, 'y': 2}, prefix="gui.")
1094
120
   >>> kv.getrange('gui.', strip=True)
1095
121
   {'z': 1, 'y': 2}
1096
122
1097
123
When updating values, its very helpful to understand which values
1098
124
have actually changed and how have they changed. The storage
1099
125
provides a delta method to provide for this::
1100
126
1101
127
   >>> data = {'debug': True, 'option': 2}
1102
128
   >>> delta = kv.delta(data, 'config.')
1103
129
   >>> delta.debug.previous
1104
130
   None
1105
131
   >>> delta.debug.current
1106
132
   True
1107
133
   >>> delta
1108
134
   {'debug': (None, True), 'option': (None, 2)}
1109
135
1110
136
Note the delta method does not persist the actual change, it needs to
1111
137
be explicitly saved via 'update' method::
1112
138
1113
139
   >>> kv.update(data, 'config.')
1114
140
1115
141
Values modified in the context of a hook scope retain historical values
1116
142
associated to the hookname.
1117
143
1118
144
   >>> with db.hook_scope('config-changed'):
1119
145
   ...      db.set('x', 42)
1120
146
   >>> db.gethistory('x')
1121
147
   [(1, u'x', 1, u'install', u'2015-01-21T16:49:30.038372'),
1122
148
    (2, u'x', 42, u'config-changed', u'2015-01-21T16:49:30.038786')]
1123
149
1124
150
"""
1125
151
1126
152
import collections
1127
153
import contextlib
1128
154
import datetime
1129
155
import json
1130
156
import os
1131
157
import pprint
1132
158
import sqlite3
1133
159
import sys
1134
160
1135
161
__author__ = 'Kapil Thangavelu <kapil.foss@gmail.com>'
1136
162
1137
163
1138
164
class Storage(object):
1139
165
    """Simple key value database for local unit state within charms.
1140
166
1141
167
    Modifications are automatically committed at hook exit. That's
1142
168
    currently regardless of exit code.
1143
169
1144
170
    To support dicts, lists, integer, floats, and booleans values
1145
171
    are automatically json encoded/decoded.
1146
172
    """
1147
173
    def __init__(self, path=None):
1148
174
        self.db_path = path
1149
175
        if path is None:
1150
176
            self.db_path = os.path.join(
1151
177
                os.environ.get('CHARM_DIR', ''), '.unit-state.db')
1152
178
        self.conn = sqlite3.connect('%s' % self.db_path)
1153
179
        self.cursor = self.conn.cursor()
1154
180
        self.revision = None
1155
181
        self._closed = False
1156
182
        self._init()
1157
183
1158
184
    def close(self):
1159
185
        if self._closed:
1160
186
            return
1161
187
        self.flush(False)
1162
188
        self.cursor.close()
1163
189
        self.conn.close()
1164
190
        self._closed = True
1165
191
1166
192
    def _scoped_query(self, stmt, params=None):
1167
193
        if params is None:
1168
194
            params = []
1169
195
        return stmt, params
1170
196
1171
197
    def get(self, key, default=None, record=False):
1172
198
        self.cursor.execute(
1173
199
            *self._scoped_query(
1174
200
                'select data from kv where key=?', [key]))
1175
201
        result = self.cursor.fetchone()
1176
202
        if not result:
1177
203
            return default
1178
204
        if record:
1179
205
            return Record(json.loads(result[0]))
1180
206
        return json.loads(result[0])
1181
207
1182
208
    def getrange(self, key_prefix, strip=False):
1183
209
        stmt = "select key, data from kv where key like '%s%%'" % key_prefix
1184
210
        self.cursor.execute(*self._scoped_query(stmt))
1185
211
        result = self.cursor.fetchall()
1186
212
1187
213
        if not result:
1188
214
            return None
1189
215
        if not strip:
1190
216
            key_prefix = ''
1191
217
        return dict([
1192
218
            (k[len(key_prefix):], json.loads(v)) for k, v in result])
1193
219
1194
220
    def update(self, mapping, prefix=""):
1195
221
        for k, v in mapping.items():
1196
222
            self.set("%s%s" % (prefix, k), v)
1197
223
1198
224
    def unset(self, key):
1199
225
        self.cursor.execute('delete from kv where key=?', [key])
1200
226
        if self.revision and self.cursor.rowcount:
1201
227
            self.cursor.execute(
1202
228
                'insert into kv_revisions values (?, ?, ?)',
1203
229
                [key, self.revision, json.dumps('DELETED')])
1204
230
1205
231
    def set(self, key, value):
1206
232
        serialized = json.dumps(value)
1207
233
1208
234
        self.cursor.execute(
1209
235
            'select data from kv where key=?', [key])
1210
236
        exists = self.cursor.fetchone()
1211
237
1212
238
        # Skip mutations to the same value
1213
239
        if exists:
1214
240
            if exists[0] == serialized:
1215
241
                return value
1216
242
1217
243
        if not exists:
1218
244
            self.cursor.execute(
1219
245
                'insert into kv (key, data) values (?, ?)',
1220
246
                (key, serialized))
1221
247
        else:
1222
248
            self.cursor.execute('''
1223
249
            update kv
1224
250
            set data = ?
1225
251
            where key = ?''', [serialized, key])
1226
252
1227
253
        # Save
1228
254
        if not self.revision:
1229
255
            return value
1230
256
1231
257
        self.cursor.execute(
1232
258
            'select 1 from kv_revisions where key=? and revision=?',
1233
259
            [key, self.revision])
1234
260
        exists = self.cursor.fetchone()
1235
261
1236
262
        if not exists:
1237
263
            self.cursor.execute(
1238
264
                '''insert into kv_revisions (
1239
265
                revision, key, data) values (?, ?, ?)''',
1240
266
                (self.revision, key, serialized))
1241
267
        else:
1242
268
            self.cursor.execute(
1243
269
                '''
1244
270
                update kv_revisions
1245
271
                set data = ?
1246
272
                where key = ?
1247
273
                and   revision = ?''',
1248
274
                [serialized, key, self.revision])
1249
275
1250
276
        return value
1251
277
1252
278
    def delta(self, mapping, prefix):
1253
279
        """
1254
280
        return a delta containing values that have changed.
1255
281
        """
1256
282
        previous = self.getrange(prefix, strip=True)
1257
283
        if not previous:
1258
284
            pk = set()
1259
285
        else:
1260
286
            pk = set(previous.keys())
1261
287
        ck = set(mapping.keys())
1262
288
        delta = DeltaSet()
1263
289
1264
290
        # added
1265
291
        for k in ck.difference(pk):
1266
292
            delta[k] = Delta(None, mapping[k])
1267
293
1268
294
        # removed
1269
295
        for k in pk.difference(ck):
1270
296
            delta[k] = Delta(previous[k], None)
1271
297
1272
298
        # changed
1273
299
        for k in pk.intersection(ck):
1274
300
            c = mapping[k]
1275
301
            p = previous[k]
1276
302
            if c != p:
1277
303
                delta[k] = Delta(p, c)
1278
304
1279
305
        return delta
1280
306
1281
307
    @contextlib.contextmanager
1282
308
    def hook_scope(self, name=""):
1283
309
        """Scope all future interactions to the current hook execution
1284
310
        revision."""
1285
311
        assert not self.revision
1286
312
        self.cursor.execute(
1287
313
            'insert into hooks (hook, date) values (?, ?)',
1288
314
            (name or sys.argv[0],
1289
315
             datetime.datetime.utcnow().isoformat()))
1290
316
        self.revision = self.cursor.lastrowid
1291
317
        try:
1292
318
            yield self.revision
1293
319
            self.revision = None
1294
320
        except:
1295
321
            self.flush(False)
1296
322
            self.revision = None
1297
323
            raise
1298
324
        else:
1299
325
            self.flush()
1300
326
1301
327
    def flush(self, save=True):
1302
328
        if save:
1303
329
            self.conn.commit()
1304
330
        elif self._closed:
1305
331
            return
1306
332
        else:
1307
333
            self.conn.rollback()
1308
334
1309
335
    def _init(self):
1310
336
        self.cursor.execute('''
1311
337
            create table if not exists kv (
1312
338
               key text,
1313
339
               data text,
1314
340
               primary key (key)
1315
341
               )''')
1316
342
        self.cursor.execute('''
1317
343
            create table if not exists kv_revisions (
1318
344
               key text,
1319
345
               revision integer,
1320
346
               data text,
1321
347
               primary key (key, revision)
1322
348
               )''')
1323
349
        self.cursor.execute('''
1324
350
            create table if not exists hooks (
1325
351
               version integer primary key autoincrement,
1326
352
               hook text,
1327
353
               date text
1328
354
               )''')
1329
355
        self.conn.commit()
1330
356
1331
357
    def gethistory(self, key, deserialize=False):
1332
358
        self.cursor.execute(
1333
359
            '''
1334
360
            select kv.revision, kv.key, kv.data, h.hook, h.date
1335
361
            from kv_revisions kv,
1336
362
                 hooks h
1337
363
            where kv.key=?
1338
364
             and kv.revision = h.version
1339
365
            ''', [key])
1340
366
        if deserialize is False:
1341
367
            return self.cursor.fetchall()
1342
368
        return map(_parse_history, self.cursor.fetchall())
1343
369
1344
370
    def debug(self, fh=sys.stderr):
1345
371
        self.cursor.execute('select * from kv')
1346
372
        pprint.pprint(self.cursor.fetchall(), stream=fh)
1347
373
        self.cursor.execute('select * from kv_revisions')
1348
374
        pprint.pprint(self.cursor.fetchall(), stream=fh)
1349
375
1350
376
1351
377
def _parse_history(d):
1352
378
    return (d[0], d[1], json.loads(d[2]), d[3],
1353
379
            datetime.datetime.strptime(d[-1], "%Y-%m-%dT%H:%M:%S.%f"))
1354
380
1355
381
1356
382
class HookData(object):
1357
383
    """Simple integration for existing hook exec frameworks.
1358
384
1359
385
    Records all unit information, and stores deltas for processing
1360
386
    by the hook.
1361
387
1362
388
    Sample::
1363
389
1364
390
       from charmhelper.core import hookenv, unitdata
1365
391
1366
392
       changes = unitdata.HookData()
1367
393
       db = unitdata.kv()
1368
394
       hooks = hookenv.Hooks()
1369
395
1370
396
       @hooks.hook
1371
397
       def config_changed():
1372
398
           # View all changes to configuration
1373
399
           for changed, (prev, cur) in changes.conf.items():
1374
400
               print('config changed', changed,
1375
401
                     'previous value', prev,
1376
402
                     'current value',  cur)
1377
403
1378
404
           # Get some unit specific bookeeping
1379
405
           if not db.get('pkg_key'):
1380
406
               key = urllib.urlopen('https://example.com/pkg_key').read()
1381
407
               db.set('pkg_key', key)
1382
408
1383
409
       if __name__ == '__main__':
1384
410
           with changes():
1385
411
               hook.execute()
1386
412
1387
413
    """
1388
414
    def __init__(self):
1389
415
        self.kv = kv()
1390
416
        self.conf = None
1391
417
        self.rels = None
1392
418
1393
419
    @contextlib.contextmanager
1394
420
    def __call__(self):
1395
421
        from charmhelpers.core import hookenv
1396
422
        hook_name = hookenv.hook_name()
1397
423
1398
424
        with self.kv.hook_scope(hook_name):
1399
425
            self._record_charm_version(hookenv.charm_dir())
1400
426
            delta_config, delta_relation = self._record_hook(hookenv)
1401
427
            yield self.kv, delta_config, delta_relation
1402
428
1403
429
    def _record_charm_version(self, charm_dir):
1404
430
        # Record revisions.. charm revisions are meaningless
1405
431
        # to charm authors as they don't control the revision.
1406
432
        # so logic dependnent on revision is not particularly
1407
433
        # useful, however it is useful for debugging analysis.
1408
434
        charm_rev = open(
1409
435
            os.path.join(charm_dir, 'revision')).read().strip()
1410
436
        charm_rev = charm_rev or '0'
1411
437
        revs = self.kv.get('charm_revisions', [])
1412
438
        if charm_rev not in revs:
1413
439
            revs.append(charm_rev.strip() or '0')
1414
440
            self.kv.set('charm_revisions', revs)
1415
441
1416
442
    def _record_hook(self, hookenv):
1417
443
        data = hookenv.execution_environment()
1418
444
        self.conf = conf_delta = self.kv.delta(data['conf'], 'config')
1419
445
        self.rels = rels_delta = self.kv.delta(data['rels'], 'rels')
1420
446
        self.kv.set('env', dict(data['env']))
1421
447
        self.kv.set('unit', data['unit'])
1422
448
        self.kv.set('relid', data.get('relid'))
1423
449
        return conf_delta, rels_delta
1424
450
1425
451
1426
452
class Record(dict):
1427
453
1428
454
    __slots__ = ()
1429
455
1430
456
    def __getattr__(self, k):
1431
457
        if k in self:
1432
458
            return self[k]
1433
459
        raise AttributeError(k)
1434
460
1435
461
1436
462
class DeltaSet(Record):
1437
463
1438
464
    __slots__ = ()
1439
465
1440
466
1441
467
Delta = collections.namedtuple('Delta', ['previous', 'current'])
1442
468
1443
469
1444
470
_KV = None
1445
471
1446
472
1447
473
def kv():
1448
474
    global _KV
1449
475
    if _KV is None:
1450
476
        _KV = Storage()
1451
477
    return _KV
1452
0
478
1453
=== renamed file 'hooks/charmhelpers/core/unitdata.py' => 'hooks/charmhelpers/core/unitdata.py.moved'
1454
=== modified file 'hooks/hooks.py'
1455
--- hooks/hooks.py	2015-04-14 10:16:50 +0000
1456
+++ hooks/hooks.py	2015-04-20 00:40:18 +0000
1457
@@ -11,6 +11,7 @@
1458
11
import shutil
11
import shutil
1459
12
import sys
12
import sys
1460
13
import os
13
import os
1461
14
import glob
1462
14
from base64 import b64decode
15
from base64 import b64decode
1463
15
16
1464
16
import maas as MAAS
17
import maas as MAAS
1465
@@ -56,6 +57,8 @@
1466
56
57
1467
57
from charmhelpers.contrib.openstack.utils import get_host_ip
58
from charmhelpers.contrib.openstack.utils import get_host_ip
1468
58
59
1469
60
from charmhelpers.contrib.charmsupport import nrpe
1470
61
1471
59
hooks = Hooks()
62
hooks = Hooks()
1472
60
63
1473
61
COROSYNC_CONF = '/etc/corosync/corosync.conf'
64
COROSYNC_CONF = '/etc/corosync/corosync.conf'
1474
@@ -68,7 +71,8 @@
1475
68
    COROSYNC_CONF
71
    COROSYNC_CONF
1476
69
]
72
]
1477
70
73
1479
71
PACKAGES = ['corosync', 'pacemaker', 'python-netaddr', 'ipmitool']
74
PACKAGES = ['corosync', 'pacemaker', 'python-netaddr', 'ipmitool',
1480
75
            'libnagios-plugin-perl']
1481
72
SUPPORTED_TRANSPORTS = ['udp', 'udpu', 'multicast', 'unicast']
76
SUPPORTED_TRANSPORTS = ['udp', 'udpu', 'multicast', 'unicast']
1482
73
77
1483
74
78
1484
@@ -209,11 +213,15 @@
1485
209
        configure_monitor_host()
213
        configure_monitor_host()
1486
210
        configure_stonith()
214
        configure_stonith()
1487
211
215
1488
216
    update_nrpe_config()
1489
217
1490
212
218
1491
213
@hooks.hook()
219
@hooks.hook()
1492
214
def upgrade_charm():
220
def upgrade_charm():
1493
215
    install()
221
    install()
1494
216
222
1495
223
    update_nrpe_config()
1496
224
1497
217
225
1498
218
def restart_corosync():
226
def restart_corosync():
1499
219
    if service_running("pacemaker"):
227
    if service_running("pacemaker"):
1500
@@ -594,6 +602,59 @@
1501
594
                        "versions less than Trusty 14.04")
602
                        "versions less than Trusty 14.04")
1502
595
603
1503
596
604
1504
605
@hooks.hook('nrpe-external-master-relation-joined',
1505
606
            'nrpe-external-master-relation-changed')
1506
607
def update_nrpe_config():
1507
608
    scripts_src = os.path.join(os.environ["CHARM_DIR"], "files",
1508
609
                               "nrpe")
1509
610
    scripts_dst = "/usr/local/lib/nagios/plugins"
1510
611
    if not os.path.exists(scripts_dst):
1511
612
        os.makedirs(scripts_dst)
1512
613
    for fname in glob.glob(os.path.join(scripts_src, "*")):
1513
614
        if os.path.isfile(fname):
1514
615
            shutil.copy2(fname,
1515
616
                         os.path.join(scripts_dst, os.path.basename(fname)))
1516
617
1517
618
    sudoers_src = os.path.join(os.environ["CHARM_DIR"], "files",
1518
619
                               "sudoers")
1519
620
    sudoers_dst = "/etc/sudoers.d"
1520
621
    for fname in glob.glob(os.path.join(sudoers_src, "*")):
1521
622
        if os.path.isfile(fname):
1522
623
            shutil.copy2(fname,
1523
624
                         os.path.join(sudoers_dst, os.path.basename(fname)))
1524
625
1525
626
    hostname = nrpe.get_nagios_hostname()
1526
627
    current_unit = nrpe.get_nagios_unit_name()
1527
628
1528
629
    nrpe_setup = nrpe.NRPE(hostname=hostname)
1529
630
1530
631
    apt_install('python-dbus')
1531
632
1532
633
    # corosync/crm checks
1533
634
    nrpe_setup.add_check(
1534
635
        shortname='corosync_rings',
1535
636
        description='Check Corosync rings {%s}' % current_unit,
1536
637
        check_cmd='check_corosync_rings')
1537
638
    nrpe_setup.add_check(
1538
639
        shortname='crm_status',
1539
640
        description='Check crm status {%s}' % current_unit,
1540
641
        check_cmd='check_crm')
1541
642
1542
643
    # process checks
1543
644
    nrpe_setup.add_check(
1544
645
        shortname='corosync_proc',
1545
646
        description='Check Corosync process {%s}' % current_unit,
1546
647
        check_cmd='check_procs -c 1:1 -C corosync'
1547
648
    )
1548
649
    nrpe_setup.add_check(
1549
650
        shortname='pacemakerd_proc',
1550
651
        description='Check Pacemakerd process {%s}' % current_unit,
1551
652
        check_cmd='check_procs -c 1:1 -C pacemakerd'
1552
653
    )
1553
654
1554
655
    nrpe_setup.write()
1555
656
1556
657
1557
597
if __name__ == '__main__':
658
if __name__ == '__main__':
1558
598
    try:
659
    try:
1559
599
        hooks.execute(sys.argv)
660
        hooks.execute(sys.argv)
1560
600
661
1561
=== added symlink 'hooks/nrpe-external-master-relation-changed'
1562
=== target is u'hooks.py'
1563
=== added symlink 'hooks/nrpe-external-master-relation-joined'
1564
=== target is u'hooks.py'
1565
=== modified file 'metadata.yaml'
1566
--- metadata.yaml	2014-04-11 11:22:46 +0000
1567
+++ metadata.yaml	2015-04-20 00:40:18 +0000
1568
@@ -14,6 +14,9 @@
1569
14
  ha:
14
  ha:
1570
15
    interface: hacluster
15
    interface: hacluster
1571
16
    scope: container
16
    scope: container
1572
17
  nrpe-external-master:
1573
18
    interface: nrpe-external-master
1574
19
    scope: container
1575
17
peers:
20
peers:
1576
18
  hanode:
21
  hanode:
1577
19
    interface: hacluster
22
    interface: hacluster
Status:	Merged
Merged at revision:	46
Proposed branch:	lp:~brad-marshall/charms/trusty/hacluster/add-nrpe-checks-update-charmhelpers
Merge into:	lp:~openstack-charmers/charms/trusty/hacluster/next
Diff against target:	1577 lines (+1456/-1) (has conflicts) 12 files modified charm-helpers.yaml (+1/-0) config.yaml (+16/-0) files/nrpe/check_corosync_rings (+99/-0) files/nrpe/check_crm (+201/-0) files/sudoers/nagios (+5/-0) hooks/charmhelpers/contrib/charmsupport/__init__.py (+15/-0) hooks/charmhelpers/contrib/charmsupport/nrpe.py (+360/-0) hooks/charmhelpers/contrib/charmsupport/volumes.py (+175/-0) hooks/charmhelpers/core/strutils.py (+42/-0) hooks/charmhelpers/core/unitdata.py (+477/-0) hooks/hooks.py (+62/-1) metadata.yaml (+3/-0) Conflict adding file hooks/charmhelpers/core/strutils.py. Moved existing file to hooks/charmhelpers/core/strutils.py.moved. Conflict adding file hooks/charmhelpers/core/unitdata.py. Moved existing file to hooks/charmhelpers/core/unitdata.py.moved.
To merge this branch:	bzr merge lp:~brad-marshall/charms/trusty/hacluster/add-nrpe-checks-update-charmhelpers
Related bugs:	Link a bug report
Reviewer	Date Requested	Status
Liam Young (community)	2015-02-12	Approve on 2015-04-20
Billy Olsen		Needs Information on 2015-04-10
OpenStack Charmers	2015-02-12	Pending
Review via email: mp+249570@code.launchpad.net