ganeti-confd 11.7 KB
Newer Older
Guido Trotter's avatar
Guido Trotter committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/python
#

# Copyright (C) 2009, Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Ganeti configuration daemon

Ganeti-confd is a daemon to query master candidates for configuration values.
It uses UDP+HMAC for authentication with a global cluster key.

"""

import os
import sys
import logging
Guido Trotter's avatar
Guido Trotter committed
32
import time
Guido Trotter's avatar
Guido Trotter committed
33

34
35
36
37
38
try:
  from pyinotify import pyinotify
except ImportError:
  import pyinotify

Guido Trotter's avatar
Guido Trotter committed
39
40
from optparse import OptionParser

41
42
43
from ganeti import asyncnotifier
from ganeti import confd
from ganeti.confd import server as confd_server
Guido Trotter's avatar
Guido Trotter committed
44
45
46
47
48
49
from ganeti import constants
from ganeti import errors
from ganeti import daemon
from ganeti import ssconf


50
class ConfdAsyncUDPServer(daemon.AsyncUDPSocket):
Guido Trotter's avatar
Guido Trotter committed
51
52
53
54
55
56
57
58
59
60
61
  """The confd udp server, suitable for use with asyncore.

  """
  def __init__(self, bind_address, port, processor):
    """Constructor for ConfdAsyncUDPServer

    @type bind_address: string
    @param bind_address: socket bind address ('' for all)
    @type port: int
    @param port: udp port
    @type processor: L{confd.server.ConfdProcessor}
62
    @param processor: ConfdProcessor to use to handle queries
Guido Trotter's avatar
Guido Trotter committed
63
64

    """
65
    daemon.AsyncUDPSocket.__init__(self)
Guido Trotter's avatar
Guido Trotter committed
66
67
68
69
    self.bind_address = bind_address
    self.port = port
    self.processor = processor
    self.bind((bind_address, port))
Iustin Pop's avatar
Iustin Pop committed
70
    logging.debug("listening on ('%s':%d)", bind_address, port)
Guido Trotter's avatar
Guido Trotter committed
71

72
73
  # this method is overriding a daemon.AsyncUDPSocket method
  def handle_datagram(self, payload_in, ip, port):
74
    try:
75
      query = confd.UnpackMagic(payload_in)
76
77
    except errors.ConfdMagicError, err:
      logging.debug(err)
78
79
80
81
      return

    answer =  self.processor.ExecQuery(query, ip, port)
    if answer is not None:
82
      try:
83
        self.enqueue_send(ip, port, confd.PackMagic(answer))
84
85
      except errors.UdpDataSizeError:
        logging.error("Reply too big to fit in an udp packet.")
Guido Trotter's avatar
Guido Trotter committed
86
87
88
89


class ConfdInotifyEventHandler(pyinotify.ProcessEvent):

90
  def __init__(self, watch_manager, callback,
Guido Trotter's avatar
Guido Trotter committed
91
92
93
94
95
               file=constants.CLUSTER_CONF_FILE):
    """Constructor for ConfdInotifyEventHandler

    @type watch_manager: L{pyinotify.WatchManager}
    @param watch_manager: ganeti-confd inotify watch manager
96
97
    @type callback: function accepting a boolean
    @param callback: function to call when an inotify event happens
Guido Trotter's avatar
Guido Trotter committed
98
99
100
101
102
103
    @type file: string
    @param file: config file to watch

    """
    # no need to call the parent's constructor
    self.watch_manager = watch_manager
104
    self.callback = callback
Guido Trotter's avatar
Guido Trotter committed
105
106
107
    self.mask = pyinotify.EventsCodes.IN_IGNORED | \
                pyinotify.EventsCodes.IN_MODIFY
    self.file = file
108
    self.watch_handle = None
Guido Trotter's avatar
Guido Trotter committed
109

110
111
  def enable(self):
    """Watch the given file
