code.grnet.gr Git - ganeti-local/blob - lib/ssconf.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21
  22 """Global Configuration data for Ganeti.
  23
  24 This module provides the interface to a special case of cluster
  25 configuration data, which is mostly static and available to all nodes.
  26
  27 """
  28
  29 import sys
  30 import re
  31
  32 from ganeti import errors
  33 from ganeti import constants
  34 from ganeti import utils
  35 from ganeti import serializer
  36
  37
  38 SSCONF_LOCK_TIMEOUT = 10
  39
  40 RE_VALID_SSCONF_NAME = re.compile(r'^[-_a-z0-9]+$')
  41
  42
  43 class SimpleConfigReader(object):
  44   """Simple class to read configuration file.
  45
  46   """
  47   def __init__(self, file_name=constants.CLUSTER_CONF_FILE):
  48     """Initializes this class.
  49
  50     @type file_name: string
  51     @param file_name: Configuration file path
  52
  53     """
  54     self._file_name = file_name
  55     self._config_data = serializer.Load(utils.ReadFile(file_name))
  56     # TODO: Error handling
  57
  58   def GetClusterName(self):
  59     return self._config_data["cluster"]["cluster_name"]
  60
  61   def GetHostKey(self):
  62     return self._config_data["cluster"]["rsahostkeypub"]
  63
  64   def GetMasterNode(self):
  65     return self._config_data["cluster"]["master_node"]
  66
  67   def GetMasterIP(self):
  68     return self._config_data["cluster"]["master_ip"]
  69
  70   def GetMasterNetdev(self):
  71     return self._config_data["cluster"]["master_netdev"]
  72
  73   def GetFileStorageDir(self):
  74     return self._config_data["cluster"]["file_storage_dir"]
  75
  76   def GetHypervisorType(self):
  77     return self._config_data["cluster"]["hypervisor"]
  78
  79   def GetNodeList(self):
  80     return self._config_data["nodes"].keys()
  81
  82   @classmethod
  83   def FromDict(cls, val, cfg_file=constants.CLUSTER_CONF_FILE):
  84     """Alternative construction from a dictionary.
  85
  86     """
  87     obj = SimpleConfigReader.__new__(cls)
  88     obj._config_data = val
  89     obj._file_name = cfg_file
  90     return obj
  91
  92
  93 class SimpleConfigWriter(SimpleConfigReader):
  94   """Simple class to write configuration file.
  95
  96   """
  97   def SetMasterNode(self, node):
  98     """Change master node.
  99
 100     """
 101     self._config_data["cluster"]["master_node"] = node
 102
 103   def Save(self):
 104     """Writes configuration file.
 105
 106     Warning: Doesn't take care of locking or synchronizing with other
 107     processes.
 108
 109     """
 110     utils.WriteFile(self._file_name,
 111                     data=serializer.Dump(self._config_data),
 112                     mode=0600)
 113
 114
 115 class SimpleStore(object):
 116   """Interface to static cluster data.
 117
 118   This is different that the config.ConfigWriter and
 119   SimpleConfigReader classes in that it holds data that will always be
 120   present, even on nodes which don't have all the cluster data.
 121
 122   Other particularities of the datastore:
 123     - keys are restricted to predefined values
 124
 125   """
 126   _SS_FILEPREFIX = "ssconf_"
 127   _VALID_KEYS = (
 128     constants.SS_CLUSTER_NAME,
 129     constants.SS_FILE_STORAGE_DIR,
 130     constants.SS_MASTER_CANDIDATES,
 131     constants.SS_MASTER_IP,
 132     constants.SS_MASTER_NETDEV,
 133     constants.SS_MASTER_NODE,
 134     constants.SS_NODE_LIST,
 135     constants.SS_OFFLINE_NODES,
 136     )
 137   _MAX_SIZE = 131072
 138
 139   def __init__(self, cfg_location=None):
 140     if cfg_location is None:
 141       self._cfg_dir = constants.DATA_DIR
 142     else:
 143       self._cfg_dir = cfg_location
 144
 145   def KeyToFilename(self, key):
 146     """Convert a given key into filename.
 147
 148     """
 149     if key not in self._VALID_KEYS:
 150       raise errors.ProgrammerError("Invalid key requested from SSConf: '%s'"
 151                                    % str(key))
 152
 153     filename = self._cfg_dir + '/' + self._SS_FILEPREFIX + key
 154     return filename
 155
 156   def _ReadFile(self, key):
 157     """Generic routine to read keys.
 158
 159     This will read the file which holds the value requested. Errors
 160     will be changed into ConfigurationErrors.
 161
 162     """
 163     filename = self.KeyToFilename(key)
 164     try:
 165       fh = file(filename, 'r')
 166       try:
 167         data = fh.read(self._MAX_SIZE)
 168         data = data.rstrip('\n')
 169       finally:
 170         fh.close()
 171     except EnvironmentError, err:
 172       raise errors.ConfigurationError("Can't read from the ssconf file:"
 173                                       " '%s'" % str(err))
 174     return data
 175
 176   def WriteFiles(self, values):
 177     """Writes ssconf files used by external scripts.
 178
 179     @type values: dict
 180     @param values: Dictionary of (name, value)
 181
 182     """
 183     ssconf_lock = utils.FileLock(constants.SSCONF_LOCK_FILE)
 184
 185     # Get lock while writing files
 186     ssconf_lock.Exclusive(blocking=True, timeout=SSCONF_LOCK_TIMEOUT)
 187     try:
 188       for name, value in values.iteritems():
 189         if value and not value.endswith("\n"):
 190           value += "\n"
 191         utils.WriteFile(self.KeyToFilename(name), data=value)
 192     finally:
 193       ssconf_lock.Unlock()
 194
 195   def GetFileList(self):
 196     """Return the list of all config files.
 197
 198     This is used for computing node replication data.
 199
 200     """
 201     return [self.KeyToFilename(key) for key in self._VALID_KEYS]
 202
 203   def GetClusterName(self):
 204     """Get the cluster name.
 205
 206     """
 207     return self._ReadFile(constants.SS_CLUSTER_NAME)
 208
 209   def GetFileStorageDir(self):
 210     """Get the file storage dir.
 211
 212     """
 213     return self._ReadFile(constants.SS_FILE_STORAGE_DIR)
 214
 215   def GetMasterCandidates(self):
 216     """Return the list of master candidates.
 217
 218     """
 219     data = self._ReadFile(constants.SS_MASTER_CANDIDATES)
 220     nl = data.splitlines(False)
 221     return nl
 222
 223   def GetMasterIP(self):
 224     """Get the IP of the master node for this cluster.
 225
 226     """
 227     return self._ReadFile(constants.SS_MASTER_IP)
 228
 229   def GetMasterNetdev(self):
 230     """Get the netdev to which we'll add the master ip.
 231
 232     """
 233     return self._ReadFile(constants.SS_MASTER_NETDEV)
 234
 235   def GetMasterNode(self):
 236     """Get the hostname of the master node for this cluster.
 237
 238     """
 239     return self._ReadFile(constants.SS_MASTER_NODE)
 240
 241   def GetNodeList(self):
 242     """Return the list of cluster nodes.
 243
 244     """
 245     data = self._ReadFile(constants.SS_NODE_LIST)
 246     nl = data.splitlines(False)
 247     return nl
 248
 249
 250 def GetMasterAndMyself(ss=None):
 251   """Get the master node and my own hostname.
 252
 253   This can be either used for a 'soft' check (compared to CheckMaster,
 254   which exits) or just for computing both at the same time.
 255
 256   The function does not handle any errors, these should be handled in
 257   the caller (errors.ConfigurationError, errors.ResolverError).
 258
 259   @param ss: either a sstore.SimpleConfigReader or a
 260       sstore.SimpleStore instance
 261   @rtype: tuple
 262   @return: a tuple (master node name, my own name)
 263
 264   """
 265   if ss is None:
 266     ss = SimpleStore()
 267   return ss.GetMasterNode(), utils.HostInfo().name
 268
 269
 270 def CheckMaster(debug, ss=None):
 271   """Checks the node setup.
 272
 273   If this is the master, the function will return. Otherwise it will
 274   exit with an exit code based on the node status.
 275
 276   """
 277   try:
 278     master_name, myself = GetMasterAndMyself(ss)
 279   except errors.ConfigurationError, err:
 280     print "Cluster configuration incomplete: '%s'" % str(err)
 281     sys.exit(constants.EXIT_NODESETUP_ERROR)
 282   except errors.ResolverError, err:
 283     sys.stderr.write("Cannot resolve my own name (%s)\n" % err.args[0])
 284     sys.exit(constants.EXIT_NODESETUP_ERROR)
 285
 286   if myself != master_name:
 287     if debug:
 288       sys.stderr.write("Not master, exiting.\n")
 289     sys.exit(constants.EXIT_NOTMASTER)