X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/af1d39b1e882214edf40724ae989fb881111f634..4a78c361a6de3bcbf98f02abfe41ae3b11de2b00:/lib/objects.py diff --git a/lib/objects.py b/lib/objects.py index 19c6d8f..5ba4a1b 100644 --- a/lib/objects.py +++ b/lib/objects.py @@ -1,7 +1,7 @@ # # -# Copyright (C) 2006, 2007 Google Inc. +# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -26,24 +26,31 @@ pass to and from external parties. """ -# pylint: disable-msg=E0203,W0201 +# pylint: disable=E0203,W0201,R0902 # E0203: Access to member %r before its definition, since we use # objects.py which doesn't explicitely initialise its members # W0201: Attribute '%s' defined outside __init__ +# R0902: Allow instances of these objects to have more than 20 attributes + import ConfigParser import re import copy +import time from cStringIO import StringIO from ganeti import errors from ganeti import constants +from ganeti import netutils +from ganeti import utils + +from socket import AF_INET __all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance", - "OS", "Node", "Cluster", "FillDict"] + "OS", "Node", "NodeGroup", "Cluster", "FillDict"] _TIMESTAMPS = ["ctime", "mtime"] _UUID = ["uuid"] @@ -73,6 +80,39 @@ def FillDict(defaults_dict, custom_dict, skip_keys=None): return ret_dict +def FillIPolicy(default_ipolicy, custom_ipolicy, skip_keys=None): + """Fills an instance policy with defaults. + + """ + assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS + ret_dict = {} + for key in constants.IPOLICY_ISPECS: + ret_dict[key] = FillDict(default_ipolicy[key], + custom_ipolicy.get(key, {}), + skip_keys=skip_keys) + # list items + for key in [constants.IPOLICY_DTS]: + ret_dict[key] = list(custom_ipolicy.get(key, default_ipolicy[key])) + # other items which we know we can directly copy (immutables) + for key in constants.IPOLICY_PARAMETERS: + ret_dict[key] = custom_ipolicy.get(key, default_ipolicy[key]) + + return ret_dict + + +def FillDiskParams(default_dparams, custom_dparams, skip_keys=None): + """Fills the disk parameter defaults. + + @see: L{FillDict} for parameters and return value + + """ + assert frozenset(default_dparams.keys()) == constants.DISK_TEMPLATES + + return dict((dt, FillDict(default_dparams[dt], custom_dparams.get(dt, {}), + skip_keys=skip_keys)) + for dt in constants.DISK_TEMPLATES) + + def UpgradeGroupedParams(target, defaults): """Update all groups for the target parameter. @@ -90,6 +130,63 @@ def UpgradeGroupedParams(target, defaults): return target +def UpgradeBeParams(target): + """Update the be parameters dict to the new format. + + @type target: dict + @param target: "be" parameters dict + + """ + if constants.BE_MEMORY in target: + memory = target[constants.BE_MEMORY] + target[constants.BE_MAXMEM] = memory + target[constants.BE_MINMEM] = memory + del target[constants.BE_MEMORY] + + +def UpgradeDiskParams(diskparams): + """Upgrade the disk parameters. + + @type diskparams: dict + @param diskparams: disk parameters to upgrade + @rtype: dict + @return: the upgraded disk parameters dict + + """ + if not diskparams: + result = {} + else: + result = FillDiskParams(constants.DISK_DT_DEFAULTS, diskparams) + + return result + + +def UpgradeNDParams(ndparams): + """Upgrade ndparams structure. + + @type ndparams: dict + @param ndparams: disk parameters to upgrade + @rtype: dict + @return: the upgraded node parameters dict + + """ + if ndparams is None: + ndparams = {} + + return FillDict(constants.NDC_DEFAULTS, ndparams) + + +def MakeEmptyIPolicy(): + """Create empty IPolicy dictionary. + + """ + return dict([ + (constants.ISPECS_MIN, {}), + (constants.ISPECS_MAX, {}), + (constants.ISPECS_STD, {}), + ]) + + class ConfigObject(object): """A generic config object. @@ -131,6 +228,9 @@ class ConfigObject(object): slots.extend(getattr(parent, "__slots__", [])) return slots + #: Public getter for the defined slots + GetAllSlots = _all_slots + def ToDict(self): """Convert to a dict holding only standard python types. @@ -167,7 +267,7 @@ class ConfigObject(object): raise errors.ConfigurationError("Invalid object passed to FromDict:" " expected dict, got %s" % type(val)) val_str = dict([(str(k), v) for k, v in val.iteritems()]) - obj = cls(**val_str) # pylint: disable-msg=W0142 + obj = cls(**val_str) # pylint: disable=W0142 return obj @staticmethod @@ -200,6 +300,8 @@ class ConfigObject(object): if not isinstance(c_type, type): raise TypeError("Container type %s passed to _ContainerFromDicts is" " not a type" % type(c_type)) + if source is None: + source = c_type() if c_type is dict: ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()]) elif c_type in (list, tuple, set, frozenset): @@ -310,10 +412,35 @@ class TaggableObject(ConfigObject): return obj +class MasterNetworkParameters(ConfigObject): + """Network configuration parameters for the master + + @ivar name: master name + @ivar ip: master IP + @ivar netmask: master netmask + @ivar netdev: master network device + @ivar ip_family: master IP family + + """ + __slots__ = [ + "name", + "ip", + "netmask", + "netdev", + "ip_family" + ] + + class ConfigData(ConfigObject): """Top-level config object.""" - __slots__ = (["version", "cluster", "nodes", "instances", "serial_no"] + - _TIMESTAMPS) + __slots__ = [ + "version", + "cluster", + "nodes", + "nodegroups", + "instances", + "serial_no", + ] + _TIMESTAMPS def ToDict(self): """Custom function for top-level config data. @@ -324,7 +451,7 @@ class ConfigData(ConfigObject): """ mydict = super(ConfigData, self).ToDict() mydict["cluster"] = mydict["cluster"].ToDict() - for key in "nodes", "instances": + for key in "nodes", "instances", "nodegroups": mydict[key] = self._ContainerToDicts(mydict[key]) return mydict @@ -338,8 +465,24 @@ class ConfigData(ConfigObject): obj.cluster = Cluster.FromDict(obj.cluster) obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node) obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance) + obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup) return obj + def HasAnyDiskOfType(self, dev_type): + """Check if in there is at disk of the given type in the configuration. + + @type dev_type: L{constants.LDS_BLOCK} + @param dev_type: the type to look for + @rtype: boolean + @return: boolean indicating if a disk of the given type was found or not + + """ + for instance in self.instances.values(): + for disk in instance.disks: + if disk.IsBasedOnDiskType(dev_type): + return True + return False + def UpgradeConfig(self): """Fill defaults for missing configuration values. @@ -349,11 +492,21 @@ class ConfigData(ConfigObject): node.UpgradeConfig() for instance in self.instances.values(): instance.UpgradeConfig() + if self.nodegroups is None: + self.nodegroups = {} + for nodegroup in self.nodegroups.values(): + nodegroup.UpgradeConfig() + if self.cluster.drbd_usermode_helper is None: + # To decide if we set an helper let's check if at least one instance has + # a DRBD disk. This does not cover all the possible scenarios but it + # gives a good approximation. + if self.HasAnyDiskOfType(constants.LD_DRBD8): + self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER class NIC(ConfigObject): """Config object representing a network card.""" - __slots__ = ["mac", "ip", "bridge", "nicparams"] + __slots__ = ["mac", "ip", "nicparams"] @classmethod def CheckParameterSyntax(cls, nicparams): @@ -364,7 +517,8 @@ class NIC(ConfigObject): @raise errors.ConfigurationError: when a parameter is not valid """ - if nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES: + if (nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES and + nicparams[constants.NIC_MODE] != constants.VALUE_AUTO): err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE] raise errors.ConfigurationError(err) @@ -373,25 +527,11 @@ class NIC(ConfigObject): err = "Missing bridged nic link" raise errors.ConfigurationError(err) - def UpgradeConfig(self): - """Fill defaults for missing configuration values. - - """ - if self.nicparams is None: - self.nicparams = {} - if self.bridge is not None: - self.nicparams[constants.NIC_MODE] = constants.NIC_MODE_BRIDGED - self.nicparams[constants.NIC_LINK] = self.bridge - # bridge is no longer used it 2.1. The slot is left there to support - # upgrading, but will be removed in 2.2 - if self.bridge is not None: - self.bridge = None - class Disk(ConfigObject): """Config object representing a block device.""" __slots__ = ["dev_type", "logical_id", "physical_id", - "children", "iv_name", "size", "mode"] + "children", "iv_name", "size", "mode", "params"] def CreateOnSecondary(self): """Test if this device needs to be created on a secondary node.""" @@ -418,6 +558,10 @@ class Disk(ConfigObject): """ if self.dev_type == constants.LD_LV: return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1]) + elif self.dev_type == constants.LD_BLOCKDEV: + return self.logical_id[1] + elif self.dev_type == constants.LD_RBD: + return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1]) return None def ChildrenNeeded(self): @@ -436,6 +580,21 @@ class Disk(ConfigObject): return 0 return -1 + def IsBasedOnDiskType(self, dev_type): + """Check if the disk or its children are based on the given type. + + @type dev_type: L{constants.LDS_BLOCK} + @param dev_type: the type to look for + @rtype: boolean + @return: boolean indicating if a device of the given type was found or not + + """ + if self.children: + for child in self.children: + if child.IsBasedOnDiskType(dev_type): + return True + return self.dev_type == dev_type + def GetNodes(self, node): """This function returns the nodes this device lives on. @@ -445,7 +604,8 @@ class Disk(ConfigObject): devices needs to (or can) be assembled. """ - if self.dev_type in [constants.LD_LV, constants.LD_FILE]: + if self.dev_type in [constants.LD_LV, constants.LD_FILE, + constants.LD_BLOCKDEV, constants.LD_RBD]: result = [node] elif self.dev_type in constants.LDS_DRBD: result = [self.logical_id[0], self.logical_id[1]] @@ -490,6 +650,28 @@ class Disk(ConfigObject): # be different) return result + def ComputeGrowth(self, amount): + """Compute the per-VG growth requirements. + + This only works for VG-based disks. + + @type amount: integer + @param amount: the desired increase in (user-visible) disk space + @rtype: dict + @return: a dictionary of volume-groups and the required size + + """ + if self.dev_type == constants.LD_LV: + return {self.logical_id[0]: amount} + elif self.dev_type == constants.LD_DRBD8: + if self.children: + return self.children[0].ComputeGrowth(amount) + else: + return {} + else: + # Other disk types do not require VG space + return {} + def RecordGrow(self, amount): """Update the size of this disk after growth. @@ -498,7 +680,8 @@ class Disk(ConfigObject): actual algorithms from bdev. """ - if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_FILE: + if self.dev_type in (constants.LD_LV, constants.LD_FILE, + constants.LD_RBD): self.size += amount elif self.dev_type == constants.LD_DRBD8: if self.children: @@ -508,6 +691,21 @@ class Disk(ConfigObject): raise errors.ProgrammerError("Disk.RecordGrow called for unsupported" " disk type %s" % self.dev_type) + def Update(self, size=None, mode=None): + """Apply changes to size and mode. + + """ + if self.dev_type == constants.LD_DRBD8: + if self.children: + self.children[0].Update(size=size, mode=mode) + else: + assert not self.children + + if size is not None: + self.size = size + if mode is not None: + self.mode = mode + def UnsetSize(self): """Sets recursively the size to zero for the disk and its children. @@ -599,7 +797,7 @@ class Disk(ConfigObject): """ if self.dev_type == constants.LD_LV: - val = " parameters + @rtype: list(dict) + @return: a list of dicts, one for each node of the disk hierarchy. Each dict + contains the LD parameters of the node. The tree is flattened in-order. + + """ + if disk_template not in constants.DISK_TEMPLATES: + raise errors.ProgrammerError("Unknown disk template %s" % disk_template) + + assert disk_template in disk_params + + result = list() + dt_params = disk_params[disk_template] + if disk_template == constants.DT_DRBD8: + drbd_params = { + constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE], + constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS], + constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS], + constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG], + constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM], + constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM], + constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC], + constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD], + constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET], + constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET], + constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE], + constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE], + } + + drbd_params = \ + FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], + drbd_params) + + result.append(drbd_params) + + # data LV + data_params = { + constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES], + } + data_params = \ + FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], + data_params) + result.append(data_params) + + # metadata LV + meta_params = { + constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES], + } + meta_params = \ + FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], + meta_params) + result.append(meta_params) + + elif (disk_template == constants.DT_FILE or + disk_template == constants.DT_SHARED_FILE): + result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE]) + + elif disk_template == constants.DT_PLAIN: + params = { + constants.LDP_STRIPES: dt_params[constants.LV_STRIPES], + } + params = \ + FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], + params) + result.append(params) + + elif disk_template == constants.DT_BLOCK: + result.append(constants.DISK_LD_DEFAULTS[constants.LD_BLOCKDEV]) + + elif disk_template == constants.DT_RBD: + params = { + constants.LDP_POOL: dt_params[constants.RBD_POOL] + } + params = \ + FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], + params) + result.append(params) + + return result + + +class InstancePolicy(ConfigObject): + """Config object representing instance policy limits dictionary. + + + Note that this object is not actually used in the config, it's just + used as a placeholder for a few functions. + + """ + @classmethod + def CheckParameterSyntax(cls, ipolicy): + """ Check the instance policy for validity. + + """ + for param in constants.ISPECS_PARAMETERS: + InstancePolicy.CheckISpecSyntax(ipolicy, param) + if constants.IPOLICY_DTS in ipolicy: + InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS]) + for key in constants.IPOLICY_PARAMETERS: + if key in ipolicy: + InstancePolicy.CheckParameter(key, ipolicy[key]) + wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS + if wrong_keys: + raise errors.ConfigurationError("Invalid keys in ipolicy: %s" % + utils.CommaJoin(wrong_keys)) + + @classmethod + def CheckISpecSyntax(cls, ipolicy, name): + """Check the instance policy for validity on a given key. + + We check if the instance policy makes sense for a given key, that is + if ipolicy[min][name] <= ipolicy[std][name] <= ipolicy[max][name]. + + @type ipolicy: dict + @param ipolicy: dictionary with min, max, std specs + @type name: string + @param name: what are the limits for + @raise errors.ConfigureError: when specs for given name are not valid + + """ + min_v = ipolicy[constants.ISPECS_MIN].get(name, 0) + std_v = ipolicy[constants.ISPECS_STD].get(name, min_v) + max_v = ipolicy[constants.ISPECS_MAX].get(name, std_v) + err = ("Invalid specification of min/max/std values for %s: %s/%s/%s" % + (name, + ipolicy[constants.ISPECS_MIN].get(name, "-"), + ipolicy[constants.ISPECS_MAX].get(name, "-"), + ipolicy[constants.ISPECS_STD].get(name, "-"))) + if min_v > std_v or std_v > max_v: + raise errors.ConfigurationError(err) + + @classmethod + def CheckDiskTemplates(cls, disk_templates): + """Checks the disk templates for validity. + + """ + wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES) + if wrong: + raise errors.ConfigurationError("Invalid disk template(s) %s" % + utils.CommaJoin(wrong)) + + @classmethod + def CheckParameter(cls, key, value): + """Checks a parameter. + + Currently we expect all parameters to be float values. + + """ + try: + float(value) + except (TypeError, ValueError), err: + raise errors.ConfigurationError("Invalid value for key" " '%s':" + " '%s', error: %s" % (key, value, err)) + class Instance(TaggableObject): """Config object representing an instance.""" @@ -657,7 +1023,8 @@ class Instance(TaggableObject): "hypervisor", "hvparams", "beparams", - "admin_up", + "osparams", + "admin_state", "nics", "disks", "disk_template", @@ -715,15 +1082,19 @@ class Instance(TaggableObject): @param lvmap: optional dictionary to receive the 'node' : ['lv', ...] data. - @return: None if lvmap arg is given, otherwise, a dictionary - of the form { 'nodename' : ['volume1', 'volume2', ...], ... } + @return: None if lvmap arg is given, otherwise, a dictionary of + the form { 'nodename' : ['volume1', 'volume2', ...], ... }; + volumeN is of the form "vg_name/lv_name", compatible with + GetVolumeList() """ if node == None: node = self.primary_node if lvmap is None: - lvmap = { node : [] } + lvmap = { + node: [], + } ret = lvmap else: if not node in lvmap: @@ -735,7 +1106,7 @@ class Instance(TaggableObject): for dev in devs: if dev.dev_type == constants.LD_LV: - lvmap[node].append(dev.logical_id[1]) + lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1]) elif dev.dev_type in constants.LDS_DRBD: if dev.children: @@ -767,7 +1138,7 @@ class Instance(TaggableObject): errors.ECODE_INVAL) except IndexError: raise errors.OpPrereqError("Invalid disk index: %d (instace has disks" - " 0 to %d" % (idx, len(self.disks)), + " 0 to %d" % (idx, len(self.disks) - 1), errors.ECODE_INVAL) def ToDict(self): @@ -793,6 +1164,13 @@ class Instance(TaggableObject): """Custom function for instances. """ + if "admin_state" not in val: + if val.get("admin_up", False): + val["admin_state"] = constants.ADMINST_UP + else: + val["admin_state"] = constants.ADMINST_DOWN + if "admin_up" in val: + del val["admin_up"] obj = super(Instance, cls).FromDict(val) obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC) obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk) @@ -812,10 +1190,22 @@ class Instance(TaggableObject): del self.hvparams[key] except KeyError: pass + if self.osparams is None: + self.osparams = {} + UpgradeBeParams(self.beparams) class OS(ConfigObject): - """Config object representing an operating system.""" + """Config object representing an operating system. + + @type supported_parameters: list + @ivar supported_parameters: a list of tuples, name and description, + containing the supported parameters by this OS + + @type VARIANT_DELIM: string + @cvar VARIANT_DELIM: the variant delimiter + + """ __slots__ = [ "name", "path", @@ -824,12 +1214,90 @@ class OS(ConfigObject): "export_script", "import_script", "rename_script", + "verify_script", "supported_variants", + "supported_parameters", ] + VARIANT_DELIM = "+" + + @classmethod + def SplitNameVariant(cls, name): + """Splits the name into the proper name and variant. + + @param name: the OS (unprocessed) name + @rtype: list + @return: a list of two elements; if the original name didn't + contain a variant, it's returned as an empty string + + """ + nv = name.split(cls.VARIANT_DELIM, 1) + if len(nv) == 1: + nv.append("") + return nv + + @classmethod + def GetName(cls, name): + """Returns the proper name of the os (without the variant). + + @param name: the OS (unprocessed) name + + """ + return cls.SplitNameVariant(name)[0] + + @classmethod + def GetVariant(cls, name): + """Returns the variant the os (without the base name). + + @param name: the OS (unprocessed) name + + """ + return cls.SplitNameVariant(name)[1] + + +class NodeHvState(ConfigObject): + """Hypvervisor state on a node. + + @ivar mem_total: Total amount of memory + @ivar mem_node: Memory used by, or reserved for, the node itself (not always + available) + @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation + rounding + @ivar mem_inst: Memory used by instances living on node + @ivar cpu_total: Total node CPU core count + @ivar cpu_node: Number of CPU cores reserved for the node itself + + """ + __slots__ = [ + "mem_total", + "mem_node", + "mem_hv", + "mem_inst", + "cpu_total", + "cpu_node", + ] + _TIMESTAMPS + + +class NodeDiskState(ConfigObject): + """Disk state on a node. + + """ + __slots__ = [ + "total", + "reserved", + "overhead", + ] + _TIMESTAMPS + class Node(TaggableObject): - """Config object representing a node.""" + """Config object representing a node. + + @ivar hv_state: Hypervisor state (e.g. number of CPUs) + @ivar hv_state_static: Hypervisor state overriden by user + @ivar disk_state: Disk state (e.g. free space) + @ivar disk_state_static: Disk state overriden by user + + """ __slots__ = [ "name", "primary_ip", @@ -838,8 +1306,152 @@ class Node(TaggableObject): "master_candidate", "offline", "drained", + "group", + "master_capable", + "vm_capable", + "ndparams", + "powered", + "hv_state", + "hv_state_static", + "disk_state", + "disk_state_static", ] + _TIMESTAMPS + _UUID + def UpgradeConfig(self): + """Fill defaults for missing configuration values. + + """ + # pylint: disable=E0203 + # because these are "defined" via slots, not manually + if self.master_capable is None: + self.master_capable = True + + if self.vm_capable is None: + self.vm_capable = True + + if self.ndparams is None: + self.ndparams = {} + + if self.powered is None: + self.powered = True + + def ToDict(self): + """Custom function for serializing. + + """ + data = super(Node, self).ToDict() + + hv_state = data.get("hv_state", None) + if hv_state is not None: + data["hv_state"] = self._ContainerToDicts(hv_state) + + disk_state = data.get("disk_state", None) + if disk_state is not None: + data["disk_state"] = \ + dict((key, self._ContainerToDicts(value)) + for (key, value) in disk_state.items()) + + return data + + @classmethod + def FromDict(cls, val): + """Custom function for deserializing. + + """ + obj = super(Node, cls).FromDict(val) + + if obj.hv_state is not None: + obj.hv_state = cls._ContainerFromDicts(obj.hv_state, dict, NodeHvState) + + if obj.disk_state is not None: + obj.disk_state = \ + dict((key, cls._ContainerFromDicts(value, dict, NodeDiskState)) + for (key, value) in obj.disk_state.items()) + + return obj + + +class NodeGroup(TaggableObject): + """Config object representing a node group.""" + __slots__ = [ + "name", + "members", + "ndparams", + "diskparams", + "ipolicy", + "serial_no", + "hv_state_static", + "disk_state_static", + "alloc_policy", + ] + _TIMESTAMPS + _UUID + + def ToDict(self): + """Custom function for nodegroup. + + This discards the members object, which gets recalculated and is only kept + in memory. + + """ + mydict = super(NodeGroup, self).ToDict() + del mydict["members"] + return mydict + + @classmethod + def FromDict(cls, val): + """Custom function for nodegroup. + + The members slot is initialized to an empty list, upon deserialization. + + """ + obj = super(NodeGroup, cls).FromDict(val) + obj.members = [] + return obj + + def UpgradeConfig(self): + """Fill defaults for missing configuration values. + + """ + if self.ndparams is None: + self.ndparams = {} + + if self.serial_no is None: + self.serial_no = 1 + + if self.alloc_policy is None: + self.alloc_policy = constants.ALLOC_POLICY_PREFERRED + + # We only update mtime, and not ctime, since we would not be able + # to provide a correct value for creation time. + if self.mtime is None: + self.mtime = time.time() + + if self.diskparams is None: + self.diskparams = {} + if self.ipolicy is None: + self.ipolicy = MakeEmptyIPolicy() + + def FillND(self, node): + """Return filled out ndparams for L{objects.Node} + + @type node: L{objects.Node} + @param node: A Node object to fill + @return a copy of the node's ndparams with defaults filled + + """ + return self.SimpleFillND(node.ndparams) + + def SimpleFillND(self, ndparams): + """Fill a given ndparams dict with defaults. + + @type ndparams: dict + @param ndparams: the dict to fill + @rtype: dict + @return: a copy of the passed in ndparams with missing keys filled + from the node group defaults + + """ + return FillDict(self.ndparams, ndparams) + class Cluster(TaggableObject): """Config object representing the cluster.""" @@ -850,30 +1462,46 @@ class Cluster(TaggableObject): "tcpudp_port_pool", "mac_prefix", "volume_group_name", + "reserved_lvs", + "drbd_usermode_helper", "default_bridge", "default_hypervisor", "master_node", "master_ip", "master_netdev", + "master_netmask", + "use_external_mip_script", "cluster_name", "file_storage_dir", + "shared_file_storage_dir", "enabled_hypervisors", "hvparams", + "ipolicy", "os_hvp", "beparams", + "osparams", "nicparams", + "ndparams", + "diskparams", "candidate_pool_size", "modify_etc_hosts", "modify_ssh_setup", "maintain_node_health", "uid_pool", + "default_iallocator", + "hidden_os", + "blacklisted_os", + "primary_ip_family", + "prealloc_wipe_disks", + "hv_state_static", + "disk_state_static", ] + _TIMESTAMPS + _UUID def UpgradeConfig(self): """Fill defaults for missing configuration values. """ - # pylint: disable-msg=E0203 + # pylint: disable=E0203 # because these are "defined" via slots, not manually if self.hvparams is None: self.hvparams = constants.HVC_DEFAULTS @@ -882,12 +1510,20 @@ class Cluster(TaggableObject): self.hvparams[hypervisor] = FillDict( constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor]) - # TODO: Figure out if it's better to put this into OS than Cluster if self.os_hvp is None: self.os_hvp = {} + # osparams added before 2.2 + if self.osparams is None: + self.osparams = {} + + self.ndparams = UpgradeNDParams(self.ndparams) + self.beparams = UpgradeGroupedParams(self.beparams, constants.BEC_DEFAULTS) + for beparams_group in self.beparams: + UpgradeBeParams(self.beparams[beparams_group]) + migrate_default_bridge = not self.nicparams self.nicparams = UpgradeGroupedParams(self.nicparams, constants.NICC_DEFAULTS) @@ -901,12 +1537,14 @@ class Cluster(TaggableObject): if self.modify_ssh_setup is None: self.modify_ssh_setup = True - # default_bridge is no longer used it 2.1. The slot is left there to - # support auto-upgrading, but will be removed in 2.2 + # default_bridge is no longer used in 2.1. The slot is left there to + # support auto-upgrading. It can be removed once we decide to deprecate + # upgrading straight from 2.0. if self.default_bridge is not None: self.default_bridge = None - # default_hypervisor is just the first enabled one in 2.1 + # default_hypervisor is just the first enabled one in 2.1. This slot and + # code can be removed once upgrading straight from 2.0 is deprecated. if self.default_hypervisor is not None: self.enabled_hypervisors = ([self.default_hypervisor] + [hvname for hvname in self.enabled_hypervisors @@ -920,6 +1558,61 @@ class Cluster(TaggableObject): if self.uid_pool is None: self.uid_pool = [] + if self.default_iallocator is None: + self.default_iallocator = "" + + # reserved_lvs added before 2.2 + if self.reserved_lvs is None: + self.reserved_lvs = [] + + # hidden and blacklisted operating systems added before 2.2.1 + if self.hidden_os is None: + self.hidden_os = [] + + if self.blacklisted_os is None: + self.blacklisted_os = [] + + # primary_ip_family added before 2.3 + if self.primary_ip_family is None: + self.primary_ip_family = AF_INET + + if self.master_netmask is None: + ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family) + self.master_netmask = ipcls.iplen + + if self.prealloc_wipe_disks is None: + self.prealloc_wipe_disks = False + + # shared_file_storage_dir added before 2.5 + if self.shared_file_storage_dir is None: + self.shared_file_storage_dir = "" + + if self.use_external_mip_script is None: + self.use_external_mip_script = False + + if self.diskparams: + self.diskparams = UpgradeDiskParams(self.diskparams) + else: + self.diskparams = constants.DISK_DT_DEFAULTS.copy() + + # instance policy added before 2.6 + if self.ipolicy is None: + self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, {}) + else: + # we can either make sure to upgrade the ipolicy always, or only + # do it in some corner cases (e.g. missing keys); note that this + # will break any removal of keys from the ipolicy dict + self.ipolicy = FillIPolicy(constants.IPOLICY_DEFAULTS, self.ipolicy) + + @property + def primary_hypervisor(self): + """The first hypervisor is the primary. + + Useful, for example, for L{Node}'s hv/disk state. + + """ + return self.enabled_hypervisors[0] + def ToDict(self): """Custom function for cluster. @@ -938,6 +1631,15 @@ class Cluster(TaggableObject): obj.tcpudp_port_pool = set(obj.tcpudp_port_pool) return obj + def SimpleFillDP(self, diskparams): + """Fill a given diskparams dict with cluster defaults. + + @param diskparams: The diskparams + @return: The defaults dict + + """ + return FillDiskParams(self.diskparams, diskparams) + def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None): """Get the default hypervisor parameters for the cluster. @@ -961,9 +1663,31 @@ class Cluster(TaggableObject): return ret_dict + def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False): + """Fill a given hvparams dict with cluster defaults. + + @type hv_name: string + @param hv_name: the hypervisor to use + @type os_name: string + @param os_name: the OS to use for overriding the hypervisor defaults + @type skip_globals: boolean + @param skip_globals: if True, the global hypervisor parameters will + not be filled + @rtype: dict + @return: a copy of the given hvparams with missing keys filled from + the cluster defaults + + """ + if skip_globals: + skip_keys = constants.HVC_GLOBALS + else: + skip_keys = [] + + def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys) + return FillDict(def_dict, hvparams, skip_keys=skip_keys) def FillHV(self, instance, skip_globals=False): - """Fill an instance's hvparams dict. + """Fill an instance's hvparams dict with cluster defaults. @type instance: L{objects.Instance} @param instance: the instance parameter to fill @@ -975,17 +1699,23 @@ class Cluster(TaggableObject): the cluster defaults """ - if skip_globals: - skip_keys = constants.HVC_GLOBALS - else: - skip_keys = [] + return self.SimpleFillHV(instance.hypervisor, instance.os, + instance.hvparams, skip_globals) + + def SimpleFillBE(self, beparams): + """Fill a given beparams dict with cluster defaults. - def_dict = self.GetHVDefaults(instance.hypervisor, instance.os, - skip_keys=skip_keys) - return FillDict(def_dict, instance.hvparams, skip_keys=skip_keys) + @type beparams: dict + @param beparams: the dict to fill + @rtype: dict + @return: a copy of the passed in beparams with missing keys filled + from the cluster defaults + + """ + return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams) def FillBE(self, instance): - """Fill an instance's beparams dict. + """Fill an instance's beparams dict with cluster defaults. @type instance: L{objects.Instance} @param instance: the instance parameter to fill @@ -994,8 +1724,89 @@ class Cluster(TaggableObject): the cluster defaults """ - return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), - instance.beparams) + return self.SimpleFillBE(instance.beparams) + + def SimpleFillNIC(self, nicparams): + """Fill a given nicparams dict with cluster defaults. + + @type nicparams: dict + @param nicparams: the dict to fill + @rtype: dict + @return: a copy of the passed in nicparams with missing keys filled + from the cluster defaults + + """ + return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams) + + def SimpleFillOS(self, os_name, os_params): + """Fill an instance's osparams dict with cluster defaults. + + @type os_name: string + @param os_name: the OS name to use + @type os_params: dict + @param os_params: the dict to fill with default values + @rtype: dict + @return: a copy of the instance's osparams with missing keys filled from + the cluster defaults + + """ + name_only = os_name.split("+", 1)[0] + # base OS + result = self.osparams.get(name_only, {}) + # OS with variant + result = FillDict(result, self.osparams.get(os_name, {})) + # specified params + return FillDict(result, os_params) + + @staticmethod + def SimpleFillHvState(hv_state): + """Fill an hv_state sub dict with cluster defaults. + + """ + return FillDict(constants.HVST_DEFAULTS, hv_state) + + @staticmethod + def SimpleFillDiskState(disk_state): + """Fill an disk_state sub dict with cluster defaults. + + """ + return FillDict(constants.DS_DEFAULTS, disk_state) + + def FillND(self, node, nodegroup): + """Return filled out ndparams for L{objects.NodeGroup} and L{objects.Node} + + @type node: L{objects.Node} + @param node: A Node object to fill + @type nodegroup: L{objects.NodeGroup} + @param nodegroup: A Node object to fill + @return a copy of the node's ndparams with defaults filled + + """ + return self.SimpleFillND(nodegroup.FillND(node)) + + def SimpleFillND(self, ndparams): + """Fill a given ndparams dict with defaults. + + @type ndparams: dict + @param ndparams: the dict to fill + @rtype: dict + @return: a copy of the passed in ndparams with missing keys filled + from the cluster defaults + + """ + return FillDict(self.ndparams, ndparams) + + def SimpleFillIPolicy(self, ipolicy): + """ Fill instance policy dict with defaults. + + @type ipolicy: dict + @param ipolicy: the dict to fill + @rtype: dict + @return: a copy of passed ipolicy with missing keys filled from + the cluster defaults + + """ + return FillIPolicy(self.ipolicy, ipolicy) class BlockDevStatus(ConfigObject): @@ -1033,6 +1844,8 @@ class ImportExportOptions(ConfigObject): @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate) @ivar compress: Compression method (one of L{constants.IEC_ALL}) @ivar magic: Used to ensure the connection goes to the right disk + @ivar ipv6: Whether to use IPv6 + @ivar connect_timeout: Number of seconds for establishing connection """ __slots__ = [ @@ -1040,6 +1853,8 @@ class ImportExportOptions(ConfigObject): "ca_pem", "compress", "magic", + "ipv6", + "connect_timeout", ] @@ -1077,6 +1892,128 @@ class ConfdReply(ConfigObject): ] +class QueryFieldDefinition(ConfigObject): + """Object holding a query field definition. + + @ivar name: Field name + @ivar title: Human-readable title + @ivar kind: Field type + @ivar doc: Human-readable description + + """ + __slots__ = [ + "name", + "title", + "kind", + "doc", + ] + + +class _QueryResponseBase(ConfigObject): + __slots__ = [ + "fields", + ] + + def ToDict(self): + """Custom function for serializing. + + """ + mydict = super(_QueryResponseBase, self).ToDict() + mydict["fields"] = self._ContainerToDicts(mydict["fields"]) + return mydict + + @classmethod + def FromDict(cls, val): + """Custom function for de-serializing. + + """ + obj = super(_QueryResponseBase, cls).FromDict(val) + obj.fields = cls._ContainerFromDicts(obj.fields, list, QueryFieldDefinition) + return obj + + +class QueryResponse(_QueryResponseBase): + """Object holding the response to a query. + + @ivar fields: List of L{QueryFieldDefinition} objects + @ivar data: Requested data + + """ + __slots__ = [ + "data", + ] + + +class QueryFieldsRequest(ConfigObject): + """Object holding a request for querying available fields. + + """ + __slots__ = [ + "what", + "fields", + ] + + +class QueryFieldsResponse(_QueryResponseBase): + """Object holding the response to a query for fields. + + @ivar fields: List of L{QueryFieldDefinition} objects + + """ + __slots__ = [ + ] + + +class MigrationStatus(ConfigObject): + """Object holding the status of a migration. + + """ + __slots__ = [ + "status", + "transferred_ram", + "total_ram", + ] + + +class InstanceConsole(ConfigObject): + """Object describing how to access the console of an instance. + + """ + __slots__ = [ + "instance", + "kind", + "message", + "host", + "port", + "user", + "command", + "display", + ] + + def Validate(self): + """Validates contents of this object. + + """ + assert self.kind in constants.CONS_ALL, "Unknown console type" + assert self.instance, "Missing instance name" + assert self.message or self.kind in [constants.CONS_SSH, + constants.CONS_SPICE, + constants.CONS_VNC] + assert self.host or self.kind == constants.CONS_MESSAGE + assert self.port or self.kind in [constants.CONS_MESSAGE, + constants.CONS_SSH] + assert self.user or self.kind in [constants.CONS_MESSAGE, + constants.CONS_SPICE, + constants.CONS_VNC] + assert self.command or self.kind in [constants.CONS_MESSAGE, + constants.CONS_SPICE, + constants.CONS_VNC] + assert self.display or self.kind in [constants.CONS_MESSAGE, + constants.CONS_SPICE, + constants.CONS_SSH] + return True + + class SerializableConfigParser(ConfigParser.SafeConfigParser): """Simple wrapper over ConfigParse that allows serialization.