Add new “daemon-util” script to start/stop Ganeti daemons
[ganeti-local] / daemons / ganeti-masterd
index 1c884bb..4e77c71 100755 (executable)
@@ -1,4 +1,4 @@
-#!/usr/bin/python -u
+#!/usr/bin/python
 #
 
 # Copyright (C) 2006, 2007 Google Inc.
@@ -27,21 +27,19 @@ inheritance from parent classes requires it.
 """
 
 
+import os
 import sys
 import SocketServer
 import time
 import collections
-import Queue
-import random
 import signal
-import simplejson
 import logging
 
-from cStringIO import StringIO
 from optparse import OptionParser
 
 from ganeti import config
 from ganeti import constants
+from ganeti import daemon
 from ganeti import mcpu
 from ganeti import opcodes
 from ganeti import jqueue
@@ -50,9 +48,10 @@ from ganeti import luxi
 from ganeti import utils
 from ganeti import errors
 from ganeti import ssconf
-from ganeti import logger
 from ganeti import workerpool
 from ganeti import rpc
+from ganeti import bootstrap
+from ganeti import serializer
 
 
 CLIENT_REQUEST_WORKERS = 16
@@ -87,9 +86,8 @@ class IOServer(SocketServer.UnixStreamServer):
   def __init__(self, address, rqhandler):
     """IOServer constructor
 
-    Args:
-      address: the address to bind this IOServer to
-      rqhandler: RequestHandler type object
+    @param address: the address to bind this IOServer to
+    @param rqhandler: RequestHandler type object
 
     """
     SocketServer.UnixStreamServer.__init__(self, address, rqhandler)
@@ -109,14 +107,17 @@ class IOServer(SocketServer.UnixStreamServer):
     """
     self.request_workers.AddTask(self, request, client_address)
 
-  def serve_forever(self):
+  @utils.SignalHandled([signal.SIGINT, signal.SIGTERM])
+  def serve_forever(self, signal_handlers=None):
     """Handle one request at a time until told to quit."""
