Ansible 变量

一、变量的介绍

1.概述

变量提供了便捷的方式来管理Ansible playbook的每一个项目中的动态值，比如nginx-1.6.3这个软件包的版本，在其它地方或许会反复使用，那么如果将此值设置为变量，然后再在其他的playbook中调用，会方便许多。如此一来还方便维护，减少维护的成本。

2.定义变量的方式

1.通过命令行进行变量定义
2.在playbook文件中进行变量定义
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 ~]# vim mode_vars.yml
- hosts: web_group
  tasks:
    - name: Installed http Server
      yum:
        name: "{{ packages }}"
      vars:
        packages:       => 定义变量，相对于DATE=data+%F
          - httpd
          - httpd-tools

#问题：
	1.如果将变量设置到模块下，那么其他的- name是不识别的。一个变量只能在一个模块下面使用
	2.所以。有2个模块的话，那就得重新写个- name,重新定义变量

2）方式二：在hosts下定义变量

[root@m01 ~]# vim hosts_vars.yml
- hosts: web_group
  vars:
    packages:
      - httpd
      - httpd-tools
  tasks:
    - name: Installed http Server
      yum:
        name: "{{ packages }}"

    - name: Mkdir Dir
      file:
        path: /tmp/{{ packages }}
        state: directory

#问题：
	1.创建目录时可能会出现格式转换问题
	2.如果将变量设置到hosts下，那么其他的hosts是不识别的

3）方式三：在hosts下面定义多个变量

[root@m01 ~]# vim yum.yml 
- hosts: web_group 
  vars:
    packages:
      - httpd
      - httpd-tools
    dbs:
      - mariadb-server
      - MySQL-python
  tasks:
    - name: Installed http Server
      yum:
        name: "{{ packages }}"
		state: present
		
    - name: Installed Mariadb Server
      yum: 
        name: "{{ dbs }}"
        state: present

2.通过vars_file定义变量

刚才我们在playbook中使用vars定义变量，有一个缺陷，就是其他的playbook无法使用该变量。所以我们可以采取第二种定义变量的方式，在vars_file中定义变量。

1）准备变量文件

[root@m01 ~]# mkdir vars
[root@m01 ~]# cd vars/
[root@m01 vars]# vim vars.yml 
packages: httpd
dbs: mariadb-server

2）调用变量文件

[root@m01 ~]# vim yum.yml 
- hosts: web_group
  vars_files: /root/vars/vars.yml
  tasks:
    - name: Installed http Server
      yum:
        name: "{{ packages }}"
        state: present
        
    - name: Installed http Server
      yum:
        name: "{{ dbs }}"
        state: present

3)用列表的方式，通过vars_file定义变量

#添加变量文件
[root@m01 ~]# cd vars/
[root@m01 vars]# vim nfs-server.yml 
nfs:
  - nfs-utils
  - rpcbind

#调用变量文件
[root@m01 ~]# vim yum.yml 
- hosts: web_group
  vars_files: 
    - /root/vars/vars.yml
    - /root/vars/nfs-server.yml 
  tasks:
    - name: Installed http Server
      yum:
        name: "{{ packages }}"
        state: present
        
    - name: Installed http Server
      yum:
        name: "{{ dbs }}"
        state: present
        
    - name: Installed nfs Server
      yum:
        name: "{{ nfs }}"
        state: present

3.通过inventory主机清单中进行变量定义，主机变量优先级高于主机变量（不推荐，容易将环境打乱）

1）配置主机清单

[root@m01 ~]# vim /etc/ansible/hosts 
[web_group]
web01 ansible_ssh_pass='1'
web02 ansible_ssh_pass='1'
... ...

[web_group:vars]
web=httpd
db=mariadb-server

2）调用变量

[root@m01 ~]# vim yum.yml 
- hosts: web_group
  tasks:
    - name: install web server
      yum:
        name: "{{ web }}"
        state: absent
    - name: install db server
      yum:
        name: "{{ db }}"
		state: absent
		
#注意：
	1.主机清单中定义变量，只要hosts配置的是主机清单中设置变量的组，可以直接使用变量
	2.如果hosts配置的不是主机清单中设置变量的组，变量不可识别

3）主机清单定义变量注意

1.设置主机清单的变量
[root@m01 project]# vim /etc/ansible/hosts
[lb_server]
lb01 ansible_ssh_pass='1'
lb02 ansible_ssh_pass='1'

[web_group]
web01 ansible_ssh_pass='1'
web02 ansible_ssh_pass='1'

[nginx:children]
web_group
lb_server

[nginx:vars]
web=nginx_group 

[web_group:vars]
web=nginx_host

2.主机组定义的变量优先级高于整合组定义的变量
3.主机定义的变量优先级高于主机组定义的变量

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
web: httpd

