ansible的模块详解

ansible 的概述

什么是ansible

Ansible是一款为类Unix系统开发的自由开源的配置和自动化工具。

它用Python写成，类似于saltstack和Puppet，但是有一个不同和优点是我们不需要在节点中安装任何客户端。

它使用SSH来和节点进行通信。Ansible基于 Python paramiko 开发，分布式，无需客户端，轻量级，配置语法使用 YMAL 及 Jinja2模板语言，更强的远程命令执行操作。

Ansible是一个基于Python开发的配置管理和应用部署工具，现在也在自动化管理领域大放异彩。它融合了众多老牌运维工具的优点，Pubbet和Saltstack能实现的功能，Ansible基本上都可以实现

• Ansible能批量配置、部署、管理上千台主机。比如以前需要切换到每个主机上执行的一或多个操作，使用Ansible只需在固定的一台Ansible控制节点上去完成所有主机的操作

• Ansible是基于模块工作的，它只是提供了一种运行框架，它本身没有完成任务的能力，真正执行操作的是Ansible的模块,

比如copy模块用于拷贝文件到远程主机上，service模块用 于管理服务的启动、停止、重启等

官方网站

https://www.ansible.com/

ansible 的特点

1、部署简单，没有客户端，只需在主控端部署Ansible环境，被控端无需做任何操作；

2、模块化：调用特定的模块，完成特定任务

3、默认使用SSH协议对设备进行管理；

4、主从集中化管理；

5、配置简单、功能强大、扩展性强；

6、支持API及自定义模块，可通过Python轻松扩展；

7、通过Playbooks来定制强大的配置、状态管理

8、对云计算平台、大数据都有很好的支持；

9、具有幂等性：一个操作在一个主机上执行一遍和执行N遍的结果是一样的

ansible是基于模块工作的，本身没有批量部署的能力。真正具有批量部署的是ansible所运行的模块，ansible只是提供一种框架。主要包括：

(1)、连接插件connection plugins：负责和被监控端实现通信；

(2)、host inventory：指定操作的主机，是一个配置文件里面定义监控的主机；

(3)、各种模块核心模块、command模块、自定义模块；

(4)、借助于插件完成记录日志邮件等功能；

(5)、playbook：剧本执行多个任务时，非必需可以让节点一次性运行多个任务

Ansible其中一个比较鲜明的特性是Agentless，即无Agent的存在，它就像普通命令一样， 并非c/s软件，也只需在某个作为控制节点的主机上安装一次Ansible即可， 通常它基于ssh连接来控制远程主机，远程主机上不需要安装Ansible或其它额外的服务。

ansible的工作原理：使用者在使用时，在服务器终端输入命令或者playbooks，会通过预定好的规则将playbook拆解为play，再组织成ansible可以识别的任务，调用模块和插件，根据主机清单通过SSH将临时文件发给远程的客户端执行并返回结果，执行结束后自动删除

• Ansible的另一个比较鲜明的特性是它的绝大多数模块都具备幂等性(idempotence)。所谓幂等性，指的是多次操作或多次执行对系统资源的影响是一致的。比如执行systemctl stop xxx命令来停止服务，当发现要停止的目标服务已经处于停止状态，它什么也不会做，所以多次停止的结果仍然是停止，不会改变结果，它是幂等的，而systemctl restart xxx是非幂等的

• Ansible的很多模块在执行时都会先判断目标节点是否要执行任务，所以，可以放心大胆地让Ansible去执行任务，重复执行某个任务绝大多数时候不会产生任何副作用

ansible的工作机制

Ansible 在管理节点将 Ansible 模块通过 SSH 协议推送到被管理端执行，执行完之后自动删除，可以使用 SVN 等来管理自定义模块及编排

ansible的组成模块

Ansible的组成由以下模块组成：

Ansible： ansible的核心模块

Host Inventory：主机清单，也就是被管理的主机列表

Playbooks：ansible的剧本，可想象为将多个任务放置在一起，一块执行

Core Modules：ansible的核心模块

Custom Modules：自定义模块

Connection Plugins：连接插件，用于与被管控主机之间基于SSH建立连接关系

