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 def FromDict(cls, val):
515 """Custom function for NICs.
517 Remove deprecated idx. Add dummy UUID if not found.
518 Needed for old runtime files.
523 obj = super(NIC, cls).FromDict(val)
527 class Disk(ConfigObject):
528 """Config object representing a block device."""
529 __slots__ = ["name", "dev_type", "logical_id", "physical_id",
530 "children", "iv_name", "size", "mode", "params", "pci"] + _UUID
532 def CreateOnSecondary(self):
533 """Test if this device needs to be created on a secondary node."""
534 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
536 def AssembleOnSecondary(self):
537 """Test if this device needs to be assembled on a secondary node."""
538 return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
540 def OpenOnSecondary(self):
541 """Test if this device needs to be opened on a secondary node."""
542 return self.dev_type in (constants.LD_LV,)
544 def StaticDevPath(self):
545 """Return the device path if this device type has a static one.
547 Some devices (LVM for example) live always at the same /dev/ path,
548 irrespective of their status. For such devices, we return this
549 path, for others we return None.
551 @warning: The path returned is not a normalized pathname; callers
552 should check that it is a valid path.
555 if self.dev_type == constants.LD_LV:
556 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
557 elif self.dev_type == constants.LD_BLOCKDEV:
558 return self.logical_id[1]
559 elif self.dev_type == constants.LD_RBD:
560 return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
563 def ChildrenNeeded(self):
564 """Compute the needed number of children for activation.
566 This method will return either -1 (all children) or a positive
567 number denoting the minimum number of children needed for
568 activation (only mirrored devices will usually return >=0).
570 Currently, only DRBD8 supports diskless activation (therefore we
571 return 0), for all other we keep the previous semantics and return
575 if self.dev_type == constants.LD_DRBD8:
579 def IsBasedOnDiskType(self, dev_type):
580 """Check if the disk or its children are based on the given type.
582 @type dev_type: L{constants.LDS_BLOCK}
583 @param dev_type: the type to look for
585 @return: boolean indicating if a device of the given type was found or not
589 for child in self.children:
590 if child.IsBasedOnDiskType(dev_type):
592 return self.dev_type == dev_type
594 def GetNodes(self, node):
595 """This function returns the nodes this device lives on.
597 Given the node on which the parent of the device lives on (or, in
598 case of a top-level device, the primary node of the devices'
599 instance), this function will return a list of nodes on which this
600 devices needs to (or can) be assembled.
603 if self.dev_type in [constants.LD_LV, constants.LD_FILE,
604 constants.LD_BLOCKDEV, constants.LD_RBD,
607 elif self.dev_type in constants.LDS_DRBD:
608 result = [self.logical_id[0], self.logical_id[1]]
609 if node not in result:
610 raise errors.ConfigurationError("DRBD device passed unknown node")
612 raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
615 def ComputeNodeTree(self, parent_node):
616 """Compute the node/disk tree for this disk and its children.
618 This method, given the node on which the parent disk lives, will
619 return the list of all (node, disk) pairs which describe the disk
620 tree in the most compact way. For example, a drbd/lvm stack
621 will be returned as (primary_node, drbd) and (secondary_node, drbd)
622 which represents all the top-level devices on the nodes.
625 my_nodes = self.GetNodes(parent_node)
626 result = [(node, self) for node in my_nodes]
627 if not self.children:
630 for node in my_nodes:
631 for child in self.children:
632 child_result = child.ComputeNodeTree(node)
633 if len(child_result) == 1:
634 # child (and all its descendants) is simple, doesn't split
635 # over multiple hosts, so we don't need to describe it, our
636 # own entry for this node describes it completely
639 # check if child nodes differ from my nodes; note that
640 # subdisk can differ from the child itself, and be instead
641 # one of its descendants
642 for subnode, subdisk in child_result:
643 if subnode not in my_nodes:
644 result.append((subnode, subdisk))
645 # otherwise child is under our own node, so we ignore this
646 # entry (but probably the other results in the list will
650 def ComputeGrowth(self, amount):
651 """Compute the per-VG growth requirements.
653 This only works for VG-based disks.
655 @type amount: integer
656 @param amount: the desired increase in (user-visible) disk space
658 @return: a dictionary of volume-groups and the required size
661 if self.dev_type == constants.LD_LV:
662 return {self.logical_id[0]: amount}
663 elif self.dev_type == constants.LD_DRBD8:
665 return self.children[0].ComputeGrowth(amount)
669 # Other disk types do not require VG space
672 def RecordGrow(self, amount):
673 """Update the size of this disk after growth.
675 This method recurses over the disks's children and updates their
676 size correspondigly. The method needs to be kept in sync with the
677 actual algorithms from bdev.
680 if self.dev_type in (constants.LD_LV, constants.LD_FILE,
681 constants.LD_RBD, constants.LD_EXT):
683 elif self.dev_type == constants.LD_DRBD8:
685 self.children[0].RecordGrow(amount)
688 raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
689 " disk type %s" % self.dev_type)
691 def Update(self, size=None, mode=None):
692 """Apply changes to size and mode.
695 if self.dev_type == constants.LD_DRBD8:
697 self.children[0].Update(size=size, mode=mode)
699 assert not self.children
707 """Sets recursively the size to zero for the disk and its children.
711 for child in self.children:
715 def SetPhysicalID(self, target_node, nodes_ip):
716 """Convert the logical ID to the physical ID.
718 This is used only for drbd, which needs ip/port configuration.
720 The routine descends down and updates its children also, because
721 this helps when the only the top device is passed to the remote
725 - target_node: the node we wish to configure for
726 - nodes_ip: a mapping of node name to ip
728 The target_node must exist in in nodes_ip, and must be one of the
729 nodes in the logical ID for each of the DRBD devices encountered
734 for child in self.children:
735 child.SetPhysicalID(target_node, nodes_ip)
737 if self.logical_id is None and self.physical_id is not None:
739 if self.dev_type in constants.LDS_DRBD:
740 pnode, snode, port, pminor, sminor, secret = self.logical_id
741 if target_node not in (pnode, snode):
742 raise errors.ConfigurationError("DRBD device not knowing node %s" %
744 pnode_ip = nodes_ip.get(pnode, None)
745 snode_ip = nodes_ip.get(snode, None)
746 if pnode_ip is None or snode_ip is None:
747 raise errors.ConfigurationError("Can't find primary or secondary node"
748 " for %s" % str(self))
749 p_data = (pnode_ip, port)
750 s_data = (snode_ip, port)
751 if pnode == target_node:
752 self.physical_id = p_data + s_data + (pminor, secret)
753 else: # it must be secondary, we tested above
754 self.physical_id = s_data + p_data + (sminor, secret)
756 self.physical_id = self.logical_id
760 """Disk-specific conversion to standard python types.
762 This replaces the children lists of objects with lists of
763 standard python types.
766 bo = super(Disk, self).ToDict()
768 for attr in ("children",):
769 alist = bo.get(attr, None)
771 bo[attr] = outils.ContainerToDicts(alist)
775 def FromDict(cls, val):
776 """Custom function for Disks
781 obj = super(Disk, cls).FromDict(val)
783 obj.children = outils.ContainerFromDicts(obj.children, list, Disk)
784 if obj.logical_id and isinstance(obj.logical_id, list):
785 obj.logical_id = tuple(obj.logical_id)
786 if obj.physical_id and isinstance(obj.physical_id, list):
787 obj.physical_id = tuple(obj.physical_id)
788 if obj.dev_type in constants.LDS_DRBD:
789 # we need a tuple of length six here
790 if len(obj.logical_id) < 6:
791 obj.logical_id += (None,) * (6 - len(obj.logical_id))
795 """Custom str() formatter for disks.
798 if self.dev_type == constants.LD_LV:
799 val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
800 elif self.dev_type in constants.LDS_DRBD:
801 node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
803 if self.physical_id is None:
806 phy = ("configured as %s:%s %s:%s" %
807 (self.physical_id[0], self.physical_id[1],
808 self.physical_id[2], self.physical_id[3]))
810 val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
811 (node_a, minor_a, node_b, minor_b, port, phy))
812 if self.children and self.children.count(None) == 0:
813 val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
815 val += "no local storage"
817 val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
818 (self.dev_type, self.logical_id, self.physical_id, self.children))
819 if self.iv_name is None:
820 val += ", not visible"
822 val += ", visible as /dev/%s" % self.iv_name
823 if isinstance(self.size, int):
824 val += ", size=%dm)>" % self.size
826 val += ", size='%s')>" % (self.size,)
830 """Checks that this disk is correctly configured.
834 if self.mode not in constants.DISK_ACCESS_SET:
835 all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
838 def UpgradeConfig(self):
839 """Fill defaults for missing configuration values.
843 for child in self.children:
844 child.UpgradeConfig()
846 # FIXME: Make this configurable in Ganeti 2.7
847 # Params should be an empty dict that gets filled any time needed
848 # In case of ext template we allow arbitrary params that should not
849 # be overrided during a config reload/upgrade.
850 if not self.params or not isinstance(self.params, dict):
853 # add here config upgrade for this disk
855 # If the file driver is empty, fill it up with the default value
856 if self.dev_type == constants.LD_FILE and self.physical_id[0] is None:
857 self.physical_id[0] = constants.FD_DEFAULT
860 def ComputeLDParams(disk_template, disk_params):
861 """Computes Logical Disk parameters from Disk Template parameters.
863 @type disk_template: string
864 @param disk_template: disk template, one of L{constants.DISK_TEMPLATES}
865 @type disk_params: dict
866 @param disk_params: disk template parameters;
867 dict(template_name -> parameters
869 @return: a list of dicts, one for each node of the disk hierarchy. Each dict
870 contains the LD parameters of the node. The tree is flattened in-order.
873 if disk_template not in constants.DISK_TEMPLATES:
874 raise errors.ProgrammerError("Unknown disk template %s" % disk_template)
876 assert disk_template in disk_params
879 dt_params = disk_params[disk_template]
880 if disk_template == constants.DT_DRBD8:
881 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], {
882 constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE],
883 constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS],
884 constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS],
885 constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG],
886 constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM],
887 constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM],
888 constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC],
889 constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD],
890 constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET],
891 constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET],
892 constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE],
893 constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE],
897 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
898 constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
902 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
903 constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
906 elif disk_template in (constants.DT_FILE, constants.DT_SHARED_FILE):
907 result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE])
909 elif disk_template == constants.DT_PLAIN:
910 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
911 constants.LDP_STRIPES: dt_params[constants.LV_STRIPES],
914 elif disk_template == constants.DT_BLOCK:
915 result.append(constants.DISK_LD_DEFAULTS[constants.LD_BLOCKDEV])
917 elif disk_template == constants.DT_RBD:
918 result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], {
919 constants.LDP_POOL: dt_params[constants.RBD_POOL],
922 elif disk_template == constants.DT_EXT:
923 result.append(constants.DISK_LD_DEFAULTS[constants.LD_EXT])
928 class InstancePolicy(ConfigObject):
929 """Config object representing instance policy limits dictionary.
931 Note that this object is not actually used in the config, it's just
932 used as a placeholder for a few functions.
936 def CheckParameterSyntax(cls, ipolicy, check_std):
937 """ Check the instance policy for validity.
940 @param ipolicy: dictionary with min/max/std specs and policies
941 @type check_std: bool
942 @param check_std: Whether to check std value or just assume compliance
943 @raise errors.ConfigurationError: when the policy is not legal
946 InstancePolicy.CheckISpecSyntax(ipolicy, check_std)
947 if constants.IPOLICY_DTS in ipolicy:
948 InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
949 for key in constants.IPOLICY_PARAMETERS:
951 InstancePolicy.CheckParameter(key, ipolicy[key])
952 wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
954 raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
955 utils.CommaJoin(wrong_keys))
958 def _CheckIncompleteSpec(cls, spec, keyname):
959 missing_params = constants.ISPECS_PARAMETERS - frozenset(spec.keys())
961 msg = ("Missing instance specs parameters for %s: %s" %
962 (keyname, utils.CommaJoin(missing_params)))
963 raise errors.ConfigurationError(msg)
966 def CheckISpecSyntax(cls, ipolicy, check_std):
967 """Check the instance policy specs for validity.
970 @param ipolicy: dictionary with min/max/std specs
971 @type check_std: bool
972 @param check_std: Whether to check std value or just assume compliance
973 @raise errors.ConfigurationError: when specs are not valid
976 if constants.ISPECS_MINMAX not in ipolicy:
980 if check_std and constants.ISPECS_STD not in ipolicy:
981 msg = "Missing key in ipolicy: %s" % constants.ISPECS_STD
982 raise errors.ConfigurationError(msg)
983 stdspec = ipolicy.get(constants.ISPECS_STD)
985 InstancePolicy._CheckIncompleteSpec(stdspec, constants.ISPECS_STD)
987 if not ipolicy[constants.ISPECS_MINMAX]:
988 raise errors.ConfigurationError("Empty minmax specifications")
990 for minmaxspecs in ipolicy[constants.ISPECS_MINMAX]:
991 missing = constants.ISPECS_MINMAX_KEYS - frozenset(minmaxspecs.keys())
993 msg = "Missing instance specification: %s" % utils.CommaJoin(missing)
994 raise errors.ConfigurationError(msg)
995 for (key, spec) in minmaxspecs.items():
996 InstancePolicy._CheckIncompleteSpec(spec, key)
999 for param in constants.ISPECS_PARAMETERS:
1000 par_std_ok = InstancePolicy._CheckISpecParamSyntax(minmaxspecs, stdspec,
1002 spec_std_ok = spec_std_ok and par_std_ok
1003 std_is_good = std_is_good or spec_std_ok
1005 raise errors.ConfigurationError("Invalid std specifications")
1008 def _CheckISpecParamSyntax(cls, minmaxspecs, stdspec, name, check_std):
1009 """Check the instance policy specs for validity on a given key.
1011 We check if the instance specs makes sense for a given key, that is
1012 if minmaxspecs[min][name] <= stdspec[name] <= minmaxspec[max][name].
1014 @type minmaxspecs: dict
1015 @param minmaxspecs: dictionary with min and max instance spec
1017 @param stdspec: dictionary with standard instance spec
1019 @param name: what are the limits for
1020 @type check_std: bool
1021 @param check_std: Whether to check std value or just assume compliance
1023 @return: C{True} when specs are valid, C{False} when standard spec for the
1024 given name is not valid
1025 @raise errors.ConfigurationError: when min/max specs for the given name
1029 minspec = minmaxspecs[constants.ISPECS_MIN]
1030 maxspec = minmaxspecs[constants.ISPECS_MAX]
1031 min_v = minspec[name]
1032 max_v = maxspec[name]
1035 err = ("Invalid specification of min/max values for %s: %s/%s" %
1036 (name, min_v, max_v))
1037 raise errors.ConfigurationError(err)
1039 std_v = stdspec.get(name, min_v)
1040 return std_v >= min_v and std_v <= max_v
1045 def CheckDiskTemplates(cls, disk_templates):
1046 """Checks the disk templates for validity.
1049 if not disk_templates:
1050 raise errors.ConfigurationError("Instance policy must contain" +
1051 " at least one disk template")
1052 wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
1054 raise errors.ConfigurationError("Invalid disk template(s) %s" %
1055 utils.CommaJoin(wrong))
1058 def CheckParameter(cls, key, value):
1059 """Checks a parameter.
1061 Currently we expect all parameters to be float values.
1066 except (TypeError, ValueError), err:
1067 raise errors.ConfigurationError("Invalid value for key" " '%s':"
1068 " '%s', error: %s" % (key, value, err))
1071 class Instance(TaggableObject):
1072 """Config object representing an instance."""
1088 ] + _TIMESTAMPS + _UUID
1090 def _ComputeSecondaryNodes(self):
1091 """Compute the list of secondary nodes.
1093 This is a simple wrapper over _ComputeAllNodes.
1096 all_nodes = set(self._ComputeAllNodes())
1097 all_nodes.discard(self.primary_node)
1098 return tuple(all_nodes)
1100 secondary_nodes = property(_ComputeSecondaryNodes, None, None,
1101 "List of names of secondary nodes")
1103 def _ComputeAllNodes(self):
1104 """Compute the list of all nodes.
1106 Since the data is already there (in the drbd disks), keeping it as
1107 a separate normal attribute is redundant and if not properly
1108 synchronised can cause problems. Thus it's better to compute it
1112 def _Helper(nodes, device):
1113 """Recursively computes nodes given a top device."""
1114 if device.dev_type in constants.LDS_DRBD:
1115 nodea, nodeb = device.logical_id[:2]
1119 for child in device.children:
1120 _Helper(nodes, child)
1123 all_nodes.add(self.primary_node)
1124 for device in self.disks:
1125 _Helper(all_nodes, device)
1126 return tuple(all_nodes)
1128 all_nodes = property(_ComputeAllNodes, None, None,
1129 "List of names of all the nodes of the instance")
1131 def MapLVsByNode(self, lvmap=None, devs=None, node=None):
1132 """Provide a mapping of nodes to LVs this instance owns.
1134 This function figures out what logical volumes should belong on
1135 which nodes, recursing through a device tree.
1137 @param lvmap: optional dictionary to receive the
1138 'node' : ['lv', ...] data.
1140 @return: None if lvmap arg is given, otherwise, a dictionary of
1141 the form { 'nodename' : ['volume1', 'volume2', ...], ... };
1142 volumeN is of the form "vg_name/lv_name", compatible with
1147 node = self.primary_node
1155 if not node in lvmap:
1163 if dev.dev_type == constants.LD_LV:
1164 lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
1166 elif dev.dev_type in constants.LDS_DRBD:
1168 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
1169 self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])
1172 self.MapLVsByNode(lvmap, dev.children, node)
1176 def FindDisk(self, idx):
1177 """Find a disk given having a specified index.
1179 This is just a wrapper that does validation of the index.
1182 @param idx: the disk index
1184 @return: the corresponding disk
1185 @raise errors.OpPrereqError: when the given index is not valid
1190 return self.disks[idx]
1191 except (TypeError, ValueError), err:
1192 raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
1195 raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1196 " 0 to %d" % (idx, len(self.disks) - 1),
1200 """Instance-specific conversion to standard python types.
1202 This replaces the children lists of objects with lists of standard
1206 bo = super(Instance, self).ToDict()
1208 for attr in "nics", "disks":
1209 alist = bo.get(attr, None)
1211 nlist = outils.ContainerToDicts(alist)
1218 def FromDict(cls, val):
1219 """Custom function for instances.
1222 if "admin_state" not in val:
1223 if val.get("admin_up", False):
1224 val["admin_state"] = constants.ADMINST_UP
1226 val["admin_state"] = constants.ADMINST_DOWN
1227 if "admin_up" in val:
1229 obj = super(Instance, cls).FromDict(val)
1230 obj.nics = outils.ContainerFromDicts(obj.nics, list, NIC)
1231 obj.disks = outils.ContainerFromDicts(obj.disks, list, Disk)
1234 def UpgradeConfig(self):
1235 """Fill defaults for missing configuration values.
1238 for nic in self.nics:
1240 for disk in self.disks:
1241 disk.UpgradeConfig()
1243 for key in constants.HVC_GLOBALS:
1245 del self.hvparams[key]
1248 if self.osparams is None:
1250 UpgradeBeParams(self.beparams)
1251 if self.disks_active is None:
1252 self.disks_active = self.admin_state == constants.ADMINST_UP
1255 class OS(ConfigObject):
1256 """Config object representing an operating system.
1258 @type supported_parameters: list
1259 @ivar supported_parameters: a list of tuples, name and description,
1260 containing the supported parameters by this OS
1262 @type VARIANT_DELIM: string
1263 @cvar VARIANT_DELIM: the variant delimiter
1275 "supported_variants",
1276 "supported_parameters",
1282 def SplitNameVariant(cls, name):
1283 """Splits the name into the proper name and variant.
1285 @param name: the OS (unprocessed) name
1287 @return: a list of two elements; if the original name didn't
1288 contain a variant, it's returned as an empty string
1291 nv = name.split(cls.VARIANT_DELIM, 1)
1297 def GetName(cls, name):
1298 """Returns the proper name of the os (without the variant).
1300 @param name: the OS (unprocessed) name
1303 return cls.SplitNameVariant(name)[0]
1306 def GetVariant(cls, name):
1307 """Returns the variant the os (without the base name).
1309 @param name: the OS (unprocessed) name
1312 return cls.SplitNameVariant(name)[1]
1315 class ExtStorage(ConfigObject):
1316 """Config object representing an External Storage Provider.
1329 "supported_parameters",
1333 class NodeHvState(ConfigObject):
1334 """Hypvervisor state on a node.
1336 @ivar mem_total: Total amount of memory
1337 @ivar mem_node: Memory used by, or reserved for, the node itself (not always
1339 @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation
1341 @ivar mem_inst: Memory used by instances living on node
1342 @ivar cpu_total: Total node CPU core count
1343 @ivar cpu_node: Number of CPU cores reserved for the node itself
1356 class NodeDiskState(ConfigObject):
1357 """Disk state on a node.
1367 class Node(TaggableObject):
1368 """Config object representing a node.
1370 @ivar hv_state: Hypervisor state (e.g. number of CPUs)
1371 @ivar hv_state_static: Hypervisor state overriden by user
1372 @ivar disk_state: Disk state (e.g. free space)
1373 @ivar disk_state_static: Disk state overriden by user
1392 "disk_state_static",
1393 ] + _TIMESTAMPS + _UUID
1395 def UpgradeConfig(self):
1396 """Fill defaults for missing configuration values.
1399 # pylint: disable=E0203
1400 # because these are "defined" via slots, not manually
1401 if self.master_capable is None:
1402 self.master_capable = True
1404 if self.vm_capable is None:
1405 self.vm_capable = True
1407 if self.ndparams is None:
1409 # And remove any global parameter
1410 for key in constants.NDC_GLOBALS:
1411 if key in self.ndparams:
1412 logging.warning("Ignoring %s node parameter for node %s",
1414 del self.ndparams[key]
1416 if self.powered is None:
1420 """Custom function for serializing.
1423 data = super(Node, self).ToDict()
1425 hv_state = data.get("hv_state", None)
1426 if hv_state is not None:
1427 data["hv_state"] = outils.ContainerToDicts(hv_state)
1429 disk_state = data.get("disk_state", None)
1430 if disk_state is not None:
1431 data["disk_state"] = \
1432 dict((key, outils.ContainerToDicts(value))
1433 for (key, value) in disk_state.items())
1438 def FromDict(cls, val):
1439 """Custom function for deserializing.
1442 obj = super(Node, cls).FromDict(val)
1444 if obj.hv_state is not None:
1446 outils.ContainerFromDicts(obj.hv_state, dict, NodeHvState)
1448 if obj.disk_state is not None:
1450 dict((key, outils.ContainerFromDicts(value, dict, NodeDiskState))
1451 for (key, value) in obj.disk_state.items())
1456 class NodeGroup(TaggableObject):
1457 """Config object representing a node group."""
1466 "disk_state_static",
1469 ] + _TIMESTAMPS + _UUID
1472 """Custom function for nodegroup.
1474 This discards the members object, which gets recalculated and is only kept
1478 mydict = super(NodeGroup, self).ToDict()
1479 del mydict["members"]
1483 def FromDict(cls, val):
1484 """Custom function for nodegroup.
1486 The members slot is initialized to an empty list, upon deserialization.
1489 obj = super(NodeGroup, cls).FromDict(val)
1493 def UpgradeConfig(self):
1494 """Fill defaults for missing configuration values.
1497 if self.ndparams is None:
1500 if self.serial_no is None:
1503 if self.alloc_policy is None:
1504 self.alloc_policy = constants.ALLOC_POLICY_PREFERRED
1506 # We only update mtime, and not ctime, since we would not be able
1507 # to provide a correct value for creation time.
1508 if self.mtime is None:
1509 self.mtime = time.time()
1511 if self.diskparams is None:
1512 self.diskparams = {}
1513 if self.ipolicy is None:
1514 self.ipolicy = MakeEmptyIPolicy()
1516 if self.networks is None:
1519 def FillND(self, node):
1520 """Return filled out ndparams for L{objects.Node}
1522 @type node: L{objects.Node}
1523 @param node: A Node object to fill
1524 @return a copy of the node's ndparams with defaults filled
1527 return self.SimpleFillND(node.ndparams)
1529 def SimpleFillND(self, ndparams):
1530 """Fill a given ndparams dict with defaults.
1532 @type ndparams: dict
1533 @param ndparams: the dict to fill
1535 @return: a copy of the passed in ndparams with missing keys filled
1536 from the node group defaults
1539 return FillDict(self.ndparams, ndparams)
1542 class Cluster(TaggableObject):
1543 """Config object representing the cluster."""
1548 "highest_used_port",
1551 "volume_group_name",
1553 "drbd_usermode_helper",
1555 "default_hypervisor",
1560 "use_external_mip_script",
1563 "shared_file_storage_dir",
1564 "enabled_hypervisors",
1573 "candidate_pool_size",
1576 "maintain_node_health",
1578 "default_iallocator",
1581 "primary_ip_family",
1582 "prealloc_wipe_disks",
1584 "disk_state_static",
1585 "enabled_disk_templates",
1586 ] + _TIMESTAMPS + _UUID
1588 def UpgradeConfig(self):
1589 """Fill defaults for missing configuration values.
1592 # pylint: disable=E0203
1593 # because these are "defined" via slots, not manually
1594 if self.hvparams is None:
1595 self.hvparams = constants.HVC_DEFAULTS
1597 for hypervisor in self.hvparams:
1598 self.hvparams[hypervisor] = FillDict(
1599 constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])
1601 if self.os_hvp is None:
1604 # osparams added before 2.2
1605 if self.osparams is None:
1608 self.ndparams = UpgradeNDParams(self.ndparams)
1610 self.beparams = UpgradeGroupedParams(self.beparams,
1611 constants.BEC_DEFAULTS)
1612 for beparams_group in self.beparams:
1613 UpgradeBeParams(self.beparams[beparams_group])
1615 migrate_default_bridge = not self.nicparams
1616 self.nicparams = UpgradeGroupedParams(self.nicparams,
1617 constants.NICC_DEFAULTS)
1618 if migrate_default_bridge:
1619 self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
1622 if self.modify_etc_hosts is None:
1623 self.modify_etc_hosts = True
1625 if self.modify_ssh_setup is None:
1626 self.modify_ssh_setup = True
1628 # default_bridge is no longer used in 2.1. The slot is left there to
1629 # support auto-upgrading. It can be removed once we decide to deprecate
1630 # upgrading straight from 2.0.
1631 if self.default_bridge is not None:
1632 self.default_bridge = None
1634 # default_hypervisor is just the first enabled one in 2.1. This slot and
1635 # code can be removed once upgrading straight from 2.0 is deprecated.
1636 if self.default_hypervisor is not None:
1637 self.enabled_hypervisors = ([self.default_hypervisor] +
1638 [hvname for hvname in self.enabled_hypervisors
1639 if hvname != self.default_hypervisor])
1640 self.default_hypervisor = None
1642 # maintain_node_health added after 2.1.1
1643 if self.maintain_node_health is None:
1644 self.maintain_node_health = False
1646 if self.uid_pool is None:
1649 if self.default_iallocator is None:
1650 self.default_iallocator = ""
1652 # reserved_lvs added before 2.2
1653 if self.reserved_lvs is None:
1654 self.reserved_lvs = []
1656 # hidden and blacklisted operating systems added before 2.2.1
1657 if self.hidden_os is None:
1660 if self.blacklisted_os is None:
1661 self.blacklisted_os = []
1663 # primary_ip_family added before 2.3
1664 if self.primary_ip_family is None:
1665 self.primary_ip_family = AF_INET
1667 if self.master_netmask is None:
1668 ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
1669 self.master_netmask = ipcls.iplen
1671 if self.prealloc_wipe_disks is None:
1672 self.prealloc_wipe_disks = False
1674 # shared_file_storage_dir added before 2.5
1675 if self.shared_file_storage_dir is None:
1676 self.shared_file_storage_dir = ""
1678 if self.use_external_mip_script is None:
1679 self.use_external_mip_script = False
1682 self.diskparams = UpgradeDiskParams(self.diskparams)
1684 self.diskparams = constants.DISK_DT_DEFAULTS.copy()
1686 # instance policy added before 2.6
1687 if self.ipolicy is None:
1688 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, {})
1690 # we can either make sure to upgrade the ipolicy always, or only
1691 # do it in some corner cases (e.g. missing keys); note that this
1692 # will break any removal of keys from the ipolicy dict
1693 wrongkeys = frozenset(self.ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
1695 # These keys would be silently removed by FillIPolicy()
1696 msg = ("Cluster instance policy contains spurious keys: %s" %
1697 utils.CommaJoin(wrongkeys))
1698 raise errors.ConfigurationError(msg)
1699 self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, self.ipolicy)
1702 def primary_hypervisor(self):
1703 """The first hypervisor is the primary.
1705 Useful, for example, for L{Node}'s hv/disk state.
1708 return self.enabled_hypervisors[0]
1711 """Custom function for cluster.
1714 mydict = super(Cluster, self).ToDict()
1716 if self.tcpudp_port_pool is None:
1717 tcpudp_port_pool = []
1719 tcpudp_port_pool = list(self.tcpudp_port_pool)
1721 mydict["tcpudp_port_pool"] = tcpudp_port_pool
1726 def FromDict(cls, val):
1727 """Custom function for cluster.
1730 obj = super(Cluster, cls).FromDict(val)
1732 if obj.tcpudp_port_pool is None:
1733 obj.tcpudp_port_pool = set()
1734 elif not isinstance(obj.tcpudp_port_pool, set):
1735 obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
1739 def SimpleFillDP(self, diskparams):
1740 """Fill a given diskparams dict with cluster defaults.
1742 @param diskparams: The diskparams
1743 @return: The defaults dict
1746 return FillDiskParams(self.diskparams, diskparams)
1748 def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
1749 """Get the default hypervisor parameters for the cluster.
1751 @param hypervisor: the hypervisor name
1752 @param os_name: if specified, we'll also update the defaults for this OS
1753 @param skip_keys: if passed, list of keys not to use
1754 @return: the defaults dict
1757 if skip_keys is None:
1760 fill_stack = [self.hvparams.get(hypervisor, {})]
1761 if os_name is not None:
1762 os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
1763 fill_stack.append(os_hvp)
1766 for o_dict in fill_stack:
1767 ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)
1771 def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
1772 """Fill a given hvparams dict with cluster defaults.
1774 @type hv_name: string
1775 @param hv_name: the hypervisor to use
1776 @type os_name: string
1777 @param os_name: the OS to use for overriding the hypervisor defaults
1778 @type skip_globals: boolean
1779 @param skip_globals: if True, the global hypervisor parameters will
1782 @return: a copy of the given hvparams with missing keys filled from
1783 the cluster defaults
1787 skip_keys = constants.HVC_GLOBALS
1791 def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
1792 return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1794 def FillHV(self, instance, skip_globals=False):
1795 """Fill an instance's hvparams dict with cluster defaults.
1797 @type instance: L{objects.Instance}
1798 @param instance: the instance parameter to fill
1799 @type skip_globals: boolean
1800 @param skip_globals: if True, the global hypervisor parameters will
1803 @return: a copy of the instance's hvparams with missing keys filled from
1804 the cluster defaults
1807 return self.SimpleFillHV(instance.hypervisor, instance.os,
1808 instance.hvparams, skip_globals)
1810 def SimpleFillBE(self, beparams):
1811 """Fill a given beparams dict with cluster defaults.
1813 @type beparams: dict
1814 @param beparams: the dict to fill
1816 @return: a copy of the passed in beparams with missing keys filled
1817 from the cluster defaults
1820 return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1822 def FillBE(self, instance):
1823 """Fill an instance's beparams dict with cluster defaults.
1825 @type instance: L{objects.Instance}
1826 @param instance: the instance parameter to fill
1828 @return: a copy of the instance's beparams with missing keys filled from
1829 the cluster defaults
1832 return self.SimpleFillBE(instance.beparams)
1834 def SimpleFillNIC(self, nicparams):
1835 """Fill a given nicparams dict with cluster defaults.
1837 @type nicparams: dict
1838 @param nicparams: the dict to fill
1840 @return: a copy of the passed in nicparams with missing keys filled
1841 from the cluster defaults
1844 return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1846 def SimpleFillOS(self, os_name, os_params):
1847 """Fill an instance's osparams dict with cluster defaults.
1849 @type os_name: string
1850 @param os_name: the OS name to use
1851 @type os_params: dict
1852 @param os_params: the dict to fill with default values
1854 @return: a copy of the instance's osparams with missing keys filled from
1855 the cluster defaults
1858 name_only = os_name.split("+", 1)[0]
1860 result = self.osparams.get(name_only, {})
1862 result = FillDict(result, self.osparams.get(os_name, {}))
1864 return FillDict(result, os_params)
1867 def SimpleFillHvState(hv_state):
1868 """Fill an hv_state sub dict with cluster defaults.
1871 return FillDict(constants.HVST_DEFAULTS, hv_state)
1874 def SimpleFillDiskState(disk_state):
1875 """Fill an disk_state sub dict with cluster defaults.
1878 return FillDict(constants.DS_DEFAULTS, disk_state)
1880 def FillND(self, node, nodegroup):
1881 """Return filled out ndparams for L{objects.NodeGroup} and L{objects.Node}
1883 @type node: L{objects.Node}
1884 @param node: A Node object to fill
1885 @type nodegroup: L{objects.NodeGroup}
1886 @param nodegroup: A Node object to fill
1887 @return a copy of the node's ndparams with defaults filled
1890 return self.SimpleFillND(nodegroup.FillND(node))
1892 def SimpleFillND(self, ndparams):
1893 """Fill a given ndparams dict with defaults.
1895 @type ndparams: dict
1896 @param ndparams: the dict to fill
1898 @return: a copy of the passed in ndparams with missing keys filled
1899 from the cluster defaults
1902 return FillDict(self.ndparams, ndparams)
1904 def SimpleFillIPolicy(self, ipolicy):
1905 """ Fill instance policy dict with defaults.
1908 @param ipolicy: the dict to fill
1910 @return: a copy of passed ipolicy with missing keys filled from
1911 the cluster defaults
1914 return FillIPolicy(self.ipolicy, ipolicy)
1917 class BlockDevStatus(ConfigObject):
1918 """Config object representing the status of a block device."""
1930 class ImportExportStatus(ConfigObject):
1931 """Config object representing the status of an import or export."""
1937 "progress_throughput",
1945 class ImportExportOptions(ConfigObject):
1946 """Options for import/export daemon
1948 @ivar key_name: X509 key name (None for cluster certificate)
1949 @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1950 @ivar compress: Compression method (one of L{constants.IEC_ALL})
1951 @ivar magic: Used to ensure the connection goes to the right disk
1952 @ivar ipv6: Whether to use IPv6
1953 @ivar connect_timeout: Number of seconds for establishing connection
1966 class ConfdRequest(ConfigObject):
1967 """Object holding a confd request.
1969 @ivar protocol: confd protocol version
1970 @ivar type: confd query type
1971 @ivar query: query request
1972 @ivar rsalt: requested reply salt
1983 class ConfdReply(ConfigObject):
1984 """Object holding a confd reply.
1986 @ivar protocol: confd protocol version
1987 @ivar status: reply status code (ok, error)
1988 @ivar answer: confd query reply
1989 @ivar serial: configuration serial number
2000 class QueryFieldDefinition(ConfigObject):
2001 """Object holding a query field definition.
2003 @ivar name: Field name
2004 @ivar title: Human-readable title
2005 @ivar kind: Field type
2006 @ivar doc: Human-readable description
2017 class _QueryResponseBase(ConfigObject):
2023 """Custom function for serializing.
2026 mydict = super(_QueryResponseBase, self).ToDict()
2027 mydict["fields"] = outils.ContainerToDicts(mydict["fields"])
2031 def FromDict(cls, val):
2032 """Custom function for de-serializing.
2035 obj = super(_QueryResponseBase, cls).FromDict(val)
2037 outils.ContainerFromDicts(obj.fields, list, QueryFieldDefinition)
2041 class QueryResponse(_QueryResponseBase):
2042 """Object holding the response to a query.
2044 @ivar fields: List of L{QueryFieldDefinition} objects
2045 @ivar data: Requested data
2053 class QueryFieldsRequest(ConfigObject):
2054 """Object holding a request for querying available fields.
2063 class QueryFieldsResponse(_QueryResponseBase):
2064 """Object holding the response to a query for fields.
2066 @ivar fields: List of L{QueryFieldDefinition} objects
2072 class MigrationStatus(ConfigObject):
2073 """Object holding the status of a migration.
2083 class InstanceConsole(ConfigObject):
2084 """Object describing how to access the console of an instance.
2099 """Validates contents of this object.
2102 assert self.kind in constants.CONS_ALL, "Unknown console type"
2103 assert self.instance, "Missing instance name"
2104 assert self.message or self.kind in [constants.CONS_SSH,
2105 constants.CONS_SPICE,
2107 assert self.host or self.kind == constants.CONS_MESSAGE
2108 assert self.port or self.kind in [constants.CONS_MESSAGE,
2110 assert self.user or self.kind in [constants.CONS_MESSAGE,
2111 constants.CONS_SPICE,
2113 assert self.command or self.kind in [constants.CONS_MESSAGE,
2114 constants.CONS_SPICE,
2116 assert self.display or self.kind in [constants.CONS_MESSAGE,
2117 constants.CONS_SPICE,
2122 class Network(TaggableObject):
2123 """Object representing a network definition for ganeti.
2136 ] + _TIMESTAMPS + _UUID
2138 def HooksDict(self, prefix=""):
2139 """Export a dictionary used by hooks with a network's information.
2141 @type prefix: String
2142 @param prefix: Prefix to prepend to the dict entries
2146 "%sNETWORK_NAME" % prefix: self.name,
2147 "%sNETWORK_UUID" % prefix: self.uuid,
2148 "%sNETWORK_TAGS" % prefix: " ".join(self.GetTags()),
2151 result["%sNETWORK_SUBNET" % prefix] = self.network
2153 result["%sNETWORK_GATEWAY" % prefix] = self.gateway
2155 result["%sNETWORK_SUBNET6" % prefix] = self.network6
2157 result["%sNETWORK_GATEWAY6" % prefix] = self.gateway6
2159 result["%sNETWORK_MAC_PREFIX" % prefix] = self.mac_prefix
2164 def FromDict(cls, val):
2165 """Custom function for networks.
2167 Remove deprecated network_type and family.
2170 if "network_type" in val:
2171 del val["network_type"]
2174 obj = super(Network, cls).FromDict(val)
2178 class SerializableConfigParser(ConfigParser.SafeConfigParser):
2179 """Simple wrapper over ConfigParse that allows serialization.
2181 This class is basically ConfigParser.SafeConfigParser with two
2182 additional methods that allow it to serialize/unserialize to/from a
2187 """Dump this instance and return the string representation."""
2190 return buf.getvalue()
2193 def Loads(cls, data):
2194 """Load data from a string."""
2195 buf = StringIO(data)
2201 class LvmPvInfo(ConfigObject):
2202 """Information about an LVM physical volume (PV).
2205 @ivar name: name of the PV
2206 @type vg_name: string
2207 @ivar vg_name: name of the volume group containing the PV
2209 @ivar size: size of the PV in MiB
2211 @ivar free: free space in the PV, in MiB
2212 @type attributes: string
2213 @ivar attributes: PV attributes
2214 @type lv_list: list of strings
2215 @ivar lv_list: names of the LVs hosted on the PV
2227 """Is this PV empty?
2230 return self.size <= (self.free + 1)
2232 def IsAllocatable(self):
2233 """Is this PV allocatable?
2236 return ("a" in self.attributes)