_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
"Default node parameters for group")
+_PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
+ "Resource(s) to query for")
+
_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
+#: Do not remember instance state changes
+_PNoRemember = ("no_remember", False, ht.TBool,
+ "Do not remember the state change")
+
+#: Target node for instance migration/failover
+_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
+ "Target node for shared-storage instances")
+
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")
_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
ht.TOr(ht.TNone, ht.TNonEmptyString))
+_SUMMARY_PREFIX = {
+ "CLUSTER_": "C_",
+ "GROUP_": "G_",
+ "NODE_": "N_",
+ "INSTANCE_": "I_",
+ }
+
def _NameToId(name):
"""Convert an opcode class name to an OP_ID.
errors.ECODE_INVAL)
+def RequireSharedFileStorage():
+ """Checks that shared file storage is enabled.
+
+ While it doesn't really fit into this module, L{utils} was deemed too large
+ of a dependency to be imported for just one or two functions.
+
+ @raise errors.OpPrereqError: when shared file storage is disabled
+
+ """
+ if not constants.ENABLE_SHARED_FILE_STORAGE:
+ raise errors.OpPrereqError("Shared file storage disabled at"
+ " configure time", errors.ECODE_INVAL)
+
+
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
"""Ensures file storage is enabled if used.
"""
if value == constants.DT_FILE:
RequireFileStorage()
+ elif value == constants.DT_SHARED_FILE:
+ RequireSharedFileStorage()
return True
txt = "%s(%s)" % (txt, field_value)
return txt
+ def TinySummary(self):
+ """Generates a compact summary description of the opcode.
+
+ """
+ assert self.OP_ID.startswith("OP_")
+
+ text = self.OP_ID[3:]
+
+ for (prefix, supplement) in _SUMMARY_PREFIX.items():
+ if text.startswith(prefix):
+ return supplement + text[len(prefix):]
+
+ return text
+
# cluster opcodes
"""Query cluster information."""
-class OpClusterVerify(OpCode):
- """Verify the cluster state.
+class OpClusterVerifyConfig(OpCode):
+ """Verify the cluster config.
+
+ """
+ OP_PARAMS = [
+ ("verbose", False, ht.TBool, None),
+ ("error_codes", False, ht.TBool, None),
+ ("debug_simulate_errors", False, ht.TBool, None),
+ ]
+
+
+class OpClusterVerifyGroup(OpCode):
+ """Run verify on a node group from the cluster.
@type skip_checks: C{list}
@ivar skip_checks: steps to be skipped from the verify process; this
only L{constants.VERIFY_NPLUSONE_MEM} can be passed
"""
+ OP_DSC_FIELD = "group_name"
OP_PARAMS = [
+ ("group_name", ht.NoDefault, ht.TNonEmptyString, None),
("skip_checks", ht.EmptyList,
ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)), None),
("verbose", False, ht.TBool, None),
class OpQuery(OpCode):
"""Query for resources/items.
- @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
+ @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
@ivar fields: List of fields to retrieve
@ivar filter: Query filter
"""
OP_PARAMS = [
- ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY),
- "Resource(s) to query for"),
+ _PQueryWhat,
("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
"Requested fields"),
- ("filter", None, ht.TOr(ht.TNone,
- ht.TListOf(ht.TOr(ht.TNonEmptyString, ht.TList))),
+ ("filter", None, ht.TOr(ht.TNone, ht.TListOf),
"Query filter"),
]
class OpQueryFields(OpCode):
"""Query for available resource/item fields.
- @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
+ @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
@ivar fields: List of fields to retrieve
"""
OP_PARAMS = [
- ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY), None),
- ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)), None),
+ _PQueryWhat,
+ ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
+ "Requested fields; if not given, all are returned"),
]
class OpOobCommand(OpCode):
"""Interact with OOB."""
OP_PARAMS = [
- ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
- ("command", None, ht.TElemOf(constants.OOB_COMMANDS), None),
- ("timeout", constants.OOB_TIMEOUT, ht.TInt, None),
- ("ignore_status", False, ht.TBool, None),
+ ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "List of nodes to run the OOB command against"),
+ ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
+ "OOB command to be run"),
+ ("timeout", constants.OOB_TIMEOUT, ht.TInt,
+ "Timeout before the OOB helper will be terminated"),
+ ("ignore_status", False, ht.TBool,
+ "Ignores the node offline status for power off"),
+ ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
+ "Time in seconds to wait between powering on nodes"),
]
_PNodeName,
_PMigrationMode,
_PMigrationLive,
+ _PMigrationTargetNode,
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding the target node for shared-storage instances"),
]
("hvparams", ht.EmptyDict, ht.TDict,
"Temporary hypervisor parameters, hypervisor-dependent"),
("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
+ _PNoRemember,
]
_PIgnoreOfflineNodes,
("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
"How long to wait for instance to shut down"),
+ _PNoRemember,
]
_PInstanceName,
_PShutdownTimeout,
_PIgnoreConsistency,
+ _PMigrationTargetNode,
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding the target node for shared-storage instances"),
]
_PInstanceName,
_PMigrationMode,
_PMigrationLive,
+ _PMigrationTargetNode,
("cleanup", False, ht.TBool,
"Whether a previously failed migration should be cleaned up"),
+ ("iallocator", None, ht.TMaybeString,
+ "Iallocator for deciding the target node for shared-storage instances"),
+ ("allow_failover", False, ht.TBool,
+ "Whether we can fallback to failover if migration is not possible"),
]
_PInstanceName,
_PShutdownTimeout,
("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
+ _PIgnoreConsistency,
]
_PInstanceName,
("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
"List of disk indexes"),
+ ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "New instance nodes, if relocation is desired"),
]
class OpInstanceQueryData(OpCode):
"""Compute the run-time status of instances."""
OP_PARAMS = [
- ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
- ("static", False, ht.TBool, None),
+ _PUseLocking,
+ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
+ "Instance names"),
+ ("static", False, ht.TBool,
+ "Whether to only return configuration data without querying"
+ " nodes"),
]
("os_name", None, ht.TMaybeString,
"Change instance's OS name. Does not reinstall 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"),
]
("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(["mac", "ip", "bridge"]),
+ 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),
("disk_template", None, ht.TMaybeString, None),
("evac_nodes", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
None),
+ ("instances", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
+ None),
+ ("reloc_mode", None,
+ ht.TOr(ht.TNone, ht.TElemOf(constants.IALLOCATOR_MRELOC_MODES)), None),
+ ("target_groups", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
+ None),
]
("result", ht.NoDefault, ht.NoType, None),
("messages", ht.NoDefault, ht.NoType, None),
("fail", ht.NoDefault, ht.NoType, None),
+ ("submit_jobs", None, ht.NoType, None),
]
WITH_LU = False