class documentation

class LUGroupSetParams(LogicalUnit):

View In Hierarchy

Modifies the parameters of a node group.

Method BuildHooksEnv Build hooks env.
Method BuildHooksNodes Build hooks nodes.
Method CheckArguments Check syntactic validity for the opcode arguments.
Method CheckPrereq Check prerequisites.
Method DeclareLocks Declare LU locking needs for a level
Method Exec Modifies the node group.
Method ExpandNames Expand names for this LU.
Constant HPATH Undocumented
Constant REQ_BGL Undocumented
Instance Variable group Undocumented
Instance Variable group_uuid Undocumented
Instance Variable needed_locks Undocumented
Instance Variable new_disk_state Undocumented
Instance Variable new_diskparams Undocumented
Instance Variable new_hv_state Undocumented
Instance Variable new_ipolicy Undocumented
Instance Variable new_ndparams Undocumented
Static Method _UpdateAndVerifyDiskParams Updates and verifies disk parameters.
Method _CheckIpolicy Sanity checks for the ipolicy.

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 op Undocumented
Instance Variable opportunistic_locks Undocumented
Instance Variable opportunistic_locks_count Undocumented
Instance Variable proc Undocumented
Instance Variable recalculate_locks 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):
def BuildHooksNodes(self):

Build hooks nodes.

def CheckArguments(self):

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.

def CheckPrereq(self):

Check prerequisites.

def DeclareLocks(self, level):

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.LEVELSLocking level which is going to be locked
def Exec(self, feedback_fn):

Modifies the node group.

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
HPATH: str =

Undocumented

Value
'group-modify'
REQ_BGL: bool =

Undocumented

Value
False
group =

Undocumented

group_uuid =

Undocumented

needed_locks =
new_disk_state =

Undocumented

new_diskparams =

Undocumented

new_hv_state =

Undocumented

new_ipolicy =

Undocumented

new_ndparams =

Undocumented

@staticmethod
def _UpdateAndVerifyDiskParams(old, new):

Updates and verifies disk parameters.

def _CheckIpolicy(self, cluster, owned_instance_names):

Sanity checks for the ipolicy.

Parameters
cluster:objects.Clusterthe cluster's configuration
owned_instance_names:list of stringlist of instances