# this are practically structures, so disable the message about too
# few public methods:
-# pylint: disable-msg=R0903
+# pylint: disable=R0903
import logging
import re
-import operator
+from ganeti import compat
from ganeti import constants
from ganeti import errors
from ganeti import ht
_PStartupPaused = ("startup_paused", False, ht.TBool,
"Pause instance at startup")
+_PVerbose = ("verbose", False, ht.TBool, "Verbose mode")
+
+# Parameters for cluster verification
+_PDebugSimulateErrors = ("debug_simulate_errors", False, ht.TBool,
+ "Whether to simulate errors (useful for debugging)")
+_PErrorCodes = ("error_codes", False, ht.TBool, "Error codes")
+_PSkipChecks = ("skip_checks", ht.EmptyList,
+ ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)),
+ "Which checks to skip")
+_PIgnoreErrors = ("ignore_errors", ht.EmptyList,
+ ht.TListOf(ht.TElemOf(constants.CV_ALL_ECODES_STRINGS)),
+ "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")
+
+# Parameters for node resource model
+_PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
+_PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")
+
+
+_PIgnoreIpolicy = ("ignore_ipolicy", False, ht.TBool,
+ "Whether to ignore ipolicy violations")
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")
#: Utility function for L{OpClusterSetParams}
_TestClusterOsList = ht.TOr(ht.TNone,
ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
- ht.TMap(ht.WithDesc("GetFirstItem")(operator.itemgetter(0)),
+ ht.TMap(ht.WithDesc("GetFirstItem")(compat.fst),
ht.TElemOf(constants.DDMS_VALUES)))))
_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
ht.TOr(ht.TNone, ht.TNonEmptyString))
+_TSetParamsResultItemItems = [
+ ht.Comment("name of changed parameter")(ht.TNonEmptyString),
+ ht.Comment("new value")(ht.TAny),
+ ]
+
+_TSetParamsResult = \
+ ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
+ ht.TItems(_TSetParamsResultItemItems)))
+
_SUMMARY_PREFIX = {
"CLUSTER_": "C_",
"GROUP_": "G_",
return True
-_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
- _CheckFileStorage)
+def _BuildDiskTemplateCheck(accept_none):
+ """Builds check for disk template.
+
+ @type accept_none: bool
+ @param accept_none: whether to accept None as a correct value
+ @rtype: callable
+
+ """
+ template_check = ht.TElemOf(constants.DISK_TEMPLATES)
+
+ if accept_none:
+ template_check = ht.TOr(template_check, ht.TNone)
+
+ return ht.TAnd(template_check, _CheckFileStorage)
def _CheckStorageType(storage_type):
field handling.
"""
- # pylint: disable-msg=E1101
+ # pylint: disable=E1101
# as OP_ID is dynamically defined
__metaclass__ = _AutoOpParamSlots
TNoRelativeJobDependencies = _BuildJobDepCheck(False)
+#: List of submission status and job ID as returned by C{SubmitManyJobs}
+_TJobIdListItem = \
+ ht.TAnd(ht.TIsLength(2),
+ ht.TItems([ht.Comment("success")(ht.TBool),
+ ht.Comment("Job ID if successful, error message"
+ " otherwise")(ht.TOr(ht.TString,
+ ht.TJobId))]))
+TJobIdList = ht.TListOf(_TJobIdListItem)
+
+#: Result containing only list of submitted jobs
+TJobIdListOnly = ht.TStrictDict(True, True, {
+ constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
+ })
+
class OpCode(BaseOpCode):
"""Abstract OpCode.
method for details).
@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
@cvar WITH_LU: Boolean that specifies whether this should be included in
mcpu's dispatch table
@ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
@ivar priority: Opcode priority for queue
"""
- # pylint: disable-msg=E1101
+ # pylint: disable=E1101
# as OP_ID is dynamically defined
WITH_LU = True
OP_PARAMS = [
ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
(DEPEND_ATTR, None, _BuildJobDepCheck(True),
"Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
- " job IDs can be used"),
+ " job IDs can be used; see :doc:`design document <design-chained-jobs>`"
+ " for details"),
(COMMENT_ATTR, None, ht.TMaybeString,
"Comment describing the purpose of the opcode"),
]
+ OP_RESULT = None
def __getstate__(self):
"""Specialized getstate for opcodes.
"""Query cluster information."""
+class OpClusterVerify(OpCode):
+ """Submits all jobs necessary to verify the cluster.
+
+ """
+ OP_PARAMS = [
+ _PDebugSimulateErrors,
+ _PErrorCodes,
+ _PSkipChecks,
+ _PIgnoreErrors,
+ _PVerbose,
+ ("group_name", None, ht.TMaybeString, "Group to verify")
+ ]
+ OP_RESULT = TJobIdListOnly
+
+
class OpClusterVerifyConfig(OpCode):
"""Verify the cluster config.
"""
OP_PARAMS = [
- ("verbose", False, ht.TBool, None),
- ("error_codes", False, ht.TBool, None),
- ("debug_simulate_errors", False, ht.TBool, None),
+ _PDebugSimulateErrors,
+ _PErrorCodes,
+ _PIgnoreErrors,
+ _PVerbose,
]
+ OP_RESULT = ht.TBool
class OpClusterVerifyGroup(OpCode):
"""
OP_DSC_FIELD = "group_name"
OP_PARAMS = [
- ("group_name", ht.NoDefault, ht.TNonEmptyString, None),
- ("skip_checks", ht.EmptyList,
- ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)), None),
- ("verbose", False, ht.TBool, None),
- ("error_codes", False, ht.TBool, None),
- ("debug_simulate_errors", False, ht.TBool, None),
+ _PGroupName,
+ _PDebugSimulateErrors,
+ _PErrorCodes,
+ _PSkipChecks,
+ _PIgnoreErrors,
+ _PVerbose,
]
+ OP_RESULT = ht.TBool
class OpClusterVerifyDisks(OpCode):
"""Verify the cluster disks.
- Parameters: none
+ """
+ OP_RESULT = TJobIdListOnly
+
+
+class OpGroupVerifyDisks(OpCode):
+ """Verifies the status of all disks in a node group.
- Result: a tuple of four elements:
- - list of node names with bad data returned (unreachable, etc.)
- - dict of node names with broken volume groups (values: error msg)
+ Result: a tuple of three elements:
+ - dict of node names with issues (values: error msg)
- list of instances with degraded disks (that should be activated)
- dict of instances with missing logical volumes (values: (node, vol)
pairs with details about the missing volumes)
consideration. This might need to be revisited in the future.
"""
+ OP_DSC_FIELD = "group_name"
+ OP_PARAMS = [
+ _PGroupName,
+ ]
+ OP_RESULT = \
+ ht.TAnd(ht.TIsLength(3),
+ ht.TItems([ht.TDictOf(ht.TString, ht.TString),
+ ht.TListOf(ht.TString),
+ ht.TDictOf(ht.TString,
+ ht.TListOf(ht.TListOf(ht.TString)))]))
class OpClusterRepairDiskSizes(OpCode):
"""
OP_PARAMS = [
+ _PHvState,
+ _PDiskState,
("vg_name", None, ht.TMaybeString, "Volume group name"),
("enabled_hypervisors", None,
ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
ht.TNone),
"Cluster-wide OS parameter defaults"),
+ _PDiskParams,
("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
"Master candidate pool size"),
("uid_pool", None, ht.NoType,
"Whether to wipe disks before allocating them to instances"),
("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
+ ("ipolicy", None, ht.TMaybeDict, "Cluster-wide instance policy specs"),
("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"),
("default_iallocator", None, ht.TOr(ht.TString, ht.TNone),
"Default iallocator for cluster"),
("master_netdev", None, ht.TOr(ht.TString, ht.TNone),
"Master network device"),
+ ("master_netmask", None, ht.TOr(ht.TInt, ht.TNone),
+ "Netmask of the master IP"),
("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone),
"List of reserved LVs"),
("hidden_os", None, _TestClusterOsList,
"Modify list of blacklisted operating systems. Each modification must have"
" two items, the operation and the OS name. The operation can be"
" ``%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"),
]
"""
+class OpClusterActivateMasterIp(OpCode):
+ """Activate the master IP on the master node.
+
+ """
+
+
+class OpClusterDeactivateMasterIp(OpCode):
+ """Deactivate the master IP on the master node.
+
+ """
+
+
class OpQuery(OpCode):
"""Query for resources/items.
@ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
@ivar fields: List of fields to retrieve
- @ivar filter: Query filter
+ @ivar qfilter: Query filter
"""
+ OP_DSC_FIELD = "what"
OP_PARAMS = [
_PQueryWhat,
+ _PUseLocking,
("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
"Requested fields"),
- ("filter", None, ht.TOr(ht.TNone, ht.TListOf),
+ ("qfilter", None, ht.TOr(ht.TNone, ht.TListOf),
"Query filter"),
]
@ivar fields: List of fields to retrieve
"""
+ OP_DSC_FIELD = "what"
OP_PARAMS = [
_PQueryWhat,
("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
+ _PHvState,
+ _PDiskState,
("primary_ip", None, ht.NoType, "Primary IP address"),
("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
("readd", False, ht.TBool, "Whether node is re-added to cluster"),
OP_PARAMS = [
_PNodeName,
_PForce,
+ _PHvState,
+ _PDiskState,
("master_candidate", None, ht.TMaybeBool,
"Whether the node should become a master candidate"),
("offline", None, ht.TMaybeBool,
("powered", None, ht.TMaybeBool,
"Whether the node should be marked as powered"),
]
+ OP_RESULT = _TSetParamsResult
class OpNodePowercycle(OpCode):
_PMigrationMode,
_PMigrationLive,
_PMigrationTargetNode,
+ _PIgnoreIpolicy,
("iallocator", None, ht.TMaybeString,
"Iallocator for deciding the target node for shared-storage instances"),
]
+ OP_RESULT = TJobIdListOnly
class OpNodeEvacuate(OpCode):
_PNodeName,
("remote_node", None, ht.TMaybeString, "New secondary node"),
("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
- ("mode", ht.NoDefault, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES),
+ ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
"Node evacuation mode"),
]
+ OP_RESULT = TJobIdListOnly
# instance opcodes
_PForceVariant,
_PWaitForSync,
_PNameCheck,
+ _PIgnoreIpolicy,
("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
("disks", ht.NoDefault,
# TODO: Generate check from constants.IDISK_PARAMS_TYPES
(constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
constants.IDISK_MODE,
" or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
- ("disk_template", ht.NoDefault, _CheckDiskTemplate, "Disk template"),
+ ("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
+ "Disk template"),
("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER)),
"Driver for file-backed disks"),
("file_storage_dir", None, ht.TMaybeString,
("start", True, ht.TBool, "Whether to start instance after creation"),
("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
]
+ OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
class OpInstanceReinstall(OpCode):
("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
("ip_check", False, ht.TBool, _PIpCheckDoc),
]
+ OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
class OpInstanceStartup(OpCode):
OP_PARAMS = [
_PInstanceName,
_PEarlyRelease,
+ _PIgnoreIpolicy,
("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
"Replacement mode"),
("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
_PShutdownTimeout,
_PIgnoreConsistency,
_PMigrationTargetNode,
+ _PIgnoreIpolicy,
("iallocator", None, ht.TMaybeString,
"Iallocator for deciding the target node for shared-storage instances"),
]
_PMigrationMode,
_PMigrationLive,
_PMigrationTargetNode,
+ _PIgnoreIpolicy,
("cleanup", False, ht.TBool,
"Whether a previously failed migration should be cleaned up"),
("iallocator", None, ht.TMaybeString,
OP_PARAMS = [
_PInstanceName,
_PShutdownTimeout,
+ _PIgnoreIpolicy,
("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
_PIgnoreConsistency,
]
class OpInstanceRecreateDisks(OpCode):
- """Deactivate an instance's disks."""
+ """Recreate an instance's disks."""
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
_PInstanceName,
_PForce,
_PForceVariant,
+ _PIgnoreIpolicy,
# TODO: Use _TestNicDef
("nics", ht.EmptyList, ht.TList,
"List of NIC changes. Each item is of the form ``(op, settings)``."
(constants.DDM_ADD, constants.DDM_REMOVE)),
("disks", ht.EmptyList, ht.TList, "List of disk changes. See ``nics``."),
("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
+ ("runtime_mem", None, ht.TMaybeStrictPositiveInt, "New runtime memory"),
("hvparams", ht.EmptyDict, ht.TDict,
"Per-instance hypervisor parameters, hypervisor-dependent"),
- ("disk_template", None, ht.TOr(ht.TNone, _CheckDiskTemplate),
+ ("disk_template", None, ht.TOr(ht.TNone, _BuildDiskTemplateCheck(False)),
"Disk template for instance"),
("remote_node", None, ht.TMaybeString,
"Secondary node (used when changing disk template)"),
("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
("wait_for_sync", True, ht.TBool,
"Whether to wait for the disk to synchronize, when changing template"),
+ ("offline_inst", False, ht.TBool,
+ "Whether to turn off the down instance completely"),
+ ("online_inst", False, ht.TBool,
+ "Whether to enable the offline instance"),
]
+ OP_RESULT = _TSetParamsResult
class OpInstanceGrowDisk(OpCode):
]
+class OpInstanceChangeGroup(OpCode):
+ """Moves an instance to another node group."""
+ OP_DSC_FIELD = "instance_name"
+ OP_PARAMS = [
+ _PInstanceName,
+ _PEarlyRelease,
+ ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
+ ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
+ "Destination group names or UUIDs (defaults to \"all but current group\""),
+ ]
+ OP_RESULT = TJobIdListOnly
+
+
# Node group opcodes
class OpGroupAdd(OpCode):
_PGroupName,
_PNodeGroupAllocPolicy,
_PGroupNodeParams,
+ _PDiskParams,
+ _PHvState,
+ _PDiskState,
+ ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
]
_PGroupName,
_PNodeGroupAllocPolicy,
_PGroupNodeParams,
+ _PDiskParams,
+ _PHvState,
+ _PDiskState,
+ ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
]
+ OP_RESULT = _TSetParamsResult
class OpGroupRemove(OpCode):
_PGroupName,
("new_name", ht.NoDefault, ht.TNonEmptyString, "New group name"),
]
+ OP_RESULT = ht.Comment("New group name")(ht.TNonEmptyString)
class OpGroupEvacuate(OpCode):
("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
"Destination group names or UUIDs"),
]
+ OP_RESULT = TJobIdListOnly
# OS opcodes
("name", ht.NoDefault, ht.TMaybeString, None),
]
+
# Test opcodes
class OpTestDelay(OpCode):
"""Sleeps for a configured amount of time.
("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt), None),
("os", None, ht.TMaybeString, None),
("disk_template", None, ht.TMaybeString, None),
- ("evac_nodes", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
- None),
("instances", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
None),
("evac_mode", None,
projects / ganeti-local / blobdiff