Add gnt-backup remove functionality
[ganeti-local] / lib / opcodes.py
index a54bb43..c6cad58 100644 (file)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#
 #
 
 # Copyright (C) 2006, 2007 Google Inc.
@@ -44,8 +44,8 @@ class OpCode(object):
   def __init__(self, **kwargs):
     for key in kwargs:
       if key not in self.__slots__:
-        raise TypeError, ("OpCode %s doesn't support the parameter '%s'" %
-                          (self.__class__.__name__, key))
+        raise TypeError("OpCode %s doesn't support the parameter '%s'" %
+                        (self.__class__.__name__, key))
       setattr(self, key, kwargs[key])
 
 
@@ -63,41 +63,74 @@ class OpDestroyCluster(OpCode):
 
 
 class OpQueryClusterInfo(OpCode):
-  """Initialise the cluster."""
+  """Query cluster information."""
   OP_ID = "OP_CLUSTER_QUERY"
   __slots__ = []
 
 
 class OpClusterCopyFile(OpCode):
-  """Initialise the cluster."""
+  """Copy a file to multiple nodes."""
   OP_ID = "OP_CLUSTER_COPYFILE"
   __slots__ = ["nodes", "filename"]
 
 
 class OpRunClusterCommand(OpCode):
-  """Initialise the cluster."""
+  """Run a command on multiple nodes."""
   OP_ID = "OP_CLUSTER_RUNCOMMAND"
   __slots__ = ["nodes", "command"]
 
 
 class OpVerifyCluster(OpCode):
-  """Initialise the cluster."""
+  """Verify the cluster state."""
   OP_ID = "OP_CLUSTER_VERIFY"
+  __slots__ = ["skip_checks"]
+
+
+class OpVerifyDisks(OpCode):
+  """Verify the cluster disks.
+
+  Parameters: none
+
+  Result: two lists:
+    - list of node names with bad data returned (unreachable, etc.)
+    - dist of node names with broken volume groups (values: error msg)
+    - list of instances with degraded disks (that should be activated)
+    - dict of instances with missing logical volumes (values: (node, vol)
+      pairs with details about the missing volumes)
+
+  In normal operation, all lists should be empty. A non-empty instance
+  list (3rd element of the result) is still ok (errors were fixed) but
+  non-empty node list means some node is down, and probably there are
+  unfixable drbd errors.
+
+  Note that only instances that are drbd-based are taken into
+  consideration. This might need to be revisited in the future.
+
+  """
+  OP_ID = "OP_CLUSTER_VERIFY_DISKS"
   __slots__ = []
 
 
 class OpMasterFailover(OpCode):
-  """Initialise the cluster."""
+  """Do a master failover."""
   OP_ID = "OP_CLUSTER_MASTERFAILOVER"
   __slots__ = []
 
 
 class OpDumpClusterConfig(OpCode):
-  """Initialise the cluster."""
+  """Dump the cluster configuration."""
   OP_ID = "OP_CLUSTER_DUMPCONFIG"
   __slots__ = []
 
 
+class OpRenameCluster(OpCode):
+  """Rename the cluster."""
+  OP_ID = "OP_CLUSTER_RENAME"
+  __slots__ = ["name"]
+
+
+# node opcodes
+
 class OpRemoveNode(OpCode):
   """Remove a node."""
   OP_ID = "OP_NODE_REMOVE"
@@ -113,13 +146,7 @@ class OpAddNode(OpCode):
 class OpQueryNodes(OpCode):
   """Compute the list of nodes."""
   OP_ID = "OP_NODE_QUERY"
-  __slots__ = ["output_fields"]
-
-
-class OpQueryNodeData(OpCode):
-  """Compute the node info."""
-  OP_ID = "OP_NODE_INFO"
-  __slots__ = ["nodes"]
+  __slots__ = ["output_fields", "names"]
 
 
 class OpQueryNodeVolumes(OpCode):
@@ -131,32 +158,55 @@ class OpQueryNodeVolumes(OpCode):
 # instance opcodes
 
 class OpCreateInstance(OpCode):
-  """Compute the list of instances."""
+  """Create an instance."""
   OP_ID = "OP_INSTANCE_CREATE"
-  __slots__ = ["instance_name", "mem_size", "disk_size", "os_type", "pnode",
-               "disk_template", "snode", "swap_size", "mode",
-               "vcpus", "ip", "bridge", "src_node", "src_path", "start",
-               "wait_for_sync"]
+  __slots__ = [
+    "instance_name", "mem_size", "disk_size", "os_type", "pnode",
+    "disk_template", "snode", "swap_size", "mode",
+    "vcpus", "ip", "bridge", "src_node", "src_path", "start",
+    "wait_for_sync", "ip_check", "mac",
+    "kernel_path", "initrd_path", "hvm_boot_order",
+    "iallocator",
+    ]
+
+
+class OpReinstallInstance(OpCode):
+  """Reinstall an instance's OS."""
+  OP_ID = "OP_INSTANCE_REINSTALL"
+  __slots__ = ["instance_name", "os_type"]
 
 
 class OpRemoveInstance(OpCode):
   """Remove an instance."""
   OP_ID = "OP_INSTANCE_REMOVE"
-  __slots__ = ["instance_name"]
+  __slots__ = ["instance_name", "ignore_failures"]
+
+
+class OpRenameInstance(OpCode):
+  """Rename an instance."""
+  OP_ID = "OP_INSTANCE_RENAME"
+  __slots__ = ["instance_name", "ignore_ip", "new_name"]
 
 
 class OpStartupInstance(OpCode):
