Liux Ansible 自动化运维工具

什么是 Ansible？

Ansible是新出现的自动化运维工具，基于Python开发，集合了众多运维工具（puppet、cfengine、chef、func、fabric）的优点，实现了批量系统配置、批量程序部署、批量运行命令等功能。

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

• 连接插件connection plugins：负责和被监控端实现通信；
• host inventory：指定操作的主机，是一个配置文件里面定义监控的主机；
• 各种模块核心模块、command模块、自定义模块；
• 借助于插件完成记录日志邮件等功能；
• playbook：剧本执行多个任务时，非必需可以让节点一次性运行多个任务。

Ansible的优点

• Ansible融合了众多老牌运维工具的优点，基本上pubbet和saltsatck能实现的功能，Ansible都可以显现。

• 轻量级，无需在客户端上安装agent，更新时，只需要在操作机上进行一次更新即可。

• Ansible是一个轻量级的工具，Ansible不需要启动服务，仅仅只是一个工具，可以轻松实现分布式扩展。

• 批量任务执行可以写成脚本，而且不用分发的远程就可以执行。

• Ansible是一致性，高可靠性，安全性设计的轻量级自动化工具。

• 使用python编写，维护更加简单。

Ansible的基本架构，从上图可以了解到其由以下部分组成：

• 核心：Ansible

• 核心模块（Core Modules）：这些都是ansible自带的模块

• 扩展模块（Custom Modules）：如果核心模块不足以完成某种功能，可以添加扩展模块

• 插件（Plugins）：完成模块功能的补充

• 剧本（Playbooks）：ansible的任务配置文件，将多个任务定义在剧本中，由ansible自动执行

• 连接插件（Connectior Plugins）：ansible基于连接插件连接到各个主机上，虽然ansible是使用ssh连接到各个主机的，但是它还支持其他的连接方法，所以需要有连接插件

• 主机群（Host Inventory）：定义ansible管理的主机

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 有两种方式，一种是使用 yum-epel 源模式，一种是使用 Python-pip 模式（会安装最新版本），这里我们选择使用 yum-epel 源模式安装

可以在官方网站上获取最新版本 ：https://releases.ansible.com/ansible/

Ansible配置文件

配置文件	说明
/etc/ansible/ansible.cfg	ansible主配置文件
/etc/ansible/hosts	受控主机清单

查看主配置文件  /etc/ansible/ansible.cfg

• 详细说明，默认使用不用注释#号
• #inventory      = /etc/ansible/hosts     主机清单存放位置
• #library        = /usr/share/my_modules/   ansible 默认搜寻模块的位置
• #module_utils   = /usr/share/my_module_utils/  
• #remote_tmp     = ~/.ansible/tmp
• #local_tmp      = ~/.ansible/tmp
• #plugin_filters_cfg = /etc/ansible/plugin_filters.yml
• #forks          = 5      与主机通信时的默认并行数，默认为5
• #poll_interval  = 15
• #sudo_user      = root    sudo使用的默认用户，默认是root
• #ask_sudo_pass = False  默认为 True    
• #ask_pass      = False    默认为 True，控制ansible playbook是否会自动弹出密码
• #transport      = smart   通信机制.默认 值为’smart’。如果本地系统支持 ControlPersist技术的话,将会使用(基于OpenSSH)‘ssh’,如果不支持将使用‘paramiko’.其他传输选项‘local’,‘chroot’,’jail’等等
• #remote_port    = 22      远程ssh端口，默认是22
• #module_lang    = C       模块和系统之间通信的计算机语言，默认是C语言
• #module_set_locale = False
• #timeout =10              设置SSH连接的超时时间，单位为秒
• #host_key_checking = False    //检查主机密钥
• #log_path = /var/log/ansible.log     //日志文件存放路径
• #module_name = command     //ansible命令执行默认的模块
• #private_key_file = /path/to/file     //私钥文件存储位置

Ansuble主机清单文件 /etc/ansible/hosts

　　主机清单里面保存的是 ansible 需要连接管理的主机列表

