实施任务控制

1、有条件地运行任务

1.2、测试多个条件

when语句可以用于评估多个条件，但需使用and、or关键字进行组合使用
实例：
如果计算机上运行的是redhat或centos，则下述条件得到满足

[root@localhost yyy]# cat test1.yml
---
- name: yyyy
  hosts: 192.168.197.135
  gather_facts: yes
  vars:
    supported_distros:
      - RedHat
      - centos
  tasks:
    - name: install httpd
      yum:
        name: httpd
        state: present
      when: ansible_distribution == "Redhat" or ansible_distribution == "Fedora"

[root@localhost yyy]# ansible-playbook test1.yml
 
PLAY [yyyy] ************************************
********************************

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

TASK [install httpd] ***************************
********************************
skipping: [192.168.197.135]

PLAY RECAP *************************************
********************************
192.168.197.135            : ok=1    changed=0  
  unreachable=0    failed=0    skipped=1    resc
ued=0    ignored=0   

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

[root@localhost yyy]# cat test1.yml 
---
- name: yyyy
  hosts: 192.168.197.135
  gather_facts: yes
  vars:
    supported_distros:
      - RedHat
      - centos
  tasks:
    - name: install httpd
      yum:
        name: httpd
        state: present
      when: ansible_distribution_version == "7.5" and ansible_kernel == "3.10.0-327.el7.x86_64"

[root@localhost yyy]# ansible-playbook test1.yml

PLAY [yyyy] ***************************************************************************************************************************

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

TASK [install httpd] ******************************************************************************************************************
skipping: [192.168.197.135]

PLAY RECAP ****************************************************************************************************************************
192.168.197.135            : ok=1    changed=0    unreachable=0    failed=0    skipped=1    rescued=0    ignored=0   

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

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

2、组合循环和有条件任务

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

[root@localhost yyy]# cat test1.yml 
---
- hosts: 192.168.197.135
  gather_facts: yes
  tasks:
    - 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语句。

3、实施处理程序

Ansible模块设计为具有幂等性。这表示，在正确编写的playbook中，playbook及其任务可以运行多次而不会改变受管主机，除非需要进行更改使受管主机进入所需的状态。

但在时候，在任务确实更改系统时，可能需要运行进一步的任务。例如，更改服务配置文件时可能要求重新加载该服务以便使其更改的配置生效。

处理程序是响应由其他任务触发的通知的任务。仅当任务在受管主机上更改了某些内容时，任务才通知其处理程序。每个处理程序具有全局唯一的名称，在playbook中任务块的末尾触发。如果没有任务通过名称通知处理程序，处理程序就不会运行。如果一个或多个任务通知处理程序，处理程序就会在play中的所有其他任务完成后运行一次。因为处理程序就是任务，所以可以在处理程序中使用他们将用于任何其他任务的模块。通常而言，处理程序被用于重新引导主机和重启服务。

处理程序可视为非活动任务，只有在使用notify语句显式调用时才会被触发。在下列代码片段中，只有配置文件更新并且通知了该任务，restart apache处理程序才会重启Apache服务器：
事例：
受管主机有httpd服务，然后我们修改它
先找到收管主机的文件地址

[root@localhost ~]# find / -name *vhosts.conf
find: ‘/proc/783283’: 没有那个文件或目录
find: ‘/proc/783302’: 没有那个文件或目录
/usr/share/doc/httpd/httpd-vhosts.conf
/usr/local/httpd/conf/extra/httpd-vhosts.conf
/usr/local/httpd/conf/original/extra/httpd-vhosts.conf
/opt/httpd-2.4.46/docs/conf/extra/httpd-vhosts.conf

将受管主机上的文件复制到当前目录

[root@localhost yyy]# scp 192.168.197.135:/usr/share/doc/httpd/httpd-vhosts.conf
usage: scp [-346BCpqrTv] [-c cipher] [-F ssh_config] [-i identity_file]
            [-J destination] [-l limit] [-o ssh_option] [-P port]
            [-S program] source ... target
