Module common

Expand a short node name into the node UUID and full name.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• expected_uuid (string) - expected UUID for the node (or None if there is no expectation). If it does not match, a errors.OpPrereqError is raised.
• name (string) - the short node name

Checks if the instances in a node group are still correct.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• group_uuid (string) - Node group UUID
• owned_instance_names (set or frozenset) - List of currently owned instances

Returns list of checked and expanded node names.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• short_node_names (list) - list of node names or None for all nodes

Returns: tuple of lists

tupe with (list of node UUIDs, list of node names)

Raises:

• errors.ProgrammerError - if the nodes parameter is wrong type

Returns list of checked and expanded instance names.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• short_inst_names (list) - list of instance names or None for all instances

Returns: tuple of lists

tuple of (instance UUIDs, instance names)

Raises:

• errors.OpPrereqError - if the instances parameter is wrong type
• errors.OpPrereqError - if any of the passed instances is not found

Distribute additional files which are part of the cluster configuration.

ConfigWriter takes care of distributing the config and ssconf files, but there are more files which should be distributed to all nodes. This function makes sure those are copied.

Compute files external to Ganeti which need to be consistent.

Parameters:

• redist (boolean) - Whether to include files which need to be redistributed

Combines the hv state from an opcode with the one of the object

Parameters:

• op_input - The input dict from the opcode
• obj_input - The input dict from the objects

Returns:

The verified and updated dict

Combines the disk state from an opcode with the one of the object

Parameters:

• op_input - The input dict from the opcode
• obj_input - The input dict from the objects

Returns:

The verified and updated dict

OS parameters validation.

Parameters:

• lu (LogicalUnit) - the logical unit for which we check
• required (boolean) - whether the validation should fail if the OS is not found
• node_uuids (list) - the list of nodes on which we should check
• osname (string) - the name of the hypervisor we should use
• osparams (dict) - the parameters which we need to check

Raises:

• errors.OpPrereqError - if the parameters are not valid

Hypervisor parameter validation.

This function abstracts the hypervisor parameter validation to be used in both instance create and instance modify.

Parameters:

• lu (LogicalUnit) - the logical unit for which we check
• node_uuids (list) - the list of nodes on which we should check
• hvname (string) - the name of the hypervisor we should use
• hvparams (dict) - the parameters which we need to check

Raises:

• errors.OpPrereqError - if the parameters are not valid

Verifies ipolicy against provided specs.

Parameters:

• ipolicy (dict) - The ipolicy
• mem_size (int) - The memory size
• cpu_count (int) - Used cpu cores
• disk_count (int) - Number of disks used
• nic_count (int) - Number of nics used
• disk_sizes (list of ints) - Disk sizes of used disk (len must match disk_count)
• spindle_use (int) - The number of spindles this instance uses
• disk_template (string) - The disk template of the instance
• _compute_fn - The compute function (unittest only)

Returns:

A list of violations, or an empty list of no violations are found

Compute if instance meets the specs of ipolicy.

Parameters:

• ipolicy (dict) - The ipolicy to verify against
• instance (objects.Instance) - The instance to verify
• cfg (config.ConfigWriter) - Cluster configuration
• _compute_fn - The function to verify ipolicy (unittest only)

Computes a set of any instances that would violate the new ipolicy.

Parameters:

• old_ipolicy - The current (still in-place) ipolicy
• new_ipolicy - The new (to become) ipolicy
• instances - List of instances to verify
• cfg (config.ConfigWriter) - Cluster configuration

Returns:

A list of instances which violates the new ipolicy but did not before

Return the new version of a parameter dictionary.

Parameters:

• old_params (dict) - old parameters
• update_dict (dict) - dict containing new parameter values, or constants.VALUE_DEFAULT to reset the parameter to its default value
• use_default (whether to recognise constants.VALUE_DEFAULT values as 'to be deleted' values) - boolean
• use_none (whether to recognise None values as 'to be deleted' values) - boolean

Returns: dict

the new parameter dictionary

Return the new version of an instance policy.

Parameters:

• group_policy - whether this policy applies to a group and thus we should support removal of policy entries

Little helper wrapper to the rpc annotation method.

Parameters:

• instance - The instance object
• devs (List of objects.Disk) - The root devices (not any of its children!)
• cfg - The config object @returns The annotated disk copies @see rpc.node.AnnotateDiskParams

Tells if node supports OOB.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• node (objects.Node) - The node

Returns:

The OOB script if supported or an empty string otherwise

Decides on which iallocator to use.

Parameters:

• cfg (config.ConfigWriter) - Cluster configuration object
• ialloc (string or None) - Iallocator specified in opcode

Returns: string

Iallocator name

Checks if node groups for locked instances are still correct.

Parameters:

• cfg (config.ConfigWriter) - Cluster configuration
• instances (dict; string as key, objects.Instance as value) - Dictionary, instance UUID as key, instance object as value
• owned_groups (iterable of string) - List of owned groups
• owned_node_uuids (iterable of string) - List of owned nodes
• cur_group_uuid (string or None) - Optional group UUID to check against instance's groups

Checks if the owned node groups are still correct for an instance.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• inst_uuid (string) - Instance UUID
• owned_groups (set or frozenset) - List of currently owned node groups
• primary_only (boolean) - Whether to check node groups for only the primary node

