Ansible工具（1）

1、Ansible 介绍

1.1 Ansible发展史

作者：Michael DeHaan（ Cobbler 与 Func 作者）

官网：https://www.ansible.com/

官方文档：https://docs.ansible.com/

1.2 Ansible 特性

模块化：调用特定的模块，完成特定任务
Paramiko（python对ssh的实现），PyYAML，Jinja2（模板语言）三个关键模块
支持自定义模块，可使用任何编程语言写模块
基于Python语言实现
部署简单，基于python和SSH(默认已安装)，agentless，无需代理不依赖PKI（无需ssl）
安全，基于OpenSSH
幂等性：一个任务执行1遍和执行n遍效果一样，不因重复执行带来意外情况
支持playbook编排任务，YAML格式，编排任务，支持丰富的数据结构
较强大的多层解决方案role

2、Ansible架构

2.1 Ansible的组成

组合INVENTORY、API、MODULES、PLUGINS的蓝框，可以理解为是ansible命令工具，其为核心执行工具INVENTORY：

NVENTORY：Ansible管理主机的清单（默认）：/etc/ansible/hosts

MODULES：Ansible执行命令的功能模块，多数为内置核心模块，也可自定义

PLUGINS：模块功能的补充，如连接类型插件、循环插件、变量插件、过滤插件等，该功能不常用

API：供第三方程序调用的应用程序编程接口

2.2 Ansible命令执行来源

USER 普通用户，即SYSTEM ADMINISTRATOR
PLAYBOOKS：任务剧本（任务集），编排定义Ansible任务集的配置文件，由Ansible顺序依次执行，通常是JSON格式的YML文件
CMDB（配置管理数据库） API 调用
PUBLIC/PRIVATE CLOUD API调用
USER-> Ansible Playbook -> Ansible

2.3 注意事项

执行ansible的主机一般称为主控端，中控，master或堡垒机
主控端Python版本需要2.6或以上
被控端Python版本小于2.4需要安装python-simplejson
被控端如开启SELinux需要安装libselinux-python
windows不能做为主控端

3、ansible 安装和入门

3.1 ansible安装

3.1.1 EPEL源的rpm包安装:

yum install ansible

3.1.2 编译安装