[root@localhost yyy]# ls
httpd-vhosts.conf  test1.yml

编写playbook

[root@localhost html]# echo "xin text" > /var/www/html/shen/index.php

[root@localhost ansible]# cat httpd.yml 
---
- hosts: 192.168.100.147
  tasks: 
    - name: install apache
      yum: 
        name: httpd
        state: present
    - name: config httpd
      copy: 
        src: node/httpd-vhosts.conf
        dest: /etc/httpd/conf.d/xin.conf
    - name: service httpd
      service: 
        name: httpd
        state: started
        enabled: yes
[root@localhost ansible]# ansible-playbook httpd.yml
 
PLAY [192.168.197.135] *********************************************************

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

TASK [install apache] **********************************************************
ok: [192.168.197.135]

TASK [config httpd] ************************************************************
changed: [192.168.197.135]

TASK [service httpd] ***********************************************************
changed: [192.168.197.135]

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

3.2 使用处理程序的好处

使用处理程序时需要牢记几个重要事项：

处理程序始终按照play的handlers部分指定的顺序运行。它们不按在任务中由notify语句列出的顺序运行，或按任务通知它们的顺序运行。
处理程序通常在相关play中的所有其他任务完成后运行。playbook的tasks部分中某一任务调用的处理程序，将等到tasks下的所有任务都已处理后才会运行。
处理程序名称存在于各play命名空间中。如果两个处理程序被错误地给予相同的名称，则仅会运行一个。
即使有多个任务通知处理程序，该处理程序依然仅运行一次。如果没有任务通知处理程序，它就不会运行。
如果包含notify语句的任务没有报告changed结果（例如，软件包已安装并且任务报告ok），则处理程序不会获得通知。处理程序将被跳过，直到有其他任务通知它。只有相关任务报告了changed状态，Ansible才会通知处理程序。
处理程序用于在任务对受管主机进行更改时执行额外操作。它们不应用作正常任务的替代。

4.处理任务失败

4.1 管理play中的任务错误

Ansible评估任务的返回代码，从而确定任务是成功还是失败。通常而言，当任务失败时，Ansible将立即在该主机上中止play的其余部分并且跳过所有后续任务。

但有些时候，可能希望即使在任务失败时也继续执行play。例如，或许预期待定任务有可能会失败，并且希望通过有条件地运行某项其他任务来修复。

Ansible有多种功能可用于管理任务错误。

4.2忽略任务失败

默认情况下，任务失败时play会中止。不过，可以通过忽略失败的任务来覆盖此行为。可以在任务中使用ignore_errors关键字来实现此目的。

下列代码片段演示了如何在任务中使用ignore_errors，以便在任务失败时也继续在主机上执行playbook。例如，如果notapkg软件包不存在，则yum模块将失败，但若将ignore_errors设为yes，则执行将继续。

---
- hosts: 192.168.197.135
  tasks:
    - name: install apache
      yum:
        name: sdasdasda
        state: present
      ignore_errors: yes
    - name: config httpd
      copy:
        src: /etc/ansible/yyy/httpd-vhosts.conf
        dest: /etc/httpd/conf.d/xin.conf
    - name: service httpd
      service:
        name: httpd
        state: started
        enabled: yes

[root@localhost yyy]# ansible-playbook test2.yml

PLAY [192.168.197.135] ***********************************************************************************************

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

TASK [install apache] ************************************************************************************************
fatal: [192.168.197.135]: FAILED! => {"changed": false, "failures": ["No package sdasdasda available."], "msg": "Failed to install some of the specified packages", "rc": 1, "results": []}
...ignoring

TASK [config httpd] **************************************************************************************************
changed: [192.168.197.135]

TASK [service httpd] *************************************************************************************************
ok: [192.168.197.135]

PLAY RECAP ***********************************************************************************************************
192.168.197.135            : ok=4    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=1   

4.3 任务失败后强制执行处理程序