-    sighandler = utils.SignalHandler([signal.SIGINT, signal.SIGTERM])
-    try:
-      while not sighandler.called:
-        self.handle_request()
-    finally:
-      sighandler.Reset()
+    assert isinstance(signal_handlers, dict) and \
+           len(signal_handlers) > 0, \
+           "Broken SignalHandled decorator"
+    # Since we use SignalHandled only once, the resulting dict will map all
+    # signals to the same handler. We'll just use the first one.
+    sighandler = signal_handlers.values()[0]
+    while not sighandler.called:
+      self.handle_request()
 
   def server_cleanup(self):
     """Cleanup the server.
@@ -148,10 +149,10 @@ class ClientRqHandler(SocketServer.BaseRequestHandler):
     while True:
       msg = self.read_message()
       if msg is None:
-        logging.info("client closed connection")
+        logging.debug("client closed connection")
         break
 
-      request = simplejson.loads(msg)
+      request = serializer.LoadJson(msg)
       logging.debug("request: %s", request)
       if not isinstance(request, dict):
         logging.error("wrong request received: %s", msg)
@@ -167,6 +168,9 @@ class ClientRqHandler(SocketServer.BaseRequestHandler):
       try:
         result = self._ops.handle_request(method, args)
         success = True
+      except errors.GenericError, err:
+        success = False
+        result = errors.EncodeException(err)
       except:
         logging.error("Unexpected exception", exc_info=True)
         err = sys.exc_info()
@@ -177,7 +181,7 @@ class ClientRqHandler(SocketServer.BaseRequestHandler):
         luxi.KEY_RESULT: result,
         }
       logging.debug("response: %s", response)
-      self.send_message(simplejson.dumps(response))
+      self.send_message(serializer.DumpJson(response))
 
   def read_message(self):
     while not self._msgs:
@@ -191,6 +195,7 @@ class ClientRqHandler(SocketServer.BaseRequestHandler):
 
   def send_message(self, msg):
     #print "sending", msg
+    # TODO: sendall is not guaranteed to send everything
     self.request.sendall(msg + self.EOM)
 
 
@@ -205,59 +210,120 @@ class ClientOps:
     # TODO: Parameter validation
 
     if method == luxi.REQ_SUBMIT_JOB:
+      logging.info("Received new job")
       ops = [opcodes.OpCode.LoadOpCode(state) for state in args]
       return queue.SubmitJob(ops)
 
+    if method == luxi.REQ_SUBMIT_MANY_JOBS:
+      logging.info("Received multiple jobs")
+      jobs = []
+      for ops in args:
+        jobs.append([opcodes.OpCode.LoadOpCode(state) for state in ops])
+      return queue.SubmitManyJobs(jobs)
+
     elif method == luxi.REQ_CANCEL_JOB:
       job_id = args
+      logging.info("Received job cancel request for %s", job_id)
       return queue.CancelJob(job_id)
 
     elif method == luxi.REQ_ARCHIVE_JOB:
       job_id = args
+      logging.info("Received job archive request for %s", job_id)
       return queue.ArchiveJob(job_id)
 
+    elif method == luxi.REQ_AUTOARCHIVE_JOBS:
+      (age, timeout) = args
+      logging.info("Received job autoarchive request for age %s, timeout %s",
+                   age, timeout)
+      return queue.AutoArchiveJobs(age, timeout)
+
     elif method == luxi.REQ_WAIT_FOR_JOB_CHANGE:
       (job_id, fields, prev_job_info, prev_log_serial, timeout) = args
+      logging.info("Received job poll request for %s", job_id)
       return queue.WaitForJobChanges(job_id, fields, prev_job_info,
                                      prev_log_serial, timeout)
 
     elif method == luxi.REQ_QUERY_JOBS:
       (job_ids, fields) = args
+      if isinstance(job_ids, (tuple, list)) and job_ids:
+        msg = ", ".join(job_ids)
+      else:
+        msg = str(job_ids)
+      logging.info("Received job query request for %s", msg)
       return queue.QueryJobs(job_ids, fields)
 
     elif method == luxi.REQ_QUERY_INSTANCES:
-      (names, fields) = args
-      op = opcodes.OpQueryInstances(names=names, output_fields=fields)
+      (names, fields, use_locking) = args
+      logging.info("Received instance query request for %s", names)
+      if use_locking:
+        raise errors.OpPrereqError("Sync queries are not allowed",
+                                   errors.ECODE_INVAL)
+      op = opcodes.OpQueryInstances(names=names, output_fields=fields,
+                                    use_locking=use_locking)
       return self._Query(op)
 
     elif method == luxi.REQ_QUERY_NODES:
-      (names, fields) = args
-      op = opcodes.OpQueryNodes(names=names, output_fields=fields)
+      (names, fields, use_locking) = args
+      logging.info("Received node query request for %s", names)
+      if use_locking:
+        raise errors.OpPrereqError("Sync queries are not allowed",
+                                   errors.ECODE_INVAL)
+      op = opcodes.OpQueryNodes(names=names, output_fields=fields,
+                                use_locking=use_locking)
       return self._Query(op)
 
     elif method == luxi.REQ_QUERY_EXPORTS:
-      nodes = args
-      op = opcodes.OpQueryExports(nodes=nodes)
+      nodes, use_locking = args
+      if use_locking:
+        raise errors.OpPrereqError("Sync queries are not allowed",
+                                   errors.ECODE_INVAL)
+      logging.info("Received exports query request")
+      op = opcodes.OpQueryExports(nodes=nodes, use_locking=use_locking)
       return self._Query(op)
 
     elif method == luxi.REQ_QUERY_CONFIG_VALUES:
       fields = args
+      logging.info("Received config values query request for %s", fields)
       op = opcodes.OpQueryConfigValues(output_fields=fields)
       return self._Query(op)
 
-    else:
-      raise ValueError("Invalid operation")
+    elif method == luxi.REQ_QUERY_CLUSTER_INFO:
+      logging.info("Received cluster info query request")
+      op = opcodes.OpQueryClusterInfo()
+      return self._Query(op)
+
+    elif method == luxi.REQ_QUEUE_SET_DRAIN_FLAG:
+      drain_flag = args
+      logging.info("Received queue drain flag change request to %s",
+                   drain_flag)
+      return queue.SetDrainFlag(drain_flag)
+
+    elif method == luxi.REQ_SET_WATCHER_PAUSE:
+      (until, ) = args
+
+      if until is None:
+        logging.info("Received request to no longer pause the watcher")
+      else:
+        if not isinstance(until, (int, float)):
+          raise TypeError("Duration must be an integer or float")
 
-  def _DummyLog(self, *args):
-    pass
+        if until < time.time():
+          raise errors.GenericError("Unable to set pause end time in the past")
+
+        logging.info("Received request to pause the watcher until %s", until)
+
+      return _SetWatcherPause(until)
+
+    else:
+      logging.info("Received invalid request '%s'", method)
+      raise ValueError("Invalid operation '%s'" % method)
 
   def _Query(self, op):
     """Runs the specified opcode and returns the result.
 
     """
     proc = mcpu.Processor(self.server.context)
-    # TODO: Where should log messages go?
-    return proc.ExecOpCode(op, self._DummyLog)
+    return proc.ExecOpCode(op, None)
 
 
 class GanetiContext(object):
@@ -306,7 +372,7 @@ class GanetiContext(object):
     self.cfg.AddNode(node)
 
     # If preseeding fails it'll not be added
-    self.jobqueue.AddNode(node.name)
+    self.jobqueue.AddNode(node)
 
     # Add the new node to the Ganeti Lock Manager
     self.glm.add(locking.LEVEL_NODE, node.name)
@@ -316,7 +382,7 @@ class GanetiContext(object):
 
     """
     # Synchronize the queue again