Unpacks the result of change-group and node-evacuate iallocator requests.

Iallocator modes constants.IALLOCATOR_MODE_NODE_EVAC and constants.IALLOCATOR_MODE_CHG_GROUP.

Parameters:

• lu (LogicalUnit) - Logical unit instance
• alloc_result (tuple/list) - Result from iallocator
• early_release (bool) - Whether to release locks early if possible
• use_nodes (bool) - Whether to display node names instead of groups

Creates a map from (node, volume) to instance name.

Parameters:

• instances (list of objects.Instance)

Returns: dict; tuple of (node uuid, volume name) as key, objects.Instance object as value

Make sure that none of the given paramters is global.

If a global parameter is found, an errors.OpPrereqError exception is raised. This is used to avoid setting global parameters for individual nodes.

Parameters:

• params (dictionary) - Parameters to check
• glob_pars (dictionary) - Forbidden parameters
• kind (string) - Kind of parameters (e.g. "node")
• bad_levels (string) - Level(s) at which the parameters are forbidden (e.g. "instance")
• good_levels (strings) - Level(s) at which the parameters are allowed (e.g. "cluster or group")

Whether exclusive_storage is in effect for the given node.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• node (objects.Node) - The node

Returns: bool

The effective value of exclusive_storage

Ensure that an instance is in one of the required states.

Parameters:

• lu - the LU on behalf of which we make the check
• instance - the instance to check
• msg - if passed, should be a message to replace the default one

Raises:

• errors.OpPrereqError - if the instance is not in the required state

Check the sanity of iallocator and node arguments and use the cluster-wide iallocator if appropriate.

Check that at most one of (iallocator, node) is specified. If none is specified, or the iallocator is constants.DEFAULT_IALLOCATOR_SHORTCUT, then the LU's opcode's iallocator slot is filled with the cluster-wide default iallocator.

Parameters:

• iallocator_slot (string) - the name of the opcode iallocator slot
• node_slot (string) - the name of the opcode target node slot

Ensure that a given node is online.

Parameters:

• lu - the LU on behalf of which we make the check
• node_uuid - the node to check
• msg - if passed, should be a message to replace the default one

Raises:

• errors.OpPrereqError - if the node is offline

Helper function to check if a disk template is enabled.

Parameters:

• cluster (objects.Cluster) - the cluster's configuration
• disk_template (str) - the disk template to be checked

Helper function to check if a storage type is enabled.

Parameters:

• cluster (objects.Cluster) - the cluster's configuration
• storage_type (str) - the storage type to be checked

Checks ipolicy disk templates against enabled disk tempaltes.

Parameters:

• ipolicy (dict) - the new ipolicy
• enabled_disk_templates (list of string) - list of enabled disk templates on the cluster

Raises:

• errors.OpPrereqError - if there is at least one allowed disk template that is not also enabled.

Checks if the access parameter is legal.

Raises:

• errors.OpPrereqError - if the check fails.

Checks if the access param is consistent with the cluster configuration.

Parameters:

• parameters - the parameters to validate
• cfg - the cfg object of the cluster
• group - if set, only check for consistency within this group.

Raises:

• errors.OpPrereqError - if the LU attempts to change the access parameter to an invalid value, such as "pink bunny".
• errors.OpPrereqError - if the LU attempts to change the access parameter to an inconsistent value, such as asking for RBD userspace access to the chroot hypervisor.

Checks if an hypervisor can read a disk template with given mode.

Parameters:

• hv - the hypervisor that will access the data
• disk_template - the disk template the data is stored as
• mode - how the hypervisor should access the data

Returns:

True if the hypervisor can read a given read disk_template in the specified mode.

Add the node's client SSL certificate digest to the candidate certs.

Parameters:

• node_uuid (string) - the node's UUID
• cluster (object.Cluster) - the cluster's configuration

Removes the node's certificate from the candidate certificates list.

Parameters:

• node_uuid (string) - the node's UUID
• cluster (objects.Cluster) - the cluster's configuration

Creates a new client SSL certificate for the node.

Parameters:

• node_uuid (string) - the node's UUID
• filename (string) - the certificate's filename

Returns: string

the digest of the newly created certificate

Ensure KVM daemon is running on nodes with KVM instances.

If user shutdown is enabled in the cluster:

• The KVM daemon will be started on VM capable nodes containing KVM instances.
• The KVM daemon will be stopped on non VM capable nodes.

If user shutdown is disabled in the cluster:

• The KVM daemon will be stopped on all nodes

Issues a warning for each failed RPC call.

Parameters:

• lu (LogicalUnit) - logical unit on whose behalf we execute
• feedback_fn (callable) - feedback function
• nodes (list of string) - if supplied, it overrides the node uuids to start/stop; this is used mainly for optimization

INSTANCE_NOT_RUNNING

Value:

[constants.ADMINST_DOWN, constants.ADMINST_OFFLINE]

CAN_CHANGE_INSTANCE_OFFLINE

Instance status in which an instance can be marked as offline/online

Value:

frozenset(INSTANCE_DOWN) | frozenset([constants.ADMINST_OFFLINE,])