LabEx
登录免费加入

如何使用 Ansible get_url 模块从特定 URL 下载文件

AnsibleAnsibleBeginner
立即练习

💡 本教程由 AI 辅助翻译自英文原版。如需查看原文，您可以 切换至英文原版

简介

Ansible 是一个强大的开源自动化工具，它简化了 IT 基础设施的管理。在本教程中，我们将探讨 Ansible 的 get_url 模块，该模块允许你从特定的 URL 下载文件。这个模块对于自动化任务至关重要，例如软件安装、配置管理和内容部署。

在本教程中，你将学习如何设置 Ansible，使用 get_url 模块及其基本和高级选项，并实现实际的例子来自动化文件下载。通过本指南，你将对如何利用这个模块来简化你的文件管理流程有一个扎实的理解。

安装和设置 Ansible

在使用 get_url 模块之前，我们需要确保 Ansible 在我们的系统上正确安装和配置。

安装 Ansible

让我们首先在 LabEx 环境中安装 Ansible：

sudo apt update
sudo apt install -y ansible

运行这些命令后，通过检查 Ansible 的版本来验证它是否正确安装：

ansible --version

你应该看到类似这样的输出，显示 Ansible 的版本和配置细节：

ansible [core 2.12.x]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/labex/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  executable location = /usr/bin/ansible
  python version = 3.10.x (default, ...) [GCC 11.x]

创建工作目录

接下来，让我们为我们的 Ansible 项目创建一个专用目录：

mkdir -p ~/project/ansible-get-url
cd ~/project/ansible-get-url

设置一个简单的清单（Inventory）

Ansible 需要知道要管理哪些主机。对于本教程，我们将创建一个简单的清单文件，目标是本地机器：

echo "localhost ansible_connection=local" > inventory.ini

这个清单文件指定我们希望使用本地连接在 localhost 上运行 Ansible。

创建 Ansible 配置文件

为了自定义 Ansible 的行为，让我们创建一个简单的配置文件：

cat > ansible.cfg << EOF
[defaults]
inventory = inventory.ini
host_key_checking = False
EOF

这个配置文件告诉 Ansible 使用我们的清单文件并禁用主机密钥检查，这简化了测试环境中的连接。

测试 Ansible 设置

让我们通过运行一个简单的 ping 命令来验证我们的 Ansible 配置是否正常工作：

ansible localhost -m ping

你应该看到一个成功的响应，例如：

localhost | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python3"
    },
    "changed": false,
    "ping": "pong"
}

此输出确认 Ansible 已正确安装，并且可以与 localhost 通信。现在我们准备好在下一步中使用 get_url 模块了。

使用 get_url 模块创建基本 Playbook

现在我们已经设置好了 Ansible，让我们创建一个简单的 playbook，它使用 get_url 模块从 URL 下载文件。

理解 Ansible Playbook

一个 Ansible playbook 是一个 YAML 文件，它定义了一组要在受管主机上执行的任务。Playbook 被组织成一系列的 plays，其中每个 play 包含：

  • 一组要定位的主机
  • 一组要执行的任务

创建我们的第一个 Playbook

让我们创建一个使用 get_url 模块的基本 playbook。在你的项目目录中创建一个名为 download-file.yml 的文件：

cd ~/project/ansible-get-url

打开文件编辑器并使用以下内容创建文件：

---
- name: Download a file from URL
  hosts: localhost
  become: no
  tasks:
    - name: Create downloads directory
      file:
        path: ~/project/ansible-get-url/downloads
        state: directory
        mode: "0755"

    - name: Download a sample text file
      get_url:
        url: https://raw.githubusercontent.com/ansible/ansible/devel/README.md
        dest: ~/project/ansible-get-url/downloads/ansible-readme.md
        mode: "0644"

这个 playbook 执行以下操作：

  1. 创建一个 downloads 目录来存储我们下载的文件
  2. 使用 get_url 模块从 GitHub 下载 Ansible README.md 文件

理解 get_url 模块参数

让我们分解一下 get_url 任务中的关键参数：

  • url: 指定要从中下载文件的 URL
  • dest: 定义将保存文件的目标路径
  • mode: 设置文件权限（0644 表示所有者可读写，组和其他用户可读）

运行 Playbook

现在我们已经创建了我们的 playbook，让我们使用 ansible-playbook 命令运行它：

ansible-playbook download-file.yml

你应该看到类似这样的输出：

PLAY [Download a file from URL] ***********************************************

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

TASK [Create downloads directory] *********************************************
changed: [localhost]

TASK [Download a sample text file] ********************************************
changed: [localhost]

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

验证下载的文件

让我们验证文件是否已正确下载：