Guido Trotter's avatar
Guido Trotter committed
112
113

    """
114
115
116
    if self.watch_handle is None:
      result = self.watch_manager.add_watch(self.file, self.mask)
      if not self.file in result or result[self.file] <= 0:
117
        raise errors.InotifyError("Could not add inotify watcher")
118
119
120
121
122
123
124
125
126
127
128
      else:
        self.watch_handle = result[self.file]

  def disable(self):
    """Stop watching the given file

    """
    if self.watch_handle is not None:
      result = self.watch_manager.rm_watch(self.watch_handle)
      if result[self.watch_handle]:
        self.watch_handle = None
Guido Trotter's avatar
Guido Trotter committed
129
130
131
132
133
134
135
136

  def process_IN_IGNORED(self, event):
    # Due to the fact that we monitor just for the cluster config file (rather
    # than for the whole data dir) when the file is replaced with another one
    # (which is what happens normally in ganeti) we're going to receive an
    # IN_IGNORED event from inotify, because of the file removal (which is
    # contextual with the replacement). In such a case we need to create
    # another watcher for the "new" file.
Iustin Pop's avatar
Iustin Pop committed
137
    logging.debug("Received 'ignored' inotify event for %s", event.path)
138
    self.watch_handle = None
Guido Trotter's avatar
Guido Trotter committed
139
140
141
142
143
144

    try:
      # Since the kernel believes the file we were interested in is gone, it's
      # not going to notify us of any other events, until we set up, here, the
      # new watch. This is not a race condition, though, since we're anyway
      # going to realod the file after setting up the new watch.
145
      self.callback(False)
Guido Trotter's avatar
Guido Trotter committed
146
    except errors.ConfdFatalError, err:
Iustin Pop's avatar
Iustin Pop committed
147
      logging.critical("Critical error, shutting down: %s", err)
Guido Trotter's avatar
Guido Trotter committed
148
149
150
151
152
153
154
155
156
157
158
159
      sys.exit(constants.EXIT_FAILURE)
    except:
      # we need to catch any exception here, log it, but proceed, because even
      # if we failed handling a single request, we still want the confd to
      # continue working.
      logging.error("Unexpected exception", exc_info=True)

  def process_IN_MODIFY(self, event):
    # This gets called when the config file is modified. Note that this doesn't
    # usually happen in Ganeti, as the config file is normally replaced by a
    # new one, at filesystem level, rather than actually modified (see
    # utils.WriteFile)
Iustin Pop's avatar
Iustin Pop committed
160
    logging.debug("Received 'modify' inotify event for %s", event.path)
Guido Trotter's avatar
Guido Trotter committed
161
162

    try:
163
      self.callback(True)
Guido Trotter's avatar
Guido Trotter committed
164
    except errors.ConfdFatalError, err:
Iustin Pop's avatar
Iustin Pop committed
165
      logging.critical("Critical error, shutting down: %s", err)
Guido Trotter's avatar
Guido Trotter committed
166
167
168
169
170
171
172
173
      sys.exit(constants.EXIT_FAILURE)
    except:
      # we need to catch any exception here, log it, but proceed, because even
      # if we failed handling a single request, we still want the confd to
      # continue working.
      logging.error("Unexpected exception", exc_info=True)

  def process_default(self, event):
Iustin Pop's avatar
Iustin Pop committed
174
    logging.error("Received unhandled inotify event: %s", event)
Guido Trotter's avatar
Guido Trotter committed
175
176


177
178
179
180
181
182
183
184
class ConfdConfigurationReloader(object):
  """Logic to control when to reload the ganeti configuration

  This class is able to alter between inotify and polling, to rate-limit the
  number of reloads. When using inotify it also supports a fallback timed
  check, to verify that the reload hasn't failed.

  """
185
  def __init__(self, processor, mainloop):
186
187
    """Constructor for ConfdConfigurationReloader

188
189
    @type processor: L{confd.server.ConfdProcessor}
    @param processor: ganeti-confd ConfdProcessor