Plugins：其他插件，包括记录日志等

ansible 命令行模块

命令格式：ansible <组名> -m <模块> -a <参数列表>

ansible-doc -l #列出所有已安装的模块，按q退出

command 模块

//在远程主机执行命令，不支持管道，重定向等shell的特性。

command ： ansible的默认模块，不指定-m参数的时候，使用的就是command模块；

常见的命令都可以使用，但命令的执行不是通过shell来执行的，所以< > | and & z这些操作都不可以，不支持管道，没法批量执行命令

ansible-doc -s command                          #-s 列出指定模块的描述信息和操作动作ansible 192.168.142.10 -m command -a 'date' #指定 ip 执行 date
ansible webservers -m command -a 'date'         #指定组执行 date
ansible dbservers -m command -a 'date'
ansible all -m command -a 'date'            #all 代表所有 hosts 主机
ansible all -a 'ls /'                           #如省略 -m 模块，则默认运行 command 模块

//常用的参数：

chdir：在远程主机上运行命令前提前进入目录

creates：判断指定文件是否存在，如果存在，不执行后面的操作

removes：判断指定文件是否存在，如果存在，执行后面的操作

ansible all -m command -a "chdir=/home ls ./"
ansible webservers -a "creates=/opt/aaa.txt cat /opt/aaa.txt"
ansible webservers -a "creates=/opt/123.txt cat /opt/aaa.txt"
ansible webservers -a "removes=/opt/aaa.txt cat /opt/aaa.txt"
ansible webservers -a "removes=/opt/123.txt cat /opt/aaa.txt"

shell 模块

//在远程主机执行命令，相当于调用远程主机的shell进程，然后在该shell下打开一个子shell运行命令（支持管道符号等功能）

ansible-doc -s shell   #查看shell模块的详细信息ansible dbservers -m shell -a 'echo 123456 | passwd --stdin test'
ansible dbservers -m shell -a 'echo $(ifconfig ens33 | awk "NR==2 {print $2}") | cut -d " " -f2'
ansible dbservers -m shell -a 'echo $(ifconfig ens33 | awk "NR==2 {print \$2}")

cron 模块

//在远程主机定义任务计划。其中有两种状态（state）：present表示添加（可以省略），absent表示移除。

ansible-doc -s cron #按 q 退出

//常用的参数：

minute/hour/day/month/weekday：分/时/日/月/周
job：任务计划要执行的命令
name：任务计划的名称ansible webservers -m cron -a 'minute="*/1" job="/bin/echo helloworld" name="test crontab"'
ansible webservers -a 'crontab -l'
ansible webservers -m cron -a 'name="test crontab" state=absent'    #移除计划任务，假如该计划任务没有取名字，name=None即可

user 模块

//用户管理的模块

ansible-doc -s user//常用的参数：
name：用户名，必选参数
state=present|absent：创建账号或者删除账号，present表示创建，absent表示删除
system=yes|no：是否为系统账号
uid：用户uid
group：用户基本组
shell：默认使用的shell
move_home=yes|no：如果设置的家目录已经存在，是否将已经存在的家目录进行移动
password：用户的密码，建议使用加密后的字符串
comment：用户的注释信息
remove=yes|no：当state=absent时，是否删除用户的家目录ansible dbservers -m user -a 'name="test01"'    #创建用户test01
ansible dbservers -m command -a 'tail /etc/passwd'
ansible dbservers -m user -a 'name="test01" state=absent'   #删除用户test01

group 模块

//用户组管理的模块

ansible-doc -s groupansible dbservers -m group -a 'name=mysql gid=3306 system=yes'  #创建mysql组
ansible dbservers -a 'tail /etc/group'
ansible dbservers -m user -a 'name=test uid=306 system=yes group=mysql' #将test01用户添加到mysql组中
ansible dbservers -a 'tail /etc/passwd'
ansible dbservers -a 'id test'

copy 模块

//用于复制指定主机文件到远程主机的

ansible-doc -s copy　　

