ganeti-confd 11.6 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
32
#!/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
import pyinotify
Guido Trotter's avatar
Guido Trotter committed
33
import time
Guido Trotter's avatar
Guido Trotter committed
34
35
36

from optparse import OptionParser

37
38
39
from ganeti import asyncnotifier
from ganeti import confd
from ganeti.confd import server as confd_server
Guido Trotter's avatar
Guido Trotter committed
40
41
42
43
44
45
from ganeti import constants
from ganeti import errors
from ganeti import daemon
from ganeti import ssconf


46
class ConfdAsyncUDPServer(daemon.AsyncUDPSocket):
Guido Trotter's avatar
Guido Trotter committed
47
48
49
50
51
52
53
54
55
56
57
  """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}
58
    @param processor: ConfdProcessor to use to handle queries
Guido Trotter's avatar
Guido Trotter committed
59
60

    """
61
    daemon.AsyncUDPSocket.__init__(self)
Guido Trotter's avatar
Guido Trotter committed
62
63
64
65
66
67
    self.bind_address = bind_address
    self.port = port
    self.processor = processor
    self.bind((bind_address, port))
    logging.debug("listening on ('%s':%d)" % (bind_address, port))

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

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


class ConfdInotifyEventHandler(pyinotify.ProcessEvent):

86
  def __init__(self, watch_manager, callback,
Guido Trotter's avatar
Guido Trotter committed
87
88
89
90
91
               file=constants.CLUSTER_CONF_FILE):
    """Constructor for ConfdInotifyEventHandler

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

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

106
107
  def enable(self):
    """Watch the given file
Guido Trotter's avatar
Guido Trotter committed
108
109

    """
110
111
112
    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:
113
        raise errors.InotifyError("Could not add inotify watcher")
114
115
116
117
118
119
120
121
122
123
124
      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
125
126
127
128
129
130
131
132
133

  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.
    logging.debug("Received 'ignored' inotify event for %s" % event.path)
134
    self.watch_handle = None
Guido Trotter's avatar
Guido Trotter committed
135
136
137
138
139
140

    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.
141
      self.callback(False)
Guido Trotter's avatar
Guido Trotter committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    except errors.ConfdFatalError, err:
      logging.critical("Critical error, shutting down: %s" % err)
      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)
    logging.debug("Received 'modify' inotify event for %s" % event.path)

    try:
159
      self.callback(True)
Guido Trotter's avatar
Guido Trotter committed
160
161
162
163
164
165
166
167
168
169
170
171
172
    except errors.ConfdFatalError, err:
      logging.critical("Critical error, shutting down: %s" % err)
      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):
    logging.error("Received unhandled inotify event: %s" % event)


173
174
175
176
177
178
179
180
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.

  """
181
  def __init__(self, processor, mainloop):
182
183
    """Constructor for ConfdConfigurationReloader

184
185
    @type processor: L{confd.server.ConfdProcessor}
    @param processor: ganeti-confd ConfdProcessor
Guido Trotter's avatar
Guido Trotter committed
186
187
    @type mainloop: L{daemon.Mainloop}
    @param mainloop: ganeti-confd mainloop
188
189

    """
190
    self.processor = processor
Guido Trotter's avatar
Guido Trotter committed
191
192
    self.mainloop = mainloop

Guido Trotter's avatar
Guido Trotter committed
193
    self.polling = True
Guido Trotter's avatar
Guido Trotter committed
194
    self.last_notification = 0
195
196
197

    # Asyncronous inotify handler for config changes
    self.wm = pyinotify.WatchManager()
198
    self.inotify_handler = ConfdInotifyEventHandler(self.wm, self.OnInotify)
199
    self.notifier = asyncnotifier.AsyncNotifier(self.wm, self.inotify_handler)
200

Guido Trotter's avatar
Guido Trotter committed
201
202
203
    self.timer_handle = None
    self._EnableTimer()

204
205
206
207
208
209
210
  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
211
212
213
214
215
216
217
218
    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:
219
        self.inotify_handler.disable()
Guido Trotter's avatar
Guido Trotter committed
220
221

    if not self.polling and not notifier_enabled:
222
223
224
      try:
        self.inotify_handler.enable()
      except errors.InotifyError:
225
        self.polling = True
226
227

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

Guido Trotter's avatar
Guido Trotter committed
238
239
    # 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.
240
    self._ResetTimer()
Guido Trotter's avatar
Guido Trotter committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

  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, [])

257
258
259
260
  def _ResetTimer(self):
    self._DisableTimer()
    self._EnableTimer()

Guido Trotter's avatar
Guido Trotter committed
261
262
263
264
265
  def OnTimer(self):
    """Function called when the timer fires

    """
    self.timer_handle = None
266
267
    reloaded = False
    was_disabled = False
Guido Trotter's avatar
Guido Trotter committed
268
    try:
269
270
271
272
273
274
      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
275
    except errors.ConfigurationError:
276
      self.DisableConfd(silent=was_disabled)
277
      return
Guido Trotter's avatar
Guido Trotter committed
278
279
280
281
282
283
284

    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
285
      if not self.notifier.check_events() and not was_disabled:
Guido Trotter's avatar
Guido Trotter committed
286
287
288
289
290
291
        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
292
293
294
295
      try:
        self.inotify_handler.enable()
      except errors.InotifyError:
        self.polling = True
Guido Trotter's avatar
Guido Trotter committed
296
297
298
299
    else:
      logging.debug("Performed configuration check")

    self._EnableTimer()
300

301
  def DisableConfd(self, silent=False):
302
303
304
    """Puts confd in non-serving mode

    """
305
306
    if not silent:
      logging.warning("Confd is being disabled")
307
308
309
310
311
312
313
314
315
316
    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()

317

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

  """
  # 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
329
330
def ExecConfd(options, args):
  """Main confd function, executed with PID file held
Guido Trotter's avatar
Guido Trotter committed
331
332

  """
333
334
  mainloop = daemon.Mainloop()

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

346
  # Configuration reloader
347
  reloader = ConfdConfigurationReloader(processor, mainloop)
348
349

  mainloop.Run()
Guido Trotter's avatar
Guido Trotter committed
350
351
352
353
354
355
356
357
358
359
360
361
362


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
363
  daemon.GenericMain(constants.CONFD, parser, dirs, CheckConfd, ExecConfd)
Guido Trotter's avatar
Guido Trotter committed
364
365


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