在自动化运维领域，Ansible以其简洁、高效的特点赢得了广泛的认可。它能够通过SSH协议与远程主机通信，执行各种运维任务，而无需在远程主机上安装任何额外的软件。在实际应用中，我们经常需要等待某个脚本在远程主机上执行完成，并获取其返回结果。本文将深入探讨如何使用Ansible实现这一目标，并提供一些实用的策略和最佳实践。

一、理解Ansible的工作原理

在开始之前，我们需要了解Ansible的基本工作原理。Ansible通过模块化设计，将各种运维任务封装成模块，用户可以通过编写Playbook或使用Ad-hoc命令来调用这些模块。每个模块执行完毕后，会返回一个JSON格式的结果，Ansible通过这些结果来判断任务是否成功。

二、等待脚本执行完成

在Ansible中，等待脚本执行完成通常涉及到以下几个步骤：

    使用command或shell模块执行脚本：

    • command模块用于执行简单的命令。
    • shell模块则支持更复杂的命令，包括管道、重定向等。

    使用async和poll参数：

    • async参数用于指定任务的超时时间。
    • poll参数用于指定Ansible检查任务状态的频率。

例如，假设我们有一个耗时的脚本long_running_script.sh，我们可以这样编写Playbook：

- name: Execute long running script
  hosts: all
  tasks:
    - name: Run the script asynchronously
      shell: /path/to/long_running_script.sh
      async: 3600
      poll: 10

在这个例子中，async: 3600表示任务的超时时间为3600秒，poll: 10表示Ansible每10秒检查一次任务状态。

三、获取脚本的返回结果

脚本执行完成后，我们通常需要获取其返回结果。这可以通过以下几种方式实现：

  1. 使用register变量：
    • register关键字可以将任务的输出结果存储在一个变量中，供后续任务使用。
- name: Execute script and capture output
  hosts: all
  tasks:
    - name: Run the script
      shell: /path/to/script.sh
      register: script_result

    - name: Print the script output
      debug:
        msg: "{{ script_result.stdout }}"

在这个例子中，script_result.stdout存储了脚本的输出结果。

  1. 使用fetch模块：
    • 如果脚本将结果写入文件，可以使用fetch模块将文件从远程主机复制到本地。
- name: Fetch script output file
  hosts: all
  tasks:
    - name: Run the script
      shell: /path/to/script.sh > /tmp/output.txt

    - name: Fetch the output file
      fetch:
        src: /tmp/output.txt
        dest: /local/path/

四、最佳实践

为了确保Ansible任务的稳定性和可维护性，以下是一些最佳实践：

  1. 使用changed_when和failed_when自定义任务状态：
    • 有时候，脚本的输出并不直接反映任务的成功或失败。我们可以使用changed_when和failed_when来自定义任务的状态。
- name: Run the script and custom status
  hosts: all
  tasks:
    - name: Run the script
      shell: /path/to/script.sh
      register: script_result
      changed_when: "'SUCCESS' in script_result.stdout"
      failed_when: "'ERROR' in script_result.stdout"
  1. 处理异步任务的超时和错误：
    • 当使用async和poll时，应考虑任务超时的情况，并适当处理错误。
- name: Execute long running script with timeout handling
  hosts: all
  tasks:
    - name: Run the script asynchronously
      shell: /path/to/long_running_script.sh
      async: 3600
      poll: 10
      register: async_result
      ignore_errors: yes

    - name: Check if the task completed successfully
      fail:
        msg: "The script did not complete successfully."
      when: async_result.rc != 0
  1. 使用block和rescue处理异常：
    • 使用block和rescue可以更好地处理任务中的异常情况。
- name: Execute script with exception handling
  hosts: all
  tasks:
    - block:
        - name: Run the script
          shell: /path/to/script.sh
          register: script_result
      rescue:
        - name: Handle script failure
          debug:
            msg: "The script failed to execute."

五、总结

使用Ansible等待脚本执行并获取返回结果是一个常见的运维需求。通过合理使用async、poll、register、fetch等参数和模块，我们可以有效地实现这一目标。同时，遵循最佳实践，如自定义任务状态、处理超时和错误、使用异常处理机制，可以显著提高Ansible任务的稳定性和可维护性。