通常而言，如果任务失败并且play在该主机上中止，则收到play中早前任务通知的处理程序将不会运行。如果在play中设置force_handlers: yes关键字，则即使play因为后续任务失败而中止也会调用被通知的处理程序。

下列代码片段演示了如何在play中使用force_handlers关键字，以便在任务失败时也强制执行相应的处理程序：

---
- hosts: 192.168.197.135
  force_handlers: yes
  tasks:
    - name: install apache
      yum:
        name: httpd
        state: present
      ignore_errors: yes
    - name: config httpd
      copy:
        src: /etc/ansible/yyy/httpd-vhosts.conf
        dest: /etc/httpd/conf.d/xin.conf
      notify: yyyy

  handlers:
    - name: yyyy
      service:
        name: httpd
        state: started
        enabled: yes
~                      

请记住，处理程序会在任务报告changed结果时获得通知，而在任务报告ok或failed结果时不会获得通知。

4.4 指定任务失败条件

可以在任务中使用failed_when关键字来指定表示任务已失败的条件。这通常与命令模块搭配使用，这些模块可能成功执行了某一命令，但命令的输出可能指示了失败。

例如，可以运行输出错误消息的脚本，并使用该消息定义任务的失败状态。下列代码片段演示了如何在任务中使用failed_when关键字：

tasks:
  - name: Run user creation script
    shell: /usr/local/bin/create_users.sh
    register: command_result
    failed_when: "'Password missing' in command_result.stdout"

fail模块也可用于强制任务失败。上面的场景也可以编写为两个任务：

tasks:
  - name: Run user creation script
    shell: /usr/local/bin/create_users.sh
    register: command_result
    ignore_errors: yes
    
  - name: Report script failure
    fail:
      msg: "The password is missing in the output"
    when: "'Password missing' in command_result.stdout"

我们可以使用fail模块为任务提供明确的失败消息。此方法还支持延迟失败，允许在运行中间任务以完成或回滚其他更改。

4.5 指定何时任务报告 “Changed” 结果

当任务对托管主机进行了更改时，会报告 changed 状态并通知处理程序。如果任务不需要进行更改，则会报告ok并且不通知处理程序。

changed_when关键字可用于控制任务在何时报告它已进行了更改。例如，下一示例中的shell模块将用于获取供后续任务使用的Kerberos凭据。它通常会在运行时始终报告changed。为抵制这种更改，应设置changed_when: false，以便它仅报告ok或failed。

- name: get Kerberos credentials as "admin"
  shell: echo "{{ krb_admin_pass }}" | kinit -f admin
  changed_when: false

[root@localhost yyy]# cat test3.yml 
---
- hosts: 192.168.197.135
  tasks:
    - name: test
      shell: echo "runtime" | passwd --stdin yyy
      register: long
      notify: shuchu

  handlers:
    - name: shuchu
      debug:
        msg: "设置成功"

[root@localhost yyy]# ansible-playbook test3.yml

PLAY [192.168.197.135] ***********************************************************************************************

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

TASK [test] **********************************************************************************************************
changed: [192.168.197.135]

RUNNING HANDLER [shuchu] *********************************************************************************************
ok: [192.168.197.135] => {
    "msg": "设置成功"
}

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

4.6.ansible块和错误处理

在playbook中，块是对任务进行逻辑分组的子句，可用于控制任务的执行方式。例如，任务块可以含有when关键字，以将某一条件应用到多个任务：

- name: block example
  hosts: 192.168.197.135
  tasks:
    - name: installing and configuring Yum versionlock plugin
      block:
      - name: package needed by yum
        yum:
          name: yum-plugin-versionlock
          state: present
      - name: lock version of tadata
        lineinfile:
          dest: /etc/yum/pluginconf.d/versionlock.list
          line: tzdata-2020j-1
          state: present
      when: ansible_distribution == "Redhat"