//常用的参数：
dest：指出复制文件的目标及位置，使用绝对路径，如果是源目录，指目标也要是目录，如果目标文件已经存在会覆盖原有的内容
src：指出源文件的路径，可以使用相对路径或绝对路径，支持直接指定目录，如果源是目录则目标也要是目录
mode：指出复制时，目标文件的权限
owner：指出复制时，目标文件的属主
group：指出复制时，目标文件的属组
content：指出复制到目标主机上的内容，不能与src一起使用

ansible dbservers -m copy -a 'src=/etc/fstab dest=/opt/fstab.bak owner=root mode=640'
ansible dbservers -a 'ls -l /opt'
ansible dbservers -a 'cat /opt/fstab.bak'ansible dbservers -m copy -a 'content="helloworld" dest=/opt/hello.txt' #将helloworld写入/opt/hello.txt文件中
ansible dbservers -a 'cat /opt/hello.txt'

file 模块

//设置文件属性

ansible-doc -s fileansible dbservers -m file -a 'owner=test1 group=mysql mode=644 path=/opt/test8.txt'    #修改文件的属主属组权限等
ansible dbservers -m file -a 'path=/etc/file8 src=/opt/file8.txt state=link'#设置/etc/file8为/opt/file8.txt的链接文件
ansible dbservers -m file -a "path=/opt/file8.txt state=touch"    #创建一个文件
ansible dbservers -m file -a "path=/opt/file8.txt state=absent"   #删除一个文件

hostname 模块

//用于管理远程主机上的主机名

ansible webservers -m hostname -a 'name=myhost'

ping 模块

//检测远程主机的连通性

ansible all -m ping

yum 模块

//在远程主机上安装与卸载软件包

ansible-doc -s yumansible dbservers -m yum -a 'name=httpd'   #安装服务
ansible dbservers -m yum -a 'name=httpd state=absent'  #卸载服务

service/systemd 模块

//用于管理远程主机上的管理服务的运行状态

ansible-doc -s service//常用的参数：
name：被管理的服务名称
state=started|stopped|restarted：动作包含启动关闭或者重启
enabled=yes|no：表示是否设置该服务开机自启
runlevel：如果设定了enabled开机自启去，则要定义在哪些运行目标下自启动ansible dbservers -a 'systemctl status httpd'  #查看web服务器httpd运行状态
ansible dbservers -m service -a 'enabled=true name=httpd state=started'    #启动httpd服务

script 模块

//实现远程批量运行本地的 shell 脚本

ansible-doc -s scriptvim test.sh
#!/bin/bash
echo "hello ansible from script" > /opt/script.txtchmod +x test.sh
ansible dbservers -m script -a 'test.sh'
ansible dbservers -a 'cat /opt/script.txt'

setup 模块

//facts 组件是用来收集被管理节点信息的，使用 setup 模块可以获取这些信息

ansible-doc -s setupansible webservers -m setup #获取mysql组主机的facts信息
ansible dbservers -m setup -a 'filter=*ipv4' #使用filter可以筛选指定的facts信息

inventory 主机清单

//Inventory支持对主机进行分组，每个组内可以定义多个主机，每个主机都可以定义在任何一个或多个主机组内。

//如果是名称类似的主机，可以使用列表的方式标识各个主机。

vim /etc/ansible/hosts
[webservers]
192.168.142.10:2222 #冒号后定义远程连接端口，默认是 ssh 的 22 端口
192.168.142.1[2:5][dbservers]
db-[a:f].example.org    #支持匹配 a~f　　

//inventory 中的变量

Inventory变量名 含义
ansible_host ansible 连接节点时的IP地址
ansible_port 连接对方的端口号，ssh连接时默认为22
ansible_user 连接对方主机时使用的用户名。不指定时，将使用执行ansible或ansible-playbook命令的用户
ansible_password 连接时的用户的ssh密码，仅在未使用密钥对验证的情况下有效
ansible_ssh_private_key_file 指定密钥认证ssh连接时的私钥文件
ansible_ssh_common_args 提供给ssh、sftp、scp命令的额外参数
ansible_become 允许进行权限提升
ansible_become_method 指定提升权限的方式，例如可使用sudo/su/runas等方式
ansible_become_user 提升为哪个用户的权限，默认提升为root
ansible_become_password 提升为指定用户权限时的密码