root / snf-cyclades-gtools / synnefo / ganeti / eventd.py @ dee2e82c
History | View | Annotate | Download (15.4 kB)
1 |
#!/usr/bin/env python
|
---|---|
2 |
# -*- coding: utf-8 -*-
|
3 |
#
|
4 |
# Copyright 2011 GRNET S.A. All rights reserved.
|
5 |
#
|
6 |
# Redistribution and use in source and binary forms, with or
|
7 |
# without modification, are permitted provided that the following
|
8 |
# conditions are met:
|
9 |
#
|
10 |
# 1. Redistributions of source code must retain the above
|
11 |
# copyright notice, this list of conditions and the following
|
12 |
# disclaimer.
|
13 |
#
|
14 |
# 2. Redistributions in binary form must reproduce the above
|
15 |
# copyright notice, this list of conditions and the following
|
16 |
# disclaimer in the documentation and/or other materials
|
17 |
# provided with the distribution.
|
18 |
#
|
19 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
20 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
21 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
22 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
23 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
24 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
25 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
26 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
27 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
28 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
29 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
30 |
# POSSIBILITY OF SUCH DAMAGE.
|
31 |
#
|
32 |
# The views and conclusions contained in the software and
|
33 |
# documentation are those of the authors and should not be
|
34 |
# interpreted as representing official policies, either expressed
|
35 |
# or implied, of GRNET S.A.
|
36 |
#
|
37 |
|
38 |
"""Ganeti notification daemon with AMQP support
|
39 |
|
40 |
A daemon to monitor the Ganeti job queue and publish job progress
|
41 |
and Ganeti VM state notifications to the ganeti exchange
|
42 |
"""
|
43 |
|
44 |
import sys |
45 |
import os |
46 |
path = os.path.normpath(os.path.join(os.getcwd(), '..'))
|
47 |
sys.path.append(path) |
48 |
|
49 |
import json |
50 |
import logging |
51 |
import pyinotify |
52 |
import daemon |
53 |
import daemon.pidlockfile |
54 |
import daemon.runner |
55 |
from lockfile import LockTimeout |
56 |
from signal import signal, SIGINT, SIGTERM |
57 |
import setproctitle |
58 |
|
59 |
from ganeti import utils, jqueue, constants, serializer, pathutils, cli |
60 |
from ganeti import errors as ganeti_errors |
61 |
from ganeti.ssconf import SimpleStore |
62 |
|
63 |
|
64 |
from synnefo import settings |
65 |
from synnefo.lib.amqp import AMQPClient |
66 |
|
67 |
|
68 |
def get_time_from_status(op, job): |
69 |
"""Generate a unique message identifier for a ganeti job.
|
70 |
|
71 |
The identifier is based on the timestamp of the job. Since a ganeti
|
72 |
job passes from multiple states, we need to pick the timestamp that
|
73 |
corresponds to each state.
|
74 |
|
75 |
"""
|
76 |
status = op.status |
77 |
if status == constants.JOB_STATUS_QUEUED:
|
78 |
time = job.received_timestamp |
79 |
try: # Compatibility with Ganeti version |
80 |
if status == constants.JOB_STATUS_WAITLOCK:
|
81 |
time = op.start_timestamp |
82 |
except AttributeError: |
83 |
if status == constants.JOB_STATUS_WAITING:
|
84 |
time = op.start_timestamp |
85 |
if status == constants.JOB_STATUS_CANCELING:
|
86 |
time = op.start_timestamp |
87 |
if status == constants.JOB_STATUS_RUNNING:
|
88 |
time = op.exec_timestamp |
89 |
if status in constants.JOBS_FINALIZED: |
90 |
time = op.end_timestamp |
91 |
|
92 |
return time and time or job.end_timestamp |
93 |
|
94 |
raise InvalidBackendStatus(status, job)
|
95 |
|
96 |
|
97 |
def get_instance_nics(instance, logger): |
98 |
"""Query Ganeti to a get the instance's NICs.
|
99 |
|
100 |
Get instance's NICs from Ganeti configuration data. If running on master,
|
101 |
query Ganeti via Ganeti CLI client. Otherwise, get the nics from Ganeti
|
102 |
configuration file.
|
103 |
|
104 |
@type instance: string
|
105 |
@param instance: the name of the instance
|
106 |
@rtype: List of dicts
|
107 |
@return: Dictionary containing the instance's NICs. Each dictionary
|
108 |
contains the following keys: 'network', 'ip', 'mac', 'mode',
|
109 |
'link' and 'firewall'
|
110 |
|
111 |
"""
|
112 |
try:
|
113 |
client = cli.GetClient() |
114 |
fields = ["nic.networks.names", "nic.ips", "nic.macs", "nic.modes", |
115 |
"nic.links", "tags"] |
116 |
info = client.QueryInstances([instance], fields, use_locking=False)
|
117 |
networks, ips, macs, modes, links, tags = info[0]
|
118 |
nic_keys = ["network", "ip", "mac", "mode", "link"] |
119 |
nics = zip(networks, ips, macs, modes, links)
|
120 |
nics = map(lambda x: dict(zip(nic_keys, x)), nics) |
121 |
except ganeti_errors.OpPrereqError:
|
122 |
# Not running on master! Load the conf file
|
123 |
raw_data = utils.ReadFile(constants.CLUSTER_CONF_FILE) |
124 |
config = serializer.LoadJson(raw_data) |
125 |
i = config["instances"][instance]
|
126 |
nics = [] |
127 |
for nic in i["nics"]: |
128 |
params = nic.pop("nicparams")
|
129 |
nic["mode"] = params["mode"] |
130 |
nic["link"] = params["link"] |
131 |
nics.append(nic) |
132 |
tags = i.get("tags", [])
|
133 |
# Get firewall from instance Tags
|
134 |
# Tags are of the form synnefo:network:N:firewall_mode
|
135 |
for tag in tags: |
136 |
t = tag.split(":")
|
137 |
if t[0:2] == ["synnefo", "network"]: |
138 |
if len(t) != 4: |
139 |
logger.error("Malformed synefo tag %s", tag)
|
140 |
continue
|
141 |
try:
|
142 |
index = int(t[2]) |
143 |
nics[index]['firewall'] = t[3] |
144 |
except ValueError: |
145 |
logger.error("Malformed synnefo tag %s", tag)
|
146 |
except IndexError: |
147 |
logger.error("Found tag %s for non-existent NIC %d",
|
148 |
tag, index) |
149 |
return nics
|
150 |
|
151 |
|
152 |
class InvalidBackendStatus(Exception): |
153 |
def __init__(self, status, job): |
154 |
self.status = status
|
155 |
self.job = job
|
156 |
|
157 |
def __str__(self): |
158 |
return repr("Invalid backend status: %s in job %s" |
159 |
% (self.status, self.job)) |
160 |
|
161 |
|
162 |
def prefix_from_name(name): |
163 |
return name.split('-')[0] |
164 |
|
165 |
|
166 |
def get_field(from_, field): |
167 |
try:
|
168 |
return getattr(from_, field) |
169 |
except AttributeError: |
170 |
None
|
171 |
|
172 |
|
173 |
class JobFileHandler(pyinotify.ProcessEvent): |
174 |
def __init__(self, logger, cluster_name): |
175 |
pyinotify.ProcessEvent.__init__(self)
|
176 |
self.logger = logger
|
177 |
self.cluster_name = cluster_name
|
178 |
|
179 |
# Set max_retries to 0 for unlimited retries.
|
180 |
self.client = AMQPClient(hosts=settings.AMQP_HOSTS, confirm_buffer=25, |
181 |
max_retries=0, logger=logger)
|
182 |
|
183 |
handler_logger.info("Attempting to connect to RabbitMQ hosts")
|
184 |
|
185 |
self.client.connect()
|
186 |
handler_logger.info("Connected succesfully")
|
187 |
|
188 |
self.client.exchange_declare(settings.EXCHANGE_GANETI, type='topic') |
189 |
|
190 |
self.op_handlers = {"INSTANCE": self.process_instance_op, |
191 |
"NETWORK": self.process_network_op} |
192 |
# "GROUP": self.process_group_op}
|
193 |
|
194 |
def process_IN_CLOSE_WRITE(self, event): |
195 |
self.process_IN_MOVED_TO(event)
|
196 |
|
197 |
def process_IN_MOVED_TO(self, event): |
198 |
jobfile = os.path.join(event.path, event.name) |
199 |
if not event.name.startswith("job-"): |
200 |
self.logger.debug("Not a job file: %s" % event.path) |
201 |
return
|
202 |
|
203 |
try:
|
204 |
data = utils.ReadFile(jobfile) |
205 |
except IOError: |
206 |
return
|
207 |
|
208 |
data = serializer.LoadJson(data) |
209 |
job = jqueue._QueuedJob.Restore(None, data, False, False) |
210 |
|
211 |
job_id = int(job.id)
|
212 |
|
213 |
for op in job.ops: |
214 |
op_id = op.input.OP_ID |
215 |
|
216 |
msg = None
|
217 |
try:
|
218 |
handler_fn = self.op_handlers[op_id.split('_')[1]] |
219 |
msg, routekey = handler_fn(op, job_id) |
220 |
except KeyError: |
221 |
pass
|
222 |
|
223 |
if not msg: |
224 |
self.logger.debug("Ignoring job: %s: %s", job_id, op_id) |
225 |
continue
|
226 |
|
227 |
# Generate a unique message identifier
|
228 |
event_time = get_time_from_status(op, job) |
229 |
|
230 |
# Get the last line of the op log as message
|
231 |
try:
|
232 |
logmsg = op.log[-1][-1] |
233 |
except IndexError: |
234 |
logmsg = None
|
235 |
|
236 |
# Add shared attributes for all operations
|
237 |
msg.update({"event_time": event_time,
|
238 |
"operation": op_id,
|
239 |
"status": op.status,
|
240 |
"cluster": self.cluster_name, |
241 |
"logmsg": logmsg,
|
242 |
"jobId": job_id})
|
243 |
|
244 |
if op_id in ["OP_INSTANCE_CREATE", "OP_INSTANCE_SET_PARAMS", |
245 |
"OP_INSTANCE_STARTUP"]:
|
246 |
if op.status == "success": |
247 |
nics = get_instance_nics(msg["instance"], self.logger) |
248 |
msg["nics"] = nics
|
249 |
|
250 |
msg = json.dumps(msg) |
251 |
self.logger.debug("Delivering msg: %s (key=%s)", msg, routekey) |
252 |
|
253 |
# Send the message to RabbitMQ
|
254 |
self.client.basic_publish(settings.EXCHANGE_GANETI,
|
255 |
routekey, |
256 |
msg) |
257 |
|
258 |
def process_instance_op(self, op, job_id): |
259 |
""" Process OP_INSTANCE_* opcodes.
|
260 |
|
261 |
"""
|
262 |
input = op.input |
263 |
op_id = input.OP_ID
|
264 |
|
265 |
instances = None
|
266 |
instances = get_field(input, 'instance_name') |
267 |
if not instances: |
268 |
instances = get_field(input, 'instances') |
269 |
if not instances or len(instances) > 1: |
270 |
# Do not publish messages for jobs with no or multiple
|
271 |
# instances. Currently snf-dispatcher can not normally handle
|
272 |
# these messages
|
273 |
return None, None |
274 |
else:
|
275 |
instances = instances[0]
|
276 |
|
277 |
self.logger.debug("Job: %d: %s(%s) %s", job_id, op_id, |
278 |
instances, op.status) |
279 |
|
280 |
msg = {"type": "ganeti-op-status", |
281 |
"instance": instances,
|
282 |
"operation": op_id}
|
283 |
|
284 |
routekey = "ganeti.%s.event.op" % prefix_from_name(instances)
|
285 |
|
286 |
return msg, routekey
|
287 |
|
288 |
def process_network_op(self, op, job_id): |
289 |
""" Process OP_NETWORK_* opcodes.
|
290 |
|
291 |
"""
|
292 |
|
293 |
input = op.input |
294 |
op_id = input.OP_ID
|
295 |
network_name = get_field(input, 'network_name') |
296 |
|
297 |
if not network_name: |
298 |
return None, None |
299 |
|
300 |
self.logger.debug("Job: %d: %s(%s) %s", job_id, op_id, |
301 |
network_name, op.status) |
302 |
|
303 |
msg = {'operation': op_id,
|
304 |
'type': "ganeti-network-status", |
305 |
'network': network_name,
|
306 |
'subnet': get_field(input, 'network'), |
307 |
# 'network_mode': get_field(input, 'network_mode'),
|
308 |
# 'network_link': get_field(input, 'network_link'),
|
309 |
'gateway': get_field(input, 'gateway'), |
310 |
'group_name': get_field(input, 'group_name')} |
311 |
|
312 |
if op_id == "OP_NETWORK_SET_PARAMS": |
313 |
msg["add_reserved_ips"] = get_field(input, "add_reserved_ips") |
314 |
msg["remove_reserved_ips"] = get_field(input, |
315 |
"remove_reserved_ips")
|
316 |
routekey = "ganeti.%s.event.network" % prefix_from_name(network_name)
|
317 |
|
318 |
return msg, routekey
|
319 |
|
320 |
|
321 |
# def process_group_op(self, op, job_id):
|
322 |
# """ Process OP_GROUP_* opcodes.
|
323 |
|
324 |
# """
|
325 |
# return None, None
|
326 |
|
327 |
|
328 |
def find_cluster_name(): |
329 |
global handler_logger
|
330 |
try:
|
331 |
ss = SimpleStore() |
332 |
name = ss.GetClusterName() |
333 |
except Exception as e: |
334 |
handler_logger.error('Can not get the name of the Cluster: %s' % e)
|
335 |
raise e
|
336 |
|
337 |
return name
|
338 |
|
339 |
|
340 |
handler_logger = None
|
341 |
|
342 |
|
343 |
def fatal_signal_handler(signum, frame): |
344 |
global handler_logger
|
345 |
|
346 |
handler_logger.info("Caught fatal signal %d, will raise SystemExit",
|
347 |
signum) |
348 |
raise SystemExit |
349 |
|
350 |
|
351 |
def parse_arguments(args): |
352 |
from optparse import OptionParser |
353 |
|
354 |
parser = OptionParser() |
355 |
parser.add_option("-d", "--debug", action="store_true", dest="debug", |
356 |
help="Enable debugging information")
|
357 |
parser.add_option("-l", "--log", dest="log_file", |
358 |
default="/var/log/snf-ganeti-eventd.log",
|
359 |
metavar="FILE",
|
360 |
help="Write log to FILE instead of %s" %
|
361 |
"/var/log/snf-ganeti-eventd.log")
|
362 |
parser.add_option('--pid-file', dest="pid_file", |
363 |
default="/var/run/snf-ganeti-eventd.pid",
|
364 |
metavar='PIDFILE',
|
365 |
help="Save PID to file (default: %s)" %
|
366 |
"/var/run/snf-ganeti-eventd.pid")
|
367 |
|
368 |
return parser.parse_args(args)
|
369 |
|
370 |
|
371 |
def main(): |
372 |
global handler_logger
|
373 |
|
374 |
(opts, args) = parse_arguments(sys.argv[1:])
|
375 |
|
376 |
# Initialize logger
|
377 |
lvl = logging.DEBUG if opts.debug else logging.INFO |
378 |
logger = logging.getLogger("ganeti.eventd")
|
379 |
logger.setLevel(lvl) |
380 |
formatter = logging.Formatter( |
381 |
"%(asctime)s %(module)s[%(process)d] %(levelname)s: %(message)s",
|
382 |
"%Y-%m-%d %H:%M:%S")
|
383 |
handler = logging.FileHandler(opts.log_file) |
384 |
handler.setFormatter(formatter) |
385 |
logger.addHandler(handler) |
386 |
handler_logger = logger |
387 |
|
388 |
# Rename this process so 'ps' output looks like this is a native
|
389 |
# executable. Can not seperate command-line arguments from actual name of
|
390 |
# the executable by NUL bytes, so only show the name of the executable
|
391 |
# instead. setproctitle.setproctitle("\x00".join(sys.argv))
|
392 |
setproctitle.setproctitle(sys.argv[0])
|
393 |
|
394 |
# Create pidfile
|
395 |
pidf = daemon.pidlockfile.TimeoutPIDLockFile(opts.pid_file, 10)
|
396 |
|
397 |
# Remove any stale PID files, left behind by previous invocations
|
398 |
if daemon.runner.is_pidfile_stale(pidf):
|
399 |
logger.warning("Removing stale PID lock file %s", pidf.path)
|
400 |
pidf.break_lock() |
401 |
|
402 |
# Become a daemon:
|
403 |
# Redirect stdout and stderr to handler.stream to catch
|
404 |
# early errors in the daemonization process [e.g., pidfile creation]
|
405 |
# which will otherwise go to /dev/null.
|
406 |
daemon_context = daemon.DaemonContext( |
407 |
pidfile=pidf, |
408 |
umask=022,
|
409 |
stdout=handler.stream, |
410 |
stderr=handler.stream, |
411 |
files_preserve=[handler.stream]) |
412 |
try:
|
413 |
daemon_context.open() |
414 |
except (daemon.pidlockfile.AlreadyLocked, LockTimeout):
|
415 |
logger.critical("Failed to lock pidfile %s, another instance running?",
|
416 |
pidf.path) |
417 |
sys.exit(1)
|
418 |
|
419 |
logger.info("Became a daemon")
|
420 |
|
421 |
# Catch signals to ensure graceful shutdown
|
422 |
signal(SIGINT, fatal_signal_handler) |
423 |
signal(SIGTERM, fatal_signal_handler) |
424 |
|
425 |
# Monitor the Ganeti job queue, create and push notifications
|
426 |
wm = pyinotify.WatchManager() |
427 |
mask = (pyinotify.EventsCodes.ALL_FLAGS["IN_MOVED_TO"] |
|
428 |
pyinotify.EventsCodes.ALL_FLAGS["IN_CLOSE_WRITE"])
|
429 |
|
430 |
cluster_name = find_cluster_name() |
431 |
|
432 |
handler = JobFileHandler(logger, cluster_name) |
433 |
notifier = pyinotify.Notifier(wm, handler) |
434 |
|
435 |
try:
|
436 |
# Fail if adding the inotify() watch fails for any reason
|
437 |
res = wm.add_watch(pathutils.QUEUE_DIR, mask) |
438 |
if res[pathutils.QUEUE_DIR] < 0: |
439 |
raise Exception("pyinotify add_watch returned negative descriptor") |
440 |
|
441 |
logger.info("Now watching %s of %s" % (pathutils.QUEUE_DIR,
|
442 |
cluster_name)) |
443 |
|
444 |
while True: # loop forever |
445 |
# process the queue of events as explained above
|
446 |
notifier.process_events() |
447 |
if notifier.check_events():
|
448 |
# read notified events and enqeue them
|
449 |
notifier.read_events() |
450 |
except SystemExit: |
451 |
logger.info("SystemExit")
|
452 |
except:
|
453 |
logger.exception("Caught exception, terminating")
|
454 |
finally:
|
455 |
# destroy the inotify's instance on this interrupt (stop monitoring)
|
456 |
notifier.stop() |
457 |
raise
|
458 |
|
459 |
if __name__ == "__main__": |
460 |
sys.exit(main()) |
461 |
|
462 |
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :
|