#3.调用变量
[root@m01 ~]# vim test.yml 
- hosts: web_group
  tasks:
    - name: mkdir dir
      file:
        path: /tmp/{{ web }}
        state: directory
        
#4.注意：
	1.只要剧本中的hosts与设置变量的主机组名字相同，就可以直接使用变量,hosts里面没有[.:vars]

2）主机定义变量

#1.创建主机变量的目录，不能改名字
[root@m01 ~]# mkdir host_vars

#2.目录下创建变量文件，文件的名字要跟主机清单中主机名字一致
[root@m01 ~]# vim host_vars/web01
web: web01_host_vars

#3.调用变量
[root@m01 project]# vim test1.yml 
- hosts: web_group
  tasks:
    - name: mkdir dir
      file:
        path: /tmp/{{ web }}
        state: directory

#4.执行
[root@m01 ~]# ansible-playbook test1.yml

#5.注意：
	1）主机组定义的变量优先级高于整合组定义的 变量
	2）主机定义的变量优先级高于主机组定义的变量

5.命令行定义变量（命令行 -e 设置变量）

通过命令行覆盖变量，优先级最高

# 令行直接指定变量所覆盖。使用--extra-vars或-e设定变量
[root@m01 ~]# ansible-playbook test.yml -e "file=minglinghang"

变量优先级排序：

1、命令行变量

2、play中的vars_files

3、play中的vars配置变量

4、host_vars主机定义变量

5、group_vars主机组定义变量

6、group_vars/all 主机清单定义变量

5）命令行指定多个变量

[root@m01 project]# ansible-playbook test.yml -e "file=command" -e "file2=command2"
#注意：指定的变量会根据命令行执行，没有指定的变量继续按照变量的设置执行

6.直接使用内置变量

#使用内置变量创建目录，目录格式为 主机名_IP_时间
[root@m01 project]# vim test.yml 
- hosts: web_group
  tasks:
    - name: Touch File
      file:
        path: /backup/{{ ansible_fqdn }}_{{ ansible_eth1.ipv4.address }}_{{ ansible_date_time.date }}
        state: directory

#官方推荐写法
[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'] }}"

#执行playbook
[root@m01 ~]# ansible-playbook test.yml

三、变量注册

当absible的模块在运行之后，其实都会返回一些result结果，就像是执行脚本，我们有的时候需要脚本给我们一些return返回值，我们才知道，上一步是否可以执行成功，但是...默认情况下，ansible的result并不会显示出来，所以，我们可以把这些返回值'存储'到变量中，这样我们就能通过'调用'对应的变量名，从而获取到这些result，这种将模块的返回值，写入到变量中的方法被称为变量注册

1.使用ad-hoc模式会得到返回结果

[root@m01 project]# ansible web01 -m shell -a 'ls -l /tmp'
web01 | CHANGED | rc=0 >>
total 0
drwx------. 2 root root 41 Dec 23 15:07 ansible_command_payload_Q9bnkr
-rw-r--r--. 1 root root  0 Dec 23 14:54 command
-rw-r--r--. 1 root root  0 Dec 23 14:57 host_vars
-rw-r--r--. 1 root root  0 Dec 23 14:56 playbook_vars
-rw-r--r--. 1 root root  0 Dec 23 14:55 vars_file

2.使用playbook执行同样的命令得不到结果

[root@m01 project]# cat test.yml 
- hosts: web_group
  tasks:
    - name: Touch File
      shell: "ls -l /tmp"
      
[root@m01 project]# ansible-playbook test.yml 

3.使用注册变量的方式

1）注册一个变量

[root@m01 project]# vim test.yml 
- hosts: web_group
  tasks:
    - name: Touch File
      shell: "ls -l /tmp"
      register: get_dir_list

2）调用并输出变量

[root@m01 project]# vim test.yml 
- hosts: web_group
  tasks:
    - name: Touch File
      shell: "ls -l /tmp"
      register: get_dir_list

    - name: Get Register
      debug:
        msg: "{{ get_dir_list }}"

        

3）只输出想要的部分

[root@m01 project]# vim test.yml 
- hosts: web_group
  tasks:
    - name: Touch File
      shell: "ls -l /tmp"
      register: get_dir_list

    - name: Get Register
      debug:
        msg: "{{ get_dir_list['stdout_lines'] }}"

4.变量注册一般使用场景

[root@m01 project]# cat php.yml 
- hosts: web_group
  tasks:
    - name: Tar php Package
      unarchive:
        src: /project/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: /project/conf/php.ini
        dest: /etc/

    - name: Config php Server
      copy:
        src: /project/conf/www.conf
        dest: /etc/php-fpm.d/

    - name: Start php Server
      systemd:
        name: php-fpm
        state: started