Remove SimpleConfigWriter.SetMasterNode
[ganeti-local] / lib / ssconf.py
index a18a556..78ae9b0 100644 (file)
@@ -1,7 +1,7 @@
 #
 #
 
-# Copyright (C) 2006, 2007 Google Inc.
+# Copyright (C) 2006, 2007, 2008 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
@@ -26,44 +26,113 @@ configuration data, which is mostly static and available to all nodes.
 
 """
 
-import socket
 import sys
+import re
 
 from ganeti import errors
 from ganeti import constants
 from ganeti import utils
+from ganeti import serializer
 
 
-class SimpleStore:
+SSCONF_LOCK_TIMEOUT = 10
+
+RE_VALID_SSCONF_NAME = re.compile(r'^[-_a-z0-9]+$')
+
+
+class SimpleConfigReader(object):
+  """Simple class to read configuration file.
+
+  """
+  def __init__(self, file_name=constants.CLUSTER_CONF_FILE):
+    """Initializes this class.
+
+    @type file_name: string
+    @param file_name: Configuration file path
+
+    """
+    self._file_name = file_name
+    self._config_data = serializer.Load(utils.ReadFile(file_name))
+    # TODO: Error handling
+
+  def GetClusterName(self):
+    return self._config_data["cluster"]["cluster_name"]
+
+  def GetHostKey(self):
+    return self._config_data["cluster"]["rsahostkeypub"]
+
+  def GetMasterNode(self):
+    return self._config_data["cluster"]["master_node"]
+
+  def GetMasterIP(self):
+    return self._config_data["cluster"]["master_ip"]
+
+  def GetMasterNetdev(self):
+    return self._config_data["cluster"]["master_netdev"]
+
+  def GetFileStorageDir(self):
+    return self._config_data["cluster"]["file_storage_dir"]
+
+  def GetHypervisorType(self):
+    return self._config_data["cluster"]["hypervisor"]
+
+  def GetNodeList(self):
+    return self._config_data["nodes"].keys()
+
+  @classmethod
+  def FromDict(cls, val, cfg_file=constants.CLUSTER_CONF_FILE):
+    """Alternative construction from a dictionary.
+
+    """
+    obj = SimpleConfigReader.__new__(cls)
+    obj._config_data = val
+    obj._file_name = cfg_file
+    return obj
+
+
+class SimpleConfigWriter(SimpleConfigReader):
+  """Simple class to write configuration file.
+
+  """
+  def Save(self):
+    """Writes configuration file.
+
+    Warning: Doesn't take care of locking or synchronizing with other
+    processes.
+
+    """
+    utils.WriteFile(self._file_name,
+                    data=serializer.Dump(self._config_data),
+                    mode=0600)
+
+
+class SimpleStore(object):
   """Interface to static cluster data.
 
-  This is different that the config.ConfigWriter class in that it
-  holds data that is (mostly) constant after the cluster
-  initialization. Its purpose is to allow limited customization of
-  things which would otherwise normally live in constants.py. Note
-  that this data cannot live in ConfigWriter as that is available only
-  on the master node, and our data must be readable by both the master
-  and the nodes.
+  This is different that the config.ConfigWriter and
+  SimpleConfigReader classes in that it holds data that will always be
+  present, even on nodes which don't have all the cluster data.
 
   Other particularities of the datastore:
     - keys are restricted to predefined values
