backend.vm_manage.manager

class backend.vm_manage.manager.VmManager(opts, logger=None)

VM manager, it is used for two purposes: - Daemon which control VMs lifecycle, requires params spawner,terminator - Client to acquire and release VM in builder process

Parameters:

• opts (Munch) – Global backend configuration
• logger (logging.Logger) – Logger instance to use inside of manager, if None manager would create new logger using helpers.get_redis_logger

set_logger(logger)

Parameters:logger (logging.Logger) – Logger to be used by manager

vm_groups

Returns:VM build groups Return type:list of int

add_vm_to_pool(vm_ip, vm_name, group)

Adds newly spawned VM into the pool of available builders

Parameters:

• vm_ip (str) – IP
• vm_name (str) – VM name
• group (int) – builder group

Return type:

VmDescriptor

lookup_vms_by_ip(vm_ip)

Parameters:vm_ip – Returns:List of found VMD with the give ip Return type:list of VmDescriptor

mark_vm_check_failed(vm_name)

mark_server_start()

can_user_acquire_more_vm(username, group)

Return bool:True when user are allowed to acquire more VM

acquire_vm(group, username, pid, task_id=None, build_id=None, chroot=None)

Try to acquire VM from pool

Parameters:

• group (int) – builder group id, as defined in config
• username – build owner username, VMM prefer to reuse an existing VM which was used by the same user
• pid – builder pid to release VM after build process unhandled death

Return type:

VmDescriptor

Raises:

NoVmAvailable when manager couldn’t find suitable VM for the given group and user

release_vm(vm_name)

Return VM into the pool. :return: True if successful :rtype: bool

start_vm_termination(vm_name, allowed_pre_state=None)

Initiate VM termination process using redis publish.

Parameters:allowed_pre_state (str constant from VmState) – When defined force check that old state is among allowed ones.

remove_vm_from_pool(vm_name)

Backend forgets about VM after this method

Raises VmError:if VM has wrong state

_load_multi_safe(vm_name_list)

get_all_vm_in_group(group)

Return type:list of VmDescriptor

get_all_vm()

Return type:list of VmDescriptor

get_vm_by_name(vm_name)

Return type:VmDescriptor

get_vm_by_task_id(task_id)

Return type:VmDescriptor

get_vm_by_group_and_state_list(group, state_list)

Select VM-s for the given group and allowed states

Parameters:

• group – filter VM-s by the build group. If group is None select VM-s from the all groups
• state_list – VM state should be in the state_list.

Returns:

Filtered VM-s

Return type:

list of VmDescriptor

info()

Present information about all managed VMs in a human readable form.

Return type:str

write_vm_pool_info(group, key, value)

read_vm_pool_info(group, key)