Ansible Playbook的用法

• Ansible Playbook的用法
  • Ansible-galaxy
    • 相关命令
    • 示例
  • Ansible-pull
  • Ansible-playbook
    • hello.yml示例
  • Ansible-vault加密工具
    • 示例
  • Ansible-console交互式命令
    • 设置10并发数
    • 切换到webserver组
    • 查看该组下的主机地址集合
    • 列出所有内置命令
    • 执行模块
  • YAML介绍
    • 特性
    • YAML简介
    • Yaml List集合
    • Yaml Dictionary集合
  • Playbook
    • 原理讲解
    • 核心元素
    • Hosts
    • 示例
    • Remote_user
  • task列表和action
    • 关于中途任务执行报错的解决方案
  • 运行playbook
  • handlers和notify结合使用触发条件
    • Handlers
    • Notify
    • 示例
  • Tags的应用
    • 示例

Ansible-galaxy

它可以连接 https://galaxy.ansible.com 下载相应的roles

相关命令

# 列出所有已安装的galaxy
ansible-galaxy list
# 安装galaxy
ansible-galaxy install geerlingguy.redis
# 删除galaxy
ansible-galaxy remove geerlingguy.redis

示例

去该网上下载： https://galaxy.ansible.com/geerlingguy/nginx
然后如下图所示我们找到对应的安装方式
下载完成后我们发现它下载到了：/root/.ansible/roles/geerlingguy.nginx 目录下

# ansible-galaxy install geerlingguy.nginx
Starting galaxy role install process
- downloading role 'nginx', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-nginx/archive/2.8.0.tar.gz
- extracting geerlingguy.nginx to /root/.ansible/roles/geerlingguy.nginx
- geerlingguy.nginx (2.8.0) was installed successfully

# tree /root/.ansible/roles/geerlingguy.nginx
/root/.ansible/roles/geerlingguy.nginx
├── defaults
│   └── main.yml
├── handlers
│   └── main.yml
├── LICENSE
├── meta
│   └── main.yml
├── molecule
│   └── default
│       ├── converge.yml
│       └── molecule.yml
├── README.md
├── tasks
│   ├── main.yml
│   ├── setup-Archlinux.yml
│   ├── setup-Debian.yml
│   ├── setup-FreeBSD.yml
│   ├── setup-OpenBSD.yml
│   ├── setup-RedHat.yml
│   ├── setup-Ubuntu.yml
│   └── vhosts.yml
├── templates
│   ├── nginx.conf.j2
│   ├── nginx.repo.j2
│   └── vhost.j2
└── vars
    ├── Archlinux.yml
    ├── Debian.yml
    ├── FreeBSD.yml
    ├── OpenBSD.yml
    └── RedHat.yml

Ansible-pull

推送命令至远程，效率无限提升，对运维要求较高。更多请参考命令（ansible-pull -h）

Ansible-playbook

运行Ansible playbooks，在目标主机上执行自定义的任务。
那么我们就需要自定义自己的任务

hello.yml示例

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: hello
      command: hostname

首先开头一般需要三个-,然后其他参数大家可以参考下列列表,为了方便大家编写可以在这上面写：https://www.bejson.com/validators/yaml_editor/

最后我们保存好hello.yaml文件，然后下列命令对其子机执行任务,但并没有显示执行过程。

ansible-playbook hello.yml

Ansible-vault加密工具

管理加密解密yml文件的工具。

示例

# 输入加密hello.yml文件
ansible-vault encrypt hello.yml
# 查看加密文件，我们会发现它是 AES256 进行加密的
cat hello.yml
# 查看原文
ansible-vault view hello.yml
# 编辑加密文件
ansible-vault edit hello.yml
# 修改密码
ansible-vault rekey hello.yml
# 解密hello.yml文件
ansible-vault decrypt hello.yml
# 创建新文件
ansible-vault create hello.yml

Ansible-console交互式命令

可交互式执行命令工具

# 运行该工具
ansible-console
# 我们会看到如下内容
root@all (2)[f:5]$

关于该格式的内容可以做如下解释：
执行用户@当前操作的主机组（当前组的主机数量）[f:并发的数量] $

设置10并发数

forks 10

