#
#
-# 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
_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
"Instance name")
+#: a instance UUID (for single-instance LUs)
+_PInstanceUuid = ("instance_uuid", None, ht.TMaybeString,
+ "Instance UUID")
+
#: Whether to ignore offline nodes
_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool,
"Whether to ignore offline nodes")
#: a required node name (for single-node LUs)
_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
+#: a node UUID (for use with _PNodeName)
+_PNodeUuid = ("node_uuid", None, ht.TMaybeString, "Node UUID")
+
#: a required node group name (for single-group LUs)
_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString, "Group name")
#: Migration type (live/non-live)
_PMigrationMode = ("mode", None,
- ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)),
+ ht.TMaybe(ht.TElemOf(constants.HT_MIGRATION_MODES)),
"Migration mode")
#: Obsolete 'live' migration mode (boolean)
_PNodeGroupAllocPolicy = \
("alloc_policy", None,
- ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
+ ht.TMaybe(ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
"Instance allocation policy")
_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
"Target node for shared-storage instances")
+_PMigrationTargetNodeUuid = ("target_node_uuid", None, ht.TMaybeString,
+ "Target node UUID for shared-storage instances")
+
_PStartupPaused = ("startup_paused", False, ht.TBool,
"Pause instance at startup")
"List of error codes that should be treated as warnings")
# Disk parameters
-_PDiskParams = ("diskparams", None,
- ht.TOr(
- ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict),
- ht.TNone),
- "Disk templates' parameter defaults")
+_PDiskParams = \
+ ("diskparams", None,
+ ht.TMaybe(ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict)),
+ "Disk templates' parameter defaults")
# Parameters for node resource model
_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])")
#: Utility function for testing NIC definitions
_TestNicDef = \
ht.Comment("NIC parameters")(ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
- ht.TOr(ht.TNone, ht.TNonEmptyString)))
+ ht.TMaybeString))
_TSetParamsResultItemItems = [
ht.Comment("name of changed parameter")(ht.TNonEmptyString),
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):
})
-def RequireFileStorage():
- """Checks that file storage is enabled.
-
- While it doesn't really fit into this module, L{utils} was deemed too large
- of a dependency to be imported for just one or two functions.
-
- @raise errors.OpPrereqError: when file storage is disabled
-
- """
- if not constants.ENABLE_FILE_STORAGE:
- raise errors.OpPrereqError("File storage disabled at configure time",
- errors.ECODE_INVAL)
-
-
-def RequireSharedFileStorage():
- """Checks that shared file storage is enabled.
-
- While it doesn't really fit into this module, L{utils} was deemed too large
- of a dependency to be imported for just one or two functions.
-
- @raise errors.OpPrereqError: when shared file storage is disabled
-
- """
- if not constants.ENABLE_SHARED_FILE_STORAGE:
- raise errors.OpPrereqError("Shared file storage disabled at"
- " configure time", errors.ECODE_INVAL)
-
-
-@ht.WithDesc("CheckFileStorage")
-def _CheckFileStorage(value):
- """Ensures file storage is enabled if used.
-
- """
- if value == constants.DT_FILE:
- RequireFileStorage()
- elif value == constants.DT_SHARED_FILE:
- RequireSharedFileStorage()
- return True
-
-
def _BuildDiskTemplateCheck(accept_none):
"""Builds check for disk template.
template_check = ht.TElemOf(constants.DISK_TEMPLATES)
if accept_none:
- template_check = ht.TOr(template_check, ht.TNone)
+ template_check = ht.TMaybe(template_check)
- return ht.TAnd(template_check, _CheckFileStorage)
+ return template_check
def _CheckStorageType(storage_type):
"""Ensure a given storage type is valid.
"""
- if storage_type not in constants.VALID_STORAGE_TYPES:
+ if storage_type not in constants.STORAGE_TYPES:
raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
errors.ECODE_INVAL)
- if storage_type == constants.ST_FILE:
- # TODO: What about shared file storage?
- RequireFileStorage()
return True
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
"Storage type")
-_CheckNetworkType = ht.TElemOf(constants.NETWORK_VALID_TYPES)
-
-#: Network type parameter
-_PNetworkType = ("network_type", None, ht.TOr(ht.TNone, _CheckNetworkType),
- "Network type")
+@ht.WithDesc("IPv4 network")
def _CheckCIDRNetNotation(value):
- """Ensure a given cidr notation type is valid.
+ """Ensure a given CIDR notation type is valid.
"""
try:
return False
return True
+
+@ht.WithDesc("IPv4 address")
def _CheckCIDRAddrNotation(value):
- """Ensure a given cidr notation type is valid.
+ """Ensure a given CIDR notation type is valid.
"""
try:
return False
return True
+
+@ht.WithDesc("IPv6 address")
def _CheckCIDR6AddrNotation(value):
- """Ensure a given cidr notation type is valid.
+ """Ensure a given CIDR notation type is valid.
"""
try:
return False
return True
+
+@ht.WithDesc("IPv6 network")
def _CheckCIDR6NetNotation(value):
- """Ensure a given cidr notation type is valid.
+ """Ensure a given CIDR notation type is valid.
"""
try:
return False
return True
-class _AutoOpParamSlots(objectutils.AutoSlots):
+
+_TIpAddress4 = ht.TAnd(ht.TString, _CheckCIDRAddrNotation)
+_TIpAddress6 = ht.TAnd(ht.TString, _CheckCIDR6AddrNotation)
+_TIpNetwork4 = ht.TAnd(ht.TString, _CheckCIDRNetNotation)
+_TIpNetwork6 = ht.TAnd(ht.TString, _CheckCIDR6NetNotation)
+_TMaybeAddr4List = ht.TMaybe(ht.TListOf(_TIpAddress4))
+
+
+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
WITH_LU = True
OP_PARAMS = [
("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
- ("debug_level", None, ht.TOr(ht.TNone, ht.TNonNegativeInt), "Debug level"),
+ ("debug_level", None, ht.TMaybe(ht.TNonNegativeInt), "Debug level"),
("priority", constants.OP_PRIO_DEFAULT,
ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
(DEPEND_ATTR, None, _BuildJobDepCheck(True),
" for details"),
(COMMENT_ATTR, None, ht.TMaybeString,
"Comment describing the purpose of the opcode"),
+ (constants.OPCODE_REASON, ht.EmptyList, 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
_PSkipChecks,
_PIgnoreErrors,
_PVerbose,
- ("group_name", None, ht.TMaybeString, "Group to verify")
+ ("group_name", None, ht.TMaybeString, "Group to verify"),
]
OP_RESULT = TJobIdListOnly
Parameters: optional instances list, in case we want to restrict the
checks to only a subset of the instances.
- Result: a list of tuples, (instance, disk, new-size) for changed
+ Result: a list of tuples, (instance, disk, parameter, new-size) for changed
configurations.
In normal operation, the list should be empty.
OP_PARAMS = [
("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
]
- OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3),
+ OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(4),
ht.TItems([ht.TNonEmptyString,
ht.TNonNegativeInt,
+ ht.TNonEmptyString,
ht.TNonNegativeInt])))
class OpClusterConfigQuery(OpCode):
"""Query cluster configuration values."""
OP_PARAMS = [
- _POutputFields
+ _POutputFields,
]
OP_RESULT = ht.TListOf(ht.TAny)
"""
OP_PARAMS = [
+ _PForce,
_PHvState,
_PDiskState,
- ("vg_name", None, ht.TOr(ht.TString, ht.TNone), "Volume group name"),
+ ("vg_name", None, ht.TMaybe(ht.TString), "Volume group name"),
("enabled_hypervisors", None,
- ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
- ht.TNone),
+ ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)),
+ ht.TTrue)),
"List of enabled hypervisors"),
- ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone),
+ ("hvparams", None,
+ ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
"Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
- ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
+ ("beparams", None, ht.TMaybeDict,
"Cluster-wide backend parameter defaults"),
- ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone),
+ ("os_hvp", None, ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
"Cluster-wide per-OS hypervisor parameter defaults"),
- ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone),
+ ("osparams", None,
+ ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
"Cluster-wide OS parameter defaults"),
_PDiskParams,
- ("candidate_pool_size", None, ht.TOr(ht.TPositiveInt, ht.TNone),
+ ("candidate_pool_size", None, ht.TMaybe(ht.TPositiveInt),
"Master candidate pool size"),
("uid_pool", None, ht.NoType,
"Set UID pool, must be list of lists describing UID ranges (two items,"
("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
("ipolicy", None, ht.TMaybeDict,
"Cluster-wide :ref:`instance policy <rapi-ipolicy>` specs"),
- ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"),
- ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone),
+ ("drbd_helper", None, ht.TMaybe(ht.TString), "DRBD helper program"),
+ ("default_iallocator", None, ht.TMaybe(ht.TString),
"Default iallocator for cluster"),
- ("master_netdev", None, ht.TOr(ht.TString, ht.TNone),
+ ("master_netdev", None, ht.TMaybe(ht.TString),
"Master network device"),
- ("master_netmask", None, ht.TOr(ht.TInt, ht.TNone),
+ ("master_netmask", None, ht.TMaybe(ht.TNonNegativeInt),
"Netmask of the master IP"),
("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString),
"List of reserved LVs"),
" ``%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"),
+ ("file_storage_dir", None, ht.TMaybe(ht.TString),
+ "Default directory for storing file-backed disks"),
+ ("shared_file_storage_dir", None, ht.TMaybe(ht.TString),
+ "Default directory for storing shared-file-backed disks"),
]
OP_RESULT = ht.TNone
_PUseLocking,
("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
"Requested fields"),
- ("qfilter", None, ht.TOr(ht.TNone, ht.TList),
+ ("qfilter", None, ht.TMaybe(ht.TList),
"Query filter"),
]
OP_RESULT = \
"""Interact with OOB."""
OP_PARAMS = [
("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
- "List of nodes to run the OOB command against"),
- ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
+ "List of node names to run the OOB command against"),
+ ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "List of node UUIDs to run the OOB command against"),
+ ("command", ht.NoDefault, ht.TElemOf(constants.OOB_COMMANDS),
"OOB command to be run"),
("timeout", constants.OOB_TIMEOUT, ht.TInt,
"Timeout before the OOB helper will be terminated"),
_PUseLocking,
("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
"Nodes on which the command should be run (at least one)"),
+ ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "Node UUIDs on which the command should be run (at least one)"),
("command", ht.NoDefault, ht.TNonEmptyString,
"Command name (no parameters)"),
]
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid
]
OP_RESULT = ht.TNone
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid,
_PStorageType,
_PStorageName,
("changes", ht.NoDefault, ht.TDict, "Requested changes"),
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid,
_PStorageType,
_PStorageName,
_PIgnoreConsistency,
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid,
_PForce,
_PHvState,
_PDiskState,
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid,
_PForce,
]
OP_RESULT = ht.TMaybeString
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PNodeUuid,
_PMigrationMode,
_PMigrationLive,
_PMigrationTargetNode,
+ _PMigrationTargetNodeUuid,
_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
OP_PARAMS = [
_PEarlyRelease,
_PNodeName,
+ _PNodeUuid,
("remote_node", None, ht.TMaybeString, "New secondary node"),
- ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
+ ("remote_node_uuid", None, ht.TMaybeString, "New secondary node UUID"),
+ _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}]``;"
" or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
"Disk template"),
- ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER)),
+ ("file_driver", None, ht.TMaybe(ht.TElemOf(constants.FILE_DRIVER)),
"Driver for file-backed disks"),
("file_storage_dir", None, ht.TMaybeString,
"Directory for storing file-backed disks"),
("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),
("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
("os_type", None, ht.TMaybeString, "Operating system"),
("pnode", None, ht.TMaybeString, "Primary node"),
+ ("pnode_uuid", None, ht.TMaybeString, "Primary node UUID"),
("snode", None, ht.TMaybeString, "Secondary node"),
- ("source_handshake", None, ht.TOr(ht.TList, ht.TNone),
+ ("snode_uuid", None, ht.TMaybeString, "Secondary node UUID"),
+ ("source_handshake", None, ht.TMaybe(ht.TList),
"Signed handshake from source (remote import only)"),
("source_instance_name", None, ht.TMaybeString,
"Source instance name (remote import only)"),
("source_x509_ca", None, ht.TMaybeString,
"Source X509 CA in PEM format (remote import only)"),
("src_node", None, ht.TMaybeString, "Source node for import"),
+ ("src_node_uuid", None, ht.TMaybeString, "Source node UUID for import"),
("src_path", None, ht.TMaybeString, "Source directory for import"),
("start", True, ht.TBool, "Whether to start instance after creation"),
("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
"""
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_RESULT = ht.TStrictDict(True, True, {
constants.JOB_IDS_KEY: _JOB_LIST,
ALLOCATABLE_KEY: ht.TListOf(ht.TNonEmptyString),
- FAILED_KEY: ht.TListOf(ht.TNonEmptyString)
+ FAILED_KEY: ht.TListOf(ht.TNonEmptyString),
})
def __getstate__(self):
type(state))
if "instances" in state:
- insts = [OpCode.LoadOpCode(inst) for inst in state["instances"]]
- state["instances"] = insts
+ state["instances"] = map(OpCode.LoadOpCode, state["instances"])
+
return OpCode.__setstate__(self, state)
def Validate(self, set_defaults):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PForceVariant,
("os_type", None, ht.TMaybeString, "Instance operating system"),
("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PShutdownTimeout,
("ignore_failures", False, ht.TBool,
"Whether to ignore failures during removal"),
"""Rename an instance."""
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PNameCheck,
("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
("ip_check", False, ht.TBool, _PIpCheckDoc),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PForce,
_PIgnoreOfflineNodes,
("hvparams", ht.EmptyDict, ht.TDict,
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
+ _PForce,
_PIgnoreOfflineNodes,
("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativeInt,
"How long to wait for instance to shut down"),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PShutdownTimeout,
("ignore_secondaries", False, ht.TBool,
"Whether to start the instance even if secondary disks are failing"),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PEarlyRelease,
_PIgnoreIpolicy,
("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
("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"),
+ ("remote_node_uuid", None, ht.TMaybeString, "New secondary node UUID"),
+ _PIAllocFromDesc("Iallocator for deciding new secondary node"),
]
OP_RESULT = ht.TNone
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PShutdownTimeout,
_PIgnoreConsistency,
_PMigrationTargetNode,
+ _PMigrationTargetNodeUuid,
_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"),
+ ("cleanup", False, ht.TBool,
+ "Whether a previously failed failover should be cleaned up"),
]
OP_RESULT = ht.TNone
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PMigrationMode,
_PMigrationLive,
_PMigrationTargetNode,
+ _PMigrationTargetNodeUuid,
_PAllowRuntimeChgs,
_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"),
]
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PShutdownTimeout,
_PIgnoreIpolicy,
("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
+ ("target_node_uuid", None, ht.TMaybeString, "Target node UUID"),
_PIgnoreConsistency,
]
OP_RESULT = ht.TNone
"""Connect to an instance's console."""
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
- _PInstanceName
+ _PInstanceName,
+ _PInstanceUuid,
]
OP_RESULT = ht.TDict
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
_PWaitForSyncFalse,
]
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PForce,
]
OP_RESULT = ht.TNone
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
("disks", ht.EmptyList,
ht.TOr(ht.TListOf(ht.TNonNegativeInt), ht.TListOf(_TDiskChanges)),
"List of disk indexes (deprecated) or a list of tuples containing a disk"
" 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"),
+ ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "New instance node UUIDs, if relocation is desired"),
+ _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,
]))
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PForce,
_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"
("runtime_mem", None, ht.TMaybePositiveInt, "New runtime memory"),
("hvparams", ht.EmptyDict, ht.TDict,
"Per-instance hypervisor parameters, hypervisor-dependent"),
- ("disk_template", None, ht.TOr(ht.TNone, _BuildDiskTemplateCheck(False)),
+ ("disk_template", None, ht.TMaybe(_BuildDiskTemplateCheck(False)),
"Disk template for instance"),
+ ("pnode", None, ht.TMaybeString, "New primary node"),
+ ("pnode_uuid", None, ht.TMaybeString, "New primary node UUID"),
("remote_node", None, ht.TMaybeString,
"Secondary node (used when changing disk template)"),
+ ("remote_node_uuid", None, ht.TMaybeString,
+ "Secondary node UUID (used when changing disk template)"),
("os_name", None, ht.TMaybeString,
"Change the instance's OS without reinstalling the instance"),
("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PWaitForSync,
("disk", ht.NoDefault, ht.TInt, "Disk index"),
("amount", ht.NoDefault, ht.TNonNegativeInt,
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_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
_PForce,
("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
"List of nodes to assign"),
+ ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "List of node UUIDs to assign"),
]
OP_RESULT = ht.TNone
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."""
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES),
"Export mode"),
]
- OP_RESULT = ht.TOr(ht.TNone, ht.TDict)
+ OP_RESULT = ht.TMaybeDict
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
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
_PShutdownTimeout,
# TODO: Rename target_node as it changes meaning for different export modes
# (e.g. "destination")
("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList),
"Destination information, depends on export mode"),
+ ("target_node_uuid", None, ht.TMaybeString,
+ "Target node UUID (if local export)"),
("shutdown", True, ht.TBool, "Whether to shutdown instance before export"),
("remove_instance", False, ht.TBool,
"Whether to remove instance after export"),
"Whether to ignore failures while removing instances"),
("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES),
"Export mode"),
- ("x509_key_name", None, ht.TOr(ht.TList, ht.TNone),
+ ("x509_key_name", None, ht.TMaybe(ht.TList),
"Name of X509 key (remote export only)"),
("destination_x509_ca", None, ht.TMaybeString,
"Destination X509 CA (remote export only)"),
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
+ _PInstanceUuid,
]
OP_RESULT = ht.TNone
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
("duration", ht.NoDefault, ht.TNumber, None),
("on_master", True, ht.TBool, None),
("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
+ ("on_node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
("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),
ht.TMaybeListOf(ht.TDictOf(ht.TElemOf([constants.INIC_MAC,
constants.INIC_IP,
"bridge"]),
- ht.TOr(ht.TNone, ht.TNonEmptyString))),
+ ht.TMaybeString)),
None),
- ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList), 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.TOr(ht.TNone, ht.TNonNegativeInt), None),
- ("vcpus", None, ht.TOr(ht.TNone, ht.TNonNegativeInt), None),
+ ("memory", None, ht.TMaybe(ht.TNonNegativeInt), None),
+ ("vcpus", None, ht.TMaybe(ht.TNonNegativeInt), None),
("os", None, ht.TMaybeString, None),
("disk_template", None, ht.TMaybeString, None),
("instances", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
("evac_mode", None,
- ht.TOr(ht.TNone, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None),
+ ht.TMaybe(ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None),
("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
("spindle_use", 1, ht.TNonNegativeInt, None),
("count", 1, ht.TNonNegativeInt, None),
OP_DSC_FIELD = "network_name"
OP_PARAMS = [
_PNetworkName,
- _PNetworkType,
- ("network", None, ht.TAnd(ht.TString ,_CheckCIDRNetNotation), None),
- ("gateway", None, ht.TOr(ht.TNone, _CheckCIDRAddrNotation), None),
- ("network6", None, ht.TOr(ht.TNone, _CheckCIDR6NetNotation), None),
- ("gateway6", None, ht.TOr(ht.TNone, _CheckCIDR6AddrNotation), None),
- ("mac_prefix", None, ht.TMaybeString, None),
- ("add_reserved_ips", None,
- ht.TOr(ht.TNone, ht.TListOf(_CheckCIDRAddrNotation)), None),
+ ("network", ht.NoDefault, _TIpNetwork4, "IPv4 subnet"),
+ ("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,
+ "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
+
class OpNetworkRemove(OpCode):
"""Remove an existing network from the cluster.
_PNetworkName,
_PForce,
]
+ OP_RESULT = ht.TNone
+
class OpNetworkSetParams(OpCode):
"""Modify Network's parameters except for IPv4 subnet"""
OP_DSC_FIELD = "network_name"
OP_PARAMS = [
_PNetworkName,
- _PNetworkType,
- ("gateway", None, ht.TOr(ht.TNone, _CheckCIDRAddrNotation), None),
- ("network6", None, ht.TOr(ht.TNone, _CheckCIDR6NetNotation), None),
- ("gateway6", None, ht.TOr(ht.TNone, _CheckCIDR6AddrNotation), None),
- ("mac_prefix", None, ht.TMaybeString, None),
- ("add_reserved_ips", None,
- ht.TOr(ht.TNone, ht.TListOf(_CheckCIDRAddrNotation)), None),
- ("remove_reserved_ips", None,
- ht.TOr(ht.TNone, ht.TListOf(_CheckCIDRAddrNotation)), None),
+ ("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"),
+ ("remove_reserved_ips", None, _TMaybeAddr4List,
+ "Which external IP addresses to release"),
]
+ OP_RESULT = ht.TNone
+
class OpNetworkConnect(OpCode):
"""Connect a Network to a specific Nodegroup with the defined netparams
OP_PARAMS = [
_PGroupName,
_PNetworkName,
- ("network_mode", None, ht.TString, None),
- ("network_link", None, ht.TString, None),
- ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
+ ("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_RESULT = ht.TNone
+
class OpNetworkDisconnect(OpCode):
"""Disconnect a Network from a Nodegroup. Produce errors if NICs are
OP_PARAMS = [
_PGroupName,
_PNetworkName,
- ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
]
+ OP_RESULT = ht.TNone
+
class OpNetworkQuery(OpCode):
"""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"),
]
+ OP_RESULT = _TOldQueryResult
def _GetOpList():
projects / ganeti-local / blobdiff