4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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
39 from ganeti import compat
40 from ganeti import constants
41 from ganeti import errors
45 # Common opcode attributes
47 #: output fields for a query operation
48 _POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
49 "Selected output fields")
51 #: the shutdown timeout
53 ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
54 "How long to wait for instance to shut down")
56 #: the force parameter
57 _PForce = ("force", False, ht.TBool, "Whether to force the operation")
59 #: a required instance name (for single-instance LUs)
60 _PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
63 #: Whether to ignore offline nodes
64 _PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool,
65 "Whether to ignore offline nodes")
67 #: a required node name (for single-node LUs)
68 _PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
70 #: a required node group name (for single-group LUs)
71 _PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString, "Group name")
73 #: Migration type (live/non-live)
74 _PMigrationMode = ("mode", None,
75 ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)),
78 #: Obsolete 'live' migration mode (boolean)
79 _PMigrationLive = ("live", None, ht.TMaybeBool,
80 "Legacy setting for live migration, do not use")
83 _PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), None)
85 #: List of tag strings
86 _PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None)
88 _PForceVariant = ("force_variant", False, ht.TBool,
89 "Whether to force an unknown OS variant")
91 _PWaitForSync = ("wait_for_sync", True, ht.TBool,
92 "Whether to wait for the disk to synchronize")
94 _PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
95 "Whether to ignore disk consistency")
97 _PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")
99 _PUseLocking = ("use_locking", False, ht.TBool,
100 "Whether to use synchronization")
102 _PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")
104 _PNodeGroupAllocPolicy = \
105 ("alloc_policy", None,
106 ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
107 "Instance allocation policy")
109 _PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
110 "Default node parameters for group")
112 _PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
113 "Resource(s) to query for")
115 _PEarlyRelease = ("early_release", False, ht.TBool,
116 "Whether to release locks as soon as possible")
118 _PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
120 #: Do not remember instance state changes
121 _PNoRemember = ("no_remember", False, ht.TBool,
122 "Do not remember the state change")
124 #: Target node for instance migration/failover
125 _PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
126 "Target node for shared-storage instances")
128 _PStartupPaused = ("startup_paused", False, ht.TBool,
129 "Pause instance at startup")
131 _PVerbose = ("verbose", False, ht.TBool, "Verbose mode")
133 # Parameters for cluster verification
134 _PDebugSimulateErrors = ("debug_simulate_errors", False, ht.TBool,
135 "Whether to simulate errors (useful for debugging)")
136 _PErrorCodes = ("error_codes", False, ht.TBool, "Error codes")
137 _PSkipChecks = ("skip_checks", ht.EmptyList,
138 ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)),
139 "Which checks to skip")
140 _PIgnoreErrors = ("ignore_errors", ht.EmptyList,
141 ht.TListOf(ht.TElemOf(constants.CV_ALL_ECODES_STRINGS)),
142 "List of error codes that should be treated as warnings")
145 _PDiskParams = ("diskparams", None,
147 ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict),
149 "Disk templates' parameter defaults")
151 # Parameters for node resource model
152 _PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
153 _PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")
155 #: OP_ID conversion regular expression
156 _OPID_RE = re.compile("([a-z])([A-Z])")
158 #: Utility function for L{OpClusterSetParams}
159 _TestClusterOsList = ht.TOr(ht.TNone,
160 ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
161 ht.TMap(ht.WithDesc("GetFirstItem")(compat.fst),
162 ht.TElemOf(constants.DDMS_VALUES)))))
165 # TODO: Generate check from constants.INIC_PARAMS_TYPES
166 #: Utility function for testing NIC definitions
167 _TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
168 ht.TOr(ht.TNone, ht.TNonEmptyString))
170 _TSetParamsResultItemItems = [
171 ht.Comment("name of changed parameter")(ht.TNonEmptyString),
172 ht.Comment("new value")(ht.TAny),
175 _TSetParamsResult = \
176 ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
177 ht.TItems(_TSetParamsResultItemItems)))
186 #: Attribute name for dependencies
187 DEPEND_ATTR = "depends"
189 #: Attribute name for comment
190 COMMENT_ATTR = "comment"
194 """Convert an opcode class name to an OP_ID.
197 @param name: the class name, as OpXxxYyy
199 @return: the name in the OP_XXXX_YYYY format
202 if not name.startswith("Op"):
204 # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
205 # consume any input, and hence we would just have all the elements
206 # in the list, one by one; but it seems that split doesn't work on
207 # non-consuming input, hence we have to process the input string a
209 name = _OPID_RE.sub(r"\1,\2", name)
210 elems = name.split(",")
211 return "_".join(n.upper() for n in elems)
214 def RequireFileStorage():
215 """Checks that file storage is enabled.
217 While it doesn't really fit into this module, L{utils} was deemed too large
218 of a dependency to be imported for just one or two functions.
220 @raise errors.OpPrereqError: when file storage is disabled
223 if not constants.ENABLE_FILE_STORAGE:
224 raise errors.OpPrereqError("File storage disabled at configure time",
228 def RequireSharedFileStorage():
229 """Checks that shared file storage is enabled.
231 While it doesn't really fit into this module, L{utils} was deemed too large
232 of a dependency to be imported for just one or two functions.
234 @raise errors.OpPrereqError: when shared file storage is disabled
237 if not constants.ENABLE_SHARED_FILE_STORAGE:
238 raise errors.OpPrereqError("Shared file storage disabled at"
239 " configure time", errors.ECODE_INVAL)
242 @ht.WithDesc("CheckFileStorage")
243 def _CheckFileStorage(value):
244 """Ensures file storage is enabled if used.
247 if value == constants.DT_FILE:
249 elif value == constants.DT_SHARED_FILE:
250 RequireSharedFileStorage()
254 def _BuildDiskTemplateCheck(accept_none):
255 """Builds check for disk template.
257 @type accept_none: bool
258 @param accept_none: whether to accept None as a correct value
262 template_check = ht.TElemOf(constants.DISK_TEMPLATES)
265 template_check = ht.TOr(template_check, ht.TNone)
267 return ht.TAnd(template_check, _CheckFileStorage)
270 def _CheckStorageType(storage_type):
271 """Ensure a given storage type is valid.
274 if storage_type not in constants.VALID_STORAGE_TYPES:
275 raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
277 if storage_type == constants.ST_FILE:
282 #: Storage type parameter
283 _PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
287 class _AutoOpParamSlots(type):
288 """Meta class for opcode definitions.
291 def __new__(mcs, name, bases, attrs):
292 """Called when a class should be created.
294 @param mcs: The meta class
295 @param name: Name of created class
296 @param bases: Base classes
298 @param attrs: Class attributes
301 assert "__slots__" not in attrs, \
302 "Class '%s' defines __slots__ when it should use OP_PARAMS" % name
303 assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
305 attrs["OP_ID"] = _NameToId(name)
307 # Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams
308 params = attrs.setdefault("OP_PARAMS", [])
310 # Use parameter names as slots
311 slots = [pname for (pname, _, _, _) in params]
313 assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
314 "Class '%s' uses unknown field in OP_DSC_FIELD" % name
316 attrs["__slots__"] = slots
318 return type.__new__(mcs, name, bases, attrs)
321 class BaseOpCode(object):
322 """A simple serializable object.
324 This object serves as a parent class for OpCode without any custom
328 # pylint: disable=E1101
329 # as OP_ID is dynamically defined
330 __metaclass__ = _AutoOpParamSlots
332 def __init__(self, **kwargs):
333 """Constructor for BaseOpCode.
335 The constructor takes only keyword arguments and will set
336 attributes on this object based on the passed arguments. As such,
337 it means that you should not pass arguments which are not in the
338 __slots__ attribute for this class.
341 slots = self._all_slots()
344 raise TypeError("Object %s doesn't support the parameter '%s'" %
345 (self.__class__.__name__, key))
346 setattr(self, key, kwargs[key])
348 def __getstate__(self):
349 """Generic serializer.
351 This method just returns the contents of the instance as a
355 @return: the instance attributes and their values
359 for name in self._all_slots():
360 if hasattr(self, name):
361 state[name] = getattr(self, name)
364 def __setstate__(self, state):
365 """Generic unserializer.
367 This method just restores from the serialized state the attributes
368 of the current instance.
370 @param state: the serialized opcode data
374 if not isinstance(state, dict):
375 raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
378 for name in self._all_slots():
379 if name not in state and hasattr(self, name):
383 setattr(self, name, state[name])
387 """Compute the list of all declared slots for a class.
391 for parent in cls.__mro__:
392 slots.extend(getattr(parent, "__slots__", []))
396 def GetAllParams(cls):
397 """Compute list of all parameters for an opcode.
401 for parent in cls.__mro__:
402 slots.extend(getattr(parent, "OP_PARAMS", []))
405 def Validate(self, set_defaults):
406 """Validate opcode parameters, optionally setting default values.
408 @type set_defaults: bool
409 @param set_defaults: Whether to set default values
410 @raise errors.OpPrereqError: When a parameter value doesn't match
414 for (attr_name, default, test, _) in self.GetAllParams():
415 assert test == ht.NoType or callable(test)
417 if not hasattr(self, attr_name):
418 if default == ht.NoDefault:
419 raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
420 (self.OP_ID, attr_name),
423 if callable(default):
427 setattr(self, attr_name, dval)
429 if test == ht.NoType:
433 if set_defaults or hasattr(self, attr_name):
434 attr_val = getattr(self, attr_name)
435 if not test(attr_val):
436 logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
437 self.OP_ID, attr_name, type(attr_val), attr_val)
438 raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
439 (self.OP_ID, attr_name),
443 def _BuildJobDepCheck(relative):
444 """Builds check for job dependencies (L{DEPEND_ATTR}).
447 @param relative: Whether to accept relative job IDs (negative)
452 job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
457 ht.TAnd(ht.TIsLength(2),
459 ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))
461 return ht.TOr(ht.TNone, ht.TListOf(job_dep))
464 TNoRelativeJobDependencies = _BuildJobDepCheck(False)
466 #: List of submission status and job ID as returned by C{SubmitManyJobs}
468 ht.TAnd(ht.TIsLength(2),
469 ht.TItems([ht.Comment("success")(ht.TBool),
470 ht.Comment("Job ID if successful, error message"
471 " otherwise")(ht.TOr(ht.TString,
473 TJobIdList = ht.TListOf(_TJobIdListItem)
475 #: Result containing only list of submitted jobs
476 TJobIdListOnly = ht.TStrictDict(True, True, {
477 constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
481 class OpCode(BaseOpCode):
484 This is the root of the actual OpCode hierarchy. All clases derived
485 from this class should override OP_ID.
487 @cvar OP_ID: The ID of this opcode. This should be unique amongst all
488 children of this class.
489 @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
490 string returned by Summary(); see the docstring of that
492 @cvar OP_PARAMS: List of opcode attributes, the default values they should
493 get if not already defined, and types they must match.
494 @cvar OP_RESULT: Callable to verify opcode result
495 @cvar WITH_LU: Boolean that specifies whether this should be included in
496 mcpu's dispatch table
497 @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
499 @ivar priority: Opcode priority for queue
502 # pylint: disable=E1101
503 # as OP_ID is dynamically defined
506 ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
507 ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
508 ("priority", constants.OP_PRIO_DEFAULT,
509 ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
510 (DEPEND_ATTR, None, _BuildJobDepCheck(True),
511 "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
512 " job IDs can be used; see :doc:`design document <design-chained-jobs>`"
514 (COMMENT_ATTR, None, ht.TMaybeString,
515 "Comment describing the purpose of the opcode"),
519 def __getstate__(self):
520 """Specialized getstate for opcodes.
522 This method adds to the state dictionary the OP_ID of the class,
523 so that on unload we can identify the correct class for
524 instantiating the opcode.
527 @return: the state as a dictionary
530 data = BaseOpCode.__getstate__(self)
531 data["OP_ID"] = self.OP_ID
535 def LoadOpCode(cls, data):
536 """Generic load opcode method.
538 The method identifies the correct opcode class from the dict-form
539 by looking for a OP_ID key, if this is not found, or its value is
540 not available in this module as a child of this class, we fail.
543 @param data: the serialized opcode
546 if not isinstance(data, dict):
547 raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
548 if "OP_ID" not in data:
549 raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
550 op_id = data["OP_ID"]
552 if op_id in OP_MAPPING:
553 op_class = OP_MAPPING[op_id]
555 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
558 new_data = data.copy()
559 del new_data["OP_ID"]
560 op.__setstate__(new_data)
564 """Generates a summary description of this opcode.
566 The summary is the value of the OP_ID attribute (without the "OP_"
567 prefix), plus the value of the OP_DSC_FIELD attribute, if one was
568 defined; this field should allow to easily identify the operation
569 (for an instance creation job, e.g., it would be the instance
573 assert self.OP_ID is not None and len(self.OP_ID) > 3
574 # all OP_ID start with OP_, we remove that
576 field_name = getattr(self, "OP_DSC_FIELD", None)
578 field_value = getattr(self, field_name, None)
579 if isinstance(field_value, (list, tuple)):
580 field_value = ",".join(str(i) for i in field_value)
581 txt = "%s(%s)" % (txt, field_value)
584 def TinySummary(self):
585 """Generates a compact summary description of the opcode.
588 assert self.OP_ID.startswith("OP_")
590 text = self.OP_ID[3:]
592 for (prefix, supplement) in _SUMMARY_PREFIX.items():
593 if text.startswith(prefix):
594 return supplement + text[len(prefix):]
601 class OpClusterPostInit(OpCode):
602 """Post cluster initialization.
604 This opcode does not touch the cluster at all. Its purpose is to run hooks
605 after the cluster has been initialized.
610 class OpClusterDestroy(OpCode):
611 """Destroy the cluster.
613 This opcode has no other parameters. All the state is irreversibly
614 lost after the execution of this opcode.
619 class OpClusterQuery(OpCode):
620 """Query cluster information."""
623 class OpClusterVerify(OpCode):
624 """Submits all jobs necessary to verify the cluster.
628 _PDebugSimulateErrors,
633 ("group_name", None, ht.TMaybeString, "Group to verify")
635 OP_RESULT = TJobIdListOnly
638 class OpClusterVerifyConfig(OpCode):
639 """Verify the cluster config.
643 _PDebugSimulateErrors,
651 class OpClusterVerifyGroup(OpCode):
652 """Run verify on a node group from the cluster.
654 @type skip_checks: C{list}
655 @ivar skip_checks: steps to be skipped from the verify process; this
656 needs to be a subset of
657 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
658 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
661 OP_DSC_FIELD = "group_name"
664 _PDebugSimulateErrors,
673 class OpClusterVerifyDisks(OpCode):
674 """Verify the cluster disks.
677 OP_RESULT = TJobIdListOnly
680 class OpGroupVerifyDisks(OpCode):
681 """Verifies the status of all disks in a node group.
683 Result: a tuple of three elements:
684 - dict of node names with issues (values: error msg)
685 - list of instances with degraded disks (that should be activated)
686 - dict of instances with missing logical volumes (values: (node, vol)
687 pairs with details about the missing volumes)
689 In normal operation, all lists should be empty. A non-empty instance
690 list (3rd element of the result) is still ok (errors were fixed) but
691 non-empty node list means some node is down, and probably there are
692 unfixable drbd errors.
694 Note that only instances that are drbd-based are taken into
695 consideration. This might need to be revisited in the future.
698 OP_DSC_FIELD = "group_name"
703 ht.TAnd(ht.TIsLength(3),
704 ht.TItems([ht.TDictOf(ht.TString, ht.TString),
705 ht.TListOf(ht.TString),
706 ht.TDictOf(ht.TString,
707 ht.TListOf(ht.TListOf(ht.TString)))]))
710 class OpClusterRepairDiskSizes(OpCode):
711 """Verify the disk sizes of the instances and fixes configuration
714 Parameters: optional instances list, in case we want to restrict the
715 checks to only a subset of the instances.
717 Result: a list of tuples, (instance, disk, new-size) for changed
720 In normal operation, the list should be empty.
722 @type instances: list
723 @ivar instances: the list of instances to check, or empty for all instances
727 ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
731 class OpClusterConfigQuery(OpCode):
732 """Query cluster configuration values."""
738 class OpClusterRename(OpCode):
739 """Rename the cluster.
742 @ivar name: The new name of the cluster. The name and/or the master IP
743 address will be changed to match the new name and its IP
747 OP_DSC_FIELD = "name"
749 ("name", ht.NoDefault, ht.TNonEmptyString, None),
753 class OpClusterSetParams(OpCode):
754 """Change the parameters of the cluster.
756 @type vg_name: C{str} or C{None}
757 @ivar vg_name: The new volume group name or None to disable LVM usage.
763 ("vg_name", None, ht.TMaybeString, "Volume group name"),
764 ("enabled_hypervisors", None,
765 ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
767 "List of enabled hypervisors"),
768 ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
770 "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
771 ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
772 "Cluster-wide backend parameter defaults"),
773 ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
775 "Cluster-wide per-OS hypervisor parameter defaults"),
776 ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
778 "Cluster-wide OS parameter defaults"),
780 ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
781 "Master candidate pool size"),
782 ("uid_pool", None, ht.NoType,
783 "Set UID pool, must be list of lists describing UID ranges (two items,"
784 " start and end inclusive)"),
785 ("add_uids", None, ht.NoType,
786 "Extend UID pool, must be list of lists describing UID ranges (two"
787 " items, start and end inclusive) to be added"),
788 ("remove_uids", None, ht.NoType,
789 "Shrink UID pool, must be list of lists describing UID ranges (two"
790 " items, start and end inclusive) to be removed"),
791 ("maintain_node_health", None, ht.TMaybeBool,
792 "Whether to automatically maintain node health"),
793 ("prealloc_wipe_disks", None, ht.TMaybeBool,
794 "Whether to wipe disks before allocating them to instances"),
795 ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
796 ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
797 ("ipolicy", None, ht.TMaybeDict, "Cluster-wide instance policy specs"),
798 ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"),
799 ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone),
800 "Default iallocator for cluster"),
801 ("master_netdev", None, ht.TOr(ht.TString, ht.TNone),
802 "Master network device"),
803 ("master_netmask", None, ht.TOr(ht.TInt, ht.TNone),
804 "Netmask of the master IP"),
805 ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone),
806 "List of reserved LVs"),
807 ("hidden_os", None, _TestClusterOsList,
808 "Modify list of hidden operating systems. Each modification must have"
809 " two items, the operation and the OS name. The operation can be"
810 " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
811 ("blacklisted_os", None, _TestClusterOsList,
812 "Modify list of blacklisted operating systems. Each modification must have"
813 " two items, the operation and the OS name. The operation can be"
814 " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
815 ("use_external_mip_script", None, ht.TMaybeBool,
816 "Whether to use an external master IP address setup script"),
820 class OpClusterRedistConf(OpCode):
821 """Force a full push of the cluster configuration.
826 class OpClusterActivateMasterIp(OpCode):
827 """Activate the master IP on the master node.
832 class OpClusterDeactivateMasterIp(OpCode):
833 """Deactivate the master IP on the master node.
838 class OpQuery(OpCode):
839 """Query for resources/items.
841 @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
842 @ivar fields: List of fields to retrieve
843 @ivar qfilter: Query filter
846 OP_DSC_FIELD = "what"
850 ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
852 ("qfilter", None, ht.TOr(ht.TNone, ht.TListOf),
857 class OpQueryFields(OpCode):
858 """Query for available resource/item fields.
860 @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
861 @ivar fields: List of fields to retrieve
864 OP_DSC_FIELD = "what"
867 ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
868 "Requested fields; if not given, all are returned"),
872 class OpOobCommand(OpCode):
873 """Interact with OOB."""
875 ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
876 "List of nodes to run the OOB command against"),
877 ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
878 "OOB command to be run"),
879 ("timeout", constants.OOB_TIMEOUT, ht.TInt,
880 "Timeout before the OOB helper will be terminated"),
881 ("ignore_status", False, ht.TBool,
882 "Ignores the node offline status for power off"),
883 ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
884 "Time in seconds to wait between powering on nodes"),
890 class OpNodeRemove(OpCode):
893 @type node_name: C{str}
894 @ivar node_name: The name of the node to remove. If the node still has
895 instances on it, the operation will fail.
898 OP_DSC_FIELD = "node_name"
904 class OpNodeAdd(OpCode):
905 """Add a node to the cluster.
907 @type node_name: C{str}
908 @ivar node_name: The name of the node to add. This can be a short name,
909 but it will be expanded to the FQDN.
910 @type primary_ip: IP address
911 @ivar primary_ip: The primary IP of the node. This will be ignored when the
912 opcode is submitted, but will be filled during the node
913 add (so it will be visible in the job query).
914 @type secondary_ip: IP address
915 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
916 if the cluster has been initialized in 'dual-network'
917 mode, otherwise it must not be given.
919 @ivar readd: Whether to re-add an existing node to the cluster. If
920 this is not passed, then the operation will abort if the node
921 name is already in the cluster; use this parameter to 'repair'
922 a node that had its configuration broken, or was reinstalled
923 without removal from the cluster.
925 @ivar group: The node group to which this node will belong.
926 @type vm_capable: C{bool}
927 @ivar vm_capable: The vm_capable node attribute
928 @type master_capable: C{bool}
929 @ivar master_capable: The master_capable node attribute
932 OP_DSC_FIELD = "node_name"
937 ("primary_ip", None, ht.NoType, "Primary IP address"),
938 ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
939 ("readd", False, ht.TBool, "Whether node is re-added to cluster"),
940 ("group", None, ht.TMaybeString, "Initial node group"),
941 ("master_capable", None, ht.TMaybeBool,
942 "Whether node can become master or master candidate"),
943 ("vm_capable", None, ht.TMaybeBool,
944 "Whether node can host instances"),
945 ("ndparams", None, ht.TMaybeDict, "Node parameters"),
949 class OpNodeQuery(OpCode):
950 """Compute the list of nodes."""
954 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
955 "Empty list to query all nodes, node names otherwise"),
959 class OpNodeQueryvols(OpCode):
960 """Get list of volumes on node."""
963 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
964 "Empty list to query all nodes, node names otherwise"),
968 class OpNodeQueryStorage(OpCode):
969 """Get information on storage for node(s)."""
973 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
974 ("name", None, ht.TMaybeString, "Storage name"),
978 class OpNodeModifyStorage(OpCode):
979 """Modifies the properies of a storage unit"""
984 ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
988 class OpRepairNodeStorage(OpCode):
989 """Repairs the volume group on a node."""
990 OP_DSC_FIELD = "node_name"
999 class OpNodeSetParams(OpCode):
1000 """Change the parameters of a node."""
1001 OP_DSC_FIELD = "node_name"
1007 ("master_candidate", None, ht.TMaybeBool,
1008 "Whether the node should become a master candidate"),
1009 ("offline", None, ht.TMaybeBool,
1010 "Whether the node should be marked as offline"),
1011 ("drained", None, ht.TMaybeBool,
1012 "Whether the node should be marked as drained"),
1013 ("auto_promote", False, ht.TBool,
1014 "Whether node(s) should be promoted to master candidate if necessary"),
1015 ("master_capable", None, ht.TMaybeBool,
1016 "Denote whether node can become master or master candidate"),
1017 ("vm_capable", None, ht.TMaybeBool,
1018 "Denote whether node can host instances"),
1019 ("secondary_ip", None, ht.TMaybeString,
1020 "Change node's secondary IP address"),
1021 ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
1022 ("powered", None, ht.TMaybeBool,
1023 "Whether the node should be marked as powered"),
1025 OP_RESULT = _TSetParamsResult
1028 class OpNodePowercycle(OpCode):
1029 """Tries to powercycle a node."""
1030 OP_DSC_FIELD = "node_name"
1037 class OpNodeMigrate(OpCode):
1038 """Migrate all instances from a node."""
1039 OP_DSC_FIELD = "node_name"
1044 _PMigrationTargetNode,
1045 ("iallocator", None, ht.TMaybeString,
1046 "Iallocator for deciding the target node for shared-storage instances"),
1048 OP_RESULT = TJobIdListOnly
1051 class OpNodeEvacuate(OpCode):
1052 """Evacuate instances off a number of nodes."""
1053 OP_DSC_FIELD = "node_name"
1057 ("remote_node", None, ht.TMaybeString, "New secondary node"),
1058 ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
1059 ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
1060 "Node evacuation mode"),
1062 OP_RESULT = TJobIdListOnly
1067 class OpInstanceCreate(OpCode):
1068 """Create an instance.
1070 @ivar instance_name: Instance name
1071 @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
1072 @ivar source_handshake: Signed handshake from source (remote import only)
1073 @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
1074 @ivar source_instance_name: Previous name of instance (remote import only)
1075 @ivar source_shutdown_timeout: Shutdown timeout used for source instance
1076 (remote import only)
1079 OP_DSC_FIELD = "instance_name"
1085 ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
1086 ("disks", ht.NoDefault,
1087 # TODO: Generate check from constants.IDISK_PARAMS_TYPES
1088 ht.TListOf(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS),
1089 ht.TOr(ht.TNonEmptyString, ht.TInt))),
1090 "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
1091 " each disk definition must contain a ``%s`` value and"
1092 " can contain an optional ``%s`` value denoting the disk access mode"
1094 (constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
1095 constants.IDISK_MODE,
1096 " or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
1097 ("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
1099 ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER)),
1100 "Driver for file-backed disks"),
1101 ("file_storage_dir", None, ht.TMaybeString,
1102 "Directory for storing file-backed disks"),
1103 ("hvparams", ht.EmptyDict, ht.TDict,
1104 "Hypervisor parameters for instance, hypervisor-dependent"),
1105 ("hypervisor", None, ht.TMaybeString, "Hypervisor"),
1106 ("iallocator", None, ht.TMaybeString,
1107 "Iallocator for deciding which node(s) to use"),
1108 ("identify_defaults", False, ht.TBool,
1109 "Reset instance parameters to default if equal"),
1110 ("ip_check", True, ht.TBool, _PIpCheckDoc),
1111 ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
1112 "Instance creation mode"),
1113 ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
1114 "List of NIC (network interface) definitions, for example"
1115 " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
1116 " contain the optional values %s" %
1118 ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
1119 ("no_install", None, ht.TMaybeBool,
1120 "Do not install the OS (will disable automatic start)"),
1121 ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
1122 ("os_type", None, ht.TMaybeString, "Operating system"),
1123 ("pnode", None, ht.TMaybeString, "Primary node"),
1124 ("snode", None, ht.TMaybeString, "Secondary node"),
1125 ("source_handshake", None, ht.TOr(ht.TList, ht.TNone),
1126 "Signed handshake from source (remote import only)"),
1127 ("source_instance_name", None, ht.TMaybeString,
1128 "Source instance name (remote import only)"),
1129 ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1131 "How long source instance was given to shut down (remote import only)"),
1132 ("source_x509_ca", None, ht.TMaybeString,
1133 "Source X509 CA in PEM format (remote import only)"),
1134 ("src_node", None, ht.TMaybeString, "Source node for import"),
1135 ("src_path", None, ht.TMaybeString, "Source directory for import"),
1136 ("start", True, ht.TBool, "Whether to start instance after creation"),
1137 ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1139 OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
1142 class OpInstanceReinstall(OpCode):
1143 """Reinstall an instance's OS."""
1144 OP_DSC_FIELD = "instance_name"
1148 ("os_type", None, ht.TMaybeString, "Instance operating system"),
1149 ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1153 class OpInstanceRemove(OpCode):
1154 """Remove an instance."""
1155 OP_DSC_FIELD = "instance_name"
1159 ("ignore_failures", False, ht.TBool,
1160 "Whether to ignore failures during removal"),
1164 class OpInstanceRename(OpCode):
1165 """Rename an instance."""
1169 ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
1170 ("ip_check", False, ht.TBool, _PIpCheckDoc),
1172 OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
1175 class OpInstanceStartup(OpCode):
1176 """Startup an instance."""
1177 OP_DSC_FIELD = "instance_name"
1181 _PIgnoreOfflineNodes,
1182 ("hvparams", ht.EmptyDict, ht.TDict,
1183 "Temporary hypervisor parameters, hypervisor-dependent"),
1184 ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1190 class OpInstanceShutdown(OpCode):
1191 """Shutdown an instance."""
1192 OP_DSC_FIELD = "instance_name"
1195 _PIgnoreOfflineNodes,
1196 ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
1197 "How long to wait for instance to shut down"),
1202 class OpInstanceReboot(OpCode):
1203 """Reboot an instance."""
1204 OP_DSC_FIELD = "instance_name"
1208 ("ignore_secondaries", False, ht.TBool,
1209 "Whether to start the instance even if secondary disks are failing"),
1210 ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
1211 "How to reboot instance"),
1215 class OpInstanceReplaceDisks(OpCode):
1216 """Replace the disks of an instance."""
1217 OP_DSC_FIELD = "instance_name"
1221 ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
1222 "Replacement mode"),
1223 ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
1225 ("remote_node", None, ht.TMaybeString, "New secondary node"),
1226 ("iallocator", None, ht.TMaybeString,
1227 "Iallocator for deciding new secondary node"),
1231 class OpInstanceFailover(OpCode):
1232 """Failover an instance."""
1233 OP_DSC_FIELD = "instance_name"
1237 _PIgnoreConsistency,
1238 _PMigrationTargetNode,
1239 ("iallocator", None, ht.TMaybeString,
1240 "Iallocator for deciding the target node for shared-storage instances"),
1244 class OpInstanceMigrate(OpCode):
1245 """Migrate an instance.
1247 This migrates (without shutting down an instance) to its secondary
1250 @ivar instance_name: the name of the instance
1251 @ivar mode: the migration mode (live, non-live or None for auto)
1254 OP_DSC_FIELD = "instance_name"
1259 _PMigrationTargetNode,
1260 ("cleanup", False, ht.TBool,
1261 "Whether a previously failed migration should be cleaned up"),
1262 ("iallocator", None, ht.TMaybeString,
1263 "Iallocator for deciding the target node for shared-storage instances"),
1264 ("allow_failover", False, ht.TBool,
1265 "Whether we can fallback to failover if migration is not possible"),
1269 class OpInstanceMove(OpCode):
1270 """Move an instance.
1272 This move (with shutting down an instance and data copying) to an
1275 @ivar instance_name: the name of the instance
1276 @ivar target_node: the destination node
1279 OP_DSC_FIELD = "instance_name"
1283 ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
1284 _PIgnoreConsistency,
1288 class OpInstanceConsole(OpCode):
1289 """Connect to an instance's console."""
1290 OP_DSC_FIELD = "instance_name"
1296 class OpInstanceActivateDisks(OpCode):
1297 """Activate an instance's disks."""
1298 OP_DSC_FIELD = "instance_name"
1301 ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
1305 class OpInstanceDeactivateDisks(OpCode):
1306 """Deactivate an instance's disks."""
1307 OP_DSC_FIELD = "instance_name"
1314 class OpInstanceRecreateDisks(OpCode):
1315 """Recreate an instance's disks."""
1316 OP_DSC_FIELD = "instance_name"
1319 ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
1320 "List of disk indexes"),
1321 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1322 "New instance nodes, if relocation is desired"),
1326 class OpInstanceQuery(OpCode):
1327 """Compute the list of instances."""
1331 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1332 "Empty list to query all instances, instance names otherwise"),
1336 class OpInstanceQueryData(OpCode):
1337 """Compute the run-time status of instances."""
1340 ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1342 ("static", False, ht.TBool,
1343 "Whether to only return configuration data without querying"
1348 class OpInstanceSetParams(OpCode):
1349 """Change the parameters of an instance."""
1350 OP_DSC_FIELD = "instance_name"
1355 # TODO: Use _TestNicDef
1356 ("nics", ht.EmptyList, ht.TList,
1357 "List of NIC changes. Each item is of the form ``(op, settings)``."
1358 " ``op`` can be ``%s`` to add a new NIC with the specified settings,"
1359 " ``%s`` to remove the last NIC or a number to modify the settings"
1360 " of the NIC with that index." %
1361 (constants.DDM_ADD, constants.DDM_REMOVE)),
1362 ("disks", ht.EmptyList, ht.TList, "List of disk changes. See ``nics``."),
1363 ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
1364 ("hvparams", ht.EmptyDict, ht.TDict,
1365 "Per-instance hypervisor parameters, hypervisor-dependent"),
1366 ("disk_template", None, ht.TOr(ht.TNone, _BuildDiskTemplateCheck(False)),
1367 "Disk template for instance"),
1368 ("remote_node", None, ht.TMaybeString,
1369 "Secondary node (used when changing disk template)"),
1370 ("os_name", None, ht.TMaybeString,
1371 "Change instance's OS name. Does not reinstall the instance."),
1372 ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
1373 ("wait_for_sync", True, ht.TBool,
1374 "Whether to wait for the disk to synchronize, when changing template"),
1375 ("offline_inst", False, ht.TBool,
1376 "Whether to turn off the down instance completely"),
1377 ("online_inst", False, ht.TBool,
1378 "Whether to enable the offline instance"),
1380 OP_RESULT = _TSetParamsResult
1383 class OpInstanceGrowDisk(OpCode):
1384 """Grow a disk of an instance."""
1385 OP_DSC_FIELD = "instance_name"
1389 ("disk", ht.NoDefault, ht.TInt, "Disk index"),
1390 ("amount", ht.NoDefault, ht.TInt,
1391 "Amount of disk space to add (megabytes)"),
1395 class OpInstanceChangeGroup(OpCode):
1396 """Moves an instance to another node group."""
1397 OP_DSC_FIELD = "instance_name"
1401 ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
1402 ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
1403 "Destination group names or UUIDs (defaults to \"all but current group\""),
1405 OP_RESULT = TJobIdListOnly
1408 # Node group opcodes
1410 class OpGroupAdd(OpCode):
1411 """Add a node group to the cluster."""
1412 OP_DSC_FIELD = "group_name"
1415 _PNodeGroupAllocPolicy,
1420 ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
1424 class OpGroupAssignNodes(OpCode):
1425 """Assign nodes to a node group."""
1426 OP_DSC_FIELD = "group_name"
1430 ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1431 "List of nodes to assign"),
1435 class OpGroupQuery(OpCode):
1436 """Compute the list of node groups."""
1439 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1440 "Empty list to query all groups, group names otherwise"),
1444 class OpGroupSetParams(OpCode):
1445 """Change the parameters of a node group."""
1446 OP_DSC_FIELD = "group_name"
1449 _PNodeGroupAllocPolicy,
1454 ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
1456 OP_RESULT = _TSetParamsResult
1459 class OpGroupRemove(OpCode):
1460 """Remove a node group from the cluster."""
1461 OP_DSC_FIELD = "group_name"
1467 class OpGroupRename(OpCode):
1468 """Rename a node group in the cluster."""
1471 ("new_name", ht.NoDefault, ht.TNonEmptyString, "New group name"),
1473 OP_RESULT = ht.Comment("New group name")(ht.TNonEmptyString)
1476 class OpGroupEvacuate(OpCode):
1477 """Evacuate a node group in the cluster."""
1478 OP_DSC_FIELD = "group_name"
1482 ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
1483 ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
1484 "Destination group names or UUIDs"),
1486 OP_RESULT = TJobIdListOnly
1490 class OpOsDiagnose(OpCode):
1491 """Compute the list of guest operating systems."""
1494 ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1495 "Which operating systems to diagnose"),
1500 class OpBackupQuery(OpCode):
1501 """Compute the list of exported images."""
1504 ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1505 "Empty list to query all nodes, node names otherwise"),
1509 class OpBackupPrepare(OpCode):
1510 """Prepares an instance export.
1512 @ivar instance_name: Instance name
1513 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
1516 OP_DSC_FIELD = "instance_name"
1519 ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES),
1524 class OpBackupExport(OpCode):
1525 """Export an instance.
1527 For local exports, the export destination is the node name. For remote
1528 exports, the export destination is a list of tuples, each consisting of
1529 hostname/IP address, port, HMAC and HMAC salt. The HMAC is calculated using
1530 the cluster domain secret over the value "${index}:${hostname}:${port}". The
1531 destination X509 CA must be a signed certificate.
1533 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
1534 @ivar target_node: Export destination
1535 @ivar x509_key_name: X509 key to use (remote export only)
1536 @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
1540 OP_DSC_FIELD = "instance_name"
1544 # TODO: Rename target_node as it changes meaning for different export modes
1545 # (e.g. "destination")
1546 ("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList),
1547 "Destination information, depends on export mode"),
1548 ("shutdown", True, ht.TBool, "Whether to shutdown instance before export"),
1549 ("remove_instance", False, ht.TBool,
1550 "Whether to remove instance after export"),
1551 ("ignore_remove_failures", False, ht.TBool,
1552 "Whether to ignore failures while removing instances"),
1553 ("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES),
1555 ("x509_key_name", None, ht.TOr(ht.TList, ht.TNone),
1556 "Name of X509 key (remote export only)"),
1557 ("destination_x509_ca", None, ht.TMaybeString,
1558 "Destination X509 CA (remote export only)"),
1562 class OpBackupRemove(OpCode):
1563 """Remove an instance's export."""
1564 OP_DSC_FIELD = "instance_name"
1571 class OpTagsGet(OpCode):
1572 """Returns the tags of the given object."""
1573 OP_DSC_FIELD = "name"
1576 # Name is only meaningful for nodes and instances
1577 ("name", ht.NoDefault, ht.TMaybeString, None),
1581 class OpTagsSearch(OpCode):
1582 """Searches the tags in the cluster for a given pattern."""
1583 OP_DSC_FIELD = "pattern"
1585 ("pattern", ht.NoDefault, ht.TNonEmptyString, None),
1589 class OpTagsSet(OpCode):
1590 """Add a list of tags on a given object."""
1594 # Name is only meaningful for nodes and instances
1595 ("name", ht.NoDefault, ht.TMaybeString, None),
1599 class OpTagsDel(OpCode):
1600 """Remove a list of tags from a given object."""
1604 # Name is only meaningful for nodes and instances
1605 ("name", ht.NoDefault, ht.TMaybeString, None),
1610 class OpTestDelay(OpCode):
1611 """Sleeps for a configured amount of time.
1613 This is used just for debugging and testing.
1616 - duration: the time to sleep
1617 - on_master: if true, sleep on the master
1618 - on_nodes: list of nodes in which to sleep
1620 If the on_master parameter is true, it will execute a sleep on the
1621 master (before any node sleep).
1623 If the on_nodes list is not empty, it will sleep on those nodes
1624 (after the sleep on the master, if that is enabled).
1626 As an additional feature, the case of duration < 0 will be reported
1627 as an execution error, so this opcode can be used as a failure
1628 generator. The case of duration == 0 will not be treated specially.
1631 OP_DSC_FIELD = "duration"
1633 ("duration", ht.NoDefault, ht.TNumber, None),
1634 ("on_master", True, ht.TBool, None),
1635 ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
1636 ("repeat", 0, ht.TPositiveInt, None),
1640 class OpTestAllocator(OpCode):
1641 """Allocator framework testing.
1643 This opcode has two modes:
1644 - gather and return allocator input for a given mode (allocate new
1645 or replace secondary) and a given instance definition (direction
1647 - run a selected allocator for a given operation (as above) and
1648 return the allocator output (direction 'out')
1651 OP_DSC_FIELD = "allocator"
1653 ("direction", ht.NoDefault,
1654 ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None),
1655 ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES), None),
1656 ("name", ht.NoDefault, ht.TNonEmptyString, None),
1657 ("nics", ht.NoDefault, ht.TOr(ht.TNone, ht.TListOf(
1658 ht.TDictOf(ht.TElemOf([constants.INIC_MAC, constants.INIC_IP, "bridge"]),
1659 ht.TOr(ht.TNone, ht.TNonEmptyString)))), None),
1660 ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList), None),
1661 ("hypervisor", None, ht.TMaybeString, None),
1662 ("allocator", None, ht.TMaybeString, None),
1663 ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
1664 ("memory", None, ht.TOr(ht.TNone, ht.TPositiveInt), None),
1665 ("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt), None),
1666 ("os", None, ht.TMaybeString, None),
1667 ("disk_template", None, ht.TMaybeString, None),
1668 ("instances", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
1671 ht.TOr(ht.TNone, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None),
1672 ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
1677 class OpTestJqueue(OpCode):
1678 """Utility opcode to test some aspects of the job queue.
1682 ("notify_waitlock", False, ht.TBool, None),
1683 ("notify_exec", False, ht.TBool, None),
1684 ("log_messages", ht.EmptyList, ht.TListOf(ht.TString), None),
1685 ("fail", False, ht.TBool, None),
1689 class OpTestDummy(OpCode):
1690 """Utility opcode used by unittests.
1694 ("result", ht.NoDefault, ht.NoType, None),
1695 ("messages", ht.NoDefault, ht.NoType, None),
1696 ("fail", ht.NoDefault, ht.NoType, None),
1697 ("submit_jobs", None, ht.NoType, None),
1703 """Returns list of all defined opcodes.
1705 Does not eliminate duplicates by C{OP_ID}.
1708 return [v for v in globals().values()
1709 if (isinstance(v, type) and issubclass(v, OpCode) and
1710 hasattr(v, "OP_ID") and v is not OpCode)]
1713 OP_MAPPING = dict((v.OP_ID, v) for v in _GetOpList())