Ansible事实、循环、条件判断

Ansible事实、循环、条件判断

1. 管理事实

1.1 描述Ansible事实

Ansible事实是Ansible在受管主机上自动检测到的变量。事实中包含有与主机相关的信息，可以像play中的常规变量、条件、循环或依赖于从受管主机收集的值的任何其他语句那样使用。

为受管主机收集的一些事实可能包括：

主机名称
内核版本
网络接口
IP地址
操作系统版本
各种环境变量
CPU数量
提供的或可用的内存
可用磁盘空间

借助事实，可以方便地检索受管主机的状态，并根据该状态确定要执行的操作。例如：

可以根据含有受管主机当前内核版本的事实运行条件任务，以此来重启服务器
可以根据通过事实报告的可用内存来自定义MySQL配置文件
可以根据事实的值设置配置文件中使用的IPv4地址
通常，每个play在执行第一个任务之前会先自动运行setup模块来收集事实。

查看为受管主机收集的事实的一种方式是，运行一个收集事实并使用debug模块显示ansible_facts变量值的简短playbook。

基于模块获取事实

[root@master ansible]# ansible all -m setup      //获取受控机事实
[root@ansible project]# ansible all -m setup | less   //这条命令可以看到事实的前面

基于playbook获取事实

---
- hosts: 192.168.200.154
  tasks:
    - name: test
      debug:
        var: ansible_facts['default_ipv4']['address']   //获取默认ipv4address事实

[root@ansible project]# ansible-playbook playbook/test.yml 

PLAY [192.168.200.154] ***************************************************************************

TASK [Gathering Facts] *************************************************************************
ok: [192.168.200.154]

TASK [test] ************************************************************************************
ok: [192.168.200.154] => {
    "ansible_facts['default_ipv4']['address']": "192.168.8.132"
}

PLAY RECAP *************************************************************************************
192.168.200.154              : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

下表显示了可能从受管节点收集的并可在playbook中使用的一些事实：
Ansible事实的示例

事实	变量
短主机名	ansible_facts[‘hostname’]
完全限定域名	ansible_facts[‘fqdn’]
IPv4地址	ansible_facts[‘default_ipv4’][‘address’]
所有网络接口的名称列表	ansible_facts[‘interfaces’]
/dev/vda1磁盘分区的大小	ansible_facts[‘devices’][‘vda’][‘partitions’][‘vda1’][‘size’]
DNS服务器列表	ansible_facts[‘dns’][‘nameservers’]
当前运行的内核版本	ansible_facts[‘kernel’]

如果变量的值为散列/字典类型，则可使用两种语法来获取其值。比如：

