#
#
-# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
+# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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
from ganeti import errors
from ganeti import ht
from ganeti import objects
-from ganeti import objectutils
+from ganeti import outils
# Common opcode attributes
_PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
_PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")
+#: Opportunistic locking
+_POpportunisticLocking = \
+ ("opportunistic_locking", False, ht.TBool,
+ ("Whether to employ opportunistic locking for nodes, meaning nodes"
+ " already locked by another opcode won't be considered for instance"
+ " allocation (only when an iallocator is used)"))
_PIgnoreIpolicy = ("ignore_ipolicy", False, ht.TBool,
"Whether to ignore ipolicy violations")
_PAllowRuntimeChgs = ("allow_runtime_changes", True, ht.TBool,
"Allow runtime changes (eg. memory ballooning)")
+#: IAllocator field builder
+_PIAllocFromDesc = lambda desc: ("iallocator", None, ht.TMaybeString, desc)
+
#: a required network name
_PNetworkName = ("network_name", ht.NoDefault, ht.TNonEmptyString,
"Set network name")
+_PTargetGroups = \
+ ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "Destination group names or UUIDs (defaults to \"all but current group\")")
+
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")
ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
ht.TItems(_TSetParamsResultItemItems)))
-# TODO: Generate check from constants.IDISK_PARAMS_TYPES (however, not all users
-# of this check support all parameters)
+# In the disks option we can provide arbitrary parameters too, which
+# we may not be able to validate at this level, so we just check the
+# format of the dict here and the checks concerning IDISK_PARAMS will
+# happen at the LU level
_TDiskParams = \
- ht.Comment("Disk parameters")(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS),
+ ht.Comment("Disk parameters")(ht.TDictOf(ht.TNonEmptyString,
ht.TOr(ht.TNonEmptyString, ht.TInt)))
_TQueryRow = \
COMMENT_ATTR = "comment"
-def _NameToId(name):
- """Convert an opcode class name to an OP_ID.
+def _NameComponents(name):
+ """Split an opcode class name into its components
@type name: string
@param name: the class name, as OpXxxYyy
- @rtype: string
- @return: the name in the OP_XXXX_YYYY format
+ @rtype: array of strings
+ @return: the components of the name
"""
- if not name.startswith("Op"):
- return None
+ assert name.startswith("Op")
# Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
# consume any input, and hence we would just have all the elements
# in the list, one by one; but it seems that split doesn't work on
# bit
name = _OPID_RE.sub(r"\1,\2", name)
elems = name.split(",")
- return "_".join(n.upper() for n in elems)
+ return elems
+
+
+def _NameToId(name):
+ """Convert an opcode class name to an OP_ID.
+
+ @type name: string
+ @param name: the class name, as OpXxxYyy
+ @rtype: string
+ @return: the name in the OP_XXXX_YYYY format
+
+ """
+ if not name.startswith("Op"):
+ return None
+ return "_".join(n.upper() for n in _NameComponents(name))
+
+
+def NameToReasonSrc(name):
+ """Convert an opcode class name to a source string for the reason trail
+
+ @type name: string
+ @param name: the class name, as OpXxxYyy
+ @rtype: string
+ @return: the name in the OP_XXXX_YYYY format
+
+ """
+ if not name.startswith("Op"):
+ return None
+ return "%s:%s" % (constants.OPCODE_REASON_SRC_OPCODE,
+ "_".join(n.lower() for n in _NameComponents(name)))
def _GenerateObjectTypeCheck(obj, fields_types):
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
"Storage type")
-_CheckNetworkType = ht.TElemOf(constants.NETWORK_VALID_TYPES)
-
-#: Network type parameter
-_PNetworkType = ("network_type", None, ht.TMaybe(_CheckNetworkType),
- "Network type")
-
@ht.WithDesc("IPv4 network")
def _CheckCIDRNetNotation(value):
_TMaybeAddr4List = ht.TMaybe(ht.TListOf(_TIpAddress4))
-class _AutoOpParamSlots(objectutils.AutoSlots):
+class _AutoOpParamSlots(outils.AutoSlots):
"""Meta class for opcode definitions.
"""
slots = mcs._GetSlots(attrs)
assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
"Class '%s' uses unknown field in OP_DSC_FIELD" % name
+ assert ("OP_DSC_FORMATTER" not in attrs or
+ callable(attrs["OP_DSC_FORMATTER"])), \
+ ("Class '%s' uses non-callable in OP_DSC_FORMATTER (%s)" %
+ (name, type(attrs["OP_DSC_FORMATTER"])))
attrs["OP_ID"] = _NameToId(name)
- return objectutils.AutoSlots.__new__(mcs, name, bases, attrs)
+ return outils.AutoSlots.__new__(mcs, name, bases, attrs)
@classmethod
def _GetSlots(mcs, attrs):
return [pname for (pname, _, _, _) in params]
-class BaseOpCode(objectutils.ValidatedSlots):
+class BaseOpCode(outils.ValidatedSlots):
"""A simple serializable object.
This object serves as a parent class for OpCode without any custom
job_id = ht.TJobId
job_dep = \
- ht.TAnd(ht.TIsLength(2),
+ ht.TAnd(ht.TOr(ht.TList, ht.TTuple),
+ ht.TIsLength(2),
ht.TItems([job_id,
ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))
@cvar OP_DSC_FIELD: The name of a field whose value will be included in the
string returned by Summary(); see the docstring of that
method for details).
+ @cvar OP_DSC_FORMATTER: A callable that should format the OP_DSC_FIELD; if
+ not present, then the field will be simply converted
+ to string
@cvar OP_PARAMS: List of opcode attributes, the default values they should
get if not already defined, and types they must match.
@cvar OP_RESULT: Callable to verify opcode result
" for details"),
(COMMENT_ATTR, None, ht.TMaybeString,
"Comment describing the purpose of the opcode"),
+ (constants.OPCODE_REASON, None, ht.TMaybeList,
+ "The reason trail, describing why the OpCode is executed"),
]
OP_RESULT = None
field_name = getattr(self, "OP_DSC_FIELD", None)
if field_name:
field_value = getattr(self, field_name, None)
- if isinstance(field_value, (list, tuple)):
+ field_formatter = getattr(self, "OP_DSC_FORMATTER", None)
+ if callable(field_formatter):
+ field_value = field_formatter(field_value)
+ elif isinstance(field_value, (list, tuple)):
field_value = ",".join(str(i) for i in field_value)
txt = "%s(%s)" % (txt, field_value)
return txt
"""
OP_PARAMS = [
+ _PForce,
_PHvState,
_PDiskState,
("vg_name", None, ht.TMaybe(ht.TString), "Volume group name"),
" ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
("use_external_mip_script", None, ht.TMaybeBool,
"Whether to use an external master IP address setup script"),
+ ("enabled_disk_templates", None,
+ ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.DISK_TEMPLATES)),
+ ht.TTrue)),
+ "List of enabled disk templates"),
+ ("modify_etc_hosts", None, ht.TMaybeBool,
+ "Whether the cluster can modify and keep in sync the /etc/hosts files"),
]
OP_RESULT = ht.TNone
_PMigrationTargetNode,
_PAllowRuntimeChgs,
_PIgnoreIpolicy,
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding the target node for shared-storage instances"),
+ _PIAllocFromDesc("Iallocator for deciding the target node"
+ " for shared-storage instances"),
]
OP_RESULT = TJobIdListOnly
_PEarlyRelease,
_PNodeName,
("remote_node", None, ht.TMaybeString, "New secondary node"),
- ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
+ _PIAllocFromDesc("Iallocator for computing solution"),
("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
"Node evacuation mode"),
]
_PWaitForSync,
_PNameCheck,
_PIgnoreIpolicy,
+ _POpportunisticLocking,
("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
("disks", ht.NoDefault, ht.TListOf(_TDiskParams),
"Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
("hvparams", ht.EmptyDict, ht.TDict,
"Hypervisor parameters for instance, hypervisor-dependent"),
("hypervisor", None, ht.TMaybeString, "Hypervisor"),
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding which node(s) to use"),
+ _PIAllocFromDesc("Iallocator for deciding which node(s) to use"),
("identify_defaults", False, ht.TBool,
"Reset instance parameters to default if equal"),
("ip_check", True, ht.TBool, _PIpCheckDoc),
"""
OP_PARAMS = [
- ("iallocator", None, ht.TMaybeString,
- "Iallocator used to allocate all the instances"),
- ("instances", [], ht.TListOf(ht.TInstanceOf(OpInstanceCreate)),
+ _POpportunisticLocking,
+ _PIAllocFromDesc("Iallocator used to allocate all the instances"),
+ ("instances", ht.EmptyList, ht.TListOf(ht.TInstanceOf(OpInstanceCreate)),
"List of instance create opcodes describing the instances to allocate"),
]
_JOB_LIST = ht.Comment("List of submitted jobs")(TJobIdList)
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PForce,
_PIgnoreOfflineNodes,
("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativeInt,
"How long to wait for instance to shut down"),
("disks", ht.EmptyList, ht.TListOf(ht.TNonNegativeInt),
"Disk indexes"),
("remote_node", None, ht.TMaybeString, "New secondary node"),
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding new secondary node"),
+ _PIAllocFromDesc("Iallocator for deciding new secondary node"),
]
OP_RESULT = ht.TNone
_PIgnoreConsistency,
_PMigrationTargetNode,
_PIgnoreIpolicy,
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding the target node for shared-storage instances"),
+ _PIAllocFromDesc("Iallocator for deciding the target node for"
+ " shared-storage instances"),
]
OP_RESULT = ht.TNone
_PIgnoreIpolicy,
("cleanup", False, ht.TBool,
"Whether a previously failed migration should be cleaned up"),
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding the target node for shared-storage instances"),
+ _PIAllocFromDesc("Iallocator for deciding the target node for"
+ " shared-storage instances"),
("allow_failover", False, ht.TBool,
"Whether we can fallback to failover if migration is not possible"),
]
" index and a possibly empty dictionary with disk parameter changes"),
("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
"New instance nodes, if relocation is desired"),
- ("iallocator", None, ht.TMaybeString,
- "Iallocator for deciding new nodes"),
+ _PIAllocFromDesc("Iallocator for deciding new nodes"),
]
OP_RESULT = ht.TNone
mod_item_fn = \
ht.TAnd(ht.TIsLength(3), ht.TItems([
ht.TElemOf(constants.DDMS_VALUES_WITH_MODIFY),
- ht.Comment("Disk index, can be negative, e.g. -1 for last disk")(ht.TInt),
+ ht.Comment("Device index, can be negative, e.g. -1 for last disk")
+ (ht.TOr(ht.TInt, ht.TString)),
fn,
]))
_PForceVariant,
_PIgnoreIpolicy,
("nics", ht.EmptyList, TestNicModifications,
- "List of NIC changes: each item is of the form ``(op, index, settings)``,"
- " ``op`` is one of ``%s``, ``%s`` or ``%s``, ``index`` can be either -1"
- " to refer to the last position, or a zero-based index number; a"
+ "List of NIC changes: each item is of the form"
+ " ``(op, identifier, settings)``, ``op`` is one of ``%s``, ``%s`` or"
+ " ``%s``, ``identifier`` can be a zero-based index number (or -1 to refer"
+ " to the last position), the NIC's UUID of the NIC's name; a"
" deprecated version of this parameter used the form ``(op, settings)``,"
" where ``op`` can be ``%s`` to add a new NIC with the specified"
" settings, ``%s`` to remove the last NIC or a number to modify the"
"Per-instance hypervisor parameters, hypervisor-dependent"),
("disk_template", None, ht.TMaybe(_BuildDiskTemplateCheck(False)),
"Disk template for instance"),
+ ("pnode", None, ht.TMaybeString, "New primary node"),
("remote_node", None, ht.TMaybeString,
"Secondary node (used when changing disk template)"),
("os_name", None, ht.TMaybeString,
OP_PARAMS = [
_PInstanceName,
_PEarlyRelease,
- ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
- ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
- "Destination group names or UUIDs (defaults to \"all but current group\""),
+ _PIAllocFromDesc("Iallocator for computing solution"),
+ _PTargetGroups,
]
OP_RESULT = TJobIdListOnly
OP_PARAMS = [
_PGroupName,
_PEarlyRelease,
- ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
- ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
- "Destination group names or UUIDs"),
+ _PIAllocFromDesc("Iallocator for computing solution"),
+ _PTargetGroups,
]
OP_RESULT = TJobIdListOnly
OP_RESULT = _TOldQueryResult
+# ExtStorage opcodes
+class OpExtStorageDiagnose(OpCode):
+ """Compute the list of external storage providers."""
+ OP_PARAMS = [
+ _POutputFields,
+ ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Which ExtStorage Provider to diagnose"),
+ ]
+ OP_RESULT = _TOldQueryResult
+
+
# Exports opcodes
class OpBackupQuery(OpCode):
"""Compute the list of exported images."""
class OpBackupExport(OpCode):
"""Export an instance.
- For local exports, the export destination is the node name. For remote
- exports, the export destination is a list of tuples, each consisting of
- hostname/IP address, port, HMAC and HMAC salt. The HMAC is calculated using
- the cluster domain secret over the value "${index}:${hostname}:${port}". The
- destination X509 CA must be a signed certificate.
+ For local exports, the export destination is the node name. For
+ remote exports, the export destination is a list of tuples, each
+ consisting of hostname/IP address, port, magic, HMAC and HMAC
+ salt. The HMAC is calculated using the cluster domain secret over
+ the value "${index}:${hostname}:${port}". The destination X509 CA
+ must be a signed certificate.
@ivar mode: Export mode (one of L{constants.EXPORT_MODES})
@ivar target_node: Export destination
This is used just for debugging and testing.
Parameters:
- - duration: the time to sleep
+ - duration: the time to sleep, in seconds
- on_master: if true, sleep on the master
- on_nodes: list of nodes in which to sleep
("repeat", 0, ht.TNonNegativeInt, None),
]
+ def OP_DSC_FORMATTER(self, value): # pylint: disable=C0103,R0201
+ """Custom formatter for duration.
+
+ """
+ try:
+ v = float(value)
+ except TypeError:
+ v = value
+ return str(v)
+
class OpTestAllocator(OpCode):
"""Allocator framework testing.
return the allocator output (direction 'out')
"""
- OP_DSC_FIELD = "allocator"
+ OP_DSC_FIELD = "iallocator"
OP_PARAMS = [
("direction", ht.NoDefault,
ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None),
None),
("disks", ht.NoDefault, ht.TMaybe(ht.TList), None),
("hypervisor", None, ht.TMaybeString, None),
- ("allocator", None, ht.TMaybeString, None),
+ _PIAllocFromDesc(None),
("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
("memory", None, ht.TMaybe(ht.TNonNegativeInt), None),
("vcpus", None, ht.TMaybe(ht.TNonNegativeInt), None),
OP_DSC_FIELD = "network_name"
OP_PARAMS = [
_PNetworkName,
- _PNetworkType,
("network", ht.NoDefault, _TIpNetwork4, "IPv4 subnet"),
("gateway", None, ht.TMaybe(_TIpAddress4), "IPv4 gateway"),
("network6", None, ht.TMaybe(_TIpNetwork6), "IPv6 subnet"),
"MAC address prefix that overrides cluster one"),
("add_reserved_ips", None, _TMaybeAddr4List,
"Which IP addresses to reserve"),
+ ("conflicts_check", True, ht.TBool,
+ "Whether to check for conflicting IP addresses"),
("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Network tags"),
]
OP_RESULT = ht.TNone
OP_DSC_FIELD = "network_name"
OP_PARAMS = [
_PNetworkName,
- _PNetworkType,
- ("gateway", None, ht.TMaybe(_TIpAddress4), "IPv4 gateway"),
- ("network6", None, ht.TMaybe(_TIpNetwork6), "IPv6 subnet"),
- ("gateway6", None, ht.TMaybe(_TIpAddress6), "IPv6 gateway"),
- ("mac_prefix", None, ht.TMaybeString,
+ ("gateway", None, ht.TMaybeValueNone(_TIpAddress4), "IPv4 gateway"),
+ ("network6", None, ht.TMaybeValueNone(_TIpNetwork6), "IPv6 subnet"),
+ ("gateway6", None, ht.TMaybeValueNone(_TIpAddress6), "IPv6 gateway"),
+ ("mac_prefix", None, ht.TMaybeValueNone(ht.TString),
"MAC address prefix that overrides cluster one"),
("add_reserved_ips", None, _TMaybeAddr4List,
"Which external IP addresses to reserve"),
OP_PARAMS = [
_PGroupName,
_PNetworkName,
- ("network_mode", ht.NoDefault, ht.TString, "Connectivity mode"),
+ ("network_mode", ht.NoDefault, ht.TElemOf(constants.NIC_VALID_MODES),
+ "Connectivity mode"),
("network_link", ht.NoDefault, ht.TString, "Connectivity link"),
("conflicts_check", True, ht.TBool, "Whether to check for conflicting IPs"),
]
OP_PARAMS = [
_PGroupName,
_PNetworkName,
- ("conflicts_check", True, ht.TBool, "Whether to check for conflicting IPs"),
]
OP_RESULT = ht.TNone
"""Compute the list of networks."""
OP_PARAMS = [
_POutputFields,
+ _PUseLocking,
("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
"Empty list to query all groups, group names otherwise"),
]
projects / ganeti-local / blobdiff