Ansible主机清单与playbook 剧本

一、inventory 主机清单

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

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

vim /etc/ansible/hosts
[webservers]
192.168.80.11:2222		#冒号后定义远程连接端口，默认是 ssh 的 22 端口
192.168.80.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	提升为指定用户权限时的密码

（1）主机变量

[webservers]
192.168.80.11 ansible_port=22 ansible_user=root ansible_password=123

（2）组变量

[webservers:vars] #表示为 webservers 组内所有主机定义变量
ansible_user=root
ansible_password=123

[all:vars] #表示为所有组内的所有主机定义变量
ansible_port=22

（3）组嵌套

[nginx]
192.168.80.20
192.168.80.21
192.168.80.22

[apache]
192.168.80.3[0:3] #表示192.168.80.30 - 192.168.80.33之间的IP

[webs:children] #表示为 webs 主机组中包含了 nginx 组和 apache 组内的所有主机
nginx
apache

二、Ansible 的脚本 --- playbook 剧本

playbook是一个不同于使用Ansible命令行执行方式的模式，其功能更强大灵活。简单来说，playbook是一个非常简单的配置管理和多主机部署系统，不同于任何已经存在的模式，可作为一个适合部署复杂应用程序的基础。

Playbook可以定制配置，可以按照指定的操作步骤有序执行，支持同步和异步方式。我们完成一个任务，例如安装部署一个httpd服务，我们需要多个模块（一个模块也可以称之为task）提供功能来完成。而playbook就是组织多个task的容器，他的实质就是一个文件，有着特定的组织格式，它采用的语法格式是YAML（Yet Another Markup Language）。

playbooks 本身由以下各部分组成

（1）Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行
（2）Variables：变量
（3）Templates：模板
（4）Handlers：处理器，当changed状态条件满足时，（notify）触发执行的操作
（5）Roles：角色

2.1 基础playbook编写

示例：playbook编写 apache的 yum安装部署剧本

vim test1.yaml
---     #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play     #定义一个play的名称，可省略
  gather_facts: false    #设置不进行facts信息收集，这可以加快执行速度，可省略
  hosts: webservers    #指定要执行任务的被管理主机组，如多个主机组用冒号分隔
  remote_user: root    #指定被管理主机上执行任务的用户
  tasks:     #定义任务列表，任务列表中的各任务按次序逐个在hosts中指定的主机上执行
   - name: test connection    #自定义任务名称
     ping:     #使用 module: [options] 格式来定义一个任务
   - name: disable selinux
     command: '/sbin/setenforce 0'    #command模块和shell模块无需使用key=value格式
     ignore_errors: True     #如执行命令的返回值不为0，就会报错，tasks停止，可使用ignore_errors忽略失败的任务
   - name: disable firewalld
     service: name=firewalld state=stopped    #使用 module: options 格式来定义任务，option使用key=value格式
   - name: install httpd
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf    #这里需要一个事先准备好的/opt/httpd.conf文件
     notify: "restart httpd"    #如以上操作后为changed的状态时，会通过notify指定的名称触发对应名称的handlers操作
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:     #handlers中定义的就是任务，此处handlers中的任务使用的是service模块
   - name: restart httpd    #notify和handlers中任务的名称必须一致
     service: name=httpd state=restarted
##Ansible在执行完某个任务之后并不会立即去执行对应的handler，而是在当前play中所有普通任务都执行完后
再去执行handler，这样的好处是可以多次触发notify，但最后只执行一次对应的handler，从而避免多次重启。

记得在opt目录下放入httpd的配置文件，不然报错。

运行playbook

ansible-playbook test1.yaml

在以上的 Ansible Playbook 配置中，notify 指令会在 install configuration file for httpd 任务成功完成后立即触发，但实际的重启操作（restart httpd）并不会立即执行。相反，Ansible 会将所有被通知（notify）的 handler 收集起来，在整个 play 中所有普通任务执行完毕后，再按照定义的顺序执行这些 handler。

