4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 explicitely initialise its members
34 # W0201: Attribute '%s' defined outside __init__
36 # R0902: Allow instances of these objects to have more than 20 attributes
42 from cStringIO import StringIO
44 from ganeti import errors
45 from ganeti import constants
46 from ganeti import netutils
47 from ganeti import utils
49 from socket import AF_INET
52 __all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
53 "OS", "Node", "NodeGroup", "Cluster", "FillDict"]
55 _TIMESTAMPS = ["ctime", "mtime"]
58 # constants used to create InstancePolicy dictionary
59 TISPECS_GROUP_TYPES = {
60 constants.ISPECS_MIN: constants.VTYPE_INT,
61 constants.ISPECS_MAX: constants.VTYPE_INT,
64 TISPECS_CLUSTER_TYPES = {
65 constants.ISPECS_MIN: constants.VTYPE_INT,
66 constants.ISPECS_MAX: constants.VTYPE_INT,
67 constants.ISPECS_STD: constants.VTYPE_INT,
71 def FillDict(defaults_dict, custom_dict, skip_keys=None):
72 """Basic function to apply settings on top a default dict.
74 @type defaults_dict: dict
75 @param defaults_dict: dictionary holding the default values
76 @type custom_dict: dict
77 @param custom_dict: dictionary holding customized value
79 @param skip_keys: which keys not to fill
81 @return: dict with the 'full' values
84 ret_dict = copy.deepcopy(defaults_dict)
85 ret_dict.update(custom_dict)
95 def FillIPolicy(default_ipolicy, custom_ipolicy, skip_keys=None):
96 """Fills an instance policy with defaults.
99 assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
101 for key in constants.IPOLICY_PARAMETERS:
102 ret_dict[key] = FillDict(default_ipolicy[key],
103 custom_ipolicy.get(key, {}),
106 for key in [constants.ISPECS_DTS]:
107 ret_dict[key] = list(custom_ipolicy.get(key, default_ipolicy[key]))
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 dit
153 if diskparams is None:
154 result = constants.DISK_DT_DEFAULTS.copy()
156 # Update the disk parameter values for each disk template.
157 # The code iterates over constants.DISK_TEMPLATES because new templates
158 # might have been added.
159 for template in constants.DISK_TEMPLATES:
160 if template not in diskparams:
161 result[template] = constants.DISK_DT_DEFAULTS[template].copy()
163 result[template] = FillDict(constants.DISK_DT_DEFAULTS[template],
164 diskparams[template])
169 def MakeEmptyIPolicy():
170 """Create empty IPolicy dictionary.
174 (constants.ISPECS_MIN, {}),
175 (constants.ISPECS_MAX, {}),
176 (constants.ISPECS_STD, {}),
180 def CreateIPolicyFromOpts(ispecs_mem_size=None,
181 ispecs_cpu_count=None,
182 ispecs_disk_count=None,
183 ispecs_disk_size=None,
184 ispecs_nic_count=None,
185 ispecs_disk_templates=None,
189 """Creation of instance policy based on command line options.
191 @param fill_all: whether for cluster policies we should ensure that
192 all values are filled
196 # prepare ipolicy dict
197 ipolicy_transposed = {
198 constants.ISPEC_MEM_SIZE: ispecs_mem_size,
199 constants.ISPEC_CPU_COUNT: ispecs_cpu_count,
200 constants.ISPEC_DISK_COUNT: ispecs_disk_count,
201 constants.ISPEC_DISK_SIZE: ispecs_disk_size,
202 constants.ISPEC_NIC_COUNT: ispecs_nic_count,
205 # first, check that the values given are correct
207 forced_type = TISPECS_GROUP_TYPES
209 forced_type = TISPECS_CLUSTER_TYPES
211 for specs in ipolicy_transposed.values():
212 utils.ForceDictType(specs, forced_type, allowed_values=allowed_values)
215 ipolicy_out = MakeEmptyIPolicy()
216 for name, specs in ipolicy_transposed.iteritems():
217 assert name in constants.ISPECS_PARAMETERS
218 for key, val in specs.items(): # {min: .. ,max: .., std: ..}
219 ipolicy_out[key][name] = val
221 # no filldict for lists
222 if not group_ipolicy and fill_all and ispecs_disk_templates is None:
223 ispecs_disk_templates = constants.DISK_TEMPLATES
224 if ispecs_disk_templates is not None:
225 ipolicy_out[constants.ISPECS_DTS] = list(ispecs_disk_templates)
227 assert not (frozenset(ipolicy_out.keys()) - constants.IPOLICY_ALL_KEYS)
232 class ConfigObject(object):
233 """A generic config object.
235 It has the following properties:
237 - provides somewhat safe recursive unpickling and pickling for its classes
238 - unset attributes which are defined in slots are always returned
239 as None instead of raising an error
241 Classes derived from this must always declare __slots__ (we use many
242 config objects and the memory reduction is useful)
247 def __init__(self, **kwargs):
248 for k, v in kwargs.iteritems():
251 def __getattr__(self, name):
252 if name not in self._all_slots():
253 raise AttributeError("Invalid object attribute %s.%s" %
254 (type(self).__name__, name))
257 def __setstate__(self, state):
258 slots = self._all_slots()
261 setattr(self, name, state[name])
265 """Compute the list of all declared slots for a class.
269 for parent in cls.__mro__:
270 slots.extend(getattr(parent, "__slots__", []))
274 """Convert to a dict holding only standard python types.
276 The generic routine just dumps all of this object's attributes in
277 a dict. It does not work if the class has children who are
278 ConfigObjects themselves (e.g. the nics list in an Instance), in
279 which case the object should subclass the function in order to
280 make sure all objects returned are only standard python types.
284 for name in self._all_slots():
285 value = getattr(self, name, None)
286 if value is not None:
290 __getstate__ = ToDict
293 def FromDict(cls, val):
294 """Create an object from a dictionary.
296 This generic routine takes a dict, instantiates a new instance of
297 the given class, and sets attributes based on the dict content.
299 As for `ToDict`, this does not work if the class has children
300 who are ConfigObjects themselves (e.g. the nics list in an
301 Instance), in which case the object should subclass the function
302 and alter the objects.
305 if not isinstance(val, dict):
306 raise errors.ConfigurationError("Invalid object passed to FromDict:"
307 " expected dict, got %s" % type(val))
308 val_str = dict([(str(k), v) for k, v in val.iteritems()])
309 obj = cls(**val_str) # pylint: disable=W0142
313 def _ContainerToDicts(container):
314 """Convert the elements of a container to standard python types.
316 This method converts a container with elements derived from
317 ConfigData to standard python types. If the container is a dict,
318 we don't touch the keys, only the values.
321 if isinstance(container, dict):
322 ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
323 elif isinstance(container, (list, tuple, set, frozenset)):
324 ret = [elem.ToDict() for elem in container]
326 raise TypeError("Invalid type %s passed to _ContainerToDicts" %
331 def _ContainerFromDicts(source, c_type, e_type):
332 """Convert a container from standard python types.
334 This method converts a container with standard python types to
335 ConfigData objects. If the container is a dict, we don't touch the
336 keys, only the values.
339 if not isinstance(c_type, type):
340 raise TypeError("Container type %s passed to _ContainerFromDicts is"
341 " not a type" % type(c_type))
345 ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
346 elif c_type in (list, tuple, set, frozenset):
347 ret = c_type([e_type.FromDict(elem) for elem in source])
349 raise TypeError("Invalid container type %s passed to"
350 " _ContainerFromDicts" % c_type)
354 """Makes a deep copy of the current object and its children.
357 dict_form = self.ToDict()
358 clone_obj = self.__class__.FromDict(dict_form)
362 """Implement __repr__ for ConfigObjects."""
363 return repr(self.ToDict())
365 def UpgradeConfig(self):
366 """Fill defaults for missing configuration values.
368 This method will be called at configuration load time, and its
369 implementation will be object dependent.
375 class TaggableObject(ConfigObject):
376 """An generic class supporting tags.
380 VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
383 def ValidateTag(cls, tag):
384 """Check if a tag is valid.
386 If the tag is invalid, an errors.TagError will be raised. The
387 function has no return value.
390 if not isinstance(tag, basestring):
391 raise errors.TagError("Invalid tag type (not a string)")
392 if len(tag) > constants.MAX_TAG_LEN:
393 raise errors.TagError("Tag too long (>%d characters)" %
394 constants.MAX_TAG_LEN)
396 raise errors.TagError("Tags cannot be empty")
397 if not cls.VALID_TAG_RE.match(tag):
398 raise errors.TagError("Tag contains invalid characters")
401 """Return the tags list.
404 tags = getattr(self, "tags", None)
406 tags = self.tags = set()
409 def AddTag(self, tag):
413 self.ValidateTag(tag)
414 tags = self.GetTags()
415 if len(tags) >= constants.MAX_TAGS_PER_OBJ:
416 raise errors.TagError("Too many tags")
417 self.GetTags().add(tag)
419 def RemoveTag(self, tag):
423 self.ValidateTag(tag)
424 tags = self.GetTags()
428 raise errors.TagError("Tag not found")
431 """Taggable-object-specific conversion to standard python types.
433 This replaces the tags set with a list.
436 bo = super(TaggableObject, self).ToDict()
438 tags = bo.get("tags", None)
439 if isinstance(tags, set):
440 bo["tags"] = list(tags)
444 def FromDict(cls, val):
445 """Custom function for instances.
448 obj = super(TaggableObject, cls).FromDict(val)
449 if hasattr(obj, "tags") and isinstance(obj.tags, list):
450 obj.tags = set(obj.tags)
454 class MasterNetworkParameters(ConfigObject):
455 """Network configuration parameters for the master
457 @ivar name: master name
459 @ivar netmask: master netmask
460 @ivar netdev: master network device
461 @ivar ip_family: master IP family
473 class ConfigData(ConfigObject):
474 """Top-level config object."""
485 """Custom function for top-level config data.
487 This just replaces the list of instances, nodes and the cluster
488 with standard python types.
491 mydict = super(ConfigData, self).ToDict()
492 mydict["cluster"] = mydict["cluster"].ToDict()
493 for key in "nodes", "instances", "nodegroups":
494 mydict[key] = self._ContainerToDicts(mydict[key])
499 def FromDict(cls, val):
500 """Custom function for top-level config data
503 obj = super(ConfigData, cls).FromDict(val)
504 obj.cluster = Cluster.FromDict(obj.cluster)
505 obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
506 obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
507 obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
510 def HasAnyDiskOfType(self, dev_type):
511 """Check if in there is at disk of the given type in the configuration.
513 @type dev_type: L{constants.LDS_BLOCK}
514 @param dev_type: the type to look for
516 @return: boolean indicating if a disk of the given type was found or not
519 for instance in self.instances.values():
520 for disk in instance.disks:
521 if disk.IsBasedOnDiskType(dev_type):
525 def UpgradeConfig(self):
526 """Fill defaults for missing configuration values.
529 self.cluster.UpgradeConfig()
530 for node in self.nodes.values():
532 for instance in self.instances.values():
533 instance.UpgradeConfig()
534 if self.nodegroups is None:
536 for nodegroup in self.nodegroups.values():
537 nodegroup.UpgradeConfig()
538 if self.cluster.drbd_usermode_helper is None:
539 # To decide if we set an helper let's check if at least one instance has
540 # a DRBD disk. This does not cover all the possible scenarios but it
541 # gives a good approximation.
542 if self.HasAnyDiskOfType(constants.LD_DRBD8):
543 self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
546 class NIC(ConfigObject):
547 """Config object representing a network card."""
548 __slots__ = ["mac", "ip", "nicparams"]
551 def CheckParameterSyntax(cls, nicparams):
552 """Check the given parameters for validity.
554 @type nicparams: dict
555 @param nicparams: dictionary with parameter names/value
556 @raise errors.ConfigurationError: when a parameter is not valid
559 if (nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES and
560 nicparams[constants.NIC_MODE] != constants.VALUE_AUTO):
561 err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
562 raise errors.ConfigurationError(err)
564 if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
565 not nicparams[constants.NIC_LINK]):
566 err = "Missing bridged nic link"
567 raise errors.ConfigurationError(err)
570 class Disk(ConfigObject):
571 """Config object representing a block device."""
572 __slots__ = ["dev_type", "logical_id", "physical_id",
573 "children", "iv_name", "size", "mode", "params"]
575 def CreateOnSecondary(self):
576 """Test if this device needs to be created on a secondary node."""
577 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
579 def AssembleOnSecondary(self):
580 """Test if this device needs to be assembled on a secondary node."""
581 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
583 def OpenOnSecondary(self):
584 """Test if this device needs to be opened on a secondary node."""
585 return self.dev_type in (constants.LD_LV,)
587 def StaticDevPath(self):
588 """Return the device path if this device type has a static one.
590 Some devices (LVM for example) live always at the same /dev/ path,
591 irrespective of their status. For such devices, we return this
592 path, for others we return None.
594 @warning: The path returned is not a normalized pathname; callers
595 should check that it is a valid path.
598 if self.dev_type == constants.LD_LV:
599 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
600 elif self.dev_type == constants.LD_BLOCKDEV:
601 return self.logical_id[1]
604 def ChildrenNeeded(self):
605 """Compute the needed number of children for activation.
607 This method will return either -1 (all children) or a positive
608 number denoting the minimum number of children needed for
609 activation (only mirrored devices will usually return >=0).
611 Currently, only DRBD8 supports diskless activation (therefore we
612 return 0), for all other we keep the previous semantics and return
616 if self.dev_type == constants.LD_DRBD8:
620 def IsBasedOnDiskType(self, dev_type):
621 """Check if the disk or its children are based on the given type.
623 @type dev_type: L{constants.LDS_BLOCK}
624 @param dev_type: the type to look for
626 @return: boolean indicating if a device of the given type was found or not
630 for child in self.children:
631 if child.IsBasedOnDiskType(dev_type):
633 return self.dev_type == dev_type
635 def GetNodes(self, node):
636 """This function returns the nodes this device lives on.
638 Given the node on which the parent of the device lives on (or, in
639 case of a top-level device, the primary node of the devices'
640 instance), this function will return a list of nodes on which this
641 devices needs to (or can) be assembled.
644 if self.dev_type in [constants.LD_LV, constants.LD_FILE,
645 constants.LD_BLOCKDEV]:
647 elif self.dev_type in constants.LDS_DRBD:
648 result = [self.logical_id[0], self.logical_id[1]]
649 if node not in result:
650 raise errors.ConfigurationError("DRBD device passed unknown node")
652 raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
655 def ComputeNodeTree(self, parent_node):
656 """Compute the node/disk tree for this disk and its children.
658 This method, given the node on which the parent disk lives, will
659 return the list of all (node, disk) pairs which describe the disk
660 tree in the most compact way. For example, a drbd/lvm stack
661 will be returned as (primary_node, drbd) and (secondary_node, drbd)
662 which represents all the top-level devices on the nodes.
665 my_nodes = self.GetNodes(parent_node)
666 result = [(node, self) for node in my_nodes]
667 if not self.children:
670 for node in my_nodes:
671 for child in self.children:
672 child_result = child.ComputeNodeTree(node)
673 if len(child_result) == 1:
674 # child (and all its descendants) is simple, doesn't split
675 # over multiple hosts, so we don't need to describe it, our
676 # own entry for this node describes it completely
679 # check if child nodes differ from my nodes; note that
680 # subdisk can differ from the child itself, and be instead
681 # one of its descendants
682 for subnode, subdisk in child_result:
683 if subnode not in my_nodes:
684 result.append((subnode, subdisk))
685 # otherwise child is under our own node, so we ignore this
686 # entry (but probably the other results in the list will
690 def ComputeGrowth(self, amount):
691 """Compute the per-VG growth requirements.
693 This only works for VG-based disks.
695 @type amount: integer
696 @param amount: the desired increase in (user-visible) disk space
698 @return: a dictionary of volume-groups and the required size
701 if self.dev_type == constants.LD_LV:
702 return {self.logical_id[0]: amount}
703 elif self.dev_type == constants.LD_DRBD8:
705 return self.children[0].ComputeGrowth(amount)
709 # Other disk types do not require VG space
712 def RecordGrow(self, amount):
713 """Update the size of this disk after growth.
715 This method recurses over the disks's children and updates their
716 size correspondigly. The method needs to be kept in sync with the
717 actual algorithms from bdev.
720 if self.dev_type in (constants.LD_LV, constants.LD_FILE):
722 elif self.dev_type == constants.LD_DRBD8:
724 self.children[0].RecordGrow(amount)
727 raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
728 " disk type %s" % self.dev_type)
731 """Sets recursively the size to zero for the disk and its children.
735 for child in self.children:
739 def SetPhysicalID(self, target_node, nodes_ip):
740 """Convert the logical ID to the physical ID.
742 This is used only for drbd, which needs ip/port configuration.
744 The routine descends down and updates its children also, because
745 this helps when the only the top device is passed to the remote
749 - target_node: the node we wish to configure for
750 - nodes_ip: a mapping of node name to ip
752 The target_node must exist in in nodes_ip, and must be one of the
753 nodes in the logical ID for each of the DRBD devices encountered
758 for child in self.children:
759 child.SetPhysicalID(target_node, nodes_ip)
761 if self.logical_id is None and self.physical_id is not None:
763 if self.dev_type in constants.LDS_DRBD:
764 pnode, snode, port, pminor, sminor, secret = self.logical_id
765 if target_node not in (pnode, snode):
766 raise errors.ConfigurationError("DRBD device not knowing node %s" %
768 pnode_ip = nodes_ip.get(pnode, None)
769 snode_ip = nodes_ip.get(snode, None)
770 if pnode_ip is None or snode_ip is None:
771 raise errors.ConfigurationError("Can't find primary or secondary node"
772 " for %s" % str(self))
773 p_data = (pnode_ip, port)
774 s_data = (snode_ip, port)
775 if pnode == target_node:
776 self.physical_id = p_data + s_data + (pminor, secret)
777 else: # it must be secondary, we tested above
778 self.physical_id = s_data + p_data + (sminor, secret)
780 self.physical_id = self.logical_id
784 """Disk-specific conversion to standard python types.
786 This replaces the children lists of objects with lists of
787 standard python types.
790 bo = super(Disk, self).ToDict()
792 for attr in ("children",):
793 alist = bo.get(attr, None)
795 bo[attr] = self._ContainerToDicts(alist)
799 def FromDict(cls, val):
800 """Custom function for Disks
803 obj = super(Disk, cls).FromDict(val)
805 obj.children = cls._ContainerFromDicts(obj.children, list, Disk)
806 if obj.logical_id and isinstance(obj.logical_id, list):
807 obj.logical_id = tuple(obj.logical_id)
808 if obj.physical_id and isinstance(obj.physical_id, list):
809 obj.physical_id = tuple(obj.physical_id)
810 if obj.dev_type in constants.LDS_DRBD:
811 # we need a tuple of length six here
812 if len(obj.logical_id) < 6:
813 obj.logical_id += (None,) * (6 - len(obj.logical_id))
817 """Custom str() formatter for disks.
820 if self.dev_type == constants.LD_LV:
821 val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
822 elif self.dev_type in constants.LDS_DRBD:
823 node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
825 if self.physical_id is None:
828 phy = ("configured as %s:%s %s:%s" %
829 (self.physical_id[0], self.physical_id[1],
830 self.physical_id[2], self.physical_id[3]))
832 val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
833 (node_a, minor_a, node_b, minor_b, port, phy))
834 if self.children and self.children.count(None) == 0:
835 val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
837 val += "no local storage"
839 val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
840 (self.dev_type, self.logical_id, self.physical_id, self.children))
841 if self.iv_name is None:
842 val += ", not visible"
844 val += ", visible as /dev/%s" % self.iv_name
845 if isinstance(self.size, int):
846 val += ", size=%dm)>" % self.size
848 val += ", size='%s')>" % (self.size,)
852 """Checks that this disk is correctly configured.
856 if self.mode not in constants.DISK_ACCESS_SET:
857 all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
860 def UpgradeConfig(self):
861 """Fill defaults for missing configuration values.
865 for child in self.children:
866 child.UpgradeConfig()
869 self.params = constants.DISK_LD_DEFAULTS[self.dev_type].copy()
871 self.params = FillDict(constants.DISK_LD_DEFAULTS[self.dev_type],
873 # add here config upgrade for this disk
876 class InstancePolicy(ConfigObject):
877 """Config object representing instance policy limits dictionary."""
878 __slots__ = ["min", "max", "std", "disk_templates"]
881 def CheckParameterSyntax(cls, ipolicy):
882 """ Check the instance policy for validity.
885 for param in constants.ISPECS_PARAMETERS:
886 InstancePolicy.CheckISpecSyntax(ipolicy, param)
887 if constants.ISPECS_DTS in ipolicy:
888 InstancePolicy.CheckDiskTemplates(ipolicy[constants.ISPECS_DTS])
889 wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
891 raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
892 utils.CommaJoin(wrong_keys))
895 def CheckISpecSyntax(cls, ipolicy, name):
896 """Check the instance policy for validity on a given key.
898 We check if the instance policy makes sense for a given key, that is
899 if ipolicy[min][name] <= ipolicy[std][name] <= ipolicy[max][name].
902 @param ipolicy: dictionary with min, max, std specs
904 @param name: what are the limits for
905 @raise errors.ConfigureError: when specs for given name are not valid
908 min_v = ipolicy[constants.ISPECS_MIN].get(name, 0)
909 std_v = ipolicy[constants.ISPECS_STD].get(name, min_v)
910 max_v = ipolicy[constants.ISPECS_MAX].get(name, std_v)
911 err = ("Invalid specification of min/max/std values for %s: %s/%s/%s" %
913 ipolicy[constants.ISPECS_MIN].get(name, "-"),
914 ipolicy[constants.ISPECS_MAX].get(name, "-"),
915 ipolicy[constants.ISPECS_STD].get(name, "-")))
916 if min_v > std_v or std_v > max_v:
917 raise errors.ConfigurationError(err)
920 def CheckDiskTemplates(cls, disk_templates):
921 """Checks the disk templates for validity.
924 wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
926 raise errors.ConfigurationError("Invalid disk template(s) %s" %
927 utils.CommaJoin(wrong))
930 class Instance(TaggableObject):
931 """Config object representing an instance."""
946 ] + _TIMESTAMPS + _UUID
948 def _ComputeSecondaryNodes(self):
949 """Compute the list of secondary nodes.
951 This is a simple wrapper over _ComputeAllNodes.
954 all_nodes = set(self._ComputeAllNodes())
955 all_nodes.discard(self.primary_node)
956 return tuple(all_nodes)
958 secondary_nodes = property(_ComputeSecondaryNodes, None, None,
959 "List of secondary nodes")
961 def _ComputeAllNodes(self):
962 """Compute the list of all nodes.
964 Since the data is already there (in the drbd disks), keeping it as
965 a separate normal attribute is redundant and if not properly
966 synchronised can cause problems. Thus it's better to compute it
970 def _Helper(nodes, device):
971 """Recursively computes nodes given a top device."""
972 if device.dev_type in constants.LDS_DRBD:
973 nodea, nodeb = device.logical_id[:2]
977 for child in device.children:
978 _Helper(nodes, child)
981 all_nodes.add(self.primary_node)
982 for device in self.disks:
983 _Helper(all_nodes, device)
984 return tuple(all_nodes)
986 all_nodes = property(_ComputeAllNodes, None, None,
987 "List of all nodes of the instance")
989 def MapLVsByNode(self, lvmap=None, devs=None, node=None):
990 """Provide a mapping of nodes to LVs this instance owns.
992 This function figures out what logical volumes should belong on
993 which nodes, recursing through a device tree.
995 @param lvmap: optional dictionary to receive the
996 'node' : ['lv', ...] data.
998 @return: None if lvmap arg is given, otherwise, a dictionary of
999 the form { 'nodename' : ['volume1', 'volume2', ...], ... };
1000 volumeN is of the form "vg_name/lv_name", compatible with
1005 node = self.primary_node
1013 if not node in lvmap:
1021 if dev.dev_type == constants.LD_LV:
1022 lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
1024 elif dev.dev_type in constants.LDS_DRBD:
1026 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
1027 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])
1030 self.MapLVsByNode(lvmap, dev.children, node)
1034 def FindDisk(self, idx):
1035 """Find a disk given having a specified index.
1037 This is just a wrapper that does validation of the index.
1040 @param idx: the disk index
1042 @return: the corresponding disk
1043 @raise errors.OpPrereqError: when the given index is not valid
1048 return self.disks[idx]
1049 except (TypeError, ValueError), err:
1050 raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
1053 raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1054 " 0 to %d" % (idx, len(self.disks) - 1),
1058 """Instance-specific conversion to standard python types.
1060 This replaces the children lists of objects with lists of standard
1064 bo = super(Instance, self).ToDict()
1066 for attr in "nics", "disks":
1067 alist = bo.get(attr, None)
1069 nlist = self._ContainerToDicts(alist)
1076 def FromDict(cls, val):
1077 """Custom function for instances.
1080 if "admin_state" not in val:
1081 if val.get("admin_up", False):
1082 val["admin_state"] = constants.ADMINST_UP
1084 val["admin_state"] = constants.ADMINST_DOWN
1085 if "admin_up" in val:
1087 obj = super(Instance, cls).FromDict(val)
1088 obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
1089 obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
1092 def UpgradeConfig(self):
1093 """Fill defaults for missing configuration values.
1096 for nic in self.nics:
1098 for disk in self.disks:
1099 disk.UpgradeConfig()
1101 for key in constants.HVC_GLOBALS:
1103 del self.hvparams[key]
1106 if self.osparams is None:
1108 UpgradeBeParams(self.beparams)
1111 class OS(ConfigObject):
1112 """Config object representing an operating system.
1114 @type supported_parameters: list
1115 @ivar supported_parameters: a list of tuples, name and description,
1116 containing the supported parameters by this OS
1118 @type VARIANT_DELIM: string
1119 @cvar VARIANT_DELIM: the variant delimiter
1131 "supported_variants",
1132 "supported_parameters",
1138 def SplitNameVariant(cls, name):
1139 """Splits the name into the proper name and variant.
1141 @param name: the OS (unprocessed) name
1143 @return: a list of two elements; if the original name didn't
1144 contain a variant, it's returned as an empty string
1147 nv = name.split(cls.VARIANT_DELIM, 1)
1153 def GetName(cls, name):
1154 """Returns the proper name of the os (without the variant).
1156 @param name: the OS (unprocessed) name
1159 return cls.SplitNameVariant(name)[0]
1162 def GetVariant(cls, name):
1163 """Returns the variant the os (without the base name).
1165 @param name: the OS (unprocessed) name
1168 return cls.SplitNameVariant(name)[1]
1171 class NodeHvState(ConfigObject):
1172 """Hypvervisor state on a node.
1174 @ivar mem_total: Total amount of memory
1175 @ivar mem_node: Memory used by, or reserved for, the node itself (not always
1177 @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation
1179 @ivar mem_inst: Memory used by instances living on node
1180 @ivar cpu_total: Total node CPU core count
1181 @ivar cpu_node: Number of CPU cores reserved for the node itself
1194 class NodeDiskState(ConfigObject):
1195 """Disk state on a node.
1205 class Node(TaggableObject):
1206 """Config object representing a node.
1208 @ivar hv_state: Hypervisor state (e.g. number of CPUs)
1209 @ivar hv_state_static: Hypervisor state overriden by user
1210 @ivar disk_state: Disk state (e.g. free space)
1211 @ivar disk_state_static: Disk state overriden by user
1230 "disk_state_static",
1231 ] + _TIMESTAMPS + _UUID
1233 def UpgradeConfig(self):
1234 """Fill defaults for missing configuration values.
1237 # pylint: disable=E0203
1238 # because these are "defined" via slots, not manually
1239 if self.master_capable is None:
1240 self.master_capable = True
1242 if self.vm_capable is None:
1243 self.vm_capable = True
1245 if self.ndparams is None:
1248 if self.powered is None:
1252 """Custom function for serializing.
1255 data = super(Node, self).ToDict()
1257 hv_state = data.get("hv_state", None)
1258 if hv_state is not None:
1259 data["hv_state"] = self._ContainerToDicts(hv_state)
1261 disk_state = data.get("disk_state", None)
1262 if disk_state is not None:
1263 data["disk_state"] = \
1264 dict((key, self._ContainerToDicts(value))
1265 for (key, value) in disk_state.items())
1270 def FromDict(cls, val):
1271 """Custom function for deserializing.
1274 obj = super(Node, cls).FromDict(val)
1276 if obj.hv_state is not None:
1277 obj.hv_state = cls._ContainerFromDicts(obj.hv_state, dict, NodeHvState)
1279 if obj.disk_state is not None:
1281 dict((key, cls._ContainerFromDicts(value, dict, NodeDiskState))
1282 for (key, value) in obj.disk_state.items())
1287 class NodeGroup(TaggableObject):
1288 """Config object representing a node group."""
1297 "disk_state_static",
1299 ] + _TIMESTAMPS + _UUID
1302 """Custom function for nodegroup.
1304 This discards the members object, which gets recalculated and is only kept
1308 mydict = super(NodeGroup, self).ToDict()
1309 del mydict["members"]
1313 def FromDict(cls, val):
1314 """Custom function for nodegroup.
1316 The members slot is initialized to an empty list, upon deserialization.
1319 obj = super(NodeGroup, cls).FromDict(val)
1323 def UpgradeConfig(self):
1324 """Fill defaults for missing configuration values.
1327 if self.ndparams is None:
1330 if self.serial_no is None:
1333 if self.alloc_policy is None:
1334 self.alloc_policy = constants.ALLOC_POLICY_PREFERRED
1336 # We only update mtime, and not ctime, since we would not be able
1337 # to provide a correct value for creation time.
1338 if self.mtime is None:
1339 self.mtime = time.time()
1341 self.diskparams = UpgradeDiskParams(self.diskparams)
1342 if self.ipolicy is None:
1343 self.ipolicy = MakeEmptyIPolicy()
1345 def FillND(self, node):
1346 """Return filled out ndparams for L{objects.Node}
1348 @type node: L{objects.Node}
1349 @param node: A Node object to fill
1350 @return a copy of the node's ndparams with defaults filled
1353 return self.SimpleFillND(node.ndparams)
1355 def SimpleFillND(self, ndparams):
1356 """Fill a given ndparams dict with defaults.
1358 @type ndparams: dict
1359 @param ndparams: the dict to fill
1361 @return: a copy of the passed in ndparams with missing keys filled
1362 from the node group defaults
1365 return FillDict(self.ndparams, ndparams)
1368 class Cluster(TaggableObject):
1369 """Config object representing the cluster."""
1373 "highest_used_port",
1376 "volume_group_name",
1378 "drbd_usermode_helper",
1380 "default_hypervisor",
1385 "use_external_mip_script",
1388 "shared_file_storage_dir",
1389 "enabled_hypervisors",
1398 "candidate_pool_size",
1401 "maintain_node_health",
1403 "default_iallocator",
1406 "primary_ip_family",
1407 "prealloc_wipe_disks",
1409 "disk_state_static",
1410 ] + _TIMESTAMPS + _UUID
1412 def UpgradeConfig(self):
1413 """Fill defaults for missing configuration values.
1416 # pylint: disable=E0203
1417 # because these are "defined" via slots, not manually
1418 if self.hvparams is None:
1419 self.hvparams = constants.HVC_DEFAULTS
1421 for hypervisor in self.hvparams:
1422 self.hvparams[hypervisor] = FillDict(
1423 constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])
1425 if self.os_hvp is None:
1428 # osparams added before 2.2
1429 if self.osparams is None:
1432 if self.ndparams is None:
1433 self.ndparams = constants.NDC_DEFAULTS
1435 self.beparams = UpgradeGroupedParams(self.beparams,
1436 constants.BEC_DEFAULTS)
1437 for beparams_group in self.beparams:
1438 UpgradeBeParams(self.beparams[beparams_group])
1440 migrate_default_bridge = not self.nicparams
1441 self.nicparams = UpgradeGroupedParams(self.nicparams,
1442 constants.NICC_DEFAULTS)
1443 if migrate_default_bridge:
1444 self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
1447 if self.modify_etc_hosts is None:
1448 self.modify_etc_hosts = True
1450 if self.modify_ssh_setup is None:
1451 self.modify_ssh_setup = True
1453 # default_bridge is no longer used in 2.1. The slot is left there to
1454 # support auto-upgrading. It can be removed once we decide to deprecate
1455 # upgrading straight from 2.0.
1456 if self.default_bridge is not None:
1457 self.default_bridge = None
1459 # default_hypervisor is just the first enabled one in 2.1. This slot and
1460 # code can be removed once upgrading straight from 2.0 is deprecated.
1461 if self.default_hypervisor is not None:
1462 self.enabled_hypervisors = ([self.default_hypervisor] +
1463 [hvname for hvname in self.enabled_hypervisors
1464 if hvname != self.default_hypervisor])
1465 self.default_hypervisor = None
1467 # maintain_node_health added after 2.1.1
1468 if self.maintain_node_health is None:
1469 self.maintain_node_health = False
1471 if self.uid_pool is None:
1474 if self.default_iallocator is None:
1475 self.default_iallocator = ""
1477 # reserved_lvs added before 2.2
1478 if self.reserved_lvs is None:
1479 self.reserved_lvs = []
1481 # hidden and blacklisted operating systems added before 2.2.1
1482 if self.hidden_os is None:
1485 if self.blacklisted_os is None:
1486 self.blacklisted_os = []
1488 # primary_ip_family added before 2.3
1489 if self.primary_ip_family is None:
1490 self.primary_ip_family = AF_INET
1492 if self.master_netmask is None:
1493 ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
1494 self.master_netmask = ipcls.iplen
1496 if self.prealloc_wipe_disks is None:
1497 self.prealloc_wipe_disks = False
1499 # shared_file_storage_dir added before 2.5
1500 if self.shared_file_storage_dir is None:
1501 self.shared_file_storage_dir = ""
1503 if self.use_external_mip_script is None:
1504 self.use_external_mip_script = False
1506 self.diskparams = UpgradeDiskParams(self.diskparams)
1508 # instance policy added before 2.6
1509 if self.ipolicy is None:
1510 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, {})
1513 def primary_hypervisor(self):
1514 """The first hypervisor is the primary.
1516 Useful, for example, for L{Node}'s hv/disk state.
1519 return self.enabled_hypervisors[0]
1522 """Custom function for cluster.
1525 mydict = super(Cluster, self).ToDict()
1526 mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
1530 def FromDict(cls, val):
1531 """Custom function for cluster.
1534 obj = super(Cluster, cls).FromDict(val)
1535 if not isinstance(obj.tcpudp_port_pool, set):
1536 obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
1539 def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
1540 """Get the default hypervisor parameters for the cluster.
1542 @param hypervisor: the hypervisor name
1543 @param os_name: if specified, we'll also update the defaults for this OS
1544 @param skip_keys: if passed, list of keys not to use
1545 @return: the defaults dict
1548 if skip_keys is None:
1551 fill_stack = [self.hvparams.get(hypervisor, {})]
1552 if os_name is not None:
1553 os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
1554 fill_stack.append(os_hvp)
1557 for o_dict in fill_stack:
1558 ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)
1562 def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
1563 """Fill a given hvparams dict with cluster defaults.
1565 @type hv_name: string
1566 @param hv_name: the hypervisor to use
1567 @type os_name: string
1568 @param os_name: the OS to use for overriding the hypervisor defaults
1569 @type skip_globals: boolean
1570 @param skip_globals: if True, the global hypervisor parameters will
1573 @return: a copy of the given hvparams with missing keys filled from
1574 the cluster defaults
1578 skip_keys = constants.HVC_GLOBALS
1582 def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
1583 return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1585 def FillHV(self, instance, skip_globals=False):
1586 """Fill an instance's hvparams dict with cluster defaults.
1588 @type instance: L{objects.Instance}
1589 @param instance: the instance parameter to fill
1590 @type skip_globals: boolean
1591 @param skip_globals: if True, the global hypervisor parameters will
1594 @return: a copy of the instance's hvparams with missing keys filled from
1595 the cluster defaults
1598 return self.SimpleFillHV(instance.hypervisor, instance.os,
1599 instance.hvparams, skip_globals)
1601 def SimpleFillBE(self, beparams):
1602 """Fill a given beparams dict with cluster defaults.
1604 @type beparams: dict
1605 @param beparams: the dict to fill
1607 @return: a copy of the passed in beparams with missing keys filled
1608 from the cluster defaults
1611 return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1613 def FillBE(self, instance):
1614 """Fill an instance's beparams dict with cluster defaults.
1616 @type instance: L{objects.Instance}
1617 @param instance: the instance parameter to fill
1619 @return: a copy of the instance's beparams with missing keys filled from
1620 the cluster defaults
1623 return self.SimpleFillBE(instance.beparams)
1625 def SimpleFillNIC(self, nicparams):
1626 """Fill a given nicparams dict with cluster defaults.
1628 @type nicparams: dict
1629 @param nicparams: the dict to fill
1631 @return: a copy of the passed in nicparams with missing keys filled
1632 from the cluster defaults
1635 return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1637 def SimpleFillOS(self, os_name, os_params):
1638 """Fill an instance's osparams dict with cluster defaults.
1640 @type os_name: string
1641 @param os_name: the OS name to use
1642 @type os_params: dict
1643 @param os_params: the dict to fill with default values
1645 @return: a copy of the instance's osparams with missing keys filled from
1646 the cluster defaults
1649 name_only = os_name.split("+", 1)[0]
1651 result = self.osparams.get(name_only, {})
1653 result = FillDict(result, self.osparams.get(os_name, {}))
1655 return FillDict(result, os_params)
1658 def SimpleFillHvState(hv_state):
1659 """Fill an hv_state sub dict with cluster defaults.
1662 return FillDict(constants.HVST_DEFAULTS, hv_state)
1665 def SimpleFillDiskState(disk_state):
1666 """Fill an disk_state sub dict with cluster defaults.
1669 return FillDict(constants.DS_DEFAULTS, disk_state)
1671 def FillND(self, node, nodegroup):
1672 """Return filled out ndparams for L{objects.NodeGroup} and L{objects.Node}
1674 @type node: L{objects.Node}
1675 @param node: A Node object to fill
1676 @type nodegroup: L{objects.NodeGroup}
1677 @param nodegroup: A Node object to fill
1678 @return a copy of the node's ndparams with defaults filled
1681 return self.SimpleFillND(nodegroup.FillND(node))
1683 def SimpleFillND(self, ndparams):
1684 """Fill a given ndparams dict with defaults.
1686 @type ndparams: dict
1687 @param ndparams: the dict to fill
1689 @return: a copy of the passed in ndparams with missing keys filled
1690 from the cluster defaults
1693 return FillDict(self.ndparams, ndparams)
1695 def SimpleFillIPolicy(self, ipolicy):
1696 """ Fill instance policy dict with defaults.
1699 @param ipolicy: the dict to fill
1701 @return: a copy of passed ipolicy with missing keys filled from
1702 the cluster defaults
1705 return FillIPolicy(self.ipolicy, ipolicy)
1708 class BlockDevStatus(ConfigObject):
1709 """Config object representing the status of a block device."""
1721 class ImportExportStatus(ConfigObject):
1722 """Config object representing the status of an import or export."""
1728 "progress_throughput",
1736 class ImportExportOptions(ConfigObject):
1737 """Options for import/export daemon
1739 @ivar key_name: X509 key name (None for cluster certificate)
1740 @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1741 @ivar compress: Compression method (one of L{constants.IEC_ALL})
1742 @ivar magic: Used to ensure the connection goes to the right disk
1743 @ivar ipv6: Whether to use IPv6
1744 @ivar connect_timeout: Number of seconds for establishing connection
1757 class ConfdRequest(ConfigObject):
1758 """Object holding a confd request.
1760 @ivar protocol: confd protocol version
1761 @ivar type: confd query type
1762 @ivar query: query request
1763 @ivar rsalt: requested reply salt
1774 class ConfdReply(ConfigObject):
1775 """Object holding a confd reply.
1777 @ivar protocol: confd protocol version
1778 @ivar status: reply status code (ok, error)
1779 @ivar answer: confd query reply
1780 @ivar serial: configuration serial number
1791 class QueryFieldDefinition(ConfigObject):
1792 """Object holding a query field definition.
1794 @ivar name: Field name
1795 @ivar title: Human-readable title
1796 @ivar kind: Field type
1797 @ivar doc: Human-readable description
1808 class _QueryResponseBase(ConfigObject):
1814 """Custom function for serializing.
1817 mydict = super(_QueryResponseBase, self).ToDict()
1818 mydict["fields"] = self._ContainerToDicts(mydict["fields"])
1822 def FromDict(cls, val):
1823 """Custom function for de-serializing.
1826 obj = super(_QueryResponseBase, cls).FromDict(val)
1827 obj.fields = cls._ContainerFromDicts(obj.fields, list, QueryFieldDefinition)
1831 class QueryRequest(ConfigObject):
1832 """Object holding a query request.
1842 class QueryResponse(_QueryResponseBase):
1843 """Object holding the response to a query.
1845 @ivar fields: List of L{QueryFieldDefinition} objects
1846 @ivar data: Requested data
1854 class QueryFieldsRequest(ConfigObject):
1855 """Object holding a request for querying available fields.
1864 class QueryFieldsResponse(_QueryResponseBase):
1865 """Object holding the response to a query for fields.
1867 @ivar fields: List of L{QueryFieldDefinition} objects
1874 class MigrationStatus(ConfigObject):
1875 """Object holding the status of a migration.
1885 class InstanceConsole(ConfigObject):
1886 """Object describing how to access the console of an instance.
1901 """Validates contents of this object.
1904 assert self.kind in constants.CONS_ALL, "Unknown console type"
1905 assert self.instance, "Missing instance name"
1906 assert self.message or self.kind in [constants.CONS_SSH,
1907 constants.CONS_SPICE,
1909 assert self.host or self.kind == constants.CONS_MESSAGE
1910 assert self.port or self.kind in [constants.CONS_MESSAGE,
1912 assert self.user or self.kind in [constants.CONS_MESSAGE,
1913 constants.CONS_SPICE,
1915 assert self.command or self.kind in [constants.CONS_MESSAGE,
1916 constants.CONS_SPICE,
1918 assert self.display or self.kind in [constants.CONS_MESSAGE,
1919 constants.CONS_SPICE,
1924 class SerializableConfigParser(ConfigParser.SafeConfigParser):
1925 """Simple wrapper over ConfigParse that allows serialization.
1927 This class is basically ConfigParser.SafeConfigParser with two
1928 additional methods that allow it to serialize/unserialize to/from a
1933 """Dump this instance and return the string representation."""
1936 return buf.getvalue()
1939 def Loads(cls, data):
1940 """Load data from a string."""
1941 buf = StringIO(data)