4 # Copyright (C) 2006, 2007, 2008, 2010 Google Inc.
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.
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.
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
22 """Global Configuration data for Ganeti.
24 This module provides the interface to a special case of cluster
25 configuration data, which is mostly static and available to all nodes.
34 from ganeti import errors
35 from ganeti import constants
36 from ganeti import utils
37 from ganeti import serializer
38 from ganeti import objects
39 from ganeti import netutils
42 SSCONF_LOCK_TIMEOUT = 10
44 RE_VALID_SSCONF_NAME = re.compile(r"^[-_a-z0-9]+$")
47 class SimpleConfigReader(object):
48 """Simple class to read configuration file.
51 def __init__(self, file_name=constants.CLUSTER_CONF_FILE):
52 """Initializes this class.
54 @type file_name: string
55 @param file_name: Configuration file path
58 self._file_name = file_name
59 self._last_inode = None
60 self._last_mtime = None
61 self._last_size = None
63 self._config_data = None
64 self._inst_ips_by_link = None
65 self._ip_to_inst_by_link = None
66 self._instances_ips = None
67 self._mc_primary_ips = None
68 self._nodes_primary_ips = None
70 # we need a forced reload at class init time, to initialize _last_*
71 self._Load(force=True)
73 def _Load(self, force=False):
74 """Loads (or reloads) the config file.
77 @param force: whether to force the reload without checking the mtime
79 @return: boolean value that says whether we reloaded the configuration or
80 not (because we decided it was already up-to-date)
84 cfg_stat = os.stat(self._file_name)
85 except EnvironmentError, err:
86 raise errors.ConfigurationError("Cannot stat config file %s: %s" %
87 (self._file_name, err))
88 inode = cfg_stat.st_ino
89 mtime = cfg_stat.st_mtime
90 size = cfg_stat.st_size
92 if (force or inode != self._last_inode or
93 mtime > self._last_mtime or
94 size != self._last_size):
95 self._last_inode = inode
96 self._last_mtime = mtime
97 self._last_size = size
103 self._config_data = serializer.Load(utils.ReadFile(self._file_name))
104 except EnvironmentError, err:
105 raise errors.ConfigurationError("Cannot read config file %s: %s" %
106 (self._file_name, err))
107 except ValueError, err:
108 raise errors.ConfigurationError("Cannot load config file %s: %s" %
109 (self._file_name, err))
111 self._ip_to_inst_by_link = {}
112 self._instances_ips = []
113 self._inst_ips_by_link = {}
114 c_nparams = self._config_data["cluster"]["nicparams"][constants.PP_DEFAULT]
115 for iname in self._config_data["instances"]:
116 instance = self._config_data["instances"][iname]
117 for nic in instance["nics"]:
118 if "ip" in nic and nic["ip"]:
119 params = objects.FillDict(c_nparams, nic["nicparams"])
120 if not params["link"] in self._inst_ips_by_link:
121 self._inst_ips_by_link[params["link"]] = []
122 self._ip_to_inst_by_link[params["link"]] = {}
123 self._ip_to_inst_by_link[params["link"]][nic["ip"]] = iname
124 self._inst_ips_by_link[params["link"]].append(nic["ip"])
126 self._nodes_primary_ips = []
127 self._mc_primary_ips = []
128 for node_name in self._config_data["nodes"]:
129 node = self._config_data["nodes"][node_name]
130 self._nodes_primary_ips.append(node["primary_ip"])
131 if node["master_candidate"]:
132 self._mc_primary_ips.append(node["primary_ip"])
136 # Clients can request a reload of the config file, so we export our internal
137 # _Load function as Reload.
140 def GetClusterName(self):
141 return self._config_data["cluster"]["cluster_name"]
143 def GetHostKey(self):
144 return self._config_data["cluster"]["rsahostkeypub"]
146 def GetMasterNode(self):
147 return self._config_data["cluster"]["master_node"]
149 def GetMasterIP(self):
150 return self._config_data["cluster"]["master_ip"]
152 def GetMasterNetdev(self):
153 return self._config_data["cluster"]["master_netdev"]
155 def GetFileStorageDir(self):
156 return self._config_data["cluster"]["file_storage_dir"]
158 def GetSharedFileStorageDir(self):
159 return self._config_data["cluster"]["shared_file_storage_dir"]
161 def GetNodeList(self):
162 return self._config_data["nodes"].keys()
164 def GetConfigSerialNo(self):
165 return self._config_data["serial_no"]
167 def GetClusterSerialNo(self):
168 return self._config_data["cluster"]["serial_no"]
170 def GetDefaultNicParams(self):
171 return self._config_data["cluster"]["nicparams"][constants.PP_DEFAULT]
173 def GetDefaultNicLink(self):
174 return self.GetDefaultNicParams()[constants.NIC_LINK]
176 def GetNodeStatusFlags(self, node):
177 """Get a node's status flags
180 @param node: node name
181 @rtype: (bool, bool, bool)
182 @return: (master_candidate, drained, offline) (or None if no such node)
185 if node not in self._config_data["nodes"]:
188 master_candidate = self._config_data["nodes"][node]["master_candidate"]
189 drained = self._config_data["nodes"][node]["drained"]
190 offline = self._config_data["nodes"][node]["offline"]
191 return master_candidate, drained, offline
193 def GetInstanceByLinkIp(self, ip, link):
194 """Get instance name from its link and ip address.
197 @param ip: ip address
199 @param link: nic link
201 @return: instance name
205 link = self.GetDefaultNicLink()
206 if not link in self._ip_to_inst_by_link:
208 if not ip in self._ip_to_inst_by_link[link]:
210 return self._ip_to_inst_by_link[link][ip]
212 def GetNodePrimaryIp(self, node):
213 """Get a node's primary ip
216 @param node: node name
217 @rtype: string, or None
218 @return: node's primary ip, or None if no such node
221 if node not in self._config_data["nodes"]:
223 return self._config_data["nodes"][node]["primary_ip"]
225 def GetInstancePrimaryNode(self, instance):
226 """Get an instance's primary node
228 @type instance: string
229 @param instance: instance name
230 @rtype: string, or None
231 @return: primary node, or None if no such instance
234 if instance not in self._config_data["instances"]:
236 return self._config_data["instances"][instance]["primary_node"]
238 def GetNodesPrimaryIps(self):
239 return self._nodes_primary_ips
241 def GetMasterCandidatesPrimaryIps(self):
242 return self._mc_primary_ips
244 def GetInstancesIps(self, link):
245 """Get list of nic ips connected to a certain link.
248 @param link: nic link
250 @return: list of ips connected to that link
254 link = self.GetDefaultNicLink()
256 if link in self._inst_ips_by_link:
257 return self._inst_ips_by_link[link]
262 class SimpleStore(object):
263 """Interface to static cluster data.
265 This is different that the config.ConfigWriter and
266 SimpleConfigReader classes in that it holds data that will always be
267 present, even on nodes which don't have all the cluster data.
269 Other particularities of the datastore:
270 - keys are restricted to predefined values
273 _SS_FILEPREFIX = "ssconf_"
275 constants.SS_CLUSTER_NAME,
276 constants.SS_CLUSTER_TAGS,
277 constants.SS_FILE_STORAGE_DIR,
278 constants.SS_SHARED_FILE_STORAGE_DIR,
279 constants.SS_MASTER_CANDIDATES,
280 constants.SS_MASTER_CANDIDATES_IPS,
281 constants.SS_MASTER_IP,
282 constants.SS_MASTER_NETDEV,
283 constants.SS_MASTER_NODE,
284 constants.SS_NODE_LIST,
285 constants.SS_NODE_PRIMARY_IPS,
286 constants.SS_NODE_SECONDARY_IPS,
287 constants.SS_OFFLINE_NODES,
288 constants.SS_ONLINE_NODES,
289 constants.SS_PRIMARY_IP_FAMILY,
290 constants.SS_INSTANCE_LIST,
291 constants.SS_RELEASE_VERSION,
292 constants.SS_HYPERVISOR_LIST,
293 constants.SS_MAINTAIN_NODE_HEALTH,
294 constants.SS_UID_POOL,
295 constants.SS_NODEGROUPS,
299 def __init__(self, cfg_location=None):
300 if cfg_location is None:
301 self._cfg_dir = constants.DATA_DIR
303 self._cfg_dir = cfg_location
305 def KeyToFilename(self, key):
306 """Convert a given key into filename.
309 if key not in self._VALID_KEYS:
310 raise errors.ProgrammerError("Invalid key requested from SSConf: '%s'"
313 filename = self._cfg_dir + "/" + self._SS_FILEPREFIX + key
316 def _ReadFile(self, key, default=None):
317 """Generic routine to read keys.
319 This will read the file which holds the value requested. Errors
320 will be changed into ConfigurationErrors.
323 filename = self.KeyToFilename(key)
325 data = utils.ReadFile(filename, size=self._MAX_SIZE)
326 except EnvironmentError, err:
327 if err.errno == errno.ENOENT and default is not None:
329 raise errors.ConfigurationError("Can't read from the ssconf file:"
331 data = data.rstrip("\n")
334 def WriteFiles(self, values):
335 """Writes ssconf files used by external scripts.
338 @param values: Dictionary of (name, value)
341 ssconf_lock = utils.FileLock.Open(constants.SSCONF_LOCK_FILE)
343 # Get lock while writing files
344 ssconf_lock.Exclusive(blocking=True, timeout=SSCONF_LOCK_TIMEOUT)
346 for name, value in values.iteritems():
347 if value and not value.endswith("\n"):
349 if len(value) > self._MAX_SIZE:
350 raise errors.ConfigurationError("ssconf file %s above maximum size" %
352 utils.WriteFile(self.KeyToFilename(name), data=value, mode=0444)
356 def GetFileList(self):
357 """Return the list of all config files.
359 This is used for computing node replication data.
362 return [self.KeyToFilename(key) for key in self._VALID_KEYS]
364 def GetClusterName(self):
365 """Get the cluster name.
368 return self._ReadFile(constants.SS_CLUSTER_NAME)
370 def GetFileStorageDir(self):
371 """Get the file storage dir.
374 return self._ReadFile(constants.SS_FILE_STORAGE_DIR)
376 def GetSharedFileStorageDir(self):
377 """Get the shared file storage dir.
380 return self._ReadFile(constants.SS_SHARED_FILE_STORAGE_DIR)
382 def GetMasterCandidates(self):
383 """Return the list of master candidates.
386 data = self._ReadFile(constants.SS_MASTER_CANDIDATES)
387 nl = data.splitlines(False)
390 def GetMasterCandidatesIPList(self):
391 """Return the list of master candidates' primary IP.
394 data = self._ReadFile(constants.SS_MASTER_CANDIDATES_IPS)
395 nl = data.splitlines(False)
398 def GetMasterIP(self):
399 """Get the IP of the master node for this cluster.
402 return self._ReadFile(constants.SS_MASTER_IP)
404 def GetMasterNetdev(self):
405 """Get the netdev to which we'll add the master ip.
408 return self._ReadFile(constants.SS_MASTER_NETDEV)
410 def GetMasterNode(self):
411 """Get the hostname of the master node for this cluster.
414 return self._ReadFile(constants.SS_MASTER_NODE)
416 def GetNodeList(self):
417 """Return the list of cluster nodes.
420 data = self._ReadFile(constants.SS_NODE_LIST)
421 nl = data.splitlines(False)
424 def GetNodePrimaryIPList(self):
425 """Return the list of cluster nodes' primary IP.
428 data = self._ReadFile(constants.SS_NODE_PRIMARY_IPS)
429 nl = data.splitlines(False)
432 def GetNodeSecondaryIPList(self):
433 """Return the list of cluster nodes' secondary IP.
436 data = self._ReadFile(constants.SS_NODE_SECONDARY_IPS)
437 nl = data.splitlines(False)
440 def GetNodegroupList(self):
441 """Return the list of nodegroups.
444 data = self._ReadFile(constants.SS_NODEGROUPS)
445 nl = data.splitlines(False)
448 def GetClusterTags(self):
449 """Return the cluster tags.
452 data = self._ReadFile(constants.SS_CLUSTER_TAGS)
453 nl = data.splitlines(False)
456 def GetHypervisorList(self):
457 """Return the list of enabled hypervisors.
460 data = self._ReadFile(constants.SS_HYPERVISOR_LIST)
461 nl = data.splitlines(False)
464 def GetMaintainNodeHealth(self):
465 """Return the value of the maintain_node_health option.
468 data = self._ReadFile(constants.SS_MAINTAIN_NODE_HEALTH)
469 # we rely on the bool serialization here
470 return data == "True"
472 def GetUidPool(self):
473 """Return the user-id pool definition string.
475 The separator character is a newline.
477 The return value can be parsed using uidpool.ParseUidPool()::
479 ss = ssconf.SimpleStore()
480 uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\\n")
483 data = self._ReadFile(constants.SS_UID_POOL)
486 def GetPrimaryIPFamily(self):
487 """Return the cluster-wide primary address family.
491 return int(self._ReadFile(constants.SS_PRIMARY_IP_FAMILY,
492 default=netutils.IP4Address.family))
493 except (ValueError, TypeError), err:
494 raise errors.ConfigurationError("Error while trying to parse primary ip"
498 def GetMasterAndMyself(ss=None):
499 """Get the master node and my own hostname.
501 This can be either used for a 'soft' check (compared to CheckMaster,
502 which exits) or just for computing both at the same time.
504 The function does not handle any errors, these should be handled in
505 the caller (errors.ConfigurationError, errors.ResolverError).
507 @param ss: either a sstore.SimpleConfigReader or a
508 sstore.SimpleStore instance
510 @return: a tuple (master node name, my own name)
515 return ss.GetMasterNode(), netutils.Hostname.GetSysName()
518 def CheckMaster(debug, ss=None):
519 """Checks the node setup.
521 If this is the master, the function will return. Otherwise it will
522 exit with an exit code based on the node status.
526 master_name, myself = GetMasterAndMyself(ss)
527 except errors.ConfigurationError, err:
528 print "Cluster configuration incomplete: '%s'" % str(err)
529 sys.exit(constants.EXIT_NODESETUP_ERROR)
530 except errors.ResolverError, err:
531 sys.stderr.write("Cannot resolve my own name (%s)\n" % err.args[0])
532 sys.exit(constants.EXIT_NODESETUP_ERROR)
534 if myself != master_name:
536 sys.stderr.write("Not master, exiting.\n")
537 sys.exit(constants.EXIT_NOTMASTER)