#
#
-# 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
__slots__ attribute for this class.
"""
+ slots = self._all_slots()
for key in kwargs:
- if key not in self.__slots__:
+ if key not in slots:
raise TypeError("Object %s doesn't support the parameter '%s'" %
(self.__class__.__name__, key))
setattr(self, key, kwargs[key])
"""
state = {}
- for name in self.__slots__:
+ for name in self._all_slots():
if hasattr(self, name):
state[name] = getattr(self, name)
return state
raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
type(state))
- for name in self.__slots__:
- if name not in state:
+ for name in self._all_slots():
+ if name not in state and hasattr(self, name):
delattr(self, name)
for name in state:
setattr(self, name, state[name])
+ @classmethod
+ def _all_slots(cls):
+ """Compute the list of all declared slots for a class.
+
+ """
+ slots = []
+ for parent in cls.__mro__:
+ slots.extend(getattr(parent, "__slots__", []))
+ return slots
+
class OpCode(BaseOpCode):
"""Abstract OpCode.
@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__ = BaseOpCode.__slots__ + ["dry_run"]
+ __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_POST_INIT"
- __slots__ = OpCode.__slots__ + []
+ __slots__ = []
class OpDestroyCluster(OpCode):
"""
OP_ID = "OP_CLUSTER_DESTROY"
- __slots__ = OpCode.__slots__ + []
+ __slots__ = []
class OpQueryClusterInfo(OpCode):
"""Query cluster information."""
OP_ID = "OP_CLUSTER_QUERY"
- __slots__ = OpCode.__slots__ + []
+ __slots__ = []
class OpVerifyCluster(OpCode):
"""
OP_ID = "OP_CLUSTER_VERIFY"
- __slots__ = OpCode.__slots__ + ["skip_checks", "verbose", "error_codes",
- "debug_simulate_errors"]
+ __slots__ = ["skip_checks", "verbose", "error_codes",
+ "debug_simulate_errors"]
class OpVerifyDisks(OpCode):
"""
OP_ID = "OP_CLUSTER_VERIFY_DISKS"
- __slots__ = OpCode.__slots__ + []
+ __slots__ = []
class OpRepairDiskSizes(OpCode):
class OpQueryConfigValues(OpCode):
"""Query cluster configuration values."""
OP_ID = "OP_CLUSTER_CONFIG_QUERY"
- __slots__ = OpCode.__slots__ + ["output_fields"]
+ __slots__ = ["output_fields"]
class OpRenameCluster(OpCode):
"""
OP_ID = "OP_CLUSTER_RENAME"
OP_DSC_FIELD = "name"
- __slots__ = OpCode.__slots__ + ["name"]
+ __slots__ = ["name"]
class OpSetClusterParams(OpCode):
"""
OP_ID = "OP_CLUSTER_SET_PARAMS"
- __slots__ = OpCode.__slots__ + [
+ __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__ = OpCode.__slots__ + [
+ __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):
"""
OP_ID = "OP_NODE_REMOVE"
OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + ["node_name"]
+ __slots__ = ["node_name"]
class OpAddNode(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__ = OpCode.__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):
"""Compute the list of nodes."""
OP_ID = "OP_NODE_QUERY"
- __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
+ __slots__ = ["output_fields", "names", "use_locking"]
class OpQueryNodeVolumes(OpCode):
"""Get list of volumes on node."""
OP_ID = "OP_NODE_QUERYVOLS"
- __slots__ = OpCode.__slots__ + ["nodes", "output_fields"]
+ __slots__ = ["nodes", "output_fields"]
class OpQueryNodeStorage(OpCode):
"""Get information on storage for node(s)."""
OP_ID = "OP_NODE_QUERY_STORAGE"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"nodes",
"storage_type",
"name",
class OpModifyNodeStorage(OpCode):
- """"""
+ """Modifies the properies of a storage unit"""
OP_ID = "OP_NODE_MODIFY_STORAGE"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"node_name",
"storage_type",
"name",
"""Repairs the volume group on a node."""
OP_ID = "OP_REPAIR_NODE_STORAGE"
OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"node_name",
"storage_type",
"name",
+ "ignore_consistency",
]
"""Change the parameters of a node."""
OP_ID = "OP_NODE_SET_PARAMS"
OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"node_name",
"force",
"master_candidate",
"offline",
"drained",
+ "auto_promote",
+ "master_capable",
+ "vm_capable",
+ "secondary_ip",
+ "ndparams",
]
"""Tries to powercycle a node."""
OP_ID = "OP_NODE_POWERCYCLE"
OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"node_name",
"force",
]
-class OpEvacuateNode(OpCode):
- """Relocate secondary instances from a node."""
- OP_ID = "OP_NODE_EVACUATE"
- OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + [
- "node_name", "remote_node", "iallocator",
- ]
-
-
class OpMigrateNode(OpCode):
"""Migrate all instances from a node."""
OP_ID = "OP_NODE_MIGRATE"
OP_DSC_FIELD = "node_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"node_name",
+ "mode",
"live",
]
+class OpNodeEvacuationStrategy(OpCode):
+ """Compute the evacuation strategy for a list of nodes."""
+ OP_ID = "OP_NODE_EVAC_STRATEGY"
+ OP_DSC_FIELD = "nodes"
+ __slots__ = ["nodes", "iallocator", "remote_node"]
+
+
# 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__ = OpCode.__slots__ + [
- "instance_name", "os_type", "force_variant",
+ __slots__ = [
+ "instance_name",
+ "os_type", "force_variant", "no_install",
"pnode", "disk_template", "snode", "mode",
"disks", "nics",
- "src_node", "src_path", "start",
- "wait_for_sync", "ip_check",
+ "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__ = OpCode.__slots__ + ["instance_name", "os_type", "force_variant"]
+ __slots__ = ["instance_name", "os_type", "force_variant", "osparams"]
class OpRemoveInstance(OpCode):
"""Remove an instance."""
OP_ID = "OP_INSTANCE_REMOVE"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name", "ignore_failures"]
+ __slots__ = [
+ "instance_name",
+ "ignore_failures",
+ "shutdown_timeout",
+ ]
class OpRenameInstance(OpCode):
"""Rename an instance."""
OP_ID = "OP_INSTANCE_RENAME"
- __slots__ = OpCode.__slots__ + [
- "instance_name", "ignore_ip", "new_name",
+ __slots__ = [
+ "instance_name", "ip_check", "new_name", "name_check",
]
"""Startup an instance."""
OP_ID = "OP_INSTANCE_STARTUP"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
- "instance_name", "force", "hvparams", "beparams",
+ __slots__ = [
+ "instance_name", "force", "hvparams", "beparams", "ignore_offline_nodes",
]
"""Shutdown an instance."""
OP_ID = "OP_INSTANCE_SHUTDOWN"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name", "timeout"]
+ __slots__ = [
+ "instance_name", "timeout", "ignore_offline_nodes",
+ ]
class OpRebootInstance(OpCode):
"""Reboot an instance."""
OP_ID = "OP_INSTANCE_REBOOT"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
]
"""Replace the disks of an instance."""
OP_ID = "OP_INSTANCE_REPLACE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name", "remote_node", "mode", "disks", "iallocator",
+ "early_release",
]
"""Failover an instance."""
OP_ID = "OP_INSTANCE_FAILOVER"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name", "ignore_consistency", "shutdown_timeout",
]
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__ = OpCode.__slots__ + ["instance_name", "live", "cleanup"]
+ __slots__ = ["instance_name", "mode", "cleanup", "live"]
class OpMoveInstance(OpCode):
"""
OP_ID = "OP_INSTANCE_MOVE"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name", "target_node", "shutdown_timeout",
- ]
+ ]
class OpConnectConsole(OpCode):
"""Connect to an instance's console."""
OP_ID = "OP_INSTANCE_CONSOLE"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name"]
+ __slots__ = ["instance_name"]
class OpActivateInstanceDisks(OpCode):
"""Activate an instance's disks."""
OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name", "ignore_size"]
+ __slots__ = ["instance_name", "ignore_size"]
class OpDeactivateInstanceDisks(OpCode):
"""Deactivate an instance's disks."""
OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name"]
+ __slots__ = ["instance_name"]
class OpRecreateInstanceDisks(OpCode):
"""Deactivate an instance's disks."""
OP_ID = "OP_INSTANCE_RECREATE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name", "disks"]
+ __slots__ = ["instance_name", "disks"]
class OpQueryInstances(OpCode):
"""Compute the list of instances."""
OP_ID = "OP_INSTANCE_QUERY"
- __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
+ __slots__ = ["output_fields", "names", "use_locking"]
class OpQueryInstanceData(OpCode):
"""Compute the run-time status of instances."""
OP_ID = "OP_INSTANCE_QUERY_DATA"
- __slots__ = OpCode.__slots__ + ["instances", "static"]
+ __slots__ = ["instances", "static"]
class OpSetInstanceParams(OpCode):
"""Change the parameters of an instance."""
OP_ID = "OP_INSTANCE_SET_PARAMS"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name",
- "hvparams", "beparams", "force",
- "nics", "disks",
+ "hvparams", "beparams", "osparams", "force",
+ "nics", "disks", "disk_template",
+ "remote_node", "os_name", "force_variant",
]
"""Grow a disk of an instance."""
OP_ID = "OP_INSTANCE_GROW_DISK"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"instance_name", "disk", "amount", "wait_for_sync",
]
+# 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."""
OP_ID = "OP_OS_DIAGNOSE"
- __slots__ = OpCode.__slots__ + ["output_fields", "names"]
+ __slots__ = ["output_fields", "names"]
# Exports opcodes
class OpQueryExports(OpCode):
"""Compute the list of exported images."""
OP_ID = "OP_BACKUP_QUERY"
- __slots__ = OpCode.__slots__ + ["nodes", "use_locking"]
+ __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__ = OpCode.__slots__ + [
+ __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",
]
"""Remove an instance's export."""
OP_ID = "OP_BACKUP_REMOVE"
OP_DSC_FIELD = "instance_name"
- __slots__ = OpCode.__slots__ + ["instance_name"]
+ __slots__ = ["instance_name"]
# Tags opcodes
"""Returns the tags of the given object."""
OP_ID = "OP_TAGS_GET"
OP_DSC_FIELD = "name"
- __slots__ = OpCode.__slots__ + ["kind", "name"]
+ __slots__ = ["kind", "name"]
class OpSearchTags(OpCode):
"""Searches the tags in the cluster for a given pattern."""
OP_ID = "OP_TAGS_SEARCH"
OP_DSC_FIELD = "pattern"
- __slots__ = OpCode.__slots__ + ["pattern"]
+ __slots__ = ["pattern"]
class OpAddTags(OpCode):
"""Add a list of tags on a given object."""
OP_ID = "OP_TAGS_SET"
- __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
+ __slots__ = ["kind", "name", "tags"]
class OpDelTags(OpCode):
"""Remove a list of tags from a given object."""
OP_ID = "OP_TAGS_DEL"
- __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
+ __slots__ = ["kind", "name", "tags"]
# Test opcodes
"""
OP_ID = "OP_TEST_DELAY"
OP_DSC_FIELD = "duration"
- __slots__ = OpCode.__slots__ + ["duration", "on_master", "on_nodes"]
+ __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
class OpTestAllocator(OpCode):
"""
OP_ID = "OP_TEST_ALLOCATOR"
OP_DSC_FIELD = "allocator"
- __slots__ = OpCode.__slots__ + [
+ __slots__ = [
"direction", "mode", "allocator", "name",
"mem_size", "disks", "disk_template",
"os", "tags", "nics", "vcpus", "hypervisor",
+ "evac_nodes",
+ ]
+
+
+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",
]
projects / ganeti-local / blobdiff