Class LogicalUnit

Constructor for LogicalUnit.

This needs to be overridden in derived classes in order to check op validity.

Overrides: object.__init__

Check syntactic validity for the opcode arguments.

This method is for doing a simple syntactic check and ensure validity of opcode parameters, without any cluster-related checks. While the same can be accomplished in ExpandNames and/or CheckPrereq, doing these separate is better because:

• ExpandNames is left as as purely a lock-related function
• CheckPrereq is run after we have acquired locks (and possible waited for them)

The function is allowed to change the self.op attribute so that later methods can no longer worry about missing parameters.

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, ecc. 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
• 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.example.com', 'node2.example.com'],
 }
 # Acquire no locks
 self.needed_locks = {} # No, you can't leave it to the default value None

Declare LU locking needs for a level

While most LUs can just declare their locking needs at ExpandNames time, sometimes there's the need to calculate some locks after having acquired the ones before. This function is called just before acquiring locks at a particular level, but after acquiring the ones at lower levels, and permits such calculations. It can be used to modify self.needed_locks, and by default it does nothing.

This function is only called if you have something already set in self.needed_locks for the level.

Parameters:

• level (member of ganeti.locking.LEVELS) - Locking level which is going to be locked

Check prerequisites for this LU.

This method should check that the prerequisites for the execution of this LU are fulfilled. It can do internode communication, but it should be idempotent - no cluster or system changes are allowed.

The method should raise errors.OpPrereqError in case something is not fulfilled. Its return value is ignored.

This method should also update all the parameters of the opcode to their canonical form if it hasn't been done by ExpandNames before.

Execute the LU.

This method should implement the actual work. It should raise errors.OpExecError for failures that are somewhat dealt with in code, or expected.

Build hooks environment for this LU.

This method should return a three-node tuple consisting of: a dict containing the environment that will be used for running the specific hook for this LU, a list of node names on which the hook should run before the execution, and a list of node names on which the hook should run after the execution.

The keys of the dict must not have 'GANETI_' prefixed as this will be handled in the hooks runner. Also note additional keys will be added by the hooks runner. If the LU doesn't define any environment, an empty dict (and not None) should be returned.

No nodes should be returned as an empty list (and not None).

Note that if the HPATH for a LU class is None, this function will not be called.

Notify the LU about the results of its hooks.

This method is called every time a hooks phase is executed, and notifies the Logical Unit about the hooks' result. The LU can then use it to alter its result based on the hooks. By default the method does nothing and the previous result is passed back unchanged but any LU can define it if it wants to use the local cluster hook-scripts somehow.

Parameters:

• phase - one of constants.HOOKS_PHASE_POST or constants.HOOKS_PHASE_PRE; it denotes the hooks phase
• hook_results - the results of the multi-node hooks rpc call
• feedback_fn - function used send feedback back to the caller
• lu_result - the previous Exec result this LU had, or None in the PRE phase

Returns:

the new Exec result, based on the previous result and hook results