切换到webserver组

cd webserver

查看该组下的主机地址集合

list

列出所有内置命令

? 或 help

执行模块

# [模块名] 参数
# 举例
shell ls

YAML介绍

YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他很多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。

Yaml (Ait’t Markup Language),即YAML不是XML。不过，在开发的这种语言时，YAML的意思其实是：Yet Another Markup Language（仍然是一种标记语言）

特性

• YAML的可读性好
• YAML与脚本语言的交互性好
• YAML使用实现语言的数据类型
• YAML有一个一致的信息模型
• YAML易于实现
• YAML可以基于流来处理
• YAML表达能力强，扩展性好
  更多请参考： http://www.yaml.org

YAML简介

• 在单一档案中，可用连续三个连字号（—-）区分多个档案。另外，还有选择性的连续三个点（…）用来表示档案结尾
• 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能
• 使用#号注释代码
• 缩进必须是统一的，不能空格和tab混用
• 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的
• YAML文件内容和Linux系统大小写判断方式保持一致，是区别大小的，k/v的值均需大小写敏感
• k/v的值可同行写也可以换行写。同行使用：分隔
• v可是个字符串，也可是另一个列表
• 一个完整的代码块功能需最少元素需包括 name: task
• 一个name只能包括一个task
• YAML文件扩展名通常为yml或yaml

Yaml List集合

List： 列表，其所有元素均使用 - 打头
示例：

# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango

Yaml Dictionary集合

Dictionary： 字典，通常由多个key与value构成
示例：

---
# An employee record
name: Example Developer
job: Developer
skill: Elite

也可以将 key:value 放置于{}中进行表示，用逗号（,）分隔多个 key:value
示例：

---
# An employee record
{ name: Example Developer,job: Developer,skill: Elite }

YAML的语法和其他高阶语言类似，并且可用简单表达清单、散列表，标量等数据结构。其（Structure）通过空格来展示，序列（Sequence）里的项用-来代表，Map里的键值对用:分隔
示例：

name: John Smith
age: 41
gender: Male
spouse:
  name: Jane Smith
  age: 37
  gender: Female
children:
  - name: Jimmy Smith
    age: 17
    gender: Male
  - name: Bob He
    age: 19
    gender: Female

Playbook

- playbook是由一个或多个play组成的列表。
- play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲，所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中，即可以让它们联同起来按事先编排的机制同唱一台大戏
- Playbook采用Yaml语言编写

原理讲解

1. 首先用户创建很多个play列出一个yaml清单。
2. 然后通过ansible-playbook进行执行先每一个play
3. 每一个play里面又找到多个task任务
4. 然后从task任务中又找到相对应的模块
5. 最后从主机清单中找到需要执行的主机列表
6. 然后通过SSH进行连接
7. 最后在各个主机上执行

核心元素

Hosts

playbook中的每一个play的目的都是为了让某个或某些主机指定的用户身份执行任务。host用于指定要执行任务的主机，须事先定义在主机清单中

可以是如下形式：
one.example.com
one.example.com:two.example.com
192.168.1.50
192.168.1.*
webserver:dbserver 两个组的并集
webserver:&dbserver 两个组的交集
webserver:!phoenix 在webserver组，但不在dbserver组

# 示例
- hosts: webserver:dbserver

示例

我们将原有的httpd停掉，然后将其卸载，最后我们将在本地进行安装一个httpd然后对index.html做出一定的修改，进行分发到不同的主机上。

# 停止该服务
ansible all -m shell -a 'systemctl stop httpd'
# 卸载软件
ansible all -m yum -a 'name=httpd state=absent'
# 在本机安装httpd
yum install httpd
# 创建/var/www/html/index.html
echo 'aidasi apache' > /var/www/html/index.html

创建file.yaml文件,添加如下任务将会进行创建/data/newfile文件方法，创建创建test2用户方法，并安装httpd应用等功能方法

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: 创建文件
      file: name=/data/newfile state=touch
    - name: 创建test2用户
      user: name=test2 system=yes shell=/sbin/nologin
    - name: 安装httpd包
      yum: name=httpd
    - name: 复制网页
      copy: src=/var/www/html/index.html dest=/var/www/html
    - name: 启动服务
      service: name=httpd state=started enabled=yes