-    - values are small (<4k)
-    - some keys are handled specially (read from the system)
 
   """
   _SS_FILEPREFIX = "ssconf_"
-  SS_HYPERVISOR = "hypervisor"
-  SS_NODED_PASS = "node_pass"
-  SS_MASTER_NODE = "master_node"
-  SS_MASTER_IP = "master_ip"
-  SS_MASTER_NETDEV = "master_netdev"
-  SS_CLUSTER_NAME = "cluster_name"
-  SS_FILE_STORAGE_DIR = "file_storage_dir"
-  SS_CONFIG_VERSION = "config_version"
-  _VALID_KEYS = (SS_HYPERVISOR, SS_NODED_PASS, SS_MASTER_NODE, SS_MASTER_IP,
-                 SS_MASTER_NETDEV, SS_CLUSTER_NAME, SS_FILE_STORAGE_DIR,
-                 SS_CONFIG_VERSION)
-  _MAX_SIZE = 4096
+  _VALID_KEYS = (
+    constants.SS_CLUSTER_NAME,
+    constants.SS_CLUSTER_TAGS,
+    constants.SS_FILE_STORAGE_DIR,
+    constants.SS_MASTER_CANDIDATES,
+    constants.SS_MASTER_IP,
+    constants.SS_MASTER_NETDEV,
+    constants.SS_MASTER_NODE,
+    constants.SS_NODE_LIST,
+    constants.SS_OFFLINE_NODES,
+    constants.SS_ONLINE_NODES,
+    constants.SS_INSTANCE_LIST,
+    constants.SS_RELEASE_VERSION,
+    )
+  _MAX_SIZE = 131072
 
   def __init__(self, cfg_location=None):
     if cfg_location is None:
@@ -93,7 +162,7 @@ class SimpleStore:
     try:
       fh = file(filename, 'r')
       try:
-        data = fh.readline(self._MAX_SIZE)
+        data = fh.read(self._MAX_SIZE)
         data = data.rstrip('\n')
       finally:
         fh.close()
@@ -102,106 +171,109 @@ class SimpleStore:
                                       " '%s'" % str(err))
     return data
 
-  def GetNodeDaemonPort(self):
-    """Get the node daemon port for this cluster.
+  def WriteFiles(self, values):
+    """Writes ssconf files used by external scripts.
 
-    Note that this routine does not read a ganeti-specific file, but
-    instead uses socket.getservbyname to allow pre-customization of
-    this parameter outside of ganeti.
+    @type values: dict
+    @param values: Dictionary of (name, value)
 
     """
+    ssconf_lock = utils.FileLock(constants.SSCONF_LOCK_FILE)
+
+    # Get lock while writing files
+    ssconf_lock.Exclusive(blocking=True, timeout=SSCONF_LOCK_TIMEOUT)
     try:
-      port = socket.getservbyname("ganeti-noded", "tcp")
-    except socket.error:
-      port = constants.DEFAULT_NODED_PORT
+      for name, value in values.iteritems():
+        if value and not value.endswith("\n"):
+          value += "\n"
+        utils.WriteFile(self.KeyToFilename(name), data=value, mode=0444)
+    finally:
+      ssconf_lock.Unlock()
 
-    return port
+  def GetFileList(self):
+    """Return the list of all config files.
 
-  def GetHypervisorType(self):
-    """Get the hypervisor type for this cluster.
+    This is used for computing node replication data.
 
     """
-    return self._ReadFile(self.SS_HYPERVISOR)
+    return [self.KeyToFilename(key) for key in self._VALID_KEYS]
 
-  def GetNodeDaemonPassword(self):
-    """Get the node password for this cluster.
+  def GetClusterName(self):
+    """Get the cluster name.
 
     """
-    return self._ReadFile(self.SS_NODED_PASS)
+    return self._ReadFile(constants.SS_CLUSTER_NAME)
 
-  def GetMasterNode(self):
-    """Get the hostname of the master node for this cluster.
+  def GetFileStorageDir(self):
+    """Get the file storage dir.
+
+    """
+    return self._ReadFile(constants.SS_FILE_STORAGE_DIR)
+
+  def GetMasterCandidates(self):
+    """Return the list of master candidates.
 
     """
-    return self._ReadFile(self.SS_MASTER_NODE)
+    data = self._ReadFile(constants.SS_MASTER_CANDIDATES)
+    nl = data.splitlines(False)
+    return nl
 
   def GetMasterIP(self):
     """Get the IP of the master node for this cluster.
 
     """
-    return self._ReadFile(self.SS_MASTER_IP)
+    return self._ReadFile(constants.SS_MASTER_IP)
 
   def GetMasterNetdev(self):
     """Get the netdev to which we'll add the master ip.
 
     """
-    return self._ReadFile(self.SS_MASTER_NETDEV)
+    return self._ReadFile(constants.SS_MASTER_NETDEV)
 
-  def GetClusterName(self):
-    """Get the cluster name.
+  def GetMasterNode(self):
+    """Get the hostname of the master node for this cluster.
 
     """
