code.grnet.gr Git - ganeti-local/blob - lib/opcodes.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007 Google Inc.
   5 #
   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.
  10 #
  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.
  15 #
  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
  19 # 02110-1301, USA.
  20
  21
  22 """OpCodes module
  23
  24 This module implements the data structures which define the cluster
  25 operations - the so-called opcodes.
  26
  27 Every operation which modifies the cluster state is expressed via
  28 opcodes.
  29
  30 """
  31
  32 # this are practically structures, so disable the message about too
  33 # few public methods:
  34 # pylint: disable-msg=R0903
  35
  36
  37 class BaseOpCode(object):
  38   """A simple serializable object.
  39
  40   This object serves as a parent class for OpCode without any custom
  41   field handling.
  42
  43   """
  44   __slots__ = []
  45
  46   def __init__(self, **kwargs):
  47     """Constructor for BaseOpCode.
  48
  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.
  53
  54     """
  55     for key in kwargs:
  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])
  60
  61   def __getstate__(self):
  62     """Generic serializer.
  63
  64     This method just returns the contents of the instance as a
  65     dictionary.
  66
  67     @rtype:  C{dict}
  68     @return: the instance attributes and their values
  69
  70     """
  71     state = {}
  72     for name in self.__slots__:
  73       if hasattr(self, name):
  74         state[name] = getattr(self, name)
  75     return state
  76
  77   def __setstate__(self, state):
  78     """Generic unserializer.
  79
  80     This method just restores from the serialized state the attributes
  81     of the current instance.
  82
  83     @param state: the serialized opcode data
  84     @type state:  C{dict}
  85
  86     """
  87     if not isinstance(state, dict):
  88       raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
  89                        type(state))
  90
  91     for name in self.__slots__:
  92       if name not in state:
  93         delattr(self, name)
  94
  95     for name in state:
  96       setattr(self, name, state[name])
  97
  98
  99 class OpCode(BaseOpCode):
 100   """Abstract OpCode.
 101
 102   This is the root of the actual OpCode hierarchy. All clases derived
 103   from this class should override OP_ID.
 104
 105   @cvar OP_ID: The ID of this opcode. This should be unique amongst all
 106                childre of this class.
 107
 108   """
 109   OP_ID = "OP_ABSTRACT"
 110   __slots__ = []
 111
 112   def __getstate__(self):
 113     """Specialized getstate for opcodes.
 114
 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.
 118
 119     @rtype:   C{dict}
 120     @return:  the state as a dictionary
 121
 122     """
 123     data = BaseOpCode.__getstate__(self)
 124     data["OP_ID"] = self.OP_ID
 125     return data
 126
 127   @classmethod
 128   def LoadOpCode(cls, data):
 129     """Generic load opcode method.
 130
 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.
 134
 135     @type data:  C{dict}
 136     @param data: the serialized opcode
 137
 138     """
 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"]
 144     op_class = None
 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):
 150         op_class = item
 151         break
 152     if op_class is None:
 153       raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
 154                        op_id)
 155     op = op_class()
 156     new_data = data.copy()
 157     del new_data["OP_ID"]
 158     op.__setstate__(new_data)
 159     return op
 160
 161   def Summary(self):
 162     """Generates a summary description of this opcode.
 163
 164     """
 165     # all OP_ID start with OP_, we remove that
 166     txt = self.OP_ID[3:]
 167     field_name = getattr(self, "OP_DSC_FIELD", None)
 168     if field_name:
 169       field_value = getattr(self, field_name, None)
 170       txt = "%s(%s)" % (txt, field_value)
 171     return txt
 172
 173
 174 # cluster opcodes
 175
 176 class OpDestroyCluster(OpCode):
 177   """Destroy the cluster.
 178
 179   This opcode has no other parameters. All the state is irreversibly
 180   lost after the execution of this opcode.
 181
 182   """
 183   OP_ID = "OP_CLUSTER_DESTROY"
 184   __slots__ = []
 185
 186
 187 class OpQueryClusterInfo(OpCode):
 188   """Query cluster information."""
 189   OP_ID = "OP_CLUSTER_QUERY"
 190   __slots__ = []
 191
 192
 193 class OpVerifyCluster(OpCode):
 194   """Verify the cluster state.
 195
 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
 201
 202   """
 203   OP_ID = "OP_CLUSTER_VERIFY"
 204   __slots__ = ["skip_checks"]
 205
 206
 207 class OpVerifyDisks(OpCode):
 208   """Verify the cluster disks.
 209
 210   Parameters: none
 211
 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)
 218
 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.
 223
 224   Note that only instances that are drbd-based are taken into
 225   consideration. This might need to be revisited in the future.
 226
 227   """
 228   OP_ID = "OP_CLUSTER_VERIFY_DISKS"
 229   __slots__ = []
 230
 231
 232 class OpQueryConfigValues(OpCode):
 233   """Query cluster configuration values."""
 234   OP_ID = "OP_CLUSTER_CONFIG_QUERY"
 235   __slots__ = ["output_fields"]
 236
 237
 238 class OpRenameCluster(OpCode):
 239   """Rename the cluster.
 240
 241   @type name: C{str}
 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
 244               address.
 245
 246   """
 247   OP_ID = "OP_CLUSTER_RENAME"
 248   OP_DSC_FIELD = "name"
 249   __slots__ = ["name"]
 250
 251
 252 class OpSetClusterParams(OpCode):
 253   """Change the parameters of the cluster.
 254
 255   @type vg_name: C{str} or C{None}
 256   @ivar vg_name: The new volume group name or None to disable LVM usage.
 257
 258   """
 259   OP_ID = "OP_CLUSTER_SET_PARAMS"
 260   __slots__ = [
 261     "vg_name",
 262     "enabled_hypervisors",
 263     "hvparams",
 264     "beparams",
 265     "candidate_pool_size",
 266     ]
 267
 268
 269 class OpRedistributeConfig(OpCode):
 270   """Force a full push of the cluster configuration.
 271
 272   """
 273   OP_ID = "OP_CLUSTER_REDIST_CONF"
 274   __slots__ = [
 275     ]
 276
 277 # node opcodes
 278
 279 class OpRemoveNode(OpCode):
 280   """Remove a node.
 281
 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.
 285
 286   """
 287   OP_ID = "OP_NODE_REMOVE"
 288   OP_DSC_FIELD = "node_name"
 289   __slots__ = ["node_name"]
 290
 291
 292 class OpAddNode(OpCode):
 293   """Add a node to the cluster.
 294
 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.
 306   @type readd: C{bool}
 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.
 312
 313   """
 314   OP_ID = "OP_NODE_ADD"
 315   OP_DSC_FIELD = "node_name"
 316   __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
 317
 318
 319 class OpQueryNodes(OpCode):
 320   """Compute the list of nodes."""
 321   OP_ID = "OP_NODE_QUERY"
 322   __slots__ = ["output_fields", "names", "use_locking"]
 323
 324
 325 class OpQueryNodeVolumes(OpCode):
 326   """Get list of volumes on node."""
 327   OP_ID = "OP_NODE_QUERYVOLS"
 328   __slots__ = ["nodes", "output_fields"]
 329
 330
 331 class OpSetNodeParams(OpCode):
 332   """Change the parameters of a node."""
 333   OP_ID = "OP_NODE_SET_PARAMS"
 334   OP_DSC_FIELD = "node_name"
 335   __slots__ = [
 336     "node_name",
 337     "force",
 338     "master_candidate",
 339     "offline",
 340     ]
 341
 342 # instance opcodes
 343
 344 class OpCreateInstance(OpCode):
 345   """Create an instance."""
 346   OP_ID = "OP_INSTANCE_CREATE"
 347   OP_DSC_FIELD = "instance_name"
 348   __slots__ = [
 349     "instance_name", "os_type", "pnode",
 350     "disk_template", "snode", "mode",
 351     "disks", "nics",
 352     "src_node", "src_path", "start",
 353     "wait_for_sync", "ip_check",
 354     "file_storage_dir", "file_driver",
 355     "iallocator",
 356     "hypervisor", "hvparams", "beparams",
 357     ]
 358
 359
 360 class OpReinstallInstance(OpCode):
 361   """Reinstall an instance's OS."""
 362   OP_ID = "OP_INSTANCE_REINSTALL"
 363   OP_DSC_FIELD = "instance_name"
 364   __slots__ = ["instance_name", "os_type"]
 365
 366
 367 class OpRemoveInstance(OpCode):
 368   """Remove an instance."""
 369   OP_ID = "OP_INSTANCE_REMOVE"
 370   OP_DSC_FIELD = "instance_name"
 371   __slots__ = ["instance_name", "ignore_failures"]
 372
 373
 374 class OpRenameInstance(OpCode):
 375   """Rename an instance."""
 376   OP_ID = "OP_INSTANCE_RENAME"
 377   __slots__ = ["instance_name", "ignore_ip", "new_name"]
 378
 379
 380 class OpStartupInstance(OpCode):
 381   """Startup an instance."""
 382   OP_ID = "OP_INSTANCE_STARTUP"
 383   OP_DSC_FIELD = "instance_name"
 384   __slots__ = ["instance_name", "force", "extra_args"]
 385
 386
 387 class OpShutdownInstance(OpCode):
 388   """Shutdown an instance."""
 389   OP_ID = "OP_INSTANCE_SHUTDOWN"
 390   OP_DSC_FIELD = "instance_name"
 391   __slots__ = ["instance_name"]
 392
 393
 394 class OpRebootInstance(OpCode):
 395   """Reboot an instance."""
 396   OP_ID = "OP_INSTANCE_REBOOT"
 397   OP_DSC_FIELD = "instance_name"
 398   __slots__ = ["instance_name", "reboot_type", "extra_args",
 399                "ignore_secondaries" ]
 400
 401
 402 class OpReplaceDisks(OpCode):
 403   """Replace the disks of an instance."""
 404   OP_ID = "OP_INSTANCE_REPLACE_DISKS"
 405   OP_DSC_FIELD = "instance_name"
 406   __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
 407
 408
 409 class OpFailoverInstance(OpCode):
 410   """Failover an instance."""
 411   OP_ID = "OP_INSTANCE_FAILOVER"
 412   OP_DSC_FIELD = "instance_name"
 413   __slots__ = ["instance_name", "ignore_consistency"]
 414
 415
 416 class OpMigrateInstance(OpCode):
 417   """Migrate an instance.
 418
 419   This migrates (without shutting down an instance) to its secondary
 420   node.
 421
 422   @ivar instance_name: the name of the instance
 423
 424   """
 425   OP_ID = "OP_INSTANCE_MIGRATE"
 426   OP_DSC_FIELD = "instance_name"
 427   __slots__ = ["instance_name", "live", "cleanup"]
 428
 429
 430 class OpConnectConsole(OpCode):
 431   """Connect to an instance's console."""
 432   OP_ID = "OP_INSTANCE_CONSOLE"
 433   OP_DSC_FIELD = "instance_name"
 434   __slots__ = ["instance_name"]
 435
 436
 437 class OpActivateInstanceDisks(OpCode):
 438   """Activate an instance's disks."""
 439   OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
 440   OP_DSC_FIELD = "instance_name"
 441   __slots__ = ["instance_name"]
 442
 443
 444 class OpDeactivateInstanceDisks(OpCode):
 445   """Deactivate an instance's disks."""
 446   OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
 447   OP_DSC_FIELD = "instance_name"
 448   __slots__ = ["instance_name"]
 449
 450
 451 class OpQueryInstances(OpCode):
 452   """Compute the list of instances."""
 453   OP_ID = "OP_INSTANCE_QUERY"
 454   __slots__ = ["output_fields", "names", "use_locking"]
 455
 456
 457 class OpQueryInstanceData(OpCode):
 458   """Compute the run-time status of instances."""
 459   OP_ID = "OP_INSTANCE_QUERY_DATA"
 460   __slots__ = ["instances", "static"]
 461
 462
 463 class OpSetInstanceParams(OpCode):
 464   """Change the parameters of an instance."""
 465   OP_ID = "OP_INSTANCE_SET_PARAMS"
 466   OP_DSC_FIELD = "instance_name"
 467   __slots__ = [
 468     "instance_name",
 469     "hvparams", "beparams", "force",
 470     "nics", "disks",
 471     ]
 472
 473
 474 class OpGrowDisk(OpCode):
 475   """Grow a disk of an instance."""
 476   OP_ID = "OP_INSTANCE_GROW_DISK"
 477   OP_DSC_FIELD = "instance_name"
 478   __slots__ = ["instance_name", "disk", "amount", "wait_for_sync"]
 479
 480
 481 # OS opcodes
 482 class OpDiagnoseOS(OpCode):
 483   """Compute the list of guest operating systems."""
 484   OP_ID = "OP_OS_DIAGNOSE"
 485   __slots__ = ["output_fields", "names"]
 486
 487
 488 # Exports opcodes
 489 class OpQueryExports(OpCode):
 490   """Compute the list of exported images."""
 491   OP_ID = "OP_BACKUP_QUERY"
 492   __slots__ = ["nodes", "use_locking"]
 493
 494
 495 class OpExportInstance(OpCode):
 496   """Export an instance."""
 497   OP_ID = "OP_BACKUP_EXPORT"
 498   OP_DSC_FIELD = "instance_name"
 499   __slots__ = ["instance_name", "target_node", "shutdown"]
 500
 501
 502 class OpRemoveExport(OpCode):
 503   """Remove an instance's export."""
 504   OP_ID = "OP_BACKUP_REMOVE"
 505   OP_DSC_FIELD = "instance_name"
 506   __slots__ = ["instance_name"]
 507
 508
 509 # Tags opcodes
 510 class OpGetTags(OpCode):
 511   """Returns the tags of the given object."""
 512   OP_ID = "OP_TAGS_GET"
 513   OP_DSC_FIELD = "name"
 514   __slots__ = ["kind", "name"]
 515
 516
 517 class OpSearchTags(OpCode):
 518   """Searches the tags in the cluster for a given pattern."""
 519   OP_ID = "OP_TAGS_SEARCH"
 520   OP_DSC_FIELD = "pattern"
 521   __slots__ = ["pattern"]
 522
 523
 524 class OpAddTags(OpCode):
 525   """Add a list of tags on a given object."""
 526   OP_ID = "OP_TAGS_SET"
 527   __slots__ = ["kind", "name", "tags"]
 528
 529
 530 class OpDelTags(OpCode):
 531   """Remove a list of tags from a given object."""
 532   OP_ID = "OP_TAGS_DEL"
 533   __slots__ = ["kind", "name", "tags"]
 534
 535
 536 # Test opcodes
 537 class OpTestDelay(OpCode):
 538   """Sleeps for a configured amount of time.
 539
 540   This is used just for debugging and testing.
 541
 542   Parameters:
 543     - duration: the time to sleep
 544     - on_master: if true, sleep on the master
 545     - on_nodes: list of nodes in which to sleep
 546
 547   If the on_master parameter is true, it will execute a sleep on the
 548   master (before any node sleep).
 549
 550   If the on_nodes list is not empty, it will sleep on those nodes
 551   (after the sleep on the master, if that is enabled).
 552
 553   As an additional feature, the case of duration < 0 will be reported
 554   as an execution error, so this opcode can be used as a failure
 555   generator. The case of duration == 0 will not be treated specially.
 556
 557   """
 558   OP_ID = "OP_TEST_DELAY"
 559   OP_DSC_FIELD = "duration"
 560   __slots__ = ["duration", "on_master", "on_nodes"]
 561
 562
 563 class OpTestAllocator(OpCode):
 564   """Allocator framework testing.
 565
 566   This opcode has two modes:
 567     - gather and return allocator input for a given mode (allocate new
 568       or replace secondary) and a given instance definition (direction
 569       'in')
 570     - run a selected allocator for a given operation (as above) and
 571       return the allocator output (direction 'out')
 572
 573   """
 574   OP_ID = "OP_TEST_ALLOCATOR"
 575   OP_DSC_FIELD = "allocator"
 576   __slots__ = [
 577     "direction", "mode", "allocator", "name",
 578     "mem_size", "disks", "disk_template",
 579     "os", "tags", "nics", "vcpus", "hypervisor",
 580     ]