#
#
-# 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.
from this class should override OP_ID.
@cvar OP_ID: The ID of this opcode. This should be unique amongst all
- childre of this class.
+ children of this class.
+ @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__ = []
+ __slots__ = ["dry_run", "debug_level", "priority"]
def __getstate__(self):
"""Specialized getstate for opcodes.
raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
op_id = data["OP_ID"]
op_class = None
- for item in globals().values():
- if (isinstance(item, type) and
- issubclass(item, cls) and
- hasattr(item, "OP_ID") and
- getattr(item, "OP_ID") == op_id):
- op_class = item
- break
- if op_class is None:
+ if op_id in OP_MAPPING:
+ op_class = OP_MAPPING[op_id]
+ else:
raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
op_id)
op = op_class()
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
+# cluster opcodes
+
+class OpPostInitCluster(OpCode):
+ """Post cluster initialization.
+
+ This opcode does not touch the cluster at all. Its purpose is to run hooks
+ after the cluster has been initialized.
+
+ """
+ OP_ID = "OP_CLUSTER_POST_INIT"
+ __slots__ = []
+
+
class OpDestroyCluster(OpCode):
"""Destroy the cluster.
"""
OP_ID = "OP_CLUSTER_VERIFY"
- __slots__ = ["skip_checks"]
+ __slots__ = ["skip_checks", "verbose", "error_codes",
+ "debug_simulate_errors"]
class OpVerifyDisks(OpCode):
__slots__ = []
+class OpRepairDiskSizes(OpCode):
+ """Verify the disk sizes of the instances and fixes configuration
+ mimatches.
+
+ Parameters: optional instances list, in case we want to restrict the
+ checks to only a subset of the instances.
+
+ Result: a list of tuples, (instance, disk, new-size) for changed
+ configurations.
+
+ In normal operation, the list should be empty.
+
+ @type instances: list
+ @ivar instances: the list of instances to check, or empty for all instances
+
+ """
+ OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
+ __slots__ = ["instances"]
+
+
class OpQueryConfigValues(OpCode):
"""Query cluster configuration values."""
OP_ID = "OP_CLUSTER_CONFIG_QUERY"
"""
OP_ID = "OP_CLUSTER_SET_PARAMS"
- __slots__ = ["vg_name"]
+ __slots__ = [
+ "vg_name",
+ "drbd_helper",
+ "enabled_hypervisors",
+ "hvparams",
+ "os_hvp",
+ "beparams",
+ "osparams",
+ "nicparams",
+ "candidate_pool_size",
+ "maintain_node_health",
+ "uid_pool",
+ "add_uids",
+ "remove_uids",
+ "default_iallocator",
+ "reserved_lvs",
+ ]
+
+class OpRedistributeConfig(OpCode):
+ """Force a full push of the cluster configuration.
+
+ """
+ OP_ID = "OP_CLUSTER_REDIST_CONF"
+ __slots__ = []
# node opcodes
"""
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", "nodegroup"]
class OpQueryNodes(OpCode):
"""Compute the list of nodes."""
OP_ID = "OP_NODE_QUERY"
- __slots__ = ["output_fields", "names"]
+ __slots__ = ["output_fields", "names", "use_locking"]
class OpQueryNodeVolumes(OpCode):
__slots__ = ["nodes", "output_fields"]
+class OpQueryNodeStorage(OpCode):
+ """Get information on storage for node(s)."""
+ OP_ID = "OP_NODE_QUERY_STORAGE"
+ __slots__ = [
+ "nodes",
+ "storage_type",
+ "name",
+ "output_fields",
+ ]
+
+
+class OpModifyNodeStorage(OpCode):
+ """Modifies the properies of a storage unit"""
+ OP_ID = "OP_NODE_MODIFY_STORAGE"
+ __slots__ = [
+ "node_name",
+ "storage_type",
+ "name",
+ "changes",
+ ]
+
+
+class OpRepairNodeStorage(OpCode):
+ """Repairs the volume group on a node."""
+ OP_ID = "OP_REPAIR_NODE_STORAGE"
+ OP_DSC_FIELD = "node_name"
+ __slots__ = [
+ "node_name",
+ "storage_type",
+ "name",
+ "ignore_consistency",
+ ]
+
+
+class OpSetNodeParams(OpCode):
+ """Change the parameters of a node."""
+ OP_ID = "OP_NODE_SET_PARAMS"
+ OP_DSC_FIELD = "node_name"
+ __slots__ = [
+ "node_name",
+ "force",
+ "master_candidate",
+ "offline",
+ "drained",
+ "auto_promote",
+ ]
+
+
+class OpPowercycleNode(OpCode):
+ """Tries to powercycle a node."""
+ OP_ID = "OP_NODE_POWERCYCLE"
+ OP_DSC_FIELD = "node_name"
+ __slots__ = [
+ "node_name",
+ "force",
+ ]
+
+
+class OpMigrateNode(OpCode):
+ """Migrate all instances from a node."""
+ OP_ID = "OP_NODE_MIGRATE"
+ OP_DSC_FIELD = "node_name"
+ __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)
+
+ """
OP_ID = "OP_INSTANCE_CREATE"
OP_DSC_FIELD = "instance_name"
__slots__ = [
- "instance_name", "disk_size", "os_type", "pnode",
- "disk_template", "snode", "swap_size", "mode",
- "ip", "bridge", "src_node", "src_path", "start",
- "wait_for_sync", "ip_check", "mac",
+ "instance_name",
+ "os_type", "force_variant", "no_install",
+ "pnode", "disk_template", "snode", "mode",
+ "disks", "nics",
+ "src_node", "src_path", "start", "identify_defaults",
+ "wait_for_sync", "ip_check", "name_check",
"file_storage_dir", "file_driver",
"iallocator",
- "hypervisor", "hvparams", "beparams",
+ "hypervisor", "hvparams", "beparams", "osparams",
+ "source_handshake",
+ "source_x509_ca",
+ "source_instance_name",
]
"""Reinstall an instance's OS."""
OP_ID = "OP_INSTANCE_REINSTALL"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "os_type"]
+ __slots__ = ["instance_name", "os_type", "force_variant"]
class OpRemoveInstance(OpCode):
"""Remove an instance."""
OP_ID = "OP_INSTANCE_REMOVE"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "ignore_failures"]
+ __slots__ = [
+ "instance_name",
+ "ignore_failures",
+ "shutdown_timeout",
+ ]
class OpRenameInstance(OpCode):
"""Rename an instance."""
OP_ID = "OP_INSTANCE_RENAME"
- __slots__ = ["instance_name", "ignore_ip", "new_name"]
+ __slots__ = [
+ "instance_name", "ip_check", "new_name", "name_check",
+ ]
class OpStartupInstance(OpCode):
"""Startup an instance."""
OP_ID = "OP_INSTANCE_STARTUP"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "force", "extra_args"]
+ __slots__ = [
+ "instance_name", "force", "hvparams", "beparams",
+ ]
class OpShutdownInstance(OpCode):
"""Shutdown an instance."""
OP_ID = "OP_INSTANCE_SHUTDOWN"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name"]
+ __slots__ = ["instance_name", "timeout"]
class OpRebootInstance(OpCode):
"""Reboot an instance."""
OP_ID = "OP_INSTANCE_REBOOT"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "reboot_type", "extra_args",
- "ignore_secondaries" ]
+ __slots__ = [
+ "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
+ ]
class OpReplaceDisks(OpCode):
"""Replace the disks of an instance."""
OP_ID = "OP_INSTANCE_REPLACE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
+ __slots__ = [
+ "instance_name", "remote_node", "mode", "disks", "iallocator",
+ "early_release",
+ ]
class OpFailoverInstance(OpCode):
"""Failover an instance."""
OP_ID = "OP_INSTANCE_FAILOVER"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name", "ignore_consistency"]
+ __slots__ = [
+ "instance_name", "ignore_consistency", "shutdown_timeout",
+ ]
+
+
+class OpMigrateInstance(OpCode):
+ """Migrate an instance.
+
+ This migrates (without shutting down an instance) to its secondary
+ 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", "mode", "cleanup", "live"]
+
+
+class OpMoveInstance(OpCode):
+ """Move an instance.
+
+ This move (with shutting down an instance and data copying) to an
+ arbitrary node.
+
+ @ivar instance_name: the name of the instance
+ @ivar target_node: the destination node
+
+ """
+ OP_ID = "OP_INSTANCE_MOVE"
+ OP_DSC_FIELD = "instance_name"
+ __slots__ = [
+ "instance_name", "target_node", "shutdown_timeout",
+ ]
class OpConnectConsole(OpCode):
"""Activate an instance's disks."""
OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
OP_DSC_FIELD = "instance_name"
- __slots__ = ["instance_name"]
+ __slots__ = ["instance_name", "ignore_size"]
class OpDeactivateInstanceDisks(OpCode):
__slots__ = ["instance_name"]
+class OpRecreateInstanceDisks(OpCode):
+ """Deactivate an instance's disks."""
+ OP_ID = "OP_INSTANCE_RECREATE_DISKS"
+ OP_DSC_FIELD = "instance_name"
+ __slots__ = ["instance_name", "disks"]
+
+
class OpQueryInstances(OpCode):
"""Compute the list of instances."""
OP_ID = "OP_INSTANCE_QUERY"
- __slots__ = ["output_fields", "names"]
+ __slots__ = ["output_fields", "names", "use_locking"]
class OpQueryInstanceData(OpCode):
OP_ID = "OP_INSTANCE_SET_PARAMS"
OP_DSC_FIELD = "instance_name"
__slots__ = [
- "instance_name", "ip", "bridge", "mac",
- "hvparams", "beparams", "force",
+ "instance_name",
+ "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__ = ["instance_name", "disk", "amount"]
+ __slots__ = [
+ "instance_name", "disk", "amount", "wait_for_sync",
+ ]
# OS opcodes
class OpQueryExports(OpCode):
"""Compute the list of exported images."""
OP_ID = "OP_BACKUP_QUERY"
- __slots__ = ["nodes"]
+ __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__ = ["instance_name", "target_node", "shutdown"]
+ __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",
+ ]
class OpRemoveExport(OpCode):
"""
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):
__slots__ = [
"direction", "mode", "allocator", "name",
"mem_size", "disks", "disk_template",
- "os", "tags", "nics", "vcpus",
+ "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",
]
+
+
+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"))])