clap.role_manager

Module Contents

Classes

Role

RoleActionInfo

RoleManager

RoleVariableInfo

Attributes

logger

exception clap.role_manager.InvalidActionError(role_name, action_name)

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception clap.role_manager.InvalidHostError(role_name, host_name)

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception clap.role_manager.InvalidRoleError(role_name)

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception clap.role_manager.MissingActionVariableError(role_name, action_name, var)

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception clap.role_manager.NodeRoleError(node_id, role_name, host_name=None)

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

class clap.role_manager.Role
actions :Optional[Dict[str, RoleActionInfo]]
hosts :Optional[List[str]]
class clap.role_manager.RoleActionInfo
description :Optional[str]
playbook :str
vars :Optional[List[RoleVariableInfo]]
exception clap.role_manager.RoleAssignmentError

Bases: RoleError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

exception clap.role_manager.RoleError

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

class clap.role_manager.RoleManager(node_repository_controller, role_dir, actions_dir, private_dir, discard_invalids=True, load=True)
_check_nodes_role(self, role_name, host_map)
Parameters
add_role(self, role_name, hosts_node_map, host_vars=None, node_vars=None, extra_args=None, quiet=False)
Parameters

  • role_name (str) –

  • hosts_node_map (Union[List[str], Dict[str, List[str]]]) –

  • host_vars (Dict[str, Dict[str, str]]) –

  • node_vars (Dict[str, Dict[str, str]]) –

  • extra_args (Dict[str, str]) –

  • quiet (bool) –

Return type

List[str]

get_all_role_nodes(self, role_name)
Parameters

role_name (str) –

Return type

List[str]

get_all_role_nodes_hosts(self, role_name)
Parameters

role_name (str) –

Return type

Dict[str, List[str]]

get_role_node_hosts(self, role_name, node_id)
Parameters

  • role_name (str) –

  • node_id (str) –

Return type

List[str]

get_role_nodes(self, role_name, from_node_ids=None)
Parameters

  • role_name (str) –

  • from_node_ids (List[str]) –

Return type

Dict[str, List[str]]

load_roles(self)
perform_action(self, role_name, action_name, hosts_node_map, host_vars=None, node_vars=None, extra_args=None, quiet=False, validate_nodes_in_role=True)
Parameters

  • role_name (str) –

  • action_name (str) –

  • hosts_node_map (Union[List[str], Dict[str, List[str]]]) –

  • host_vars (Dict[str, Dict[str, str]]) –

  • node_vars (Dict[str, Dict[str, str]]) –

  • extra_args (Dict[str, str]) –

  • quiet (bool) –

  • validate_nodes_in_role (bool) –

Return type

clap.executor.AnsiblePlaybookExecutor.PlaybookResult

remove_role(self, role_name, hosts_node_map)
Parameters

  • role_name (str) –

  • hosts_node_map (Union[List[str], Dict[str, List[str]]]) –

Return type

List[str]

class clap.role_manager.RoleVariableInfo
description :Optional[str]
name :str
optional :Optional[bool] = False
clap.role_manager.logger