X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/538475caba3a3d9e15ba21a3da7c12336d578621..aa74b82881a5913d8f983fcd6c63c00bf485c0c8:/lib/opcodes.py diff --git a/lib/opcodes.py b/lib/opcodes.py index 117757f..2984185 100644 --- a/lib/opcodes.py +++ b/lib/opcodes.py @@ -24,11 +24,8 @@ This module implements the data structures which define the cluster operations - the so-called opcodes. - -This module implements the logic for doing operations in the cluster. There -are two kinds of classes defined: - - opcodes, which are small classes only holding data for the task at hand - - logical units, which know how to deal with their specific opcode only +Every operation which modifies the cluster state is expressed via +opcodes. """ @@ -37,16 +34,24 @@ are two kinds of classes defined: # pylint: disable-msg=R0903 -class BaseJO(object): +class BaseOpCode(object): """A simple serializable object. - This object serves as a parent class for both OpCode and Job since - they are serialized in the same way. + This object serves as a parent class for OpCode without any custom + field handling. """ __slots__ = [] def __init__(self, **kwargs): + """Constructor for BaseOpCode. + + The constructor takes only keyword arguments and will set + attributes on this object based on the passed arguments. As such, + it means that you should not pass arguments which are not in the + __slots__ attribute for this class. + + """ for key in kwargs: if key not in self.__slots__: raise TypeError("Object %s doesn't support the parameter '%s'" % @@ -54,6 +59,15 @@ class BaseJO(object): setattr(self, key, kwargs[key]) def __getstate__(self): + """Generic serializer. + + This method just returns the contents of the instance as a + dictionary. + + @rtype: C{dict} + @return: the instance attributes and their values + + """ state = {} for name in self.__slots__: if hasattr(self, name): @@ -61,6 +75,15 @@ class BaseJO(object): return state def __setstate__(self, state): + """Generic unserializer. + + This method just restores from the serialized state the attributes + of the current instance. + + @param state: the serialized opcode data + @type state: C{dict} + + """ if not isinstance(state, dict): raise ValueError("Invalid data to __setstate__: expected dict, got %s" % type(state)) @@ -73,61 +96,31 @@ class BaseJO(object): setattr(self, name, state[name]) -class Job(BaseJO): - """Job definition structure +class OpCode(BaseOpCode): + """Abstract OpCode. - The Job definitions has two sets of parameters: - - the parameters of the job itself (all filled by server): - - job_id, - - status: pending, running, successfull, failed, aborted - - opcode parameters: - - op_list, list of opcodes, clients creates this - - op_status, status for each opcode, server fills in - - op_result, result for each opcode, server fills in + This is the root of the actual OpCode hierarchy. All clases derived + from this class should override OP_ID. - """ - STATUS_PENDING = 1 - STATUS_RUNNING = 2 - STATUS_SUCCESS = 3 - STATUS_FAIL = 4 - STATUS_ABORT = 5 + @cvar OP_ID: The ID of this opcode. This should be unique amongst all + childre of this class. - __slots__ = [ - "job_id", - "status", - "op_list", - "op_status", - "op_result", - ] - - def __getstate__(self): - """Specialized getstate for jobs - - """ - data = BaseJO.__getstate__(self) - if "op_list" in data: - data["op_list"] = [op.__getstate__() for op in data["op_list"]] - return data - - def __setstate__(self, state): - """Specialized setstate for jobs - - """ - BaseJO.__setstate__(self, state) - if "op_list" in state: - self.op_list = [OpCode.LoadOpCode(op) for op in state["op_list"]] - - -class OpCode(BaseJO): - """Abstract OpCode""" + """ OP_ID = "OP_ABSTRACT" __slots__ = [] def __getstate__(self): """Specialized getstate for opcodes. + This method adds to the state dictionary the OP_ID of the class, + so that on unload we can identify the correct class for + instantiating the opcode. + + @rtype: C{dict} + @return: the state as a dictionary + """ - data = BaseJO.__getstate__(self) + data = BaseOpCode.__getstate__(self) data["OP_ID"] = self.OP_ID return data @@ -135,6 +128,13 @@ class OpCode(BaseJO): def LoadOpCode(cls, data): """Generic load opcode method. + The method identifies the correct opcode class from the dict-form + by looking for a OP_ID key, if this is not found, or its value is + not available in this module as a child of this class, we fail. + + @type data: C{dict} + @param data: the serialized opcode + """ if not isinstance(data, dict): raise ValueError("Invalid data to LoadOpCode (%s)" % type(data)) @@ -159,16 +159,13 @@ class OpCode(BaseJO): return op -class OpInitCluster(OpCode): - """Initialise the cluster.""" - OP_ID = "OP_CLUSTER_INIT" - __slots__ = ["cluster_name", "secondary_ip", "hypervisor_type", - "vg_name", "mac_prefix", "def_bridge", "master_netdev", - "file_storage_dir"] +class OpDestroyCluster(OpCode): + """Destroy the cluster. + This opcode has no other parameters. All the state is irreversibly + lost after the execution of this opcode. -class OpDestroyCluster(OpCode): - """Destroy the cluster.""" + """ OP_ID = "OP_CLUSTER_DESTROY" __slots__ = [] @@ -179,20 +176,16 @@ class OpQueryClusterInfo(OpCode): __slots__ = [] -class OpClusterCopyFile(OpCode): - """Copy a file to multiple nodes.""" - OP_ID = "OP_CLUSTER_COPYFILE" - __slots__ = ["nodes", "filename"] - - -class OpRunClusterCommand(OpCode): - """Run a command on multiple nodes.""" - OP_ID = "OP_CLUSTER_RUNCOMMAND" - __slots__ = ["nodes", "command"] +class OpVerifyCluster(OpCode): + """Verify the cluster state. + @type skip_checks: C{list} + @ivar skip_checks: steps to be skipped from the verify process; this + needs to be a subset of + L{constants.VERIFY_OPTIONAL_CHECKS}; currently + only L{constants.VERIFY_NPLUSONE_MEM} can be passed -class OpVerifyCluster(OpCode): - """Verify the cluster state.""" + """ OP_ID = "OP_CLUSTER_VERIFY" __slots__ = ["skip_checks"] @@ -204,7 +197,7 @@ class OpVerifyDisks(OpCode): Result: two lists: - list of node names with bad data returned (unreachable, etc.) - - dist of node names with broken volume groups (values: error msg) + - dict 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) @@ -222,12 +215,6 @@ class OpVerifyDisks(OpCode): __slots__ = [] -class OpMasterFailover(OpCode): - """Do a master failover.""" - OP_ID = "OP_CLUSTER_MASTERFAILOVER" - __slots__ = [] - - class OpDumpClusterConfig(OpCode): """Dump the cluster configuration.""" OP_ID = "OP_CLUSTER_DUMPCONFIG" @@ -235,13 +222,25 @@ class OpDumpClusterConfig(OpCode): class OpRenameCluster(OpCode): - """Rename the cluster.""" + """Rename the cluster. + + @type name: C{str} + @ivar name: The new name of the cluster. The name and/or the master IP + address will be changed to match the new name and its IP + address. + + """ OP_ID = "OP_CLUSTER_RENAME" __slots__ = ["name"] class OpSetClusterParams(OpCode): - """Change the parameters of the cluster.""" + """Change the parameters of the cluster. + + @type vg_name: C{str} or C{None} + @ivar vg_name: The new volume group name or None to disable LVM usage. + + """ OP_ID = "OP_CLUSTER_SET_PARAMS" __slots__ = ["vg_name"] @@ -249,15 +248,41 @@ class OpSetClusterParams(OpCode): # node opcodes class OpRemoveNode(OpCode): - """Remove a node.""" + """Remove a node. + + @type node_name: C{str} + @ivar node_name: The name of the node to remove. If the node still has + instances on it, the operation will fail. + + """ OP_ID = "OP_NODE_REMOVE" __slots__ = ["node_name"] class OpAddNode(OpCode): - """Add a node.""" + """Add a node to the cluster. + + @type node_name: C{str} + @ivar node_name: The name of the node to add. This can be a short name, + but it will be expanded to the FQDN. + @type primary_ip: IP address + @ivar primary_ip: The primary IP of the node. This will be ignored when the + opcode is submitted, but will be filled during the node + add (so it will be visible in the job query). + @type secondary_ip: IP address + @ivar secondary_ip: The secondary IP of the node. This needs to be passed + if the cluster has been initialized in 'dual-network' + mode, otherwise it must not be given. + @type readd: C{bool} + @ivar readd: Whether to re-add an existing node to the cluster. If + this is not passed, then the operation will abort if the node + name is already in the cluster; use this parameter to 'repair' + a node that had its configuration broken, or was reinstalled + without removal from the cluster. + + """ OP_ID = "OP_NODE_ADD" - __slots__ = ["node_name", "primary_ip", "secondary_ip"] + __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"] class OpQueryNodes(OpCode): @@ -282,9 +307,10 @@ class OpCreateInstance(OpCode): "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", + "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi", + "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address", "file_storage_dir", "file_driver", - "iallocator", + "iallocator", "hvm_nic_type", "hvm_disk_type", ] @@ -328,7 +354,7 @@ class OpRebootInstance(OpCode): class OpReplaceDisks(OpCode): """Replace the disks of an instance.""" OP_ID = "OP_INSTANCE_REPLACE_DISKS" - __slots__ = ["instance_name", "remote_node", "mode", "disks"] + __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"] class OpFailoverInstance(OpCode): @@ -372,10 +398,18 @@ class OpSetInstanceParams(OpCode): OP_ID = "OP_INSTANCE_SET_PARAMS" __slots__ = [ "instance_name", "mem", "vcpus", "ip", "bridge", "mac", - "kernel_path", "initrd_path", "hvm_boot_order", + "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi", + "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address", + "hvm_nic_type", "hvm_disk_type", "force" ] +class OpGrowDisk(OpCode): + """Grow a disk of an instance.""" + OP_ID = "OP_INSTANCE_GROW_DISK" + __slots__ = ["instance_name", "disk", "amount"] + + # OS opcodes class OpDiagnoseOS(OpCode): """Compute the list of guest operating systems.""" @@ -396,6 +430,12 @@ class OpExportInstance(OpCode): __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."""