1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
# and others. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from collections import namedtuple
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
__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):
"""
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 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)
import ansible.constants
ansible.constants.HOST_KEY_CHECKING = False
variable_manager = VariableManager()
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)
executor = PlaybookExecutor(
playbooks=[playbook_path],
inventory=inventory,
variable_manager=variable_manager,
loader=loader,
options=ansible_opts,
passwords=None)
logger.debug('Executing Ansible Playbook - ' + playbook_path)
retval = executor.run()
if retval != 0:
logger.error('Playbook application failed [' + playbook_path + '] with return value of - ' + str(retval))
raise Exception('Playbook not applied - ' + playbook_path)
return retval
def ssh_client(ip, user, private_key_filepath, 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)
:return: the SSH client if can connect else false
"""
logger.debug('Retrieving SSH client')
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.MissingHostKeyPolicy())
try:
proxy_cmd = None
if proxy_settings and proxy_settings.ssh_proxy_cmd:
proxy_cmd_str = str(proxy_settings.ssh_proxy_cmd.replace('%h', ip))
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)
return ssh
except Exception as e:
logger.warn('Unable to connect via SSH with message - ' + e.message)
|
