-# Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
+# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
# and others. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
import os
import paramiko
-from ansible.parsing.dataloader import DataLoader
-from ansible.vars import VariableManager
-from ansible.inventory import Inventory
-from ansible.executor.playbook_executor import PlaybookExecutor
+try:
+ from ansible.parsing.dataloader import DataLoader
+ from ansible.vars.manager import VariableManager
+ from ansible.inventory.manager import InventoryManager
+ from ansible.executor.playbook_executor import PlaybookExecutor
+except:
+ pass
__author__ = 'spisarski'
logger = logging.getLogger('ansible_utils')
-def apply_playbook(playbook_path, hosts_inv, host_user, ssh_priv_key_file_path, variables=None, proxy_setting=None):
+def apply_playbook(playbook_path, hosts_inv, host_user,
+ ssh_priv_key_file_path=None, password=None, variables=None,
+ proxy_setting=None):
"""
Executes an Ansible playbook to the given host
:param playbook_path: the (relative) path to the Ansible playbook
- :param hosts_inv: a list of hostnames/ip addresses to which to apply the Ansible playbook
- :param host_user: A user for the host instances (must be a password-less sudo user if playbook has "sudo: yes"
- :param ssh_priv_key_file_path: the file location of the ssh key
- :param variables: a dictionary containing any substitution variables needed by the Jinga 2 templates
+ :param hosts_inv: a list of hostnames/ip addresses to which to apply the
+ Ansible playbook
+ :param host_user: A user for the host instances (must be a password-less
+ sudo user if playbook has "sudo: yes"
+ :param ssh_priv_key_file_path: the file location of the ssh key. Required
+ if password is None
+ :param password: the file location of the ssh key. Required if
+ ssh_priv_key_file_path is None
+ :param variables: a dictionary containing any substitution variables needed
+ by the Jinga 2 templates
:param proxy_setting: instance of os_credentials.ProxySettings class
:return: the results
"""
if not os.path.isfile(playbook_path):
- raise Exception('Requested playbook not found - ' + playbook_path)
- if not os.path.isfile(ssh_priv_key_file_path):
- raise Exception('Requested private SSH key not found - ' + ssh_priv_key_file_path)
+ raise AnsibleException(
+ 'Requested playbook not found - ' + playbook_path)
+
+ pk_file_path = None
+ if ssh_priv_key_file_path:
+ pk_file_path = os.path.expanduser(ssh_priv_key_file_path)
+ if not password:
+ if not os.path.isfile(pk_file_path):
+ raise AnsibleException('Requested private SSH key not found - ' +
+ pk_file_path)
+
+ if not ssh_priv_key_file_path and not password:
+ raise AnsibleException('Invalid credentials, no priv key or password')
+
+ passwords = None
+ if password:
+ passwords = {'conn_pass': password, 'become_pass': password}
import ansible.constants
ansible.constants.HOST_KEY_CHECKING = False
- variable_manager = VariableManager()
+ loader = DataLoader()
+ inventory = InventoryManager(loader=loader)
+ for host in hosts_inv:
+ inventory.add_host(host=host, group='ungrouped')
+ variable_manager = VariableManager(loader=loader, inventory=inventory)
if variables:
variable_manager.extra_vars = variables
- loader = DataLoader()
- inventory = Inventory(loader=loader, variable_manager=variable_manager, host_list=hosts_inv)
- variable_manager.set_inventory(inventory)
-
ssh_extra_args = None
if proxy_setting and proxy_setting.ssh_proxy_cmd:
- ssh_extra_args = '-o ProxyCommand=\'' + proxy_setting.ssh_proxy_cmd + '\''
-
- options = namedtuple('Options', ['listtags', 'listtasks', 'listhosts', 'syntax', 'connection', 'module_path',
- 'forks', 'remote_user', 'private_key_file', 'ssh_common_args', 'ssh_extra_args',
- 'become', 'become_method', 'become_user', 'verbosity', 'check'])
-
- ansible_opts = options(listtags=False, listtasks=False, listhosts=False, syntax=False, connection='ssh',
- module_path=None, forks=100, remote_user=host_user, private_key_file=ssh_priv_key_file_path,
- ssh_common_args=None, ssh_extra_args=ssh_extra_args, become=None, become_method=None,
- become_user=None, verbosity=11111, check=False)
-
- logger.debug('Setting up Ansible Playbook Executor for playbook - ' + playbook_path)
+ ssh_extra_args = '-o ProxyCommand=\'%s\'' % proxy_setting.ssh_proxy_cmd
+
+ options = namedtuple(
+ 'Options', ['listtags', 'listtasks', 'listhosts', 'syntax',
+ 'connection', 'module_path', 'forks', 'remote_user',
+ 'private_key_file', 'ssh_common_args', 'ssh_extra_args',
+ 'become', 'become_method', 'become_user', 'verbosity',
+ 'check', 'timeout', 'diff'])
+
+ ansible_opts = options(
+ listtags=False, listtasks=False, listhosts=False, syntax=False,
+ connection='ssh', module_path=None, forks=100, remote_user=host_user,
+ private_key_file=pk_file_path, ssh_common_args=None,
+ ssh_extra_args=ssh_extra_args, become=None, become_method=None,
+ become_user=None, verbosity=11111, check=False, timeout=30, diff=None)
+
+ logger.debug('Setting up Ansible Playbook Executor for playbook - ' +
+ playbook_path)
executor = PlaybookExecutor(
playbooks=[playbook_path],
inventory=inventory,
variable_manager=variable_manager,
loader=loader,
options=ansible_opts,
- passwords=None)
+ passwords=passwords)
logger.debug('Executing Ansible Playbook - ' + playbook_path)
return executor.run()
-def ssh_client(ip, user, private_key_filepath, proxy_settings=None):
+def ssh_client(ip, user, private_key_filepath=None, password=None,
+ proxy_settings=None):
"""
Retrieves and attemts an SSH connection
:param ip: the IP of the host to connect
:param user: the user with which to connect
- :param private_key_filepath: the path to the private key file
- :param proxy_settings: instance of os_credentials.ProxySettings class (optional)
+ :param private_key_filepath: when None, password is required
+ :param password: when None, private_key_filepath is required
+ :param proxy_settings: instance of os_credentials.ProxySettings class
+ (optional)
:return: the SSH client if can connect else false
"""
logger.debug('Retrieving SSH client')
proxy_cmd_str = proxy_cmd_str.replace("%p", '22')
proxy_cmd = paramiko.ProxyCommand(proxy_cmd_str)
- ssh.connect(ip, username=user, key_filename=private_key_filepath, sock=proxy_cmd)
+ pk_abs_path = None
+ if not password and private_key_filepath:
+ pk_abs_path = os.path.expanduser(private_key_filepath)
+
+ ssh.connect(
+ ip, username=user, key_filename=pk_abs_path, password=password,
+ sock=proxy_cmd)
return ssh
except Exception as e:
- logger.warn('Unable to connect via SSH with message - ' + e.message)
+ logger.warning('Unable to connect via SSH with message - ' + str(e))
+
+
+class AnsibleException(Exception):
+ """
+ Exception when calls to the Keystone client cannot be served properly
+ """
Code Review / snaps.git / blobdiff