`ansible_facts[‘default_ipv4’][‘address’]也可以写成ansible_facts.default_ipv4.address
ansible_facts[‘dns’][‘nameservers’]也可以写成ansible_facts.dns.nameservers

在play中使用事实时，Ansible将事实的变量名动态替换为对应的值：

//获取主机名为fqdn的默认ipvd地址
---
- hosts: 192.168.200.154
  tasks:
    - name: test
      debug:
        msg: >
          The host named {{ ansible_facts['fqdn'] }} of
          ip  is {{ ansible_facts['default_ipv4']['address'] }} 

[root@master project]# ansible-playbook playbook/test.yml 

PLAY [192.168.200.154] ***************************************************************************

TASK [Gathering Facts] *************************************************************************
ok: [192.168.200.154]

TASK [test] ************************************************************************************
ok: [192.168.200.154] => {
    "msg": "The host named localhost.localdomain of ip  is 192.168.8.132 \n"
}

PLAY RECAP *************************************************************************************
192.168.200.154              : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

将Ansible配置文件的[default]部分中inject_facts_as_vars参数设置为False，可关闭旧命名系统。默认设置目前为True。

# inject_facts_as_vars = True

1.2 关闭事实收集

关闭事实可以提高运行速度（gather_facts: no） 也可以使用setup模块来手动收集事实

[root@master playbook]# cat aa.yml 
---
- hosts: 192.168.200.154
  gather_facts: no
  tasks:
    - setup:
    - debug:
        var:
          ansible_facts

[root@master playbook]# ansible-playbook aa.yml 

PLAY [192.168.200.154] ******************************************************************************************************************

TASK [setup] ***************************************************************************************************************************
Enter passphrase for key '/root/.ssh/id_rsa': 
ok: [192.168.200.154]

TASK [debug] ***************************************************************************************************************************
ok: [192.168.200.154] => {
    "ansible_facts": {
        "all_ipv4_addresses": [
            "192.168.200.154"
        ],
        "all_ipv6_addresses": [
            "fe80::7014:45ea:bce2:63"
        ],
.......

1.3 创建自定义事实

除了使用系统捕获的事实外，我们还可以自定义事实，并将其本地存储在每个受管主机上。这些事实整合到setup模块在受管主机上运行时收集的标准事实列表中。它们让受管主机能够向Ansible提供任意变量，以用于调整play的行为。

自定义事实可以在静态文件中定义，格式可为INI文件或采用JSON。它们也可以是生成JSON输出的可执行脚本，如同动态清单脚本一样。

有了自定义事实，我们可以为受管主机定义特定的值，供play用于填充配置文件或有条件地运行任务。动态自定义事实允许在play运行时以编程方式确定这些事实的值，甚至还可以确定提供哪些事实。

默认情况下，setup模块从各受管主机的/etc/ansible/facts.d目录下的文件和脚本中加载自定义事实。各个文件或脚本的名称必须以.fact结尾才能被使用。动态自定义事实脚本必须输出JSON格式的事实，而且必须是可执行文件。

以下是采用INI格式编写的静态自定义事实文件。INI格式的自定义事实文件包含由一个部分定义的顶层值，后跟用于待定义的事实的键值对：

//在受控机上创建自定义事实
[root@localhost ~]# mkdir -p /etc/ansible/facts.d
[root@localhost ~]# cd /etc/ansible/facts.d/

[root@localhost facts.d]# vi test.fact
[root@localhost facts.d]# cat test.fact 
[ckages]
web_package = httpd
db_pacjage = mariadb-server

[users]
user1 = joe
user2 = janepackages

{
  "ckages": {
    "web_package": "httpd",
    "db_package": "mariadb-server"
  },
  "users": {
    "user1": "joe",
    "user2": "janepackages"
    
  }
}

自定义事实文件不能采用playbook那样的YAML格式。JSON格式是最为接近的等效格式。

自定义事实由setup模块存储在ansible_facts.ansible_local变量中。
事实按照定义它们的文件的名称来整理。例如，假设前面的自定义事实由受管主机上保存为/etc/ansible/facts.d/custom.fact的文件生成。在这种情况下，ansible_facts.ansible_local[‘custom’][‘users’][‘user1’]的值为joe。

可以利用临时命令在受管主机上运行setup模块来检查自定义事实的结构。

ansible 192.168.200.154 -m setup

自定义事实的使用方式与playbook中的默认事实相同：

[root@localhost ~]# mkdir -p /etc/ansible/facts.d
[root@localhost ~]# vi  /etc/ansible/facts.d/test.fact

{
"ckages": {
    "web_package": "httpd",
    "db_package": "mariadb-server"
  },
  "users": {
     "user1": "joe",
     "user2": "janepackages"
  }
}

[root@ansible opt]# ansible all -m setup | less

        "ansible_local": {
            "custom": {
                "ckages": {
                    "db_package": "mariadb-server",
                    "web_package": "httpd"
                },
                "users": {
                    "user1": "joe",
                    "user2": "janepackages"
                }
            }
        },

1.4 使用魔法变量

一些变量并非事实或通过setup模块配置，但也由Ansible自动设置。这些魔法变量也可用于获取与特定受管主机相关的信息。
最常用的有四个：

魔法变量	说明
hostvars	包含受管主机的变量，可以用于获取另一台受管主机的变量的值。 如果还没有为受管主机收集事实，则它不会包含该主机的事实。
group_names	列出当前受管主机所属的所有组
groups	列出清单中的所有组和主机
inventory_hostname	包含清单中配置的当前受管主机的主机名称。 因为各种原因有可能与事实报告的主机名称不同

若要深入了解它们的值，一个途径是使用debug模块报告特定主机的hostvars变量的内容：

ansible 192.168.200.154 -m debug -a 'var=hostvars["localhost"]'

2. 编写循环和条件任务

2.1 利用循环迭代任务

通过利用循环，我们无需编写多个使用同一模块的任务。例如，他们不必编写五个任务来确保存在五个用户，而是只需编写一个任务来对含有五个用户的列表迭代，从而确保它们都存在。

Ansible支持使用loop关键字对一组项目迭代任务。可以配置循环以利用列表中的各个项目、列表中各个文件的内容、生成的数字序列或更为复杂的结构来重复任务。

2.1.1 简单循环

简单循环对一组项目迭代任务。loop关键字添加到任务中，将应对其迭代任务的项目列表取为值。循环变量item保存每个迭代过程中使用的值。

请思考以下代码片段，它使用两次service模块来确保两个网络服务处于运行状态：

[root@ansible opt]# vim site.yaml 
---
  - hosts: httpd
    tasks:
      - name: Apache is running
        service:
          name: httpd
          state: started
      - name: Php is runing
        service:
          name: php-fpm
          state: started

[root@ansible opt]# ansible-playbook  site.yaml    

PLAY [httpd] **************************************************************************************************

TASK [Gathering Facts] ****************************************************************************************
ok: [httpd]

TASK [Apache is running] **************************************************************************************
ok: [httpd]

TASK [Php is runing] ******************************************************************************************
ok: [httpd]

PLAY RECAP ****************************************************************************************************
httpd                      : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

这两个任务可以重新编写为使用一个简单循环，从而只需一个任务来确保两个服务都在运行：

[root@ansible opt]# vim site.yaml 

---
  - hosts: httpd
    tasks:
      - name: Service is running
        service:
          name: "{{ item  }}"
          state: started
        loop:
          - httpd
          - php-fpm

[root@ansible opt]# ansible-playbook  site.yaml    

PLAY [httpd] **************************************************************************************************

TASK [Gathering Facts] ****************************************************************************************
ok: [httpd]

TASK [Apache is running] **************************************************************************************
ok: [httpd] => (item=httpd)
ok: [httpd] => (item=php-fpm)

PLAY RECAP ****************************************************************************************************
httpd                      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

2.1.2 循环散列或字典列表

loop列表不需要是简单值列表。在以下示例中，列表中的每个项实际上是散列或字典。示例中的每个散列或字典具有两个键，即name和groups，当前item循环变量中每个键的值可以分别通过item.name和item.groups变量来检索。

[root@ansible opt]# vim site.yaml 
---
  - hosts: httpd
    tasks:

       - name: Create groups
         group:
            name: "{{ item }}"
            state: present
            system: yes
         loop:
           - jery
           - tom

       - name: Users exist and are in the correct groups
         user:
           name: "{{ item.name  }}"
           state: present
           system: yes
           groups: "{{ item.groups  }}"
         loop:
           - name: alice
             groups: aa    #组jaa必须事先存在，否则会报错
           - name: natasha
             groups: bb  #组bb必须事先存在，否则会报错




[root@ansible opt]# ansible-playbook  site.yaml    

PLAY [httpd] **************************************************************************************************

TASK [Gathering Facts] ****************************************************************************************
ok: [httpd]

TASK [Create groups] ******************************************************************************************
changed: [httpd] => (item=aa)
changed: [httpd] => (item=bb)

TASK [Users exist and are in the correct groups] **************************************************************
changed: [httpd] => (item={'name': 'alice', 'groups': 'aa'})
changed: [httpd] => (item={'name': 'natasha', 'groups': 'bb'})

PLAY RECAP ****************************************************************************************************
httpd                      : ok=3    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

这一示例中结果是用户alice存在且为组jery的成员，并且用户joe存在且为组tom的成员

2.1.3 较早样式的循环关键字

在Ansible2.5之前，大多数playbook使用不同的循环语法。提供了多个循环关键字，前缀为whth_，后面跟Ansible查找插件的名称。这种循环语法在现有playbook中很常见，但在将来的某个时候可能会被弃用。
较早样式的Ansible循环

循环关键字	描述
with_items	行为与简单列表的loop关键字相同，例如字符串列表或散列/字典列表。但与loop不同的是，如果为with_items提供了列表的列表，它们将被扁平化为单级列表。循环变量item保存每次迭代过程中使用的列表项。
with_file	此关键字需要控制节点文件名列表。循环变量item在每次迭代过程中保存文件列表中相应文件的内容。
with_sequence	此关键字不需要列表，而是需要参数来根据数字序列生成值列表。 循环变量item在每次迭代过程中保存生成的序列中的一个生成项的值。

playbook中的with_items的示例如下所示：

---
- hosts: 192.168.200.154
  gather_facts: no
  vars_files:
    - vars/users.yml
  tasks:
    - name: create user
      user:
        name: '{{ item.name }}'
        uid: '{{ item.uid }}'
        state: present
      with_items: "{{ users }}"

从Ansible2.5开始，建议使用loop关键字编写循环。

2.1.4 将Register变量与Loop一起使用

register关键字也可以捕获循环任务的输出。以下代码片段显示了循环任务中register变量的结构：

---
- hosts: 192.168.200.154
  gather_facts: no
  tasks:
    - name: test
      command: 'echo hello {{ item }},how are you.'
      loop:
        - tom
        - Bob
        - alice
      register: result         //注册echo_item变量

    - debug:
        var: result            //echo_item变量的内容显示在屏幕上

ok: [192.168.200.154] => {
    "result": {
        "changed": true,
        "msg": "All items completed",
        "results": [
            {
                "ansible_facts": {
                    "discovered_interpreter_python": "/usr/libexec/platform-python"
                },
                "ansible_loop_var": "item",
                "changed": true,
                "cmd": [
                    "echo",
                    "hello",
                    "tom,how",
                    "are",
                    "you."

2.2 有条件地运行任务

Ansible可使用conditionals在符合特定条件时执行任务或play。例如，可以利用一个条件在Ansible安装或配置服务前确定受管主机上的可用内存。

我们可以利用条件来区分不同的受管主机，并根据它们所符合的条件来分配功能角色。Playbook变量、注册的变量和Ansible事实都可通过条件来进行测试。可以使用比较字符串、数字数据和布尔值的运算符。

以下场景说明了在Ansible中使用条件的情况：

可以在变量中定义硬限制（如min_memory）并将它与受管主机上的可用内存进行比较。
Ansible可以捕获并评估命令的输出，以确定某一任务在执行进一步操作前是否已经完成。例如，如果某一程序失败，则将路过批处理。
可以利用Ansible事实来确定受管主机网络配置，并决定要发送的模板文件（如，网络绑定或中继）。
可以评估CPU的数量，来确定如何正确调节某一Web服务器。
将注册的变量与预定义的变量进行比较，以确定服务是否已更改。例如，测试服务配置文件的MD5检验以和查看服务是否已更改。

2.2.1 条件任务语法

when语句用于有条件地运行任务。它取要测试的条件为值。如果条件满足，则运行任务。如果条件不满足，则跳过任务。

可以测试的一个最简单条件是某一布尔变量是True还是False。以下示例中的when语句导致任务仅在run_my_task为True时运行：

---
- name: Simple Boolean Task Demo
  hosts: 172.16.200.154
  vars:
    run_my_task: True
    
  tasks:
    - name: httpd package is installed
      yum:
        name: httpd
      when: run_my_task

以下示例测试my_service变量是否具有值。若有值，则将my_service的值用作要安装的软件包的名称。如果未定义my_service变量，则跳过任务且不显示错误。

---
- name: Test Variable is Defined Demo
  hosts: 172.16.200.154
  vars:
    my_service: httpd
    
  tasks:
    - name: "{{ my_service }} package is installed"
      yum:
        name: "{{ my_service }}"
      when: my_service is defined

下表显示了在处理条件时可使用的一些运算：
示例条件

操作	示例
等于（值为字符串）	ansible_machine == “x86_64”
等于（值为数字）	max_memory == 512
小于	min_memory < 128
大于	min_memory > 256
小于等于	min_memory <= 256
大于等于	min_memory >= 512
不等于	min_memory != 512
变量存在	min_memory is defined
变量不存在	min_memory is not defined
布尔变量是True。1、True或yes的求值为True	memory_available
布尔变量是False。0、False或no的求值为False	not memory_available
第一个变量的值存在，作为第二个变量的列表中的值	ansible_distribution in supported_distros

上表中的最后一个条目初看起来有些令人困惑。下例演示了它的工作原理。

在示例中，ansible_distribution变量是在Gathering Facts任务期间确定的事实，用于标识托管主机的操作系统分支。变量supported_distros由playbook创建，包含该playbook支持的操作系统分发列表。如果ansible_distribution的值在supported_distros列表中，则条件通过且任务运行。

---
- name: Demonstrale the "in" keyword
  hosts: 172.16.200.154
  gather_facts: yes
  vars:
    supported_distros:
      - RedHat
      - Fedora
  tasks:
    - name: Install httpd using yum, where supported
      yum:
        name: httpd
        state: present
      when: ansible_distribution in supported_distros

注意when语句的缩进。由于when语句不是模块变量，它必须通过缩进到任务的最高级别，放置在模块的外面。

任务是YAML散列/字典，when语句只是任务中的又一个键，就如任务的名称以及它所使用的模块一样。通常的惯例是将可能存在的任何when关键字放在任务名称和模块（及模块参数）的后面。

2.2.2 测试多个条件

一个when语句可用于评估多个条件。使用and和or关键字组合条件，并使用括号分组条件。

如果任一条件为真时满足条件语句，则应当使用or语句。例如，如果计算机上运行的是红帽企业linux或Fedora，则下述条件得到满足：

when: ansible_distribution == "Redhat" or ansible_distribution == "Fedora"

使用and运算时，两个条件都必须为真，才能满足整个条件语句。例如，如果远程主机是红帽企业Linux7.5主机，并且安装的内核是指定版本，则将满足以下条件：

when: ansible_distribution_version == "7.5" and ansible_kernel == "3.10.0-327.el7.x86_64"

when关键字还支持使用列表来描述条件列表。向when关键字提供列表时，将使用and运算组合所有条件。下面的示例演示了使用and运算符组合多个条件语句的另一方式：

when:
  - ansible_distribution_version == "7.5"
  - ansible_kernel == "3.10.0-327.el7.x86_64"

这种格式提高了可读性，而可读性是良好编写Ansible Playbook的关键目标。

通过使用括号分组条件，可以表达更复杂的条件语句。例如，如果计算机上运行的是红帽企业Linux7或Fedora28，则下述条件语句得到满足。此示例使用大于字符，这样长条件就可以在playbook中分成多行，以便于阅读。

when: >
  ( ansible_distribution == "Redhat" and
    ansible_distribution_major_version == "7" )
  or
  ( ansible_distribution == "Fedora" and
    ansible_distribution_major_version == "28" )

2.3 组合循环和有条件任务

循环和条件可以组合使用。

在下例中，yum模块将安装mariadb-server软件包，只要/上挂载的文件系统具有超过300MB的可用空间。ansible_mounts事实是一组字典，各自代表一个已挂载文件系统的相关事实。循环迭代列表中每一字典，只有找到了代表两个条件都为真的已挂载文件系统的字典时，条件语句才得到满足。

- name: install mariadb-server if enough space on root
  yum:
    name: mariadb-server
    state: latest
  loop: "{{ ansible_mounts }}"
  when: item.mount == "/" and item.size_available > 300000000

对某个任务结合使用when和loop时，将对每个项检查when语句。

下面是组合使用条件和注册变量的另一个示例。

---
- name: Restart HTTPD if Postfix is Running
  hosts: 192.168.200.154
  tasks:
    - name: Get Postfix server status
      command: /usr/bin/systemctl is-active postfix     # Postfix是否在运行？
      ignore_errors: yes    # 如果它不在运行并且命令失败，则不停止处理。
      register: result      # 将模块的结果信息保存在名为result的变量中
      
    - name: Restart Apache HTTPD based on Postfix status
      service:
        name: httpd
        state: restarted
      when: result.rc == 0      # 评估Postfix任务的输出。如果systemctl命令的退出代码为0，\
                                # 则Postfix激活并且此任务重启httpd服务