Ansible `unarchive` 模块

Ansible unarchive 模块

一、简介

• 功能：unarchive 模块用于解压缩文件，并将其内容提取到指定的目录。支持本地和远程压缩文件的解压，常用于自动化部署过程中解压软件包或配置文件。
• 使用场景：常用于解压缩软件包、配置文件或数据文件，并将其提取到目标主机的指定目录，以便后续使用或安装。

二、基本用法

2.1 语法

ansible <pattern> -m unarchive -a "src=<source_path> dest=<destination_path> [other options]"

• <pattern>：指定要操作的主机或主机组，例如 all、webservers。
• -m unarchive：指定使用 unarchive 模块。
• src=<source_path>：指定压缩文件的路径，可以是本地路径或 URL。
• dest=<destination_path>：指定要解压到的目标目录。

2.2 常见 copy 参数

• yes：将本地的 src 文件先复制到远程主机再解压。
• no：不复制文件，直接在远程主机上使用现有文件解压。

三、使用示例

3.1 解压本地文件到远程主机

ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html"

• 解释：将本地主机上的 file.tar.gz 文件解压到所有目标主机的 /var/www/html 目录下。unarchive 模块会先将文件复制到远程主机，然后进行解压。

3.2 解压远程主机上的文件

ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html copy=no"

• 解释：解压远程主机上的 file.tar.gz 文件到 /var/www/html 目录下。因为 copy=no，所以 src 必须是远程主机上的路径。

3.3 解压并覆盖目标目录中的文件

ansible all -m unarchive -a "src=/path/to/file.zip dest=/var/www/html extra_opts='--overwrite'"

• 解释：将 file.zip 文件解压到 /var/www/html 目录，并覆盖已存在的文件。

3.4 从 URL 解压文件到远程主机

ansible all -m unarchive -a "src=https://example.com/file.tar.gz dest=/var/www/html"

• 解释：从 URL https://example.com/file.tar.gz 下载文件并解压到所有目标主机的 /var/www/html 目录下。

四、其他常用选项

4.1 remote_src

• 功能：指定压缩文件是否在远程主机上。默认为 no，表示 src 是本地主机路径。如果文件在远程主机上，需设置为 yes。

• 用法：

  ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html remote_src=yes"
  

  • 解释：解压远程主机上的 file.tar.gz 文件到 /var/www/html 目录。

4.2 creates

• 功能：指定一个路径，如果该路径存在，则跳过解压操作。通常用于检查目标目录是否已包含解压后的文件。

• 用法：

  ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html creates=/var/www/html/index.html"
  

  • 解释：只有在 /var/www/html/index.html 不存在时才进行解压。

4.3 extra_opts

• 功能：为解压命令添加额外的选项。可以用于控制解压行为，如覆盖文件、显示解压进度等。

• 用法：

  ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html extra_opts='--strip-components=1'"
  

  • 解释：解压时去掉压缩包中的顶层目录（--strip-components=1）。

4.4 mode

• 功能：设置解压后文件或目录的权限（八进制格式，如 0755）。

• 用法：

  ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html mode=0755"
  

  • 解释：将解压后的文件和目录权限设置为 0755。

4.5 keep_newer

• 功能：解压时保持目标目录中较新的文件（即只覆盖比目标文件旧的文件）。

• 用法：

  ansible all -m unarchive -a "src=/path/to/file.tar.gz dest=/var/www/html keep_newer=yes"
  

  • 解释：仅覆盖比目标目录中现有文件旧的文件，保留较新的文件。

五、注意事项

• 文件路径：确保 src 路径的文件存在并可访问。对于本地路径，文件将被复制到远程主机；对于远程路径，remote_src 必须设置为 yes。
• 目标目录：确保 dest 目录存在且具有写权限。如果目录不存在，unarchive 模块会尝试创建该目录。
• 压缩格式支持：unarchive 模块支持常见的压缩格式，如 tar.gz、zip 等，但需要目标主机上安装相应的解压工具（如 tar、unzip）。