X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/2d90608c0ebe560641be246ea266803d0a8e3ad8..31155d60eed6d14d25979c41c031f746e51d3c7d:/lib/objects.py diff --git a/lib/objects.py b/lib/objects.py index 43cea75..be6f2d7 100644 --- a/lib/objects.py +++ b/lib/objects.py @@ -26,6 +26,12 @@ pass to and from external parties. """ +# pylint: disable-msg=E0203,W0201 + +# 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__ import ConfigParser import re @@ -37,7 +43,51 @@ from ganeti import constants __all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance", - "OS", "Node", "Cluster"] + "OS", "Node", "Cluster", "FillDict"] + +_TIMESTAMPS = ["ctime", "mtime"] +_UUID = ["uuid"] + + +def FillDict(defaults_dict, custom_dict, skip_keys=None): + """Basic function to apply settings on top a default dict. + + @type defaults_dict: dict + @param defaults_dict: dictionary holding the default values + @type custom_dict: dict + @param custom_dict: dictionary holding customized value + @type skip_keys: list + @param skip_keys: which keys not to fill + @rtype: dict + @return: dict with the 'full' values + + """ + ret_dict = copy.deepcopy(defaults_dict) + ret_dict.update(custom_dict) + if skip_keys: + for k in skip_keys: + try: + del ret_dict[k] + except KeyError: + pass + return ret_dict + + +def UpgradeGroupedParams(target, defaults): + """Update all groups for the target parameter. + + @type target: dict of dicts + @param target: {group: {parameter: value}} + @type defaults: dict + @param defaults: default parameter values + + """ + if target is None: + target = {constants.PP_DEFAULT: defaults} + else: + for group in target: + target[group] = FillDict(defaults, target[group]) + return target class ConfigObject(object): @@ -60,28 +110,27 @@ class ConfigObject(object): setattr(self, k, v) def __getattr__(self, name): - if name not in self.__slots__: + if name not in self._all_slots(): raise AttributeError("Invalid object attribute %s.%s" % (type(self).__name__, name)) return None - def __setitem__(self, key, value): - if key not in self.__slots__: - raise KeyError(key) - setattr(self, key, value) - - def __getstate__(self): - state = {} - for name in self.__slots__: - if hasattr(self, name): - state[name] = getattr(self, name) - return state - def __setstate__(self, state): + slots = self._all_slots() for name in state: - if name in self.__slots__: + if name in slots: setattr(self, name, state[name]) + @classmethod + def _all_slots(cls): + """Compute the list of all declared slots for a class. + + """ + slots = [] + for parent in cls.__mro__: + slots.extend(getattr(parent, "__slots__", [])) + return slots + def ToDict(self): """Convert to a dict holding only standard python types. @@ -92,7 +141,14 @@ class ConfigObject(object): make sure all objects returned are only standard python types. """ - return dict([(k, getattr(self, k, None)) for k in self.__slots__]) + result = {} + for name in self._all_slots(): + value = getattr(self, name, None) + if value is not None: + result[name] = value + return result + + __getstate__ = ToDict @classmethod def FromDict(cls, val): @@ -111,7 +167,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) + obj = cls(**val_str) # pylint: disable-msg=W0142 return obj @staticmethod @@ -179,10 +235,11 @@ class TaggableObject(ConfigObject): """An generic class supporting tags. """ - __slots__ = ConfigObject.__slots__ + ["tags"] + __slots__ = ["tags"] + VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$") - @staticmethod - def ValidateTag(tag): + @classmethod + def ValidateTag(cls, tag): """Check if a tag is valid. If the tag is invalid, an errors.TagError will be raised. The @@ -196,7 +253,7 @@ class TaggableObject(ConfigObject): constants.MAX_TAG_LEN) if not tag: raise errors.TagError("Tags cannot be empty") - if not re.match("^[\w.+*/:-]+$", tag): + if not cls.VALID_TAG_RE.match(tag): raise errors.TagError("Tag contains invalid characters") def GetTags(self): @@ -255,7 +312,8 @@ class TaggableObject(ConfigObject): class ConfigData(ConfigObject): """Top-level config object.""" - __slots__ = ["version", "cluster", "nodes", "instances", "serial_no"] + __slots__ = (["version", "cluster", "nodes", "instances", "serial_no"] + + _TIMESTAMPS) def ToDict(self): """Custom function for top-level config data. @@ -282,6 +340,21 @@ class ConfigData(ConfigObject): obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance) 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. @@ -291,11 +364,50 @@ class ConfigData(ConfigObject): node.UpgradeConfig() for instance in self.instances.values(): instance.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"] + __slots__ = ["mac", "ip", "bridge", "nicparams"] + + @classmethod + def CheckParameterSyntax(cls, nicparams): + """Check the given parameters for validity. + + @type nicparams: dict + @param nicparams: dictionary with parameter names/value + @raise errors.ConfigurationError: when a parameter is not valid + + """ + if nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES: + err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE] + raise errors.ConfigurationError(err) + + if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and + not nicparams[constants.NIC_LINK]): + 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 can be removed once upgrades to the current version + # straight from 2.0 are deprecated. + if self.bridge is not None: + self.bridge = None class Disk(ConfigObject): @@ -322,6 +434,9 @@ class Disk(ConfigObject): irrespective of their status. For such devices, we return this path, for others we return None. + @warning: The path returned is not a normalized pathname; callers + should check that it is a valid path. + """ if self.dev_type == constants.LD_LV: return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1]) @@ -343,6 +458,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. @@ -405,7 +535,7 @@ class Disk(ConfigObject): actual algorithms from bdev. """ - if self.dev_type == constants.LD_LV: + if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_FILE: self.size += amount elif self.dev_type == constants.LD_DRBD8: if self.children: @@ -557,20 +687,21 @@ class Disk(ConfigObject): class Instance(TaggableObject): """Config object representing an instance.""" - __slots__ = TaggableObject.__slots__ + [ + __slots__ = [ "name", "primary_node", "os", "hypervisor", "hvparams", "beparams", + "osparams", "admin_up", "nics", "disks", "disk_template", "network_port", "serial_no", - ] + ] + _TIMESTAMPS + _UUID def _ComputeSecondaryNodes(self): """Compute the list of secondary nodes. @@ -669,11 +800,13 @@ class Instance(TaggableObject): try: idx = int(idx) return self.disks[idx] - except ValueError, err: - raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err)) + except (TypeError, ValueError), err: + raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err), + 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)), + errors.ECODE_INVAL) def ToDict(self): """Instance-specific conversion to standard python types. @@ -711,44 +844,41 @@ class Instance(TaggableObject): nic.UpgradeConfig() for disk in self.disks: disk.UpgradeConfig() + if self.hvparams: + for key in constants.HVC_GLOBALS: + try: + del self.hvparams[key] + except KeyError: + pass + if self.osparams is None: + self.osparams = {} 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 + + """ __slots__ = [ "name", "path", - "status", "api_versions", "create_script", "export_script", "import_script", "rename_script", + "verify_script", + "supported_variants", + "supported_parameters", ] - @classmethod - def FromInvalidOS(cls, err): - """Create an OS from an InvalidOS error. - - This routine knows how to convert an InvalidOS error to an OS - object representing the broken OS with a meaningful error message. - - """ - if not isinstance(err, errors.InvalidOS): - raise errors.ProgrammerError("Trying to initialize an OS from an" - " invalid object of type %s" % type(err)) - - return cls(name=err.args[0], path=err.args[1], status=err.args[2]) - - def __nonzero__(self): - return self.status == constants.OS_VALID_STATUS - - __bool__ = __nonzero__ - class Node(TaggableObject): """Config object representing a node.""" - __slots__ = TaggableObject.__slots__ + [ + __slots__ = [ "name", "primary_ip", "secondary_ip", @@ -756,18 +886,19 @@ class Node(TaggableObject): "master_candidate", "offline", "drained", - ] + ] + _TIMESTAMPS + _UUID class Cluster(TaggableObject): """Config object representing the cluster.""" - __slots__ = TaggableObject.__slots__ + [ + __slots__ = [ "serial_no", "rsahostkeypub", "highest_used_port", "tcpudp_port_pool", "mac_prefix", "volume_group_name", + "drbd_usermode_helper", "default_bridge", "default_hypervisor", "master_node", @@ -777,32 +908,77 @@ class Cluster(TaggableObject): "file_storage_dir", "enabled_hypervisors", "hvparams", + "os_hvp", "beparams", + "osparams", + "nicparams", "candidate_pool_size", "modify_etc_hosts", - ] + "modify_ssh_setup", + "maintain_node_health", + "uid_pool", + "default_iallocator", + ] + _TIMESTAMPS + _UUID def UpgradeConfig(self): """Fill defaults for missing configuration values. """ + # pylint: disable-msg=E0203 + # because these are "defined" via slots, not manually if self.hvparams is None: self.hvparams = constants.HVC_DEFAULTS else: for hypervisor in self.hvparams: - self.hvparams[hypervisor] = self.FillDict( + self.hvparams[hypervisor] = FillDict( constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor]) - if self.beparams is None: - self.beparams = {constants.BEGR_DEFAULT: constants.BEC_DEFAULTS} - else: - for begroup in self.beparams: - self.beparams[begroup] = self.FillDict(constants.BEC_DEFAULTS, - self.beparams[begroup]) + if self.os_hvp is None: + self.os_hvp = {} + + # osparams added before 2.2 + if self.osparams is None: + self.osparams = {} + + self.beparams = UpgradeGroupedParams(self.beparams, + constants.BEC_DEFAULTS) + migrate_default_bridge = not self.nicparams + self.nicparams = UpgradeGroupedParams(self.nicparams, + constants.NICC_DEFAULTS) + if migrate_default_bridge: + self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \ + self.default_bridge if self.modify_etc_hosts is None: self.modify_etc_hosts = True + 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. 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. 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 + if hvname != self.default_hypervisor]) + self.default_hypervisor = None + + # maintain_node_health added after 2.1.1 + if self.maintain_node_health is None: + self.maintain_node_health = False + + if self.uid_pool is None: + self.uid_pool = [] + + if self.default_iallocator is None: + self.default_iallocator = "" + def ToDict(self): """Custom function for cluster. @@ -821,37 +997,82 @@ class Cluster(TaggableObject): obj.tcpudp_port_pool = set(obj.tcpudp_port_pool) return obj - @staticmethod - def FillDict(defaults_dict, custom_dict): - """Basic function to apply settings on top a default dict. + def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None): + """Get the default hypervisor parameters for the cluster. - @type defaults_dict: dict - @param defaults_dict: dictionary holding the default values - @type custom_dict: dict - @param custom_dict: dictionary holding customized value - @rtype: dict - @return: dict with the 'full' values + @param hypervisor: the hypervisor name + @param os_name: if specified, we'll also update the defaults for this OS + @param skip_keys: if passed, list of keys not to use + @return: the defaults dict """ - ret_dict = copy.deepcopy(defaults_dict) - ret_dict.update(custom_dict) + if skip_keys is None: + skip_keys = [] + + fill_stack = [self.hvparams.get(hypervisor, {})] + if os_name is not None: + os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {}) + fill_stack.append(os_hvp) + + ret_dict = {} + for o_dict in fill_stack: + ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys) + return ret_dict - def FillHV(self, instance): - """Fill an instance's hvparams 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 with cluster defaults. @type instance: L{objects.Instance} @param instance: the instance parameter to fill + @type skip_globals: boolean + @param skip_globals: if True, the global hypervisor parameters will + not be filled @rtype: dict @return: a copy of the instance's hvparams with missing keys filled from the cluster defaults """ - return self.FillDict(self.hvparams.get(instance.hypervisor, {}), - instance.hvparams) + return self.SimpleFillHV(instance.hypervisor, instance.os, + instance.hvparams, skip_globals) + + def SimpleFillBE(self, beparams): + """Fill a given beparams dict with cluster defaults. + + @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 @@ -860,8 +1081,118 @@ class Cluster(TaggableObject): the cluster defaults """ - return self.FillDict(self.beparams.get(constants.BEGR_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) + + +class BlockDevStatus(ConfigObject): + """Config object representing the status of a block device.""" + __slots__ = [ + "dev_path", + "major", + "minor", + "sync_percent", + "estimated_time", + "is_degraded", + "ldisk_status", + ] + + +class ImportExportStatus(ConfigObject): + """Config object representing the status of an import or export.""" + __slots__ = [ + "recent_output", + "listen_port", + "connected", + "progress_mbytes", + "progress_throughput", + "progress_eta", + "progress_percent", + "exit_status", + "error_message", + ] + _TIMESTAMPS + + +class ImportExportOptions(ConfigObject): + """Options for import/export daemon + + @ivar key_name: X509 key name (None for cluster certificate) + @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 + + """ + __slots__ = [ + "key_name", + "ca_pem", + "compress", + "magic", + ] + + +class ConfdRequest(ConfigObject): + """Object holding a confd request. + + @ivar protocol: confd protocol version + @ivar type: confd query type + @ivar query: query request + @ivar rsalt: requested reply salt + + """ + __slots__ = [ + "protocol", + "type", + "query", + "rsalt", + ] + + +class ConfdReply(ConfigObject): + """Object holding a confd reply. + + @ivar protocol: confd protocol version + @ivar status: reply status code (ok, error) + @ivar answer: confd query reply + @ivar serial: configuration serial number + + """ + __slots__ = [ + "protocol", + "status", + "answer", + "serial", + ] class SerializableConfigParser(ConfigParser.SafeConfigParser): @@ -878,10 +1209,10 @@ class SerializableConfigParser(ConfigParser.SafeConfigParser): self.write(buf) return buf.getvalue() - @staticmethod - def Loads(data): + @classmethod + def Loads(cls, data): """Load data from a string.""" buf = StringIO(data) - cfp = SerializableConfigParser() + cfp = cls() cfp.readfp(buf) return cfp