-    self.jobqueue.AddNode(node.name)
+    self.jobqueue.AddNode(node)
 
   def RemoveNode(self, name):
     """Removes a node from the configuration and lock manager.
@@ -332,26 +398,20 @@ class GanetiContext(object):
     self.glm.remove(locking.LEVEL_NODE, name)
 
 
-def ParseOptions():
-  """Parse the command line options.
+def _SetWatcherPause(until):
+  """Creates or removes the watcher pause file.
 
-  Returns:
-    (options, args) as from OptionParser.parse_args()
+  @type until: None or int
+  @param until: Unix timestamp saying until when the watcher shouldn't run
 
   """
-  parser = OptionParser(description="Ganeti master daemon",
-                        usage="%prog [-f] [-d]",
-                        version="%%prog (ganeti) %s" %
-                        constants.RELEASE_VERSION)
+  if until is None:
+    utils.RemoveFile(constants.WATCHER_PAUSEFILE)
+  else:
+    utils.WriteFile(constants.WATCHER_PAUSEFILE,
+                    data="%d\n" % (until, ))
 
-  parser.add_option("-f", "--foreground", dest="fork",
-                    help="Don't detach from the current terminal",
-                    default=True, action="store_false")
-  parser.add_option("-d", "--debug", dest="debug",
-                    help="Enable some debug messages",
-                    default=False, action="store_true")
-  options, args = parser.parse_args()
-  return options, args
+  return until
 
 
 def CheckAgreement():
@@ -363,93 +423,185 @@ def CheckAgreement():
   future we could collect the current node list from our (possibly
   obsolete) known nodes.
 