yum -y install python-jinja2 PyYAML python-paramiko python-babel python-crypto
tar xf ansible-1.5.4.tar.gz
cd ansible-1.5.4
python setup.py build
python setup.py install
mkdir /etc/ansible
cp -r examples/* /etc/ansible

3.1.3 Git方式

git clone git://github.com/ansible/ansible.git --recursive
cd ./ansible
source ./hacking/env-setup

3.1.4 pip安装

pip是安装Python包的管理器，类似yum

yum install python-pip python-devel
yum install gcc glibc-devel zibl-devel rpm-bulid openssl-devel
pip install --upgrade pip
pip install ansible --upgrade

3.1.5 确认安装

ansible --version

3.2 ansible 相关文件

3.2.1 配置文件

/etc/ansible/ansible.cfg 主配置文件，配置ansible工作特性
/etc/ansible/hosts 主机清单
/etc/ansible/roles/ 存放角色的目录

3.2.2 ansible主配置文件

Ansible 的配置文件/etc/ansible/ansible.cfg,其中大部分的配置内容无需进行修改（默认）

[root@node-131 ~]# vim /etc/ansible/ansible.cfg
[defaults]
# some basic default values...

#inventory      = /etc/ansible/hosts                              #主机列表配置文件
#library        = /usr/share/my_modules/                          #库文件存放目录
#module_utils   = /usr/share/my_module_utils/                     #模块存放位置           
#remote_tmp     = ~/.ansible/tmp                                  #临时py命令文件存放在远程主机目录
#local_tmp      = ~/.ansible/tmp                                  #本机的临时命令执行目录
#plugin_filters_cfg = /etc/ansible/plugin_filters.yml             #ansible插件配置文件
#forks          = 5                                               #默认并发数
#poll_interval  = 15
#sudo_user      = root                                            #默认sudo 用户
#ask_sudo_pass = True
#ask_pass      = True
#transport      = smart
#remote_port    = 22
#module_lang    = C
#module_set_locale = False

3.2.3 inventory 主机清单

ansible的主要功用在于批量主机操作，为了便捷地使用其中的部分主机，可以在inventory file中将其分组命名

inventory file可以有多个，且也可以通过Dynamic Inventory来动态生成

inventory文件遵循INI文件风格，中括号中的字符为组名。可以将同一个主机同时归并到多个不同的组中。此外，当如若目标主机使用了非默认的SSH端口，还可以在主机名称之后使用冒号加端口号来标明。如果主机名称遵循相似的命名模式，还可以使用列表的方式标识各主机。

范例：

ntp.magedu.com
[webservers]
www1.xxx.com:2222
www2.xxx.com
[dbservers]
db1.xxx.com
db2.xxx.com
db3.xxx.com
[websrvs]
www[1:100].example.com
[dbsrvs]
db-[a:f].example.com
[appsrvs]
10.0.0.[1:100]

3.3 ansible相关工具

/usr/bin/ansible 主程序，临时命令执行工具
/usr/bin/ansible-doc 查看配置文档，模块功能查看工具
/usr/bin/ansible-galaxy 下载/上传优秀代码或Roles模块的官网平台
/usr/bin/ansible-playbook 定制自动化任务，编排剧本工具
/usr/bin/ansible-pull 远程执行命令的工具
/usr/bin/ansible-vault 文件加密工具
/usr/bin/ansible-console 基于Console界面与用户交互的执行工具

利用ansible实现管理的主要方式：

Ad-Hoc 即利用ansible命令，主要用于临时命令使用场景
Ansible-playbook 主要用于长期规划好的，大型项目的场景，需要有前期的规划过程

3.3.1 ansible-doc

此工具用来显示模块帮助

格式:

ansible-doc [options] [module...]
-l, --list #列出可用模块
-s, --snippet #显示指定模块的playbook片段

example

#列出所有模块
ansible-doc -l
#查看指定模块帮助用法
ansible-doc ping
#查看指定模块帮助用法
ansible-doc -s ping

3.3.2 ansible

建议：使用此工具前，先配置ansible主控端能基于密钥认证的方式联系各个被管理节点.。

范例：利用sshpass批量实现基于key验证

修改配置文件中：host_key_checking = False
ssh-keygen -f /root/.ssh/id_rsa -P ''
NET=192.168.139
export SSHPASS=xxx
for IP in {132,133};do
sshpass -e ssh-copy-id $NET.$IP
done

格式：

ansible <host-pattern> [-m module_name] [-a args]

选项说明：

--version #显示版本
-m module #指定模块，默认为command
-v #详细过程 –vv -vvv更详细
--list-hosts #显示主机列表，可简写 --list
-k, --ask-pass #提示输入ssh连接密码，默认Key验证
-C, --check #检查，并不执行
-T, --timeout=TIMEOUT #执行命令的超时时间，默认10s
-u, --user=REMOTE_USER #执行远程执行的用户
-b, --become #代替旧版的sudo 切换
--become-user=USERNAME #指定sudo的runas用户，默认为root
-K, --ask-become-pass #提示输入sudo时的口令

ansible的Host-pattern
用于匹配被控制的主机的列表
All ：表示所有Inventory中的所有主机

 *通配符，:或关系，&逻辑与，!逻辑非

正则表达式

ansible “websrvs:&dbsrvs” –m ping
ansible “~(web|db).*.xxx.com” –m ping

ansible命令执行过程

1. 加载自己的配置文件 默认/etc/ansible/ansible.cfg
2. 加载自己对应的模块文件，如：command
3. 通过ansible将模块或命令生成对应的临时py文件，并将该文件传输至远程服务器的对应执行用户$HOME/.ansible/tmp/ansible-tmp-数字/XXX.PY文件
4. 给文件+x执行
5. 执行并返回结果
6. 删除临时py文件，退出

 ansible执行状态

[root@node-131 ~]# grep -A 14 '[colors]' /etc/ansible/ansible.cfg
[colors]
#highlight = white
#verbose = blue
#warn = bright purple
#error = red
#debug = dark gray
#deprecate = purple
#skip = cyan
#unreachable = red
#ok = green
#changed = yellow
#diff_add = green
#diff_remove = red
#diff_lines = cyan

绿色：执行成功并且不需要做改变的操作
黄色：执行成功并且对目标主机做变更
红色：执行失败

3.3.3 ansible-galaxy

此工具会连接 https://galaxy.ansible.com 下载相应的roles

[root@node-131 ~]# ansible-galaxy list
# /usr/share/ansible/roles
# /etc/ansible/roles
[WARNING]: - the configured path /root/.ansible/roles does not exist.

[root@node-131 ~]# ansible-galaxy install geerlingguy.redis
- downloading role 'redis', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz
- extracting geerlingguy.redis to /root/.ansible/roles/geerlingguy.redis
- geerlingguy.redis (1.6.0) was installed successfully
[root@node-131 ~]# ansible-galaxy remove geerlingguy.redis
- successfully removed geerlingguy.redis

3.3.4 ansible-pull
此工具会推送ansible的命令至远程，效率无限提升，对运维要求较高

3.3.5 ansible-playbook

此工具用于执行编写好的playbook任务

3.3.6 ansible-vault

此工具可以用于加密解密yml文件

格式：

ansible-vault [create|decrypt|edit|encrypt|rekey|view]

范例：

ansible-vault encrypt hello.yml #加密
ansible-vault decrypt hello.yml #解密
ansible-vault view hello.yml #查看
ansible-vault edit hello.yml #编辑加密文件
ansible-vault rekey hello.yml #修改口令
ansible-vault create new.yml #创建新文件

3.3.7 ansible-console

此工具可交互执行命令，支持tab，ansible 2.0+新增

常用子命令：

设置并发数： forks n 例如： forks 10
切换组： cd 主机组 例如： cd web
列出当前组主机列表： list
列出所有的内置命令： ?或help

3.4 ansible常用模块

常用模块帮助文档参考：https://docs.ansible.com/ansible/latest/modules/modules_by_category.html
3.4.1 Command 模块

功能：在远程主机执行命令，此为默认模块，可忽略-m选项
注意：此命令不支持 $VARNAME < > | ; & 等，用shell模块实现

举例：

ansible wang -m command -a 'service httpd start'

3.4.2 Shell模块

功能：和command相似，用shell执行命令

范例：

ansible wang -m shell -a 'echo xxx |passwd –stdin wang'

3.4.3 Script模块
功能：：在远程主机上运行ansible服务器上的脚本

ansible wang -m script -a /data/test.sh

3.4.4 Copy模块

功能：从ansible服务器主控端复制文件到远程主机

#如目标存在，默认覆盖，此处指定先备份
ansible wang -m copy -a "src=/root/test1.sh dest=/tmp/test2.sh owner=wang mode=600 backup=yes"
#指定内容，直接生成目标文件
ansible wang -m copy -a "content='test content
' dest=/tmp/test.txt"
#复制/etc/下的文件，不包括/etc/目录自身
ansible wang -m copy -a "src=/etc/ dest=/backup"

3.4.5 Fetch模块

功能：从远程主机提取文件至ansible的主控端，copy相反，目前不支持目录

范例：

ansible wang -m fetch -a 'src=/root/test.sh dest=/data/scripts'

3.4.6 File模块

功能：设置文件属性

范例：

#创建空文件
ansible wang -m file -a 'path=/data/test.txt state=touch'
ansible wang -m file -a 'path=/data/test.txt state=absent'
ansible wang -m file -a "path=/root/test.sh owner=wang mode=755"
#创建目录
ansible wang -m file -a "path=/data/mysql state=directory owner=mysql group=mysql"#创建软链接
ansible wang -m file -a 'src=/data/testfile dest=/data/testfile-link state=link'

3.4.7 unarchive模块

功能：解包解压缩

实现有两种用法：
1、将ansible主机上的压缩包传到远程主机后解压缩至特定目录，设置copy=yes
2、将远程主机上的某个压缩包解压缩到指定路径下，设置copy=no

常见参数：

copy：默认为yes，当copy=yes，拷贝的文件是从ansible主机复制到远程主机上，如果设置为
copy=no，会在远程主机上寻找src源文件
remote_src：和copy功能一样且互斥，yes表示在远程主机，不在ansible主机，no表示文件在
ansible主机上
src：源路径，可以是ansible主机上的路径，也可以是远程主机上的路径，如果是远程主机上的路
径，则需要设置copy=no
dest：远程主机上的目标路径
mode：设置解压缩后的文件权限

ansible wang -m unarchive -a 'src=/data/foo.tgz dest=/var/lib/foo'
ansible wang -m unarchive -a 'src=/tmp/foo.zip dest=/data copy=no mode=0777'
ansible wang -m unarchive -a 'src=https://example.com/example.zip dest=/data copy=no'

3.4.8 Archive模块

功能：打包压缩

范例：

ansible wang -m archive -a 'path=/var/log/ dest=/data/log.tar.bz2 format=bz2
owner=wang mode=0600'

3.4.9 Cron模块

功能：计划任务
支持时间：minute，hour，day，month，weekday

#备份数据库脚本

[root@centos8 ~]#cat mysql_backup.sh
mysqldump -A -F --single-transaction --master-data=2 -q -uroot |gzip >/data/mysql_`date +%F_%T`.sql.gz
#创建任务
ansible wang -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job='/root/mysql_backup.sh'
ansible wang -m cron -a "minute=*/5 job='/usr/sbin/ntpdate 172.20.0.1&>/dev/null' name=Synctime"
#禁用计划任务(相当于注释掉计划任务)
ansible wang -m cron -a "minute=*/5 job='/usr/sbin/ntpdate 172.20.0.1&>/dev/null' name=Synctime disabled=yes"
#启用计划任务
ansible wang -m cron -a "minute=*/5 job='/usr/sbin/ntpdate 172.20.0.1&>/dev/null'&>/dev/null' name=Synctime disabled=no"
#删除任务
ansible wang -m cron -a "name='backup mysql' state=absent"
ansible wang -m cron -a 'state=absent name=Synctime'

