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 for item in globals().values():
146 if (isinstance(item, type) and
147 issubclass(item, cls) and
148 hasattr(item, "OP_ID") and
149 getattr(item, "OP_ID") == op_id):
153 raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
156 new_data = data.copy()
157 del new_data["OP_ID"]
158 op.__setstate__(new_data)
162 """Generates a summary description of this opcode.
165 # all OP_ID start with OP_, we remove that
167 field_name = getattr(self, "OP_DSC_FIELD", None)
169 field_value = getattr(self, field_name, None)
170 txt = "%s(%s)" % (txt, field_value)
176 class OpDestroyCluster(OpCode):
177 """Destroy the cluster.
179 This opcode has no other parameters. All the state is irreversibly
180 lost after the execution of this opcode.
183 OP_ID = "OP_CLUSTER_DESTROY"
187 class OpQueryClusterInfo(OpCode):
188 """Query cluster information."""
189 OP_ID = "OP_CLUSTER_QUERY"
193 class OpVerifyCluster(OpCode):
194 """Verify the cluster state.
196 @type skip_checks: C{list}
197 @ivar skip_checks: steps to be skipped from the verify process; this
198 needs to be a subset of
199 L{constants.VERIFY_OPTIONAL_CHECKS}; currently
200 only L{constants.VERIFY_NPLUSONE_MEM} can be passed
203 OP_ID = "OP_CLUSTER_VERIFY"
204 __slots__ = ["skip_checks"]
207 class OpVerifyDisks(OpCode):
208 """Verify the cluster disks.
212 Result: a tuple of four elements:
213 - list of node names with bad data returned (unreachable, etc.)
214 - dict of node names with broken volume groups (values: error msg)
215 - list of instances with degraded disks (that should be activated)
216 - dict of instances with missing logical volumes (values: (node, vol)
217 pairs with details about the missing volumes)
219 In normal operation, all lists should be empty. A non-empty instance
220 list (3rd element of the result) is still ok (errors were fixed) but
221 non-empty node list means some node is down, and probably there are
222 unfixable drbd errors.
224 Note that only instances that are drbd-based are taken into
225 consideration. This might need to be revisited in the future.
228 OP_ID = "OP_CLUSTER_VERIFY_DISKS"
232 class OpQueryConfigValues(OpCode):
233 """Query cluster configuration values."""
234 OP_ID = "OP_CLUSTER_CONFIG_QUERY"
235 __slots__ = ["output_fields"]
238 class OpRenameCluster(OpCode):
239 """Rename the cluster.
242 @ivar name: The new name of the cluster. The name and/or the master IP
243 address will be changed to match the new name and its IP
247 OP_ID = "OP_CLUSTER_RENAME"
248 OP_DSC_FIELD = "name"
252 class OpSetClusterParams(OpCode):
253 """Change the parameters of the cluster.
255 @type vg_name: C{str} or C{None}
256 @ivar vg_name: The new volume group name or None to disable LVM usage.
259 OP_ID = "OP_CLUSTER_SET_PARAMS"
262 "enabled_hypervisors",
265 "candidate_pool_size",
269 class OpRedistributeConfig(OpCode):
270 """Force a full push of the cluster configuration.
273 OP_ID = "OP_CLUSTER_REDIST_CONF"
279 class OpRemoveNode(OpCode):
282 @type node_name: C{str}
283 @ivar node_name: The name of the node to remove. If the node still has
284 instances on it, the operation will fail.
287 OP_ID = "OP_NODE_REMOVE"
288 OP_DSC_FIELD = "node_name"
289 __slots__ = ["node_name"]
292 class OpAddNode(OpCode):
293 """Add a node to the cluster.
295 @type node_name: C{str}
296 @ivar node_name: The name of the node to add. This can be a short name,
297 but it will be expanded to the FQDN.
298 @type primary_ip: IP address
299 @ivar primary_ip: The primary IP of the node. This will be ignored when the
300 opcode is submitted, but will be filled during the node
301 add (so it will be visible in the job query).
302 @type secondary_ip: IP address
303 @ivar secondary_ip: The secondary IP of the node. This needs to be passed
304 if the cluster has been initialized in 'dual-network'
305 mode, otherwise it must not be given.
307 @ivar readd: Whether to re-add an existing node to the cluster. If
308 this is not passed, then the operation will abort if the node
309 name is already in the cluster; use this parameter to 'repair'
310 a node that had its configuration broken, or was reinstalled
311 without removal from the cluster.
314 OP_ID = "OP_NODE_ADD"
315 OP_DSC_FIELD = "node_name"
316 __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
319 class OpQueryNodes(OpCode):
320 """Compute the list of nodes."""
321 OP_ID = "OP_NODE_QUERY"
322 __slots__ = ["output_fields", "names", "use_locking"]
325 class OpQueryNodeVolumes(OpCode):
326 """Get list of volumes on node."""
327 OP_ID = "OP_NODE_QUERYVOLS"
328 __slots__ = ["nodes", "output_fields"]
331 class OpSetNodeParams(OpCode):
332 """Change the parameters of a node."""
333 OP_ID = "OP_NODE_SET_PARAMS"
334 OP_DSC_FIELD = "node_name"
344 class OpPowercycleNode(OpCode):
345 """Tries to powercycle a node."""
346 OP_ID = "OP_NODE_POWERCYCLE"
347 OP_DSC_FIELD = "node_name"
355 class OpCreateInstance(OpCode):
356 """Create an instance."""
357 OP_ID = "OP_INSTANCE_CREATE"
358 OP_DSC_FIELD = "instance_name"
360 "instance_name", "os_type", "pnode",
361 "disk_template", "snode", "mode",
363 "src_node", "src_path", "start",
364 "wait_for_sync", "ip_check",
365 "file_storage_dir", "file_driver",
367 "hypervisor", "hvparams", "beparams",
371 class OpReinstallInstance(OpCode):
372 """Reinstall an instance's OS."""
373 OP_ID = "OP_INSTANCE_REINSTALL"
374 OP_DSC_FIELD = "instance_name"
375 __slots__ = ["instance_name", "os_type"]
378 class OpRemoveInstance(OpCode):
379 """Remove an instance."""
380 OP_ID = "OP_INSTANCE_REMOVE"
381 OP_DSC_FIELD = "instance_name"
382 __slots__ = ["instance_name", "ignore_failures"]
385 class OpRenameInstance(OpCode):
386 """Rename an instance."""
387 OP_ID = "OP_INSTANCE_RENAME"
388 __slots__ = ["instance_name", "ignore_ip", "new_name"]
391 class OpStartupInstance(OpCode):
392 """Startup an instance."""
393 OP_ID = "OP_INSTANCE_STARTUP"
394 OP_DSC_FIELD = "instance_name"
395 __slots__ = ["instance_name", "force", "hvparams", "beparams"]
398 class OpShutdownInstance(OpCode):
399 """Shutdown an instance."""
400 OP_ID = "OP_INSTANCE_SHUTDOWN"
401 OP_DSC_FIELD = "instance_name"
402 __slots__ = ["instance_name"]
405 class OpRebootInstance(OpCode):
406 """Reboot an instance."""
407 OP_ID = "OP_INSTANCE_REBOOT"
408 OP_DSC_FIELD = "instance_name"
409 __slots__ = ["instance_name", "reboot_type", "ignore_secondaries" ]
412 class OpReplaceDisks(OpCode):
413 """Replace the disks of an instance."""
414 OP_ID = "OP_INSTANCE_REPLACE_DISKS"
415 OP_DSC_FIELD = "instance_name"
416 __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
419 class OpFailoverInstance(OpCode):
420 """Failover an instance."""
421 OP_ID = "OP_INSTANCE_FAILOVER"
422 OP_DSC_FIELD = "instance_name"
423 __slots__ = ["instance_name", "ignore_consistency"]
426 class OpMigrateInstance(OpCode):
427 """Migrate an instance.
429 This migrates (without shutting down an instance) to its secondary
432 @ivar instance_name: the name of the instance
435 OP_ID = "OP_INSTANCE_MIGRATE"
436 OP_DSC_FIELD = "instance_name"
437 __slots__ = ["instance_name", "live", "cleanup"]
440 class OpConnectConsole(OpCode):
441 """Connect to an instance's console."""
442 OP_ID = "OP_INSTANCE_CONSOLE"
443 OP_DSC_FIELD = "instance_name"
444 __slots__ = ["instance_name"]
447 class OpActivateInstanceDisks(OpCode):
448 """Activate an instance's disks."""
449 OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
450 OP_DSC_FIELD = "instance_name"
451 __slots__ = ["instance_name"]
454 class OpDeactivateInstanceDisks(OpCode):
455 """Deactivate an instance's disks."""
456 OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
457 OP_DSC_FIELD = "instance_name"
458 __slots__ = ["instance_name"]
461 class OpQueryInstances(OpCode):
462 """Compute the list of instances."""
463 OP_ID = "OP_INSTANCE_QUERY"
464 __slots__ = ["output_fields", "names", "use_locking"]
467 class OpQueryInstanceData(OpCode):
468 """Compute the run-time status of instances."""
469 OP_ID = "OP_INSTANCE_QUERY_DATA"
470 __slots__ = ["instances", "static"]
473 class OpSetInstanceParams(OpCode):
474 """Change the parameters of an instance."""
475 OP_ID = "OP_INSTANCE_SET_PARAMS"
476 OP_DSC_FIELD = "instance_name"
479 "hvparams", "beparams", "force",
484 class OpGrowDisk(OpCode):
485 """Grow a disk of an instance."""
486 OP_ID = "OP_INSTANCE_GROW_DISK"
487 OP_DSC_FIELD = "instance_name"
488 __slots__ = ["instance_name", "disk", "amount", "wait_for_sync"]
492 class OpDiagnoseOS(OpCode):
493 """Compute the list of guest operating systems."""
494 OP_ID = "OP_OS_DIAGNOSE"
495 __slots__ = ["output_fields", "names"]
499 class OpQueryExports(OpCode):
500 """Compute the list of exported images."""
501 OP_ID = "OP_BACKUP_QUERY"
502 __slots__ = ["nodes", "use_locking"]
505 class OpExportInstance(OpCode):
506 """Export an instance."""
507 OP_ID = "OP_BACKUP_EXPORT"
508 OP_DSC_FIELD = "instance_name"
509 __slots__ = ["instance_name", "target_node", "shutdown"]
512 class OpRemoveExport(OpCode):
513 """Remove an instance's export."""
514 OP_ID = "OP_BACKUP_REMOVE"
515 OP_DSC_FIELD = "instance_name"
516 __slots__ = ["instance_name"]
520 class OpGetTags(OpCode):
521 """Returns the tags of the given object."""
522 OP_ID = "OP_TAGS_GET"
523 OP_DSC_FIELD = "name"
524 __slots__ = ["kind", "name"]
527 class OpSearchTags(OpCode):
528 """Searches the tags in the cluster for a given pattern."""
529 OP_ID = "OP_TAGS_SEARCH"
530 OP_DSC_FIELD = "pattern"
531 __slots__ = ["pattern"]
534 class OpAddTags(OpCode):
535 """Add a list of tags on a given object."""
536 OP_ID = "OP_TAGS_SET"
537 __slots__ = ["kind", "name", "tags"]
540 class OpDelTags(OpCode):
541 """Remove a list of tags from a given object."""
542 OP_ID = "OP_TAGS_DEL"
543 __slots__ = ["kind", "name", "tags"]
547 class OpTestDelay(OpCode):
548 """Sleeps for a configured amount of time.
550 This is used just for debugging and testing.
553 - duration: the time to sleep
554 - on_master: if true, sleep on the master
555 - on_nodes: list of nodes in which to sleep
557 If the on_master parameter is true, it will execute a sleep on the
558 master (before any node sleep).
560 If the on_nodes list is not empty, it will sleep on those nodes
561 (after the sleep on the master, if that is enabled).
563 As an additional feature, the case of duration < 0 will be reported
564 as an execution error, so this opcode can be used as a failure
565 generator. The case of duration == 0 will not be treated specially.
568 OP_ID = "OP_TEST_DELAY"
569 OP_DSC_FIELD = "duration"
570 __slots__ = ["duration", "on_master", "on_nodes"]
573 class OpTestAllocator(OpCode):
574 """Allocator framework testing.
576 This opcode has two modes:
577 - gather and return allocator input for a given mode (allocate new
578 or replace secondary) and a given instance definition (direction
580 - run a selected allocator for a given operation (as above) and
581 return the allocator output (direction 'out')
584 OP_ID = "OP_TEST_ALLOCATOR"
585 OP_DSC_FIELD = "allocator"
587 "direction", "mode", "allocator", "name",
588 "mem_size", "disks", "disk_template",
589 "os", "tags", "nics", "vcpus", "hypervisor",