class documentation

class LUBackupExport(LogicalUnit):

View In Hierarchy

Export an instance to an image in the cluster.

Method BuildHooksEnv Build hooks env.
Method BuildHooksNodes Build hooks nodes.
Method CheckArguments Check the arguments.
Method CheckPrereq Check prerequisites.
Method DeclareLocks Last minute lock declaration.
Method DoReboot Returns true iff the instance needs to be started after transfer.
Method Exec Export an instance to an image in the cluster.
Method ExpandNames Expand names for this LU.
Method StartInstance Send the node instructions to start the instance.
Method TrySnapshot Returns true if there is a reason to prefer a snapshot.
Method ZeroFreeSpace Zeroes the free space on a shutdown instance.
Constant HPATH Undocumented
Constant REQ_BGL Undocumented
Instance Variable dest_disk_info Undocumented
Instance Variable dest_x509_ca Undocumented
Instance Variable dest_x509_ca_pem Undocumented
Instance Variable dst_node Undocumented
Instance Variable inst_disks Undocumented
Instance Variable instance Undocumented
Instance Variable recalculate_locks Undocumented
Instance Variable secondary_nodes Undocumented
Instance Variable x509_key_name Undocumented
Method _CleanupExports Removes exports of current instance from all other nodes.
Method _InstanceDiskSizeSum Calculates the size of all the disks of the instance used in this LU.
Instance Variable _cds Undocumented

Inherited from LogicalUnit:

Method __init__ Constructor for LogicalUnit.
Method AssertReleasedLocks Raise AssertionError if the LU holds some locks of the given level.
Method HooksCallBack Notify the LU about the results of its hooks.
Method owned_locks Return the list of locks owned by the LU at a given level.
Method PreparePostHookNodes Extend list of nodes to run the post LU hook.
Method PrepareRetry Prepare the LU to run again.
Method release_request Return a request to release the specified locks of the given level.
Method WConfdClient Undocumented
Constant HTYPE Undocumented
Instance Variable add_locks Undocumented
Instance Variable cfg Undocumented
Instance Variable dont_collate_locks Undocumented
Instance Variable dry_run_result the value (if any) that will be returned to the caller in dry-run mode (signalled by opcode dry_run parameter)
Instance Variable Log Undocumented
Instance Variable LogInfo Undocumented
Instance Variable LogStep Undocumented
Instance Variable LogWarning Undocumented
Instance Variable needed_locks Undocumented
Instance Variable op Undocumented
Instance Variable opportunistic_locks Undocumented
Instance Variable opportunistic_locks_count Undocumented
Instance Variable proc Undocumented
Instance Variable rpc Undocumented
Instance Variable share_locks Undocumented
Instance Variable tasklets Undocumented
Instance Variable wconfd Undocumented
Instance Variable wconfdcontext Undocumented
Instance Variable wconfdlocks Undocumented
Method _ExpandAndLockInstance Helper function to expand and lock an instance.
Method _LockInstancesNodes Helper function to declare instances' nodes for locking.
def BuildHooksEnv(self):

Build hooks env.

This will run on the master, primary node and target node.

def BuildHooksNodes(self):

Build hooks nodes.

def CheckArguments(self):

Check the arguments.

def CheckPrereq(self):

Check prerequisites.

This checks that the instance and node names are valid.

def DeclareLocks(self, level):

Last minute lock declaration.

def DoReboot(self):

Returns true iff the instance needs to be started after transfer.

def Exec(self, feedback_fn):

Export an instance to an image in the cluster.

def ExpandNames(self):

Expand names for this LU.

This method is called before starting to execute the opcode, and it should update all the parameters of the opcode to their canonical form (e.g. a short node name must be fully expanded after this method has successfully completed). This way locking, hooks, logging, etc. can work correctly.

LUs which implement this method must also populate the self.needed_locks member, as a dict with lock levels as keys, and a list of needed lock names as values. Rules:

  • use an empty dict if you don't need any lock
  • if you don't need any lock at a particular level omit that level (note that in this case DeclareLocks won't be called at all for that level)
  • if you need locks at a level, but you can't calculate it in this function, initialise that level with an empty list and do further processing in LogicalUnit.DeclareLocks (see that function's docstring)
  • don't put anything for the BGL level
  • if you want all locks at a level use locking.ALL_SET as a value

If you need to share locks (rather than acquire them exclusively) at one level you can modify self.share_locks, setting a true value (usually 1) for that level. By default locks are not shared.

This function can also define a list of tasklets, which then will be executed in order instead of the usual LU-level CheckPrereq and Exec functions, if those are not defined by the LU.

Examples:

  # Acquire all nodes and one instance
  self.needed_locks = {
    locking.LEVEL_NODE: locking.ALL_SET,
    locking.LEVEL_INSTANCE: ['instance1.example.com'],
  }
  # Acquire just two nodes
  self.needed_locks = {
    locking.LEVEL_NODE: ['node1-uuid', 'node2-uuid'],
  }
  # Acquire no locks
  self.needed_locks = {} # No, you can't leave it to the default value None
def StartInstance(self, feedback_fn, src_node_uuid):

Send the node instructions to start the instance.

Raises
errors.OpExecErrorIf the instance didn't start up.
def TrySnapshot(self):

Returns true if there is a reason to prefer a snapshot.

def ZeroFreeSpace(self, feedback_fn):

Zeroes the free space on a shutdown instance.

Parameters
feedback_fn:functionFunction used to log progress
HPATH: str =

Undocumented

Value
'instance-export'
REQ_BGL: bool =

Undocumented

Value
False
dest_disk_info =

Undocumented

dest_x509_ca =

Undocumented

dest_x509_ca_pem =

Undocumented

dst_node =

Undocumented

inst_disks =

Undocumented

instance =

Undocumented

recalculate_locks =
secondary_nodes =

Undocumented

x509_key_name =

Undocumented

def _CleanupExports(self, feedback_fn):

Removes exports of current instance from all other nodes.

If an instance in a cluster with nodes A..D was exported to node C, its exports will be removed from the nodes A, B and D.

def _InstanceDiskSizeSum(self):

Calculates the size of all the disks of the instance used in this LU.

Returns
intSize of the disks in MiB
_cds =

Undocumented