4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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 """Transportable objects for Ganeti.
24 This module provides small, mostly data-only objects which are safe to
25 pass to and from external parties.
29 # pylint: disable=E0203,W0201,R0902
31 # E0203: Access to member %r before its definition, since we use
32 # objects.py which doesn't explicitly initialise its members
34 # W0201: Attribute '%s' defined outside __init__
36 # R0902: Allow instances of these objects to have more than 20 attributes
43 from cStringIO import StringIO
45 from ganeti import errors
46 from ganeti import constants
47 from ganeti import netutils
48 from ganeti import outils
49 from ganeti import utils
51 from socket import AF_INET
54 __all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
55 "OS", "Node", "NodeGroup", "Cluster", "FillDict", "Network"]
57 _TIMESTAMPS = ["ctime", "mtime"]
61 def FillDict(defaults_dict, custom_dict, skip_keys=None):
62 """Basic function to apply settings on top a default dict.
64 @type defaults_dict: dict
65 @param defaults_dict: dictionary holding the default values
66 @type custom_dict: dict
67 @param custom_dict: dictionary holding customized value
69 @param skip_keys: which keys not to fill
71 @return: dict with the 'full' values
74 ret_dict = copy.deepcopy(defaults_dict)
75 ret_dict.update(custom_dict)
85 def FillIPolicy(default_ipolicy, custom_ipolicy):
86 """Fills an instance policy with defaults.
89 assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
90 ret_dict = copy.deepcopy(custom_ipolicy)
91 for key in default_ipolicy:
92 if key not in ret_dict:
93 ret_dict[key] = copy.deepcopy(default_ipolicy[key])
94 elif key == constants.ISPECS_STD:
95 ret_dict[key] = FillDict(default_ipolicy[key], ret_dict[key])
99 def FillDiskParams(default_dparams, custom_dparams, skip_keys=None):
100 """Fills the disk parameter defaults.
102 @see: L{FillDict} for parameters and return value
105 assert frozenset(default_dparams.keys()) == constants.DISK_TEMPLATES
107 return dict((dt, FillDict(default_dparams[dt], custom_dparams.get(dt, {}),
108 skip_keys=skip_keys))
109 for dt in constants.DISK_TEMPLATES)
112 def UpgradeGroupedParams(target, defaults):
113 """Update all groups for the target parameter.
115 @type target: dict of dicts
116 @param target: {group: {parameter: value}}
118 @param defaults: default parameter values
122 target = {constants.PP_DEFAULT: defaults}
125 target[group] = FillDict(defaults, target[group])
129 def UpgradeBeParams(target):
130 """Update the be parameters dict to the new format.
133 @param target: "be" parameters dict
136 if constants.BE_MEMORY in target:
137 memory = target[constants.BE_MEMORY]
138 target[constants.BE_MAXMEM] = memory
139 target[constants.BE_MINMEM] = memory
140 del target[constants.BE_MEMORY]
143 def UpgradeDiskParams(diskparams):
144 """Upgrade the disk parameters.
146 @type diskparams: dict
147 @param diskparams: disk parameters to upgrade
149 @return: the upgraded disk parameters dict
155 result = FillDiskParams(constants.DISK_DT_DEFAULTS, diskparams)
160 def UpgradeNDParams(ndparams):
161 """Upgrade ndparams structure.
164 @param ndparams: disk parameters to upgrade
166 @return: the upgraded node parameters dict
172 if (constants.ND_OOB_PROGRAM in ndparams and
173 ndparams[constants.ND_OOB_PROGRAM] is None):
174 # will be reset by the line below
175 del ndparams[constants.ND_OOB_PROGRAM]
176 return FillDict(constants.NDC_DEFAULTS, ndparams)
179 def MakeEmptyIPolicy():
180 """Create empty IPolicy dictionary.
186 class ConfigObject(outils.ValidatedSlots):
187 """A generic config object.
189 It has the following properties:
191 - provides somewhat safe recursive unpickling and pickling for its classes
192 - unset attributes which are defined in slots are always returned
193 as None instead of raising an error
195 Classes derived from this must always declare __slots__ (we use many
196 config objects and the memory reduction is useful)
201 def __getattr__(self, name):
202 if name not in self.GetAllSlots():
203 raise AttributeError("Invalid object attribute %s.%s" %
204 (type(self).__name__, name))
207 def __setstate__(self, state):
208 slots = self.GetAllSlots()
211 setattr(self, name, state[name])
214 """Validates the slots.
219 """Convert to a dict holding only standard python types.
221 The generic routine just dumps all of this object's attributes in
222 a dict. It does not work if the class has children who are
223 ConfigObjects themselves (e.g. the nics list in an Instance), in
224 which case the object should subclass the function in order to
225 make sure all objects returned are only standard python types.
229 for name in self.GetAllSlots():
230 value = getattr(self, name, None)
231 if value is not None:
235 __getstate__ = ToDict
238 def FromDict(cls, val):
239 """Create an object from a dictionary.
241 This generic routine takes a dict, instantiates a new instance of
242 the given class, and sets attributes based on the dict content.
244 As for `ToDict`, this does not work if the class has children
245 who are ConfigObjects themselves (e.g. the nics list in an
246 Instance), in which case the object should subclass the function
247 and alter the objects.
250 if not isinstance(val, dict):
251 raise errors.ConfigurationError("Invalid object passed to FromDict:"
252 " expected dict, got %s" % type(val))
253 val_str = dict([(str(k), v) for k, v in val.iteritems()])
254 obj = cls(**val_str) # pylint: disable=W0142
258 """Makes a deep copy of the current object and its children.
261 dict_form = self.ToDict()
262 clone_obj = self.__class__.FromDict(dict_form)
266 """Implement __repr__ for ConfigObjects."""
267 return repr(self.ToDict())
269 def UpgradeConfig(self):
270 """Fill defaults for missing configuration values.
272 This method will be called at configuration load time, and its
273 implementation will be object dependent.
279 class TaggableObject(ConfigObject):
280 """An generic class supporting tags.
284 VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
287 def ValidateTag(cls, tag):
288 """Check if a tag is valid.
290 If the tag is invalid, an errors.TagError will be raised. The
291 function has no return value.
294 if not isinstance(tag, basestring):
295 raise errors.TagError("Invalid tag type (not a string)")
296 if len(tag) > constants.MAX_TAG_LEN:
297 raise errors.TagError("Tag too long (>%d characters)" %
298 constants.MAX_TAG_LEN)
300 raise errors.TagError("Tags cannot be empty")
301 if not cls.VALID_TAG_RE.match(tag):
302 raise errors.TagError("Tag contains invalid characters")
305 """Return the tags list.
308 tags = getattr(self, "tags", None)
310 tags = self.tags = set()
313 def AddTag(self, tag):
317 self.ValidateTag(tag)
318 tags = self.GetTags()
319 if len(tags) >= constants.MAX_TAGS_PER_OBJ:
320 raise errors.TagError("Too many tags")
321 self.GetTags().add(tag)
323 def RemoveTag(self, tag):
327 self.ValidateTag(tag)
328 tags = self.GetTags()
332 raise errors.TagError("Tag not found")
335 """Taggable-object-specific conversion to standard python types.
337 This replaces the tags set with a list.
340 bo = super(TaggableObject, self).ToDict()
342 tags = bo.get("tags", None)
343 if isinstance(tags, set):
344 bo["tags"] = list(tags)
348 def FromDict(cls, val):
349 """Custom function for instances.
352 obj = super(TaggableObject, cls).FromDict(val)
353 if hasattr(obj, "tags") and isinstance(obj.tags, list):
354 obj.tags = set(obj.tags)
358 class MasterNetworkParameters(ConfigObject):
359 """Network configuration parameters for the master
361 @ivar name: master name
363 @ivar netmask: master netmask
364 @ivar netdev: master network device
365 @ivar ip_family: master IP family
377 class ConfigData(ConfigObject):
378 """Top-level config object."""
390 """Custom function for top-level config data.
392 This just replaces the list of instances, nodes and the cluster
393 with standard python types.
396 mydict = super(ConfigData, self).ToDict()
397 mydict["cluster"] = mydict["cluster"].ToDict()
398 for key in "nodes", "instances", "nodegroups", "networks":
399 mydict[key] = outils.ContainerToDicts(mydict[key])
404 def FromDict(cls, val):
405 """Custom function for top-level config data
408 obj = super(ConfigData, cls).FromDict(val)
409 obj.cluster = Cluster.FromDict(obj.cluster)
410 obj.nodes = outils.ContainerFromDicts(obj.nodes, dict, Node)
412 outils.ContainerFromDicts(obj.instances, dict, Instance)
414 outils.ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
415 obj.networks = outils.ContainerFromDicts(obj.networks, dict, Network)
418 def HasAnyDiskOfType(self, dev_type):
419 """Check if in there is at disk of the given type in the configuration.
421 @type dev_type: L{constants.LDS_BLOCK}
422 @param dev_type: the type to look for
424 @return: boolean indicating if a disk of the given type was found or not
427 for instance in self.instances.values():
428 for disk in instance.disks:
429 if disk.IsBasedOnDiskType(dev_type):
433 def UpgradeConfig(self):
434 """Fill defaults for missing configuration values.
437 self.cluster.UpgradeConfig()
438 for node in self.nodes.values():
440 for instance in self.instances.values():
441 instance.UpgradeConfig()
442 if self.nodegroups is None:
444 for nodegroup in self.nodegroups.values():
445 nodegroup.UpgradeConfig()
446 if self.cluster.drbd_usermode_helper is None:
447 # To decide if we set an helper let's check if at least one instance has
448 # a DRBD disk. This does not cover all the possible scenarios but it
449 # gives a good approximation.
450 if self.HasAnyDiskOfType(constants.LD_DRBD8):
451 self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
452 if self.networks is None:
454 for network in self.networks.values():
455 network.UpgradeConfig()
456 self._UpgradeEnabledDiskTemplates()
458 def _UpgradeEnabledDiskTemplates(self):
459 """Upgrade the cluster's enabled disk templates by inspecting the currently
460 enabled and/or used disk templates.
463 # enabled_disk_templates in the cluster config were introduced in 2.8.
464 # Remove this code once upgrading from earlier versions is deprecated.
465 if not self.cluster.enabled_disk_templates:
467 set([inst.disk_template for inst in self.instances.values()])
468 # Add drbd and plain, if lvm is enabled (by specifying a volume group)
469 if self.cluster.volume_group_name:
470 template_set.add(constants.DT_DRBD8)
471 template_set.add(constants.DT_PLAIN)
472 # FIXME: Adapt this when dis/enabling at configure time is removed.
473 # Enable 'file' and 'sharedfile', if they are enabled, even though they
474 # might currently not be used.
475 if constants.ENABLE_FILE_STORAGE:
476 template_set.add(constants.DT_FILE)
477 if constants.ENABLE_SHARED_FILE_STORAGE:
478 template_set.add(constants.DT_SHARED_FILE)
479 # Set enabled_disk_templates to the inferred disk templates. Order them
480 # according to a preference list that is based on Ganeti's history of
481 # supported disk templates.
482 self.cluster.enabled_disk_templates = []
483 for preferred_template in constants.DISK_TEMPLATE_PREFERENCE:
484 if preferred_template in template_set:
485 self.cluster.enabled_disk_templates.append(preferred_template)
486 template_set.remove(preferred_template)
487 self.cluster.enabled_disk_templates.extend(list(template_set))
490 class NIC(ConfigObject):
491 """Config object representing a network card."""
492 __slots__ = ["name", "mac", "ip", "network", "nicparams", "netinfo"] + _UUID
495 def CheckParameterSyntax(cls, nicparams):
496 """Check the given parameters for validity.
498 @type nicparams: dict
499 @param nicparams: dictionary with parameter names/value
500 @raise errors.ConfigurationError: when a parameter is not valid
503 mode = nicparams[constants.NIC_MODE]
504 if (mode not in constants.NIC_VALID_MODES and
505 mode != constants.VALUE_AUTO):
506 raise errors.ConfigurationError("Invalid NIC mode '%s'" % mode)
508 if (mode == constants.NIC_MODE_BRIDGED and
509 not nicparams[constants.NIC_LINK]):
510 raise errors.ConfigurationError("Missing bridged NIC link")
513 class Disk(ConfigObject):
514 """Config object representing a block device."""
515 __slots__ = ["name", "dev_type", "logical_id", "physical_id",
516 "children", "iv_name", "size", "mode", "params"] + _UUID
518 def CreateOnSecondary(self):
519 """Test if this device needs to be created on a secondary node."""
520 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
522 def AssembleOnSecondary(self):
523 """Test if this device needs to be assembled on a secondary node."""
524 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
526 def OpenOnSecondary(self):
527 """Test if this device needs to be opened on a secondary node."""
528 return self.dev_type in (constants.LD_LV,)
530 def StaticDevPath(self):
531 """Return the device path if this device type has a static one.
533 Some devices (LVM for example) live always at the same /dev/ path,
534 irrespective of their status. For such devices, we return this
535 path, for others we return None.
537 @warning: The path returned is not a normalized pathname; callers
538 should check that it is a valid path.
541 if self.dev_type == constants.LD_LV:
542 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
543 elif self.dev_type == constants.LD_BLOCKDEV:
544 return self.logical_id[1]
545 elif self.dev_type == constants.LD_RBD:
546 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
549 def ChildrenNeeded(self):
550 """Compute the needed number of children for activation.
552 This method will return either -1 (all children) or a positive
553 number denoting the minimum number of children needed for
554 activation (only mirrored devices will usually return >=0).
556 Currently, only DRBD8 supports diskless activation (therefore we
557 return 0), for all other we keep the previous semantics and return
561 if self.dev_type == constants.LD_DRBD8:
565 def IsBasedOnDiskType(self, dev_type):
566 """Check if the disk or its children are based on the given type.
568 @type dev_type: L{constants.LDS_BLOCK}
569 @param dev_type: the type to look for
571 @return: boolean indicating if a device of the given type was found or not
575 for child in self.children:
576 if child.IsBasedOnDiskType(dev_type):
578 return self.dev_type == dev_type
580 def GetNodes(self, node):
581 """This function returns the nodes this device lives on.
583 Given the node on which the parent of the device lives on (or, in
584 case of a top-level device, the primary node of the devices'
585 instance), this function will return a list of nodes on which this
586 devices needs to (or can) be assembled.
589 if self.dev_type in [constants.LD_LV, constants.LD_FILE,
590 constants.LD_BLOCKDEV, constants.LD_RBD,
593 elif self.dev_type in constants.LDS_DRBD:
594 result = [self.logical_id[0], self.logical_id[1]]
595 if node not in result:
596 raise errors.ConfigurationError("DRBD device passed unknown node")
598 raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
601 def ComputeNodeTree(self, parent_node):
602 """Compute the node/disk tree for this disk and its children.
604 This method, given the node on which the parent disk lives, will
605 return the list of all (node, disk) pairs which describe the disk
606 tree in the most compact way. For example, a drbd/lvm stack
607 will be returned as (primary_node, drbd) and (secondary_node, drbd)
608 which represents all the top-level devices on the nodes.
611 my_nodes = self.GetNodes(parent_node)
612 result = [(node, self) for node in my_nodes]
613 if not self.children:
616 for node in my_nodes:
617 for child in self.children:
618 child_result = child.ComputeNodeTree(node)
619 if len(child_result) == 1:
620 # child (and all its descendants) is simple, doesn't split
621 # over multiple hosts, so we don't need to describe it, our
622 # own entry for this node describes it completely
625 # check if child nodes differ from my nodes; note that
626 # subdisk can differ from the child itself, and be instead
627 # one of its descendants
628 for subnode, subdisk in child_result:
629 if subnode not in my_nodes:
630 result.append((subnode, subdisk))
631 # otherwise child is under our own node, so we ignore this
632 # entry (but probably the other results in the list will
636 def ComputeGrowth(self, amount):
637 """Compute the per-VG growth requirements.
639 This only works for VG-based disks.
641 @type amount: integer
642 @param amount: the desired increase in (user-visible) disk space
644 @return: a dictionary of volume-groups and the required size
647 if self.dev_type == constants.LD_LV:
648 return {self.logical_id[0]: amount}
649 elif self.dev_type == constants.LD_DRBD8:
651 return self.children[0].ComputeGrowth(amount)
655 # Other disk types do not require VG space
658 def RecordGrow(self, amount):
659 """Update the size of this disk after growth.
661 This method recurses over the disks's children and updates their
662 size correspondigly. The method needs to be kept in sync with the
663 actual algorithms from bdev.
666 if self.dev_type in (constants.LD_LV, constants.LD_FILE,
667 constants.LD_RBD, constants.LD_EXT):
669 elif self.dev_type == constants.LD_DRBD8:
671 self.children[0].RecordGrow(amount)
674 raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
675 " disk type %s" % self.dev_type)
677 def Update(self, size=None, mode=None):
678 """Apply changes to size and mode.
681 if self.dev_type == constants.LD_DRBD8:
683 self.children[0].Update(size=size, mode=mode)
685 assert not self.children
693 """Sets recursively the size to zero for the disk and its children.
697 for child in self.children:
701 def SetPhysicalID(self, target_node, nodes_ip):
702 """Convert the logical ID to the physical ID.
704 This is used only for drbd, which needs ip/port configuration.
706 The routine descends down and updates its children also, because
707 this helps when the only the top device is passed to the remote
711 - target_node: the node we wish to configure for
712 - nodes_ip: a mapping of node name to ip
714 The target_node must exist in in nodes_ip, and must be one of the
715 nodes in the logical ID for each of the DRBD devices encountered
720 for child in self.children:
721 child.SetPhysicalID(target_node, nodes_ip)
723 if self.logical_id is None and self.physical_id is not None:
725 if self.dev_type in constants.LDS_DRBD:
726 pnode, snode, port, pminor, sminor, secret = self.logical_id
727 if target_node not in (pnode, snode):
728 raise errors.ConfigurationError("DRBD device not knowing node %s" %
730 pnode_ip = nodes_ip.get(pnode, None)
731 snode_ip = nodes_ip.get(snode, None)
732 if pnode_ip is None or snode_ip is None:
733 raise errors.ConfigurationError("Can't find primary or secondary node"
734 " for %s" % str(self))
735 p_data = (pnode_ip, port)
736 s_data = (snode_ip, port)
737 if pnode == target_node:
738 self.physical_id = p_data + s_data + (pminor, secret)
739 else: # it must be secondary, we tested above
740 self.physical_id = s_data + p_data + (sminor, secret)
742 self.physical_id = self.logical_id
746 """Disk-specific conversion to standard python types.
748 This replaces the children lists of objects with lists of
749 standard python types.
752 bo = super(Disk, self).ToDict()
754 for attr in ("children",):
755 alist = bo.get(attr, None)
757 bo[attr] = outils.ContainerToDicts(alist)
761 def FromDict(cls, val):
762 """Custom function for Disks
765 obj = super(Disk, cls).FromDict(val)
767 obj.children = outils.ContainerFromDicts(obj.children, list, Disk)
768 if obj.logical_id and isinstance(obj.logical_id, list):
769 obj.logical_id = tuple(obj.logical_id)
770 if obj.physical_id and isinstance(obj.physical_id, list):
771 obj.physical_id = tuple(obj.physical_id)
772 if obj.dev_type in constants.LDS_DRBD:
773 # we need a tuple of length six here
774 if len(obj.logical_id) < 6:
775 obj.logical_id += (None,) * (6 - len(obj.logical_id))
779 """Custom str() formatter for disks.
782 if self.dev_type == constants.LD_LV:
783 val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
784 elif self.dev_type in constants.LDS_DRBD:
785 node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
787 if self.physical_id is None:
790 phy = ("configured as %s:%s %s:%s" %
791 (self.physical_id[0], self.physical_id[1],
792 self.physical_id[2], self.physical_id[3]))
794 val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
795 (node_a, minor_a, node_b, minor_b, port, phy))
796 if self.children and self.children.count(None) == 0:
797 val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
799 val += "no local storage"
801 val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
802 (self.dev_type, self.logical_id, self.physical_id, self.children))
803 if self.iv_name is None:
804 val += ", not visible"
806 val += ", visible as /dev/%s" % self.iv_name
807 if isinstance(self.size, int):
808 val += ", size=%dm)>" % self.size
810 val += ", size='%s')>" % (self.size,)
814 """Checks that this disk is correctly configured.
818 if self.mode not in constants.DISK_ACCESS_SET:
819 all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
822 def UpgradeConfig(self):
823 """Fill defaults for missing configuration values.
827 for child in self.children:
828 child.UpgradeConfig()
830 # FIXME: Make this configurable in Ganeti 2.7
832 # add here config upgrade for this disk
835 def ComputeLDParams(disk_template, disk_params):
836 """Computes Logical Disk parameters from Disk Template parameters.
838 @type disk_template: string
839 @param disk_template: disk template, one of L{constants.DISK_TEMPLATES}
840 @type disk_params: dict
841 @param disk_params: disk template parameters;
842 dict(template_name -> parameters
844 @return: a list of dicts, one for each node of the disk hierarchy. Each dict
845 contains the LD parameters of the node. The tree is flattened in-order.
848 if disk_template not in constants.DISK_TEMPLATES:
849 raise errors.ProgrammerError("Unknown disk template %s" % disk_template)
851 assert disk_template in disk_params
854 dt_params = disk_params[disk_template]
855 if disk_template == constants.DT_DRBD8:
856 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], {
857 constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE],
858 constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS],
859 constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS],
860 constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG],
861 constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM],
862 constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM],
863 constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC],
864 constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD],
865 constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET],
866 constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET],
867 constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE],
868 constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE],
872 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
873 constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
877 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
878 constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
881 elif disk_template in (constants.DT_FILE, constants.DT_SHARED_FILE):
882 result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE])
884 elif disk_template == constants.DT_PLAIN:
885 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
886 constants.LDP_STRIPES: dt_params[constants.LV_STRIPES],
889 elif disk_template == constants.DT_BLOCK:
890 result.append(constants.DISK_LD_DEFAULTS[constants.LD_BLOCKDEV])
892 elif disk_template == constants.DT_RBD:
893 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], {
894 constants.LDP_POOL: dt_params[constants.RBD_POOL],
897 elif disk_template == constants.DT_EXT:
898 result.append(constants.DISK_LD_DEFAULTS[constants.LD_EXT])
903 class InstancePolicy(ConfigObject):
904 """Config object representing instance policy limits dictionary.
906 Note that this object is not actually used in the config, it's just
907 used as a placeholder for a few functions.
911 def CheckParameterSyntax(cls, ipolicy, check_std):
912 """ Check the instance policy for validity.
915 @param ipolicy: dictionary with min/max/std specs and policies
916 @type check_std: bool
917 @param check_std: Whether to check std value or just assume compliance
918 @raise errors.ConfigurationError: when the policy is not legal
921 InstancePolicy.CheckISpecSyntax(ipolicy, check_std)
922 if constants.IPOLICY_DTS in ipolicy:
923 InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
924 for key in constants.IPOLICY_PARAMETERS:
926 InstancePolicy.CheckParameter(key, ipolicy[key])
927 wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
929 raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
930 utils.CommaJoin(wrong_keys))
933 def _CheckIncompleteSpec(cls, spec, keyname):
934 missing_params = constants.ISPECS_PARAMETERS - frozenset(spec.keys())
936 msg = ("Missing instance specs parameters for %s: %s" %
937 (keyname, utils.CommaJoin(missing_params)))
938 raise errors.ConfigurationError(msg)
941 def CheckISpecSyntax(cls, ipolicy, check_std):
942 """Check the instance policy specs for validity.
945 @param ipolicy: dictionary with min/max/std specs
946 @type check_std: bool
947 @param check_std: Whether to check std value or just assume compliance
948 @raise errors.ConfigurationError: when specs are not valid
951 if constants.ISPECS_MINMAX not in ipolicy:
955 if check_std and constants.ISPECS_STD not in ipolicy:
956 msg = "Missing key in ipolicy: %s" % constants.ISPECS_STD
957 raise errors.ConfigurationError(msg)
958 stdspec = ipolicy.get(constants.ISPECS_STD)
960 InstancePolicy._CheckIncompleteSpec(stdspec, constants.ISPECS_STD)
962 if not ipolicy[constants.ISPECS_MINMAX]:
963 raise errors.ConfigurationError("Empty minmax specifications")
965 for minmaxspecs in ipolicy[constants.ISPECS_MINMAX]:
966 missing = constants.ISPECS_MINMAX_KEYS - frozenset(minmaxspecs.keys())
968 msg = "Missing instance specification: %s" % utils.CommaJoin(missing)
969 raise errors.ConfigurationError(msg)
970 for (key, spec) in minmaxspecs.items():
971 InstancePolicy._CheckIncompleteSpec(spec, key)
974 for param in constants.ISPECS_PARAMETERS:
975 par_std_ok = InstancePolicy._CheckISpecParamSyntax(minmaxspecs, stdspec,
977 spec_std_ok = spec_std_ok and par_std_ok
978 std_is_good = std_is_good or spec_std_ok
980 raise errors.ConfigurationError("Invalid std specifications")
983 def _CheckISpecParamSyntax(cls, minmaxspecs, stdspec, name, check_std):
984 """Check the instance policy specs for validity on a given key.
986 We check if the instance specs makes sense for a given key, that is
987 if minmaxspecs[min][name] <= stdspec[name] <= minmaxspec[max][name].
989 @type minmaxspecs: dict
990 @param minmaxspecs: dictionary with min and max instance spec
992 @param stdspec: dictionary with standard instance spec
994 @param name: what are the limits for
995 @type check_std: bool
996 @param check_std: Whether to check std value or just assume compliance
998 @return: C{True} when specs are valid, C{False} when standard spec for the
999 given name is not valid
1000 @raise errors.ConfigurationError: when min/max specs for the given name
1004 minspec = minmaxspecs[constants.ISPECS_MIN]
1005 maxspec = minmaxspecs[constants.ISPECS_MAX]
1006 min_v = minspec[name]
1007 max_v = maxspec[name]
1010 err = ("Invalid specification of min/max values for %s: %s/%s" %
1011 (name, min_v, max_v))
1012 raise errors.ConfigurationError(err)
1014 std_v = stdspec.get(name, min_v)
1015 return std_v >= min_v and std_v <= max_v
1020 def CheckDiskTemplates(cls, disk_templates):
1021 """Checks the disk templates for validity.
1024 if not disk_templates:
1025 raise errors.ConfigurationError("Instance policy must contain" +
1026 " at least one disk template")
1027 wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
1029 raise errors.ConfigurationError("Invalid disk template(s) %s" %
1030 utils.CommaJoin(wrong))
1033 def CheckParameter(cls, key, value):
1034 """Checks a parameter.
1036 Currently we expect all parameters to be float values.
1041 except (TypeError, ValueError), err:
1042 raise errors.ConfigurationError("Invalid value for key" " '%s':"
1043 " '%s', error: %s" % (key, value, err))
1046 class Instance(TaggableObject):
1047 """Config object representing an instance."""
1063 ] + _TIMESTAMPS + _UUID
1065 def _ComputeSecondaryNodes(self):
1066 """Compute the list of secondary nodes.
1068 This is a simple wrapper over _ComputeAllNodes.
1071 all_nodes = set(self._ComputeAllNodes())
1072 all_nodes.discard(self.primary_node)
1073 return tuple(all_nodes)
1075 secondary_nodes = property(_ComputeSecondaryNodes, None, None,
1076 "List of names of secondary nodes")
1078 def _ComputeAllNodes(self):
1079 """Compute the list of all nodes.
1081 Since the data is already there (in the drbd disks), keeping it as
1082 a separate normal attribute is redundant and if not properly
1083 synchronised can cause problems. Thus it's better to compute it
1087 def _Helper(nodes, device):
1088 """Recursively computes nodes given a top device."""
1089 if device.dev_type in constants.LDS_DRBD:
1090 nodea, nodeb = device.logical_id[:2]
1094 for child in device.children:
1095 _Helper(nodes, child)
1098 all_nodes.add(self.primary_node)
1099 for device in self.disks:
1100 _Helper(all_nodes, device)
1101 return tuple(all_nodes)
1103 all_nodes = property(_ComputeAllNodes, None, None,
1104 "List of names of all the nodes of the instance")
1106 def MapLVsByNode(self, lvmap=None, devs=None, node=None):
1107 """Provide a mapping of nodes to LVs this instance owns.
1109 This function figures out what logical volumes should belong on
1110 which nodes, recursing through a device tree.
1112 @param lvmap: optional dictionary to receive the
1113 'node' : ['lv', ...] data.
1115 @return: None if lvmap arg is given, otherwise, a dictionary of
1116 the form { 'nodename' : ['volume1', 'volume2', ...], ... };
1117 volumeN is of the form "vg_name/lv_name", compatible with
1122 node = self.primary_node
1130 if not node in lvmap:
1138 if dev.dev_type == constants.LD_LV:
1139 lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
1141 elif dev.dev_type in constants.LDS_DRBD:
1143 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
1144 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])
1147 self.MapLVsByNode(lvmap, dev.children, node)
1151 def FindDisk(self, idx):
1152 """Find a disk given having a specified index.
1154 This is just a wrapper that does validation of the index.
1157 @param idx: the disk index
1159 @return: the corresponding disk
1160 @raise errors.OpPrereqError: when the given index is not valid
1165 return self.disks[idx]
1166 except (TypeError, ValueError), err:
1167 raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
1170 raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1171 " 0 to %d" % (idx, len(self.disks) - 1),
1175 """Instance-specific conversion to standard python types.
1177 This replaces the children lists of objects with lists of standard
1181 bo = super(Instance, self).ToDict()
1183 for attr in "nics", "disks":
1184 alist = bo.get(attr, None)
1186 nlist = outils.ContainerToDicts(alist)
1193 def FromDict(cls, val):
1194 """Custom function for instances.
1197 if "admin_state" not in val:
1198 if val.get("admin_up", False):
1199 val["admin_state"] = constants.ADMINST_UP
1201 val["admin_state"] = constants.ADMINST_DOWN
1202 if "admin_up" in val:
1204 obj = super(Instance, cls).FromDict(val)
1205 obj.nics = outils.ContainerFromDicts(obj.nics, list, NIC)
1206 obj.disks = outils.ContainerFromDicts(obj.disks, list, Disk)
1209 def UpgradeConfig(self):
1210 """Fill defaults for missing configuration values.
1213 for nic in self.nics:
1215 for disk in self.disks:
1216 disk.UpgradeConfig()
1218 for key in constants.HVC_GLOBALS:
1220 del self.hvparams[key]
1223 if self.osparams is None:
1225 UpgradeBeParams(self.beparams)
1226 if self.disks_active is None:
1227 self.disks_active = self.admin_state == constants.ADMINST_UP
1230 class OS(ConfigObject):
1231 """Config object representing an operating system.
1233 @type supported_parameters: list
1234 @ivar supported_parameters: a list of tuples, name and description,
1235 containing the supported parameters by this OS
1237 @type VARIANT_DELIM: string
1238 @cvar VARIANT_DELIM: the variant delimiter
1250 "supported_variants",
1251 "supported_parameters",
1257 def SplitNameVariant(cls, name):
1258 """Splits the name into the proper name and variant.
1260 @param name: the OS (unprocessed) name
1262 @return: a list of two elements; if the original name didn't
1263 contain a variant, it's returned as an empty string
1266 nv = name.split(cls.VARIANT_DELIM, 1)
1272 def GetName(cls, name):
1273 """Returns the proper name of the os (without the variant).
1275 @param name: the OS (unprocessed) name
1278 return cls.SplitNameVariant(name)[0]
1281 def GetVariant(cls, name):
1282 """Returns the variant the os (without the base name).
1284 @param name: the OS (unprocessed) name
1287 return cls.SplitNameVariant(name)[1]
1290 class ExtStorage(ConfigObject):
1291 """Config object representing an External Storage Provider.
1304 "supported_parameters",
1308 class NodeHvState(ConfigObject):
1309 """Hypvervisor state on a node.
1311 @ivar mem_total: Total amount of memory
1312 @ivar mem_node: Memory used by, or reserved for, the node itself (not always
1314 @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation
1316 @ivar mem_inst: Memory used by instances living on node
1317 @ivar cpu_total: Total node CPU core count
1318 @ivar cpu_node: Number of CPU cores reserved for the node itself
1331 class NodeDiskState(ConfigObject):
1332 """Disk state on a node.
1342 class Node(TaggableObject):
1343 """Config object representing a node.
1345 @ivar hv_state: Hypervisor state (e.g. number of CPUs)
1346 @ivar hv_state_static: Hypervisor state overriden by user
1347 @ivar disk_state: Disk state (e.g. free space)
1348 @ivar disk_state_static: Disk state overriden by user
1367 "disk_state_static",
1368 ] + _TIMESTAMPS + _UUID
1370 def UpgradeConfig(self):
1371 """Fill defaults for missing configuration values.
1374 # pylint: disable=E0203
1375 # because these are "defined" via slots, not manually
1376 if self.master_capable is None:
1377 self.master_capable = True
1379 if self.vm_capable is None:
1380 self.vm_capable = True
1382 if self.ndparams is None:
1384 # And remove any global parameter
1385 for key in constants.NDC_GLOBALS:
1386 if key in self.ndparams:
1387 logging.warning("Ignoring %s node parameter for node %s",
1389 del self.ndparams[key]
1391 if self.powered is None:
1395 """Custom function for serializing.
1398 data = super(Node, self).ToDict()
1400 hv_state = data.get("hv_state", None)
1401 if hv_state is not None:
1402 data["hv_state"] = outils.ContainerToDicts(hv_state)
1404 disk_state = data.get("disk_state", None)
1405 if disk_state is not None:
1406 data["disk_state"] = \
1407 dict((key, outils.ContainerToDicts(value))
1408 for (key, value) in disk_state.items())
1413 def FromDict(cls, val):
1414 """Custom function for deserializing.
1417 obj = super(Node, cls).FromDict(val)
1419 if obj.hv_state is not None:
1421 outils.ContainerFromDicts(obj.hv_state, dict, NodeHvState)
1423 if obj.disk_state is not None:
1425 dict((key, outils.ContainerFromDicts(value, dict, NodeDiskState))
1426 for (key, value) in obj.disk_state.items())
1431 class NodeGroup(TaggableObject):
1432 """Config object representing a node group."""
1441 "disk_state_static",
1444 ] + _TIMESTAMPS + _UUID
1447 """Custom function for nodegroup.
1449 This discards the members object, which gets recalculated and is only kept
1453 mydict = super(NodeGroup, self).ToDict()
1454 del mydict["members"]
1458 def FromDict(cls, val):
1459 """Custom function for nodegroup.
1461 The members slot is initialized to an empty list, upon deserialization.
1464 obj = super(NodeGroup, cls).FromDict(val)
1468 def UpgradeConfig(self):
1469 """Fill defaults for missing configuration values.
1472 if self.ndparams is None:
1475 if self.serial_no is None:
1478 if self.alloc_policy is None:
1479 self.alloc_policy = constants.ALLOC_POLICY_PREFERRED
1481 # We only update mtime, and not ctime, since we would not be able
1482 # to provide a correct value for creation time.
1483 if self.mtime is None:
1484 self.mtime = time.time()
1486 if self.diskparams is None:
1487 self.diskparams = {}
1488 if self.ipolicy is None:
1489 self.ipolicy = MakeEmptyIPolicy()
1491 if self.networks is None:
1494 def FillND(self, node):
1495 """Return filled out ndparams for L{objects.Node}
1497 @type node: L{objects.Node}
1498 @param node: A Node object to fill
1499 @return a copy of the node's ndparams with defaults filled
1502 return self.SimpleFillND(node.ndparams)
1504 def SimpleFillND(self, ndparams):
1505 """Fill a given ndparams dict with defaults.
1507 @type ndparams: dict
1508 @param ndparams: the dict to fill
1510 @return: a copy of the passed in ndparams with missing keys filled
1511 from the node group defaults
1514 return FillDict(self.ndparams, ndparams)
1517 class Cluster(TaggableObject):
1518 """Config object representing the cluster."""
1523 "highest_used_port",
1526 "volume_group_name",
1528 "drbd_usermode_helper",
1530 "default_hypervisor",
1535 "use_external_mip_script",
1538 "shared_file_storage_dir",
1539 "enabled_hypervisors",
1548 "candidate_pool_size",
1551 "maintain_node_health",
1553 "default_iallocator",
1556 "primary_ip_family",
1557 "prealloc_wipe_disks",
1559 "disk_state_static",
1560 "enabled_disk_templates",
1561 ] + _TIMESTAMPS + _UUID
1563 def UpgradeConfig(self):
1564 """Fill defaults for missing configuration values.
1567 # pylint: disable=E0203
1568 # because these are "defined" via slots, not manually
1569 if self.hvparams is None:
1570 self.hvparams = constants.HVC_DEFAULTS
1572 for hypervisor in self.hvparams:
1573 self.hvparams[hypervisor] = FillDict(
1574 constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])
1576 if self.os_hvp is None:
1579 # osparams added before 2.2
1580 if self.osparams is None:
1583 self.ndparams = UpgradeNDParams(self.ndparams)
1585 self.beparams = UpgradeGroupedParams(self.beparams,
1586 constants.BEC_DEFAULTS)
1587 for beparams_group in self.beparams:
1588 UpgradeBeParams(self.beparams[beparams_group])
1590 migrate_default_bridge = not self.nicparams
1591 self.nicparams = UpgradeGroupedParams(self.nicparams,
1592 constants.NICC_DEFAULTS)
1593 if migrate_default_bridge:
1594 self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
1597 if self.modify_etc_hosts is None:
1598 self.modify_etc_hosts = True
1600 if self.modify_ssh_setup is None:
1601 self.modify_ssh_setup = True
1603 # default_bridge is no longer used in 2.1. The slot is left there to
1604 # support auto-upgrading. It can be removed once we decide to deprecate
1605 # upgrading straight from 2.0.
1606 if self.default_bridge is not None:
1607 self.default_bridge = None
1609 # default_hypervisor is just the first enabled one in 2.1. This slot and
1610 # code can be removed once upgrading straight from 2.0 is deprecated.
1611 if self.default_hypervisor is not None:
1612 self.enabled_hypervisors = ([self.default_hypervisor] +
1613 [hvname for hvname in self.enabled_hypervisors
1614 if hvname != self.default_hypervisor])
1615 self.default_hypervisor = None
1617 # maintain_node_health added after 2.1.1
1618 if self.maintain_node_health is None:
1619 self.maintain_node_health = False
1621 if self.uid_pool is None:
1624 if self.default_iallocator is None:
1625 self.default_iallocator = ""
1627 # reserved_lvs added before 2.2
1628 if self.reserved_lvs is None:
1629 self.reserved_lvs = []
1631 # hidden and blacklisted operating systems added before 2.2.1
1632 if self.hidden_os is None:
1635 if self.blacklisted_os is None:
1636 self.blacklisted_os = []
1638 # primary_ip_family added before 2.3
1639 if self.primary_ip_family is None:
1640 self.primary_ip_family = AF_INET
1642 if self.master_netmask is None:
1643 ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
1644 self.master_netmask = ipcls.iplen
1646 if self.prealloc_wipe_disks is None:
1647 self.prealloc_wipe_disks = False
1649 # shared_file_storage_dir added before 2.5
1650 if self.shared_file_storage_dir is None:
1651 self.shared_file_storage_dir = ""
1653 if self.use_external_mip_script is None:
1654 self.use_external_mip_script = False
1657 self.diskparams = UpgradeDiskParams(self.diskparams)
1659 self.diskparams = constants.DISK_DT_DEFAULTS.copy()
1661 # instance policy added before 2.6
1662 if self.ipolicy is None:
1663 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, {})
1665 # we can either make sure to upgrade the ipolicy always, or only
1666 # do it in some corner cases (e.g. missing keys); note that this
1667 # will break any removal of keys from the ipolicy dict
1668 wrongkeys = frozenset(self.ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
1670 # These keys would be silently removed by FillIPolicy()
1671 msg = ("Cluster instance policy contains spurious keys: %s" %
1672 utils.CommaJoin(wrongkeys))
1673 raise errors.ConfigurationError(msg)
1674 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, self.ipolicy)
1677 def primary_hypervisor(self):
1678 """The first hypervisor is the primary.
1680 Useful, for example, for L{Node}'s hv/disk state.
1683 return self.enabled_hypervisors[0]
1686 """Custom function for cluster.
1689 mydict = super(Cluster, self).ToDict()
1691 if self.tcpudp_port_pool is None:
1692 tcpudp_port_pool = []
1694 tcpudp_port_pool = list(self.tcpudp_port_pool)
1696 mydict["tcpudp_port_pool"] = tcpudp_port_pool
1701 def FromDict(cls, val):
1702 """Custom function for cluster.
1705 obj = super(Cluster, cls).FromDict(val)
1707 if obj.tcpudp_port_pool is None:
1708 obj.tcpudp_port_pool = set()
1709 elif not isinstance(obj.tcpudp_port_pool, set):
1710 obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
1714 def SimpleFillDP(self, diskparams):
1715 """Fill a given diskparams dict with cluster defaults.
1717 @param diskparams: The diskparams
1718 @return: The defaults dict
1721 return FillDiskParams(self.diskparams, diskparams)
1723 def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
1724 """Get the default hypervisor parameters for the cluster.
1726 @param hypervisor: the hypervisor name
1727 @param os_name: if specified, we'll also update the defaults for this OS
1728 @param skip_keys: if passed, list of keys not to use
1729 @return: the defaults dict
1732 if skip_keys is None:
1735 fill_stack = [self.hvparams.get(hypervisor, {})]
1736 if os_name is not None:
1737 os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
1738 fill_stack.append(os_hvp)
1741 for o_dict in fill_stack:
1742 ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)
1746 def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
1747 """Fill a given hvparams dict with cluster defaults.
1749 @type hv_name: string
1750 @param hv_name: the hypervisor to use
1751 @type os_name: string
1752 @param os_name: the OS to use for overriding the hypervisor defaults
1753 @type skip_globals: boolean
1754 @param skip_globals: if True, the global hypervisor parameters will
1757 @return: a copy of the given hvparams with missing keys filled from
1758 the cluster defaults
1762 skip_keys = constants.HVC_GLOBALS
1766 def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
1767 return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1769 def FillHV(self, instance, skip_globals=False):
1770 """Fill an instance's hvparams dict with cluster defaults.
1772 @type instance: L{objects.Instance}
1773 @param instance: the instance parameter to fill
1774 @type skip_globals: boolean
1775 @param skip_globals: if True, the global hypervisor parameters will
1778 @return: a copy of the instance's hvparams with missing keys filled from
1779 the cluster defaults
1782 return self.SimpleFillHV(instance.hypervisor, instance.os,
1783 instance.hvparams, skip_globals)
1785 def SimpleFillBE(self, beparams):
1786 """Fill a given beparams dict with cluster defaults.
1788 @type beparams: dict
1789 @param beparams: the dict to fill
1791 @return: a copy of the passed in beparams with missing keys filled
1792 from the cluster defaults
1795 return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1797 def FillBE(self, instance):
1798 """Fill an instance's beparams dict with cluster defaults.
1800 @type instance: L{objects.Instance}
1801 @param instance: the instance parameter to fill
1803 @return: a copy of the instance's beparams with missing keys filled from
1804 the cluster defaults
1807 return self.SimpleFillBE(instance.beparams)
1809 def SimpleFillNIC(self, nicparams):
1810 """Fill a given nicparams dict with cluster defaults.
1812 @type nicparams: dict
1813 @param nicparams: the dict to fill
1815 @return: a copy of the passed in nicparams with missing keys filled
1816 from the cluster defaults
1819 return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1821 def SimpleFillOS(self, os_name, os_params):
1822 """Fill an instance's osparams dict with cluster defaults.
1824 @type os_name: string
1825 @param os_name: the OS name to use
1826 @type os_params: dict
1827 @param os_params: the dict to fill with default values
1829 @return: a copy of the instance's osparams with missing keys filled from
1830 the cluster defaults
1833 name_only = os_name.split("+", 1)[0]
1835 result = self.osparams.get(name_only, {})
1837 result = FillDict(result, self.osparams.get(os_name, {}))
1839 return FillDict(result, os_params)
1842 def SimpleFillHvState(hv_state):
1843 """Fill an hv_state sub dict with cluster defaults.
1846 return FillDict(constants.HVST_DEFAULTS, hv_state)
1849 def SimpleFillDiskState(disk_state):
1850 """Fill an disk_state sub dict with cluster defaults.
1853 return FillDict(constants.DS_DEFAULTS, disk_state)
1855 def FillND(self, node, nodegroup):
1856 """Return filled out ndparams for L{objects.NodeGroup} and L{objects.Node}
1858 @type node: L{objects.Node}
1859 @param node: A Node object to fill
1860 @type nodegroup: L{objects.NodeGroup}
1861 @param nodegroup: A Node object to fill
1862 @return a copy of the node's ndparams with defaults filled
1865 return self.SimpleFillND(nodegroup.FillND(node))
1867 def SimpleFillND(self, ndparams):
1868 """Fill a given ndparams dict with defaults.
1870 @type ndparams: dict
1871 @param ndparams: the dict to fill
1873 @return: a copy of the passed in ndparams with missing keys filled
1874 from the cluster defaults
1877 return FillDict(self.ndparams, ndparams)
1879 def SimpleFillIPolicy(self, ipolicy):
1880 """ Fill instance policy dict with defaults.
1883 @param ipolicy: the dict to fill
1885 @return: a copy of passed ipolicy with missing keys filled from
1886 the cluster defaults
1889 return FillIPolicy(self.ipolicy, ipolicy)
1892 class BlockDevStatus(ConfigObject):
1893 """Config object representing the status of a block device."""
1905 class ImportExportStatus(ConfigObject):
1906 """Config object representing the status of an import or export."""
1912 "progress_throughput",
1920 class ImportExportOptions(ConfigObject):
1921 """Options for import/export daemon
1923 @ivar key_name: X509 key name (None for cluster certificate)
1924 @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1925 @ivar compress: Compression method (one of L{constants.IEC_ALL})
1926 @ivar magic: Used to ensure the connection goes to the right disk
1927 @ivar ipv6: Whether to use IPv6
1928 @ivar connect_timeout: Number of seconds for establishing connection
1941 class ConfdRequest(ConfigObject):
1942 """Object holding a confd request.
1944 @ivar protocol: confd protocol version
1945 @ivar type: confd query type
1946 @ivar query: query request
1947 @ivar rsalt: requested reply salt
1958 class ConfdReply(ConfigObject):
1959 """Object holding a confd reply.
1961 @ivar protocol: confd protocol version
1962 @ivar status: reply status code (ok, error)
1963 @ivar answer: confd query reply
1964 @ivar serial: configuration serial number
1975 class QueryFieldDefinition(ConfigObject):
1976 """Object holding a query field definition.
1978 @ivar name: Field name
1979 @ivar title: Human-readable title
1980 @ivar kind: Field type
1981 @ivar doc: Human-readable description
1992 class _QueryResponseBase(ConfigObject):
1998 """Custom function for serializing.
2001 mydict = super(_QueryResponseBase, self).ToDict()
2002 mydict["fields"] = outils.ContainerToDicts(mydict["fields"])
2006 def FromDict(cls, val):
2007 """Custom function for de-serializing.
2010 obj = super(_QueryResponseBase, cls).FromDict(val)
2012 outils.ContainerFromDicts(obj.fields, list, QueryFieldDefinition)
2016 class QueryResponse(_QueryResponseBase):
2017 """Object holding the response to a query.
2019 @ivar fields: List of L{QueryFieldDefinition} objects
2020 @ivar data: Requested data
2028 class QueryFieldsRequest(ConfigObject):
2029 """Object holding a request for querying available fields.
2038 class QueryFieldsResponse(_QueryResponseBase):
2039 """Object holding the response to a query for fields.
2041 @ivar fields: List of L{QueryFieldDefinition} objects
2047 class MigrationStatus(ConfigObject):
2048 """Object holding the status of a migration.
2058 class InstanceConsole(ConfigObject):
2059 """Object describing how to access the console of an instance.
2074 """Validates contents of this object.
2077 assert self.kind in constants.CONS_ALL, "Unknown console type"
2078 assert self.instance, "Missing instance name"
2079 assert self.message or self.kind in [constants.CONS_SSH,
2080 constants.CONS_SPICE,
2082 assert self.host or self.kind == constants.CONS_MESSAGE
2083 assert self.port or self.kind in [constants.CONS_MESSAGE,
2085 assert self.user or self.kind in [constants.CONS_MESSAGE,
2086 constants.CONS_SPICE,
2088 assert self.command or self.kind in [constants.CONS_MESSAGE,
2089 constants.CONS_SPICE,
2091 assert self.display or self.kind in [constants.CONS_MESSAGE,
2092 constants.CONS_SPICE,
2097 class Network(TaggableObject):
2098 """Object representing a network definition for ganeti.
2111 ] + _TIMESTAMPS + _UUID
2113 def HooksDict(self, prefix=""):
2114 """Export a dictionary used by hooks with a network's information.
2116 @type prefix: String
2117 @param prefix: Prefix to prepend to the dict entries
2121 "%sNETWORK_NAME" % prefix: self.name,
2122 "%sNETWORK_UUID" % prefix: self.uuid,
2123 "%sNETWORK_TAGS" % prefix: " ".join(self.GetTags()),
2126 result["%sNETWORK_SUBNET" % prefix] = self.network
2128 result["%sNETWORK_GATEWAY" % prefix] = self.gateway
2130 result["%sNETWORK_SUBNET6" % prefix] = self.network6
2132 result["%sNETWORK_GATEWAY6" % prefix] = self.gateway6
2134 result["%sNETWORK_MAC_PREFIX" % prefix] = self.mac_prefix
2139 def FromDict(cls, val):
2140 """Custom function for networks.
2142 Remove deprecated network_type and family.
2145 if "network_type" in val:
2146 del val["network_type"]
2149 obj = super(Network, cls).FromDict(val)
2153 class SerializableConfigParser(ConfigParser.SafeConfigParser):
2154 """Simple wrapper over ConfigParse that allows serialization.
2156 This class is basically ConfigParser.SafeConfigParser with two
2157 additional methods that allow it to serialize/unserialize to/from a
2162 """Dump this instance and return the string representation."""
2165 return buf.getvalue()
2168 def Loads(cls, data):
2169 """Load data from a string."""
2170 buf = StringIO(data)
2176 class LvmPvInfo(ConfigObject):
2177 """Information about an LVM physical volume (PV).
2180 @ivar name: name of the PV
2181 @type vg_name: string
2182 @ivar vg_name: name of the volume group containing the PV
2184 @ivar size: size of the PV in MiB
2186 @ivar free: free space in the PV, in MiB
2187 @type attributes: string
2188 @ivar attributes: PV attributes
2189 @type lv_list: list of strings
2190 @ivar lv_list: names of the LVs hosted on the PV
2202 """Is this PV empty?
2205 return self.size <= (self.free + 1)
2207 def IsAllocatable(self):
2208 """Is this PV allocatable?
2211 return ("a" in self.attributes)