root / daemons / ganeti-confd @ 675bf1b7
History | View | Annotate | Download (12.1 kB)
1 |
#!/usr/bin/python |
---|---|
2 |
# |
3 |
|
4 |
# Copyright (C) 2009, Google Inc. |
5 |
# |
6 |
# This program is free software; you can redistribute it and/or modify |
7 |
# it under the terms of the GNU General Public License as published by |
8 |
# the Free Software Foundation; either version 2 of the License, or |
9 |
# (at your option) any later version. |
10 |
# |
11 |
# This program is distributed in the hope that it will be useful, but |
12 |
# WITHOUT ANY WARRANTY; without even the implied warranty of |
13 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 |
# General Public License for more details. |
15 |
# |
16 |
# You should have received a copy of the GNU General Public License |
17 |
# along with this program; if not, write to the Free Software |
18 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
19 |
# 02110-1301, USA. |
20 |
|
21 |
|
22 |
"""Ganeti configuration daemon |
23 |
|
24 |
Ganeti-confd is a daemon to query master candidates for configuration values. |
25 |
It uses UDP+HMAC for authentication with a global cluster key. |
26 |
|
27 |
""" |
28 |
|
29 |
# pylint: disable-msg=C0103 |
30 |
# C0103: Invalid name ganeti-confd |
31 |
|
32 |
import os |
33 |
import sys |
34 |
import logging |
35 |
import time |
36 |
|
37 |
try: |
38 |
# pylint: disable-msg=E0611 |
39 |
from pyinotify import pyinotify |
40 |
except ImportError: |
41 |
import pyinotify |
42 |
|
43 |
from optparse import OptionParser |
44 |
|
45 |
from ganeti import asyncnotifier |
46 |
from ganeti import confd |
47 |
from ganeti.confd import server as confd_server |
48 |
from ganeti import constants |
49 |
from ganeti import errors |
50 |
from ganeti import daemon |
51 |
|
52 |
|
53 |
class ConfdAsyncUDPServer(daemon.AsyncUDPSocket): |
54 |
"""The confd udp server, suitable for use with asyncore. |
55 |
|
56 |
""" |
57 |
def __init__(self, bind_address, port, processor): |
58 |
"""Constructor for ConfdAsyncUDPServer |
59 |
|
60 |
@type bind_address: string |
61 |
@param bind_address: socket bind address ('' for all) |
62 |
@type port: int |
63 |
@param port: udp port |
64 |
@type processor: L{confd.server.ConfdProcessor} |
65 |
@param processor: ConfdProcessor to use to handle queries |
66 |
|
67 |
""" |
68 |
daemon.AsyncUDPSocket.__init__(self) |
69 |
self.bind_address = bind_address |
70 |
self.port = port |
71 |
self.processor = processor |
72 |
self.bind((bind_address, port)) |
73 |
logging.debug("listening on ('%s':%d)", bind_address, port) |
74 |
|
75 |
# this method is overriding a daemon.AsyncUDPSocket method |
76 |
def handle_datagram(self, payload_in, ip, port): |
77 |
try: |
78 |
query = confd.UnpackMagic(payload_in) |
79 |
except errors.ConfdMagicError, err: |
80 |
logging.debug(err) |
81 |
return |
82 |
|
83 |
answer = self.processor.ExecQuery(query, ip, port) |
84 |
if answer is not None: |
85 |
try: |
86 |
self.enqueue_send(ip, port, confd.PackMagic(answer)) |
87 |
except errors.UdpDataSizeError: |
88 |
logging.error("Reply too big to fit in an udp packet.") |
89 |
|
90 |
|
91 |
class ConfdInotifyEventHandler(pyinotify.ProcessEvent): |
92 |
|
93 |
def __init__(self, watch_manager, callback, |
94 |
filename=constants.CLUSTER_CONF_FILE): |
95 |
"""Constructor for ConfdInotifyEventHandler |
96 |
|
97 |
@type watch_manager: pyinotify.WatchManager |
98 |
@param watch_manager: ganeti-confd inotify watch manager |
99 |
@type callback: function accepting a boolean |
100 |
@param callback: function to call when an inotify event happens |
101 |
@type filename: string |
102 |
@param filename: config file to watch |
103 |
|
104 |
""" |
105 |
# pylint: disable-msg=W0231 |
106 |
# no need to call the parent's constructor |
107 |
self.watch_manager = watch_manager |
108 |
self.callback = callback |
109 |
self.mask = pyinotify.EventsCodes.ALL_FLAGS["IN_IGNORED"] | \ |
110 |
pyinotify.EventsCodes.ALL_FLAGS["IN_MODIFY"] |
111 |
self.file = filename |
112 |
self.watch_handle = None |
113 |
|
114 |
def enable(self): |
115 |
"""Watch the given file |
116 |
|
117 |
""" |
118 |
if self.watch_handle is None: |
119 |
result = self.watch_manager.add_watch(self.file, self.mask) |
120 |
if not self.file in result or result[self.file] <= 0: |
121 |
raise errors.InotifyError("Could not add inotify watcher") |
122 |
else: |
123 |
self.watch_handle = result[self.file] |
124 |
|
125 |
def disable(self): |
126 |
"""Stop watching the given file |
127 |
|
128 |
""" |
129 |
if self.watch_handle is not None: |
130 |
result = self.watch_manager.rm_watch(self.watch_handle) |
131 |
if result[self.watch_handle]: |
132 |
self.watch_handle = None |
133 |
|
134 |
def process_IN_IGNORED(self, event): |
135 |
# Due to the fact that we monitor just for the cluster config file (rather |
136 |
# than for the whole data dir) when the file is replaced with another one |
137 |
# (which is what happens normally in ganeti) we're going to receive an |
138 |
# IN_IGNORED event from inotify, because of the file removal (which is |
139 |
# contextual with the replacement). In such a case we need to create |
140 |
# another watcher for the "new" file. |
141 |
logging.debug("Received 'ignored' inotify event for %s", event.path) |
142 |
self.watch_handle = None |
143 |
|
144 |
try: |
145 |
# Since the kernel believes the file we were interested in is gone, it's |
146 |
# not going to notify us of any other events, until we set up, here, the |
147 |
# new watch. This is not a race condition, though, since we're anyway |
148 |
# going to realod the file after setting up the new watch. |
149 |
self.callback(False) |
150 |
except errors.ConfdFatalError, err: |
151 |
logging.critical("Critical error, shutting down: %s", err) |
152 |
sys.exit(constants.EXIT_FAILURE) |
153 |
except: |
154 |
# we need to catch any exception here, log it, but proceed, because even |
155 |
# if we failed handling a single request, we still want the confd to |
156 |
# continue working. |
157 |
logging.error("Unexpected exception", exc_info=True) |
158 |
|
159 |
def process_IN_MODIFY(self, event): |
160 |
# This gets called when the config file is modified. Note that this doesn't |
161 |
# usually happen in Ganeti, as the config file is normally replaced by a |
162 |
# new one, at filesystem level, rather than actually modified (see |
163 |
# utils.WriteFile) |
164 |
logging.debug("Received 'modify' inotify event for %s", event.path) |
165 |
|
166 |
try: |
167 |
self.callback(True) |
168 |
except errors.ConfdFatalError, err: |
169 |
logging.critical("Critical error, shutting down: %s", err) |
170 |
sys.exit(constants.EXIT_FAILURE) |
171 |
except: |
172 |
# we need to catch any exception here, log it, but proceed, because even |
173 |
# if we failed handling a single request, we still want the confd to |
174 |
# continue working. |
175 |
logging.error("Unexpected exception", exc_info=True) |
176 |
|
177 |
def process_default(self, event): |
178 |
logging.error("Received unhandled inotify event: %s", event) |
179 |
|
180 |
|
181 |
class ConfdConfigurationReloader(object): |
182 |
"""Logic to control when to reload the ganeti configuration |
183 |
|
184 |
This class is able to alter between inotify and polling, to rate-limit the |
185 |
number of reloads. When using inotify it also supports a fallback timed |
186 |
check, to verify that the reload hasn't failed. |
187 |
|
188 |
""" |
189 |
def __init__(self, processor, mainloop): |
190 |
"""Constructor for ConfdConfigurationReloader |
191 |
|
192 |
@type processor: L{confd.server.ConfdProcessor} |
193 |
@param processor: ganeti-confd ConfdProcessor |
194 |
@type mainloop: L{daemon.Mainloop} |
195 |
@param mainloop: ganeti-confd mainloop |
196 |
|
197 |
""" |
198 |
self.processor = processor |
199 |
self.mainloop = mainloop |
200 |
|
201 |
self.polling = True |
202 |
self.last_notification = 0 |
203 |
|
204 |
# Asyncronous inotify handler for config changes |
205 |
self.wm = pyinotify.WatchManager() |
206 |
self.inotify_handler = ConfdInotifyEventHandler(self.wm, self.OnInotify) |
207 |
self.notifier = asyncnotifier.AsyncNotifier(self.wm, self.inotify_handler) |
208 |
|
209 |
self.timer_handle = None |
210 |
self._EnableTimer() |
211 |
|
212 |
def OnInotify(self, notifier_enabled): |
213 |
"""Receive an inotify notification. |
214 |
|
215 |
@type notifier_enabled: boolean |
216 |
@param notifier_enabled: whether the notifier is still enabled |
217 |
|
218 |
""" |
219 |
current_time = time.time() |
220 |
time_delta = current_time - self.last_notification |
221 |
self.last_notification = current_time |
222 |
|
223 |
if time_delta < constants.CONFD_CONFIG_RELOAD_RATELIMIT: |
224 |
logging.debug("Moving from inotify mode to polling mode") |
225 |
self.polling = True |
226 |
if notifier_enabled: |
227 |
self.inotify_handler.disable() |
228 |
|
229 |
if not self.polling and not notifier_enabled: |
230 |
try: |
231 |
self.inotify_handler.enable() |
232 |
except errors.InotifyError: |
233 |
self.polling = True |
234 |
|
235 |
try: |
236 |
reloaded = self.processor.reader.Reload() |
237 |
if reloaded: |
238 |
logging.info("Reloaded ganeti config") |
239 |
else: |
240 |
logging.debug("Skipped double config reload") |
241 |
except errors.ConfigurationError: |
242 |
self.DisableConfd() |
243 |
self.inotify_handler.disable() |
244 |
return |
245 |
|
246 |
# Reset the timer. If we're polling it will go to the polling rate, if |
247 |
# we're not it will delay it again to its base safe timeout. |
248 |
self._ResetTimer() |
249 |
|
250 |
def _DisableTimer(self): |
251 |
if self.timer_handle is not None: |
252 |
self.mainloop.scheduler.cancel(self.timer_handle) |
253 |
self.timer_handle = None |
254 |
|
255 |
def _EnableTimer(self): |
256 |
if self.polling: |
257 |
timeout = constants.CONFD_CONFIG_RELOAD_RATELIMIT |
258 |
else: |
259 |
timeout = constants.CONFD_CONFIG_RELOAD_TIMEOUT |
260 |
|
261 |
if self.timer_handle is None: |
262 |
self.timer_handle = self.mainloop.scheduler.enter( |
263 |
timeout, 1, self.OnTimer, []) |
264 |
|
265 |
def _ResetTimer(self): |
266 |
self._DisableTimer() |
267 |
self._EnableTimer() |
268 |
|
269 |
def OnTimer(self): |
270 |
"""Function called when the timer fires |
271 |
|
272 |
""" |
273 |
self.timer_handle = None |
274 |
reloaded = False |
275 |
was_disabled = False |
276 |
try: |
277 |
if self.processor.reader is None: |
278 |
was_disabled = True |
279 |
self.EnableConfd() |
280 |
reloaded = True |
281 |
else: |
282 |
reloaded = self.processor.reader.Reload() |
283 |
except errors.ConfigurationError: |
284 |
self.DisableConfd(silent=was_disabled) |
285 |
return |
286 |
|
287 |
if self.polling and reloaded: |
288 |
logging.info("Reloaded ganeti config") |
289 |
elif reloaded: |
290 |
# We have reloaded the config files, but received no inotify event. If |
291 |
# an event is pending though, we just happen to have timed out before |
292 |
# receiving it, so this is not a problem, and we shouldn't alert |
293 |
if not self.notifier.check_events() and not was_disabled: |
294 |
logging.warning("Config file reload at timeout (inotify failure)") |
295 |
elif self.polling: |
296 |
# We're polling, but we haven't reloaded the config: |
297 |
# Going back to inotify mode |
298 |
logging.debug("Moving from polling mode to inotify mode") |
299 |
self.polling = False |
300 |
try: |
301 |
self.inotify_handler.enable() |
302 |
except errors.InotifyError: |
303 |
self.polling = True |
304 |
else: |
305 |
logging.debug("Performed configuration check") |
306 |
|
307 |
self._EnableTimer() |
308 |
|
309 |
def DisableConfd(self, silent=False): |
310 |
"""Puts confd in non-serving mode |
311 |
|
312 |
""" |
313 |
if not silent: |
314 |
logging.warning("Confd is being disabled") |
315 |
self.processor.Disable() |
316 |
self.polling = False |
317 |
self._ResetTimer() |
318 |
|
319 |
def EnableConfd(self): |
320 |
self.processor.Enable() |
321 |
logging.warning("Confd is being enabled") |
322 |
self.polling = True |
323 |
self._ResetTimer() |
324 |
|
325 |
|
326 |
def CheckConfd(_, args): |
327 |
"""Initial checks whether to run exit with a failure. |
328 |
|
329 |
""" |
330 |
if args: # confd doesn't take any arguments |
331 |
print >> sys.stderr, ("Usage: %s [-f] [-d] [-b ADDRESS]" % sys.argv[0]) |
332 |
sys.exit(constants.EXIT_FAILURE) |
333 |
|
334 |
# TODO: collapse HMAC daemons handling in daemons GenericMain, when we'll |
335 |
# have more than one. |
336 |
if not os.path.isfile(constants.CONFD_HMAC_KEY): |
337 |
print >> sys.stderr, "Need HMAC key %s to run" % constants.CONFD_HMAC_KEY |
338 |
sys.exit(constants.EXIT_FAILURE) |
339 |
|
340 |
|
341 |
def ExecConfd(options, _): |
342 |
"""Main confd function, executed with PID file held |
343 |
|
344 |
""" |
345 |
# TODO: clarify how the server and reloader variables work (they are |
346 |
# not used) |
347 |
# pylint: disable-msg=W0612 |
348 |
mainloop = daemon.Mainloop() |
349 |
|
350 |
# Asyncronous confd UDP server |
351 |
processor = confd_server.ConfdProcessor() |
352 |
try: |
353 |
processor.Enable() |
354 |
except errors.ConfigurationError: |
355 |
# If enabling the processor has failed, we can still go on, but confd will |
356 |
# be disabled |
357 |
logging.warning("Confd is starting in disabled mode") |
358 |
|
359 |
server = ConfdAsyncUDPServer(options.bind_address, options.port, processor) |
360 |
|
361 |
# Configuration reloader |
362 |
reloader = ConfdConfigurationReloader(processor, mainloop) |
363 |
|
364 |
mainloop.Run() |
365 |
|
366 |
|
367 |
def main(): |
368 |
"""Main function for the confd daemon. |
369 |
|
370 |
""" |
371 |
parser = OptionParser(description="Ganeti configuration daemon", |
372 |
usage="%prog [-f] [-d] [-b ADDRESS]", |
373 |
version="%%prog (ganeti) %s" % |
374 |
constants.RELEASE_VERSION) |
375 |
|
376 |
dirs = [(val, constants.RUN_DIRS_MODE) for val in constants.SUB_RUN_DIRS] |
377 |
dirs.append((constants.LOCK_DIR, 1777)) |
378 |
daemon.GenericMain(constants.CONFD, parser, dirs, CheckConfd, ExecConfd) |
379 |
|
380 |
|
381 |
if __name__ == "__main__": |
382 |
main() |