通过块，也可结合rescue和always语句来处理错误。如果块中的任何任务失败，则执行其rescue块中的任务来进行恢复。在block子句中的任务以及rescue子句中的任务（如果出现故障）运行之后，always子句中的任务运行。总结：

block：定义要运行的主要任务

rescue：定义要在block子句中定义的任务失败时运行的任务

always：定义始终都独立运行的任务，不论block和rescue子句中定义的任务是成功还是失败

以下示例演示了如何在playbook中实施块。即使block子句中定义的任务失败，rescue和always子句中定义的任务也会执行。

tasks:
  - name: Upgrade DB
    block:    //如果我任务执行成功了 ，那么后面的任务就不执行，如果执行失败，就执行rescure里面的
      - name: upgrade the database
        shell:
          cmd: /usr/local/lib/upgrade-database
    rescue:
      - name: revert the database upgrade
        shell:
          cmd: /usr/local/lib/revert-database
    always:    //不管上面成功不成功。alway是一定会执行的
      - name: always restart the database
        service:
          name: mariadb
          state: restarted

block中的when条件也会应用到其rescue和always子句（若存在）。

5.修改文件并将其复制到主机

1.1 描述文件模块
Files模块库包含的模块允许用户完成与Linux文件管理相关的大多数任务，如创建、复制、编辑和修改文件的权限和其他属性。下表提供了常用文件管理模块的列表：

常用文件模块

模块名称	模块说明
blockinfile	插入、更新或删除由可自定义标记线包围的多行文本块
copy	将文件从本地或远程计算机复制到受管主机上的某个位置。类似于file模块，copy模块还可以设置文件属性，包括SELinux上下文件
fetch	此模块的作用和copy模块类似，但以相反方式工作。此模块用于从远程计算机获取文件到控制节点，并将它们存储在按主机名组织的文件树中。
file	设置权限、所有权、SELinux上下文以及常规文件、符号链接、硬链接和目录的时间戳等属性。此模块还可以创建或删除常规文件、符号链接、硬链接和目录。其他多个与文件相关的模块支持与file模块相同的属性设置选项，包括copy模块。
lineinfile	确保特定行位于某文件中，或使用反向引用正则表达来替换现有行。此模块主要在用户想要更改文件的某一行时使用。
stat	检索文件的状态信息，类似于Linux中的stat命令。
synchronize	围绕rsync命令的一个打包程序，可加快和简化常见任务。
synchronize	模块无法提供对rsync命令的完整功能的访问权限，但确实最常见的调用更容易实施。用户可能仍需通过run command模块直接调用rsync命令。

5.1 files模块的自动化示例

在受管主机上创建、复制、编辑和删除文件是用户可以使用Files模块库中的模块实施的常见任务。
以下示例显示了可以使用这些模块自动执行常见文件管理任务的方式。

5.2 确保受管主机上存在文件

使用file模块处理受管主机上的文件。其工作方式与touch命令类似，如果不存在则创建一个空文件，如果存在，则更新其修改时间。在本例中，除了处理文件之外，Ansible还确保将文件的所有者、组和权限设置为特定值。

- name: Touch a file and set permissions
  file:
    path: /path/to/file
    owner: user1
    group: group1
    mode: 0640
    state: touch

5.3 修改文件属性

使用file模块还可以确保新的或现有的文件具有正确的权限和SELinux类型。

例如，以下文件保留了相对于用户主目录的默认SELinux上下文，这不是所需的上下文。

[root@node1 ~]# ls -Z anaconda-ks.cfg    //我们查看受管主机root下的一个文件
system_u:object_r:admin_home_t:s0 anaconda-ks.cfg     //修改它的权限  
[root@node1 ~]# 


[root@node1 ~]# cat /etc/ansible/node/test.yml   //play写法
---
- name: create user
  hosts: 192.168.197.135
  tasks: 
    - name: test
      file: 
        path: /root/anaconda-ks.cfg
        setype: shen_niubi_shuaiqi_t    //改为我们想要的