Guido Trotter's avatar
Guido Trotter committed
190
191
    @type mainloop: L{daemon.Mainloop}
    @param mainloop: ganeti-confd mainloop
192
193

    """
194
    self.processor = processor
Guido Trotter's avatar
Guido Trotter committed
195
196
    self.mainloop = mainloop

Guido Trotter's avatar
Guido Trotter committed
197
    self.polling = True
Guido Trotter's avatar
Guido Trotter committed
198
    self.last_notification = 0
199
200
201

    # Asyncronous inotify handler for config changes
    self.wm = pyinotify.WatchManager()
202
    self.inotify_handler = ConfdInotifyEventHandler(self.wm, self.OnInotify)
203
    self.notifier = asyncnotifier.AsyncNotifier(self.wm, self.inotify_handler)
204

Guido Trotter's avatar
Guido Trotter committed
205
206
207
    self.timer_handle = None
    self._EnableTimer()

208
209
210
211
212
213
214
  def OnInotify(self, notifier_enabled):
    """Receive an inotify notification.

    @type notifier_enabled: boolean
    @param notifier_enabled: whether the notifier is still enabled

    """
Guido Trotter's avatar
Guido Trotter committed
215
216
217
218
219
220
221
222
    current_time = time.time()
    time_delta = current_time - self.last_notification
    self.last_notification = current_time

    if time_delta < constants.CONFD_CONFIG_RELOAD_RATELIMIT:
      logging.debug("Moving from inotify mode to polling mode")
      self.polling = True
      if notifier_enabled:
223
        self.inotify_handler.disable()
Guido Trotter's avatar
Guido Trotter committed
224
225

    if not self.polling and not notifier_enabled:
226
227
228
      try:
        self.inotify_handler.enable()
      except errors.InotifyError:
229
        self.polling = True
230
231

    try:
232
      reloaded = self.processor.reader.Reload()
233
234
235
236
237
      if reloaded:
        logging.info("Reloaded ganeti config")
      else:
        logging.debug("Skipped double config reload")
    except errors.ConfigurationError:
238
239
240
      self.DisableConfd()
      self.inotify_handler.disable()
      return
241

Guido Trotter's avatar
Guido Trotter committed
242
243
    # Reset the timer. If we're polling it will go to the polling rate, if
    # we're not it will delay it again to its base safe timeout.
244
    self._ResetTimer()
Guido Trotter's avatar
Guido Trotter committed
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

  def _DisableTimer(self):
    if self.timer_handle is not None:
      self.mainloop.scheduler.cancel(self.timer_handle)
      self.timer_handle = None

  def _EnableTimer(self):
    if self.polling:
      timeout = constants.CONFD_CONFIG_RELOAD_RATELIMIT
    else:
      timeout = constants.CONFD_CONFIG_RELOAD_TIMEOUT

    if self.timer_handle is None:
      self.timer_handle = self.mainloop.scheduler.enter(
        timeout, 1, self.OnTimer, [])

261
262
263
264
  def _ResetTimer(self):
    self._DisableTimer()
    self._EnableTimer()

Guido Trotter's avatar
Guido Trotter committed
265
266
267
268
269
  def OnTimer(self):
    """Function called when the timer fires

    """
    self.timer_handle = None
270
271
    reloaded = False
    was_disabled = False
Guido Trotter's avatar
Guido Trotter committed
272
    try:
273
274
275
276
277
278
      if self.processor.reader is None:
        was_disabled = True
        self.EnableConfd()
        reloaded = True
      else:
        reloaded = self.processor.reader.Reload()
Guido Trotter's avatar
Guido Trotter committed
279
    except errors.ConfigurationError:
280
      self.DisableConfd(silent=was_disabled)
281
      return
Guido Trotter's avatar
Guido Trotter committed
282
283
284
285
286
287
288

    if self.polling and reloaded:
      logging.info("Reloaded ganeti config")
    elif reloaded:
      # We have reloaded the config files, but received no inotify event.  If
      # an event is pending though, we just happen to have timed out before
      # receiving it, so this is not a problem, and we shouldn't alert
289
      if not self.notifier.check_events() and not was_disabled:
Guido Trotter's avatar
Guido Trotter committed
290
291
292
293
294
295
        logging.warning("Config file reload at timeout (inotify failure)")
    elif self.polling:
      # We're polling, but we haven't reloaded the config:
      # Going back to inotify mode
      logging.debug("Moving from polling mode to inotify mode")
      self.polling = False
296
297
298
299
      try:
        self.inotify_handler.enable()
      except errors.InotifyError:
        self.polling = True
Guido Trotter's avatar
Guido Trotter committed
300
301
302
303
    else:
      logging.debug("Performed configuration check")

    self._EnableTimer()
304

305
  def DisableConfd(self, silent=False):
306
307
308
    """Puts confd in non-serving mode

    """
309
310
    if not silent:
      logging.warning("Confd is being disabled")
311
312
313
314
315
316
317
318
319
320
    self.processor.Disable()
    self.polling = False
    self._ResetTimer()

  def EnableConfd(self):
    self.processor.Enable()
    logging.warning("Confd is being enabled")
    self.polling = True
    self._ResetTimer()

321

Michael Hanselmann's avatar
Michael Hanselmann committed
322
323
def CheckConfd(options, args):
  """Initial checks whether to run exit with a failure.