所以，尽管 install configuration file for httpd 任务完成后会立即发出通知（notify），restart httpd 处理器将在该 play 中所有其他 tasks 完成后执行。这种设计有助于避免在配置变更的多个任务之间频繁重启服务，而是统一在所有配置更改完成后进行服务重启，以确保服务状态的一致性和高效性。

补充参数：

-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户
ansible-playbook test1.yaml --syntax-check    #检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task       #检查tasks任务
ansible-playbook test1.yaml --list-hosts      #检查生效的主机
ansible-playbook test1.yaml --start-at-task='install httpd'     #指定从某个task开始运行

也就是task任务列表从- name: install httpd 开始运行，前面定义的关闭防火墙、关闭核心防控、ping
将不执行。

示例：playbook编写nginx 的yum安装并且能修改其监听端口的剧本

在编写剧本前，需要准备相应的文件

剧本编写：

---
- gather_facts: false
  hosts: host1
  remote_user: root
  tasks:
    - name: test connection
      ping:
    - name: disable selinux
      command: '/sbin/setenforce 0'
      ignore_errors: True
    - name: disable firewalld
      service: name=firewalld state=stopped

    - name: yum epel                #yum安装epel源
      yum: name=epel-release

    - name: yum nginx               #yum安装nginx
      yum: name=nginx state=latest

    - name: install configuration file for nginx
      copy: src=/opt/benet.conf  dest=/etc/nginx/conf.d/benet.conf
      notify:
        - restart nginx                  #copy模块执行完成后 将启动该模块

    - name: start nginx
      service: name=nginx state=started enabled=yes

  handlers:                             #tasks执行完成后触发模块的触发动作
    - name: restart nginx
      service: name=nginx state=restarted    #重启nginx服务

2.2 定义、引用变量

基础变量的定义与引用

在yaml文件中，我们可以在初始配置的模块中用var去定义变量的存在，变量的格式为key:value,以此来确定该变量在剧本中的存在

vim test3.yaml
---
- hosts: host1
  remote_user: root
  vars:
   filename: wang.win
  tasks:
   - name: touch a new file
     file: path=/opt/{{filename}} state=touch
 
 
ansible-playbook test3.yaml

引用fact信息中的变量

首先我们知道使用 ansible 组 -m setup 可以收集该组中所有的节点信息，

所以setup中fact'信息，有时候会剧本编写中需要，而fact的信息也是可以通过变量的方式进行调用

---
- hosts: host1
  remote_user: root
  tasks:
    - name: read setup1
      debug:
        msg: "Today is {{ ansible_date_time.date }} (weekday: {{ ansible_date_time.weekday }})"

debug模块为yaml文件中的测试模块

通常用var进行输入调试信息
使用msg输出调试信息

扩展：

vim test6.yaml

- name: second play
  hosts: dbservers
  remote_user: root
  vars:                 #定义变量
   - groupname: mysql   #格式为 key: value
   - username: wweww
  tasks:
   - name: create group
     group: name={{groupname}} system=yes gid=507    #使用 {{key}} 引用变量的值
   - name: create user
     user: name={{username}} uid=507 group={{groupname}} 
   - name: copy file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息



ansible-playbook test6.yaml

我们也可以在命令行中指定变量

ansible-playbook test6.yaml -e "username=wweww" #在命令行里定义变量（如果再执行一次会报错）

2.3 指定远程主机sudo切换用户

---
- hosts: host1
  remote_user: zhangsan            
  become: yes	                 #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: root              #指定sudo用户为root
执行playbook时：ansible-playbook test1.yml -K <密码>

-K ：用来交互输入sudo密码
这里输入的是zhangsan用户的密码


这段playbook配置是在host1主机上以普通用户zhangsan的身份登录，并通过sudo或su等机制切换到root
用户以执行需要管理员权限的任务。


如果该账户没有被sudo授予权限可以在目标主机的/etc/sudoers文件中给zhangsan用户授权

示例：

---
- hosts: host1
  remote_user: zhangsan

  tasks:
    - name: Remove vars.txt from /opt directory
      command: sudo rm -rf /opt/vars.txt


由于 zhangsan 已经具备相应权限，您无需使用 become 或 become_user 选项

去host1主机给张三授予sudo权限