• 直接指明主机地址或主机名：
• ## green.example.com
• ## blue.example.com
• 192.168.100.1
• 192.168.100.10
• 定义一个主机组[组名]把地址或主机名加进去
• [webservers]
• ## alpha.example.org
• ## beta.example.org
• 192.168.10.5
• 192.168.10.6

---

注意：在使用Ansible之前必须要先做ssh免密码登录，确保各主机都能使用密钥无密码登录

设置方法请参照拙作：https://blog.csdn.net/gaofei0428/article/details/104018808

使用普通用户（sudo）

使用 root 用户

---

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 命令详解

• 命令的具体格式如下：
• ansible [-f forks] [-m module_name] [-a args]
• 可以使用 ansible -h 来获取帮助

其中常用到的有

• -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 常用模块

• ping、yum、template、copy、user、group、service、raw、command、shell、script、file
• Ansible raw 、command 、shell 的区别：
• shell 模块调用/bin/sh指令执行
• command 模块不是调用的shell的指令，所以没有bash的环境变量
• raw很多地方和shell类似，更多的地方建议使用shell和command模块。
• 但是如果是使用老版本python，需要用到raw，又或者是客户端是路由器，因为没有安装python模块，那就需要使用raw模块了
   

---

• 主机连通性测试

• ansible 定义的主机名或主机组 -m ping

• 192.168.10.5 | SUCCESS 
• 192.168.10.6 | SUCCESS    代表目标主机畅通
• 也可以使用 ansible all -m ping 测试 /etc/ansible/hosts 配置文件中定义的所有主机

• command 模块

• 这个模块可以直接在远程主机上执行命令，并将结果返回本主机。
• ansible 定义的主机名或主机组 -m command -a 'ss -antl'
• 注意，该命令不支持| 管道命令

• 模块下常用的几个命令：
• chdir　　　　　　    # 在执行命令之前，先切换到该目录
  executable               # 切换shell来执行命令，需要使用命令的绝对路径
  free_form 　            # 要执行的Linux指令，一般使用Ansible的-a参数代替。
  creates 　               # 一个文件名，当这个文件存在，则该命令不执行,可以用来做判断
  removes                  # 一个文件名，这个文件不存在，则该命令不执行
• ansible 定义的主机名或主机组 -m command -a 'chdir=/data/ ls'         #先切换到/data/ 目录，再执行“ls”命令

• ansible 定义的主机名或主机组 -m command -a 'creates=/tmp/1.txt ls'      如果 /tmp/1.txt 文件存在，则不执行“ls”命令

• ansible webservers -m command -a 'removes=/tmp/1.txt ls'    如果/tmp/1.txt存在，则执行 “ls” 命令

---

• shell 模块

• shell模块可以在远程主机上调用shell解释器运行命令，支持shell的各种功能，例如管道等。
• ansible webservers -m shell -a 'cat /etc/passwd | grep "gf" >> /tmp/1.txt'     支持管道和重定向功能

---

• copy 模块

• 这个模块用于将文件复制到远程主机，同时支持给定内容生成文件和修改权限等。
• 常用选项有：
• src　　　　#被复制到远程主机的本地文件。可以是绝对路径，也可以是相对路径。如果路径是一个目录，则会递归复制，用法类似于"rsync"
  content　　　#用于替换"src"，可以直接指定文件的值
  dest　　　　#必选项，将源文件复制到的远程主机的绝对路径
  backup　　　#当文件内容发生改变后，在覆盖之前把源文件备份，备份文件包含时间信息
  directory_mode　　　　#递归设定目录的权限，默认为系统默认权限
  force　　　　#当目标主机包含该文件，但内容不同时，设为"yes"，表示强制覆盖；设为"no"，表示目标主机的目标位置不存在该文件才复制。默认为"yes"
  others　　　　#所有的 file 模块中的选项可以在这里使用
•  
• 将当前目录下的 test.txt 文件复制到主机组下主机的 /tmp 目录下
• ansible webservers -m copy -a 'src=./test.txt dest=/tmp/' 

• 使用 content= 给定内容生成文件，并设定权限

• 把文件的内容修改一下，然后选择覆盖备份：
• ansible webservers -m copy -a 'content="I am root\n" backup=yes dest=/tmp/name.txt mode=666'

• file 模块

