#
#
-# Copyright (C) 2006, 2007 Google Inc.
+# Copyright (C) 2006, 2007, 2008, 2009, 2010 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
@cvar OP_ID: The ID of this opcode. This should be unique amongst all
children of this class.
+ @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
+ string returned by Summary(); see the docstring of that
+ method for details).
@ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
the check steps
+ @ivar priority: Opcode priority for queue
"""
OP_ID = "OP_ABSTRACT"
- __slots__ = ["dry_run", "debug_level"]
+ __slots__ = ["dry_run", "debug_level", "priority"]
def __getstate__(self):
"""Specialized getstate for opcodes.
def Summary(self):
"""Generates a summary description of this opcode.
+ The summary is the value of the OP_ID attribute (without the "OP_" prefix),
+ plus the value of the OP_DSC_FIELD attribute, if one was defined; this field
+ should allow to easily identify the operation (for an instance creation job,
+ e.g., it would be the instance name).
+
"""
# all OP_ID start with OP_, we remove that
txt = self.OP_ID[3:]
field_name = getattr(self, "OP_DSC_FIELD", None)
if field_name:
field_value = getattr(self, field_name, None)
+ if isinstance(field_value, (list, tuple)):
+ field_value = ",".join(str(i) for i in field_value)
txt = "%s(%s)" % (txt, field_value)
return txt
OP_ID = "OP_CLUSTER_SET_PARAMS"
__slots__ = [
"vg_name",
+ "drbd_helper",
"enabled_hypervisors",
"hvparams",
"os_hvp",
"beparams",
+ "osparams",
"nicparams",
+ "ndparams",
"candidate_pool_size",
"maintain_node_health",
+ "uid_pool",
+ "add_uids",
+ "remove_uids",
+ "default_iallocator",
+ "reserved_lvs",
+ "hidden_os",
+ "blacklisted_os",
+ "prealloc_wipe_disks",
+ "master_netdev",
]
OP_ID = "OP_CLUSTER_REDIST_CONF"
__slots__ = []
+
+class OpQuery(OpCode):
+ """Query for resources/items.
+
+ @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
+ @ivar fields: List of fields to retrieve
+ @ivar filter: Query filter
+
+ """
+ OP_ID = "OP_QUERY"
+ __slots__ = [
+ "what",
+ "fields",
+ "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 fields: List of fields to retrieve
+
+ """
+ OP_ID = "OP_QUERY_FIELDS"
+ __slots__ = [
+ "what",
+ "fields",
+ ]
+
+
+class OpOutOfBand(OpCode):
+ """Interact with OOB."""
+ OP_ID = "OP_OUT_OF_BAND"
+ __slots__ = [
+ "node_name",
+ "command",
+ "timeout",
+ ]
+
+
# node opcodes
class OpRemoveNode(OpCode):
name is already in the cluster; use this parameter to 'repair'
a node that had its configuration broken, or was reinstalled
without removal from the cluster.
+ @type group: C{str}
+ @ivar group: The node group to which this node will belong.
+ @type vm_capable: C{bool}
+ @ivar vm_capable: The vm_capable node attribute
+ @type master_capable: C{bool}
+ @ivar master_capable: The master_capable node attribute
"""
OP_ID = "OP_NODE_ADD"
OP_DSC_FIELD = "node_name"
- __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
+ __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd", "group",
+ "vm_capable", "master_capable", "ndparams"]
class OpQueryNodes(OpCode):
"offline",
"drained",
"auto_promote",
+ "master_capable",
+ "vm_capable",
+ "secondary_ip",
+ "ndparams",
]
]
-class OpEvacuateNode(OpCode):
- """Relocate secondary instances from a node."""
- OP_ID = "OP_NODE_EVACUATE"
- OP_DSC_FIELD = "node_name"
- __slots__ = [
- "node_name", "remote_node", "iallocator", "early_release",
- ]
-
-
class OpMigrateNode(OpCode):
"""Migrate all instances from a node."""
OP_ID = "OP_NODE_MIGRATE"
OP_DSC_FIELD = "node_name"
__slots__ = [
"node_name",
+ "mode",
"live",
]
# instance opcodes
class OpCreateInstance(OpCode):
- """Create an instance."""
+ """Create an instance.
+
+ @ivar instance_name: Instance name
+ @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
+ @ivar source_handshake: Signed handshake from source (remote import only)
+ @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
+ @ivar source_instance_name: Previous name of instance (remote import only)
+ @ivar source_shutdown_timeout: Shutdown timeout used for source instance
+ (remote import only)
+
+ """
OP_ID = "OP_INSTANCE_CREATE"
OP_DSC_FIELD = "instance_name"
__slots__ = [
"os_type", "force_variant", "no_install",
"pnode", "disk_template", "snode", "mode",
"disks", "nics",
- "src_node", "src_path", "start",
+ "src_node", "src_path", "start", "identify_defaults",
"wait_for_sync", "ip_check", "name_check",
"file_storage_dir", "file_driver",
"iallocator",
- "hypervisor", "hvparams", "beparams",
- "dry_run",
+ "hypervisor", "hvparams", "beparams", "osparams",
+ "source_handshake",
+ "source_x509_ca",
+ "source_instance_name",
+ "source_shutdown_timeout",
]
"""Reinstall an instance's OS."""
OP_ID = "OP_INSTANCE_REINSTALL"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "os_type", "force_variant"]
+ __slots__ = ["instance_name", "os_type", "force_variant", "osparams"]
class OpRemoveInstance(OpCode):
"""Rename an instance."""
OP_ID = "OP_INSTANCE_RENAME"
__slots__ = [
- "instance_name", "ignore_ip", "new_name",
+ "instance_name", "ip_check", "new_name", "name_check",
]
OP_ID = "OP_INSTANCE_STARTUP"
OP_DSC_FIELD = "instance_name"
__slots__ = [
- "instance_name", "force", "hvparams", "beparams",
+ "instance_name", "force", "hvparams", "beparams", "ignore_offline_nodes",
]
"""Shutdown an instance."""
OP_ID = "OP_INSTANCE_SHUTDOWN"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "timeout"]
+ __slots__ = [
+ "instance_name", "timeout", "ignore_offline_nodes",
+ ]
class OpRebootInstance(OpCode):
node.
@ivar instance_name: the name of the instance
+ @ivar mode: the migration mode (live, non-live or None for auto)
"""
OP_ID = "OP_INSTANCE_MIGRATE"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "live", "cleanup"]
+ __slots__ = ["instance_name", "mode", "cleanup", "live"]
class OpMoveInstance(OpCode):
OP_DSC_FIELD = "instance_name"
__slots__ = [
"instance_name",
- "hvparams", "beparams", "force",
+ "hvparams", "beparams", "osparams", "force",
"nics", "disks", "disk_template",
"remote_node", "os_name", "force_variant",
]
]
+# Node group opcodes
+
+class OpAddGroup(OpCode):
+ """Add a node group to the cluster."""
+ OP_ID = "OP_GROUP_ADD"
+ OP_DSC_FIELD = "group_name"
+ __slots__ = ["group_name"]
+
+
+class OpQueryGroups(OpCode):
+ """Compute the list of node groups."""
+ OP_ID = "OP_GROUP_QUERY"
+ __slots__ = ["output_fields", "names"]
+
+
+class OpRemoveGroup(OpCode):
+ """Remove a node group from the cluster."""
+ OP_ID = "OP_GROUP_REMOVE"
+ OP_DSC_FIELD = "group_name"
+ __slots__ = ["group_name"]
+
+
+class OpRenameGroup(OpCode):
+ """Rename a node group in the cluster."""
+ OP_ID = "OP_GROUP_RENAME"
+ OP_DSC_FIELD = "old_name"
+ __slots__ = ["old_name", "new_name"]
+
+
# OS opcodes
class OpDiagnoseOS(OpCode):
"""Compute the list of guest operating systems."""
__slots__ = ["nodes", "use_locking"]
+class OpPrepareExport(OpCode):
+ """Prepares an instance export.
+
+ @ivar instance_name: Instance name
+ @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
+
+ """
+ OP_ID = "OP_BACKUP_PREPARE"
+ OP_DSC_FIELD = "instance_name"
+ __slots__ = [
+ "instance_name", "mode",
+ ]
+
+
class OpExportInstance(OpCode):
- """Export an instance."""
+ """Export an instance.
+
+ For local exports, the export destination is the node name. For remote
+ exports, the export destination is a list of tuples, each consisting of
+ hostname/IP address, port, HMAC and HMAC salt. The HMAC is calculated using
+ the cluster domain secret over the value "${index}:${hostname}:${port}". The
+ destination X509 CA must be a signed certificate.
+
+ @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
+ @ivar target_node: Export destination
+ @ivar x509_key_name: X509 key to use (remote export only)
+ @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
+ only)
+
+ """
OP_ID = "OP_BACKUP_EXPORT"
OP_DSC_FIELD = "instance_name"
__slots__ = [
+ # TODO: Rename target_node as it changes meaning for different export modes
+ # (e.g. "destination")
"instance_name", "target_node", "shutdown", "shutdown_timeout",
+ "remove_instance",
+ "ignore_remove_failures",
+ "mode",
+ "x509_key_name",
+ "destination_x509_ca",
]
"""
OP_ID = "OP_TEST_DELAY"
OP_DSC_FIELD = "duration"
- __slots__ = ["duration", "on_master", "on_nodes"]
+ __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
class OpTestAllocator(OpCode):
]
+class OpTestJobqueue(OpCode):
+ """Utility opcode to test some aspects of the job queue.
+
+ """
+ OP_ID = "OP_TEST_JQUEUE"
+ __slots__ = [
+ "notify_waitlock",
+ "notify_exec",
+ "log_messages",
+ "fail",
+ ]
+
+
+class OpTestDummy(OpCode):
+ """Utility opcode used by unittests.
+
+ """
+ OP_ID = "OP_TEST_DUMMY"
+ __slots__ = [
+ "result",
+ "messages",
+ "fail",
+ ]
+
+
OP_MAPPING = dict([(v.OP_ID, v) for v in globals().values()
if (isinstance(v, type) and issubclass(v, OpCode) and
hasattr(v, "OP_ID"))])
projects / ganeti-local / blobdiff