4 # Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 This module implements the data structures which define the cluster
25 operations - the so-called opcodes.
27 Every operation which modifies the cluster state is expressed via
32 # this are practically structures, so disable the message about too
34 # pylint: disable-msg=R0903
37 class BaseOpCode(object):
38 """A simple serializable object.
40 This object serves as a parent class for OpCode without any custom
46 def __init__(self, **kwargs):
47 """Constructor for BaseOpCode.
49 The constructor takes only keyword arguments and will set
50 attributes on this object based on the passed arguments. As such,
51 it means that you should not pass arguments which are not in the
52 __slots__ attribute for this class.
55 slots = self._all_slots()
58 raise TypeError("Object %s doesn't support the parameter '%s'" %
59 (self.__class__.__name__, key))
60 setattr(self, key, kwargs[key])
62 def __getstate__(self):
63 """Generic serializer.
65 This method just returns the contents of the instance as a
69 @return: the instance attributes and their values
73 for name in self._all_slots():
74 if hasattr(self, name):
75 state[name] = getattr(self, name)
78 def __setstate__(self, state):
79 """Generic unserializer.
81 This method just restores from the serialized state the attributes
82 of the current instance.
84 @param state: the serialized opcode data
88 if not isinstance(state, dict):
89 raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
92 for name in self._all_slots():
93 if name not in state and hasattr(self, name):
97 setattr(self, name, state[name])
101 """Compute the list of all declared slots for a class.
105 for parent in cls.__mro__:
106 slots.extend(getattr(parent, "__slots__", []))
110 class OpCode(BaseOpCode):
113 This is the root of the actual OpCode hierarchy. All clases derived
114 from this class should override OP_ID.
116 @cvar OP_ID: The ID of this opcode. This should be unique amongst all
117 children of this class.
118 @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
120 @ivar priority: Opcode priority for queue
123 OP_ID = "OP_ABSTRACT"
124 __slots__ = ["dry_run", "debug_level", "priority"]
126 def __getstate__(self):
127 """Specialized getstate for opcodes.
129 This method adds to the state dictionary the OP_ID of the class,
130 so that on unload we can identify the correct class for
131 instantiating the opcode.
134 @return: the state as a dictionary
137 data = BaseOpCode.__getstate__(self)
138 data["OP_ID"] = self.OP_ID
142 def LoadOpCode(cls, data):
143 """Generic load opcode method.
145 The method identifies the correct opcode class from the dict-form
146 by looking for a OP_ID key, if this is not found, or its value is
147 not available in this module as a child of this class, we fail.
150 @param data: the serialized opcode
153 if not isinstance(data, dict):
154 raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
155 if "OP_ID" not in data:
156 raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
157 op_id = data["OP_ID"]
159 if op_id in OP_MAPPING:
160 op_class = OP_MAPPING[op_id]
162 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
165 new_data = data.copy()
166 del new_data["OP_ID"]
167 op.__setstate__(new_data)
171 """Generates a summary description of this opcode.
174 # all OP_ID start with OP_, we remove that
176 field_name = getattr(self, "OP_DSC_FIELD", None)
178 field_value = getattr(self, field_name, None)
179 if isinstance(field_value, (list, tuple)):
180 field_value = ",".join(str(i) for i in field_value)
181 txt = "%s(%s)" % (txt, field_value)
187 class OpPostInitCluster(OpCode):
188 """Post cluster initialization.
190 This opcode does not touch the cluster at all. Its purpose is to run hooks
191 after the cluster has been initialized.
194 OP_ID = "OP_CLUSTER_POST_INIT"
198 class OpDestroyCluster(OpCode):
199 """Destroy the cluster.
201 This opcode has no other parameters. All the state is irreversibly
202 lost after the execution of this opcode.
205 OP_ID = "OP_CLUSTER_DESTROY"
209 class OpQueryClusterInfo(OpCode):
210 """Query cluster information."""
211 OP_ID = "OP_CLUSTER_QUERY"
215 class OpVerifyCluster(OpCode):
216 """Verify the cluster state.
218 @type skip_checks: C{list}
219 @ivar skip_checks: steps to be skipped from the verify process; this
220 needs to be a subset of
221 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
222 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
225 OP_ID = "OP_CLUSTER_VERIFY"
226 __slots__ = ["skip_checks", "verbose", "error_codes",
227 "debug_simulate_errors"]
230 class OpVerifyDisks(OpCode):
231 """Verify the cluster disks.
235 Result: a tuple of four elements:
236 - list of node names with bad data returned (unreachable, etc.)
237 - dict of node names with broken volume groups (values: error msg)
238 - list of instances with degraded disks (that should be activated)
239 - dict of instances with missing logical volumes (values: (node, vol)
240 pairs with details about the missing volumes)
242 In normal operation, all lists should be empty. A non-empty instance
243 list (3rd element of the result) is still ok (errors were fixed) but
244 non-empty node list means some node is down, and probably there are
245 unfixable drbd errors.
247 Note that only instances that are drbd-based are taken into
248 consideration. This might need to be revisited in the future.
251 OP_ID = "OP_CLUSTER_VERIFY_DISKS"
255 class OpRepairDiskSizes(OpCode):
256 """Verify the disk sizes of the instances and fixes configuration
259 Parameters: optional instances list, in case we want to restrict the
260 checks to only a subset of the instances.
262 Result: a list of tuples, (instance, disk, new-size) for changed
265 In normal operation, the list should be empty.
267 @type instances: list
268 @ivar instances: the list of instances to check, or empty for all instances
271 OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
272 __slots__ = ["instances"]
275 class OpQueryConfigValues(OpCode):
276 """Query cluster configuration values."""
277 OP_ID = "OP_CLUSTER_CONFIG_QUERY"
278 __slots__ = ["output_fields"]
281 class OpRenameCluster(OpCode):
282 """Rename the cluster.
285 @ivar name: The new name of the cluster. The name and/or the master IP
286 address will be changed to match the new name and its IP
290 OP_ID = "OP_CLUSTER_RENAME"
291 OP_DSC_FIELD = "name"
295 class OpSetClusterParams(OpCode):
296 """Change the parameters of the cluster.
298 @type vg_name: C{str} or C{None}
299 @ivar vg_name: The new volume group name or None to disable LVM usage.
302 OP_ID = "OP_CLUSTER_SET_PARAMS"
306 "enabled_hypervisors",
312 "candidate_pool_size",
313 "maintain_node_health",
317 "default_iallocator",
321 "prealloc_wipe_disks",
325 class OpRedistributeConfig(OpCode):
326 """Force a full push of the cluster configuration.
329 OP_ID = "OP_CLUSTER_REDIST_CONF"
334 class OpRemoveNode(OpCode):
337 @type node_name: C{str}
338 @ivar node_name: The name of the node to remove. If the node still has
339 instances on it, the operation will fail.
342 OP_ID = "OP_NODE_REMOVE"
343 OP_DSC_FIELD = "node_name"
344 __slots__ = ["node_name"]
347 class OpAddNode(OpCode):
348 """Add a node to the cluster.
350 @type node_name: C{str}
351 @ivar node_name: The name of the node to add. This can be a short name,
352 but it will be expanded to the FQDN.
353 @type primary_ip: IP address
354 @ivar primary_ip: The primary IP of the node. This will be ignored when the
355 opcode is submitted, but will be filled during the node
356 add (so it will be visible in the job query).
357 @type secondary_ip: IP address
358 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
359 if the cluster has been initialized in 'dual-network'
360 mode, otherwise it must not be given.
362 @ivar readd: Whether to re-add an existing node to the cluster. If
363 this is not passed, then the operation will abort if the node
364 name is already in the cluster; use this parameter to 'repair'
365 a node that had its configuration broken, or was reinstalled
366 without removal from the cluster.
368 @ivar group: The node group to which this node will belong.
369 @type vm_capable: C{bool}
370 @ivar vm_capable: The vm_capable node attribute
371 @type master_capable: C{bool}
372 @ivar master_capable: The master_capable node attribute
375 OP_ID = "OP_NODE_ADD"
376 OP_DSC_FIELD = "node_name"
377 __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd", "group",
378 "vm_capable", "master_capable"]
381 class OpQueryNodes(OpCode):
382 """Compute the list of nodes."""
383 OP_ID = "OP_NODE_QUERY"
384 __slots__ = ["output_fields", "names", "use_locking"]
387 class OpQueryNodeVolumes(OpCode):
388 """Get list of volumes on node."""
389 OP_ID = "OP_NODE_QUERYVOLS"
390 __slots__ = ["nodes", "output_fields"]
393 class OpQueryNodeStorage(OpCode):
394 """Get information on storage for node(s)."""
395 OP_ID = "OP_NODE_QUERY_STORAGE"
404 class OpModifyNodeStorage(OpCode):
405 """Modifies the properies of a storage unit"""
406 OP_ID = "OP_NODE_MODIFY_STORAGE"
415 class OpRepairNodeStorage(OpCode):
416 """Repairs the volume group on a node."""
417 OP_ID = "OP_REPAIR_NODE_STORAGE"
418 OP_DSC_FIELD = "node_name"
423 "ignore_consistency",
427 class OpSetNodeParams(OpCode):
428 """Change the parameters of a node."""
429 OP_ID = "OP_NODE_SET_PARAMS"
430 OP_DSC_FIELD = "node_name"
443 class OpPowercycleNode(OpCode):
444 """Tries to powercycle a node."""
445 OP_ID = "OP_NODE_POWERCYCLE"
446 OP_DSC_FIELD = "node_name"
453 class OpMigrateNode(OpCode):
454 """Migrate all instances from a node."""
455 OP_ID = "OP_NODE_MIGRATE"
456 OP_DSC_FIELD = "node_name"
464 class OpNodeEvacuationStrategy(OpCode):
465 """Compute the evacuation strategy for a list of nodes."""
466 OP_ID = "OP_NODE_EVAC_STRATEGY"
467 OP_DSC_FIELD = "nodes"
468 __slots__ = ["nodes", "iallocator", "remote_node"]
473 class OpCreateInstance(OpCode):
474 """Create an instance.
476 @ivar instance_name: Instance name
477 @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
478 @ivar source_handshake: Signed handshake from source (remote import only)
479 @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
480 @ivar source_instance_name: Previous name of instance (remote import only)
483 OP_ID = "OP_INSTANCE_CREATE"
484 OP_DSC_FIELD = "instance_name"
487 "os_type", "force_variant", "no_install",
488 "pnode", "disk_template", "snode", "mode",
490 "src_node", "src_path", "start", "identify_defaults",
491 "wait_for_sync", "ip_check", "name_check",
492 "file_storage_dir", "file_driver",
494 "hypervisor", "hvparams", "beparams", "osparams",
497 "source_instance_name",
501 class OpReinstallInstance(OpCode):
502 """Reinstall an instance's OS."""
503 OP_ID = "OP_INSTANCE_REINSTALL"
504 OP_DSC_FIELD = "instance_name"
505 __slots__ = ["instance_name", "os_type", "force_variant", "osparams"]
508 class OpRemoveInstance(OpCode):
509 """Remove an instance."""
510 OP_ID = "OP_INSTANCE_REMOVE"
511 OP_DSC_FIELD = "instance_name"
519 class OpRenameInstance(OpCode):
520 """Rename an instance."""
521 OP_ID = "OP_INSTANCE_RENAME"
523 "instance_name", "ip_check", "new_name", "name_check",
527 class OpStartupInstance(OpCode):
528 """Startup an instance."""
529 OP_ID = "OP_INSTANCE_STARTUP"
530 OP_DSC_FIELD = "instance_name"
532 "instance_name", "force", "hvparams", "beparams", "ignore_offline_nodes",
536 class OpShutdownInstance(OpCode):
537 """Shutdown an instance."""
538 OP_ID = "OP_INSTANCE_SHUTDOWN"
539 OP_DSC_FIELD = "instance_name"
541 "instance_name", "timeout", "ignore_offline_nodes",
545 class OpRebootInstance(OpCode):
546 """Reboot an instance."""
547 OP_ID = "OP_INSTANCE_REBOOT"
548 OP_DSC_FIELD = "instance_name"
550 "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
554 class OpReplaceDisks(OpCode):
555 """Replace the disks of an instance."""
556 OP_ID = "OP_INSTANCE_REPLACE_DISKS"
557 OP_DSC_FIELD = "instance_name"
559 "instance_name", "remote_node", "mode", "disks", "iallocator",
564 class OpFailoverInstance(OpCode):
565 """Failover an instance."""
566 OP_ID = "OP_INSTANCE_FAILOVER"
567 OP_DSC_FIELD = "instance_name"
569 "instance_name", "ignore_consistency", "shutdown_timeout",
573 class OpMigrateInstance(OpCode):
574 """Migrate an instance.
576 This migrates (without shutting down an instance) to its secondary
579 @ivar instance_name: the name of the instance
580 @ivar mode: the migration mode (live, non-live or None for auto)
583 OP_ID = "OP_INSTANCE_MIGRATE"
584 OP_DSC_FIELD = "instance_name"
585 __slots__ = ["instance_name", "mode", "cleanup", "live"]
588 class OpMoveInstance(OpCode):
591 This move (with shutting down an instance and data copying) to an
594 @ivar instance_name: the name of the instance
595 @ivar target_node: the destination node
598 OP_ID = "OP_INSTANCE_MOVE"
599 OP_DSC_FIELD = "instance_name"
601 "instance_name", "target_node", "shutdown_timeout",
605 class OpConnectConsole(OpCode):
606 """Connect to an instance's console."""
607 OP_ID = "OP_INSTANCE_CONSOLE"
608 OP_DSC_FIELD = "instance_name"
609 __slots__ = ["instance_name"]
612 class OpActivateInstanceDisks(OpCode):
613 """Activate an instance's disks."""
614 OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
615 OP_DSC_FIELD = "instance_name"
616 __slots__ = ["instance_name", "ignore_size"]
619 class OpDeactivateInstanceDisks(OpCode):
620 """Deactivate an instance's disks."""
621 OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
622 OP_DSC_FIELD = "instance_name"
623 __slots__ = ["instance_name"]
626 class OpRecreateInstanceDisks(OpCode):
627 """Deactivate an instance's disks."""
628 OP_ID = "OP_INSTANCE_RECREATE_DISKS"
629 OP_DSC_FIELD = "instance_name"
630 __slots__ = ["instance_name", "disks"]
633 class OpQueryInstances(OpCode):
634 """Compute the list of instances."""
635 OP_ID = "OP_INSTANCE_QUERY"
636 __slots__ = ["output_fields", "names", "use_locking"]
639 class OpQueryInstanceData(OpCode):
640 """Compute the run-time status of instances."""
641 OP_ID = "OP_INSTANCE_QUERY_DATA"
642 __slots__ = ["instances", "static"]
645 class OpSetInstanceParams(OpCode):
646 """Change the parameters of an instance."""
647 OP_ID = "OP_INSTANCE_SET_PARAMS"
648 OP_DSC_FIELD = "instance_name"
651 "hvparams", "beparams", "osparams", "force",
652 "nics", "disks", "disk_template",
653 "remote_node", "os_name", "force_variant",
657 class OpGrowDisk(OpCode):
658 """Grow a disk of an instance."""
659 OP_ID = "OP_INSTANCE_GROW_DISK"
660 OP_DSC_FIELD = "instance_name"
662 "instance_name", "disk", "amount", "wait_for_sync",
667 class OpDiagnoseOS(OpCode):
668 """Compute the list of guest operating systems."""
669 OP_ID = "OP_OS_DIAGNOSE"
670 __slots__ = ["output_fields", "names"]
674 class OpQueryExports(OpCode):
675 """Compute the list of exported images."""
676 OP_ID = "OP_BACKUP_QUERY"
677 __slots__ = ["nodes", "use_locking"]
680 class OpPrepareExport(OpCode):
681 """Prepares an instance export.
683 @ivar instance_name: Instance name
684 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
687 OP_ID = "OP_BACKUP_PREPARE"
688 OP_DSC_FIELD = "instance_name"
690 "instance_name", "mode",
694 class OpExportInstance(OpCode):
695 """Export an instance.
697 For local exports, the export destination is the node name. For remote
698 exports, the export destination is a list of tuples, each consisting of
699 hostname/IP address, port, HMAC and HMAC salt. The HMAC is calculated using
700 the cluster domain secret over the value "${index}:${hostname}:${port}". The
701 destination X509 CA must be a signed certificate.
703 @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
704 @ivar target_node: Export destination
705 @ivar x509_key_name: X509 key to use (remote export only)
706 @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
710 OP_ID = "OP_BACKUP_EXPORT"
711 OP_DSC_FIELD = "instance_name"
713 # TODO: Rename target_node as it changes meaning for different export modes
714 # (e.g. "destination")
715 "instance_name", "target_node", "shutdown", "shutdown_timeout",
717 "ignore_remove_failures",
720 "destination_x509_ca",
724 class OpRemoveExport(OpCode):
725 """Remove an instance's export."""
726 OP_ID = "OP_BACKUP_REMOVE"
727 OP_DSC_FIELD = "instance_name"
728 __slots__ = ["instance_name"]
732 class OpGetTags(OpCode):
733 """Returns the tags of the given object."""
734 OP_ID = "OP_TAGS_GET"
735 OP_DSC_FIELD = "name"
736 __slots__ = ["kind", "name"]
739 class OpSearchTags(OpCode):
740 """Searches the tags in the cluster for a given pattern."""
741 OP_ID = "OP_TAGS_SEARCH"
742 OP_DSC_FIELD = "pattern"
743 __slots__ = ["pattern"]
746 class OpAddTags(OpCode):
747 """Add a list of tags on a given object."""
748 OP_ID = "OP_TAGS_SET"
749 __slots__ = ["kind", "name", "tags"]
752 class OpDelTags(OpCode):
753 """Remove a list of tags from a given object."""
754 OP_ID = "OP_TAGS_DEL"
755 __slots__ = ["kind", "name", "tags"]
759 class OpTestDelay(OpCode):
760 """Sleeps for a configured amount of time.
762 This is used just for debugging and testing.
765 - duration: the time to sleep
766 - on_master: if true, sleep on the master
767 - on_nodes: list of nodes in which to sleep
769 If the on_master parameter is true, it will execute a sleep on the
770 master (before any node sleep).
772 If the on_nodes list is not empty, it will sleep on those nodes
773 (after the sleep on the master, if that is enabled).
775 As an additional feature, the case of duration < 0 will be reported
776 as an execution error, so this opcode can be used as a failure
777 generator. The case of duration == 0 will not be treated specially.
780 OP_ID = "OP_TEST_DELAY"
781 OP_DSC_FIELD = "duration"
782 __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
785 class OpTestAllocator(OpCode):
786 """Allocator framework testing.
788 This opcode has two modes:
789 - gather and return allocator input for a given mode (allocate new
790 or replace secondary) and a given instance definition (direction
792 - run a selected allocator for a given operation (as above) and
793 return the allocator output (direction 'out')
796 OP_ID = "OP_TEST_ALLOCATOR"
797 OP_DSC_FIELD = "allocator"
799 "direction", "mode", "allocator", "name",
800 "mem_size", "disks", "disk_template",
801 "os", "tags", "nics", "vcpus", "hypervisor",
806 class OpTestJobqueue(OpCode):
807 """Utility opcode to test some aspects of the job queue.
810 OP_ID = "OP_TEST_JQUEUE"
819 class OpTestDummy(OpCode):
820 """Utility opcode used by unittests.
823 OP_ID = "OP_TEST_DUMMY"
831 OP_MAPPING = dict([(v.OP_ID, v) for v in globals().values()
832 if (isinstance(v, type) and issubclass(v, OpCode) and
833 hasattr(v, "OP_ID"))])