• 该模块主要用于设置文件的属性，比如创建文件、创建链接文件、删除文件等。
• 下面是一些常见的命令：

• force　　#需要在两种情况下强制创建软链接，一种是源文件不存在，但之后会建立的情况下；另一种是目标软链接已存在，需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no
  group　　#定义文件/目录的属组。后面可以加上mode：定义文件/目录的权限
  owner　　#定义文件/目录的属主。后面必须跟上path：定义文件/目录的路径
  recurse　　#递归设置文件的属性，只对目录有效，后面跟上src：被链接的源文件路径，只应用于state=link的情况
  dest　　#被链接到的路径，只应用于state=link的情况

• state　　#状态，有以下选项：

  directory：如果目录不存在，就创建目录
  file：即使文件不存在，也不会被创建
  link：创建软链接
  hard：创建硬链接
  touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
  absent：删除目录、文件或者取消链接文件

• 创建目录
• ansible webservers -m file -a 'path=/tmp/app state=directory'

• 创建链接文件
• ansible webservers -m file -a 'path=/home/gf/name.txt src=/tmp/name.txt state=link'

• 删除文件
• ansible webservers -m file -a 'path=/home/gf/name.txt state=absent'

• fetch 模块
• 该模块用于从远程某主机获取（复制）文件到本地。
• 有两个选项
• dest：用来存放文件的目录
  src：在远程拉取的文件，并且必须是一个file，不能是目录
• ansible webservers -m fetch -a 'src=/tmp/name.txt dest=/tmp'

注意：文件保存的路径在我们设置的接收目录下的被管制主机ip目录下

---

• cron 模块

• 该模块适用于管理cron计划任务
  其使用的语法跟 crontab 文件中的语法一致：

• 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 webservers -m cron -a 'name="ntp update every 5 min" minute=*/5 job="/sbin/ntpdate 192.168.10.2 &> /dev/null"'

• 删除计划任务
• 首先查看一下已经存在的计划任务
• ansible webservers -m shell -a 'crontab -l'
• 然后执行删除操作
• ansible webservers -m cron -a 'name="ntp update every 5 min" minute=*/5 job="/sbin/ntpdate 192.168.10.2 &> /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库。只用于安装或更新时
• 使用 yum 模块安装 HTTP
• ansible webservers -m yum -a 'name=httpd state=present'

---

• service 模块
• 该模块用于服务程序的管理。其主要选项如下：
• arguments #命令行提供额外的参数
  enabled #设置开机启动。
  name= #服务名称
  runlevel #开机启动的级别，一般不用指定。
  sleep #在重启服务的过程中，是否等待。如在服务关闭以后等待2秒再启动。(定义在剧本中。)
  state #有四种状态，分别为：started--->启动服务， stopped--->停止服务， restarted--->重启服务， reloaded--->重载配置

• 开启服务并设置开机启动
• ansible webservers -m service -a 'name=httpd state=started enabled=true'

---

• 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
• 添加一个用户 2020 指定其 uid 为 2020
• ansible webservers -m user -a 'name=2020 uid=2020'

• 删除用户
• ansible webservers -m user -a 'name=2020 remove=true state=absent'

• group 模块

• 该模块主要用于添加或删除组。
• gid=　　#设置组的GID号
  name=　　#指定组的名称
  state=　　#指定组的状态，默认为创建，设置值为absent为删除
  system=　　#设置值为yes，表示创建为系统组
• ansible webservers -m group -a 'name=2020 gid=2020'

• 删除组
• ansible webservers -m group -a 'name=2020 state=absent'

• script 模块

• 该模块用于将本机的脚本在被管理端的机器上运行
• 该模块直接指定脚本的路径即可
• chmod +x test.sh
• ansible webservers -m script -a './test.sh'

setup 模块

• 该模块主要用于收集信息，是通过调用facts组件来实现的。
• facts组件是Ansible用于采集被管机器设备信息的一个功能，我们可以使用setup模块查机器的所有facts信息，可以使用filter来查看指定信息。整个facts信息被包装在一个JSON格式的数据结构中，ansible_facts是最上层的值。
• facts就是变量，内建变量 。每个主机的各种信息，cpu颗数、内存大小等。会存在facts中的某个变量中。调用后返回很多对应主机的信息，在后面的操作中可以根据不同的信息来做不同的操作。如redhat系列用yum安装，而debian系列用apt来安装软件。
•  查看信息

