#
#
-# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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
# this are practically structures, so disable the message about too
# few public methods:
-# pylint: disable-msg=R0903
+# pylint: disable=R0903
import logging
import re
from ganeti import constants
from ganeti import errors
from ganeti import ht
+from ganeti import objects
+from ganeti import objectutils
# Common opcode attributes
#: output fields for a query operation
-_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))
+_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
+ "Selected output fields")
#: the shutdown timeout
-_PShutdownTimeout = ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
- ht.TPositiveInt)
+_PShutdownTimeout = \
+ ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
+ "How long to wait for instance to shut down")
#: the force parameter
-_PForce = ("force", False, ht.TBool)
+_PForce = ("force", False, ht.TBool, "Whether to force the operation")
#: a required instance name (for single-instance LUs)
-_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString)
+_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
+ "Instance name")
#: Whether to ignore offline nodes
-_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool)
+_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)
+_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
#: a required node group name (for single-group LUs)
-_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString)
+_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.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)),
+ "Migration mode")
#: Obsolete 'live' migration mode (boolean)
-_PMigrationLive = ("live", None, ht.TMaybeBool)
+_PMigrationLive = ("live", None, ht.TMaybeBool,
+ "Legacy setting for live migration, do not use")
#: Tag type
-_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES))
+_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES),
+ "Tag kind")
#: List of tag strings
-_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))
+_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
+ "List of tag names")
-#: Ignore consistency
-_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool)
+_PForceVariant = ("force_variant", False, ht.TBool,
+ "Whether to force an unknown OS variant")
+
+_PWaitForSync = ("wait_for_sync", True, ht.TBool,
+ "Whether to wait for the disk to synchronize")
+
+_PWaitForSyncFalse = ("wait_for_sync", False, ht.TBool,
+ "Whether to wait for the disk to synchronize"
+ " (defaults to false)")
+
+_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
+ "Whether to ignore disk consistency")
+
+_PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")
+
+_PUseLocking = ("use_locking", False, ht.TBool,
+ "Whether to use synchronization")
+
+_PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")
+
+_PNodeGroupAllocPolicy = \
+ ("alloc_policy", None,
+ ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
+ "Instance allocation policy")
+
+_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
+ "Default node parameters for group")
+
+_PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
+ "Resource(s) to query for")
+
+_PEarlyRelease = ("early_release", False, ht.TBool,
+ "Whether to release locks as soon as possible")
+
+_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
#: Do not remember instance state changes
-_PNoRemember = ("no_remember", False, ht.TBool)
+_PNoRemember = ("no_remember", False, ht.TBool,
+ "Do not remember the state change")
+
+#: Target node for instance migration/failover
+_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
+ "Target node for shared-storage instances")
+
+_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")
+
+# Allow runtime changes while migrating
+_PAllowRuntimeChgs = ("allow_runtime_changes", True, ht.TBool,
+ "Allow runtime changes (eg. memory ballooning)")
+
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")
+#: Utility function for L{OpClusterSetParams}
+_TestClusterOsListItem = \
+ ht.TAnd(ht.TIsLength(2), ht.TItems([
+ ht.TElemOf(constants.DDMS_VALUES),
+ ht.TNonEmptyString,
+ ]))
+
+_TestClusterOsList = ht.TMaybeListOf(_TestClusterOsListItem)
+
+# TODO: Generate check from constants.INIC_PARAMS_TYPES
+#: Utility function for testing NIC definitions
+_TestNicDef = \
+ ht.Comment("NIC parameters")(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)))
+
+# TODO: Generate check from constants.IDISK_PARAMS_TYPES (however, not all users
+# of this check support all parameters)
+_TDiskParams = \
+ ht.Comment("Disk parameters")(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS),
+ ht.TOr(ht.TNonEmptyString, ht.TInt)))
+
+_TQueryRow = \
+ ht.TListOf(ht.TAnd(ht.TIsLength(2),
+ ht.TItems([ht.TElemOf(constants.RS_ALL),
+ ht.TAny])))
+
+_TQueryResult = ht.TListOf(_TQueryRow)
+
+_TOldQueryRow = ht.TListOf(ht.TAny)
+
+_TOldQueryResult = ht.TListOf(_TOldQueryRow)
+
+
+_SUMMARY_PREFIX = {
+ "CLUSTER_": "C_",
+ "GROUP_": "G_",
+ "NODE_": "N_",
+ "INSTANCE_": "I_",
+ }
+
+#: Attribute name for dependencies
+DEPEND_ATTR = "depends"
+
+#: Attribute name for comment
+COMMENT_ATTR = "comment"
+
def _NameToId(name):
"""Convert an opcode class name to an OP_ID.
return "_".join(n.upper() for n in elems)
+def _GenerateObjectTypeCheck(obj, fields_types):
+ """Helper to generate type checks for objects.
+
+ @param obj: The object to generate type checks
+ @param fields_types: The fields and their types as a dict
+ @return: A ht type check function
+
+ """
+ assert set(obj.GetAllSlots()) == set(fields_types.keys()), \
+ "%s != %s" % (set(obj.GetAllSlots()), set(fields_types.keys()))
+ return ht.TStrictDict(True, True, fields_types)
+
+
+_TQueryFieldDef = \
+ _GenerateObjectTypeCheck(objects.QueryFieldDefinition, {
+ "name": ht.TNonEmptyString,
+ "title": ht.TNonEmptyString,
+ "kind": ht.TElemOf(constants.QFT_ALL),
+ "doc": ht.TNonEmptyString,
+ })
+
+
def RequireFileStorage():
"""Checks that file storage is enabled.
errors.ECODE_INVAL)
-def _CheckDiskTemplate(template):
- """Ensure a given disk template is valid.
+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 template not in constants.DISK_TEMPLATES:
- # Using str.join directly to avoid importing utils for CommaJoin
- msg = ("Invalid disk template name '%s', valid templates are: %s" %
- (template, ", ".join(constants.DISK_TEMPLATES)))
- raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
- if template == constants.DT_FILE:
+ 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.
+
+ @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):
"""Ensure a given storage type is valid.
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
#: Storage type parameter
-_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType)
+_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
+ "Storage type")
-class _AutoOpParamSlots(type):
+class _AutoOpParamSlots(objectutils.AutoSlots):
"""Meta class for opcode definitions.
"""
@param attrs: Class attributes
"""
- assert "__slots__" not in attrs, \
- "Class '%s' defines __slots__ when it should use OP_PARAMS" % name
assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
+ 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
+
attrs["OP_ID"] = _NameToId(name)
+ return objectutils.AutoSlots.__new__(mcs, name, bases, attrs)
+
+ @classmethod
+ def _GetSlots(mcs, attrs):
+ """Build the slots out of OP_PARAMS.
+
+ """
# Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams
params = attrs.setdefault("OP_PARAMS", [])
# Use parameter names as slots
- slots = [pname for (pname, _, _) in params]
+ return [pname for (pname, _, _, _) in params]
- assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
- "Class '%s' uses unknown field in OP_DSC_FIELD" % name
-
- attrs["__slots__"] = slots
-
- return type.__new__(mcs, name, bases, attrs)
-
-class BaseOpCode(object):
+class BaseOpCode(objectutils.ValidatedSlots):
"""A simple serializable object.
This object serves as a parent class for OpCode without any custom
field handling.
"""
- # pylint: disable-msg=E1101
+ # pylint: disable=E1101
# as OP_ID is dynamically defined
__metaclass__ = _AutoOpParamSlots
- def __init__(self, **kwargs):
- """Constructor for BaseOpCode.
-
- The constructor takes only keyword arguments and will set
- attributes on this object based on the passed arguments. As such,
- it means that you should not pass arguments which are not in the
- __slots__ attribute for this class.
-
- """
- slots = self._all_slots()
- for key in kwargs:
- if key not in slots:
- raise TypeError("Object %s doesn't support the parameter '%s'" %
- (self.__class__.__name__, key))
- setattr(self, key, kwargs[key])
-
def __getstate__(self):
"""Generic serializer.
"""
state = {}
- for name in self._all_slots():
+ for name in self.GetAllSlots():
if hasattr(self, name):
state[name] = getattr(self, name)
return state
raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
type(state))
- for name in self._all_slots():
+ for name in self.GetAllSlots():
if name not in state and hasattr(self, name):
delattr(self, name)
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
-
- @classmethod
def GetAllParams(cls):
"""Compute list of all parameters for an opcode.
slots.extend(getattr(parent, "OP_PARAMS", []))
return slots
- def Validate(self, set_defaults):
+ def Validate(self, set_defaults): # pylint: disable=W0221
"""Validate opcode parameters, optionally setting default values.
@type set_defaults: bool
requirements
"""
- for (attr_name, default, test) in self.GetAllParams():
+ for (attr_name, default, test, _) in self.GetAllParams():
assert test == ht.NoType or callable(test)
if not hasattr(self, attr_name):
if set_defaults or hasattr(self, attr_name):
attr_val = getattr(self, attr_name)
if not test(attr_val):
- logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
- self.OP_ID, attr_name, type(attr_val), attr_val)
+ logging.error("OpCode %s, parameter %s, has invalid type %s/value %s"
+ " expecting type %s",
+ self.OP_ID, attr_name, type(attr_val), attr_val, test)
raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
(self.OP_ID, attr_name),
errors.ECODE_INVAL)
+def _BuildJobDepCheck(relative):
+ """Builds check for job dependencies (L{DEPEND_ATTR}).
+
+ @type relative: bool
+ @param relative: Whether to accept relative job IDs (negative)
+ @rtype: callable
+
+ """
+ if relative:
+ job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
+ else:
+ job_id = ht.TJobId
+
+ job_dep = \
+ ht.TAnd(ht.TIsLength(2),
+ ht.TItems([job_id,
+ ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))
+
+ return ht.TMaybeListOf(job_dep)
+
+
+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 = [
- ("dry_run", None, ht.TMaybeBool),
- ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
+ ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
+ ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
("priority", constants.OP_PRIO_DEFAULT,
- ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID)),
+ 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; 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.
txt = "%s(%s)" % (txt, field_value)
return txt
+ def TinySummary(self):
+ """Generates a compact summary description of the opcode.
+
+ """
+ assert self.OP_ID.startswith("OP_")
+
+ text = self.OP_ID[3:]
+
+ for (prefix, supplement) in _SUMMARY_PREFIX.items():
+ if text.startswith(prefix):
+ return supplement + text[len(prefix):]
+
+ return text
+
# cluster opcodes
after the cluster has been initialized.
"""
+ OP_RESULT = ht.TBool
class OpClusterDestroy(OpCode):
lost after the execution of this opcode.
"""
+ OP_RESULT = ht.TNonEmptyString
class OpClusterQuery(OpCode):
"""Query cluster information."""
+ OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TAny)
class OpClusterVerify(OpCode):
- """Verify the cluster state.
+ """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 = [
+ _PDebugSimulateErrors,
+ _PErrorCodes,
+ _PIgnoreErrors,
+ _PVerbose,
+ ]
+ OP_RESULT = ht.TBool
+
+
+class OpClusterVerifyGroup(OpCode):
+ """Run verify on a node group from the cluster.
@type skip_checks: C{list}
@ivar skip_checks: steps to be skipped from the verify process; this
only L{constants.VERIFY_NPLUSONE_MEM} can be passed
"""
+ OP_DSC_FIELD = "group_name"
OP_PARAMS = [
- ("skip_checks", ht.EmptyList,
- ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS))),
- ("verbose", False, ht.TBool),
- ("error_codes", False, ht.TBool),
- ("debug_simulate_errors", False, ht.TBool),
+ _PGroupName,
+ _PDebugSimulateErrors,
+ _PErrorCodes,
+ _PSkipChecks,
+ _PIgnoreErrors,
+ _PVerbose,
]
+ OP_RESULT = ht.TBool
class OpClusterVerifyDisks(OpCode):
"""Verify the cluster disks.
- Parameters: none
+ """
+ OP_RESULT = TJobIdListOnly
+
- 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)
+class OpGroupVerifyDisks(OpCode):
+ """Verifies the status of all disks in a node group.
+
+ 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 = [
- ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
+ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
]
+ OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3),
+ ht.TItems([ht.TNonEmptyString,
+ ht.TPositiveInt,
+ ht.TPositiveInt])))
class OpClusterConfigQuery(OpCode):
OP_PARAMS = [
_POutputFields
]
+ OP_RESULT = ht.TListOf(ht.TAny)
class OpClusterRename(OpCode):
"""
OP_DSC_FIELD = "name"
OP_PARAMS = [
- ("name", ht.NoDefault, ht.TNonEmptyString),
+ ("name", ht.NoDefault, ht.TNonEmptyString, None),
]
+ OP_RESULT = ht.TNonEmptyString
class OpClusterSetParams(OpCode):
"""
OP_PARAMS = [
- ("vg_name", None, ht.TMaybeString),
+ _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),
- ht.TNone)),
+ ht.TNone),
+ "List of enabled hypervisors"),
("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone)),
- ("beparams", None, ht.TOr(ht.TDict, ht.TNone)),
+ ht.TNone),
+ "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
+ ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
+ "Cluster-wide backend parameter defaults"),
("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone)),
+ ht.TNone),
+ "Cluster-wide per-OS hypervisor parameter defaults"),
("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
- ht.TNone)),
- ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone)),
- ("uid_pool", None, ht.NoType),
- ("add_uids", None, ht.NoType),
- ("remove_uids", None, ht.NoType),
- ("maintain_node_health", None, ht.TMaybeBool),
- ("prealloc_wipe_disks", None, ht.TMaybeBool),
- ("nicparams", None, ht.TMaybeDict),
- ("ndparams", None, ht.TMaybeDict),
- ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone)),
- ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone)),
- ("master_netdev", None, ht.TOr(ht.TString, ht.TNone)),
- ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone)),
- ("hidden_os", None, ht.TOr(ht.TListOf(
- ht.TAnd(ht.TList,
- ht.TIsLength(2),
- ht.TMap(lambda v: v[0], ht.TElemOf(constants.DDMS_VALUES)))),
- ht.TNone)),
- ("blacklisted_os", None, ht.TOr(ht.TListOf(
- ht.TAnd(ht.TList,
- ht.TIsLength(2),
- ht.TMap(lambda v: v[0], ht.TElemOf(constants.DDMS_VALUES)))),
- ht.TNone)),
+ 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,
+ "Set UID pool, must be list of lists describing UID ranges (two items,"
+ " start and end inclusive)"),
+ ("add_uids", None, ht.NoType,
+ "Extend UID pool, must be list of lists describing UID ranges (two"
+ " items, start and end inclusive) to be added"),
+ ("remove_uids", None, ht.NoType,
+ "Shrink UID pool, must be list of lists describing UID ranges (two"
+ " items, start and end inclusive) to be removed"),
+ ("maintain_node_health", None, ht.TMaybeBool,
+ "Whether to automatically maintain node health"),
+ ("prealloc_wipe_disks", None, ht.TMaybeBool,
+ "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 :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),
+ "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.TMaybeListOf(ht.TNonEmptyString),
+ "List of reserved LVs"),
+ ("hidden_os", None, _TestClusterOsList,
+ "Modify list of hidden 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)),
+ ("blacklisted_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"),
]
+ OP_RESULT = ht.TNone
class OpClusterRedistConf(OpCode):
"""Force a full push of the cluster configuration.
"""
+ OP_RESULT = ht.TNone
+
+
+class OpClusterActivateMasterIp(OpCode):
+ """Activate the master IP on the master node.
+
+ """
+ OP_RESULT = ht.TNone
+
+
+class OpClusterDeactivateMasterIp(OpCode):
+ """Deactivate the master IP on the master node.
+
+ """
+ OP_RESULT = ht.TNone
class OpQuery(OpCode):
"""Query for resources/items.
- @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
+ @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 = [
- ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)),
- ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
- ("filter", None, ht.TOr(ht.TNone,
- ht.TListOf(ht.TOr(ht.TNonEmptyString, ht.TList)))),
+ _PQueryWhat,
+ _PUseLocking,
+ ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
+ "Requested fields"),
+ ("qfilter", None, ht.TOr(ht.TNone, ht.TList),
+ "Query filter"),
]
+ OP_RESULT = \
+ _GenerateObjectTypeCheck(objects.QueryResponse, {
+ "fields": ht.TListOf(_TQueryFieldDef),
+ "data": _TQueryResult,
+ })
class OpQueryFields(OpCode):
"""Query for available resource/item fields.
- @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
+ @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
@ivar fields: List of fields to retrieve
"""
+ OP_DSC_FIELD = "what"
OP_PARAMS = [
- ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)),
- ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString))),
+ _PQueryWhat,
+ ("fields", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "Requested fields; if not given, all are returned"),
]
+ OP_RESULT = \
+ _GenerateObjectTypeCheck(objects.QueryFieldsResponse, {
+ "fields": ht.TListOf(_TQueryFieldDef),
+ })
class OpOobCommand(OpCode):
"""Interact with OOB."""
OP_PARAMS = [
- ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("command", None, ht.TElemOf(constants.OOB_COMMANDS)),
- ("timeout", constants.OOB_TIMEOUT, ht.TInt),
+ ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "List of nodes to run the OOB command against"),
+ ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
+ "OOB command to be run"),
+ ("timeout", constants.OOB_TIMEOUT, ht.TInt,
+ "Timeout before the OOB helper will be terminated"),
+ ("ignore_status", False, ht.TBool,
+ "Ignores the node offline status for power off"),
+ ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
+ "Time in seconds to wait between powering on nodes"),
]
+ # Fixme: Make it more specific with all the special cases in LUOobCommand
+ OP_RESULT = _TQueryResult
# node opcodes
OP_PARAMS = [
_PNodeName,
]
+ OP_RESULT = ht.TNone
class OpNodeAdd(OpCode):
OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
- ("primary_ip", None, ht.NoType),
- ("secondary_ip", None, ht.TMaybeString),
- ("readd", False, ht.TBool),
- ("group", None, ht.TMaybeString),
- ("master_capable", None, ht.TMaybeBool),
- ("vm_capable", None, ht.TMaybeBool),
- ("ndparams", None, ht.TMaybeDict),
+ _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"),
+ ("group", None, ht.TMaybeString, "Initial node group"),
+ ("master_capable", None, ht.TMaybeBool,
+ "Whether node can become master or master candidate"),
+ ("vm_capable", None, ht.TMaybeBool,
+ "Whether node can host instances"),
+ ("ndparams", None, ht.TMaybeDict, "Node parameters"),
]
+ OP_RESULT = ht.TNone
class OpNodeQuery(OpCode):
"""Compute the list of nodes."""
OP_PARAMS = [
_POutputFields,
- ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("use_locking", False, ht.TBool),
+ _PUseLocking,
+ ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Empty list to query all nodes, node names otherwise"),
]
+ OP_RESULT = _TOldQueryResult
class OpNodeQueryvols(OpCode):
"""Get list of volumes on node."""
OP_PARAMS = [
_POutputFields,
- ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
+ ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Empty list to query all nodes, node names otherwise"),
]
+ OP_RESULT = ht.TListOf(ht.TAny)
class OpNodeQueryStorage(OpCode):
OP_PARAMS = [
_POutputFields,
_PStorageType,
- ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("name", None, ht.TMaybeString),
+ ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
+ ("name", None, ht.TMaybeString, "Storage name"),
]
+ OP_RESULT = _TOldQueryResult
class OpNodeModifyStorage(OpCode):
"""Modifies the properies of a storage unit"""
+ OP_DSC_FIELD = "node_name"
OP_PARAMS = [
_PNodeName,
_PStorageType,
- ("name", ht.NoDefault, ht.TNonEmptyString),
- ("changes", ht.NoDefault, ht.TDict),
+ _PStorageName,
+ ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
]
+ OP_RESULT = ht.TNone
class OpRepairNodeStorage(OpCode):
OP_PARAMS = [
_PNodeName,
_PStorageType,
+ _PStorageName,
_PIgnoreConsistency,
- ("name", ht.NoDefault, ht.TNonEmptyString),
]
+ OP_RESULT = ht.TNone
class OpNodeSetParams(OpCode):
OP_PARAMS = [
_PNodeName,
_PForce,
- ("master_candidate", None, ht.TMaybeBool),
- ("offline", None, ht.TMaybeBool),
- ("drained", None, ht.TMaybeBool),
- ("auto_promote", False, ht.TBool),
- ("master_capable", None, ht.TMaybeBool),
- ("vm_capable", None, ht.TMaybeBool),
- ("secondary_ip", None, ht.TMaybeString),
- ("ndparams", None, ht.TMaybeDict),
- ("powered", None, ht.TMaybeBool),
+ _PHvState,
+ _PDiskState,
+ ("master_candidate", None, ht.TMaybeBool,
+ "Whether the node should become a master candidate"),
+ ("offline", None, ht.TMaybeBool,
+ "Whether the node should be marked as offline"),
+ ("drained", None, ht.TMaybeBool,
+ "Whether the node should be marked as drained"),
+ ("auto_promote", False, ht.TBool,
+ "Whether node(s) should be promoted to master candidate if necessary"),
+ ("master_capable", None, ht.TMaybeBool,
+ "Denote whether node can become master or master candidate"),
+ ("vm_capable", None, ht.TMaybeBool,
+ "Denote whether node can host instances"),
+ ("secondary_ip", None, ht.TMaybeString,
+ "Change node's secondary IP address"),
+ ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
+ ("powered", None, ht.TMaybeBool,
+ "Whether the node should be marked as powered"),
]
+ OP_RESULT = _TSetParamsResult
class OpNodePowercycle(OpCode):
_PNodeName,
_PForce,
]
+ OP_RESULT = ht.TMaybeString
class OpNodeMigrate(OpCode):
_PNodeName,
_PMigrationMode,
_PMigrationLive,
+ _PMigrationTargetNode,
+ _PAllowRuntimeChgs,
+ _PIgnoreIpolicy,
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding the target node for shared-storage instances"),
]
+ OP_RESULT = TJobIdListOnly
-class OpNodeEvacStrategy(OpCode):
- """Compute the evacuation strategy for a list of nodes."""
- OP_DSC_FIELD = "nodes"
+class OpNodeEvacuate(OpCode):
+ """Evacuate instances off a number of nodes."""
+ OP_DSC_FIELD = "node_name"
OP_PARAMS = [
- ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
- ("remote_node", None, ht.TMaybeString),
- ("iallocator", None, ht.TMaybeString),
+ _PEarlyRelease,
+ _PNodeName,
+ ("remote_node", None, ht.TMaybeString, "New secondary node"),
+ ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
+ ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
+ "Node evacuation mode"),
]
+ OP_RESULT = TJobIdListOnly
# instance opcodes
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("beparams", ht.EmptyDict, ht.TDict),
- ("disks", ht.NoDefault, ht.TListOf(ht.TDict)),
- ("disk_template", ht.NoDefault, _CheckDiskTemplate),
- ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER))),
- ("file_storage_dir", None, ht.TMaybeString),
- ("force_variant", False, ht.TBool),
- ("hvparams", ht.EmptyDict, ht.TDict),
- ("hypervisor", None, ht.TMaybeString),
- ("iallocator", None, ht.TMaybeString),
- ("identify_defaults", False, ht.TBool),
- ("ip_check", True, ht.TBool),
- ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES)),
- ("name_check", True, ht.TBool),
- ("nics", ht.NoDefault, ht.TListOf(ht.TDict)),
- ("no_install", None, ht.TMaybeBool),
- ("osparams", ht.EmptyDict, ht.TDict),
- ("os_type", None, ht.TMaybeString),
- ("pnode", None, ht.TMaybeString),
- ("snode", None, ht.TMaybeString),
- ("source_handshake", None, ht.TOr(ht.TList, ht.TNone)),
- ("source_instance_name", None, ht.TMaybeString),
+ _PForceVariant,
+ _PWaitForSync,
+ _PNameCheck,
+ _PIgnoreIpolicy,
+ ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
+ ("disks", ht.NoDefault, ht.TListOf(_TDiskParams),
+ "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
+ " each disk definition must contain a ``%s`` value and"
+ " can contain an optional ``%s`` value denoting the disk access mode"
+ " (%s)" %
+ (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, _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,
+ "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"),
+ ("identify_defaults", False, ht.TBool,
+ "Reset instance parameters to default if equal"),
+ ("ip_check", True, ht.TBool, _PIpCheckDoc),
+ ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
+ "Instance creation mode"),
+ ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
+ "List of NIC (network interface) definitions, for example"
+ " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
+ " contain the optional values %s" %
+ (constants.INIC_IP,
+ ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
+ ("no_install", None, ht.TMaybeBool,
+ "Do not install the OS (will disable automatic start)"),
+ ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
+ ("os_type", None, ht.TMaybeString, "Operating system"),
+ ("pnode", None, ht.TMaybeString, "Primary node"),
+ ("snode", None, ht.TMaybeString, "Secondary node"),
+ ("source_handshake", None, ht.TOr(ht.TList, ht.TNone),
+ "Signed handshake from source (remote import only)"),
+ ("source_instance_name", None, ht.TMaybeString,
+ "Source instance name (remote import only)"),
("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
- ht.TPositiveInt),
- ("source_x509_ca", None, ht.TMaybeString),
- ("src_node", None, ht.TMaybeString),
- ("src_path", None, ht.TMaybeString),
- ("start", True, ht.TBool),
- ("wait_for_sync", True, ht.TBool),
+ ht.TPositiveInt,
+ "How long source instance was given to shut down (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_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_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
+
+
+class OpInstanceMultiAlloc(OpCode):
+ """Allocates multiple instances.
+
+ """
+ OP_PARAMS = [
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator used to allocate all the instances"),
+ ("instances", [], ht.TListOf(ht.TInstanceOf(OpInstanceCreate)),
+ "List of instance create opcodes describing the instances to allocate"),
+ ]
+ _JOB_LIST = ht.Comment("List of submitted jobs")(TJobIdList)
+ ALLOCATABLE_KEY = "allocatable"
+ FAILED_KEY = "allocatable"
+ OP_RESULT = ht.TStrictDict(True, True, {
+ constants.JOB_IDS_KEY: _JOB_LIST,
+ ALLOCATABLE_KEY: ht.TListOf(ht.TNonEmptyString),
+ FAILED_KEY: ht.TListOf(ht.TNonEmptyString)
+ })
+
+ def __getstate__(self):
+ """Generic serializer.
+
+ """
+ state = OpCode.__getstate__(self)
+ if hasattr(self, "instances"):
+ # pylint: disable=E1101
+ state["instances"] = [inst.__getstate__() for inst in self.instances]
+ return state
+
+ def __setstate__(self, state):
+ """Generic unserializer.
+
+ This method just restores from the serialized state the attributes
+ of the current instance.
+
+ @param state: the serialized opcode data
+ @type state: C{dict}
+
+ """
+ if not isinstance(state, dict):
+ raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
+ type(state))
+
+ if "instances" in state:
+ insts = [OpCode.LoadOpCode(inst) for inst in state["instances"]]
+ state["instances"] = insts
+ return OpCode.__setstate__(self, state)
+
+ def Validate(self, set_defaults):
+ """Validates this opcode.
+
+ We do this recursively.
+
+ """
+ OpCode.Validate(self, set_defaults)
+
+ for inst in self.instances: # pylint: disable=E1101
+ inst.Validate(set_defaults)
class OpInstanceReinstall(OpCode):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("os_type", None, ht.TMaybeString),
- ("force_variant", False, ht.TBool),
- ("osparams", None, ht.TMaybeDict),
+ _PForceVariant,
+ ("os_type", None, ht.TMaybeString, "Instance operating system"),
+ ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
]
+ OP_RESULT = ht.TNone
class OpInstanceRemove(OpCode):
OP_PARAMS = [
_PInstanceName,
_PShutdownTimeout,
- ("ignore_failures", False, ht.TBool),
+ ("ignore_failures", False, ht.TBool,
+ "Whether to ignore failures during removal"),
]
+ OP_RESULT = ht.TNone
class OpInstanceRename(OpCode):
"""Rename an instance."""
OP_PARAMS = [
_PInstanceName,
- ("new_name", ht.NoDefault, ht.TNonEmptyString),
- ("ip_check", False, ht.TBool),
- ("name_check", True, ht.TBool),
+ _PNameCheck,
+ ("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):
_PInstanceName,
_PForce,
_PIgnoreOfflineNodes,
+ ("hvparams", ht.EmptyDict, ht.TDict,
+ "Temporary hypervisor parameters, hypervisor-dependent"),
+ ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
_PNoRemember,
- ("hvparams", ht.EmptyDict, ht.TDict),
- ("beparams", ht.EmptyDict, ht.TDict),
+ _PStartupPaused,
]
+ OP_RESULT = ht.TNone
class OpInstanceShutdown(OpCode):
OP_PARAMS = [
_PInstanceName,
_PIgnoreOfflineNodes,
+ ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
+ "How long to wait for instance to shut down"),
_PNoRemember,
- ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt),
]
+ OP_RESULT = ht.TNone
class OpInstanceReboot(OpCode):
OP_PARAMS = [
_PInstanceName,
_PShutdownTimeout,
- ("ignore_secondaries", False, ht.TBool),
- ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES)),
+ ("ignore_secondaries", False, ht.TBool,
+ "Whether to start the instance even if secondary disks are failing"),
+ ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
+ "How to reboot instance"),
]
+ OP_RESULT = ht.TNone
class OpInstanceReplaceDisks(OpCode):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES)),
- ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt)),
- ("remote_node", None, ht.TMaybeString),
- ("iallocator", None, ht.TMaybeString),
- ("early_release", False, ht.TBool),
+ _PEarlyRelease,
+ _PIgnoreIpolicy,
+ ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
+ "Replacement mode"),
+ ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
+ "Disk indexes"),
+ ("remote_node", None, ht.TMaybeString, "New secondary node"),
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding new secondary node"),
]
+ OP_RESULT = ht.TNone
class OpInstanceFailover(OpCode):
_PInstanceName,
_PShutdownTimeout,
_PIgnoreConsistency,
+ _PMigrationTargetNode,
+ _PIgnoreIpolicy,
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding the target node for shared-storage instances"),
]
+ OP_RESULT = ht.TNone
class OpInstanceMigrate(OpCode):
_PInstanceName,
_PMigrationMode,
_PMigrationLive,
- ("cleanup", False, ht.TBool),
+ _PMigrationTargetNode,
+ _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"),
+ ("allow_failover", False, ht.TBool,
+ "Whether we can fallback to failover if migration is not possible"),
]
+ OP_RESULT = ht.TNone
class OpInstanceMove(OpCode):
OP_PARAMS = [
_PInstanceName,
_PShutdownTimeout,
+ _PIgnoreIpolicy,
+ ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
_PIgnoreConsistency,
- ("target_node", ht.NoDefault, ht.TNonEmptyString),
]
+ OP_RESULT = ht.TNone
class OpInstanceConsole(OpCode):
OP_PARAMS = [
_PInstanceName
]
+ OP_RESULT = ht.TDict
class OpInstanceActivateDisks(OpCode):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("ignore_size", False, ht.TBool),
+ ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
+ _PWaitForSyncFalse,
]
+ OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3),
+ ht.TItems([ht.TNonEmptyString,
+ ht.TNonEmptyString,
+ ht.TNonEmptyString])))
class OpInstanceDeactivateDisks(OpCode):
_PInstanceName,
_PForce,
]
+ OP_RESULT = ht.TNone
class OpInstanceRecreateDisks(OpCode):
- """Deactivate an instance's disks."""
+ """Recreate an instance's disks."""
+ _TDiskChanges = \
+ ht.TAnd(ht.TIsLength(2),
+ ht.TItems([ht.Comment("Disk index")(ht.TPositiveInt),
+ ht.Comment("Parameters")(_TDiskParams)]))
+
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt)),
- ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
+ ("disks", ht.EmptyList,
+ ht.TOr(ht.TListOf(ht.TPositiveInt), 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"),
]
+ OP_RESULT = ht.TNone
class OpInstanceQuery(OpCode):
"""Compute the list of instances."""
OP_PARAMS = [
_POutputFields,
- ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("use_locking", False, ht.TBool),
+ _PUseLocking,
+ ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Empty list to query all instances, instance names otherwise"),
]
+ OP_RESULT = _TOldQueryResult
class OpInstanceQueryData(OpCode):
"""Compute the run-time status of instances."""
OP_PARAMS = [
- ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("static", False, ht.TBool),
- ("use_locking", False, ht.TBool),
+ _PUseLocking,
+ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Instance names"),
+ ("static", False, ht.TBool,
+ "Whether to only return configuration data without querying"
+ " nodes"),
]
+ OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TDict)
+
+
+def _TestInstSetParamsModList(fn):
+ """Generates a check for modification lists.
+
+ """
+ # Old format
+ # TODO: Remove in version 2.8 including support in LUInstanceSetParams
+ old_mod_item_fn = \
+ ht.TAnd(ht.TIsLength(2), ht.TItems([
+ ht.TOr(ht.TElemOf(constants.DDMS_VALUES), ht.TPositiveInt),
+ fn,
+ ]))
+
+ # New format, supporting adding/removing disks/NICs at arbitrary indices
+ 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),
+ fn,
+ ]))
+
+ return ht.TOr(ht.Comment("Recommended")(ht.TListOf(mod_item_fn)),
+ ht.Comment("Deprecated")(ht.TListOf(old_mod_item_fn)))
class OpInstanceSetParams(OpCode):
- """Change the parameters of an instance."""
+ """Change the parameters of an instance.
+
+ """
+ TestNicModifications = _TestInstSetParamsModList(_TestNicDef)
+ TestDiskModifications = _TestInstSetParamsModList(_TDiskParams)
+
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
_PForce,
- ("nics", ht.EmptyList, ht.TList),
- ("disks", ht.EmptyList, ht.TList),
- ("beparams", ht.EmptyDict, ht.TDict),
- ("hvparams", ht.EmptyDict, ht.TDict),
- ("disk_template", None, ht.TOr(ht.TNone, _CheckDiskTemplate)),
- ("remote_node", None, ht.TMaybeString),
- ("os_name", None, ht.TMaybeString),
- ("force_variant", False, ht.TBool),
- ("osparams", None, ht.TMaybeDict),
- ("wait_for_sync", True, ht.TBool),
+ _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"
+ " 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"
+ " settings of the NIC with that index" %
+ (constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE,
+ constants.DDM_ADD, constants.DDM_REMOVE)),
+ ("disks", ht.EmptyList, TestDiskModifications,
+ "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, _BuildDiskTemplateCheck(False)),
+ "Disk template for instance"),
+ ("remote_node", None, ht.TMaybeString,
+ "Secondary node (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"),
+ ("wait_for_sync", True, ht.TBool,
+ "Whether to wait for the disk to synchronize, when changing template"),
+ ("offline", None, ht.TMaybeBool, "Whether to mark instance as offline"),
]
+ OP_RESULT = _TSetParamsResult
class OpInstanceGrowDisk(OpCode):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("disk", ht.NoDefault, ht.TInt),
- ("amount", ht.NoDefault, ht.TInt),
- ("wait_for_sync", True, ht.TBool),
+ _PWaitForSync,
+ ("disk", ht.NoDefault, ht.TInt, "Disk index"),
+ ("amount", ht.NoDefault, ht.TPositiveInt,
+ "Amount of disk space to add (megabytes)"),
+ ("absolute", False, ht.TBool,
+ "Whether the amount parameter is an absolute target or a relative one"),
]
+ OP_RESULT = ht.TNone
+
+
+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.TMaybeListOf(ht.TNonEmptyString),
+ "Destination group names or UUIDs (defaults to \"all but current group\""),
+ ]
+ OP_RESULT = TJobIdListOnly
# Node group opcodes
OP_DSC_FIELD = "group_name"
OP_PARAMS = [
_PGroupName,
- ("ndparams", None, ht.TMaybeDict),
- ("alloc_policy", None,
- ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
+ _PNodeGroupAllocPolicy,
+ _PGroupNodeParams,
+ _PDiskParams,
+ _PHvState,
+ _PDiskState,
+ ("ipolicy", None, ht.TMaybeDict,
+ "Group-wide :ref:`instance policy <rapi-ipolicy>` specs"),
]
+ OP_RESULT = ht.TNone
class OpGroupAssignNodes(OpCode):
OP_PARAMS = [
_PGroupName,
_PForce,
- ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
+ ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
+ "List of nodes to assign"),
]
+ OP_RESULT = ht.TNone
class OpGroupQuery(OpCode):
"""Compute the list of node groups."""
OP_PARAMS = [
_POutputFields,
- ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
+ ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Empty list to query all groups, group names otherwise"),
]
+ OP_RESULT = _TOldQueryResult
class OpGroupSetParams(OpCode):
OP_DSC_FIELD = "group_name"
OP_PARAMS = [
_PGroupName,
- ("ndparams", None, ht.TMaybeDict),
- ("alloc_policy", None, ht.TOr(ht.TNone,
- ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
+ _PNodeGroupAllocPolicy,
+ _PGroupNodeParams,
+ _PDiskParams,
+ _PHvState,
+ _PDiskState,
+ ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
]
+ OP_RESULT = _TSetParamsResult
class OpGroupRemove(OpCode):
OP_PARAMS = [
_PGroupName,
]
+ OP_RESULT = ht.TNone
class OpGroupRename(OpCode):
"""Rename a node group in the cluster."""
- OP_DSC_FIELD = "old_name"
OP_PARAMS = [
- ("old_name", ht.NoDefault, ht.TNonEmptyString),
- ("new_name", ht.NoDefault, ht.TNonEmptyString),
+ _PGroupName,
+ ("new_name", ht.NoDefault, ht.TNonEmptyString, "New group name"),
]
+ OP_RESULT = ht.Comment("New group name")(ht.TNonEmptyString)
+
+
+class OpGroupEvacuate(OpCode):
+ """Evacuate a node group in the cluster."""
+ OP_DSC_FIELD = "group_name"
+ OP_PARAMS = [
+ _PGroupName,
+ _PEarlyRelease,
+ ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
+ ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
+ "Destination group names or UUIDs"),
+ ]
+ OP_RESULT = TJobIdListOnly
# OS opcodes
"""Compute the list of guest operating systems."""
OP_PARAMS = [
_POutputFields,
- ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
+ ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Which operating systems to diagnose"),
]
+ OP_RESULT = _TOldQueryResult
# Exports opcodes
class OpBackupQuery(OpCode):
"""Compute the list of exported images."""
OP_PARAMS = [
- ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("use_locking", False, ht.TBool),
+ _PUseLocking,
+ ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Empty list to query all nodes, node names otherwise"),
]
+ OP_RESULT = ht.TDictOf(ht.TNonEmptyString,
+ ht.TOr(ht.Comment("False on error")(ht.TBool),
+ ht.TListOf(ht.TNonEmptyString)))
class OpBackupPrepare(OpCode):
OP_DSC_FIELD = "instance_name"
OP_PARAMS = [
_PInstanceName,
- ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES)),
+ ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES),
+ "Export mode"),
]
+ OP_RESULT = ht.TOr(ht.TNone, ht.TDict)
class OpBackupExport(OpCode):
_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)),
- ("shutdown", True, ht.TBool),
- ("remove_instance", False, ht.TBool),
- ("ignore_remove_failures", False, ht.TBool),
- ("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES)),
- ("x509_key_name", None, ht.TOr(ht.TList, ht.TNone)),
- ("destination_x509_ca", None, ht.TMaybeString),
+ ("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList),
+ "Destination information, depends on export mode"),
+ ("shutdown", True, ht.TBool, "Whether to shutdown instance before export"),
+ ("remove_instance", False, ht.TBool,
+ "Whether to remove instance after export"),
+ ("ignore_remove_failures", False, ht.TBool,
+ "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),
+ "Name of X509 key (remote export only)"),
+ ("destination_x509_ca", None, ht.TMaybeString,
+ "Destination X509 CA (remote export only)"),
]
+ OP_RESULT = \
+ ht.TAnd(ht.TIsLength(2), ht.TItems([
+ ht.Comment("Finalizing status")(ht.TBool),
+ ht.Comment("Status for every exported disk")(ht.TListOf(ht.TBool)),
+ ]))
class OpBackupRemove(OpCode):
OP_PARAMS = [
_PInstanceName,
]
+ OP_RESULT = ht.TNone
# Tags opcodes
OP_DSC_FIELD = "name"
OP_PARAMS = [
_PTagKind,
+ # Not using _PUseLocking as the default is different for historical reasons
+ ("use_locking", True, ht.TBool, "Whether to use synchronization"),
# Name is only meaningful for nodes and instances
- ("name", ht.NoDefault, ht.TMaybeString),
+ ("name", ht.NoDefault, ht.TMaybeString,
+ "Name of object to retrieve tags from"),
]
+ OP_RESULT = ht.TListOf(ht.TNonEmptyString)
class OpTagsSearch(OpCode):
"""Searches the tags in the cluster for a given pattern."""
OP_DSC_FIELD = "pattern"
OP_PARAMS = [
- ("pattern", ht.NoDefault, ht.TNonEmptyString),
+ ("pattern", ht.NoDefault, ht.TNonEmptyString,
+ "Search pattern (regular expression)"),
]
+ OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([
+ ht.TNonEmptyString,
+ ht.TNonEmptyString,
+ ])))
class OpTagsSet(OpCode):
_PTagKind,
_PTags,
# Name is only meaningful for nodes and instances
- ("name", ht.NoDefault, ht.TMaybeString),
+ ("name", ht.NoDefault, ht.TMaybeString,
+ "Name of object where tag(s) should be added"),
]
+ OP_RESULT = ht.TNone
class OpTagsDel(OpCode):
_PTagKind,
_PTags,
# Name is only meaningful for nodes and instances
- ("name", ht.NoDefault, ht.TMaybeString),
+ ("name", ht.NoDefault, ht.TMaybeString,
+ "Name of object where tag(s) should be deleted"),
]
+ OP_RESULT = ht.TNone
+
# Test opcodes
class OpTestDelay(OpCode):
"""
OP_DSC_FIELD = "duration"
OP_PARAMS = [
- ("duration", ht.NoDefault, ht.TNumber),
- ("on_master", True, ht.TBool),
- ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("repeat", 0, ht.TPositiveInt)
+ ("duration", ht.NoDefault, ht.TNumber, None),
+ ("on_master", True, ht.TBool, None),
+ ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
+ ("repeat", 0, ht.TPositiveInt, None),
]
OP_DSC_FIELD = "allocator"
OP_PARAMS = [
("direction", ht.NoDefault,
- ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS)),
- ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES)),
- ("name", ht.NoDefault, ht.TNonEmptyString),
- ("nics", ht.NoDefault, ht.TOr(ht.TNone, ht.TListOf(
- ht.TDictOf(ht.TElemOf(["mac", "ip", "bridge"]),
- ht.TOr(ht.TNone, ht.TNonEmptyString))))),
- ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList)),
- ("hypervisor", None, ht.TMaybeString),
- ("allocator", None, ht.TMaybeString),
- ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
- ("mem_size", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
- ("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
- ("os", None, ht.TMaybeString),
- ("disk_template", None, ht.TMaybeString),
- ("evac_nodes", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString))),
+ ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None),
+ ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES), None),
+ ("name", ht.NoDefault, ht.TNonEmptyString, None),
+ ("nics", ht.NoDefault,
+ ht.TMaybeListOf(ht.TDictOf(ht.TElemOf([constants.INIC_MAC,
+ constants.INIC_IP,
+ "bridge"]),
+ ht.TOr(ht.TNone, ht.TNonEmptyString))),
+ None),
+ ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList), None),
+ ("hypervisor", None, ht.TMaybeString, None),
+ ("allocator", None, ht.TMaybeString, None),
+ ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
+ ("memory", None, ht.TOr(ht.TNone, ht.TPositiveInt), None),
+ ("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt), 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),
+ ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
+ ("spindle_use", 1, ht.TPositiveInt, None),
+ ("count", 1, ht.TPositiveInt, None),
]
"""
OP_PARAMS = [
- ("notify_waitlock", False, ht.TBool),
- ("notify_exec", False, ht.TBool),
- ("log_messages", ht.EmptyList, ht.TListOf(ht.TString)),
- ("fail", False, ht.TBool),
+ ("notify_waitlock", False, ht.TBool, None),
+ ("notify_exec", False, ht.TBool, None),
+ ("log_messages", ht.EmptyList, ht.TListOf(ht.TString), None),
+ ("fail", False, ht.TBool, None),
]
"""
OP_PARAMS = [
- ("result", ht.NoDefault, ht.NoType),
- ("messages", ht.NoDefault, ht.NoType),
- ("fail", ht.NoDefault, ht.NoType),
+ ("result", ht.NoDefault, ht.NoType, None),
+ ("messages", ht.NoDefault, ht.NoType, None),
+ ("fail", ht.NoDefault, ht.NoType, None),
+ ("submit_jobs", None, ht.NoType, None),
]
WITH_LU = False
projects / ganeti-local / blobdiff