-    return self._ReadFile(self.SS_CLUSTER_NAME)
+    return self._ReadFile(constants.SS_MASTER_NODE)
 
-  def GetFileStorageDir(self):
-    """Get the file storage dir.
+  def GetNodeList(self):
+    """Return the list of cluster nodes.
 
     """
-    return self._ReadFile(self.SS_FILE_STORAGE_DIR)
+    data = self._ReadFile(constants.SS_NODE_LIST)
+    nl = data.splitlines(False)
+    return nl
 
-  def GetConfigVersion(self):
-    """Get the configuration version.
+  def GetClusterTags(self):
+    """Return the cluster tags.
 
     """
-    value = self._ReadFile(self.SS_CONFIG_VERSION)
-    try:
-      return int(value)
-    except (ValueError, TypeError), err:
-      raise errors.ConfigurationError("Failed to convert config version %s to"
-                                      " int: '%s'" % (value, str(err)))
+    data = self._ReadFile(constants.SS_CLUSTER_TAGS)
+    nl = data.splitlines(False)
+    return nl
 
-  def GetFileList(self):
-    """Return the list of all config files.
 
-    This is used for computing node replication data.
-
-    """
-    return [self.KeyToFilename(key) for key in self._VALID_KEYS]
+def GetMasterAndMyself(ss=None):
+  """Get the master node and my own hostname.
 
+  This can be either used for a 'soft' check (compared to CheckMaster,
+  which exits) or just for computing both at the same time.
 
-class WritableSimpleStore(SimpleStore):
-  """This is a read/write interface to SimpleStore, which is used rarely, when
-  values need to be changed. Since WriteFile handles updates in an atomic way
-  it should be fine to use two WritableSimpleStore at the same time, but in
-  the future we might want to put additional protection for this class.
+  The function does not handle any errors, these should be handled in
+  the caller (errors.ConfigurationError, errors.ResolverError).
 
-  A WritableSimpleStore cannot be used to update system-dependent values.
+  @param ss: either a sstore.SimpleConfigReader or a
+      sstore.SimpleStore instance
+  @rtype: tuple
+  @return: a tuple (master node name, my own name)
 
   """
-
-  def SetKey(self, key, value):
-    """Set the value of a key.
-
-    This should be used only when adding a node to a cluster, or in other
-    infrequent operations such as cluster-rename or master-failover.
-
-    """
-    file_name = self.KeyToFilename(key)
-    utils.WriteFile(file_name, data="%s\n" % str(value),
-                    uid=0, gid=0, mode=0400)
+  if ss is None:
+    ss = SimpleStore()
+  return ss.GetMasterNode(), utils.HostInfo().name
 
 
-def CheckMaster(debug):
+def CheckMaster(debug, ss=None):
   """Checks the node setup.
 
   If this is the master, the function will return. Otherwise it will
@@ -209,19 +281,15 @@ def CheckMaster(debug):
 
   """
   try:
-    ss = SimpleStore()
-    master_name = ss.GetMasterNode()
+    master_name, myself = GetMasterAndMyself(ss)
   except errors.ConfigurationError, err:
     print "Cluster configuration incomplete: '%s'" % str(err)
     sys.exit(constants.EXIT_NODESETUP_ERROR)
-
-  try:
-    myself = utils.HostInfo()
   except errors.ResolverError, err:
     sys.stderr.write("Cannot resolve my own name (%s)\n" % err.args[0])
     sys.exit(constants.EXIT_NODESETUP_ERROR)
 
-  if myself.name != master_name:
+  if myself != master_name:
     if debug:
       sys.stderr.write("Not master, exiting.\n")
     sys.exit(constants.EXIT_NOTMASTER)