ls -l ~/project/ansible-get-url/downloads/

你应该看到下载的文件：

-rw-r--r-- 1 labex labex 3154 Mar 15 12:34 ansible-readme.md

你也可以查看下载文件的内容：

head -n 10 ~/project/ansible-get-url/downloads/ansible-readme.md

这将显示 Ansible README.md 文件的前 10 行，确认它已成功下载。

恭喜你！你已经成功创建并执行了你的第一个 Ansible playbook，它使用 get_url 模块从 URL 下载文件。

使用高级 get_url 选项

现在我们已经介绍了基础知识，让我们探索 get_url 模块的一些高级选项，这些选项在实际场景中可能很有用。

创建高级 Playbook

让我们创建一个名为 advanced-download.yml 的新 playbook，它演示了各种高级选项：

cd ~/project/ansible-get-url

打开文件编辑器并使用以下内容创建文件：

---
- name: Advanced get_url Module Options
  hosts: localhost
  become: no
  tasks:
    - name: Create advanced downloads directory
      file:
        path: ~/project/ansible-get-url/advanced-downloads
        state: directory
        mode: "0755"

    - name: Download with checksum validation
      get_url:
        url: https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64
        dest: ~/project/ansible-get-url/advanced-downloads/jq
        mode: "0755"
        checksum: sha256:af986793a515d500ab2d35f8d2aecd656e764504b789b66d7e1a0b727a124c44

    - name: Download with timeout and retries
      get_url:
        url: https://raw.githubusercontent.com/ansible/ansible-examples/master/README.md
        dest: ~/project/ansible-get-url/advanced-downloads/examples-readme.md
        timeout: 30
        retries: 3
        delay: 5
        force: yes

    - name: Download only if file doesn't exist
      get_url:
        url: https://raw.githubusercontent.com/ansible/ansible/devel/examples/ansible.cfg
        dest: ~/project/ansible-get-url/advanced-downloads/ansible-example.cfg
        force: no

理解高级参数

让我们检查一下此 playbook 中使用的高级参数：

  1. 校验和验证（Checksum Validation）：

    • checksum: 指定下载文件的预期校验和（格式：算法：校验和）
    • 这确保了下载文件的完整性，并防止在文件已经存在且校验和正确的情况下进行下载

  2. 超时和重试（Timeout and Retries）：

    • timeout: HTTP 请求完成的最长时间（以秒为单位）
    • retries: 如果下载失败，重试的次数
    • delay: 两次重试之间的延迟时间（以秒为单位）
    • force: 是否下载文件，即使它已经存在

  3. 条件下载（Conditional Download）：

    • force: no: 仅当目标位置不存在该文件时才会下载该文件

运行高级 Playbook

让我们执行我们的高级 playbook：

ansible-playbook advanced-download.yml

你应该看到类似这样的输出：

PLAY [Advanced get_url Module Options] ****************************************

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

TASK [Create advanced downloads directory] ************************************
changed: [localhost]

TASK [Download with checksum validation] **************************************
changed: [localhost]

TASK [Download with timeout and retries] **************************************
changed: [localhost]

