Ansible 入门和常用模块
Posted 哀木缇
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Ansible 入门和常用模块相关的知识，希望对你有一定的参考价值。
Ansible 入门
1.1 Ansible 架构
1.1.1 Ansible 组成
- NVENTORY：Ansible管理主机的清单/etc/anaible/hosts
- MODULES：Ansible执行命令的功能模块，多数为内置核心模块，也可自定义
- PLUGINS：模块功能的补充，如连接类型插件、循环插件、变量插件、过滤插件等，该功能不常用
- API：供第三方程序调用的应用程序编程接口
1.1.2 Ansible 命令执行 来源
- USER 普通用户，即SYSTEM ADMINISTRATOR
- PLAYBOOKS：任务剧本（任务集），编排定义Ansible任务集的配置文件，由Ansible顺序依次执
- 行，通常是JSON格式的YML文件
- CMDB（配置管理数据库） API 调用
- PUBLIC/PRIVATE CLOUD API调用
- USER-> Ansible Playbook -> Ansibile
1.1.3 注意事项
- 执行ansible的主机一般称为管理端, 主控端，中控，master或堡垒机
- 主控端Python版本需要2.6或以上
- 被控端Python版本小于2.4，需要安装python-simplejson
- 被控端如开启SELinux需要安装libselinux-python
- windows 不能做为主控端
1.2 Ansible安装
官方安装文档
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
下载
https://releases.ansible.com/ansible/
#pip 下载
https://pypi.org/project/ansible/
1.2.1 包安装方式
#Centos EPEL源的rpm包安装
[root@ansible <sub>]#yum -y install ansible
#ubuntu 安装
root@ansible:</sub># apt -y install ansible
范例：ubuntu2004安装最新版ansible
root@ansible:<sub># apt search ansible
root@ansible:</sub># apt update
root@ansible:<sub># apt install software-properties-common
root@ansible:</sub># apt-add-repository --yes --update ppa:ansible/ansible
root@ansible:<sub># apt install -y ansible
root@ansible:</sub># ansible --version
ansible [core 2.12.5]
config file = /etc/ansible/ansible.cfg
configured module search path = [/root/.ansible/plugins/modules, /usr/share/ansible/plugins/modules]
ansible python module location = /usr/lib/python3/dist-packages/ansible
ansible collection location = /root/.ansible/collections:/usr/share/ansible/collections
executable location = /usr/bin/ansible
python version = 3.8.10 (default, Mar 15 2022, 12:22:08) [GCC 9.4.0]
jinja version = 2.10.1
libyaml = True
1.2.2 编译安装
[root@ansible <sub>]#yum -y install python-jinja2 PyYAML python-paramiko python-babel python-crypto
[root@ansible </sub>]#wget https://releases.ansible.com/ansible/ansible-2.8.0.tar.gz
[root@ansible <sub>]#tar xvf ansible-2.8.0.tar.gz
[root@ansible </sub>]#cd ansible-2.8.0/
[root@ansible ansible-2.8.0]#python setup.py build
[root@ansible ansible-2.8.0]#python setup.py install
[root@ansible ansible-2.8.0]#mkdir /etc/ansible
[root@ansible ansible-2.8.0]#cp -r examples/* /etc/ansible/
[root@ansible ansible]#ansible --version
ansible 2.8.0
config file = /etc/ansible/ansible.cfg
configured module search path = [u/root/.ansible/plugins/modules, u/usr/share/ansible/plugins/modules]
ansible python module location = /usr/lib/python2.7/site-packages/ansible-2.8.0-py2.7.egg/ansible
executable location = /usr/bin/ansible
python version = 2.7.5 (default, Oct 14 2020, 14:45:30) [GCC 4.8.5 20150623 (Red Hat 4.8.5-44)]
1.2.3 Git 方式
git clone git://github.com/ansible/ansible.git --recursive
cd ./ansible
source ./hacking/env-setup
1.2.4 pip 方式安装
pip是安装python包的管理器，类似yum，由EPEL源提供
[root@centos7 <sub>]#yum install python-pip -y
[root@centos7 </sub>]#pip install --upgrade pip
[root@centos7 ~]#pip install ansible --upgrade
1.3 Ansible 相关文件
1.3.1 配置文件
- /etc/ansible/ansible.cfg 主配置文件，配置ansible工作特性，也可以在项目的目录中创建此文件，当前目前下如果也有ansible.cfg，则此文件优先生效，建议每个项目目录下，创建独有的ansible.cfg文件
- /etc/ansible/hosts 主机清单
- /etc/ansilbe/roles 存放角色的目录
1.3.2 ansible 主配置文件
Ansible 的配置文件可以放在多个不同地方，优先从高到低顺序如下
ANSIBLE_CONFIG #环境变量,注意此项用 ansible --version 看不到,但可以生效
./ansible.cfg #当前目录下的ansible.cfg
~/.ansible.cfg #当前用户家目录下的.ansible.cfg
/etc/ansible/ansible.cfg #系统默认配置文件
Ansible 的默认配置文件 /etc/ansible/ansible.cfg，其中大部分的配置内容无需进行修改
[defaults]
#inventory = /etc/ansible/hosts #主机列表配置文件
#library = /usr/share/my_modules/ #库文件存放目录
#remote_tmp = $HOME/.ansible/tmp #临时py命令文件存放在远程主机目录
#local_tmp = $HOME/.ansible/tmp #本机的临时命令执行目录
#forks = 5 #默认并发数
#sudo_user = root #默认sudo 用户
#ask_sudo_pass = True #每次执行ansible命令是否询问ssh密码
#ask_pass = True
#remote_port = 22
#host_key_checking = False #检查对应服务器的host_key，建议取消此行注释,实现第一次连接自动信任目标主机
#log_path=/var/log/ansible.log #日志文件，建议启用
#module_name = command #默认模块，可以修改为shell模块
[privilege_escalation] #普通用户提权配置
#become=True
#become_method=sudo
#become_user=root
#become_ask_pass=False
1.3.3 Inventory 主机清单文件
ansible的主要功用在于批量主机操作，为了便捷的使用其中的部分主机，可以在inventory 主机清单文件中将其分组
默认的inventory file为 /etc/ansible/hosts
inventory file可以有多个，且也可以通过Dynamic Inventory来动态生成
注意: 生产建议在每个项目目录下创建项目独立的hosts文件
主机清单文件格式
inventory文件遵循INI文件风格，中括号中的字符为组名。可以将同一个主机同时归并到多个不同的组中
此外，当如若目标主机使用了非默认的SSH端口，还可以在主机名称之后使用冒号加端口号来标明
如果主机名称遵循相似的命名模式，还可以使用列表的方式标识各主机
Inventory 参数说明
ansible_ssh_host #将要连接的远程主机名.与你想要设定的主机的别名不同的话,可通过此变量设置.
ansible_ssh_port #ssh端口号.如果不是默认的端口号,通过此变量设置. 可以使用 ip:端口
ansible_ssh_user #默认的 ssh 用户名
ansible_ssh_pass #ssh 密码(这种方式并不安全,我们强烈建议使用 --ask-pass 或 SSH 密钥)
ansible_sudo_pass #sudo 密码(这种方式并不安全,我们强烈建议使用 --ask-sudo-pass)
ansible_sudo_exe (new in version 1.8) #sudo 命令路径(适用于1.8及以上版本)
ansible_connection #与主机的连接类型.比如:local, ssh 或者 paramiko. Ansible 1.2 以前默
认使用 paramiko.1.2 以后默认使用 smart,smart 方式会根据是否支持 ControlPersist, 来
判断ssh 方式是否可行.
ansible_ssh_private_key_file #ssh 使用的私钥文件.适用于有多个密钥,而你不想使用 SSH 代理的
情况.
ansible_shell_type #目标系统的shell类型.默认情况下,命令的执行使用 sh 语法,可设置为
csh 或 fish.
ansible_python_interpreter #目标主机的 python 路径.适用于的情况: 系统中有多个 Python,或者命令路径不是"/usr/bin/python",比如 \\*BSD, 或者 /usr/bin/python 不是 2.X 版本的Python.之所以不使用 "/usr/bin/env" 机制,因为这要求远程用户的路径设置正确,且要求 "python"可执行程序名不可为 python以外的名字(实际有可能名为python26).与ansible_python_interpreter 的工作方式相同,可设定如 ruby 或 perl 的路径....
范例：
[test]
10.0.0.8 ansible_connection=local #指定本地连接,无需ssh配置
#ansible_connection=ssh 需要StrictHostKeyChecking no
10.0.0.7 ansible_connection=ssh ansible_ssh_port=2222 ansible_ssh_user=wang
ansible_ssh_password=magedu
10.0.0.6 ansible_connection=ssh ansible_ssh_user=root
ansible_ssh_password=123456
#执行ansible命令时显示别名,如web01
[websrvs]
web01 ansible_ssh_host=10.0.0.101
web02 ansible_ssh_host=10.0.0.102
[dbsrvs]
10.0.0.8:15210
10.0.0.18:15210
1.4 Ansible 相关工具
- /usr/bin/ansible 主程序，临时命令执行工具
- /usr/bin/ansible-doc 查看配置文档，模块功能查看工具
- /usr/bin/ansible-playbook 定制自动化任务，编排剧本工具
- /usr/bin/ansible-pull 远程执行命令工具
- /usr/bin/ansible-vault 文件加密工具
- /usr/bin/ansible-console 基于Console界面与用户交互执行的工具
- /usr/bin/ansible-galaxy 下载/上传优秀代码或Roles模块的的官网平台
利用ansible实现管理的主要方式：
- Ansible Ad-Hoc 即利用ansible命令，主要用于临时命令使用场景
- Ansible playbook 主要用于长期规划好的，大型项目的场景，需要有前期的规划过程
ansible 使用前准备
ansible 相关工具大多数是通过ssh协议，实现对远程主机的配置管理、应用部署、任务执行等功能
建议：使用此工具前，先配置ansible主控端能基于密钥认证的方式联系各个被管理节点
范例：利用sshpass批量实现基于key验证脚本
PASS=123456
#设置网段最后的地址，4-255之间，越小扫描越快
END=254
IP=`ip a s eth0 | awk -F[ /]+ NR==3print $3`
NET=$IP%.*.
rm -f /root/.ssh/id_rsa
[ -e ./SCANIP.log ] && rm -f SCANIP.log
for((i=3;i<="$END";i++));do
ping -c 1 -w 1 $NET$i &> /dev/null && echo "$NET$i" >> SCANIP.log &
done
wait
ssh-keygen -P "" -f /root/.ssh/id_rsa
rpm -q sshpass || yum -y install sshpass
sshpass -p $PASS ssh-copy-id -o StrictHostKeyChecking=no $IP
AliveIP=(`cat SCANIP.log`)
for n in $AliveIP[*];do
sshpass -p $PASS scp -o StrictHostKeyChecking=no -r /root/.ssh root@$n:
done
#把.ssh/known_hosts拷贝到所有主机，使它们第一次互相访问时不需要输入回车
for n in $AliveIP[*];do
scp /root/.ssh/known_hosts $n:.ssh/
done
1.4.1 ansible-doc
此工具用来显示模块帮助
格式
ansible-doc [options] [module...]
-l, --list #列出可用模块
-s, --snippet #显示指定模块的playbook片段
#列出所有模块
ansible-doc -l
#查看指定模块帮助用法
ansible-doc ping
#查看指定模块帮助用法
ansible-doc -s ping
1.4.2 ansible
Ansible Ad-Hoc 的执行方式的主要工具就是 ansible
格式：
ansible <host-pattern> [-m module_name] [-a args]
选项说明：
--version #显示版本
-m module #指定模块，默认为command
-v #详细过程 -vv -vvv更详细
--list-hosts #显示主机列表，可简写 --list
-C, --check #检查，并不执行
-T, --timeout=TIMEOUT #执行命令的超时时间，默认10s
-k, --ask-pass #提示输入ssh连接密码，默认Key验证
-u, --user=REMOTE_USER #执行远程执行的用户,默认root
-b, --become #代替旧版的sudo 切换
--become-user=USERNAME #指定sudo的runas用户，默认为root
-K, --ask-become-pass #提示输入sudo时的口令
-f FORKS, --forks FORKS #指定并发同时执行ansible任务的主机数
ansible的Host-pattern
用于匹配被控制的主机的列表
All ：表示所有Inventory中的所有主机
#或关系
ansible "websrvs:dbsrvs" -m ping
#逻辑与
ansible "websrvs:&dbsrvs" -m Ansible playbooks入门和编写规范Ansible Playbooks常用模块介绍常用模块集合