vim /etc/sudoers

在93行添加
zhangsan ALL=(ALL) NOPASSWD: /bin/rm -rf /opt/*

2.4 when条件判断

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。

when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim test7.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host 
     command: /sbin/shutdown -r 17:40                          #17点40重启计算机
     when: ansible_default_ipv4.address == "192.168.80.16"      #when指令中的变量名不需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>"
	
ansible-playbook test7.yaml


如果你不想重启可使用/sbin/shutdown -c
如果你想立即重启就使用/sbin/shutdown -r now

除此之外 when条件还可以通过！=（不等于条件来进行判断）

vim test8.yaml

---
- hosts: all
  remote_user: root
  tasks:
   - name: test when
     debug: msg='判断位置'
     when: ansible_default_ipv4.address != "192.168.80.16"


ansible-playbook test8.yaml

2.5 迭代（变量循环）

Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。

示例：

---
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory
      with_items:          #等同于 loop:
        - /tmp/test1
        - /tmp/test2
#这里使用了 Jinja2 模板语法 {{item}}，并通过 with_items 列表迭代器依次传入 /tmp/test1 和
 /tmp/test2 作为 path 的值，directory表示文件夹
#作用：创建 /tmp/test1 和 /tmp/test2 目录


    - name: add users
      user: name={{item.name}} state=present groups={{item.groups}}
      with_items:
        - name: test1
          groups: wheel
        - name: test2
          groups: root
或
      with_items:
        - {name:'test1', groups:'wheel'}
        - {name:'test2', groups:'root'}

#使用了 with_items 迭代器，传入了一个包含多个字典的列表，每个字典代表一个待创建用户的属性。
#添加名为 test1 的用户，并将其加入 wheel 组。
#添加名为 test2 的用户，并将其加入 root 组。

2.6 Templates 模块

Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件，可以看作是一个编译过的模板文件，用来产生目标文本，传递Python的变量给模板去替换模板中的标记。

本次我们以改变apche的配置文件为例，来展现Templates模块的运用

1.先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量

cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2

vim /opt/httpd.conf.j2


Listen {{http_port}}				#42行，修改（原格式：Listen 80）
ServerName {{server_name}}			#95行，修改（原格式：#ServerName www.example.com:80）

2.修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

vim /etc/ansible/hosts

[host1]
192.168.80.11 http_port=6680 server_name=www.accp.com:6680

[host2]
192.168.80.12 http_port=8891 server_name=www.benet.com:8891

3.编写 playbook

---
- hosts: host1,host2
  remote_user: root
  vars:
    - winny: httpd
      server: httpd
  tasks:
    - name: install httpd
      yum: name={{winny}} state=latest
    - name: install conf file
      template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
      notify:
      - restart httpd
    - name: start httpd
      service: name={{server}} enabled=yes state=started
  handlers:
    - name: restart httpd
      service: name={{server}} state=restarted

验证：

成功访问httpd服务。

2.7 tags 模块

可以在一个playbook中为某个或某些任务定义“标签”，在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。

playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

示例1：

---
- hosts: host1
  remote_user: root
  tasks:
    - name: copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts.bak
      tags:
        - only1
    - name: tar hosts.bak
      command: tar zcf /opt/hosts.tar.gz /opt/hosts.bak
      tags:
        - only2

ansible-playbook txt3.yaml --tags="only1"

在host1 主机上查看是否只执行了 copy hosts file 。

可以看到hosts.bak 并没有被压缩说明 tar hosts.bak 并未执行

我们使用 ansible-playbook txt3.yaml --tags="only2" 查看结果

示例2：

---
- hosts: host1
  remote_user: root
  tasks:
    - name: copy passwd file
      copy: src=/etc/passwd dest=/opt/passwd.bak
      tags:
        - only1
    - name: tar passwd.bak
      command: tar zcf /opt/passwd.tar.gz /opt/passwd.bak
      tags:
        - always        #表示始终要运行的代码

ansible-playbook txt3.yaml --tags="only1"

在host1 主机上查看结果

示例3：关于tags的先后顺序

2.8 Roles 模块

Ansible为了层次化、结构化地组织Playbook，使用了角色（roles），roles可以根据层次型结构自动装载变量文件、task以及handlers等。

简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include它们。

roles一般用于基于主机构建服务的场景中，但也可以用于构建守护进程等场景中。

简述 ansible 角色

数据中心有各种不同类型的主机。如web服务器、数据库服务器，基于开发环境的服务器。随着时间的推移，具有处理所有这些情况的任务和人员的Ansible playbook将变得庞大而复杂

角色允许将复杂的剧本组织成独立的、更小的剧本和文件。
角色提供了一种从外部文件加载任务、处理程序和变量的方法。
角色也可关联和引用静态的文件和模板。
角色可以编写成满足普通用途需求，并且能被重复利用。
定义角色的文件具有特定的名称，并以严格的目录结构进行组织。

roles 的目录结构

cd /etc/ansible/
tree roles/
roles/
├── web/
│   ├── files/
│   ├── templates/
│   ├── tasks/
│   ├── handlers/
│   ├── vars/
│   ├── defaults/
│   └── meta/
└── db/
    ├── files/
    ├── templates/
    ├── tasks/
    ├── handlers/
    ├── vars/
    ├── defaults/
    └── meta/

roles 内各目录含义解释

●files
用来存放由 copy 模块或 script 模块调用的文件。

●templates
用来存放 jinjia2 模板，template 模块会自动在此目录中寻找 jinjia2 模板文件。

●tasks
此目录应当包含一个 main.yml 文件，用于定义此角色的任务列表，此文件可以使用 include 包含其它的位于此目录的 task 文件。

●handlers
此目录应当包含一个 main.yml 文件，用于定义此角色中触发条件时执行的动作。

●vars
此目录应当包含一个 main.yml 文件，用于定义此角色用到的变量。

●defaults
此目录应当包含一个 main.yml 文件，用于为当前角色设定默认变量。

●meta
此目录应当包含一个 main.yml 文件，用于定义此角色的特殊设定及其依赖关系。

在一个 playbook 中使用 roles 的步骤：

（1）创建以 roles 命名的目录

mkdir /etc/ansible/roles/ -p #yum装完默认就有

（2）创建全局变量目录（可选）

mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all #文件名自己定义，引用的时候注意

（3）在 roles 目录中分别创建以各角色名称命令的目录

mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql

需要创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p

（5）在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名

touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml

（6）修改 site.yml 文件，针对不同主机去调用不同的角色

vim /etc/ansible/site.yml
---
- hosts: host1
  remote_user: root
  roles:
     - httpd
- hosts: host2
  remote_user: root
  roles:
     - mysql

（7）运行 ansible-playbook

cd /etc/ansible
ansible-playbook site.yml

实例：

使用ansible在一台主机上搭建 lamp 架构

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta} -p

touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml

------编写httpd模块------
写一个简单的tasks/main.yml
vim /etc/ansible/roles/httpd/tasks/main.yml
- name: install apache
  yum: name={{pkg}} state=latest
- name: start apache
  service: enabled=true name={{svc}} state=started
 
//定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
vim /etc/ansible/roles/httpd/vars/main.yml
pkg: httpd
svc: httpd

-------编写mysql模块-------
vim /etc/ansible/roles/mysql/tasks/main.yml
- name: install mysql
  yum: name={{pkg}} state=latest
- name: start mysql
  service: enabled=true name={{svc}} state=started
  
vim /etc/ansible/roles/mysql/vars/main.yml
pkg:
  - mariadb
  - mariadb-server
svc: mariadb

-------编写php模块-----
vim /etc/ansible/roles/php/tasks/main.yml
- name: install php
  yum: name={{pkg}} state=latest
- name: start php-fpm
  service: enabled=true name={{svc}} state=started

vim /etc/ansible/roles/php/vars/main.yml
pkg:
  - php
  - php-fpm
svc: php-fpm

-----编写roles示例-----
vim /etc/ansible/site.yml
---
- hosts: webservers
  remote_user: root
  roles:
   - httpd
   - mysql
   - php


cd /etc/ansible
ansible-playbook site.yml