+  In order to account for cold-start of all nodes, we retry for up to
+  a minute until we get a real answer as the top-voted one. If the
+  nodes are more out-of-sync, for now manual startup of the master
+  should be attempted.
+
+  Note that for a even number of nodes cluster, we need at least half
+  of the nodes (beside ourselves) to vote for us. This creates a
+  problem on two-node clusters, since in this case we require the
+  other node to be up too to confirm our status.
+
   """
   myself = utils.HostInfo().name
   #temp instantiation of a config writer, used only to get the node list
   cfg = config.ConfigWriter()
   node_list = cfg.GetNodeList()
   del cfg
-  try:
-    node_list.remove(myself)
-  except KeyError:
-    pass
-  if not node_list:
-    # either single node cluster, or a misconfiguration, but I won't
-    # break any other node, so I can proceed
-    return True
-  results = rpc.call_master_info(node_list)
-  if not isinstance(results, dict):
-    # this should not happen (unless internal error in rpc)
-    logging.critical("Can't complete rpc call, aborting master startup")
-    return False
-  positive = negative = 0
-  other_masters = {}
-  for node in results:
-    if not isinstance(results[node], (tuple, list)) or len(results[node]) < 3:
-      logging.warning("Can't contact node %s", node)
+  retries = 6
+  while retries > 0:
+    votes = bootstrap.GatherMasterVotes(node_list)
+    if not votes:
+      # empty node list, this is a one node cluster
+      return True
+    if votes[0][0] is None:
+      retries -= 1
+      time.sleep(10)
       continue
-    master_node = results[node][2]
-    if master_node == myself:
-      positive += 1
-    else:
-      negative += 1
-      if not master_node in other_masters:
-        other_masters[master_node] = 0
-      other_masters[master_node] += 1
-  if positive <= negative:
-    # bad!
-    logging.critical("It seems we are not the master (%d votes for,"
-                     " %d votes against)", positive, negative)
-    if len(other_masters) > 1:
-      logging.critical("The other nodes do not agree on a single master")
-    elif other_masters:
-      # TODO: resync my files from the master
-      logging.critical("It seems the real master is %s",
-                       other_masters.keys()[0])
-    else:
-      logging.critical("Can't contact any node for data, aborting startup")
+    break
+  if retries == 0:
+    logging.critical("Cluster inconsistent, most of the nodes didn't answer"
+                     " after multiple retries. Aborting startup")
     return False
-  return True
+  # here a real node is at the top of the list
+  all_votes = sum(item[1] for item in votes)
+  top_node, top_votes = votes[0]
+
+  result = False
+  if top_node != myself:
+    logging.critical("It seems we are not the master (top-voted node"
+                     " is %s with %d out of %d votes)", top_node, top_votes,
+                     all_votes)
+  elif top_votes < all_votes - top_votes:
+    logging.critical("It seems we are not the master (%d votes for,"
+                     " %d votes against)", top_votes, all_votes - top_votes)
+  else:
+    result = True
 
+  return result
 
-def main():
-  """Main function"""
 
-  options, args = ParseOptions()
-  utils.debug = options.debug
-  utils.no_fork = True
+def CheckAgreementWithRpc():
+  rpc.Init()
+  try:
+    return CheckAgreement()
+  finally:
+    rpc.Shutdown()
+
+
+def _RunInSeparateProcess(fn):
+  """Runs a function in a separate process.
+
+  Note: Only boolean return values are supported.
 