Guido Trotter's avatar
Guido Trotter committed
324
325
326
327
328
329
330
331
332

  """
  # TODO: collapse HMAC daemons handling in daemons GenericMain, when we'll
  # have more than one.
  if not os.path.isfile(constants.HMAC_CLUSTER_KEY):
    print >> sys.stderr, "Need HMAC key %s to run" % constants.HMAC_CLUSTER_KEY
    sys.exit(constants.EXIT_FAILURE)


Michael Hanselmann's avatar
Michael Hanselmann committed
333
334
def ExecConfd(options, args):
  """Main confd function, executed with PID file held
Guido Trotter's avatar
Guido Trotter committed
335
336

  """
337
338
  mainloop = daemon.Mainloop()

Guido Trotter's avatar
Guido Trotter committed
339
  # Asyncronous confd UDP server
340
  processor = confd_server.ConfdProcessor()
341
342
343
  try:
    processor.Enable()
  except errors.ConfigurationError:
344
345
    # If enabling the processor has failed, we can still go on, but confd will
    # be disabled
346
    logging.warning("Confd is starting in disabled mode")
347
    pass
Guido Trotter's avatar
Guido Trotter committed
348
349
  server = ConfdAsyncUDPServer(options.bind_address, options.port, processor)

350
  # Configuration reloader
351
  reloader = ConfdConfigurationReloader(processor, mainloop)
352
353

  mainloop.Run()
Guido Trotter's avatar
Guido Trotter committed
354
355
356
357
358
359
360
361
362
363
364
365
366


def main():
  """Main function for the confd daemon.

  """
  parser = OptionParser(description="Ganeti configuration daemon",
                        usage="%prog [-f] [-d] [-b ADDRESS]",
                        version="%%prog (ganeti) %s" %
                        constants.RELEASE_VERSION)

  dirs = [(val, constants.RUN_DIRS_MODE) for val in constants.SUB_RUN_DIRS]
  dirs.append((constants.LOCK_DIR, 1777))
Michael Hanselmann's avatar
Michael Hanselmann committed
367
  daemon.GenericMain(constants.CONFD, parser, dirs, CheckConfd, ExecConfd)
Guido Trotter's avatar
Guido Trotter committed
368
369


Michael Hanselmann's avatar
Michael Hanselmann committed
370
if __name__ == "__main__":
Guido Trotter's avatar
Guido Trotter committed
371
  main()