ansible 简介
ansible是新出现的自动化运维工具,基于Python开发,集合了众多运维工具(puppet、chef、func、fabric)的优点,实现了批量系统配置、批量程序部署、批量运行命令等功能。
ansible 特点
- 部署简单,只需在主控端部署Ansible环境,被控端无需做任何操作;
- 默认使用SSH协议对设备进行管理;
- 有大量常规运维操作模块,可实现日常绝大部分操作;
- 配置简单、功能强大、扩展性强;
- 支持API及自定义模块,可通过Python轻松扩展;
- 通过Playbooks来定制强大的配置、状态管理;
- 轻量级,无需在客户端安装agent,更新时,只需在操作机上进行一次更新即可;
- 提供一个功能强大、操作性强的Web管理界面和REST API接口——AWX平台。
ansible 任务执行
Ansible 系统由控制主机对被管节点的操作方式可分为两类,即adhoc和playbook:
ad-hoc模式(点对点模式)
使用单个模块,支持批量执行单条命令。ad-hoc 命令是一种可以快速输入的命令,而且不需要保存起来的命令。就相当于bash中的一句话shell。
playbook模式(剧本模式)
是Ansible主要管理方式,也是Ansible功能强大的关键所在。playbook通过多个task集合完成一类功能,如Web服务的安装部署、数据库服务器的批量备份等。可以简单地把playbook理解为通过组合多条ad-hoc操作的配置文件。
简单理解就是Ansible在运行时, 首先读取ansible.cfg中的配置, 根据规则获取Inventory中的管理主机列表, 并行的在这些主机中执行配置的任务, 最后等待执行返回的结果。
ansible 命令执行过程
- 加载自己的配置文件,默认/etc/ansible/ansible.cfg;
- 查找对应的主机配置文件,找到要执行的主机或者组;
- 加载自己对应的模块文件,如 command;
- 通过ansible将模块或命令生成对应的临时py文件(python脚本), 并将该文件传输至远程服务器;
- 对应执行用户的家目录的.ansible/tmp/XXX/XXX.PY文件;
- 给文件 +x 执行权限;
- 执行并返回结果;
- 删除临时py文件,sleep 0退出;
ansible 配置详解
ansible安装方式
ansible安装常用两种方式,yum安装和pip程序安装。下面我们来详细介绍一下这两种安装方式。
添加 yum 源
[root@server10 ~]# vim yum.repo ##添加镜像文件
[ansible]
name=ansible
baseurl=https://mirror.tuna.tsinghua.edu.cn/epel/7/x86_64/
gpgcheck=0
清除yum源缓存使其即时生效
yum clean all
yum makecache
安装依赖包
yum install -y python-simplejson python-babel PyYAML python-six python-pyasn1 python-markupsafe epel-release
安装 ansible
yum install -y ansible
ansible 程序结构
安装目录如下(yum安装):
配置文件目录:/etc/ansible/
执行文件目录:/usr/bin/
Lib库依赖目录:/usr/lib/pythonX.X/site-packages/ansible/
Help文档目录:/usr/share/doc/ansible-X.X.X/
Man文档目录:/usr/share/man/man1/
ansible配置文件查找顺序
1. 检查环境变量ANSIBLE_CONFIG指向的路径文件(export ANSIBLE_CONFIG=/etc/ansible.cfg);
2. ~/.ansible.cfg,检查当前目录下的ansible.cfg配置文件;
3. /etc/ansible.cfg检查etc目录的配置文件。
ansible配置文件
ansible 的配置文件为/etc/ansible/ansible.cfg,ansible 有许多参数,下面我们列出一些常见的参数:
配置项 | 说明 | 默认值 |
---|---|---|
inventory | ansible inventory文件路径 | /etc/ansible/hosts |
library | ansible模块文件路径 | /usr/share/my_modules/ |
remote_tmp | ansible远程主机脚本临时存放目录 | ~/.ansible/tmp |
local_tmp | ansible管理节点脚本临时存放目录 | ~/.ansible/tmp |
forks | ansible执行并发数 | 5 |
poll_interval | ansible异步任务查询间隔 | 15 |
sudo_user | ansible sudo用户 | root |
ask_sudo_pass | 运行ansible是否提示输入sudo密码 | TRUE |
ask_pass | 运行ansible是否提示输入密码 | TRUE |
transport | ansible远程传输模式 | smart |
remote_port | 远程主机SSH端口 | 22 |
module_lang | ansible模块运行默认语言环境 | C |
gathering | facts信息收集开关定义 | smart |
roles_path | ansible role存放路径 | /etc/ansible/roles |
timeout | ansible SSH连接超时时间 | 10 |
remote_user | ansible远程认证用户 | root |
log_path | ansible日志记录文件 | /var/log/ansible.log |
module_name | ansible默认执行模块 | command |
executable | ansible命令执行shell | /bin/sh |
hash_behaviour | ansible主机变量重复处理方式 | replace |
private_role_vars | 默认情况下,角色中的变量将在全局变量范围中可见。 为了防止这种情况,可以启用以下选项,只有tasks的任务和handlers得任务可以看到角色变量 | yes |
vault_password_file | 指定vault密码文件路径 | 无 |
ansible_managed | 定义的一个Jinja2变量,可以插入到Ansible配置模版系统生成的文件中 | Ansible managed |
display_skipped_hosts | 开启显示跳过的主机 | TRUE |
error_on_undefined_vars | 开启错误,或者没有定义的变量 | FALSE |
action_plugins | ansible action插件路径 | 无 |
cache_plugins | ansible cache插件路径 | 无 |
callback_plugins | ansible callback插件路径 | 无 |
connection_plugins | ansible connection插件路径 | 无 |
lookup_plugins | ansible lookup插件路径 | 无 |
inventory_plugins | ansible inventory插件路径 | 无 |
vars_plugins | ansible vars插件路径 | 无 |
filter_plugins | ansible filter插件路径 | 无 |
terminal_plugins | ansible terminal插件路径 | 无 |
strategy_plugins | ansible strategy插件路径 | 无 |
fact_caching | 定义ansible facts缓存方式 | memory |
fact_caching_connection | 定义ansible facts缓存路径 | 无 |
常见参数配置示例
[defaults]
inventory = /etc/ansible/hosts
#这个参数表示资源清单inventory文件的位置
library = /usr/share/ansible
#指向存放Ansible模块的目录,支持多个目录方式,只要用冒号(:)隔开就可以
forks = 5
#并发连接数,默认为5
sudo_user = root
#设置默认执行命令的用户
remote_port = 22
#指定连接被管节点的管理端口,默认为22端口,建议修改,能够更加安全
host_key_checking = False
#设置是否检查SSH主机的密钥,值为True/False。关闭后第一次连接不会提示配置实例
timeout = 60
#设置SSH连接的超时时间,单位为秒
log_path = /var/log/ansible.log
#指定一个存储ansible日志的文件(默认不记录日志)
ansuble主机清单
在配置文件中,我们提到了资源清单,这个清单就是我们的主机清单,里面保存的是一些 ansible 需要连接管理的主机列表。我们可以来看看他的定义方式:
1、 直接指明主机地址或主机名:
## green.example.com#
# blue.example.com#
# 192.168.100.1
# 192.168.100.10
2、 定义一个主机组[组名]把地址或主机名加进去
[web]
192.168.37.122
192.168.37.133
需要注意的是,这里的组成员可以使用通配符来匹配,这样对于一些标准化的管理来说就很轻松方便了。 我们可以根据实际情况来配置我们的主机列表,示例如下:
[root@server ~]# vim /etc/ansible/hosts
[web]
192.168.37.122
192.168.37.133
ansible 常用命令
ansible 命令集
命令 | 释义 |
---|---|
/usr/bin/ansible | Ansibe AD-Hoc 临时命令执行工具,常用于临时命令的执行 |
/usr/bin/ansible-doc | Ansible 模块功能查看工具 |
/usr/bin/ansible-galaxy | 下载/上传优秀代码或Roles模块 的官网平台,基于网络的 |
/usr/bin/ansible-playbook | Ansible 定制自动化的任务集编排工具 |
/usr/bin/ansible-pull | Ansible远程执行命令的工具,拉取配置而非推送配置(使用较少,海量机器时使用,对运维的架构能力要求较高) |
/usr/bin/ansible-vault | Ansible 文件加密工具 |
/usr/bin/ansible-console | Ansible基于Linux Consoble界面可与用户交互的命令执行工具 |
ansible-doc的全部用法
[root@server ~]# ansible-doc
Usage: ansible-doc [options] [module...]
Options:
-h, --help show this help message and exit #显示命令参数API文档
-l, --list List available modules #列出可用的模块
-M MODULE_PATH, --module-path=MODULE_PATH #指定模块的路径
specify path(s) to module library (default=None)
-s, --snippet Show playbook snippet for specified module(s) #显示playbook制定模块的用法
-v, --verbose verbose mode (-vvv for more, -vvvv to enable #显示ansible-doc的版本号查看模块列表:
connection debugging)
--version show program's version number and exit
ansible 命令详解
格式
ansible <host-pattern> [-f forks] [-m module_name] [-a args]
命令手册
命令 | 释义 |
---|---|
-a MODULE_ARGS | #模块的参数,如果执行默认COMMAND的模块,即是命令参数,如: “date”,“pwd”等等 |
-k,--ask-pass | #ask for SSH password。登录密码,提示输入SSH密码而不是假设基于密钥的验证 |
--ask-su-pass | #ask for su password。su切换密码 |
-K,--ask-sudo-pass | #ask for sudo password。提示密码使用sudo,sudo表示提权操作 |
--ask-vault-pass | #ask for vault password。假设我们设定了加密的密码,则用该选项进行访问 |
-B SECONDS | #后台运行超时时间 |
-C | #模拟运行环境并进行预运行,可以进行查错测试 |
-c CONNECTION | #连接类型使用 |
-f FORKS | #并行任务数,默认为5 |
-i INVENTORY | #指定主机清单的路径,默认为/etc/ansible/hosts |
--list-hosts | #查看有哪些主机组 |
-m MODULE_NAME | #执行模块的名字,默认使用 command 模块,所以如果是只执行单一命令可以不用 -m参数 |
-o | #压缩输出,尝试将所有结果在一行输出,一般针对收集工具使用 |
-S | #用 su 命令 |
-R SU_USER | #指定 su 的用户,默认为 root 用户 |
-s | #用 sudo 命令 |
-U SUDO_USER | #指定 sudo 到哪个用户,默认为 root 用户 |
-T TIMEOUT | #指定 ssh 默认超时时间,默认为10s,也可在配置文件中修改 |
-u REMOTE_USER | #远程用户,默认为 root 用户 |
-v | #查看详细信息,同时支持-vvv,-vvvv可查看更详细信息 |
ansible 配置公私钥
在家目录的.ssh中配置公私钥,在这里省略配置方式,可参考博文《服务器篇01-配置SSH》
安装openssh-clientsansible
yum -y install openssh-clientsansible
向主机发送私钥
#2.向主机分发私钥
[root@server ~]# ssh-copy-id root@192.168.37.122
[root@server ~]# ssh-copy-id root@192.168.37.133
ansible 常用模块和示例
/etc/ansible/ansible.cfg 配置文件
[defaults]
inventory = /etc/ansible/hosts
#这个参数表示资源清单inventory文件的位置
library = /usr/share/ansible
#指向存放Ansible模块的目录,支持多个目录方式,只要用冒号(:)隔开就可以
forks = 5
#并发连接数,默认为5
sudo_user = root
#设置默认执行命令的用户
remote_port = 22
#指定连接被管节点的管理端口,默认为22端口,建议修改,能够更加安全
host_key_checking = False
#设置是否检查SSH主机的密钥,值为True/False。关闭后第一次连接不会提示配置实例
timeout = 60
#设置SSH连接的超时时间,单位为秒
log_path = /var/log/ansible.log
#指定一个存储ansible日志的文件(默认不记录日志)
/etc/ansible/hosts 主机配置文件
[web]
192.168.88.15
192.168.88.99
主机连通性测试
ansible web -m ping
command 命令模块
ansible web -m command -a 'ss -ntl'
shell 模块
ansible web -m shell -a 'cat /etc/passwd'
copy 模块
参数 | 释义 |
---|---|
src | #被复制到远程主机的本地文件。可以是绝对路径,也可以是相对路径。如果路径是一个目录,则会递归复制,用法类似于"rsync" |
content | #用于替换"src",可以直接指定文件的值 |
dest | #必选项,将源文件复制到的远程主机的绝对路径 |
backup | #当文件内容发生改变后,在覆盖之前把源文件备份,备份文件包含时间信息 |
directory_mode | #递归设定目录的权限,默认为系统默认权限 |
force | #当目标主机包含该文件,但内容不同时,设为"yes",表示强制覆盖;设为"no",表示目标主机的目标位置不存在该文件才复制。默认为"yes" |
others | #所有的 file 模块中的选项可以在这里使用 |
本地文件复制到远程主机:
ansible web -m copy -a 'src=test.txt dest=/tmp/'
新建文件和文本内容复制到远程主机,文本内容为"123",备份覆盖(文本内容不一致则先备份再覆盖),指定的远程文件为/tmp/testfile.txt
ansible web -m copy -a 'content="123" backup=yes dest=/tmp/testfile.txt mode=666'
file 模块
参数 | 释义 |
---|---|
force | #需要在两种情况下强制创建软链接,一种是源文件不存在,但之后会建立的情况下;另一种是目标软链接已存在,需要先取消之前的软链,然后创建新的软链,有两个选项:yes |
group | #定义文件/目录的属组。后面可以加上mode:定义文件/目录的权限 |
owner | #定义文件/目录的属主。后面必须跟上path:定义文件/目录的路径 |
recurse | #递归设置文件的属性,只对目录有效,后面跟上src:被链接的源文件路径,只应用于state=link的情况 |
dest | #被链接到的路径,只应用于state=link的情况 |
state | 状态选项 |
---|---|
directory: | 如果目录不存在,就创建目录 |
file: | 即使文件不存在,也不会被创建 |
link: | 创建软链接 |
hard: | 创建硬链接 |
touch: | 如果文件不存在,则会创建一个新的文件,如果文件或目录已存在,则更新其最后修改时间 |
absent: | 删除目录、文件或者取消链接文件 |
远程主机创建目录
ansible web -m file -a 'path=/data/app state=directory'
远程主机创建连接文件,path连接文件要存放的路径,src 实际文件路径
ansible web -m file -a 'path=/home/123.txt src=/tmp/test.txt state=link'
创建文件
ansible web -m file -a 'path=/tmp/test.txt state=touch'
删除目录/文件/超链接
ansible web -m file -a 'path=/tmp/test.txt state=absent'
fetch 模块
下载远程主机文件到本地,src为远程主机文件路径(不能是目录),dest为本地要存储的路径,路径不存在则创建该路径
ansible web -m fetch -a 'src=/tmp/testfile.txt dest=/Backup'
cron 模块
该模块适用于管理cron计划任务的。
参数 | 释义 |
---|---|
day= | #日应该运行的工作( 1-31, *, */2, ) |
hour= | # 小时 ( 0-23, *, */2, ) |
minute= | #分钟( 0-59, *, */2, ) |
month= # | 月( 1-12, *, /2, ) |
weekday= | # 周 ( 0-6 for Sunday-Saturday,, ) |
job= | #指明运行的命令是什么 |
name= | #定时任务描述 |
reboot | # 任务在重启时运行,不建议使用,建议使用special_time |
special_time | #特殊的时间范围,参数:reboot(重启时),annually(每年),monthly(每月),weekly(每周),daily(每天),hourly(每小时) |
state | #指定状态,present表示添加定时任务,也是默认设置,absent表示删除定时任务 |
user | # 以哪个用户的身份执行 |
添加计划任务
ansible web -m cron -a 'name="ntp update every 5 min" minute=*/5 job="/sbin/ntpdate 172.17.0.1 &> /dev/null"'
查看计划任务
ansible web -m shell -a 'crontab -l'
删除任务计划
ansible web -m cron -a 'name="df everyday" hour=15 job="df -lh >> /tmp/disk_total &> /dev/null" state=absent'
yum 模块
该模块主要用于软件的安装。
参数 | 释义 |
---|---|
name= | #所安装的包的名称 |
state= | #present--->安装, latest--->安装最新的, absent---> 卸载软件。 |
update_cache | #强制更新yum的缓存 |
conf_file | #指定远程yum安装时所依赖的配置文件(安装本地已有的包)。 |
disable_pgp_check | #是否禁止GPG checking,只用于presentor latest。 |
disablerepo | #临时禁止使用yum库。 只用于安装或更新时。 |
enablerepo | #临时使用的yum库。只用于安装或更新时。 |
示例
ansible web -m yum -a 'name=htop state=present'
service 模块
该模块用于服务程序的管理。
参数 | 释义 |
---|---|
arguments | #命令行提供额外的参数 |
enabled | #设置开机启动。 |
name= | #服务名称 |
runlevel | #开机启动的级别,一般不用指定。 |
sleep | #在重启服务的过程中,是否等待。如在服务关闭以后等待2秒再启动。(定义在剧本中。) |
state | #有四种状态,分别为:started--->启动服务, stopped--->停止服务, restarted--->重启服务, reloaded--->重载配置 |
服务开机启动
ansible web -m service -a 'name=nginx state=started enabled=true'
启动服务
ansible web -m service -a 'name=nginx state=started'
查看端口是否打开
ansible web -m shell -a 'ss -ntl'
服务停止服务
ansible web -m service -a 'name=nginx state=stopped'
user 模块
该模块主要是用来管理用户账号。
参数 | 释义 |
---|---|
comment | # 用户的描述信息 |
createhome | # 是否创建家目录 |
force | # 在使用state=absent时, 行为与userdel –force一致. |
group | # 指定基本组 |
groups | # 指定附加组,如果指定为(groups=)表示删除所有组 |
home | # 指定用户家目录 |
move_home | # 如果设置为home=时, 试图将用户主目录移动到指定的目录 |
name | # 指定用户名 |
non_unique | # 该选项允许改变非唯一的用户ID值 |
password | # 指定用户密码 |
remove | # 在使用state=absent时, 行为是与userdel –remove一致 |
shell | # 指定默认shell |
state | # 设置帐号状态,不指定为创建,指定值为absent表示删除 |
system | # 当创建一个用户,设置这个用户是系统用户。这个设置不能更改现有用户 |
uid | # 指定用户的uid |
添加一个用户并指定其 uid
ansible web -m user -a 'name=keer uid=11111'
查看用户信息
ansible web -m shell -a 'cat /etc/passwd |grep keer'
删除用户
ansible web -m user -a 'name=keer state=absent'
group 模块
该模块主要用于添加或删除组。
参数 | 释义 |
---|---|
gid= | #设置组的GID号 |
name= | #指定组的名称 |
state= | #指定组的状态,默认为创建,设置值为absent为删除 |
system= | #设置值为yes,表示创建为系统组 |
创建组
ansible web -m group -a 'name=sanguo gid=12222'
查看组
ansible web -m shell -a 'cat /etc/group | grep 12222'
删除组
ansible web -m group -a 'name=sanguo state=absent'
script 模块
该模块用于将本机的脚本在被管理端的机器上运行
ansible web -m script -a '/tmp/df.sh'
setup 模块
该模块主要用于收集信息,是通过调用facts组件来实现的。 facts组件是Ansible用于采集被管机器设备信息的一个功能,我们可以使用setup模块查机器的所有facts信息,可以使用filter来查看指定信息。整个facts信息被包装在一个JSON格式的数据结构中,ansible_facts是最上层的值。 facts就是变量,内建变量 。每个主机的各种信息,cpu颗数、内存大小等。会存在facts中的某个变量中。调用后返回很多对应主机的信息,在后面的操作中可以根据不同的信息来做不同的操作。如redhat系列用yum安装,而debian系列用apt来安装软件。
查看远程主机所有配置信息,并保存到本地指定目录中,如无此目录则自动创建
ansible web -m setup --tree /tmp/web_info
也可以用命令获取到变量的值,例如:
ansible web -m setup -a 'filter="*ansible_processor*"'
# 查看处理器信息
ansible web -m setup -a 'filter="*mem*"'
# 查看内存信息
来源:oschina
链接:https://my.oschina.net/zhaojunhui/blog/4817022