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 childre of this class.
109 OP_ID = "OP_ABSTRACT"
112 def __getstate__(self):
113 """Specialized getstate for opcodes.
115 This method adds to the state dictionary the OP_ID of the class,
116 so that on unload we can identify the correct class for
117 instantiating the opcode.
120 @return: the state as a dictionary
123 data = BaseOpCode.__getstate__(self)
124 data["OP_ID"] = self.OP_ID
128 def LoadOpCode(cls, data):
129 """Generic load opcode method.
131 The method identifies the correct opcode class from the dict-form
132 by looking for a OP_ID key, if this is not found, or its value is
133 not available in this module as a child of this class, we fail.
136 @param data: the serialized opcode
139 if not isinstance(data, dict):
140 raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
141 if "OP_ID" not in data:
142 raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
143 op_id = data["OP_ID"]
145 if op_id in OP_MAPPING:
146 op_class = OP_MAPPING[op_id]
148 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
151 new_data = data.copy()
152 del new_data["OP_ID"]
153 op.__setstate__(new_data)
157 """Generates a summary description of this opcode.
160 # all OP_ID start with OP_, we remove that
162 field_name = getattr(self, "OP_DSC_FIELD", None)
164 field_value = getattr(self, field_name, None)
165 txt = "%s(%s)" % (txt, field_value)
171 class OpDestroyCluster(OpCode):
172 """Destroy the cluster.
174 This opcode has no other parameters. All the state is irreversibly
175 lost after the execution of this opcode.
178 OP_ID = "OP_CLUSTER_DESTROY"
182 class OpQueryClusterInfo(OpCode):
183 """Query cluster information."""
184 OP_ID = "OP_CLUSTER_QUERY"
188 class OpVerifyCluster(OpCode):
189 """Verify the cluster state.
191 @type skip_checks: C{list}
192 @ivar skip_checks: steps to be skipped from the verify process; this
193 needs to be a subset of
194 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
195 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
198 OP_ID = "OP_CLUSTER_VERIFY"
199 __slots__ = ["skip_checks"]
202 class OpVerifyDisks(OpCode):
203 """Verify the cluster disks.
207 Result: a tuple of four elements:
208 - list of node names with bad data returned (unreachable, etc.)
209 - dict of node names with broken volume groups (values: error msg)
210 - list of instances with degraded disks (that should be activated)
211 - dict of instances with missing logical volumes (values: (node, vol)
212 pairs with details about the missing volumes)
214 In normal operation, all lists should be empty. A non-empty instance
215 list (3rd element of the result) is still ok (errors were fixed) but
216 non-empty node list means some node is down, and probably there are
217 unfixable drbd errors.
219 Note that only instances that are drbd-based are taken into
220 consideration. This might need to be revisited in the future.
223 OP_ID = "OP_CLUSTER_VERIFY_DISKS"
227 class OpRepairDiskSizes(OpCode):
228 """Verify the disk sizes of the instances and fixes configuration
231 Parameters: optional instances list, in case we want to restrict the
232 checks to only a subset of the instances.
234 Result: a list of tuples, (instance, disk, new-size) for changed
237 In normal operation, the list should be empty.
239 @type instances: list
240 @ivar instances: the list of instances to check, or empty for all instances
243 OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
244 __slots__ = ["instances"]
247 class OpQueryConfigValues(OpCode):
248 """Query cluster configuration values."""
249 OP_ID = "OP_CLUSTER_CONFIG_QUERY"
250 __slots__ = ["output_fields"]
253 class OpRenameCluster(OpCode):
254 """Rename the cluster.
257 @ivar name: The new name of the cluster. The name and/or the master IP
258 address will be changed to match the new name and its IP
262 OP_ID = "OP_CLUSTER_RENAME"
263 OP_DSC_FIELD = "name"
267 class OpSetClusterParams(OpCode):
268 """Change the parameters of the cluster.
270 @type vg_name: C{str} or C{None}
271 @ivar vg_name: The new volume group name or None to disable LVM usage.
274 OP_ID = "OP_CLUSTER_SET_PARAMS"
277 "enabled_hypervisors",
280 "candidate_pool_size",
284 class OpRedistributeConfig(OpCode):
285 """Force a full push of the cluster configuration.
288 OP_ID = "OP_CLUSTER_REDIST_CONF"
294 class OpRemoveNode(OpCode):
297 @type node_name: C{str}
298 @ivar node_name: The name of the node to remove. If the node still has
299 instances on it, the operation will fail.
302 OP_ID = "OP_NODE_REMOVE"
303 OP_DSC_FIELD = "node_name"
304 __slots__ = ["node_name"]
307 class OpAddNode(OpCode):
308 """Add a node to the cluster.
310 @type node_name: C{str}
311 @ivar node_name: The name of the node to add. This can be a short name,
312 but it will be expanded to the FQDN.
313 @type primary_ip: IP address
314 @ivar primary_ip: The primary IP of the node. This will be ignored when the
315 opcode is submitted, but will be filled during the node
316 add (so it will be visible in the job query).
317 @type secondary_ip: IP address
318 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
319 if the cluster has been initialized in 'dual-network'
320 mode, otherwise it must not be given.
322 @ivar readd: Whether to re-add an existing node to the cluster. If
323 this is not passed, then the operation will abort if the node
324 name is already in the cluster; use this parameter to 'repair'
325 a node that had its configuration broken, or was reinstalled
326 without removal from the cluster.
329 OP_ID = "OP_NODE_ADD"
330 OP_DSC_FIELD = "node_name"
331 __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
334 class OpQueryNodes(OpCode):
335 """Compute the list of nodes."""
336 OP_ID = "OP_NODE_QUERY"
337 __slots__ = ["output_fields", "names", "use_locking"]
340 class OpQueryNodeVolumes(OpCode):
341 """Get list of volumes on node."""
342 OP_ID = "OP_NODE_QUERYVOLS"
343 __slots__ = ["nodes", "output_fields"]
346 class OpSetNodeParams(OpCode):
347 """Change the parameters of a node."""
348 OP_ID = "OP_NODE_SET_PARAMS"
349 OP_DSC_FIELD = "node_name"
360 class OpCreateInstance(OpCode):
361 """Create an instance."""
362 OP_ID = "OP_INSTANCE_CREATE"
363 OP_DSC_FIELD = "instance_name"
365 "instance_name", "os_type", "pnode",
366 "disk_template", "snode", "mode",
368 "src_node", "src_path", "start",
369 "wait_for_sync", "ip_check",
370 "file_storage_dir", "file_driver",
372 "hypervisor", "hvparams", "beparams",
376 class OpReinstallInstance(OpCode):
377 """Reinstall an instance's OS."""
378 OP_ID = "OP_INSTANCE_REINSTALL"
379 OP_DSC_FIELD = "instance_name"
380 __slots__ = ["instance_name", "os_type"]
383 class OpRemoveInstance(OpCode):
384 """Remove an instance."""
385 OP_ID = "OP_INSTANCE_REMOVE"
386 OP_DSC_FIELD = "instance_name"
387 __slots__ = ["instance_name", "ignore_failures"]
390 class OpRenameInstance(OpCode):
391 """Rename an instance."""
392 OP_ID = "OP_INSTANCE_RENAME"
393 __slots__ = ["instance_name", "ignore_ip", "new_name"]
396 class OpStartupInstance(OpCode):
397 """Startup an instance."""
398 OP_ID = "OP_INSTANCE_STARTUP"
399 OP_DSC_FIELD = "instance_name"
400 __slots__ = ["instance_name", "force", "hvparams", "beparams"]
403 class OpShutdownInstance(OpCode):
404 """Shutdown an instance."""
405 OP_ID = "OP_INSTANCE_SHUTDOWN"
406 OP_DSC_FIELD = "instance_name"
407 __slots__ = ["instance_name"]
410 class OpRebootInstance(OpCode):
411 """Reboot an instance."""
412 OP_ID = "OP_INSTANCE_REBOOT"
413 OP_DSC_FIELD = "instance_name"
414 __slots__ = ["instance_name", "reboot_type", "ignore_secondaries" ]
417 class OpReplaceDisks(OpCode):
418 """Replace the disks of an instance."""
419 OP_ID = "OP_INSTANCE_REPLACE_DISKS"
420 OP_DSC_FIELD = "instance_name"
421 __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
424 class OpFailoverInstance(OpCode):
425 """Failover an instance."""
426 OP_ID = "OP_INSTANCE_FAILOVER"
427 OP_DSC_FIELD = "instance_name"
428 __slots__ = ["instance_name", "ignore_consistency"]
431 class OpMigrateInstance(OpCode):
432 """Migrate an instance.
434 This migrates (without shutting down an instance) to its secondary
437 @ivar instance_name: the name of the instance
440 OP_ID = "OP_INSTANCE_MIGRATE"
441 OP_DSC_FIELD = "instance_name"
442 __slots__ = ["instance_name", "live", "cleanup"]
445 class OpConnectConsole(OpCode):
446 """Connect to an instance's console."""
447 OP_ID = "OP_INSTANCE_CONSOLE"
448 OP_DSC_FIELD = "instance_name"
449 __slots__ = ["instance_name"]
452 class OpActivateInstanceDisks(OpCode):
453 """Activate an instance's disks."""
454 OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
455 OP_DSC_FIELD = "instance_name"
456 __slots__ = ["instance_name", "ignore_size"]
459 class OpDeactivateInstanceDisks(OpCode):
460 """Deactivate an instance's disks."""
461 OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
462 OP_DSC_FIELD = "instance_name"
463 __slots__ = ["instance_name"]
466 class OpQueryInstances(OpCode):
467 """Compute the list of instances."""
468 OP_ID = "OP_INSTANCE_QUERY"
469 __slots__ = ["output_fields", "names", "use_locking"]
472 class OpQueryInstanceData(OpCode):
473 """Compute the run-time status of instances."""
474 OP_ID = "OP_INSTANCE_QUERY_DATA"
475 __slots__ = ["instances", "static"]
478 class OpSetInstanceParams(OpCode):
479 """Change the parameters of an instance."""
480 OP_ID = "OP_INSTANCE_SET_PARAMS"
481 OP_DSC_FIELD = "instance_name"
484 "hvparams", "beparams", "force",
489 class OpGrowDisk(OpCode):
490 """Grow a disk of an instance."""
491 OP_ID = "OP_INSTANCE_GROW_DISK"
492 OP_DSC_FIELD = "instance_name"
493 __slots__ = ["instance_name", "disk", "amount", "wait_for_sync"]
497 class OpDiagnoseOS(OpCode):
498 """Compute the list of guest operating systems."""
499 OP_ID = "OP_OS_DIAGNOSE"
500 __slots__ = ["output_fields", "names"]
504 class OpQueryExports(OpCode):
505 """Compute the list of exported images."""
506 OP_ID = "OP_BACKUP_QUERY"
507 __slots__ = ["nodes", "use_locking"]
510 class OpExportInstance(OpCode):
511 """Export an instance."""
512 OP_ID = "OP_BACKUP_EXPORT"
513 OP_DSC_FIELD = "instance_name"
514 __slots__ = ["instance_name", "target_node", "shutdown"]
517 class OpRemoveExport(OpCode):
518 """Remove an instance's export."""
519 OP_ID = "OP_BACKUP_REMOVE"
520 OP_DSC_FIELD = "instance_name"
521 __slots__ = ["instance_name"]
525 class OpGetTags(OpCode):
526 """Returns the tags of the given object."""
527 OP_ID = "OP_TAGS_GET"
528 OP_DSC_FIELD = "name"
529 __slots__ = ["kind", "name"]
532 class OpSearchTags(OpCode):
533 """Searches the tags in the cluster for a given pattern."""
534 OP_ID = "OP_TAGS_SEARCH"
535 OP_DSC_FIELD = "pattern"
536 __slots__ = ["pattern"]
539 class OpAddTags(OpCode):
540 """Add a list of tags on a given object."""
541 OP_ID = "OP_TAGS_SET"
542 __slots__ = ["kind", "name", "tags"]
545 class OpDelTags(OpCode):
546 """Remove a list of tags from a given object."""
547 OP_ID = "OP_TAGS_DEL"
548 __slots__ = ["kind", "name", "tags"]
552 class OpTestDelay(OpCode):
553 """Sleeps for a configured amount of time.
555 This is used just for debugging and testing.
558 - duration: the time to sleep
559 - on_master: if true, sleep on the master
560 - on_nodes: list of nodes in which to sleep
562 If the on_master parameter is true, it will execute a sleep on the
563 master (before any node sleep).
565 If the on_nodes list is not empty, it will sleep on those nodes
566 (after the sleep on the master, if that is enabled).
568 As an additional feature, the case of duration < 0 will be reported
569 as an execution error, so this opcode can be used as a failure
570 generator. The case of duration == 0 will not be treated specially.
573 OP_ID = "OP_TEST_DELAY"
574 OP_DSC_FIELD = "duration"
575 __slots__ = ["duration", "on_master", "on_nodes"]
578 class OpTestAllocator(OpCode):
579 """Allocator framework testing.
581 This opcode has two modes:
582 - gather and return allocator input for a given mode (allocate new
583 or replace secondary) and a given instance definition (direction
585 - run a selected allocator for a given operation (as above) and
586 return the allocator output (direction 'out')
589 OP_ID = "OP_TEST_ALLOCATOR"
590 OP_DSC_FIELD = "allocator"
592 "direction", "mode", "allocator", "name",
593 "mem_size", "disks", "disk_template",
594 "os", "tags", "nics", "vcpus", "hypervisor",
597 OP_MAPPING = dict([(v.OP_ID, v) for v in globals().values()
598 if (isinstance(v, type) and issubclass(v, OpCode) and
599 hasattr(v, "OP_ID"))])