TASK [Download only if file doesn't exist] ************************************
changed: [localhost]

PLAY RECAP ********************************************************************
localhost                  : ok=5    changed=4    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

验证高级下载

让我们检查一下我们使用高级选项下载的文件：

ls -l ~/project/ansible-get-url/advanced-downloads/

你应该看到所有下载的文件：

-rwxr-xr-x 1 labex labex 3773448 Mar 15 12:45 jq
-rw-r--r-- 1 labex labex     426 Mar 15 12:45 examples-readme.md
-rw-r--r-- 1 labex labex    1690 Mar 15 12:45 ansible-example.cfg

让我们测试一下下载的 jq 二进制文件是否有效：

~/project/ansible-get-url/advanced-downloads/jq --version

你应该看到指示 jq 版本的输出（例如，jq-1.6），确认可执行文件已使用正确的校验和正确下载。

你现在已经成功地使用了 get_url 模块的各种高级选项，以下载具有不同需求和约束的文件。

实现一个实用的 Web 应用程序部署

让我们在一个更实际的场景中应用我们所学到的知识：使用 Ansible 的 get_url 模块部署一个简单的 Web 应用程序。

设置 Web 应用程序项目

首先，让我们为我们的 Web 应用程序创建一个目录结构：

mkdir -p ~/project/ansible-get-url/webapp/public
cd ~/project/ansible-get-url

创建 Web 应用程序部署 Playbook

现在，我们将创建一个名为 deploy-webapp.yml 的 playbook，它将下载我们 Web 应用程序所需的文件：

---
- name: Deploy Web Application Files
  hosts: localhost
  become: no
  vars:
    webapp_dir: ~/project/ansible-get-url/webapp
    assets_base_url: https://raw.githubusercontent.com/ansible/ansible-documentation/devel/docs/docsite/rst/_static
  tasks:
    - name: Ensure webapp directories exist
      file:
        path: "{{ item }}"
        state: directory
        mode: "0755"
      loop:
        - "{{ webapp_dir }}"
        - "{{ webapp_dir }}/public"
        - "{{ webapp_dir }}/public/css"
        - "{{ webapp_dir }}/public/images"

    - name: Create index.html
      copy:
        dest: "{{ webapp_dir }}/public/index.html"
        content: |
          <!DOCTYPE html>
          <html>
          <head>
            <title>Ansible Demo App</title>
            <link rel="stylesheet" href="css/style.css">
          </head>
          <body>
            <div class="container">
              <h1>Welcome to Ansible Demo</h1>
              <p>This site was deployed using Ansible's get_url module!</p>
              <img src="images/ansible-logo.png" alt="Ansible Logo">
            </div>
          </body>
          </html>

    - name: Download CSS file
      get_url:
        url: "{{ assets_base_url }}/css/ansible.css"
        dest: "{{ webapp_dir }}/public/css/style.css"
        mode: "0644"
        timeout: 30
        retries: 3

    - name: Download Ansible logo
      get_url:
        url: "{{ assets_base_url }}/images/ansible_logo.svg"
        dest: "{{ webapp_dir }}/public/images/ansible-logo.png"
        mode: "0644"
        timeout: 30
        retries: 3

    - name: Install Python HTTP server
      apt:
        name: python3-http.server
        state: present
      become: yes

    - name: Display information about running the web server
      debug:
        msg: |
          Web application has been deployed!
          To start the web server, run:
          cd {{ webapp_dir }}/public && python3 -m http.server 8080
          Then access it at: http://localhost:8080

这个 playbook：

  1. 为我们的 Web 应用程序创建必要的目录结构
  2. 创建一个包含基本 HTML 内容的 index.html 文件
  3. 使用 get_url 模块下载一个 CSS 文件和一个 Ansible 徽标图像
  4. 安装一个 Python HTTP 服务器
  5. 显示有关如何运行 Web 服务器的信息

运行 Web 应用程序部署 Playbook

让我们执行 playbook：

ansible-playbook deploy-webapp.yml

你应该看到输出，表明 Web 应用程序已成功部署。

启动 Web 服务器

现在，让我们启动 Web 服务器来测试我们部署的应用程序：

cd ~/project/ansible-get-url/webapp/public
python3 -m http.server 8080 &

Web 服务器现在正在后台的 8080 端口上运行。如果你在一个具有浏览器访问权限的常规环境中，你可以在 http://localhost:8080 访问 Web 应用程序。

检查已部署的文件

让我们验证所有必需的文件是否已正确部署：

ls -la ~/project/ansible-get-url/webapp/public/

你应该看到 index.html 文件和我们创建的目录。

ls -la ~/project/ansible-get-url/webapp/public/css/

这应该显示下载的 CSS 文件。

ls -la ~/project/ansible-get-url/webapp/public/images/

这应该显示下载的 Ansible 徽标图像。

查看 HTML 内容

让我们检查 index.html 文件的内容：

cat ~/project/ansible-get-url/webapp/public/index.html

你应该看到我们在 playbook 中创建的 HTML 内容。

停止 Web 服务器

当你完成测试后，你可以通过找到其进程 ID 并将其杀死来停止 Web 服务器：

pkill -f "python3 -m http.server 8080"

恭喜你！你已经成功地使用 Ansible 的 get_url 模块部署了一个简单的 Web 应用程序，以下载必要的文件。

总结

在本教程中，你获得了使用 Ansible 的 get_url 模块从特定 URL 下载文件的实践经验。你学到了：

  • 如何安装和配置 Ansible 用于本地开发
  • 如何使用 get_url 模块创建基本的 playbooks 来下载文件
  • 如何利用高级选项，例如校验和验证、超时、重试和条件下载
  • 如何使用 get_url 模块实现一个实用的 Web 应用程序部署场景

这些技能对于自动化各种 IT 运营中的文件管理任务至关重要，包括软件部署、内容管理和系统配置。get_url 模块是一个多功能工具，可以集成到更复杂的 Ansible 工作流程中，以简化你的基础设施管理流程。

在你继续 Ansible 之旅时，请考虑探索相关的模块，例如 uri、unarchive 和 synchronize，它们补充了 get_url 模块，以实现更全面的文件管理自动化。

相关 Ansible 课程
Ansible 快速入门

Ansible 快速入门

Ansible
初级