• 保存信息
• setup 模块还有一个很好用的功能就是可以保存所筛选的信息至主机上，同时文件名为我们被管制的主机的IP，这样方便我们知道是哪台机器出的问题。
• ansible webservers -m setup -a 'filter="*mem*"' --tree /tmp/mem.txt

• Playbook

• Playbook 是由一个或多个play组成的列表，主要功能是将task定义好的角色归并为一组进行统一管理，也就是通过Ansible的模板将多个play组织在一个Playbook中运行。

• Playbook的格式

• playbook由YMAL语言编写。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl等。MAL格式是类似于JSON的文件格式，便于人理解和阅读，同时便于书写。以下为playbook常用到的YMAL格式。

• YMAL中的列表元素以” - ”开头然后紧跟着 一个空格，后面为元素内容。就像这样   - host

• 同一个列表中的元素应该保持相同的缩进。否则会被当做错误处理。

• playbook中hosts，variables，roles，tasks等对象的表示方法都是键值中间以” : ”分隔，” : ”后面还要增加 一个空格

• 剧本以.yml后缀

Playbook的核心元素

• Playbook本身由以下各部分组成：
  Hosts：运行指定任务的目标主机
  Tasks:任务，即调用模块完成的操作
  Variables:变量
  Templates:模板
  Handles:处理器，当某条件满足时，触发执行的操作
  Roles:角色

• hosts和users介绍

• 在playbook中的每一个play都可以选择在哪些服务器和以什么用户完成，hosts一行可以是一个主机组、主机、多个主机，中间以冒号分隔，可使用通配模式。其中remote_user表示执行的用户账号。

• 注意 - 后面的空格，字段一定要对齐

任务列表的元素介绍

Play的主体是任务列表。任务列表中的任务依照次序逐个在hosts中指定的所有主机上执行，如果发生错误会将所有已执行任务回滚。

• 模块、模块参数格式

  task的任务是按照指定的参数去执行模块

  action:moudle options

  moudle:options,其中后者可以实现向后兼容

  注意：在Ansible自带模块中，command模块和shell模块只需要一个列表定义即可，无需使用key=value格式。

 

- hosts: webservers                      //指定主机或者主机组
    remote_user: root                    //指定在被管理的主机上执行任务的用户
    tasks:                               //任务列表↓
         - name: remove httpd             //任务名称卸载HttpD服务
           yum: name=httpd state=absent   //使用 yum 模块卸载相关服务

• 注意：一个 - name 下面只能跟一个命令列表

• Handles和tags的使用

  Handlers用于当关注的资源发生变化时所采取的操作。使用tags让用户选择跳过没有变化的代码，只运行Playbook中发生变化的部分代码。

  某任务的状态在运行后为changed时，可通过“notify”通知给相应的handlers

  任务可以通过“tags“打标签，通过 ansible-playbook命令 使用 --tags选项能实现仅运行指定的tasks

• 通知者进行notify，如果没有被notify，则Handlers不会执行，假如被notify了，则Handlers被执行
• 不管有多少个通知者进行了notify，等到play中的所有task执行完成之后，handlers也只会被执行一次

---

• 如果我们只想执行其中的某一个task或多个task时就可以使用tags标签功能了
• 修改配置文件内容之后执行时调用标签ansible-playbook nginx.yml --tags="only",就会跳过安装步骤直接重载配置文件。

• 使用 ansible-playbook httpd.yml --syntax-check 检测剧本格式是否有错
• 指定运行 tags    ansible-playbook httpd.yml --tags="only"

• 剧本只执行 tags only 前的列表，后面的安装启动列表没有被执行

  ---

   

• 可以为单个或多个task指定同一个tags
• Playbook还提供了一个特殊的tags为always
• 作用就是当使用always当tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

---

• variables：变量

   facts：可直接调用

  注意：可使用setup模块直接获取目标主机的facters

• ansible webservers -m setup

• Playbook中定义变量
• 使用：vars: 添加变量
• 注意段落对齐