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",
493 "nicparams", "netinfo", "pci"] + _UUID
496 def CheckParameterSyntax(cls, nicparams):
497 """Check the given parameters for validity.
499 @type nicparams: dict
500 @param nicparams: dictionary with parameter names/value
501 @raise errors.ConfigurationError: when a parameter is not valid
504 mode = nicparams[constants.NIC_MODE]
505 if (mode not in constants.NIC_VALID_MODES and
506 mode != constants.VALUE_AUTO):
507 raise errors.ConfigurationError("Invalid NIC mode '%s'" % mode)
509 if (mode == constants.NIC_MODE_BRIDGED and
510 not nicparams[constants.NIC_LINK]):
511 raise errors.ConfigurationError("Missing bridged NIC link")
514 class Disk(ConfigObject):
515 """Config object representing a block device."""
516 __slots__ = ["name", "dev_type", "logical_id", "physical_id",
517 "children", "iv_name", "size", "mode", "params", "pci"] + _UUID
519 def CreateOnSecondary(self):
520 """Test if this device needs to be created on a secondary node."""
521 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
523 def AssembleOnSecondary(self):
524 """Test if this device needs to be assembled on a secondary node."""
525 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
527 def OpenOnSecondary(self):
528 """Test if this device needs to be opened on a secondary node."""
529 return self.dev_type in (constants.LD_LV,)
531 def StaticDevPath(self):
532 """Return the device path if this device type has a static one.
534 Some devices (LVM for example) live always at the same /dev/ path,
535 irrespective of their status. For such devices, we return this
536 path, for others we return None.
538 @warning: The path returned is not a normalized pathname; callers
539 should check that it is a valid path.
542 if self.dev_type == constants.LD_LV:
543 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
544 elif self.dev_type == constants.LD_BLOCKDEV:
545 return self.logical_id[1]
546 elif self.dev_type == constants.LD_RBD:
547 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
550 def ChildrenNeeded(self):
551 """Compute the needed number of children for activation.
553 This method will return either -1 (all children) or a positive
554 number denoting the minimum number of children needed for
555 activation (only mirrored devices will usually return >=0).
557 Currently, only DRBD8 supports diskless activation (therefore we
558 return 0), for all other we keep the previous semantics and return
562 if self.dev_type == constants.LD_DRBD8:
566 def IsBasedOnDiskType(self, dev_type):
567 """Check if the disk or its children are based on the given type.
569 @type dev_type: L{constants.LDS_BLOCK}
570 @param dev_type: the type to look for
572 @return: boolean indicating if a device of the given type was found or not
576 for child in self.children:
577 if child.IsBasedOnDiskType(dev_type):
579 return self.dev_type == dev_type
581 def GetNodes(self, node):
582 """This function returns the nodes this device lives on.
584 Given the node on which the parent of the device lives on (or, in
585 case of a top-level device, the primary node of the devices'
586 instance), this function will return a list of nodes on which this
587 devices needs to (or can) be assembled.
590 if self.dev_type in [constants.LD_LV, constants.LD_FILE,
591 constants.LD_BLOCKDEV, constants.LD_RBD,
594 elif self.dev_type in constants.LDS_DRBD:
595 result = [self.logical_id[0], self.logical_id[1]]
596 if node not in result:
597 raise errors.ConfigurationError("DRBD device passed unknown node")
599 raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
602 def ComputeNodeTree(self, parent_node):
603 """Compute the node/disk tree for this disk and its children.
605 This method, given the node on which the parent disk lives, will
606 return the list of all (node, disk) pairs which describe the disk
607 tree in the most compact way. For example, a drbd/lvm stack
608 will be returned as (primary_node, drbd) and (secondary_node, drbd)
609 which represents all the top-level devices on the nodes.
612 my_nodes = self.GetNodes(parent_node)
613 result = [(node, self) for node in my_nodes]
614 if not self.children:
617 for node in my_nodes:
618 for child in self.children:
619 child_result = child.ComputeNodeTree(node)
620 if len(child_result) == 1:
621 # child (and all its descendants) is simple, doesn't split
622 # over multiple hosts, so we don't need to describe it, our
623 # own entry for this node describes it completely
626 # check if child nodes differ from my nodes; note that
627 # subdisk can differ from the child itself, and be instead
628 # one of its descendants
629 for subnode, subdisk in child_result:
630 if subnode not in my_nodes:
631 result.append((subnode, subdisk))
632 # otherwise child is under our own node, so we ignore this
633 # entry (but probably the other results in the list will
637 def ComputeGrowth(self, amount):
638 """Compute the per-VG growth requirements.
640 This only works for VG-based disks.
642 @type amount: integer
643 @param amount: the desired increase in (user-visible) disk space
645 @return: a dictionary of volume-groups and the required size
648 if self.dev_type == constants.LD_LV:
649 return {self.logical_id[0]: amount}
650 elif self.dev_type == constants.LD_DRBD8:
652 return self.children[0].ComputeGrowth(amount)
656 # Other disk types do not require VG space
659 def RecordGrow(self, amount):
660 """Update the size of this disk after growth.
662 This method recurses over the disks's children and updates their
663 size correspondigly. The method needs to be kept in sync with the
664 actual algorithms from bdev.
667 if self.dev_type in (constants.LD_LV, constants.LD_FILE,
668 constants.LD_RBD, constants.LD_EXT):
670 elif self.dev_type == constants.LD_DRBD8:
672 self.children[0].RecordGrow(amount)
675 raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
676 " disk type %s" % self.dev_type)
678 def Update(self, size=None, mode=None):
679 """Apply changes to size and mode.
682 if self.dev_type == constants.LD_DRBD8:
684 self.children[0].Update(size=size, mode=mode)
686 assert not self.children
694 """Sets recursively the size to zero for the disk and its children.
698 for child in self.children:
702 def SetPhysicalID(self, target_node, nodes_ip):
703 """Convert the logical ID to the physical ID.
705 This is used only for drbd, which needs ip/port configuration.
707 The routine descends down and updates its children also, because
708 this helps when the only the top device is passed to the remote
712 - target_node: the node we wish to configure for
713 - nodes_ip: a mapping of node name to ip
715 The target_node must exist in in nodes_ip, and must be one of the
716 nodes in the logical ID for each of the DRBD devices encountered
721 for child in self.children:
722 child.SetPhysicalID(target_node, nodes_ip)
724 if self.logical_id is None and self.physical_id is not None:
726 if self.dev_type in constants.LDS_DRBD:
727 pnode, snode, port, pminor, sminor, secret = self.logical_id
728 if target_node not in (pnode, snode):
729 raise errors.ConfigurationError("DRBD device not knowing node %s" %
731 pnode_ip = nodes_ip.get(pnode, None)
732 snode_ip = nodes_ip.get(snode, None)
733 if pnode_ip is None or snode_ip is None:
734 raise errors.ConfigurationError("Can't find primary or secondary node"
735 " for %s" % str(self))
736 p_data = (pnode_ip, port)
737 s_data = (snode_ip, port)
738 if pnode == target_node:
739 self.physical_id = p_data + s_data + (pminor, secret)
740 else: # it must be secondary, we tested above
741 self.physical_id = s_data + p_data + (sminor, secret)
743 self.physical_id = self.logical_id
747 """Disk-specific conversion to standard python types.
749 This replaces the children lists of objects with lists of
750 standard python types.
753 bo = super(Disk, self).ToDict()
755 for attr in ("children",):
756 alist = bo.get(attr, None)
758 bo[attr] = outils.ContainerToDicts(alist)
762 def FromDict(cls, val):
763 """Custom function for Disks
766 obj = super(Disk, cls).FromDict(val)
768 obj.children = outils.ContainerFromDicts(obj.children, list, Disk)
769 if obj.logical_id and isinstance(obj.logical_id, list):
770 obj.logical_id = tuple(obj.logical_id)
771 if obj.physical_id and isinstance(obj.physical_id, list):
772 obj.physical_id = tuple(obj.physical_id)
773 if obj.dev_type in constants.LDS_DRBD:
774 # we need a tuple of length six here
775 if len(obj.logical_id) < 6:
776 obj.logical_id += (None,) * (6 - len(obj.logical_id))
780 """Custom str() formatter for disks.
783 if self.dev_type == constants.LD_LV:
784 val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
785 elif self.dev_type in constants.LDS_DRBD:
786 node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
788 if self.physical_id is None:
791 phy = ("configured as %s:%s %s:%s" %
792 (self.physical_id[0], self.physical_id[1],
793 self.physical_id[2], self.physical_id[3]))
795 val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
796 (node_a, minor_a, node_b, minor_b, port, phy))
797 if self.children and self.children.count(None) == 0:
798 val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
800 val += "no local storage"
802 val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
803 (self.dev_type, self.logical_id, self.physical_id, self.children))
804 if self.iv_name is None:
805 val += ", not visible"
807 val += ", visible as /dev/%s" % self.iv_name
808 if isinstance(self.size, int):
809 val += ", size=%dm)>" % self.size
811 val += ", size='%s')>" % (self.size,)
815 """Checks that this disk is correctly configured.
819 if self.mode not in constants.DISK_ACCESS_SET:
820 all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
823 def UpgradeConfig(self):
824 """Fill defaults for missing configuration values.
828 for child in self.children:
829 child.UpgradeConfig()
831 # FIXME: Make this configurable in Ganeti 2.7
833 # add here config upgrade for this disk
836 def ComputeLDParams(disk_template, disk_params):
837 """Computes Logical Disk parameters from Disk Template parameters.
839 @type disk_template: string
840 @param disk_template: disk template, one of L{constants.DISK_TEMPLATES}
841 @type disk_params: dict
842 @param disk_params: disk template parameters;
843 dict(template_name -> parameters
845 @return: a list of dicts, one for each node of the disk hierarchy. Each dict
846 contains the LD parameters of the node. The tree is flattened in-order.
849 if disk_template not in constants.DISK_TEMPLATES:
850 raise errors.ProgrammerError("Unknown disk template %s" % disk_template)
852 assert disk_template in disk_params
855 dt_params = disk_params[disk_template]
856 if disk_template == constants.DT_DRBD8:
857 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], {
858 constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE],
859 constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS],
860 constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS],
861 constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG],
862 constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM],
863 constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM],
864 constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC],
865 constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD],
866 constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET],
867 constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET],
868 constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE],
869 constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE],
873 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
874 constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
878 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
879 constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
882 elif disk_template in (constants.DT_FILE, constants.DT_SHARED_FILE):
883 result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE])
885 elif disk_template == constants.DT_PLAIN:
886 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
887 constants.LDP_STRIPES: dt_params[constants.LV_STRIPES],
890 elif disk_template == constants.DT_BLOCK:
891 result.append(constants.DISK_LD_DEFAULTS[constants.LD_BLOCKDEV])
893 elif disk_template == constants.DT_RBD:
894 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], {
895 constants.LDP_POOL: dt_params[constants.RBD_POOL],
898 elif disk_template == constants.DT_EXT:
899 result.append(constants.DISK_LD_DEFAULTS[constants.LD_EXT])
904 class InstancePolicy(ConfigObject):
905 """Config object representing instance policy limits dictionary.
907 Note that this object is not actually used in the config, it's just
908 used as a placeholder for a few functions.
912 def CheckParameterSyntax(cls, ipolicy, check_std):
913 """ Check the instance policy for validity.
916 @param ipolicy: dictionary with min/max/std specs and policies
917 @type check_std: bool
918 @param check_std: Whether to check std value or just assume compliance
919 @raise errors.ConfigurationError: when the policy is not legal
922 InstancePolicy.CheckISpecSyntax(ipolicy, check_std)
923 if constants.IPOLICY_DTS in ipolicy:
924 InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
925 for key in constants.IPOLICY_PARAMETERS:
927 InstancePolicy.CheckParameter(key, ipolicy[key])
928 wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
930 raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
931 utils.CommaJoin(wrong_keys))
934 def _CheckIncompleteSpec(cls, spec, keyname):
935 missing_params = constants.ISPECS_PARAMETERS - frozenset(spec.keys())
937 msg = ("Missing instance specs parameters for %s: %s" %
938 (keyname, utils.CommaJoin(missing_params)))
939 raise errors.ConfigurationError(msg)
942 def CheckISpecSyntax(cls, ipolicy, check_std):
943 """Check the instance policy specs for validity.
946 @param ipolicy: dictionary with min/max/std specs
947 @type check_std: bool
948 @param check_std: Whether to check std value or just assume compliance
949 @raise errors.ConfigurationError: when specs are not valid
952 if constants.ISPECS_MINMAX not in ipolicy:
956 if check_std and constants.ISPECS_STD not in ipolicy:
957 msg = "Missing key in ipolicy: %s" % constants.ISPECS_STD
958 raise errors.ConfigurationError(msg)
959 stdspec = ipolicy.get(constants.ISPECS_STD)
961 InstancePolicy._CheckIncompleteSpec(stdspec, constants.ISPECS_STD)
963 if not ipolicy[constants.ISPECS_MINMAX]:
964 raise errors.ConfigurationError("Empty minmax specifications")
966 for minmaxspecs in ipolicy[constants.ISPECS_MINMAX]:
967 missing = constants.ISPECS_MINMAX_KEYS - frozenset(minmaxspecs.keys())
969 msg = "Missing instance specification: %s" % utils.CommaJoin(missing)
970 raise errors.ConfigurationError(msg)
971 for (key, spec) in minmaxspecs.items():
972 InstancePolicy._CheckIncompleteSpec(spec, key)
975 for param in constants.ISPECS_PARAMETERS:
976 par_std_ok = InstancePolicy._CheckISpecParamSyntax(minmaxspecs, stdspec,
978 spec_std_ok = spec_std_ok and par_std_ok
979 std_is_good = std_is_good or spec_std_ok
981 raise errors.ConfigurationError("Invalid std specifications")
984 def _CheckISpecParamSyntax(cls, minmaxspecs, stdspec, name, check_std):
985 """Check the instance policy specs for validity on a given key.
987 We check if the instance specs makes sense for a given key, that is
988 if minmaxspecs[min][name] <= stdspec[name] <= minmaxspec[max][name].
990 @type minmaxspecs: dict
991 @param minmaxspecs: dictionary with min and max instance spec
993 @param stdspec: dictionary with standard instance spec
995 @param name: what are the limits for
996 @type check_std: bool
997 @param check_std: Whether to check std value or just assume compliance
999 @return: C{True} when specs are valid, C{False} when standard spec for the
1000 given name is not valid
1001 @raise errors.ConfigurationError: when min/max specs for the given name
1005 minspec = minmaxspecs[constants.ISPECS_MIN]
1006 maxspec = minmaxspecs[constants.ISPECS_MAX]
1007 min_v = minspec[name]
1008 max_v = maxspec[name]
1011 err = ("Invalid specification of min/max values for %s: %s/%s" %
1012 (name, min_v, max_v))
1013 raise errors.ConfigurationError(err)
1015 std_v = stdspec.get(name, min_v)
1016 return std_v >= min_v and std_v <= max_v
1021 def CheckDiskTemplates(cls, disk_templates):
1022 """Checks the disk templates for validity.
1025 if not disk_templates:
1026 raise errors.ConfigurationError("Instance policy must contain" +
1027 " at least one disk template")
1028 wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
1030 raise errors.ConfigurationError("Invalid disk template(s) %s" %
1031 utils.CommaJoin(wrong))
1034 def CheckParameter(cls, key, value):
1035 """Checks a parameter.
1037 Currently we expect all parameters to be float values.
1042 except (TypeError, ValueError), err:
1043 raise errors.ConfigurationError("Invalid value for key" " '%s':"
1044 " '%s', error: %s" % (key, value, err))
1047 class Instance(TaggableObject):
1048 """Config object representing an instance."""
1064 ] + _TIMESTAMPS + _UUID
1066 def _ComputeSecondaryNodes(self):
1067 """Compute the list of secondary nodes.
1069 This is a simple wrapper over _ComputeAllNodes.
1072 all_nodes = set(self._ComputeAllNodes())
1073 all_nodes.discard(self.primary_node)
1074 return tuple(all_nodes)
1076 secondary_nodes = property(_ComputeSecondaryNodes, None, None,
1077 "List of names of secondary nodes")
1079 def _ComputeAllNodes(self):
1080 """Compute the list of all nodes.
1082 Since the data is already there (in the drbd disks), keeping it as
1083 a separate normal attribute is redundant and if not properly
1084 synchronised can cause problems. Thus it's better to compute it
1088 def _Helper(nodes, device):
1089 """Recursively computes nodes given a top device."""
1090 if device.dev_type in constants.LDS_DRBD:
1091 nodea, nodeb = device.logical_id[:2]
1095 for child in device.children:
1096 _Helper(nodes, child)
1099 all_nodes.add(self.primary_node)
1100 for device in self.disks:
1101 _Helper(all_nodes, device)
1102 return tuple(all_nodes)
1104 all_nodes = property(_ComputeAllNodes, None, None,
1105 "List of names of all the nodes of the instance")
1107 def MapLVsByNode(self, lvmap=None, devs=None, node=None):
1108 """Provide a mapping of nodes to LVs this instance owns.
1110 This function figures out what logical volumes should belong on
1111 which nodes, recursing through a device tree.
1113 @param lvmap: optional dictionary to receive the
1114 'node' : ['lv', ...] data.
1116 @return: None if lvmap arg is given, otherwise, a dictionary of
1117 the form { 'nodename' : ['volume1', 'volume2', ...], ... };
1118 volumeN is of the form "vg_name/lv_name", compatible with
1123 node = self.primary_node
1131 if not node in lvmap:
1139 if dev.dev_type == constants.LD_LV:
1140 lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
1142 elif dev.dev_type in constants.LDS_DRBD:
1144 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
1145 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])
1148 self.MapLVsByNode(lvmap, dev.children, node)
1152 def FindDisk(self, idx):
1153 """Find a disk given having a specified index.
1155 This is just a wrapper that does validation of the index.
1158 @param idx: the disk index
1160 @return: the corresponding disk
1161 @raise errors.OpPrereqError: when the given index is not valid
1166 return self.disks[idx]
1167 except (TypeError, ValueError), err:
1168 raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
1171 raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1172 " 0 to %d" % (idx, len(self.disks) - 1),
1176 """Instance-specific conversion to standard python types.
1178 This replaces the children lists of objects with lists of standard
1182 bo = super(Instance, self).ToDict()
1184 for attr in "nics", "disks":
1185 alist = bo.get(attr, None)
1187 nlist = outils.ContainerToDicts(alist)
1194 def FromDict(cls, val):
1195 """Custom function for instances.
1198 if "admin_state" not in val:
1199 if val.get("admin_up", False):
1200 val["admin_state"] = constants.ADMINST_UP
1202 val["admin_state"] = constants.ADMINST_DOWN
1203 if "admin_up" in val:
1205 obj = super(Instance, cls).FromDict(val)
1206 obj.nics = outils.ContainerFromDicts(obj.nics, list, NIC)
1207 obj.disks = outils.ContainerFromDicts(obj.disks, list, Disk)
1210 def UpgradeConfig(self):
1211 """Fill defaults for missing configuration values.
1214 for nic in self.nics:
1216 for disk in self.disks:
1217 disk.UpgradeConfig()
1219 for key in constants.HVC_GLOBALS:
1221 del self.hvparams[key]
1224 if self.osparams is None:
1226 UpgradeBeParams(self.beparams)
1227 if self.disks_active is None:
1228 self.disks_active = self.admin_state == constants.ADMINST_UP
1231 class OS(ConfigObject):
1232 """Config object representing an operating system.
1234 @type supported_parameters: list
1235 @ivar supported_parameters: a list of tuples, name and description,
1236 containing the supported parameters by this OS
1238 @type VARIANT_DELIM: string
1239 @cvar VARIANT_DELIM: the variant delimiter
1251 "supported_variants",
1252 "supported_parameters",
1258 def SplitNameVariant(cls, name):
1259 """Splits the name into the proper name and variant.
1261 @param name: the OS (unprocessed) name
1263 @return: a list of two elements; if the original name didn't
1264 contain a variant, it's returned as an empty string
1267 nv = name.split(cls.VARIANT_DELIM, 1)
1273 def GetName(cls, name):
1274 """Returns the proper name of the os (without the variant).
1276 @param name: the OS (unprocessed) name
1279 return cls.SplitNameVariant(name)[0]
1282 def GetVariant(cls, name):
1283 """Returns the variant the os (without the base name).
1285 @param name: the OS (unprocessed) name
1288 return cls.SplitNameVariant(name)[1]
1291 class ExtStorage(ConfigObject):
1292 """Config object representing an External Storage Provider.
1305 "supported_parameters",
1309 class NodeHvState(ConfigObject):
1310 """Hypvervisor state on a node.
1312 @ivar mem_total: Total amount of memory
1313 @ivar mem_node: Memory used by, or reserved for, the node itself (not always
1315 @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation
1317 @ivar mem_inst: Memory used by instances living on node
1318 @ivar cpu_total: Total node CPU core count
1319 @ivar cpu_node: Number of CPU cores reserved for the node itself
1332 class NodeDiskState(ConfigObject):
1333 """Disk state on a node.
1343 class Node(TaggableObject):
1344 """Config object representing a node.
1346 @ivar hv_state: Hypervisor state (e.g. number of CPUs)
1347 @ivar hv_state_static: Hypervisor state overriden by user
1348 @ivar disk_state: Disk state (e.g. free space)
1349 @ivar disk_state_static: Disk state overriden by user
1368 "disk_state_static",
1369 ] + _TIMESTAMPS + _UUID
1371 def UpgradeConfig(self):
1372 """Fill defaults for missing configuration values.
1375 # pylint: disable=E0203
1376 # because these are "defined" via slots, not manually
1377 if self.master_capable is None:
1378 self.master_capable = True
1380 if self.vm_capable is None:
1381 self.vm_capable = True
1383 if self.ndparams is None:
1385 # And remove any global parameter
1386 for key in constants.NDC_GLOBALS:
1387 if key in self.ndparams:
1388 logging.warning("Ignoring %s node parameter for node %s",
1390 del self.ndparams[key]
1392 if self.powered is None:
1396 """Custom function for serializing.
1399 data = super(Node, self).ToDict()
1401 hv_state = data.get("hv_state", None)
1402 if hv_state is not None:
1403 data["hv_state"] = outils.ContainerToDicts(hv_state)
1405 disk_state = data.get("disk_state", None)
1406 if disk_state is not None:
1407 data["disk_state"] = \
1408 dict((key, outils.ContainerToDicts(value))
1409 for (key, value) in disk_state.items())
1414 def FromDict(cls, val):
1415 """Custom function for deserializing.
1418 obj = super(Node, cls).FromDict(val)
1420 if obj.hv_state is not None:
1422 outils.ContainerFromDicts(obj.hv_state, dict, NodeHvState)
1424 if obj.disk_state is not None:
1426 dict((key, outils.ContainerFromDicts(value, dict, NodeDiskState))
1427 for (key, value) in obj.disk_state.items())
1432 class NodeGroup(TaggableObject):
1433 """Config object representing a node group."""
1442 "disk_state_static",
1445 ] + _TIMESTAMPS + _UUID
1448 """Custom function for nodegroup.
1450 This discards the members object, which gets recalculated and is only kept
1454 mydict = super(NodeGroup, self).ToDict()
1455 del mydict["members"]
1459 def FromDict(cls, val):
1460 """Custom function for nodegroup.
1462 The members slot is initialized to an empty list, upon deserialization.
1465 obj = super(NodeGroup, cls).FromDict(val)
1469 def UpgradeConfig(self):
1470 """Fill defaults for missing configuration values.
1473 if self.ndparams is None:
1476 if self.serial_no is None:
1479 if self.alloc_policy is None:
1480 self.alloc_policy = constants.ALLOC_POLICY_PREFERRED
1482 # We only update mtime, and not ctime, since we would not be able
1483 # to provide a correct value for creation time.
1484 if self.mtime is None:
1485 self.mtime = time.time()
1487 if self.diskparams is None:
1488 self.diskparams = {}
1489 if self.ipolicy is None:
1490 self.ipolicy = MakeEmptyIPolicy()
1492 if self.networks is None:
1495 def FillND(self, node):
1496 """Return filled out ndparams for L{objects.Node}
1498 @type node: L{objects.Node}
1499 @param node: A Node object to fill
1500 @return a copy of the node's ndparams with defaults filled
1503 return self.SimpleFillND(node.ndparams)
1505 def SimpleFillND(self, ndparams):
1506 """Fill a given ndparams dict with defaults.
1508 @type ndparams: dict
1509 @param ndparams: the dict to fill
1511 @return: a copy of the passed in ndparams with missing keys filled
1512 from the node group defaults
1515 return FillDict(self.ndparams, ndparams)
1518 class Cluster(TaggableObject):
1519 """Config object representing the cluster."""
1524 "highest_used_port",
1527 "volume_group_name",
1529 "drbd_usermode_helper",
1531 "default_hypervisor",
1536 "use_external_mip_script",
1539 "shared_file_storage_dir",
1540 "enabled_hypervisors",
1549 "candidate_pool_size",
1552 "maintain_node_health",
1554 "default_iallocator",
1557 "primary_ip_family",
1558 "prealloc_wipe_disks",
1560 "disk_state_static",
1561 "enabled_disk_templates",
1562 ] + _TIMESTAMPS + _UUID
1564 def UpgradeConfig(self):
1565 """Fill defaults for missing configuration values.
1568 # pylint: disable=E0203
1569 # because these are "defined" via slots, not manually
1570 if self.hvparams is None:
1571 self.hvparams = constants.HVC_DEFAULTS
1573 for hypervisor in self.hvparams:
1574 self.hvparams[hypervisor] = FillDict(
1575 constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])
1577 if self.os_hvp is None:
1580 # osparams added before 2.2
1581 if self.osparams is None:
1584 self.ndparams = UpgradeNDParams(self.ndparams)
1586 self.beparams = UpgradeGroupedParams(self.beparams,
1587 constants.BEC_DEFAULTS)
1588 for beparams_group in self.beparams:
1589 UpgradeBeParams(self.beparams[beparams_group])
1591 migrate_default_bridge = not self.nicparams
1592 self.nicparams = UpgradeGroupedParams(self.nicparams,
1593 constants.NICC_DEFAULTS)
1594 if migrate_default_bridge:
1595 self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
1598 if self.modify_etc_hosts is None:
1599 self.modify_etc_hosts = True
1601 if self.modify_ssh_setup is None:
1602 self.modify_ssh_setup = True
1604 # default_bridge is no longer used in 2.1. The slot is left there to
1605 # support auto-upgrading. It can be removed once we decide to deprecate
1606 # upgrading straight from 2.0.
1607 if self.default_bridge is not None:
1608 self.default_bridge = None
1610 # default_hypervisor is just the first enabled one in 2.1. This slot and
1611 # code can be removed once upgrading straight from 2.0 is deprecated.
1612 if self.default_hypervisor is not None:
1613 self.enabled_hypervisors = ([self.default_hypervisor] +
1614 [hvname for hvname in self.enabled_hypervisors
1615 if hvname != self.default_hypervisor])
1616 self.default_hypervisor = None
1618 # maintain_node_health added after 2.1.1
1619 if self.maintain_node_health is None:
1620 self.maintain_node_health = False
1622 if self.uid_pool is None:
1625 if self.default_iallocator is None:
1626 self.default_iallocator = ""
1628 # reserved_lvs added before 2.2
1629 if self.reserved_lvs is None:
1630 self.reserved_lvs = []
1632 # hidden and blacklisted operating systems added before 2.2.1
1633 if self.hidden_os is None:
1636 if self.blacklisted_os is None:
1637 self.blacklisted_os = []
1639 # primary_ip_family added before 2.3
1640 if self.primary_ip_family is None:
1641 self.primary_ip_family = AF_INET
1643 if self.master_netmask is None:
1644 ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
1645 self.master_netmask = ipcls.iplen
1647 if self.prealloc_wipe_disks is None:
1648 self.prealloc_wipe_disks = False
1650 # shared_file_storage_dir added before 2.5
1651 if self.shared_file_storage_dir is None:
1652 self.shared_file_storage_dir = ""
1654 if self.use_external_mip_script is None:
1655 self.use_external_mip_script = False
1658 self.diskparams = UpgradeDiskParams(self.diskparams)
1660 self.diskparams = constants.DISK_DT_DEFAULTS.copy()
1662 # instance policy added before 2.6
1663 if self.ipolicy is None:
1664 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, {})
1666 # we can either make sure to upgrade the ipolicy always, or only
1667 # do it in some corner cases (e.g. missing keys); note that this
1668 # will break any removal of keys from the ipolicy dict
1669 wrongkeys = frozenset(self.ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
1671 # These keys would be silently removed by FillIPolicy()
1672 msg = ("Cluster instance policy contains spurious keys: %s" %
1673 utils.CommaJoin(wrongkeys))
1674 raise errors.ConfigurationError(msg)
1675 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, self.ipolicy)
1678 def primary_hypervisor(self):
1679 """The first hypervisor is the primary.
1681 Useful, for example, for L{Node}'s hv/disk state.
1684 return self.enabled_hypervisors[0]
1687 """Custom function for cluster.
1690 mydict = super(Cluster, self).ToDict()
1692 if self.tcpudp_port_pool is None:
1693 tcpudp_port_pool = []
1695 tcpudp_port_pool = list(self.tcpudp_port_pool)
1697 mydict["tcpudp_port_pool"] = tcpudp_port_pool
1702 def FromDict(cls, val):
1703 """Custom function for cluster.
1706 obj = super(Cluster, cls).FromDict(val)
1708 if obj.tcpudp_port_pool is None:
1709 obj.tcpudp_port_pool = set()
1710 elif not isinstance(obj.tcpudp_port_pool, set):
1711 obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
1715 def SimpleFillDP(self, diskparams):
1716 """Fill a given diskparams dict with cluster defaults.
1718 @param diskparams: The diskparams
1719 @return: The defaults dict
1722 return FillDiskParams(self.diskparams, diskparams)
1724 def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
1725 """Get the default hypervisor parameters for the cluster.
1727 @param hypervisor: the hypervisor name
1728 @param os_name: if specified, we'll also update the defaults for this OS
1729 @param skip_keys: if passed, list of keys not to use
1730 @return: the defaults dict
1733 if skip_keys is None:
1736 fill_stack = [self.hvparams.get(hypervisor, {})]
1737 if os_name is not None:
1738 os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
1739 fill_stack.append(os_hvp)
1742 for o_dict in fill_stack:
1743 ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)
1747 def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
1748 """Fill a given hvparams dict with cluster defaults.
1750 @type hv_name: string
1751 @param hv_name: the hypervisor to use
1752 @type os_name: string
1753 @param os_name: the OS to use for overriding the hypervisor defaults
1754 @type skip_globals: boolean
1755 @param skip_globals: if True, the global hypervisor parameters will
1758 @return: a copy of the given hvparams with missing keys filled from
1759 the cluster defaults
1763 skip_keys = constants.HVC_GLOBALS
1767 def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
1768 return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1770 def FillHV(self, instance, skip_globals=False):
1771 """Fill an instance's hvparams dict with cluster defaults.
1773 @type instance: L{objects.Instance}
1774 @param instance: the instance parameter to fill
1775 @type skip_globals: boolean
1776 @param skip_globals: if True, the global hypervisor parameters will
1779 @return: a copy of the instance's hvparams with missing keys filled from
1780 the cluster defaults
1783 return self.SimpleFillHV(instance.hypervisor, instance.os,
1784 instance.hvparams, skip_globals)
1786 def SimpleFillBE(self, beparams):
1787 """Fill a given beparams dict with cluster defaults.
1789 @type beparams: dict
1790 @param beparams: the dict to fill
1792 @return: a copy of the passed in beparams with missing keys filled
1793 from the cluster defaults
1796 return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1798 def FillBE(self, instance):
1799 """Fill an instance's beparams dict with cluster defaults.
1801 @type instance: L{objects.Instance}
1802 @param instance: the instance parameter to fill
1804 @return: a copy of the instance's beparams with missing keys filled from
1805 the cluster defaults
1808 return self.SimpleFillBE(instance.beparams)
1810 def SimpleFillNIC(self, nicparams):
1811 """Fill a given nicparams dict with cluster defaults.
1813 @type nicparams: dict
1814 @param nicparams: the dict to fill
1816 @return: a copy of the passed in nicparams with missing keys filled
1817 from the cluster defaults
1820 return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1822 def SimpleFillOS(self, os_name, os_params):
1823 """Fill an instance's osparams dict with cluster defaults.
1825 @type os_name: string
1826 @param os_name: the OS name to use
1827 @type os_params: dict
1828 @param os_params: the dict to fill with default values
1830 @return: a copy of the instance's osparams with missing keys filled from
1831 the cluster defaults
1834 name_only = os_name.split("+", 1)[0]
1836 result = self.osparams.get(name_only, {})
1838 result = FillDict(result, self.osparams.get(os_name, {}))
1840 return FillDict(result, os_params)
1843 def SimpleFillHvState(hv_state):
1844 """Fill an hv_state sub dict with cluster defaults.
1847 return FillDict(constants.HVST_DEFAULTS, hv_state)
1850 def SimpleFillDiskState(disk_state):
1851 """Fill an disk_state sub dict with cluster defaults.
1854 return FillDict(constants.DS_DEFAULTS, disk_state)
1856 def FillND(self, node, nodegroup):
1857 """Return filled out ndparams for L{objects.NodeGroup} and L{objects.Node}
1859 @type node: L{objects.Node}
1860 @param node: A Node object to fill
1861 @type nodegroup: L{objects.NodeGroup}
1862 @param nodegroup: A Node object to fill
1863 @return a copy of the node's ndparams with defaults filled
1866 return self.SimpleFillND(nodegroup.FillND(node))
1868 def SimpleFillND(self, ndparams):
1869 """Fill a given ndparams dict with defaults.
1871 @type ndparams: dict
1872 @param ndparams: the dict to fill
1874 @return: a copy of the passed in ndparams with missing keys filled
1875 from the cluster defaults
1878 return FillDict(self.ndparams, ndparams)
1880 def SimpleFillIPolicy(self, ipolicy):
1881 """ Fill instance policy dict with defaults.
1884 @param ipolicy: the dict to fill
1886 @return: a copy of passed ipolicy with missing keys filled from
1887 the cluster defaults
1890 return FillIPolicy(self.ipolicy, ipolicy)
1893 class BlockDevStatus(ConfigObject):
1894 """Config object representing the status of a block device."""
1906 class ImportExportStatus(ConfigObject):
1907 """Config object representing the status of an import or export."""
1913 "progress_throughput",
1921 class ImportExportOptions(ConfigObject):
1922 """Options for import/export daemon
1924 @ivar key_name: X509 key name (None for cluster certificate)
1925 @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1926 @ivar compress: Compression method (one of L{constants.IEC_ALL})
1927 @ivar magic: Used to ensure the connection goes to the right disk
1928 @ivar ipv6: Whether to use IPv6
1929 @ivar connect_timeout: Number of seconds for establishing connection
1942 class ConfdRequest(ConfigObject):
1943 """Object holding a confd request.
1945 @ivar protocol: confd protocol version
1946 @ivar type: confd query type
1947 @ivar query: query request
1948 @ivar rsalt: requested reply salt
1959 class ConfdReply(ConfigObject):
1960 """Object holding a confd reply.
1962 @ivar protocol: confd protocol version
1963 @ivar status: reply status code (ok, error)
1964 @ivar answer: confd query reply
1965 @ivar serial: configuration serial number
1976 class QueryFieldDefinition(ConfigObject):
1977 """Object holding a query field definition.
1979 @ivar name: Field name
1980 @ivar title: Human-readable title
1981 @ivar kind: Field type
1982 @ivar doc: Human-readable description
1993 class _QueryResponseBase(ConfigObject):
1999 """Custom function for serializing.
2002 mydict = super(_QueryResponseBase, self).ToDict()
2003 mydict["fields"] = outils.ContainerToDicts(mydict["fields"])
2007 def FromDict(cls, val):
2008 """Custom function for de-serializing.
2011 obj = super(_QueryResponseBase, cls).FromDict(val)
2013 outils.ContainerFromDicts(obj.fields, list, QueryFieldDefinition)
2017 class QueryResponse(_QueryResponseBase):
2018 """Object holding the response to a query.
2020 @ivar fields: List of L{QueryFieldDefinition} objects
2021 @ivar data: Requested data
2029 class QueryFieldsRequest(ConfigObject):
2030 """Object holding a request for querying available fields.
2039 class QueryFieldsResponse(_QueryResponseBase):
2040 """Object holding the response to a query for fields.
2042 @ivar fields: List of L{QueryFieldDefinition} objects
2048 class MigrationStatus(ConfigObject):
2049 """Object holding the status of a migration.
2059 class InstanceConsole(ConfigObject):
2060 """Object describing how to access the console of an instance.
2075 """Validates contents of this object.
2078 assert self.kind in constants.CONS_ALL, "Unknown console type"
2079 assert self.instance, "Missing instance name"
2080 assert self.message or self.kind in [constants.CONS_SSH,
2081 constants.CONS_SPICE,
2083 assert self.host or self.kind == constants.CONS_MESSAGE
2084 assert self.port or self.kind in [constants.CONS_MESSAGE,
2086 assert self.user or self.kind in [constants.CONS_MESSAGE,
2087 constants.CONS_SPICE,
2089 assert self.command or self.kind in [constants.CONS_MESSAGE,
2090 constants.CONS_SPICE,
2092 assert self.display or self.kind in [constants.CONS_MESSAGE,
2093 constants.CONS_SPICE,
2098 class Network(TaggableObject):
2099 """Object representing a network definition for ganeti.
2112 ] + _TIMESTAMPS + _UUID
2114 def HooksDict(self, prefix=""):
2115 """Export a dictionary used by hooks with a network's information.
2117 @type prefix: String
2118 @param prefix: Prefix to prepend to the dict entries
2122 "%sNETWORK_NAME" % prefix: self.name,
2123 "%sNETWORK_UUID" % prefix: self.uuid,
2124 "%sNETWORK_TAGS" % prefix: " ".join(self.GetTags()),
2127 result["%sNETWORK_SUBNET" % prefix] = self.network
2129 result["%sNETWORK_GATEWAY" % prefix] = self.gateway
2131 result["%sNETWORK_SUBNET6" % prefix] = self.network6
2133 result["%sNETWORK_GATEWAY6" % prefix] = self.gateway6
2135 result["%sNETWORK_MAC_PREFIX" % prefix] = self.mac_prefix
2140 def FromDict(cls, val):
2141 """Custom function for networks.
2143 Remove deprecated network_type and family.
2146 if "network_type" in val:
2147 del val["network_type"]
2150 obj = super(Network, cls).FromDict(val)
2154 class SerializableConfigParser(ConfigParser.SafeConfigParser):
2155 """Simple wrapper over ConfigParse that allows serialization.
2157 This class is basically ConfigParser.SafeConfigParser with two
2158 additional methods that allow it to serialize/unserialize to/from a
2163 """Dump this instance and return the string representation."""
2166 return buf.getvalue()
2169 def Loads(cls, data):
2170 """Load data from a string."""
2171 buf = StringIO(data)
2177 class LvmPvInfo(ConfigObject):
2178 """Information about an LVM physical volume (PV).
2181 @ivar name: name of the PV
2182 @type vg_name: string
2183 @ivar vg_name: name of the volume group containing the PV
2185 @ivar size: size of the PV in MiB
2187 @ivar free: free space in the PV, in MiB
2188 @type attributes: string
2189 @ivar attributes: PV attributes
2190 @type lv_list: list of strings
2191 @ivar lv_list: names of the LVs hosted on the PV
2203 """Is this PV empty?
2206 return self.size <= (self.free + 1)
2208 def IsAllocatable(self):
2209 """Is this PV allocatable?
2212 return ("a" in self.attributes)