Package ganeti :: Package cmdlib :: Module backup :: Class LUBackupExport
[hide private]
[frames] | no frames]

Class LUBackupExport

source code


Export an instance to an image in the cluster.

Instance Methods [hide private]
 
CheckArguments(self)
Check the arguments.
source code
 
ExpandNames(self)
Expand names for this LU.
source code
 
DeclareLocks(self, level)
Last minute lock declaration.
source code
dict
BuildHooksEnv(self)
Build hooks env.
source code
tuple; (list, list)
BuildHooksNodes(self)
Build hooks nodes.
source code
 
CheckPrereq(self)
Check prerequisites.
source code
 
_CleanupExports(self, feedback_fn)
Removes exports of current instance from all other nodes.
source code
int
_InstanceDiskSizeSum(self)
Calculates the size of all the disks of the instance used in this LU.
source code
 
ZeroFreeSpace(self, feedback_fn)
Zeroes the free space on a shutdown instance.
source code
 
StartInstance(self, feedback_fn, src_node_uuid)
Send the node instructions to start the instance.
source code
 
TrySnapshot(self)
Returns true if there is a reason to prefer a snapshot.
source code
 
DoReboot(self)
Returns true iff the instance needs to be started after transfer.
source code
 
Exec(self, feedback_fn)
Export an instance to an image in the cluster.
source code

Inherited from base.LogicalUnit: AssertReleasedLocks, HooksCallBack, PreparePostHookNodes, PrepareRetry, WConfdClient, __init__, owned_locks, release_request

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  HPATH = "instance-export"
hash(x)
  HTYPE = constants.HTYPE_INSTANCE
hash(x)
  REQ_BGL = False
Instance Variables [hide private]

Inherited from base.LogicalUnit: dry_run_result

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

CheckArguments(self)

source code 

Check the arguments.

Overrides: base.LogicalUnit.CheckArguments

ExpandNames(self)

source code 

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
Overrides: base.LogicalUnit.ExpandNames
(inherited documentation)

DeclareLocks(self, level)

source code 

Last minute lock declaration.

Parameters:
  • level - Locking level which is going to be locked
Overrides: base.LogicalUnit.DeclareLocks

BuildHooksEnv(self)

source code 

Build hooks env.

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

Returns: dict
Dictionary containing the environment that will be used for running the hooks for this LU. The keys of the dict must not be prefixed with "GANETI_"--that'll be added by the hooks runner. The hooks runner will extend the environment with additional variables. If no environment should be defined, an empty dictionary should be returned (not None).
Overrides: base.LogicalUnit.BuildHooksEnv

BuildHooksNodes(self)

source code 

Build hooks nodes.

Returns: tuple; (list, list)
Tuple containing a list of node UUIDs on which the hook should run before the execution and a list of node UUIDs on which the hook should run after the execution. No nodes should be returned as an empty list (and not None).
Overrides: base.LogicalUnit.BuildHooksNodes

CheckPrereq(self)

source code 

Check prerequisites.

This checks that the instance and node names are valid.

Overrides: base.LogicalUnit.CheckPrereq

_CleanupExports(self, feedback_fn)

source code 

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.

_InstanceDiskSizeSum(self)

source code 

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

Returns: int
Size of the disks in MiB

ZeroFreeSpace(self, feedback_fn)

source code 

Zeroes the free space on a shutdown instance.

Parameters:
  • feedback_fn (function) - Function used to log progress

StartInstance(self, feedback_fn, src_node_uuid)

source code 

Send the node instructions to start the instance.

Raises:

Exec(self, feedback_fn)

source code 

Export an instance to an image in the cluster.

Overrides: base.LogicalUnit.Exec