我们先测试一下我们等yaml有没有问题，然后再进行执行。

# 测试yaml执行
ansible-playbook -C file.yaml
# 执行yaml
ansible-playbook file.yaml

最后我们到实体机上测试任务是否全部完成。

ansible all -a 'ls /data'
ansible all -a 'getent passwd test2'
ansible all -a 'ss -lp src :80'
# 或
ansible all -m shell -a 'ss -tln|grep :80'

Remote_user

可用于Host和task中。也可以通过指定其通过sudo的方式主机上执行任务，其可用于play全局或某任务；此外，甚至可以在sudo时使用sudo_user指定sudo时切换的用户

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: test connection
      ping:
      remote_user: aidasi  # 远程连接的用户
      sudo: yes  # 默认为root
      sudo_user: testuser # sudo为testuser

task列表和action

play的主体部分是task list。task list 中各任务按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个任务后再完成第二个。在运行自下而下某playbook时，如果中途发生错误，所有已执行任务都将回滚，因此，在更正playbook后重新执行一次即可。

task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是冥等的，这意味着多次执行是安全的，因为其结果均一致

每个task都应该有其name，用于playbook的执行输出，建议其内容尽可能的清晰的描述任务执行步骤。如果未提供name，则action的结果将用于输出

关于中途任务执行报错的解决方案

如果命令或脚本的退出码不为零，可以使用如下方式替代。

task:
- name: xxxxx
  shell: 你的命令 || /bin/true

或者使用ignore_errors来忽略错误信息。

task:
- name: xxxxx
  shell: 你的命令
  ignore_errors: True

运行playbook

运行playbook的方式

ansible-playbook <filename.yaml> [options]

常见选项

示例

ansible-playbook file.yaml --check #只检测
ansible-playbook file.yaml
ansible-playbook file.yaml --limit webserver #只执行webserver组下面的
ansible-playbook file.yaml --list-tags  # 查看标记

handlers和notify结合使用触发条件

Handlers

是task列表，这些task与前述的task并没有本质上的不同，用于当前关注的支援发生变化时，才会采取一定的操作。

Notify

Notify此action可用于在每个play的最后被触发，这样可避免多次有改变发生时每次都执行指定的操作，仅在所有的变化发生完成最后一次性地执行指定操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作。

示例

当我们对index.html的内容做了一些修改的时候，或者我们对阿帕奇服务器的配置文件做出一些调整的时候，我就需要重启一下服务，那么我们可以在复制完网页后执行重启事件。如果我们在重启后还需要对其中的内容进行查看我们还可以添加一个事件

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: 安装httpd包
      yum: name=httpd
    - name: 复制网页
      copy: src=/var/www/html/index.html dest=/var/www/html backup=yes
      notify: restart service
    - name: 启动服务
      service: name=httpd state=started enabled=yes
  handlers:
    - name: restart service
      service: name=httpd state=restarted

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: 安装httpd包
      yum: name=httpd
    - name: 复制网页
      copy: src=/var/www/html/index.html dest=/var/www/html backup=yes
      notify:
        - restart service
        - view content
    - name: 启动服务
      service: name=httpd state=started enabled=yes
  handlers:
    - name: restart service
      service: name=httpd state=restarted
    - name: view content
      shell: cat /var/www/html/index.html

Tags的应用

在每个action上标记tags后，可以只执行其中的一个或多个标记上的action。

示例

这里我们在安装httpd包设置inshttpd标签，复制网页并重启我们也设置 thrshttpd 标签，然后我们只需要执行这两个标签时就可以通过下面的命令进行执行。

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: 安装httpd包
      yum: name=httpd
      tags: inshttpd
    - name: 复制网页
      copy: src=/var/www/html/index.html dest=/var/www/html backup=yes
      notify:
        - restart service
        - view content
      tags: thrshttpd
    - name: 启动服务
      service: name=httpd state=started enabled=yes
  handlers:
    - name: restart service
      service: name=httpd state=restarted
    - name: view content
      shell: cat /var/www/html/index.html

# t 参数
ansible-playbook -t inshttpd,thrshttpd file2.yaml