X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/1f5d9bf8747301b4f6b54e665500061c78dbd808..6f287cf3c893e170a92957c6cf640248532d79dd:/lib/opcodes.py diff --git a/lib/opcodes.py b/lib/opcodes.py index 4cdcdd9..2995bc2 100644 --- a/lib/opcodes.py +++ b/lib/opcodes.py @@ -1,7 +1,7 @@ # # -# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc. +# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -36,10 +36,10 @@ opcodes. import logging import re -from ganeti import compat from ganeti import constants from ganeti import errors from ganeti import ht +from ganeti import objects # Common opcode attributes @@ -80,10 +80,12 @@ _PMigrationLive = ("live", None, ht.TMaybeBool, "Legacy setting for live migration, do not use") #: Tag type -_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), None) +_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), + "Tag kind") #: List of tag strings -_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None) +_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), + "List of tag names") _PForceVariant = ("force_variant", False, ht.TBool, "Whether to force an unknown OS variant") @@ -91,6 +93,10 @@ _PForceVariant = ("force_variant", False, ht.TBool, _PWaitForSync = ("wait_for_sync", True, ht.TBool, "Whether to wait for the disk to synchronize") +_PWaitForSyncFalse = ("wait_for_sync", False, ht.TBool, + "Whether to wait for the disk to synchronize" + " (defaults to false)") + _PIgnoreConsistency = ("ignore_consistency", False, ht.TBool, "Whether to ignore disk consistency") @@ -152,20 +158,32 @@ _PDiskParams = ("diskparams", None, _PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states") _PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states") + +_PIgnoreIpolicy = ("ignore_ipolicy", False, ht.TBool, + "Whether to ignore ipolicy violations") + +# Allow runtime changes while migrating +_PAllowRuntimeChgs = ("allow_runtime_changes", True, ht.TBool, + "Allow runtime changes (eg. memory ballooning)") + + #: OP_ID conversion regular expression _OPID_RE = re.compile("([a-z])([A-Z])") #: Utility function for L{OpClusterSetParams} -_TestClusterOsList = ht.TOr(ht.TNone, - ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2), - ht.TMap(ht.WithDesc("GetFirstItem")(compat.fst), - ht.TElemOf(constants.DDMS_VALUES))))) +_TestClusterOsListItem = \ + ht.TAnd(ht.TIsLength(2), ht.TItems([ + ht.TElemOf(constants.DDMS_VALUES), + ht.TNonEmptyString, + ])) +_TestClusterOsList = ht.TMaybeListOf(_TestClusterOsListItem) # TODO: Generate check from constants.INIC_PARAMS_TYPES #: Utility function for testing NIC definitions -_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS), - ht.TOr(ht.TNone, ht.TNonEmptyString)) +_TestNicDef = \ + ht.Comment("NIC parameters")(ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS), + ht.TOr(ht.TNone, ht.TNonEmptyString))) _TSetParamsResultItemItems = [ ht.Comment("name of changed parameter")(ht.TNonEmptyString), @@ -176,6 +194,24 @@ _TSetParamsResult = \ ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)), ht.TItems(_TSetParamsResultItemItems))) +# TODO: Generate check from constants.IDISK_PARAMS_TYPES (however, not all users +# of this check support all parameters) +_TDiskParams = \ + ht.Comment("Disk parameters")(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS), + ht.TOr(ht.TNonEmptyString, ht.TInt))) + +_TQueryRow = \ + ht.TListOf(ht.TAnd(ht.TIsLength(2), + ht.TItems([ht.TElemOf(constants.RS_ALL), + ht.TAny]))) + +_TQueryResult = ht.TListOf(_TQueryRow) + +_TOldQueryRow = ht.TListOf(ht.TAny) + +_TOldQueryResult = ht.TListOf(_TOldQueryRow) + + _SUMMARY_PREFIX = { "CLUSTER_": "C_", "GROUP_": "G_", @@ -211,6 +247,28 @@ def _NameToId(name): return "_".join(n.upper() for n in elems) +def _GenerateObjectTypeCheck(obj, fields_types): + """Helper to generate type checks for objects. + + @param obj: The object to generate type checks + @param fields_types: The fields and their types as a dict + @return: A ht type check function + + """ + assert set(obj.GetAllSlots()) == set(fields_types.keys()), \ + "%s != %s" % (set(obj.GetAllSlots()), set(fields_types.keys())) + return ht.TStrictDict(True, True, fields_types) + + +_TQueryFieldDef = \ + _GenerateObjectTypeCheck(objects.QueryFieldDefinition, { + "name": ht.TNonEmptyString, + "title": ht.TNonEmptyString, + "kind": ht.TElemOf(constants.QFT_ALL), + "doc": ht.TNonEmptyString, + }) + + def RequireFileStorage(): """Checks that file storage is enabled. @@ -458,7 +516,7 @@ def _BuildJobDepCheck(relative): ht.TItems([job_id, ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))])) - return ht.TOr(ht.TNone, ht.TListOf(job_dep)) + return ht.TMaybeListOf(job_dep) TNoRelativeJobDependencies = _BuildJobDepCheck(False) @@ -509,7 +567,8 @@ class OpCode(BaseOpCode): ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"), (DEPEND_ATTR, None, _BuildJobDepCheck(True), "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)" - " job IDs can be used"), + " job IDs can be used; see :doc:`design document `" + " for details"), (COMMENT_ATTR, None, ht.TMaybeString, "Comment describing the purpose of the opcode"), ] @@ -604,6 +663,7 @@ class OpClusterPostInit(OpCode): after the cluster has been initialized. """ + OP_RESULT = ht.TBool class OpClusterDestroy(OpCode): @@ -613,10 +673,12 @@ class OpClusterDestroy(OpCode): lost after the execution of this opcode. """ + OP_RESULT = ht.TNonEmptyString class OpClusterQuery(OpCode): """Query cluster information.""" + OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TAny) class OpClusterVerify(OpCode): @@ -725,6 +787,10 @@ class OpClusterRepairDiskSizes(OpCode): OP_PARAMS = [ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None), ] + OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3), + ht.TItems([ht.TNonEmptyString, + ht.TPositiveInt, + ht.TPositiveInt]))) class OpClusterConfigQuery(OpCode): @@ -732,6 +798,7 @@ class OpClusterConfigQuery(OpCode): OP_PARAMS = [ _POutputFields ] + OP_RESULT = ht.TListOf(ht.TAny) class OpClusterRename(OpCode): @@ -747,6 +814,7 @@ class OpClusterRename(OpCode): OP_PARAMS = [ ("name", ht.NoDefault, ht.TNonEmptyString, None), ] + OP_RESULT = ht.TNonEmptyString class OpClusterSetParams(OpCode): @@ -793,7 +861,8 @@ class OpClusterSetParams(OpCode): "Whether to wipe disks before allocating them to instances"), ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"), ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"), - ("ipolicy", None, ht.TMaybeDict, "Cluster-wide instance policy specs"), + ("ipolicy", None, ht.TMaybeDict, + "Cluster-wide :ref:`instance policy ` specs"), ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"), ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone), "Default iallocator for cluster"), @@ -801,37 +870,41 @@ class OpClusterSetParams(OpCode): "Master network device"), ("master_netmask", None, ht.TOr(ht.TInt, ht.TNone), "Netmask of the master IP"), - ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone), + ("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString), "List of reserved LVs"), ("hidden_os", None, _TestClusterOsList, - "Modify list of hidden operating systems. Each modification must have" - " two items, the operation and the OS name. The operation can be" - " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)), + "Modify list of hidden operating systems: each modification must have" + " two items, the operation and the OS name; the operation can be" + " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)), ("blacklisted_os", None, _TestClusterOsList, - "Modify list of blacklisted operating systems. Each modification must have" - " two items, the operation and the OS name. The operation can be" - " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)), + "Modify list of blacklisted operating systems: each modification must" + " have two items, the operation and the OS name; the operation can be" + " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)), ("use_external_mip_script", None, ht.TMaybeBool, "Whether to use an external master IP address setup script"), ] + OP_RESULT = ht.TNone class OpClusterRedistConf(OpCode): """Force a full push of the cluster configuration. """ + OP_RESULT = ht.TNone class OpClusterActivateMasterIp(OpCode): """Activate the master IP on the master node. """ + OP_RESULT = ht.TNone class OpClusterDeactivateMasterIp(OpCode): """Deactivate the master IP on the master node. """ + OP_RESULT = ht.TNone class OpQuery(OpCode): @@ -848,9 +921,14 @@ class OpQuery(OpCode): _PUseLocking, ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), "Requested fields"), - ("qfilter", None, ht.TOr(ht.TNone, ht.TListOf), + ("qfilter", None, ht.TOr(ht.TNone, ht.TList), "Query filter"), ] + OP_RESULT = \ + _GenerateObjectTypeCheck(objects.QueryResponse, { + "fields": ht.TListOf(_TQueryFieldDef), + "data": _TQueryResult, + }) class OpQueryFields(OpCode): @@ -863,9 +941,13 @@ class OpQueryFields(OpCode): OP_DSC_FIELD = "what" OP_PARAMS = [ _PQueryWhat, - ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), + ("fields", None, ht.TMaybeListOf(ht.TNonEmptyString), "Requested fields; if not given, all are returned"), ] + OP_RESULT = \ + _GenerateObjectTypeCheck(objects.QueryFieldsResponse, { + "fields": ht.TListOf(_TQueryFieldDef), + }) class OpOobCommand(OpCode): @@ -882,6 +964,8 @@ class OpOobCommand(OpCode): ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat, "Time in seconds to wait between powering on nodes"), ] + # Fixme: Make it more specific with all the special cases in LUOobCommand + OP_RESULT = _TQueryResult # node opcodes @@ -898,6 +982,7 @@ class OpNodeRemove(OpCode): OP_PARAMS = [ _PNodeName, ] + OP_RESULT = ht.TNone class OpNodeAdd(OpCode): @@ -931,6 +1016,8 @@ class OpNodeAdd(OpCode): OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, + _PHvState, + _PDiskState, ("primary_ip", None, ht.NoType, "Primary IP address"), ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"), ("readd", False, ht.TBool, "Whether node is re-added to cluster"), @@ -941,6 +1028,7 @@ class OpNodeAdd(OpCode): "Whether node can host instances"), ("ndparams", None, ht.TMaybeDict, "Node parameters"), ] + OP_RESULT = ht.TNone class OpNodeQuery(OpCode): @@ -951,6 +1039,7 @@ class OpNodeQuery(OpCode): ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Empty list to query all nodes, node names otherwise"), ] + OP_RESULT = _TOldQueryResult class OpNodeQueryvols(OpCode): @@ -960,6 +1049,7 @@ class OpNodeQueryvols(OpCode): ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Empty list to query all nodes, node names otherwise"), ] + OP_RESULT = ht.TListOf(ht.TAny) class OpNodeQueryStorage(OpCode): @@ -970,16 +1060,19 @@ class OpNodeQueryStorage(OpCode): ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"), ("name", None, ht.TMaybeString, "Storage name"), ] + OP_RESULT = _TOldQueryResult class OpNodeModifyStorage(OpCode): """Modifies the properies of a storage unit""" + OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, _PStorageType, _PStorageName, ("changes", ht.NoDefault, ht.TDict, "Requested changes"), ] + OP_RESULT = ht.TNone class OpRepairNodeStorage(OpCode): @@ -991,6 +1084,7 @@ class OpRepairNodeStorage(OpCode): _PStorageName, _PIgnoreConsistency, ] + OP_RESULT = ht.TNone class OpNodeSetParams(OpCode): @@ -1029,6 +1123,7 @@ class OpNodePowercycle(OpCode): _PNodeName, _PForce, ] + OP_RESULT = ht.TMaybeString class OpNodeMigrate(OpCode): @@ -1039,6 +1134,8 @@ class OpNodeMigrate(OpCode): _PMigrationMode, _PMigrationLive, _PMigrationTargetNode, + _PAllowRuntimeChgs, + _PIgnoreIpolicy, ("iallocator", None, ht.TMaybeString, "Iallocator for deciding the target node for shared-storage instances"), ] @@ -1079,11 +1176,9 @@ class OpInstanceCreate(OpCode): _PForceVariant, _PWaitForSync, _PNameCheck, + _PIgnoreIpolicy, ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"), - ("disks", ht.NoDefault, - # TODO: Generate check from constants.IDISK_PARAMS_TYPES - ht.TListOf(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS), - ht.TOr(ht.TNonEmptyString, ht.TInt))), + ("disks", ht.NoDefault, ht.TListOf(_TDiskParams), "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;" " each disk definition must contain a ``%s`` value and" " can contain an optional ``%s`` value denoting the disk access mode" @@ -1145,6 +1240,7 @@ class OpInstanceReinstall(OpCode): ("os_type", None, ht.TMaybeString, "Instance operating system"), ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"), ] + OP_RESULT = ht.TNone class OpInstanceRemove(OpCode): @@ -1156,6 +1252,7 @@ class OpInstanceRemove(OpCode): ("ignore_failures", False, ht.TBool, "Whether to ignore failures during removal"), ] + OP_RESULT = ht.TNone class OpInstanceRename(OpCode): @@ -1182,6 +1279,7 @@ class OpInstanceStartup(OpCode): _PNoRemember, _PStartupPaused, ] + OP_RESULT = ht.TNone class OpInstanceShutdown(OpCode): @@ -1194,6 +1292,7 @@ class OpInstanceShutdown(OpCode): "How long to wait for instance to shut down"), _PNoRemember, ] + OP_RESULT = ht.TNone class OpInstanceReboot(OpCode): @@ -1207,6 +1306,7 @@ class OpInstanceReboot(OpCode): ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES), "How to reboot instance"), ] + OP_RESULT = ht.TNone class OpInstanceReplaceDisks(OpCode): @@ -1215,6 +1315,7 @@ class OpInstanceReplaceDisks(OpCode): OP_PARAMS = [ _PInstanceName, _PEarlyRelease, + _PIgnoreIpolicy, ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES), "Replacement mode"), ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt), @@ -1223,6 +1324,7 @@ class OpInstanceReplaceDisks(OpCode): ("iallocator", None, ht.TMaybeString, "Iallocator for deciding new secondary node"), ] + OP_RESULT = ht.TNone class OpInstanceFailover(OpCode): @@ -1233,9 +1335,11 @@ class OpInstanceFailover(OpCode): _PShutdownTimeout, _PIgnoreConsistency, _PMigrationTargetNode, + _PIgnoreIpolicy, ("iallocator", None, ht.TMaybeString, "Iallocator for deciding the target node for shared-storage instances"), ] + OP_RESULT = ht.TNone class OpInstanceMigrate(OpCode): @@ -1254,6 +1358,8 @@ class OpInstanceMigrate(OpCode): _PMigrationMode, _PMigrationLive, _PMigrationTargetNode, + _PAllowRuntimeChgs, + _PIgnoreIpolicy, ("cleanup", False, ht.TBool, "Whether a previously failed migration should be cleaned up"), ("iallocator", None, ht.TMaybeString, @@ -1261,6 +1367,7 @@ class OpInstanceMigrate(OpCode): ("allow_failover", False, ht.TBool, "Whether we can fallback to failover if migration is not possible"), ] + OP_RESULT = ht.TNone class OpInstanceMove(OpCode): @@ -1277,9 +1384,11 @@ class OpInstanceMove(OpCode): OP_PARAMS = [ _PInstanceName, _PShutdownTimeout, + _PIgnoreIpolicy, ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"), _PIgnoreConsistency, ] + OP_RESULT = ht.TNone class OpInstanceConsole(OpCode): @@ -1288,6 +1397,7 @@ class OpInstanceConsole(OpCode): OP_PARAMS = [ _PInstanceName ] + OP_RESULT = ht.TDict class OpInstanceActivateDisks(OpCode): @@ -1296,7 +1406,12 @@ class OpInstanceActivateDisks(OpCode): OP_PARAMS = [ _PInstanceName, ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"), + _PWaitForSyncFalse, ] + OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3), + ht.TItems([ht.TNonEmptyString, + ht.TNonEmptyString, + ht.TNonEmptyString]))) class OpInstanceDeactivateDisks(OpCode): @@ -1306,18 +1421,29 @@ class OpInstanceDeactivateDisks(OpCode): _PInstanceName, _PForce, ] + OP_RESULT = ht.TNone class OpInstanceRecreateDisks(OpCode): """Recreate an instance's disks.""" + _TDiskChanges = \ + ht.TAnd(ht.TIsLength(2), + ht.TItems([ht.Comment("Disk index")(ht.TPositiveInt), + ht.Comment("Parameters")(_TDiskParams)])) + OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, - ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt), - "List of disk indexes"), + ("disks", ht.EmptyList, + ht.TOr(ht.TListOf(ht.TPositiveInt), ht.TListOf(_TDiskChanges)), + "List of disk indexes (deprecated) or a list of tuples containing a disk" + " index and a possibly empty dictionary with disk parameter changes"), ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "New instance nodes, if relocation is desired"), + ("iallocator", None, ht.TMaybeString, + "Iallocator for deciding new nodes"), ] + OP_RESULT = ht.TNone class OpInstanceQuery(OpCode): @@ -1328,6 +1454,7 @@ class OpInstanceQuery(OpCode): ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Empty list to query all instances, instance names otherwise"), ] + OP_RESULT = _TOldQueryResult class OpInstanceQueryData(OpCode): @@ -1340,24 +1467,60 @@ class OpInstanceQueryData(OpCode): "Whether to only return configuration data without querying" " nodes"), ] + OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TDict) + + +def _TestInstSetParamsModList(fn): + """Generates a check for modification lists. + + """ + # Old format + # TODO: Remove in version 2.8 including support in LUInstanceSetParams + old_mod_item_fn = \ + ht.TAnd(ht.TIsLength(2), ht.TItems([ + ht.TOr(ht.TElemOf(constants.DDMS_VALUES), ht.TPositiveInt), + fn, + ])) + + # New format, supporting adding/removing disks/NICs at arbitrary indices + mod_item_fn = \ + ht.TAnd(ht.TIsLength(3), ht.TItems([ + ht.TElemOf(constants.DDMS_VALUES_WITH_MODIFY), + ht.Comment("Disk index, can be negative, e.g. -1 for last disk")(ht.TInt), + fn, + ])) + + return ht.TOr(ht.Comment("Recommended")(ht.TListOf(mod_item_fn)), + ht.Comment("Deprecated")(ht.TListOf(old_mod_item_fn))) class OpInstanceSetParams(OpCode): - """Change the parameters of an instance.""" + """Change the parameters of an instance. + + """ + TestNicModifications = _TestInstSetParamsModList(_TestNicDef) + TestDiskModifications = _TestInstSetParamsModList(_TDiskParams) + OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, _PForce, _PForceVariant, - # TODO: Use _TestNicDef - ("nics", ht.EmptyList, ht.TList, - "List of NIC changes. Each item is of the form ``(op, settings)``." - " ``op`` can be ``%s`` to add a new NIC with the specified settings," - " ``%s`` to remove the last NIC or a number to modify the settings" - " of the NIC with that index." % - (constants.DDM_ADD, constants.DDM_REMOVE)), - ("disks", ht.EmptyList, ht.TList, "List of disk changes. See ``nics``."), + _PIgnoreIpolicy, + ("nics", ht.EmptyList, TestNicModifications, + "List of NIC changes: each item is of the form ``(op, index, settings)``," + " ``op`` is one of ``%s``, ``%s`` or ``%s``, ``index`` can be either -1" + " to refer to the last position, or a zero-based index number; a" + " deprecated version of this parameter used the form ``(op, settings)``," + " where ``op`` can be ``%s`` to add a new NIC with the specified" + " settings, ``%s`` to remove the last NIC or a number to modify the" + " settings of the NIC with that index" % + (constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE, + constants.DDM_ADD, constants.DDM_REMOVE)), + ("disks", ht.EmptyList, TestDiskModifications, + "List of disk changes; see ``nics``"), ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"), + ("runtime_mem", None, ht.TMaybeStrictPositiveInt, "New runtime memory"), ("hvparams", ht.EmptyDict, ht.TDict, "Per-instance hypervisor parameters, hypervisor-dependent"), ("disk_template", None, ht.TOr(ht.TNone, _BuildDiskTemplateCheck(False)), @@ -1365,14 +1528,11 @@ class OpInstanceSetParams(OpCode): ("remote_node", None, ht.TMaybeString, "Secondary node (used when changing disk template)"), ("os_name", None, ht.TMaybeString, - "Change instance's OS name. Does not reinstall the instance."), + "Change the instance's OS without reinstalling the instance"), ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"), ("wait_for_sync", True, ht.TBool, "Whether to wait for the disk to synchronize, when changing template"), - ("offline_inst", False, ht.TBool, - "Whether to turn off the down instance completely"), - ("online_inst", False, ht.TBool, - "Whether to enable the offline instance"), + ("offline", None, ht.TMaybeBool, "Whether to mark instance as offline"), ] OP_RESULT = _TSetParamsResult @@ -1384,9 +1544,12 @@ class OpInstanceGrowDisk(OpCode): _PInstanceName, _PWaitForSync, ("disk", ht.NoDefault, ht.TInt, "Disk index"), - ("amount", ht.NoDefault, ht.TInt, + ("amount", ht.NoDefault, ht.TPositiveInt, "Amount of disk space to add (megabytes)"), + ("absolute", False, ht.TBool, + "Whether the amount parameter is an absolute target or a relative one"), ] + OP_RESULT = ht.TNone class OpInstanceChangeGroup(OpCode): @@ -1396,7 +1559,7 @@ class OpInstanceChangeGroup(OpCode): _PInstanceName, _PEarlyRelease, ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"), - ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), + ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), "Destination group names or UUIDs (defaults to \"all but current group\""), ] OP_RESULT = TJobIdListOnly @@ -1412,8 +1575,12 @@ class OpGroupAdd(OpCode): _PNodeGroupAllocPolicy, _PGroupNodeParams, _PDiskParams, - ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"), + _PHvState, + _PDiskState, + ("ipolicy", None, ht.TMaybeDict, + "Group-wide :ref:`instance policy ` specs"), ] + OP_RESULT = ht.TNone class OpGroupAssignNodes(OpCode): @@ -1425,6 +1592,7 @@ class OpGroupAssignNodes(OpCode): ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), "List of nodes to assign"), ] + OP_RESULT = ht.TNone class OpGroupQuery(OpCode): @@ -1434,6 +1602,7 @@ class OpGroupQuery(OpCode): ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Empty list to query all groups, group names otherwise"), ] + OP_RESULT = _TOldQueryResult class OpGroupSetParams(OpCode): @@ -1446,6 +1615,7 @@ class OpGroupSetParams(OpCode): _PDiskParams, _PHvState, _PDiskState, + ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"), ] OP_RESULT = _TSetParamsResult @@ -1456,6 +1626,7 @@ class OpGroupRemove(OpCode): OP_PARAMS = [ _PGroupName, ] + OP_RESULT = ht.TNone class OpGroupRename(OpCode): @@ -1474,7 +1645,7 @@ class OpGroupEvacuate(OpCode): _PGroupName, _PEarlyRelease, ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"), - ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), + ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), "Destination group names or UUIDs"), ] OP_RESULT = TJobIdListOnly @@ -1488,6 +1659,7 @@ class OpOsDiagnose(OpCode): ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Which operating systems to diagnose"), ] + OP_RESULT = _TOldQueryResult # Exports opcodes @@ -1498,6 +1670,9 @@ class OpBackupQuery(OpCode): ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Empty list to query all nodes, node names otherwise"), ] + OP_RESULT = ht.TDictOf(ht.TNonEmptyString, + ht.TOr(ht.Comment("False on error")(ht.TBool), + ht.TListOf(ht.TNonEmptyString))) class OpBackupPrepare(OpCode): @@ -1513,6 +1688,7 @@ class OpBackupPrepare(OpCode): ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES), "Export mode"), ] + OP_RESULT = ht.TOr(ht.TNone, ht.TDict) class OpBackupExport(OpCode): @@ -1551,6 +1727,11 @@ class OpBackupExport(OpCode): ("destination_x509_ca", None, ht.TMaybeString, "Destination X509 CA (remote export only)"), ] + OP_RESULT = \ + ht.TAnd(ht.TIsLength(2), ht.TItems([ + ht.Comment("Finalizing status")(ht.TBool), + ht.Comment("Status for every exported disk")(ht.TListOf(ht.TBool)), + ])) class OpBackupRemove(OpCode): @@ -1559,6 +1740,7 @@ class OpBackupRemove(OpCode): OP_PARAMS = [ _PInstanceName, ] + OP_RESULT = ht.TNone # Tags opcodes @@ -1567,17 +1749,26 @@ class OpTagsGet(OpCode): OP_DSC_FIELD = "name" OP_PARAMS = [ _PTagKind, + # Not using _PUseLocking as the default is different for historical reasons + ("use_locking", True, ht.TBool, "Whether to use synchronization"), # Name is only meaningful for nodes and instances - ("name", ht.NoDefault, ht.TMaybeString, None), + ("name", ht.NoDefault, ht.TMaybeString, + "Name of object to retrieve tags from"), ] + OP_RESULT = ht.TListOf(ht.TNonEmptyString) class OpTagsSearch(OpCode): """Searches the tags in the cluster for a given pattern.""" OP_DSC_FIELD = "pattern" OP_PARAMS = [ - ("pattern", ht.NoDefault, ht.TNonEmptyString, None), + ("pattern", ht.NoDefault, ht.TNonEmptyString, + "Search pattern (regular expression)"), ] + OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([ + ht.TNonEmptyString, + ht.TNonEmptyString, + ]))) class OpTagsSet(OpCode): @@ -1586,8 +1777,10 @@ class OpTagsSet(OpCode): _PTagKind, _PTags, # Name is only meaningful for nodes and instances - ("name", ht.NoDefault, ht.TMaybeString, None), + ("name", ht.NoDefault, ht.TMaybeString, + "Name of object where tag(s) should be added"), ] + OP_RESULT = ht.TNone class OpTagsDel(OpCode): @@ -1596,8 +1789,10 @@ class OpTagsDel(OpCode): _PTagKind, _PTags, # Name is only meaningful for nodes and instances - ("name", ht.NoDefault, ht.TMaybeString, None), + ("name", ht.NoDefault, ht.TMaybeString, + "Name of object where tag(s) should be deleted"), ] + OP_RESULT = ht.TNone # Test opcodes @@ -1648,9 +1843,12 @@ class OpTestAllocator(OpCode): ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None), ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES), None), ("name", ht.NoDefault, ht.TNonEmptyString, None), - ("nics", ht.NoDefault, ht.TOr(ht.TNone, ht.TListOf( - ht.TDictOf(ht.TElemOf([constants.INIC_MAC, constants.INIC_IP, "bridge"]), - ht.TOr(ht.TNone, ht.TNonEmptyString)))), None), + ("nics", ht.NoDefault, + ht.TMaybeListOf(ht.TDictOf(ht.TElemOf([constants.INIC_MAC, + constants.INIC_IP, + "bridge"]), + ht.TOr(ht.TNone, ht.TNonEmptyString))), + None), ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList), None), ("hypervisor", None, ht.TMaybeString, None), ("allocator", None, ht.TMaybeString, None), @@ -1659,12 +1857,10 @@ class OpTestAllocator(OpCode): ("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt), None), ("os", None, ht.TMaybeString, None), ("disk_template", None, ht.TMaybeString, None), - ("instances", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), - None), + ("instances", None, ht.TMaybeListOf(ht.TNonEmptyString), None), ("evac_mode", None, ht.TOr(ht.TNone, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None), - ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), - None), + ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), None), ]