4 # Copyright (C) 2006, 2007 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.
56 if key not in self.__slots__:
57 raise TypeError("Object %s doesn't support the parameter '%s'" %
58 (self.__class__.__name__, key))
59 setattr(self, key, kwargs[key])
61 def __getstate__(self):
62 """Generic serializer.
64 This method just returns the contents of the instance as a
68 @return: the instance attributes and their values
72 for name in self.__slots__:
73 if hasattr(self, name):
74 state[name] = getattr(self, name)
77 def __setstate__(self, state):
78 """Generic unserializer.
80 This method just restores from the serialized state the attributes
81 of the current instance.
83 @param state: the serialized opcode data
87 if not isinstance(state, dict):
88 raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
91 for name in self.__slots__:
96 setattr(self, name, state[name])
99 class OpCode(BaseOpCode):
102 This is the root of the actual OpCode hierarchy. All clases derived
103 from this class should override OP_ID.
105 @cvar OP_ID: The ID of this opcode. This should be unique amongst all
106 children of this class.
107 @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
111 OP_ID = "OP_ABSTRACT"
112 __slots__ = BaseOpCode.__slots__ + ["dry_run"]
114 def __getstate__(self):
115 """Specialized getstate for opcodes.
117 This method adds to the state dictionary the OP_ID of the class,
118 so that on unload we can identify the correct class for
119 instantiating the opcode.
122 @return: the state as a dictionary
125 data = BaseOpCode.__getstate__(self)
126 data["OP_ID"] = self.OP_ID
130 def LoadOpCode(cls, data):
131 """Generic load opcode method.
133 The method identifies the correct opcode class from the dict-form
134 by looking for a OP_ID key, if this is not found, or its value is
135 not available in this module as a child of this class, we fail.
138 @param data: the serialized opcode
141 if not isinstance(data, dict):
142 raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
143 if "OP_ID" not in data:
144 raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
145 op_id = data["OP_ID"]
147 if op_id in OP_MAPPING:
148 op_class = OP_MAPPING[op_id]
150 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
153 new_data = data.copy()
154 del new_data["OP_ID"]
155 op.__setstate__(new_data)
159 """Generates a summary description of this opcode.
162 # all OP_ID start with OP_, we remove that
164 field_name = getattr(self, "OP_DSC_FIELD", None)
166 field_value = getattr(self, field_name, None)
167 txt = "%s(%s)" % (txt, field_value)
173 class OpPostInitCluster(OpCode):
174 """Post cluster initialization.
176 This opcode does not touch the cluster at all. Its purpose is to run hooks
177 after the cluster has been initialized.
180 OP_ID = "OP_CLUSTER_POST_INIT"
181 __slots__ = OpCode.__slots__ + []
184 class OpDestroyCluster(OpCode):
185 """Destroy the cluster.
187 This opcode has no other parameters. All the state is irreversibly
188 lost after the execution of this opcode.
191 OP_ID = "OP_CLUSTER_DESTROY"
192 __slots__ = OpCode.__slots__ + []
195 class OpQueryClusterInfo(OpCode):
196 """Query cluster information."""
197 OP_ID = "OP_CLUSTER_QUERY"
198 __slots__ = OpCode.__slots__ + []
201 class OpVerifyCluster(OpCode):
202 """Verify the cluster state.
204 @type skip_checks: C{list}
205 @ivar skip_checks: steps to be skipped from the verify process; this
206 needs to be a subset of
207 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
208 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
211 OP_ID = "OP_CLUSTER_VERIFY"
212 __slots__ = OpCode.__slots__ + ["skip_checks", "verbose", "error_codes",
213 "debug_simulate_errors"]
216 class OpVerifyDisks(OpCode):
217 """Verify the cluster disks.
221 Result: a tuple of four elements:
222 - list of node names with bad data returned (unreachable, etc.)
223 - dict of node names with broken volume groups (values: error msg)
224 - list of instances with degraded disks (that should be activated)
225 - dict of instances with missing logical volumes (values: (node, vol)
226 pairs with details about the missing volumes)
228 In normal operation, all lists should be empty. A non-empty instance
229 list (3rd element of the result) is still ok (errors were fixed) but
230 non-empty node list means some node is down, and probably there are
231 unfixable drbd errors.
233 Note that only instances that are drbd-based are taken into
234 consideration. This might need to be revisited in the future.
237 OP_ID = "OP_CLUSTER_VERIFY_DISKS"
238 __slots__ = OpCode.__slots__ + []
241 class OpRepairDiskSizes(OpCode):
242 """Verify the disk sizes of the instances and fixes configuration
245 Parameters: optional instances list, in case we want to restrict the
246 checks to only a subset of the instances.
248 Result: a list of tuples, (instance, disk, new-size) for changed
251 In normal operation, the list should be empty.
253 @type instances: list
254 @ivar instances: the list of instances to check, or empty for all instances
257 OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
258 __slots__ = ["instances"]
261 class OpQueryConfigValues(OpCode):
262 """Query cluster configuration values."""
263 OP_ID = "OP_CLUSTER_CONFIG_QUERY"
264 __slots__ = OpCode.__slots__ + ["output_fields"]
267 class OpRenameCluster(OpCode):
268 """Rename the cluster.
271 @ivar name: The new name of the cluster. The name and/or the master IP
272 address will be changed to match the new name and its IP
276 OP_ID = "OP_CLUSTER_RENAME"
277 OP_DSC_FIELD = "name"
278 __slots__ = OpCode.__slots__ + ["name"]
281 class OpSetClusterParams(OpCode):
282 """Change the parameters of the cluster.
284 @type vg_name: C{str} or C{None}
285 @ivar vg_name: The new volume group name or None to disable LVM usage.
288 OP_ID = "OP_CLUSTER_SET_PARAMS"
289 __slots__ = OpCode.__slots__ + [
291 "enabled_hypervisors",
295 "candidate_pool_size",
299 class OpRedistributeConfig(OpCode):
300 """Force a full push of the cluster configuration.
303 OP_ID = "OP_CLUSTER_REDIST_CONF"
304 __slots__ = OpCode.__slots__ + [
309 class OpRemoveNode(OpCode):
312 @type node_name: C{str}
313 @ivar node_name: The name of the node to remove. If the node still has
314 instances on it, the operation will fail.
317 OP_ID = "OP_NODE_REMOVE"
318 OP_DSC_FIELD = "node_name"
319 __slots__ = OpCode.__slots__ + ["node_name"]
322 class OpAddNode(OpCode):
323 """Add a node to the cluster.
325 @type node_name: C{str}
326 @ivar node_name: The name of the node to add. This can be a short name,
327 but it will be expanded to the FQDN.
328 @type primary_ip: IP address
329 @ivar primary_ip: The primary IP of the node. This will be ignored when the
330 opcode is submitted, but will be filled during the node
331 add (so it will be visible in the job query).
332 @type secondary_ip: IP address
333 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
334 if the cluster has been initialized in 'dual-network'
335 mode, otherwise it must not be given.
337 @ivar readd: Whether to re-add an existing node to the cluster. If
338 this is not passed, then the operation will abort if the node
339 name is already in the cluster; use this parameter to 'repair'
340 a node that had its configuration broken, or was reinstalled
341 without removal from the cluster.
344 OP_ID = "OP_NODE_ADD"
345 OP_DSC_FIELD = "node_name"
346 __slots__ = OpCode.__slots__ + [
347 "node_name", "primary_ip", "secondary_ip", "readd",
351 class OpQueryNodes(OpCode):
352 """Compute the list of nodes."""
353 OP_ID = "OP_NODE_QUERY"
354 __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
357 class OpQueryNodeVolumes(OpCode):
358 """Get list of volumes on node."""
359 OP_ID = "OP_NODE_QUERYVOLS"
360 __slots__ = OpCode.__slots__ + ["nodes", "output_fields"]
363 class OpQueryNodeStorage(OpCode):
364 """Get information on storage for node(s)."""
365 OP_ID = "OP_NODE_QUERY_STORAGE"
366 __slots__ = OpCode.__slots__ + [
374 class OpModifyNodeStorage(OpCode):
376 OP_ID = "OP_NODE_MODIFY_STORAGE"
377 __slots__ = OpCode.__slots__ + [
385 class OpRepairNodeStorage(OpCode):
386 """Repairs the volume group on a node."""
387 OP_ID = "OP_REPAIR_NODE_STORAGE"
388 OP_DSC_FIELD = "node_name"
389 __slots__ = OpCode.__slots__ + [
396 class OpSetNodeParams(OpCode):
397 """Change the parameters of a node."""
398 OP_ID = "OP_NODE_SET_PARAMS"
399 OP_DSC_FIELD = "node_name"
400 __slots__ = OpCode.__slots__ + [
409 class OpPowercycleNode(OpCode):
410 """Tries to powercycle a node."""
411 OP_ID = "OP_NODE_POWERCYCLE"
412 OP_DSC_FIELD = "node_name"
413 __slots__ = OpCode.__slots__ + [
419 class OpEvacuateNode(OpCode):
420 """Relocate secondary instances from a node."""
421 OP_ID = "OP_NODE_EVACUATE"
422 OP_DSC_FIELD = "node_name"
423 __slots__ = OpCode.__slots__ + [
424 "node_name", "remote_node", "iallocator",
428 class OpMigrateNode(OpCode):
429 """Migrate all instances from a node."""
430 OP_ID = "OP_NODE_MIGRATE"
431 OP_DSC_FIELD = "node_name"
432 __slots__ = OpCode.__slots__ + [
440 class OpCreateInstance(OpCode):
441 """Create an instance."""
442 OP_ID = "OP_INSTANCE_CREATE"
443 OP_DSC_FIELD = "instance_name"
444 __slots__ = OpCode.__slots__ + [
445 "instance_name", "os_type", "force_variant",
446 "pnode", "disk_template", "snode", "mode",
448 "src_node", "src_path", "start",
449 "wait_for_sync", "ip_check",
450 "file_storage_dir", "file_driver",
452 "hypervisor", "hvparams", "beparams",
457 class OpReinstallInstance(OpCode):
458 """Reinstall an instance's OS."""
459 OP_ID = "OP_INSTANCE_REINSTALL"
460 OP_DSC_FIELD = "instance_name"
461 __slots__ = OpCode.__slots__ + ["instance_name", "os_type", "force_variant"]
464 class OpRemoveInstance(OpCode):
465 """Remove an instance."""
466 OP_ID = "OP_INSTANCE_REMOVE"
467 OP_DSC_FIELD = "instance_name"
468 __slots__ = OpCode.__slots__ + [
475 class OpRenameInstance(OpCode):
476 """Rename an instance."""
477 OP_ID = "OP_INSTANCE_RENAME"
478 __slots__ = OpCode.__slots__ + [
479 "instance_name", "ignore_ip", "new_name",
483 class OpStartupInstance(OpCode):
484 """Startup an instance."""
485 OP_ID = "OP_INSTANCE_STARTUP"
486 OP_DSC_FIELD = "instance_name"
487 __slots__ = OpCode.__slots__ + [
488 "instance_name", "force", "hvparams", "beparams",
492 class OpShutdownInstance(OpCode):
493 """Shutdown an instance."""
494 OP_ID = "OP_INSTANCE_SHUTDOWN"
495 OP_DSC_FIELD = "instance_name"
496 __slots__ = OpCode.__slots__ + ["instance_name", "timeout"]
499 class OpRebootInstance(OpCode):
500 """Reboot an instance."""
501 OP_ID = "OP_INSTANCE_REBOOT"
502 OP_DSC_FIELD = "instance_name"
503 __slots__ = OpCode.__slots__ + [
504 "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
508 class OpReplaceDisks(OpCode):
509 """Replace the disks of an instance."""
510 OP_ID = "OP_INSTANCE_REPLACE_DISKS"
511 OP_DSC_FIELD = "instance_name"
512 __slots__ = OpCode.__slots__ + [
513 "instance_name", "remote_node", "mode", "disks", "iallocator",
517 class OpFailoverInstance(OpCode):
518 """Failover an instance."""
519 OP_ID = "OP_INSTANCE_FAILOVER"
520 OP_DSC_FIELD = "instance_name"
521 __slots__ = OpCode.__slots__ + [
522 "instance_name", "ignore_consistency", "shutdown_timeout",
526 class OpMigrateInstance(OpCode):
527 """Migrate an instance.
529 This migrates (without shutting down an instance) to its secondary
532 @ivar instance_name: the name of the instance
535 OP_ID = "OP_INSTANCE_MIGRATE"
536 OP_DSC_FIELD = "instance_name"
537 __slots__ = OpCode.__slots__ + ["instance_name", "live", "cleanup"]
540 class OpMoveInstance(OpCode):
543 This move (with shutting down an instance and data copying) to an
546 @ivar instance_name: the name of the instance
547 @ivar target_node: the destination node
550 OP_ID = "OP_INSTANCE_MOVE"
551 OP_DSC_FIELD = "instance_name"
552 __slots__ = OpCode.__slots__ + [
553 "instance_name", "target_node", "shutdown_timeout",
557 class OpConnectConsole(OpCode):
558 """Connect to an instance's console."""
559 OP_ID = "OP_INSTANCE_CONSOLE"
560 OP_DSC_FIELD = "instance_name"
561 __slots__ = OpCode.__slots__ + ["instance_name"]
564 class OpActivateInstanceDisks(OpCode):
565 """Activate an instance's disks."""
566 OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
567 OP_DSC_FIELD = "instance_name"
568 __slots__ = OpCode.__slots__ + ["instance_name", "ignore_size"]
571 class OpDeactivateInstanceDisks(OpCode):
572 """Deactivate an instance's disks."""
573 OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
574 OP_DSC_FIELD = "instance_name"
575 __slots__ = OpCode.__slots__ + ["instance_name"]
578 class OpRecreateInstanceDisks(OpCode):
579 """Deactivate an instance's disks."""
580 OP_ID = "OP_INSTANCE_RECREATE_DISKS"
581 OP_DSC_FIELD = "instance_name"
582 __slots__ = OpCode.__slots__ + ["instance_name", "disks"]
585 class OpQueryInstances(OpCode):
586 """Compute the list of instances."""
587 OP_ID = "OP_INSTANCE_QUERY"
588 __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
591 class OpQueryInstanceData(OpCode):
592 """Compute the run-time status of instances."""
593 OP_ID = "OP_INSTANCE_QUERY_DATA"
594 __slots__ = OpCode.__slots__ + ["instances", "static"]
597 class OpSetInstanceParams(OpCode):
598 """Change the parameters of an instance."""
599 OP_ID = "OP_INSTANCE_SET_PARAMS"
600 OP_DSC_FIELD = "instance_name"
601 __slots__ = OpCode.__slots__ + [
603 "hvparams", "beparams", "force",
608 class OpGrowDisk(OpCode):
609 """Grow a disk of an instance."""
610 OP_ID = "OP_INSTANCE_GROW_DISK"
611 OP_DSC_FIELD = "instance_name"
612 __slots__ = OpCode.__slots__ + [
613 "instance_name", "disk", "amount", "wait_for_sync",
618 class OpDiagnoseOS(OpCode):
619 """Compute the list of guest operating systems."""
620 OP_ID = "OP_OS_DIAGNOSE"
621 __slots__ = OpCode.__slots__ + ["output_fields", "names"]
625 class OpQueryExports(OpCode):
626 """Compute the list of exported images."""
627 OP_ID = "OP_BACKUP_QUERY"
628 __slots__ = OpCode.__slots__ + ["nodes", "use_locking"]
631 class OpExportInstance(OpCode):
632 """Export an instance."""
633 OP_ID = "OP_BACKUP_EXPORT"
634 OP_DSC_FIELD = "instance_name"
635 __slots__ = OpCode.__slots__ + [
636 "instance_name", "target_node", "shutdown", "shutdown_timeout",
640 class OpRemoveExport(OpCode):
641 """Remove an instance's export."""
642 OP_ID = "OP_BACKUP_REMOVE"
643 OP_DSC_FIELD = "instance_name"
644 __slots__ = OpCode.__slots__ + ["instance_name"]
648 class OpGetTags(OpCode):
649 """Returns the tags of the given object."""
650 OP_ID = "OP_TAGS_GET"
651 OP_DSC_FIELD = "name"
652 __slots__ = OpCode.__slots__ + ["kind", "name"]
655 class OpSearchTags(OpCode):
656 """Searches the tags in the cluster for a given pattern."""
657 OP_ID = "OP_TAGS_SEARCH"
658 OP_DSC_FIELD = "pattern"
659 __slots__ = OpCode.__slots__ + ["pattern"]
662 class OpAddTags(OpCode):
663 """Add a list of tags on a given object."""
664 OP_ID = "OP_TAGS_SET"
665 __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
668 class OpDelTags(OpCode):
669 """Remove a list of tags from a given object."""
670 OP_ID = "OP_TAGS_DEL"
671 __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
675 class OpTestDelay(OpCode):
676 """Sleeps for a configured amount of time.
678 This is used just for debugging and testing.
681 - duration: the time to sleep
682 - on_master: if true, sleep on the master
683 - on_nodes: list of nodes in which to sleep
685 If the on_master parameter is true, it will execute a sleep on the
686 master (before any node sleep).
688 If the on_nodes list is not empty, it will sleep on those nodes
689 (after the sleep on the master, if that is enabled).
691 As an additional feature, the case of duration < 0 will be reported
692 as an execution error, so this opcode can be used as a failure
693 generator. The case of duration == 0 will not be treated specially.
696 OP_ID = "OP_TEST_DELAY"
697 OP_DSC_FIELD = "duration"
698 __slots__ = OpCode.__slots__ + ["duration", "on_master", "on_nodes"]
701 class OpTestAllocator(OpCode):
702 """Allocator framework testing.
704 This opcode has two modes:
705 - gather and return allocator input for a given mode (allocate new
706 or replace secondary) and a given instance definition (direction
708 - run a selected allocator for a given operation (as above) and
709 return the allocator output (direction 'out')
712 OP_ID = "OP_TEST_ALLOCATOR"
713 OP_DSC_FIELD = "allocator"
714 __slots__ = OpCode.__slots__ + [
715 "direction", "mode", "allocator", "name",
716 "mem_size", "disks", "disk_template",
717 "os", "tags", "nics", "vcpus", "hypervisor",
721 OP_MAPPING = dict([(v.OP_ID, v) for v in globals().values()
722 if (isinstance(v, type) and issubclass(v, OpCode) and
723 hasattr(v, "OP_ID"))])