+  @type fn: callable
+  @param fn: Function to be called
+  @rtype: bool
+
+  """
+  pid = os.fork()
+  if pid == 0:
+    # Child process
+    try:
+      # Call function
+      result = int(bool(fn()))
+      assert result in (0, 1)
+    except:
+      logging.exception("Error while calling function in separate process")
+      # 0 and 1 are reserved for the return value
+      result = 33
+
+    os._exit(result)
+
+  # Parent process
+
+  # Avoid zombies and check exit code
+  (_, status) = os.waitpid(pid, 0)
+
+  if os.WIFSIGNALED(status):
+    signum = os.WTERMSIG(status)
+    exitcode = None
+  else:
+    signum = None
+    exitcode = os.WEXITSTATUS(status)
+
+  if not (exitcode in (0, 1) and signum is None):
+    logging.error("Child program failed (code=%s, signal=%s)",
+                  exitcode, signum)
+    sys.exit(constants.EXIT_FAILURE)
+
+  return bool(exitcode)
+
+
+def CheckMasterd(options, args):
+  """Initial checks whether to run or exit with a failure.
+
+  """
   ssconf.CheckMaster(options.debug)
 
-  # we believe we are the master, let's ask the other nodes...
-  if not CheckAgreement():
-    return
+  # If CheckMaster didn't fail we believe we are the master, but we have to
+  # confirm with the other nodes.
+  if options.no_voting:
+    if options.yes_do_it:
+      return
 
-  master = IOServer(constants.MASTER_SOCKET, ClientRqHandler)
+    sys.stdout.write("The 'no voting' option has been selected.\n")
+    sys.stdout.write("This is dangerous, please confirm by"
+                     " typing uppercase 'yes': ")
+    sys.stdout.flush()
 
-  # become a daemon
-  if options.fork:
-    utils.Daemonize(logfile=constants.LOG_MASTERDAEMON,
-                    noclose_fds=[master.fileno()])
+    confirmation = sys.stdin.readline().strip()
+    if confirmation != "YES":
+      print >>sys.stderr, "Aborting."
+      sys.exit(constants.EXIT_FAILURE)
 
-  utils.WritePidFile(constants.MASTERD_PID)
+    return
 
-  logger.SetupLogging(constants.LOG_MASTERDAEMON, debug=options.debug,
-                      stderr_logging=not options.fork)
+  # CheckAgreement uses RPC and threads, hence it needs to be run in a separate
+  # process before we call utils.Daemonize in the current process.
+  if not _RunInSeparateProcess(CheckAgreementWithRpc):
+    sys.exit(constants.EXIT_FAILURE)
 
-  logging.info("ganeti master daemon startup")
 
-  # activate ip
-  master_node = ssconf.SimpleConfigReader().GetMasterNode()
-  if not rpc.call_node_start_master(master_node, False):
-    logging.error("Can't activate master IP address")
+def ExecMasterd (options, args):
+  """Main master daemon function, executed with the PID file held.
 
-  master.setup_queue()
+  """
+  # This is safe to do as the pid file guarantees against
+  # concurrent execution.
+  utils.RemoveFile(constants.MASTER_SOCKET)
+
+  master = IOServer(constants.MASTER_SOCKET, ClientRqHandler)
   try:
-    master.serve_forever()
+    rpc.Init()
+    try:
+      # activate ip
+      master_node = ssconf.SimpleStore().GetMasterNode()
+      result = rpc.RpcRunner.call_node_start_master(master_node, False, False)
+      msg = result.fail_msg
+      if msg:
+        logging.error("Can't activate master IP address: %s", msg)
+
+      master.setup_queue()
+      try:
+        master.serve_forever()
+      finally:
+        master.server_cleanup()
+    finally:
+      rpc.Shutdown()
   finally:
-    master.server_cleanup()
-    utils.RemovePidFile(constants.MASTERD_PID)
+    utils.RemoveFile(constants.MASTER_SOCKET)
+
+
+def main():
+  """Main function"""
+  parser = OptionParser(description="Ganeti master daemon",
+                        usage="%prog [-f] [-d]",
+                        version="%%prog (ganeti) %s" %
+                        constants.RELEASE_VERSION)
+  parser.add_option("--no-voting", dest="no_voting",
+                    help="Do not check that the nodes agree on this node"
+                    " being the master and start the daemon unconditionally",
+                    default=False, action="store_true")
+  parser.add_option("--yes-do-it", dest="yes_do_it",
+                    help="Override interactive check for --no-voting",
+                    default=False, action="store_true")
+  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE),
+          (constants.SOCKET_DIR, constants.SOCKET_DIR_MODE),
+         ]
+  daemon.GenericMain(constants.MASTERD, parser, dirs,
+                     CheckMasterd, ExecMasterd)
 
 
 if __name__ == "__main__":