4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 This module implements the data structures which define the cluster
25 operations - the so-called opcodes.
27 Every operation which modifies the cluster state is expressed via
32 # this are practically structures, so disable the message about too
34 # pylint: disable=R0903
40 from ganeti import constants
41 from ganeti import errors
43 from ganeti import objects
44 from ganeti import outils
47 # Common opcode attributes
49 #: output fields for a query operation
50 _POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
51 "Selected output fields")
53 #: the shutdown timeout
55 ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativeInt,
56 "How long to wait for instance to shut down")
58 #: the force parameter
59 _PForce = ("force", False, ht.TBool, "Whether to force the operation")
61 #: a required instance name (for single-instance LUs)
62 _PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
65 #: a instance UUID (for single-instance LUs)
66 _PInstanceUuid = ("instance_uuid", None, ht.TMaybeString,
69 #: Whether to ignore offline nodes
70 _PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool,
71 "Whether to ignore offline nodes")
73 #: a required node name (for single-node LUs)
74 _PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
76 #: a node UUID (for use with _PNodeName)
77 _PNodeUuid = ("node_uuid", None, ht.TMaybeString, "Node UUID")
79 #: a required node group name (for single-group LUs)
80 _PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString, "Group name")
82 #: Migration type (live/non-live)
83 _PMigrationMode = ("mode", None,
84 ht.TMaybe(ht.TElemOf(constants.HT_MIGRATION_MODES)),
87 #: Obsolete 'live' migration mode (boolean)
88 _PMigrationLive = ("live", None, ht.TMaybeBool,
89 "Legacy setting for live migration, do not use")
92 _PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES),
95 #: List of tag strings
96 _PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
99 _PForceVariant = ("force_variant", False, ht.TBool,
100 "Whether to force an unknown OS variant")
102 _PWaitForSync = ("wait_for_sync", True, ht.TBool,
103 "Whether to wait for the disk to synchronize")
105 _PWaitForSyncFalse = ("wait_for_sync", False, ht.TBool,
106 "Whether to wait for the disk to synchronize"
107 " (defaults to false)")
109 _PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
110 "Whether to ignore disk consistency")
112 _PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")
114 _PUseLocking = ("use_locking", False, ht.TBool,
115 "Whether to use synchronization")
117 _PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")
119 _PNodeGroupAllocPolicy = \
120 ("alloc_policy", None,
121 ht.TMaybe(ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
122 "Instance allocation policy")
124 _PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
125 "Default node parameters for group")
127 _PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
128 "Resource(s) to query for")
130 _PEarlyRelease = ("early_release", False, ht.TBool,
131 "Whether to release locks as soon as possible")
133 _PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
135 #: Do not remember instance state changes
136 _PNoRemember = ("no_remember", False, ht.TBool,
137 "Do not remember the state change")
139 #: Target node for instance migration/failover
140 _PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
141 "Target node for shared-storage instances")
143 _PMigrationTargetNodeUuid = ("target_node_uuid", None, ht.TMaybeString,
144 "Target node UUID for shared-storage instances")
146 _PStartupPaused = ("startup_paused", False, ht.TBool,
147 "Pause instance at startup")
149 _PVerbose = ("verbose", False, ht.TBool, "Verbose mode")
151 # Parameters for cluster verification
152 _PDebugSimulateErrors = ("debug_simulate_errors", False, ht.TBool,
153 "Whether to simulate errors (useful for debugging)")
154 _PErrorCodes = ("error_codes", False, ht.TBool, "Error codes")
155 _PSkipChecks = ("skip_checks", ht.EmptyList,
156 ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)),
157 "Which checks to skip")
158 _PIgnoreErrors = ("ignore_errors", ht.EmptyList,
159 ht.TListOf(ht.TElemOf(constants.CV_ALL_ECODES_STRINGS)),
160 "List of error codes that should be treated as warnings")
165 ht.TMaybe(ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict)),
166 "Disk templates' parameter defaults")
168 # Parameters for node resource model
169 _PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
170 _PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")
172 #: Opportunistic locking
173 _POpportunisticLocking = \
174 ("opportunistic_locking", False, ht.TBool,
175 ("Whether to employ opportunistic locking for nodes, meaning nodes"
176 " already locked by another opcode won't be considered for instance"
177 " allocation (only when an iallocator is used)"))
179 _PIgnoreIpolicy = ("ignore_ipolicy", False, ht.TBool,
180 "Whether to ignore ipolicy violations")
182 # Allow runtime changes while migrating
183 _PAllowRuntimeChgs = ("allow_runtime_changes", True, ht.TBool,
184 "Allow runtime changes (eg. memory ballooning)")
186 #: IAllocator field builder
187 _PIAllocFromDesc = lambda desc: ("iallocator", None, ht.TMaybeString, desc)
189 #: a required network name
190 _PNetworkName = ("network_name", ht.NoDefault, ht.TNonEmptyString,
194 ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
195 "Destination group names or UUIDs (defaults to \"all but current group\")")
197 #: OP_ID conversion regular expression
198 _OPID_RE = re.compile("([a-z])([A-Z])")
200 #: Utility function for L{OpClusterSetParams}
201 _TestClusterOsListItem = \
202 ht.TAnd(ht.TIsLength(2), ht.TItems([
203 ht.TElemOf(constants.DDMS_VALUES),
207 _TestClusterOsList = ht.TMaybeListOf(_TestClusterOsListItem)
209 # TODO: Generate check from constants.INIC_PARAMS_TYPES
210 #: Utility function for testing NIC definitions
212 ht.Comment("NIC parameters")(ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
215 _TSetParamsResultItemItems = [
216 ht.Comment("name of changed parameter")(ht.TNonEmptyString),
217 ht.Comment("new value")(ht.TAny),
220 _TSetParamsResult = \
221 ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
222 ht.TItems(_TSetParamsResultItemItems)))
224 # In the disks option we can provide arbitrary parameters too, which
225 # we may not be able to validate at this level, so we just check the
226 # format of the dict here and the checks concerning IDISK_PARAMS will
227 # happen at the LU level
229 ht.Comment("Disk parameters")(ht.TDictOf(ht.TNonEmptyString,
230 ht.TOr(ht.TNonEmptyString, ht.TInt)))
233 ht.TListOf(ht.TAnd(ht.TIsLength(2),
234 ht.TItems([ht.TElemOf(constants.RS_ALL),
237 _TQueryResult = ht.TListOf(_TQueryRow)
239 _TOldQueryRow = ht.TListOf(ht.TAny)
241 _TOldQueryResult = ht.TListOf(_TOldQueryRow)
251 #: Attribute name for dependencies
252 DEPEND_ATTR = "depends"
254 #: Attribute name for comment
255 COMMENT_ATTR = "comment"
258 def _NameComponents(name):
259 """Split an opcode class name into its components
262 @param name: the class name, as OpXxxYyy
263 @rtype: array of strings
264 @return: the components of the name
267 assert name.startswith("Op")
268 # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
269 # consume any input, and hence we would just have all the elements
270 # in the list, one by one; but it seems that split doesn't work on
271 # non-consuming input, hence we have to process the input string a
273 name = _OPID_RE.sub(r"\1,\2", name)
274 elems = name.split(",")
279 """Convert an opcode class name to an OP_ID.
282 @param name: the class name, as OpXxxYyy
284 @return: the name in the OP_XXXX_YYYY format
287 if not name.startswith("Op"):
289 return "_".join(n.upper() for n in _NameComponents(name))
292 def NameToReasonSrc(name):
293 """Convert an opcode class name to a source string for the reason trail
296 @param name: the class name, as OpXxxYyy
298 @return: the name in the OP_XXXX_YYYY format
301 if not name.startswith("Op"):
303 return "%s:%s" % (constants.OPCODE_REASON_SRC_OPCODE,
304 "_".join(n.lower() for n in _NameComponents(name)))
307 def _GenerateObjectTypeCheck(obj, fields_types):
308 """Helper to generate type checks for objects.
310 @param obj: The object to generate type checks
311 @param fields_types: The fields and their types as a dict
312 @return: A ht type check function
315 assert set(obj.GetAllSlots()) == set(fields_types.keys()), \
316 "%s != %s" % (set(obj.GetAllSlots()), set(fields_types.keys()))
317 return ht.TStrictDict(True, True, fields_types)
321 _GenerateObjectTypeCheck(objects.QueryFieldDefinition, {
322 "name": ht.TNonEmptyString,
323 "title": ht.TNonEmptyString,
324 "kind": ht.TElemOf(constants.QFT_ALL),
325 "doc": ht.TNonEmptyString,
329 def RequireFileStorage():
330 """Checks that file storage is enabled.
332 While it doesn't really fit into this module, L{utils} was deemed too large
333 of a dependency to be imported for just one or two functions.
335 @raise errors.OpPrereqError: when file storage is disabled
338 if not constants.ENABLE_FILE_STORAGE:
339 raise errors.OpPrereqError("File storage disabled at configure time",
343 def RequireSharedFileStorage():
344 """Checks that shared file storage is enabled.
346 While it doesn't really fit into this module, L{utils} was deemed too large
347 of a dependency to be imported for just one or two functions.
349 @raise errors.OpPrereqError: when shared file storage is disabled
352 if not constants.ENABLE_SHARED_FILE_STORAGE:
353 raise errors.OpPrereqError("Shared file storage disabled at"
354 " configure time", errors.ECODE_INVAL)
357 @ht.WithDesc("CheckFileStorage")
358 def _CheckFileStorage(value):
359 """Ensures file storage is enabled if used.
362 if value == constants.DT_FILE:
364 elif value == constants.DT_SHARED_FILE:
365 RequireSharedFileStorage()
369 def _BuildDiskTemplateCheck(accept_none):
370 """Builds check for disk template.
372 @type accept_none: bool
373 @param accept_none: whether to accept None as a correct value
377 template_check = ht.TElemOf(constants.DISK_TEMPLATES)
380 template_check = ht.TMaybe(template_check)
382 return ht.TAnd(template_check, _CheckFileStorage)
385 def _CheckStorageType(storage_type):
386 """Ensure a given storage type is valid.
389 if storage_type not in constants.VALID_STORAGE_TYPES:
390 raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
392 if storage_type == constants.ST_FILE:
393 # TODO: What about shared file storage?
398 #: Storage type parameter
399 _PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
403 @ht.WithDesc("IPv4 network")
404 def _CheckCIDRNetNotation(value):
405 """Ensure a given CIDR notation type is valid.
409 ipaddr.IPv4Network(value)
410 except ipaddr.AddressValueError:
415 @ht.WithDesc("IPv4 address")
416 def _CheckCIDRAddrNotation(value):
417 """Ensure a given CIDR notation type is valid.
421 ipaddr.IPv4Address(value)
422 except ipaddr.AddressValueError:
427 @ht.WithDesc("IPv6 address")
428 def _CheckCIDR6AddrNotation(value):
429 """Ensure a given CIDR notation type is valid.
433 ipaddr.IPv6Address(value)
434 except ipaddr.AddressValueError:
439 @ht.WithDesc("IPv6 network")
440 def _CheckCIDR6NetNotation(value):
441 """Ensure a given CIDR notation type is valid.
445 ipaddr.IPv6Network(value)
446 except ipaddr.AddressValueError:
451 _TIpAddress4 = ht.TAnd(ht.TString, _CheckCIDRAddrNotation)
452 _TIpAddress6 = ht.TAnd(ht.TString, _CheckCIDR6AddrNotation)
453 _TIpNetwork4 = ht.TAnd(ht.TString, _CheckCIDRNetNotation)
454 _TIpNetwork6 = ht.TAnd(ht.TString, _CheckCIDR6NetNotation)
455 _TMaybeAddr4List = ht.TMaybe(ht.TListOf(_TIpAddress4))
458 class _AutoOpParamSlots(outils.AutoSlots):
459 """Meta class for opcode definitions.
462 def __new__(mcs, name, bases, attrs):
463 """Called when a class should be created.
465 @param mcs: The meta class
466 @param name: Name of created class
467 @param bases: Base classes
469 @param attrs: Class attributes
472 assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
474 slots = mcs._GetSlots(attrs)
475 assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
476 "Class '%s' uses unknown field in OP_DSC_FIELD" % name
477 assert ("OP_DSC_FORMATTER" not in attrs or
478 callable(attrs["OP_DSC_FORMATTER"])), \
479 ("Class '%s' uses non-callable in OP_DSC_FORMATTER (%s)" %
480 (name, type(attrs["OP_DSC_FORMATTER"])))
482 attrs["OP_ID"] = _NameToId(name)
484 return outils.AutoSlots.__new__(mcs, name, bases, attrs)
487 def _GetSlots(mcs, attrs):
488 """Build the slots out of OP_PARAMS.
491 # Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams
492 params = attrs.setdefault("OP_PARAMS", [])
494 # Use parameter names as slots
495 return [pname for (pname, _, _, _) in params]
498 class BaseOpCode(outils.ValidatedSlots):
499 """A simple serializable object.
501 This object serves as a parent class for OpCode without any custom
505 # pylint: disable=E1101
506 # as OP_ID is dynamically defined
507 __metaclass__ = _AutoOpParamSlots
509 def __getstate__(self):
510 """Generic serializer.
512 This method just returns the contents of the instance as a
516 @return: the instance attributes and their values
520 for name in self.GetAllSlots():
521 if hasattr(self, name):
522 state[name] = getattr(self, name)
525 def __setstate__(self, state):
526 """Generic unserializer.
528 This method just restores from the serialized state the attributes
529 of the current instance.
531 @param state: the serialized opcode data
535 if not isinstance(state, dict):
536 raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
539 for name in self.GetAllSlots():
540 if name not in state and hasattr(self, name):
544 setattr(self, name, state[name])
547 def GetAllParams(cls):
548 """Compute list of all parameters for an opcode.
552 for parent in cls.__mro__:
553 slots.extend(getattr(parent, "OP_PARAMS", []))
556 def Validate(self, set_defaults): # pylint: disable=W0221
557 """Validate opcode parameters, optionally setting default values.
559 @type set_defaults: bool
560 @param set_defaults: Whether to set default values
561 @raise errors.OpPrereqError: When a parameter value doesn't match
565 for (attr_name, default, test, _) in self.GetAllParams():
566 assert test == ht.NoType or callable(test)
568 if not hasattr(self, attr_name):
569 if default == ht.NoDefault:
570 raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
571 (self.OP_ID, attr_name),
574 if callable(default):
578 setattr(self, attr_name, dval)
580 if test == ht.NoType:
584 if set_defaults or hasattr(self, attr_name):
585 attr_val = getattr(self, attr_name)
586 if not test(attr_val):
587 logging.error("OpCode %s, parameter %s, has invalid type %s/value"
588 " '%s' expecting type %s",
589 self.OP_ID, attr_name, type(attr_val), attr_val, test)
590 raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
591 (self.OP_ID, attr_name),
595 def _BuildJobDepCheck(relative):
596 """Builds check for job dependencies (L{DEPEND_ATTR}).
599 @param relative: Whether to accept relative job IDs (negative)
604 job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
609 ht.TAnd(ht.TOr(ht.TList, ht.TTuple),
612 ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))
614 return ht.TMaybeListOf(job_dep)
617 TNoRelativeJobDependencies = _BuildJobDepCheck(False)
619 #: List of submission status and job ID as returned by C{SubmitManyJobs}
621 ht.TAnd(ht.TIsLength(2),
622 ht.TItems([ht.Comment("success")(ht.TBool),
623 ht.Comment("Job ID if successful, error message"
624 " otherwise")(ht.TOr(ht.TString,
626 TJobIdList = ht.TListOf(_TJobIdListItem)
628 #: Result containing only list of submitted jobs
629 TJobIdListOnly = ht.TStrictDict(True, True, {
630 constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
634 class OpCode(BaseOpCode):
637 This is the root of the actual OpCode hierarchy. All clases derived
638 from this class should override OP_ID.
640 @cvar OP_ID: The ID of this opcode. This should be unique amongst all
641 children of this class.
642 @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
643 string returned by Summary(); see the docstring of that
645 @cvar OP_DSC_FORMATTER: A callable that should format the OP_DSC_FIELD; if
646 not present, then the field will be simply converted
648 @cvar OP_PARAMS: List of opcode attributes, the default values they should
649 get if not already defined, and types they must match.
650 @cvar OP_RESULT: Callable to verify opcode result
651 @cvar WITH_LU: Boolean that specifies whether this should be included in
652 mcpu's dispatch table
653 @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
655 @ivar priority: Opcode priority for queue
658 # pylint: disable=E1101
659 # as OP_ID is dynamically defined
662 ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
663 ("debug_level", None, ht.TMaybe(ht.TNonNegativeInt), "Debug level"),
664 ("priority", constants.OP_PRIO_DEFAULT,
665 ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
666 (DEPEND_ATTR, None, _BuildJobDepCheck(True),
667 "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
668 " job IDs can be used; see :doc:`design document <design-chained-jobs>`"
670 (COMMENT_ATTR, None, ht.TMaybeString,
671 "Comment describing the purpose of the opcode"),
672 (constants.OPCODE_REASON, None, ht.TMaybeList,
673 "The reason trail, describing why the OpCode is executed"),
677 def __getstate__(self):
678 """Specialized getstate for opcodes.
680 This method adds to the state dictionary the OP_ID of the class,
681 so that on unload we can identify the correct class for
682 instantiating the opcode.
685 @return: the state as a dictionary
688 data = BaseOpCode.__getstate__(self)
689 data["OP_ID"] = self.OP_ID
693 def LoadOpCode(cls, data):
694 """Generic load opcode method.
696 The method identifies the correct opcode class from the dict-form
697 by looking for a OP_ID key, if this is not found, or its value is
698 not available in this module as a child of this class, we fail.
701 @param data: the serialized opcode
704 if not isinstance(data, dict):
705 raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
706 if "OP_ID" not in data:
707 raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
708 op_id = data["OP_ID"]
710 if op_id in OP_MAPPING:
711 op_class = OP_MAPPING[op_id]
713 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
716 new_data = data.copy()
717 del new_data["OP_ID"]
718 op.__setstate__(new_data)
722 """Generates a summary description of this opcode.
724 The summary is the value of the OP_ID attribute (without the "OP_"
725 prefix), plus the value of the OP_DSC_FIELD attribute, if one was
726 defined; this field should allow to easily identify the operation
727 (for an instance creation job, e.g., it would be the instance
731 assert self.OP_ID is not None and len(self.OP_ID) > 3
732 # all OP_ID start with OP_, we remove that
734 field_name = getattr(self, "OP_DSC_FIELD", None)
736 field_value = getattr(self, field_name, None)
737 field_formatter = getattr(self, "OP_DSC_FORMATTER", None)
738 if callable(field_formatter):
739 field_value = field_formatter(field_value)
740 elif isinstance(field_value, (list, tuple)):
741 field_value = ",".join(str(i) for i in field_value)
742 txt = "%s(%s)" % (txt, field_value)
745 def TinySummary(self):
746 """Generates a compact summary description of the opcode.
749 assert self.OP_ID.startswith("OP_")
751 text = self.OP_ID[3:]
753 for (prefix, supplement) in _SUMMARY_PREFIX.items():
754 if text.startswith(prefix):
755 return supplement + text[len(prefix):]
762 class OpClusterPostInit(OpCode):
763 """Post cluster initialization.
765 This opcode does not touch the cluster at all. Its purpose is to run hooks
766 after the cluster has been initialized.
772 class OpClusterDestroy(OpCode):
773 """Destroy the cluster.
775 This opcode has no other parameters. All the state is irreversibly
776 lost after the execution of this opcode.
779 OP_RESULT = ht.TNonEmptyString
782 class OpClusterQuery(OpCode):
783 """Query cluster information."""
784 OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TAny)
787 class OpClusterVerify(OpCode):
788 """Submits all jobs necessary to verify the cluster.
792 _PDebugSimulateErrors,
797 ("group_name", None, ht.TMaybeString, "Group to verify"),
799 OP_RESULT = TJobIdListOnly
802 class OpClusterVerifyConfig(OpCode):
803 """Verify the cluster config.
807 _PDebugSimulateErrors,
815 class OpClusterVerifyGroup(OpCode):
816 """Run verify on a node group from the cluster.
818 @type skip_checks: C{list}
819 @ivar skip_checks: steps to be skipped from the verify process; this
820 needs to be a subset of
821 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
822 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
825 OP_DSC_FIELD = "group_name"
828 _PDebugSimulateErrors,
837 class OpClusterVerifyDisks(OpCode):
838 """Verify the cluster disks.
841 OP_RESULT = TJobIdListOnly
844 class OpGroupVerifyDisks(OpCode):
845 """Verifies the status of all disks in a node group.
847 Result: a tuple of three elements:
848 - dict of node names with issues (values: error msg)
849 - list of instances with degraded disks (that should be activated)
850 - dict of instances with missing logical volumes (values: (node, vol)
851 pairs with details about the missing volumes)
853 In normal operation, all lists should be empty. A non-empty instance
854 list (3rd element of the result) is still ok (errors were fixed) but
855 non-empty node list means some node is down, and probably there are
856 unfixable drbd errors.
858 Note that only instances that are drbd-based are taken into
859 consideration. This might need to be revisited in the future.
862 OP_DSC_FIELD = "group_name"
867 ht.TAnd(ht.TIsLength(3),
868 ht.TItems([ht.TDictOf(ht.TString, ht.TString),
869 ht.TListOf(ht.TString),
870 ht.TDictOf(ht.TString,
871 ht.TListOf(ht.TListOf(ht.TString)))]))
874 class OpClusterRepairDiskSizes(OpCode):
875 """Verify the disk sizes of the instances and fixes configuration
878 Parameters: optional instances list, in case we want to restrict the
879 checks to only a subset of the instances.
881 Result: a list of tuples, (instance, disk, parameter, new-size) for changed
884 In normal operation, the list should be empty.
886 @type instances: list
887 @ivar instances: the list of instances to check, or empty for all instances
891 ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
893 OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(4),
894 ht.TItems([ht.TNonEmptyString,
897 ht.TNonNegativeInt])))
900 class OpClusterConfigQuery(OpCode):
901 """Query cluster configuration values."""
905 OP_RESULT = ht.TListOf(ht.TAny)
908 class OpClusterRename(OpCode):
909 """Rename the cluster.
912 @ivar name: The new name of the cluster. The name and/or the master IP
913 address will be changed to match the new name and its IP
917 OP_DSC_FIELD = "name"
919 ("name", ht.NoDefault, ht.TNonEmptyString, None),
921 OP_RESULT = ht.TNonEmptyString
924 class OpClusterSetParams(OpCode):
925 """Change the parameters of the cluster.
927 @type vg_name: C{str} or C{None}
928 @ivar vg_name: The new volume group name or None to disable LVM usage.
935 ("vg_name", None, ht.TMaybe(ht.TString), "Volume group name"),
936 ("enabled_hypervisors", None,
937 ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)),
939 "List of enabled hypervisors"),
941 ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
942 "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
943 ("beparams", None, ht.TMaybeDict,
944 "Cluster-wide backend parameter defaults"),
945 ("os_hvp", None, ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
946 "Cluster-wide per-OS hypervisor parameter defaults"),
948 ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
949 "Cluster-wide OS parameter defaults"),
951 ("candidate_pool_size", None, ht.TMaybe(ht.TPositiveInt),
952 "Master candidate pool size"),
953 ("uid_pool", None, ht.NoType,
954 "Set UID pool, must be list of lists describing UID ranges (two items,"
955 " start and end inclusive)"),
956 ("add_uids", None, ht.NoType,
957 "Extend UID pool, must be list of lists describing UID ranges (two"
958 " items, start and end inclusive) to be added"),
959 ("remove_uids", None, ht.NoType,
960 "Shrink UID pool, must be list of lists describing UID ranges (two"
961 " items, start and end inclusive) to be removed"),
962 ("maintain_node_health", None, ht.TMaybeBool,
963 "Whether to automatically maintain node health"),
964 ("prealloc_wipe_disks", None, ht.TMaybeBool,
965 "Whether to wipe disks before allocating them to instances"),
966 ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
967 ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
968 ("ipolicy", None, ht.TMaybeDict,
969 "Cluster-wide :ref:`instance policy <rapi-ipolicy>` specs"),
970 ("drbd_helper", None, ht.TMaybe(ht.TString), "DRBD helper program"),
971 ("default_iallocator", None, ht.TMaybe(ht.TString),
972 "Default iallocator for cluster"),
973 ("master_netdev", None, ht.TMaybe(ht.TString),
974 "Master network device"),
975 ("master_netmask", None, ht.TMaybe(ht.TNonNegativeInt),
976 "Netmask of the master IP"),
977 ("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString),
978 "List of reserved LVs"),
979 ("hidden_os", None, _TestClusterOsList,
980 "Modify list of hidden operating systems: each modification must have"
981 " two items, the operation and the OS name; the operation can be"
982 " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
983 ("blacklisted_os", None, _TestClusterOsList,
984 "Modify list of blacklisted operating systems: each modification must"
985 " have two items, the operation and the OS name; the operation can be"
986 " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
987 ("use_external_mip_script", None, ht.TMaybeBool,
988 "Whether to use an external master IP address setup script"),
989 ("enabled_disk_templates", None,
990 ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.DISK_TEMPLATES)),
992 "List of enabled disk templates"),
997 class OpClusterRedistConf(OpCode):
998 """Force a full push of the cluster configuration.
1001 OP_RESULT = ht.TNone
1004 class OpClusterActivateMasterIp(OpCode):
1005 """Activate the master IP on the master node.
1008 OP_RESULT = ht.TNone
1011 class OpClusterDeactivateMasterIp(OpCode):
1012 """Deactivate the master IP on the master node.
1015 OP_RESULT = ht.TNone
1018 class OpQuery(OpCode):
1019 """Query for resources/items.
1021 @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
1022 @ivar fields: List of fields to retrieve
1023 @ivar qfilter: Query filter
1026 OP_DSC_FIELD = "what"
1030 ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1031 "Requested fields"),
1032 ("qfilter", None, ht.TMaybe(ht.TList),
1036 _GenerateObjectTypeCheck(objects.QueryResponse, {
1037 "fields": ht.TListOf(_TQueryFieldDef),
1038 "data": _TQueryResult,
1042 class OpQueryFields(OpCode):
1043 """Query for available resource/item fields.
1045 @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
1046 @ivar fields: List of fields to retrieve
1049 OP_DSC_FIELD = "what"
1052 ("fields", None, ht.TMaybeListOf(ht.TNonEmptyString),
1053 "Requested fields; if not given, all are returned"),
1056 _GenerateObjectTypeCheck(objects.QueryFieldsResponse, {
1057 "fields": ht.TListOf(_TQueryFieldDef),
1061 class OpOobCommand(OpCode):
1062 """Interact with OOB."""
1064 ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1065 "List of node names to run the OOB command against"),
1066 ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
1067 "List of node UUIDs to run the OOB command against"),
1068 ("command", ht.NoDefault, ht.TElemOf(constants.OOB_COMMANDS),
1069 "OOB command to be run"),
1070 ("timeout", constants.OOB_TIMEOUT, ht.TInt,
1071 "Timeout before the OOB helper will be terminated"),
1072 ("ignore_status", False, ht.TBool,
1073 "Ignores the node offline status for power off"),
1074 ("power_delay", constants.OOB_POWER_DELAY, ht.TNonNegativeFloat,
1075 "Time in seconds to wait between powering on nodes"),
1077 # Fixme: Make it more specific with all the special cases in LUOobCommand
1078 OP_RESULT = _TQueryResult
1081 class OpRestrictedCommand(OpCode):
1082 """Runs a restricted command on node(s).
1087 ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1088 "Nodes on which the command should be run (at least one)"),
1089 ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
1090 "Node UUIDs on which the command should be run (at least one)"),
1091 ("command", ht.NoDefault, ht.TNonEmptyString,
1092 "Command name (no parameters)"),
1096 ht.Comment("success")(ht.TBool),
1097 ht.Comment("output or error message")(ht.TString),
1101 ht.TListOf(ht.TAnd(ht.TIsLength(len(_RESULT_ITEMS)),
1102 ht.TItems(_RESULT_ITEMS)))
1107 class OpNodeRemove(OpCode):
1110 @type node_name: C{str}
1111 @ivar node_name: The name of the node to remove. If the node still has
1112 instances on it, the operation will fail.
1115 OP_DSC_FIELD = "node_name"
1120 OP_RESULT = ht.TNone
1123 class OpNodeAdd(OpCode):
1124 """Add a node to the cluster.
1126 @type node_name: C{str}
1127 @ivar node_name: The name of the node to add. This can be a short name,
1128 but it will be expanded to the FQDN.
1129 @type primary_ip: IP address
1130 @ivar primary_ip: The primary IP of the node. This will be ignored when the
1131 opcode is submitted, but will be filled during the node
1132 add (so it will be visible in the job query).
1133 @type secondary_ip: IP address
1134 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
1135 if the cluster has been initialized in 'dual-network'
1136 mode, otherwise it must not be given.
1137 @type readd: C{bool}
1138 @ivar readd: Whether to re-add an existing node to the cluster. If
1139 this is not passed, then the operation will abort if the node
1140 name is already in the cluster; use this parameter to 'repair'
1141 a node that had its configuration broken, or was reinstalled
1142 without removal from the cluster.
1144 @ivar group: The node group to which this node will belong.
1145 @type vm_capable: C{bool}
1146 @ivar vm_capable: The vm_capable node attribute
1147 @type master_capable: C{bool}
1148 @ivar master_capable: The master_capable node attribute
1151 OP_DSC_FIELD = "node_name"
1156 ("primary_ip", None, ht.NoType, "Primary IP address"),
1157 ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
1158 ("readd", False, ht.TBool, "Whether node is re-added to cluster"),
1159 ("group", None, ht.TMaybeString, "Initial node group"),
1160 ("master_capable", None, ht.TMaybeBool,
1161 "Whether node can become master or master candidate"),
1162 ("vm_capable", None, ht.TMaybeBool,
1163 "Whether node can host instances"),
1164 ("ndparams", None, ht.TMaybeDict, "Node parameters"),
1166 OP_RESULT = ht.TNone
1169 class OpNodeQuery(OpCode):
1170 """Compute the list of nodes."""
1174 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1175 "Empty list to query all nodes, node names otherwise"),
1177 OP_RESULT = _TOldQueryResult
1180 class OpNodeQueryvols(OpCode):
1181 """Get list of volumes on node."""
1184 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1185 "Empty list to query all nodes, node names otherwise"),
1187 OP_RESULT = ht.TListOf(ht.TAny)
1190 class OpNodeQueryStorage(OpCode):
1191 """Get information on storage for node(s)."""
1195 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
1196 ("name", None, ht.TMaybeString, "Storage name"),
1198 OP_RESULT = _TOldQueryResult
1201 class OpNodeModifyStorage(OpCode):
1202 """Modifies the properies of a storage unit"""
1203 OP_DSC_FIELD = "node_name"
1209 ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
1211 OP_RESULT = ht.TNone
1214 class OpRepairNodeStorage(OpCode):
1215 """Repairs the volume group on a node."""
1216 OP_DSC_FIELD = "node_name"
1222 _PIgnoreConsistency,
1224 OP_RESULT = ht.TNone
1227 class OpNodeSetParams(OpCode):
1228 """Change the parameters of a node."""
1229 OP_DSC_FIELD = "node_name"
1236 ("master_candidate", None, ht.TMaybeBool,
1237 "Whether the node should become a master candidate"),
1238 ("offline", None, ht.TMaybeBool,
1239 "Whether the node should be marked as offline"),
1240 ("drained", None, ht.TMaybeBool,
1241 "Whether the node should be marked as drained"),
1242 ("auto_promote", False, ht.TBool,
1243 "Whether node(s) should be promoted to master candidate if necessary"),
1244 ("master_capable", None, ht.TMaybeBool,
1245 "Denote whether node can become master or master candidate"),
1246 ("vm_capable", None, ht.TMaybeBool,
1247 "Denote whether node can host instances"),
1248 ("secondary_ip", None, ht.TMaybeString,
1249 "Change node's secondary IP address"),
1250 ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
1251 ("powered", None, ht.TMaybeBool,
1252 "Whether the node should be marked as powered"),
1254 OP_RESULT = _TSetParamsResult
1257 class OpNodePowercycle(OpCode):
1258 """Tries to powercycle a node."""
1259 OP_DSC_FIELD = "node_name"
1265 OP_RESULT = ht.TMaybeString
1268 class OpNodeMigrate(OpCode):
1269 """Migrate all instances from a node."""
1270 OP_DSC_FIELD = "node_name"
1276 _PMigrationTargetNode,
1277 _PMigrationTargetNodeUuid,
1280 _PIAllocFromDesc("Iallocator for deciding the target node"
1281 " for shared-storage instances"),
1283 OP_RESULT = TJobIdListOnly
1286 class OpNodeEvacuate(OpCode):
1287 """Evacuate instances off a number of nodes."""
1288 OP_DSC_FIELD = "node_name"
1293 ("remote_node", None, ht.TMaybeString, "New secondary node"),
1294 ("remote_node_uuid", None, ht.TMaybeString, "New secondary node UUID"),
1295 _PIAllocFromDesc("Iallocator for computing solution"),
1296 ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
1297 "Node evacuation mode"),
1299 OP_RESULT = TJobIdListOnly
1304 class OpInstanceCreate(OpCode):
1305 """Create an instance.
1307 @ivar instance_name: Instance name
1308 @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
1309 @ivar source_handshake: Signed handshake from source (remote import only)
1310 @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
1311 @ivar source_instance_name: Previous name of instance (remote import only)
1312 @ivar source_shutdown_timeout: Shutdown timeout used for source instance
1313 (remote import only)
1316 OP_DSC_FIELD = "instance_name"
1323 _POpportunisticLocking,
1324 ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
1325 ("disks", ht.NoDefault, ht.TListOf(_TDiskParams),
1326 "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
1327 " each disk definition must contain a ``%s`` value and"
1328 " can contain an optional ``%s`` value denoting the disk access mode"
1330 (constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
1331 constants.IDISK_MODE,
1332 " or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
1333 ("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
1335 ("file_driver", None, ht.TMaybe(ht.TElemOf(constants.FILE_DRIVER)),
1336 "Driver for file-backed disks"),
1337 ("file_storage_dir", None, ht.TMaybeString,
1338 "Directory for storing file-backed disks"),
1339 ("hvparams", ht.EmptyDict, ht.TDict,
1340 "Hypervisor parameters for instance, hypervisor-dependent"),
1341 ("hypervisor", None, ht.TMaybeString, "Hypervisor"),
1342 _PIAllocFromDesc("Iallocator for deciding which node(s) to use"),
1343 ("identify_defaults", False, ht.TBool,
1344 "Reset instance parameters to default if equal"),
1345 ("ip_check", True, ht.TBool, _PIpCheckDoc),
1346 ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
1347 ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
1348 "Instance creation mode"),
1349 ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
1350 "List of NIC (network interface) definitions, for example"
1351 " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
1352 " contain the optional values %s" %
1354 ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
1355 ("no_install", None, ht.TMaybeBool,
1356 "Do not install the OS (will disable automatic start)"),
1357 ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
1358 ("os_type", None, ht.TMaybeString, "Operating system"),
1359 ("pnode", None, ht.TMaybeString, "Primary node"),
1360 ("pnode_uuid", None, ht.TMaybeString, "Primary node UUID"),
1361 ("snode", None, ht.TMaybeString, "Secondary node"),
1362 ("snode_uuid", None, ht.TMaybeString, "Secondary node UUID"),
1363 ("source_handshake", None, ht.TMaybe(ht.TList),
1364 "Signed handshake from source (remote import only)"),
1365 ("source_instance_name", None, ht.TMaybeString,
1366 "Source instance name (remote import only)"),
1367 ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1369 "How long source instance was given to shut down (remote import only)"),
1370 ("source_x509_ca", None, ht.TMaybeString,
1371 "Source X509 CA in PEM format (remote import only)"),
1372 ("src_node", None, ht.TMaybeString, "Source node for import"),
1373 ("src_node_uuid", None, ht.TMaybeString, "Source node UUID for import"),
1374 ("src_path", None, ht.TMaybeString, "Source directory for import"),
1375 ("start", True, ht.TBool, "Whether to start instance after creation"),
1376 ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1378 OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
1381 class OpInstanceMultiAlloc(OpCode):
1382 """Allocates multiple instances.
1386 _POpportunisticLocking,
1387 _PIAllocFromDesc("Iallocator used to allocate all the instances"),
1388 ("instances", ht.EmptyList, ht.TListOf(ht.TInstanceOf(OpInstanceCreate)),
1389 "List of instance create opcodes describing the instances to allocate"),
1391 _JOB_LIST = ht.Comment("List of submitted jobs")(TJobIdList)
1392 ALLOCATABLE_KEY = "allocatable"
1393 FAILED_KEY = "allocatable"
1394 OP_RESULT = ht.TStrictDict(True, True, {
1395 constants.JOB_IDS_KEY: _JOB_LIST,
1396 ALLOCATABLE_KEY: ht.TListOf(ht.TNonEmptyString),
1397 FAILED_KEY: ht.TListOf(ht.TNonEmptyString),
1400 def __getstate__(self):
1401 """Generic serializer.
1404 state = OpCode.__getstate__(self)
1405 if hasattr(self, "instances"):
1406 # pylint: disable=E1101
1407 state["instances"] = [inst.__getstate__() for inst in self.instances]
1410 def __setstate__(self, state):
1411 """Generic unserializer.
1413 This method just restores from the serialized state the attributes
1414 of the current instance.
1416 @param state: the serialized opcode data
1417 @type state: C{dict}
1420 if not isinstance(state, dict):
1421 raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
1424 if "instances" in state:
1425 state["instances"] = map(OpCode.LoadOpCode, state["instances"])
1427 return OpCode.__setstate__(self, state)
1429 def Validate(self, set_defaults):
1430 """Validates this opcode.
1432 We do this recursively.
1435 OpCode.Validate(self, set_defaults)
1437 for inst in self.instances: # pylint: disable=E1101
1438 inst.Validate(set_defaults)
1441 class OpInstanceReinstall(OpCode):
1442 """Reinstall an instance's OS."""
1443 OP_DSC_FIELD = "instance_name"
1448 ("os_type", None, ht.TMaybeString, "Instance operating system"),
1449 ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1451 OP_RESULT = ht.TNone
1454 class OpInstanceRemove(OpCode):
1455 """Remove an instance."""
1456 OP_DSC_FIELD = "instance_name"
1461 ("ignore_failures", False, ht.TBool,
1462 "Whether to ignore failures during removal"),
1464 OP_RESULT = ht.TNone
1467 class OpInstanceRename(OpCode):
1468 """Rename an instance."""
1473 ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
1474 ("ip_check", False, ht.TBool, _PIpCheckDoc),
1476 OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
1479 class OpInstanceStartup(OpCode):
1480 """Startup an instance."""
1481 OP_DSC_FIELD = "instance_name"
1486 _PIgnoreOfflineNodes,
1487 ("hvparams", ht.EmptyDict, ht.TDict,
1488 "Temporary hypervisor parameters, hypervisor-dependent"),
1489 ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1493 OP_RESULT = ht.TNone
1496 class OpInstanceShutdown(OpCode):
1497 """Shutdown an instance."""
1498 OP_DSC_FIELD = "instance_name"
1503 _PIgnoreOfflineNodes,
1504 ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativeInt,
1505 "How long to wait for instance to shut down"),
1508 OP_RESULT = ht.TNone
1511 class OpInstanceReboot(OpCode):
1512 """Reboot an instance."""
1513 OP_DSC_FIELD = "instance_name"
1518 ("ignore_secondaries", False, ht.TBool,
1519 "Whether to start the instance even if secondary disks are failing"),
1520 ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
1521 "How to reboot instance"),
1523 OP_RESULT = ht.TNone
1526 class OpInstanceReplaceDisks(OpCode):
1527 """Replace the disks of an instance."""
1528 OP_DSC_FIELD = "instance_name"
1534 ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
1535 "Replacement mode"),
1536 ("disks", ht.EmptyList, ht.TListOf(ht.TNonNegativeInt),
1538 ("remote_node", None, ht.TMaybeString, "New secondary node"),
1539 ("remote_node_uuid", None, ht.TMaybeString, "New secondary node UUID"),
1540 _PIAllocFromDesc("Iallocator for deciding new secondary node"),
1542 OP_RESULT = ht.TNone
1545 class OpInstanceFailover(OpCode):
1546 """Failover an instance."""
1547 OP_DSC_FIELD = "instance_name"
1552 _PIgnoreConsistency,
1553 _PMigrationTargetNode,
1554 _PMigrationTargetNodeUuid,
1556 _PIAllocFromDesc("Iallocator for deciding the target node for"
1557 " shared-storage instances"),
1559 OP_RESULT = ht.TNone
1562 class OpInstanceMigrate(OpCode):
1563 """Migrate an instance.
1565 This migrates (without shutting down an instance) to its secondary
1568 @ivar instance_name: the name of the instance
1569 @ivar mode: the migration mode (live, non-live or None for auto)
1572 OP_DSC_FIELD = "instance_name"
1578 _PMigrationTargetNode,
1579 _PMigrationTargetNodeUuid,
1582 ("cleanup", False, ht.TBool,
1583 "Whether a previously failed migration should be cleaned up"),
1584 _PIAllocFromDesc("Iallocator for deciding the target node for"
1585 " shared-storage instances"),
1586 ("allow_failover", False, ht.TBool,
1587 "Whether we can fallback to failover if migration is not possible"),
1589 OP_RESULT = ht.TNone
1592 class OpInstanceMove(OpCode):
1593 """Move an instance.
1595 This move (with shutting down an instance and data copying) to an
1598 @ivar instance_name: the name of the instance
1599 @ivar target_node: the destination node
1602 OP_DSC_FIELD = "instance_name"
1608 ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
1609 ("target_node_uuid", None, ht.TMaybeString, "Target node UUID"),
1610 _PIgnoreConsistency,
1612 OP_RESULT = ht.TNone
1615 class OpInstanceConsole(OpCode):
1616 """Connect to an instance's console."""
1617 OP_DSC_FIELD = "instance_name"
1622 OP_RESULT = ht.TDict
1625 class OpInstanceActivateDisks(OpCode):
1626 """Activate an instance's disks."""
1627 OP_DSC_FIELD = "instance_name"
1631 ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
1634 OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3),
1635 ht.TItems([ht.TNonEmptyString,
1637 ht.TNonEmptyString])))
1640 class OpInstanceDeactivateDisks(OpCode):
1641 """Deactivate an instance's disks."""
1642 OP_DSC_FIELD = "instance_name"
1648 OP_RESULT = ht.TNone
1651 class OpInstanceRecreateDisks(OpCode):
1652 """Recreate an instance's disks."""
1654 ht.TAnd(ht.TIsLength(2),
1655 ht.TItems([ht.Comment("Disk index")(ht.TNonNegativeInt),
1656 ht.Comment("Parameters")(_TDiskParams)]))
1658 OP_DSC_FIELD = "instance_name"
1662 ("disks", ht.EmptyList,
1663 ht.TOr(ht.TListOf(ht.TNonNegativeInt), ht.TListOf(_TDiskChanges)),
1664 "List of disk indexes (deprecated) or a list of tuples containing a disk"
1665 " index and a possibly empty dictionary with disk parameter changes"),
1666 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1667 "New instance nodes, if relocation is desired"),
1668 ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
1669 "New instance node UUIDs, if relocation is desired"),
1670 _PIAllocFromDesc("Iallocator for deciding new nodes"),
1672 OP_RESULT = ht.TNone
1675 class OpInstanceQuery(OpCode):
1676 """Compute the list of instances."""
1680 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1681 "Empty list to query all instances, instance names otherwise"),
1683 OP_RESULT = _TOldQueryResult
1686 class OpInstanceQueryData(OpCode):
1687 """Compute the run-time status of instances."""
1690 ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1692 ("static", False, ht.TBool,
1693 "Whether to only return configuration data without querying"
1696 OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TDict)
1699 def _TestInstSetParamsModList(fn):
1700 """Generates a check for modification lists.
1704 # TODO: Remove in version 2.8 including support in LUInstanceSetParams
1706 ht.TAnd(ht.TIsLength(2), ht.TItems([
1707 ht.TOr(ht.TElemOf(constants.DDMS_VALUES), ht.TNonNegativeInt),
1711 # New format, supporting adding/removing disks/NICs at arbitrary indices
1713 ht.TAnd(ht.TIsLength(3), ht.TItems([
1714 ht.TElemOf(constants.DDMS_VALUES_WITH_MODIFY),
1715 ht.Comment("Device index, can be negative, e.g. -1 for last disk")
1716 (ht.TOr(ht.TInt, ht.TString)),
1720 return ht.TOr(ht.Comment("Recommended")(ht.TListOf(mod_item_fn)),
1721 ht.Comment("Deprecated")(ht.TListOf(old_mod_item_fn)))
1724 class OpInstanceSetParams(OpCode):
1725 """Change the parameters of an instance.
1728 TestNicModifications = _TestInstSetParamsModList(_TestNicDef)
1729 TestDiskModifications = _TestInstSetParamsModList(_TDiskParams)
1731 OP_DSC_FIELD = "instance_name"
1738 ("nics", ht.EmptyList, TestNicModifications,
1739 "List of NIC changes: each item is of the form"
1740 " ``(op, identifier, settings)``, ``op`` is one of ``%s``, ``%s`` or"
1741 " ``%s``, ``identifier`` can be a zero-based index number (or -1 to refer"
1742 " to the last position), the NIC's UUID of the NIC's name; a"
1743 " deprecated version of this parameter used the form ``(op, settings)``,"
1744 " where ``op`` can be ``%s`` to add a new NIC with the specified"
1745 " settings, ``%s`` to remove the last NIC or a number to modify the"
1746 " settings of the NIC with that index" %
1747 (constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE,
1748 constants.DDM_ADD, constants.DDM_REMOVE)),
1749 ("disks", ht.EmptyList, TestDiskModifications,
1750 "List of disk changes; see ``nics``"),
1751 ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
1752 ("runtime_mem", None, ht.TMaybePositiveInt, "New runtime memory"),
1753 ("hvparams", ht.EmptyDict, ht.TDict,
1754 "Per-instance hypervisor parameters, hypervisor-dependent"),
1755 ("disk_template", None, ht.TMaybe(_BuildDiskTemplateCheck(False)),
1756 "Disk template for instance"),
1757 ("pnode", None, ht.TMaybeString, "New primary node"),
1758 ("pnode_uuid", None, ht.TMaybeString, "New primary node UUID"),
1759 ("remote_node", None, ht.TMaybeString,
1760 "Secondary node (used when changing disk template)"),
1761 ("remote_node_uuid", None, ht.TMaybeString,
1762 "Secondary node UUID (used when changing disk template)"),
1763 ("os_name", None, ht.TMaybeString,
1764 "Change the instance's OS without reinstalling the instance"),
1765 ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
1766 ("wait_for_sync", True, ht.TBool,
1767 "Whether to wait for the disk to synchronize, when changing template"),
1768 ("offline", None, ht.TMaybeBool, "Whether to mark instance as offline"),
1769 ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
1771 OP_RESULT = _TSetParamsResult
1774 class OpInstanceGrowDisk(OpCode):
1775 """Grow a disk of an instance."""
1776 OP_DSC_FIELD = "instance_name"
1781 ("disk", ht.NoDefault, ht.TInt, "Disk index"),
1782 ("amount", ht.NoDefault, ht.TNonNegativeInt,
1783 "Amount of disk space to add (megabytes)"),
1784 ("absolute", False, ht.TBool,
1785 "Whether the amount parameter is an absolute target or a relative one"),
1787 OP_RESULT = ht.TNone
1790 class OpInstanceChangeGroup(OpCode):
1791 """Moves an instance to another node group."""
1792 OP_DSC_FIELD = "instance_name"
1797 _PIAllocFromDesc("Iallocator for computing solution"),
1800 OP_RESULT = TJobIdListOnly
1803 # Node group opcodes
1805 class OpGroupAdd(OpCode):
1806 """Add a node group to the cluster."""
1807 OP_DSC_FIELD = "group_name"
1810 _PNodeGroupAllocPolicy,
1815 ("ipolicy", None, ht.TMaybeDict,
1816 "Group-wide :ref:`instance policy <rapi-ipolicy>` specs"),
1818 OP_RESULT = ht.TNone
1821 class OpGroupAssignNodes(OpCode):
1822 """Assign nodes to a node group."""
1823 OP_DSC_FIELD = "group_name"
1827 ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1828 "List of nodes to assign"),
1829 ("node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString),
1830 "List of node UUIDs to assign"),
1832 OP_RESULT = ht.TNone
1835 class OpGroupQuery(OpCode):
1836 """Compute the list of node groups."""
1839 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1840 "Empty list to query all groups, group names otherwise"),
1842 OP_RESULT = _TOldQueryResult
1845 class OpGroupSetParams(OpCode):
1846 """Change the parameters of a node group."""
1847 OP_DSC_FIELD = "group_name"
1850 _PNodeGroupAllocPolicy,
1855 ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
1857 OP_RESULT = _TSetParamsResult
1860 class OpGroupRemove(OpCode):
1861 """Remove a node group from the cluster."""
1862 OP_DSC_FIELD = "group_name"
1866 OP_RESULT = ht.TNone
1869 class OpGroupRename(OpCode):
1870 """Rename a node group in the cluster."""
1873 ("new_name", ht.NoDefault, ht.TNonEmptyString, "New group name"),
1875 OP_RESULT = ht.Comment("New group name")(ht.TNonEmptyString)
1878 class OpGroupEvacuate(OpCode):
1879 """Evacuate a node group in the cluster."""
1880 OP_DSC_FIELD = "group_name"
1884 _PIAllocFromDesc("Iallocator for computing solution"),
1887 OP_RESULT = TJobIdListOnly
1891 class OpOsDiagnose(OpCode):
1892 """Compute the list of guest operating systems."""
1895 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1896 "Which operating systems to diagnose"),
1898 OP_RESULT = _TOldQueryResult
1901 # ExtStorage opcodes
1902 class OpExtStorageDiagnose(OpCode):
1903 """Compute the list of external storage providers."""
1906 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1907 "Which ExtStorage Provider to diagnose"),
1909 OP_RESULT = _TOldQueryResult
1913 class OpBackupQuery(OpCode):
1914 """Compute the list of exported images."""
1917 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1918 "Empty list to query all nodes, node names otherwise"),
1920 OP_RESULT = ht.TDictOf(ht.TNonEmptyString,
1921 ht.TOr(ht.Comment("False on error")(ht.TBool),
1922 ht.TListOf(ht.TNonEmptyString)))
1925 class OpBackupPrepare(OpCode):
1926 """Prepares an instance export.
1928 @ivar instance_name: Instance name
1929 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
1932 OP_DSC_FIELD = "instance_name"
1936 ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES),
1939 OP_RESULT = ht.TMaybeDict
1942 class OpBackupExport(OpCode):
1943 """Export an instance.
1945 For local exports, the export destination is the node name. For
1946 remote exports, the export destination is a list of tuples, each
1947 consisting of hostname/IP address, port, magic, HMAC and HMAC
1948 salt. The HMAC is calculated using the cluster domain secret over
1949 the value "${index}:${hostname}:${port}". The destination X509 CA
1950 must be a signed certificate.
1952 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
1953 @ivar target_node: Export destination
1954 @ivar x509_key_name: X509 key to use (remote export only)
1955 @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
1959 OP_DSC_FIELD = "instance_name"
1964 # TODO: Rename target_node as it changes meaning for different export modes
1965 # (e.g. "destination")
1966 ("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList),
1967 "Destination information, depends on export mode"),
1968 ("target_node_uuid", None, ht.TMaybeString,
1969 "Target node UUID (if local export)"),
1970 ("shutdown", True, ht.TBool, "Whether to shutdown instance before export"),
1971 ("remove_instance", False, ht.TBool,
1972 "Whether to remove instance after export"),
1973 ("ignore_remove_failures", False, ht.TBool,
1974 "Whether to ignore failures while removing instances"),
1975 ("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES),
1977 ("x509_key_name", None, ht.TMaybe(ht.TList),
1978 "Name of X509 key (remote export only)"),
1979 ("destination_x509_ca", None, ht.TMaybeString,
1980 "Destination X509 CA (remote export only)"),
1983 ht.TAnd(ht.TIsLength(2), ht.TItems([
1984 ht.Comment("Finalizing status")(ht.TBool),
1985 ht.Comment("Status for every exported disk")(ht.TListOf(ht.TBool)),
1989 class OpBackupRemove(OpCode):
1990 """Remove an instance's export."""
1991 OP_DSC_FIELD = "instance_name"
1996 OP_RESULT = ht.TNone
2000 class OpTagsGet(OpCode):
2001 """Returns the tags of the given object."""
2002 OP_DSC_FIELD = "name"
2005 # Not using _PUseLocking as the default is different for historical reasons
2006 ("use_locking", True, ht.TBool, "Whether to use synchronization"),
2007 # Name is only meaningful for nodes and instances
2008 ("name", ht.NoDefault, ht.TMaybeString,
2009 "Name of object to retrieve tags from"),
2011 OP_RESULT = ht.TListOf(ht.TNonEmptyString)
2014 class OpTagsSearch(OpCode):
2015 """Searches the tags in the cluster for a given pattern."""
2016 OP_DSC_FIELD = "pattern"
2018 ("pattern", ht.NoDefault, ht.TNonEmptyString,
2019 "Search pattern (regular expression)"),
2021 OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([
2027 class OpTagsSet(OpCode):
2028 """Add a list of tags on a given object."""
2032 # Name is only meaningful for groups, nodes and instances
2033 ("name", ht.NoDefault, ht.TMaybeString,
2034 "Name of object where tag(s) should be added"),
2036 OP_RESULT = ht.TNone
2039 class OpTagsDel(OpCode):
2040 """Remove a list of tags from a given object."""
2044 # Name is only meaningful for groups, nodes and instances
2045 ("name", ht.NoDefault, ht.TMaybeString,
2046 "Name of object where tag(s) should be deleted"),
2048 OP_RESULT = ht.TNone
2052 class OpTestDelay(OpCode):
2053 """Sleeps for a configured amount of time.
2055 This is used just for debugging and testing.
2058 - duration: the time to sleep, in seconds
2059 - on_master: if true, sleep on the master
2060 - on_nodes: list of nodes in which to sleep
2062 If the on_master parameter is true, it will execute a sleep on the
2063 master (before any node sleep).
2065 If the on_nodes list is not empty, it will sleep on those nodes
2066 (after the sleep on the master, if that is enabled).
2068 As an additional feature, the case of duration < 0 will be reported
2069 as an execution error, so this opcode can be used as a failure
2070 generator. The case of duration == 0 will not be treated specially.
2073 OP_DSC_FIELD = "duration"
2075 ("duration", ht.NoDefault, ht.TNumber, None),
2076 ("on_master", True, ht.TBool, None),
2077 ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
2078 ("on_node_uuids", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
2079 ("repeat", 0, ht.TNonNegativeInt, None),
2082 def OP_DSC_FORMATTER(self, value): # pylint: disable=C0103,R0201
2083 """Custom formatter for duration.
2093 class OpTestAllocator(OpCode):
2094 """Allocator framework testing.
2096 This opcode has two modes:
2097 - gather and return allocator input for a given mode (allocate new
2098 or replace secondary) and a given instance definition (direction
2100 - run a selected allocator for a given operation (as above) and
2101 return the allocator output (direction 'out')
2104 OP_DSC_FIELD = "iallocator"
2106 ("direction", ht.NoDefault,
2107 ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None),
2108 ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES), None),
2109 ("name", ht.NoDefault, ht.TNonEmptyString, None),
2110 ("nics", ht.NoDefault,
2111 ht.TMaybeListOf(ht.TDictOf(ht.TElemOf([constants.INIC_MAC,
2116 ("disks", ht.NoDefault, ht.TMaybe(ht.TList), None),
2117 ("hypervisor", None, ht.TMaybeString, None),
2118 _PIAllocFromDesc(None),
2119 ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
2120 ("memory", None, ht.TMaybe(ht.TNonNegativeInt), None),
2121 ("vcpus", None, ht.TMaybe(ht.TNonNegativeInt), None),
2122 ("os", None, ht.TMaybeString, None),
2123 ("disk_template", None, ht.TMaybeString, None),
2124 ("instances", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
2126 ht.TMaybe(ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None),
2127 ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
2128 ("spindle_use", 1, ht.TNonNegativeInt, None),
2129 ("count", 1, ht.TNonNegativeInt, None),
2133 class OpTestJqueue(OpCode):
2134 """Utility opcode to test some aspects of the job queue.
2138 ("notify_waitlock", False, ht.TBool, None),
2139 ("notify_exec", False, ht.TBool, None),
2140 ("log_messages", ht.EmptyList, ht.TListOf(ht.TString), None),
2141 ("fail", False, ht.TBool, None),
2145 class OpTestDummy(OpCode):
2146 """Utility opcode used by unittests.
2150 ("result", ht.NoDefault, ht.NoType, None),
2151 ("messages", ht.NoDefault, ht.NoType, None),
2152 ("fail", ht.NoDefault, ht.NoType, None),
2153 ("submit_jobs", None, ht.NoType, None),
2159 # Add a new network in the cluster
2160 class OpNetworkAdd(OpCode):
2161 """Add an IP network to the cluster."""
2162 OP_DSC_FIELD = "network_name"
2165 ("network", ht.NoDefault, _TIpNetwork4, "IPv4 subnet"),
2166 ("gateway", None, ht.TMaybe(_TIpAddress4), "IPv4 gateway"),
2167 ("network6", None, ht.TMaybe(_TIpNetwork6), "IPv6 subnet"),
2168 ("gateway6", None, ht.TMaybe(_TIpAddress6), "IPv6 gateway"),
2169 ("mac_prefix", None, ht.TMaybeString,
2170 "MAC address prefix that overrides cluster one"),
2171 ("add_reserved_ips", None, _TMaybeAddr4List,
2172 "Which IP addresses to reserve"),
2173 ("conflicts_check", True, ht.TBool,
2174 "Whether to check for conflicting IP addresses"),
2175 ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Network tags"),
2177 OP_RESULT = ht.TNone
2180 class OpNetworkRemove(OpCode):
2181 """Remove an existing network from the cluster.
2182 Must not be connected to any nodegroup.
2185 OP_DSC_FIELD = "network_name"
2190 OP_RESULT = ht.TNone
2193 class OpNetworkSetParams(OpCode):
2194 """Modify Network's parameters except for IPv4 subnet"""
2195 OP_DSC_FIELD = "network_name"
2198 ("gateway", None, ht.TMaybeValueNone(_TIpAddress4), "IPv4 gateway"),
2199 ("network6", None, ht.TMaybeValueNone(_TIpNetwork6), "IPv6 subnet"),
2200 ("gateway6", None, ht.TMaybeValueNone(_TIpAddress6), "IPv6 gateway"),
2201 ("mac_prefix", None, ht.TMaybeValueNone(ht.TString),
2202 "MAC address prefix that overrides cluster one"),
2203 ("add_reserved_ips", None, _TMaybeAddr4List,
2204 "Which external IP addresses to reserve"),
2205 ("remove_reserved_ips", None, _TMaybeAddr4List,
2206 "Which external IP addresses to release"),
2208 OP_RESULT = ht.TNone
2211 class OpNetworkConnect(OpCode):
2212 """Connect a Network to a specific Nodegroup with the defined netparams
2213 (mode, link). Nics in this Network will inherit those params.
2214 Produce errors if a NIC (that its not already assigned to a network)
2215 has an IP that is contained in the Network this will produce error unless
2216 --no-conflicts-check is passed.
2219 OP_DSC_FIELD = "network_name"
2223 ("network_mode", ht.NoDefault, ht.TElemOf(constants.NIC_VALID_MODES),
2224 "Connectivity mode"),
2225 ("network_link", ht.NoDefault, ht.TString, "Connectivity link"),
2226 ("conflicts_check", True, ht.TBool, "Whether to check for conflicting IPs"),
2228 OP_RESULT = ht.TNone
2231 class OpNetworkDisconnect(OpCode):
2232 """Disconnect a Network from a Nodegroup. Produce errors if NICs are
2233 present in the Network unless --no-conficts-check option is passed.
2236 OP_DSC_FIELD = "network_name"
2241 OP_RESULT = ht.TNone
2244 class OpNetworkQuery(OpCode):
2245 """Compute the list of networks."""
2249 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
2250 "Empty list to query all groups, group names otherwise"),
2252 OP_RESULT = _TOldQueryResult
2256 """Returns list of all defined opcodes.
2258 Does not eliminate duplicates by C{OP_ID}.
2261 return [v for v in globals().values()
2262 if (isinstance(v, type) and issubclass(v, OpCode) and
2263 hasattr(v, "OP_ID") and v is not OpCode)]
2266 OP_MAPPING = dict((v.OP_ID, v) for v in _GetOpList())