[root@node1 ~]# 
[root@localhost ~]# ls -Z anaconda-ks.cfg    //修改成功
system_u:object_r:shen_niubi_shuaiqi_t:s0 anaconda-ks.cfg

5.4 使SELinux文件上下文更改具有持久性

设置文件上下文时，file模块的行为与chcon类似。通过运行restorecon，可能会意外地撤消使用该模块所做的更改。使用file设置上下文后，用户可以使用system模块集合中的sefcontext来更新SELinux策略，如semanage fcontext。

- name: Copy a file to managed hosts   //这是我们常用的做法
  copy:
    src: file
    dest: /path/to/file

注意：sefcontext模块更新SELinux策略中目标的默认上下文，但不更改现有文件的上下文。

要确保现有文件中存在特定的单行文本，请使用lineinfile模块：

- name: Add a line of text to a file   
  lineinfile:
    path: /path/to/file
    line: 'Add this line to the file'
    state: present

要将文本块添加到现有文件，请使用blockinfile模块：

[root@node1 ansible]# cat node/test.yml 
---
- name: create user
  hosts: 192.168.100.147
  tasks: 
    - name: test
      blockinfile: 
        path: /tmp/shen   //给受管主机tmp下面添加文本
        block: |
          shunzi chishi 
          hello shunzi
          helle shuaige
          hello SB
        state: present
        create: yes    //没有文件的，自动创建

注意：使用blockinfile模块时，注释块标记插入到块的开头和结尾，以确保幂等性

# BEGIN ANSIBLE MANAGED BLOCK
shunzi chishi 
hello shunzi
helle shuaige
hello SB
# END ANSIBLE MANAGED BLOCK

从守寡主机中删除文件

从受管主机中删除文件的基本示例是使用file模块和state: absent参数。state参数对于许多模块是可选的。一些模块也支持其他选项。

[root@node1 ansible]# cat node/test.yml    //删除上面创建的shen
---
- name: create user
  hosts: 192.168.197.135
  tasks: 
    - name: test
      file: 
        dest: /tmp/shen
        state: absent
[root@node1 ansible]# 


[root@node1 ansible]# ansible-playbook node/test.yml    //执行成功

PLAY [create user] *************************************************************

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

TASK [test] ********************************************************************
changed: [192.168.197.135]

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

[root@localhost tmp]# ls    //查看此时已经没有，已经被删除
systemd-private-2126c22bfcc7458eac8d84abfdcb844c-chronyd.service-Vd9cpx
systemd-private-2126c22bfcc7458eac8d84abfdcb844c-httpd.service-xjP1M8
[root@localhost tmp]

同步控制节点和受管主机之间的文件

synchronize模块是一个围绕rsync工具的打包程序，它简化了playbook中的常见文件管理任务。rsync工具必须同时安装在本机和远程主机上。默认情况下，在使用synchronize模块时，“本地主机”是同步任务所源自的主机（通常是控制节点），而“目标主机”是synchronize连接到的主机。

以下示例将位于Ansible工作目录中的文件同步到受管主机

[root@node1 node]# ls    //我想把控制机中这个httpd同步到受管主机中
httpd  test.yml
[root@node1 node]# 


[root@node1 ansible]# cat node/test.yml 
---
- name: create user
  hosts: 192.168.197.135
  tasks: 
    - name: test
      yum:
        name: rsync     //必须下载rsync
        state: present
    - name: 
      synchronize:   //用这个模块
        src: httpd     //原地址下的httpd
        dest: /opt/httpd    //同步到受管主机opt下面
[root@node1 ansible]# 

[root@node1 ansible]# ansible-playbook node/test.yml    //执行成功

PLAY [create user] *************************************************************

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

TASK [test] ********************************************************************
changed: [192.168.197.135]

TASK [synchronize] *************************************************************
changed: [192.168.197.135]

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

[root@localhost opt]# ls   //这边可以看到已经同步过来了
httpd  shen.sh
[root@localhost opt]#