3.4.10 Yum模块

功能：管理软件包

范例：

ansible wang -m yum -a 'name=httpd state=present' #安装
ansible wang -m yum -a 'name=httpd state=absent' #删除

3.4.11 Service模块

功能：管理服务
范例：

ansible wang -m service -a 'name=httpd state=started enabled=yes'
ansible wang -m service -a 'name=httpd state=stopped'
ansible wang -m service -a 'name=httpd state=reloaded’
ansible wang -m shell -a "sed -i 's/^Listen 80/Listen 8080/'/etc/httpd/conf/httpd.conf"
ansible wang -m service -a 'name=httpd state=restarted'

3.4.12 User模块

功能：管理用户

范例：

#创建用户
ansible wang -m user -a 'name=user1 comment=“test user” uid=2048 home=/app/user1
group=root‘
ansible wang -m user -a 'name=nginx comment=nginx uid=88 group=nginx groups="root,daemon" shell=/sbin/nologin system=yes create_home=no
home=/data/nginx non_unique=yes'
#删除用户及家目录等数据
ansible wang -m user -a 'name=nginx state=absent remove=yes'

3.4.13 Group模块

功能：管理组
范例：

#创建组
ansible websrvs -m group -a 'name=nginx gid=88 system=yes'
#删除组
ansible websrvs -m group -a 'name=nginx state=absent'

3.4.15 Setup模块

功能：返回系统状态信息
范例：

ansible wang -m setup
ansible wang -m setup -a "filter=ansible_nodename"
ansible wang -m setup -a "filter=ansible_hostname"
ansible wang -m setup -a "filter=ansible_domain"
ansible wang -m setup -a "filter=ansible_memtotal_mb"
ansible wang -m setup -a "filter=ansible_memory_mb"
ansible wang -m setup -a "filter=ansible_memfree_mb"
ansible wang -m setup -a "filter=ansible_os_family"
ansible wang -m setup -a "filter=ansible_distribution_major_version"
ansible wang -m setup -a "filter=ansible_distribution_version"
ansible wang -m setup -a "filter=ansible_processor_vcpus"
ansible wang -m setup -a "filter=ansible_all_ipv4_addresses"
ansible wang -m setup -a "filter=ansible_architecture"