-  """Remove an instance."""
+  """Startup an instance."""
   OP_ID = "OP_INSTANCE_STARTUP"
   __slots__ = ["instance_name", "force", "extra_args"]
 
 
 class OpShutdownInstance(OpCode):
-  """Remove an instance."""
+  """Shutdown an instance."""
   OP_ID = "OP_INSTANCE_SHUTDOWN"
   __slots__ = ["instance_name"]
 
 
+class OpRebootInstance(OpCode):
+  """Reboot an instance."""
+  OP_ID = "OP_INSTANCE_REBOOT"
+  __slots__ = ["instance_name", "reboot_type", "extra_args",
+               "ignore_secondaries" ]
+
+
 class OpAddMDDRBDComponent(OpCode):
   """Add a MD-DRBD component."""
   OP_ID = "OP_INSTANCE_ADD_MDDRBD"
@@ -170,9 +220,9 @@ class OpRemoveMDDRBDComponent(OpCode):
 
 
 class OpReplaceDisks(OpCode):
-  """Replace disks of an instance."""
+  """Replace the disks of an instance."""
   OP_ID = "OP_INSTANCE_REPLACE_DISKS"
-  __slots__ = ["instance_name", "remote_node"]
+  __slots__ = ["instance_name", "remote_node", "mode", "disks"]
 
 
 class OpFailoverInstance(OpCode):
@@ -182,19 +232,19 @@ class OpFailoverInstance(OpCode):
 
 
 class OpConnectConsole(OpCode):
-  """Failover an instance."""
+  """Connect to an instance's console."""
   OP_ID = "OP_INSTANCE_CONSOLE"
   __slots__ = ["instance_name"]
 
 
 class OpActivateInstanceDisks(OpCode):
-  """Remove an instance."""
+  """Activate an instance's disks."""
   OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
   __slots__ = ["instance_name"]
 
 
 class OpDeactivateInstanceDisks(OpCode):
-  """Remove an instance."""
+  """Deactivate an instance's disks."""
   OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
   __slots__ = ["instance_name"]
 
@@ -202,7 +252,7 @@ class OpDeactivateInstanceDisks(OpCode):
 class OpQueryInstances(OpCode):
   """Compute the list of instances."""
   OP_ID = "OP_INSTANCE_QUERY"
-  __slots__ = ["output_fields"]
+  __slots__ = ["output_fields", "names"]
 
 
 class OpQueryInstanceData(OpCode):
@@ -214,7 +264,10 @@ class OpQueryInstanceData(OpCode):
 class OpSetInstanceParms(OpCode):
   """Change the parameters of an instance."""
   OP_ID = "OP_INSTANCE_SET_PARMS"
-  __slots__ = ["instance_name", "mem", "vcpus", "ip", "bridge"]
+  __slots__ = [
+    "instance_name", "mem", "vcpus", "ip", "bridge", "mac",
+    "kernel_path", "initrd_path", "hvm_boot_order",
+    ]
 
 
 # OS opcodes
@@ -233,3 +286,77 @@ class OpExportInstance(OpCode):
   """Export an instance."""
   OP_ID = "OP_BACKUP_EXPORT"
   __slots__ = ["instance_name", "target_node", "shutdown"]
+
+class OpRemoveExport(OpCode):
+  """Remove an instance's export."""
+  OP_ID = "OP_BACKUP_REMOVE"
+  __slots__ = ["instance_name"]
+
+# Tags opcodes
+class OpGetTags(OpCode):
+  """Returns the tags of the given object."""
+  OP_ID = "OP_TAGS_GET"
+  __slots__ = ["kind", "name"]
+
+
+class OpSearchTags(OpCode):
+  """Searches the tags in the cluster for a given pattern."""
+  OP_ID = "OP_TAGS_SEARCH"
+  __slots__ = ["pattern"]
+
+
+class OpAddTags(OpCode):
+  """Add a list of tags on a given object."""
+  OP_ID = "OP_TAGS_SET"
+  __slots__ = ["kind", "name", "tags"]
+
+
+class OpDelTags(OpCode):
+  """Remove a list of tags from a given object."""
+  OP_ID = "OP_TAGS_DEL"
+  __slots__ = ["kind", "name", "tags"]
+
+
+# Test opcodes
+class OpTestDelay(OpCode):
+  """Sleeps for a configured amount of time.
+
+  This is used just for debugging and testing.
+
+  Parameters:
+    - duration: the time to sleep
+    - on_master: if true, sleep on the master
+    - on_nodes: list of nodes in which to sleep
+
+  If the on_master parameter is true, it will execute a sleep on the
+  master (before any node sleep).
+
+  If the on_nodes list is not empty, it will sleep on those nodes
+  (after the sleep on the master, if that is enabled).
+
+  As an additional feature, the case of duration < 0 will be reported
+  as an execution error, so this opcode can be used as a failure
+  generator. The case of duration == 0 will not be treated specially.
+
+  """
+  OP_ID = "OP_TEST_DELAY"
+  __slots__ = ["duration", "on_master", "on_nodes"]
+
+
+class OpTestAllocator(OpCode):
+  """Allocator framework testing.
+
+  This opcode has two modes:
+    - gather and return allocator input for a given mode (allocate new
+      or replace secondary) and a given instance definition (direction
+      'in')
+    - run a selected allocator for a given operation (as above) and
+      return the allocator output (direction 'out')
+
+  """
+  OP_ID = "OP_TEST_ALLOCATOR"
+  __slots__ = [
+    "direction", "mode", "allocator", "name",
+    "mem_size", "disks", "disk_template",
+    "os", "tags", "nics", "vcpus",
+    ]