Package ganeti :: Package cmdlib :: Module node :: Class LUNodeSetParams
[hide private]
[frames] | no frames]

Class LUNodeSetParams

source code


Modifies the parameters of a node.

Instance Methods [hide private]
 
CheckArguments(self)
Check syntactic validity for the opcode arguments.
source code
 
_InstanceFilter(self, instance)
Filter for getting affected instances.
source code
 
ExpandNames(self)
Expand names for this LU.
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
 
Exec(self, feedback_fn)
Modifies a node.
source code

Inherited from base.LogicalUnit: AssertReleasedLocks, DeclareLocks, 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 = "node-modify"
hash(x)
  HTYPE = constants.HTYPE_NODE
hash(x)
  REQ_BGL = False
  _F2R = {(True, False, False): _ROLE_CANDIDATE, (False, True, F...
a dictionary from tuples of flags (mc, drained, offline) to the node role (as _ROLE_*)
  _R2F = dict((v, k) for k, v in _F2R.items())
a dictionary from node role to tuples of flags
  _FLAGS = ["master_candidate", "drained", "offline"]
a list of attribute names corresponding to the flags
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 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.

Overrides: base.LogicalUnit.CheckArguments
(inherited documentation)

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)

BuildHooksEnv(self)

source code 

Build hooks env.

This runs on the master 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 only checks the instance list against the existing names.

Overrides: base.LogicalUnit.CheckPrereq

Exec(self, feedback_fn)

source code 

Modifies a node.

Overrides: base.LogicalUnit.Exec

Class Variable Details [hide private]

_F2R

a dictionary from tuples of flags (mc, drained, offline) to the node role (as _ROLE_*)
Value:
{(True, False, False): _ROLE_CANDIDATE, (False, True, False): _ROLE_DR\
AINED, (False, False, True): _ROLE_OFFLINE, (False, False, False): _RO\
LE_REGULAR,}