Ansible 剧本变量
一、变量的介绍
1.概述
变量提供了便捷的方式来管理Ansible playbook的每一个项目中的动态值，比如nginx-1.6.3这个软件包的版本，在其它地方或许会反复使用，那么如果将此值设置为变量，然后再在其他的playbook中调用，会方便许多。如此一来还方便维护，减少维护的成本。
2.定义变量的方式
1.通过命令行进行变量定义
2.在play文件中进行变量定义
3.通过Inventory主机清单中进行变量定义
4.通过vars_file定义变量
5.通过hosts_vars和group_vars定义变量 #官方推荐
#变量的优先级
如果在定义变量时，变量冲突了
在上述的三个地方分别设置了：
1.命令行中：age=11
2.play文件中：age=12
3.Inventory中：age=13
那么，最终的age结果一定是 11
变量的读取优先级：命令行 > playbook文件 > Inventory文件
#变量设置：命名时，应该由字母，数字，下划线组成，必须由字母开头
二、变量的定义
1.在playbook文件中进行变量定义
# 1. 方式一：在模块下定义变量
[root@m01 ~]# cat nfs_yum.yml
- hosts: nfs_group
tasks:
- name: install tree server
yum:
name: "{{ packages }}"
vars:
packages:
- tree
- name: remove tree server
yum:
name: "{{ packages }}"
state: absent
vars:
packages:
- tree
#问题：
1.如果将变量设置到模块下，那么其他的name是不识别的
# 2. 方式二：在hosts下定义变量
[root@m01 ~] # vim yum.yml
- hosts: nfs_group
vars:
packages:
- tree
tasks:
- name: Installed tree Server
yum:
name: "{{ packages }}"
- name: remove tree server
yum:
name: "{{ packages }}"
state: absent
#问题：
1.创建目录时可能会出现格式转换问题
2.如果将变量设置到hosts下，那么其他的hosts是不识别的
# 3. 方式三：在hosts下面定义多个变量
[root@m01 ~]# cat nfs_yum.yml
- hosts: nfs_group
vars:
packages:
- tree
db:
- httpd
- httpd-tools
tasks:
- name: Installed tree Server
yum:
name: "{{ packages }}"
- name: install httpd server
yum:
name: "{{ db }}"
- name: Mkdir Dir
file:
path: /tmp/{{ packages }}
state: directory
2.通过vars_file定义变量
刚才我们学到在playbook中使用vars定义变量，有一个缺陷，就是其他的playbook无法使用该变量。所以我们可以采取第二种定义变量的方式，在vars_file中定义变量。
# 1.准备变量文件
[root@m01 ~]# vim vars.yml
web:
- httpd
- httpd-tools
db: tree
# 2.调用变量文件
[root@m01 ~]# vim yum.yml
- hosts: nfs_group
vars_files: /root/vars.yml
tasks:
- name: Installed http Server
yum:
name: "{{ web }}"
- name: Installed tree Server
yum:
name: "{{ db }}"
3.通过Inventory主机清单中进行变量定义
# 1.配置主机清单
[root@m01 ~]# vim /etc/ansible/hosts
... ...
[db_server]
db01 ansible_ssh_pass='123'
[db_server:vars]
web=httpd
# 2.调用变量
[root@m01 ~]# vim yum.yml
- hosts: db_server
tasks:
- name: Touch File
file:
path: /tmp/{{ web }}
state: touch
#注意：
1.主机清单中定义变量，只要hosts配置的是主机清单中设置变量的组，可以直接使用变量
2.如果hosts配置的不是主机清单中设置变量的组，变量不可识别
# 3.主机清单定义变量注意
1.设置主机清单的变量
[root@m01 ~]# vim /etc/ansible/hosts
[lb_group]
lb01 ansible_ssh_pass='123'
lb02 ansible_ssh_pass='123'
[web_group]
web01 ansible_ssh_pass='123'
web02 ansible_ssh_pass='123'
[nginx:children]
web_group
lb_group
[nginx:vars]
web=nginx_group
[web_group:vars]
web=nginx_host
# 1.主机组定义的变量优先级高于整合组定义的变量
# 2.主机定义的变量优先级高于主机组定义的变量
4.通过hosts_vars和group_vars定义变量
之前的几种变量定义都不是很好用，比较好用的是在Ansible项目目录下创建两个变量目录：
host_vars
group_vars
切记，目录名字一定要一致，不能做任何修改。
1.主机组定义变量
#1.创建主机组变量的目录，不能改名字
[root@m01 ~]# mkdir group_vars
#2.目录下创建变量文件，文件的名字要跟主机清单中主机组名字一致
[root@m01 ~]# cd group_vars/
[root@m01 group_vars]# vim web_group
file: group_vars
#3.调用变量
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
#4.注意：
1.只要剧本中的hosts与设置变量的主机组名字相同，就可以直接使用变量
2、主机定义变量
#1.创建主机变量的目录，不能改名字
[root@m01 ~]# mkdir host_vars
#2.目录下创建变量文件，文件的名字要跟主机清单中主机名字一致
[root@m01 ~]# vim host_vars/web01
file: host_vars
#3.调用变量
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
#4.执行
[root@m01 ~]# ansible-playbook test.yml
#5.查看执行结果
[root@web01 ~]# ll /tmp/
total 0
-rw-r--r--. 1 root root 0 Dec 22 17:35 host_vars
[root@web02 ~]# ll /tmp/
total 0
-rw-r--r-- 1 root root 0 Dec 22 17:35 group_vars
#6.注意：
1）主机组定义的变量优先级高于整合组定义的变量
2）主机定义的变量优先级高于主机组定义的变量
5.命令行定义变量（命令行 -e 设置变量）
# 1、查看剧本文件
[root@m01 ~]# cat test.yml
- hosts: web_group
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
# 2、命令行指定变量执行
[root@m01 ~]# ansible-playbook test.yml -e "file=minglinghang"
# 3、查看远端文件
[root@web01 ~]# ll /tmp/
total 0
-rw-r--r--. 1 root root 0 Dec 22 17:41 minglinghang
[root@web02 ~]# ll /tmp/
total 0
-rw-r--r-- 1 root root 0 Dec 22 17:41 minglinghang
# 4、修改剧本
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
- name: Touch File
file:
path: /tmp/{{ file2 }}
state: touch
# 5、命令行指定多个变量
[root@m01 ~]# ansible-playbook test.yml -e "file=command" -e "file2=command2"
6.直接使用内置变量
# 查看内置变量
[root@m01 ~]# ansible 'web_group' -m setup
# 查看内部变量的主机名
[root@m01 ~]# ansible 'web_group' -m setup -a 'filter=ansible_fqdn'
#使用内置变量创建目录，目录格式为 主机名_IP_时间
[root@m01 ~]# vim test.yml
- hosts: nfs_group
tasks:
- name: Touch File
file:
path: /backup/{{ ansible_fqdn }}_{{ ansible_eth1.ipv4.address }}_{{ ansible_date_time.date }}
state: directory
[root@nfs ~]# ll #相当于在nfs机器上创建时间备份目录
drwxr-xr-x 2 root root 6 May 6 22:37 nfs_172.16.1.131_2021-05-06
7.内置变量设置变量
[root@m01 ~]# vim test.yml
- hosts: nfs_group
vars:
- host: "{{ansible_fqdn }}"
- remoe_ip: "{{ ansible_eth1.ipv4.address }}"
- date: "{{ ansible_date_time.date }}"
tasks:
- name: Touch File
file:
path: /backup/{{ remote_ip }}_{{ host }}_{{ date }}
state: directory
8.内置变量常用方式
# 1.编写配置文件
[root@m01 ~]# vim /etc/redis.conf
bind {{ ansible_eth1.ipv4.address }}
# 2.配置playbook
[root@m01 ~]# cat redis.yml
- hosts: web_group
tasks:
- name: install redis server
yum:
name: redis
- name: config redis
template:
src: /root/mm/redis.conf
dest: /etc
# 3.执行
[root@m01 ~]# ansible-playbook redis.yml
# 4.查看结果
[root@web01 ~]# grep '^bind' /etc/redis.conf
bind 172.16.1.107
[root@web02 ~]# grep '^bind' /etc/redis.conf
bind 172.16.1.108
三、Ansible定义变量
1.设置变量的方法
1.在主机清单中配置变量
2.在命令行定义变量
3.在playbook中定义变量
4.使用内置变量
5.通过vars_file定义变量
6.通过host_vars和group_vars定义变量
2.变量优先级测试
1、在playbook中定义变量
[root@m01 ~]# vim test.yml
- hosts: web_group
vars:
file: playbook_vars
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
2、在vars_file中定义变量
#1.定义变量文件
[root@m01 ~]# vim vars.yml
file: vars_file
#2.剧本调用
[root@m01 ~]# vim test.yml
- hosts: web_group
vars:
file: playbook_vars
vars_files: /project/vars.yml
tasks:
- name: Touch File
file:
path: /tmp/{{ file }}
state: touch
# 3、主机清单定义变量
[root@m01 ~]# vim /etc/ansible/hosts
[web_group:vars]
file=inventory_vars
# 4、host_vars 定义变量
[root@m01 ~]# vim host_vars/web01
file: host_vars
# 5、group_vars定义变量
[root@m01 ~]# vim group_vars/web_group
file: group_vars
# 6、命令行定义变量
[root@m01 ~]# ansible-playbook test.yml -e "file=command"
# 7、测试优先级结果
命令行优先级 > vars_file优先级 > playbook_vars优先级 > host_vars优先级 > group_vars优先级 > 主机清单中主机组的优先级 > 主机清单中整合组的优先级
3.层级定义变量
# 1.编辑变量文件
[root@m01 ~]# vim vars_file.yml
lamp:
framework:
web_package: httpd
db_package: mariadb-server
php_package: php
lnmp:
framework:
web_package: nginx
db_package: mysql
php_package: php
lnmt:
framework:
web_package: nginx
db_package: mysql
java_package: tomcat
# 2.编辑playbook文件
[root@m01 ~]# vim test.yml
- hosts: web_group
vars_files: ./vars_file.yml
tasks:
- name: Install LAMP httpd
yum:
name: "{{ lamp.framework.web_package }}"
- name: Install LAMP mariadb-server
yum:
name: "{{ lamp.framework.db_package }}"
- name: Install LAMP php
yum:
name: "{{ lamp.framework.php_package }}"
# 3.官方推荐写法
[root@m01 ~]# vim test.yml
- hosts: web_group
vars_files: ./vars_file.yml
tasks:
- name: Install LAMP httpd
yum:
name: "{{ lamp['framework']['web_package'] }}"
- name: Install LAMP mariadb-server
yum:
name: "{{ lamp['framework']['db_package'] }}"
- name: Install LAMP php
yum:
name: "{{ lamp['framework']['php_package'] }}"
# 4.执行playbook
[root@m01 ~]# ansible-playbook test.yml
四、变量注册
当Absible的模块运行以后，其实都会返回一些结果（result），就像是执行脚本，我们有的时候需要脚本给我们一些返回值（return），这时我们才知道，上一步是否可以执行成功；
但是...默认情况下，Ansible的结果（result）并不会显示出来，所以，我们可以把这些返回值'存储'到变量中，这样我们就能通过'调用'对应的变量名，从而获取到这些结果（result），这种将模块的返回值，写入到变量中的方法被称为变量注册
1.使用ad-hoc模式会得到返回结果
[root@m01 ~]# ansible web01 -m shell -a 'df -h'
web01 | CHANGED | rc=0 >>
Filesystem Size Used Avail Use% Mounted on
devtmpfs 475M 0 475M 0% /dev
tmpfs 487M 0 487M 0% /dev/shm
tmpfs 487M 7.6M 479M 2% /run
tmpfs 487M 0 487M 0% /sys/fs/cgroup
/dev/mapper/centos-root 17G 2.3G 15G 13% /
/dev/sda1 1014M 163M 852M 17% /boot
tmpfs 98M 0 98M 0% /run/user/0
2.使用playbook执行同样的命令得不到结果
[root@m01 ~]# cat test.yml
- hosts: web_group
tasks:
- name: list File
shell: "df -h "
[root@m01 ~]# vim a.yml
[root@m01 ~]# ansible-playbook a.yml
PLAY [web01] ******************************************************************************
TASK [Gathering Facts] ********************************************************************
ok: [web01]
TASK [list dir] ***************************************************************************
changed: [web01]
PLAY RECAP ********************************************************************************
web01 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
3.使用注册变量的方式
# 1、注册一个变量
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
shell: "df -h"
register: get_dir_list
# 2、调用并输出变量
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
shell: "df -h"
register: get_dir_list
- name: Get Register
debug:
msg: "{{ get_dir_list }}"
# 3、只输出想要的部分
[root@m01 ~]# vim test.yml
- hosts: web_group
tasks:
- name: Touch File
shell: "df -h"
register: get_dir_list
- name: Get Register
debug:
msg: "{{ get_dir_list['stdout_lines'] }}"
4.变量注册一般使用场景
[root@m01 lnmp]# cat lnmp2.yml
- hosts: web_group
tasks:
- name: Tar php Package
unarchive:
src: /root/package/php.tar.gz
dest: /tmp/
- name: Check php Install Status
shell: "rpm -qa | grep php | wc -l"
register: get_php_instll_status
- name: Install php Server
shell: "yum localinstall -y /tmp/*.rpm"
when: get_php_instll_status.stdout_lines == 0
- name: Config php Server
copy:
src:/root/mm/php.ini
dest: /etc/
- name: Config php Server
copy:
src: /root/mm/www.conf
dest: /etc/php-fpm.d/
- name: Start php Server
systemd:
name: php-fpm
state: started
五、facts缓存
Ansible facts是在被管理主机上通过Ansible自动采集发现的变量。facts包含每台特定的主机信息。比如：被控端的主机名、IP地址、系统版本、CPU数量、内存状态、磁盘状态等等。
1.使用场景
1.通过facts缓存检查CPU，来生成对应的nginx配置文件
2.通过facts缓存检查主机名，生成不同的redis配置文件
3.通过facts缓存检索物理机的内存大小来生成不通的mysql配置文件
综上所述的Ansible facts类似于saltstack中的grains对于做自动化的小伙伴是非常有用滴。
2.关闭facts缓存
[root@m01 ~]# vim facts.yml
- hosts: web_group
gather_facts: no #关闭信息采集
tasks:
#如果不使用内置变量，可以关闭会提高剧本的执行速度，如果使用内置变量，那么不能关闭facts缓存
3.一般使用
#1.配置redis配置文件
[root@m01 ~]# vim /etc/redis.conf
bind {{ ansible_eth1.ipv4.address }}
#2.编写剧本
- hosts: web_group
tasks:
- name: Install Redis Server
yum:
name: redis
state: present
- name: Config Redis Server
template:
src: /root/mm/redis.conf
dest: /etc/
#3.查看受控端配置
[root@web01 ~]# vim /etc/redis.conf
bind 172.16.1.107
[root@web02 ~]# vim /etc/redis.conf
bind 172.16.1.108
