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
32
33
34
#!/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 asyncore
import socket
import pyinotify
Guido Trotter's avatar
Guido Trotter committed
35
import time
36
import errno
Guido Trotter's avatar
Guido Trotter committed
37
38
39

from optparse import OptionParser

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


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

    """
64
    daemon.AsyncUDPSocket.__init__(self)
Guido Trotter's avatar
Guido Trotter committed
65
66
67
68
69
70
    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))

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

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


class ConfdInotifyEventHandler(pyinotify.ProcessEvent):

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

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

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

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

    """
113
114
115
    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:
116
        raise errors.InotifyError("Could not add inotify watcher")
117
118
119
120
121
122
123
124
125
126
127
      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
128
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.
    logging.debug("Received 'ignored' inotify event for %s" % event.path)
137
    self.watch_handle = None
Guido Trotter's avatar
Guido Trotter committed
138
139
140
141
142
143

    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.
144
      self.callback(False)
Guido Trotter's avatar
Guido Trotter committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
    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:
162
      self.callback(True)
Guido Trotter's avatar
Guido Trotter committed
163
164
165
166
167
168
169
170
171
172
173
174
175
    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)


176
177
178
179
180
181
182
183
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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    self._EnableTimer()
303

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

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

320

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

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

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

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

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

  mainloop.Run()
Guido Trotter's avatar
Guido Trotter committed
353
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.LOG_OS_DIR, 0750))
  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()