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
  28 This module implements the logic for doing operations in the cluster. There
  29 are two kinds of classes defined:
  30   - opcodes, which are small classes only holding data for the task at hand
  31   - logical units, which know how to deal with their specific opcode only
  32
  33 """
  34
  35 # this are practically structures, so disable the message about too
  36 # few public methods:
  37 # pylint: disable-msg=R0903
  38
  39 class OpCode(object):
  40   """Abstract OpCode"""
  41   OP_ID = "OP_ABSTRACT"
  42   __slots__ = []
  43
  44   def __init__(self, **kwargs):
  45     for key in kwargs:
  46       if key not in self.__slots__:
  47         raise TypeError("OpCode %s doesn't support the parameter '%s'" %
  48                         (self.__class__.__name__, key))
  49       setattr(self, key, kwargs[key])
  50
  51
  52 class OpInitCluster(OpCode):
  53   """Initialise the cluster."""
  54   OP_ID = "OP_CLUSTER_INIT"
  55   __slots__ = ["cluster_name", "secondary_ip", "hypervisor_type",
  56                "vg_name", "mac_prefix", "def_bridge", "master_netdev"]
  57
  58
  59 class OpDestroyCluster(OpCode):
  60   """Destroy the cluster."""
  61   OP_ID = "OP_CLUSTER_DESTROY"
  62   __slots__ = []
  63
  64
  65 class OpQueryClusterInfo(OpCode):
  66   """Query cluster information."""
  67   OP_ID = "OP_CLUSTER_QUERY"
  68   __slots__ = []
  69
  70
  71 class OpClusterCopyFile(OpCode):
  72   """Copy a file to multiple nodes."""
  73   OP_ID = "OP_CLUSTER_COPYFILE"
  74   __slots__ = ["nodes", "filename"]
  75
  76
  77 class OpRunClusterCommand(OpCode):
  78   """Run a command on multiple nodes."""
  79   OP_ID = "OP_CLUSTER_RUNCOMMAND"
  80   __slots__ = ["nodes", "command"]
  81
  82
  83 class OpVerifyCluster(OpCode):
  84   """Verify the cluster state."""
  85   OP_ID = "OP_CLUSTER_VERIFY"
  86   __slots__ = ["skip_checks"]
  87
  88
  89 class OpVerifyDisks(OpCode):
  90   """Verify the cluster disks.
  91
  92   Parameters: none
  93
  94   Result: two lists:
  95     - list of node names with bad data returned (unreachable, etc.)
  96     - dist of node names with broken volume groups (values: error msg)
  97     - list of instances with degraded disks (that should be activated)
  98     - dict of instances with missing logical volumes (values: (node, vol)
  99       pairs with details about the missing volumes)
 100
 101   In normal operation, all lists should be empty. A non-empty instance
 102   list (3rd element of the result) is still ok (errors were fixed) but
 103   non-empty node list means some node is down, and probably there are
 104   unfixable drbd errors.
 105
 106   Note that only instances that are drbd-based are taken into
 107   consideration. This might need to be revisited in the future.
 108
 109   """
 110   OP_ID = "OP_CLUSTER_VERIFY_DISKS"
 111   __slots__ = []
 112
 113
 114 class OpMasterFailover(OpCode):
 115   """Do a master failover."""
 116   OP_ID = "OP_CLUSTER_MASTERFAILOVER"
 117   __slots__ = []
 118
 119
 120 class OpDumpClusterConfig(OpCode):
 121   """Dump the cluster configuration."""
 122   OP_ID = "OP_CLUSTER_DUMPCONFIG"
 123   __slots__ = []
 124
 125
 126 class OpRenameCluster(OpCode):
 127   """Rename the cluster."""
 128   OP_ID = "OP_CLUSTER_RENAME"
 129   __slots__ = ["name"]
 130
 131
 132 # node opcodes
 133
 134 class OpRemoveNode(OpCode):
 135   """Remove a node."""
 136   OP_ID = "OP_NODE_REMOVE"
 137   __slots__ = ["node_name"]
 138
 139
 140 class OpAddNode(OpCode):
 141   """Add a node."""
 142   OP_ID = "OP_NODE_ADD"
 143   __slots__ = ["node_name", "primary_ip", "secondary_ip"]
 144
 145
 146 class OpQueryNodes(OpCode):
 147   """Compute the list of nodes."""
 148   OP_ID = "OP_NODE_QUERY"
 149   __slots__ = ["output_fields", "names"]
 150
 151
 152 class OpQueryNodeVolumes(OpCode):
 153   """Get list of volumes on node."""
 154   OP_ID = "OP_NODE_QUERYVOLS"
 155   __slots__ = ["nodes", "output_fields"]
 156
 157
 158 # instance opcodes
 159
 160 class OpCreateInstance(OpCode):
 161   """Create an instance."""
 162   OP_ID = "OP_INSTANCE_CREATE"
 163   __slots__ = [
 164     "instance_name", "mem_size", "disk_size", "os_type", "pnode",
 165     "disk_template", "snode", "swap_size", "mode",
 166     "vcpus", "ip", "bridge", "src_node", "src_path", "start",
 167     "wait_for_sync", "ip_check", "mac",
 168     "kernel_path", "initrd_path", "hvm_boot_order",
 169     "iallocator",
 170     ]
 171
 172
 173 class OpReinstallInstance(OpCode):
 174   """Reinstall an instance's OS."""
 175   OP_ID = "OP_INSTANCE_REINSTALL"
 176   __slots__ = ["instance_name", "os_type"]
 177
 178
 179 class OpRemoveInstance(OpCode):
 180   """Remove an instance."""
 181   OP_ID = "OP_INSTANCE_REMOVE"
 182   __slots__ = ["instance_name", "ignore_failures"]
 183
 184
 185 class OpRenameInstance(OpCode):
 186   """Rename an instance."""
 187   OP_ID = "OP_INSTANCE_RENAME"
 188   __slots__ = ["instance_name", "ignore_ip", "new_name"]
 189
 190
 191 class OpStartupInstance(OpCode):
 192   """Startup an instance."""
 193   OP_ID = "OP_INSTANCE_STARTUP"
 194   __slots__ = ["instance_name", "force", "extra_args"]
 195
 196
 197 class OpShutdownInstance(OpCode):
 198   """Shutdown an instance."""
 199   OP_ID = "OP_INSTANCE_SHUTDOWN"
 200   __slots__ = ["instance_name"]
 201
 202
 203 class OpRebootInstance(OpCode):
 204   """Reboot an instance."""
 205   OP_ID = "OP_INSTANCE_REBOOT"
 206   __slots__ = ["instance_name", "reboot_type", "extra_args",
 207                "ignore_secondaries" ]
 208
 209
 210 class OpAddMDDRBDComponent(OpCode):
 211   """Add a MD-DRBD component."""
 212   OP_ID = "OP_INSTANCE_ADD_MDDRBD"
 213   __slots__ = ["instance_name", "remote_node", "disk_name"]
 214
 215
 216 class OpRemoveMDDRBDComponent(OpCode):
 217   """Remove a MD-DRBD component."""
 218   OP_ID = "OP_INSTANCE_REMOVE_MDDRBD"
 219   __slots__ = ["instance_name", "disk_name", "disk_id"]
 220
 221
 222 class OpReplaceDisks(OpCode):
 223   """Replace the disks of an instance."""
 224   OP_ID = "OP_INSTANCE_REPLACE_DISKS"
 225   __slots__ = ["instance_name", "remote_node", "mode", "disks"]
 226
 227
 228 class OpFailoverInstance(OpCode):
 229   """Failover an instance."""
 230   OP_ID = "OP_INSTANCE_FAILOVER"
 231   __slots__ = ["instance_name", "ignore_consistency"]
 232
 233
 234 class OpConnectConsole(OpCode):
 235   """Connect to an instance's console."""
 236   OP_ID = "OP_INSTANCE_CONSOLE"
 237   __slots__ = ["instance_name"]
 238
 239
 240 class OpActivateInstanceDisks(OpCode):
 241   """Activate an instance's disks."""
 242   OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
 243   __slots__ = ["instance_name"]
 244
 245
 246 class OpDeactivateInstanceDisks(OpCode):
 247   """Deactivate an instance's disks."""
 248   OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
 249   __slots__ = ["instance_name"]
 250
 251
 252 class OpQueryInstances(OpCode):
 253   """Compute the list of instances."""
 254   OP_ID = "OP_INSTANCE_QUERY"
 255   __slots__ = ["output_fields", "names"]
 256
 257
 258 class OpQueryInstanceData(OpCode):
 259   """Compute the run-time status of instances."""
 260   OP_ID = "OP_INSTANCE_QUERY_DATA"
 261   __slots__ = ["instances"]
 262
 263
 264 class OpSetInstanceParms(OpCode):
 265   """Change the parameters of an instance."""
 266   OP_ID = "OP_INSTANCE_SET_PARMS"
 267   __slots__ = [
 268     "instance_name", "mem", "vcpus", "ip", "bridge", "mac",
 269     "kernel_path", "initrd_path", "hvm_boot_order",
 270     ]
 271
 272
 273 # OS opcodes
 274 class OpDiagnoseOS(OpCode):
 275   """Compute the list of guest operating systems."""
 276   OP_ID = "OP_OS_DIAGNOSE"
 277   __slots__ = []
 278
 279 # Exports opcodes
 280 class OpQueryExports(OpCode):
 281   """Compute the list of exported images."""
 282   OP_ID = "OP_BACKUP_QUERY"
 283   __slots__ = ["nodes"]
 284
 285 class OpExportInstance(OpCode):
 286   """Export an instance."""
 287   OP_ID = "OP_BACKUP_EXPORT"
 288   __slots__ = ["instance_name", "target_node", "shutdown"]
 289
 290
 291 # Tags opcodes
 292 class OpGetTags(OpCode):
 293   """Returns the tags of the given object."""
 294   OP_ID = "OP_TAGS_GET"
 295   __slots__ = ["kind", "name"]
 296
 297
 298 class OpSearchTags(OpCode):
 299   """Searches the tags in the cluster for a given pattern."""
 300   OP_ID = "OP_TAGS_SEARCH"
 301   __slots__ = ["pattern"]
 302
 303
 304 class OpAddTags(OpCode):
 305   """Add a list of tags on a given object."""
 306   OP_ID = "OP_TAGS_SET"
 307   __slots__ = ["kind", "name", "tags"]
 308
 309
 310 class OpDelTags(OpCode):
 311   """Remove a list of tags from a given object."""
 312   OP_ID = "OP_TAGS_DEL"
 313   __slots__ = ["kind", "name", "tags"]
 314
 315
 316 # Test opcodes
 317 class OpTestDelay(OpCode):
 318   """Sleeps for a configured amount of time.
 319
 320   This is used just for debugging and testing.
 321
 322   Parameters:
 323     - duration: the time to sleep
 324     - on_master: if true, sleep on the master
 325     - on_nodes: list of nodes in which to sleep
 326
 327   If the on_master parameter is true, it will execute a sleep on the
 328   master (before any node sleep).
 329
 330   If the on_nodes list is not empty, it will sleep on those nodes
 331   (after the sleep on the master, if that is enabled).
 332
 333   As an additional feature, the case of duration < 0 will be reported
 334   as an execution error, so this opcode can be used as a failure
 335   generator. The case of duration == 0 will not be treated specially.
 336
 337   """
 338   OP_ID = "OP_TEST_DELAY"
 339   __slots__ = ["duration", "on_master", "on_nodes"]
 340
 341
 342 class OpTestAllocator(OpCode):
 343   """Allocator framework testing.
 344
 345   This opcode has two modes:
 346     - gather and return allocator input for a given mode (allocate new
 347       or replace secondary) and a given instance definition (direction
 348       'in')
 349     - run a selected allocator for a given operation (as above) and
 350       return the allocator output (direction 'out')
 351
 352   """
 353   OP_ID = "OP_TEST_ALLOCATOR"
 354   __slots__ = [
 355     "direction", "mode", "allocator", "name",
 356     "mem_size", "disks", "disk_template",
 357     "os", "tags", "nics", "vcpus",
 358     ]