community.docker.docker_image_export 模块 – 导出（归档）Docker 镜像

注意

此模块是 community.docker 集合（版本 4.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.docker。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：community.docker.docker_image_export。

community.docker 3.7.0 中的新增功能

概要

要求

执行此模块的主机需要以下要求。

  • Docker API >= 1.25

  • backports.ssl_match_hostname（在 Python 2 上使用 TLS 时）

  • paramiko（当使用 SSH 和 use_ssh_client=false 时）

  • pyOpenSSL（当使用 TLS 时）

  • pywin32（当在 Windows 32 上使用命名管道时）

  • requests

参数

参数

注释

api_version

别名：docker_api_version

字符串

在 Docker 主机上运行的 Docker API 的版本。

默认为此集合和 docker 守护程序支持的最新版本的 API。

如果在任务中未指定该值，则将使用环境变量 DOCKER_API_VERSION 的值。 如果未设置环境变量，则将使用默认值。

默认值： "auto"

ca_path

别名：ca_cert, tls_ca_cert, cacert_path

路径

通过提供 CA 证书文件的路径，在执行服务器验证时使用 CA 证书。

如果在任务中未指定该值，并且设置了环境变量 DOCKER_CERT_PATH，则将使用环境变量 DOCKER_CERT_PATH 中指定的目录中的文件 ca.pem。

此选项被称为 ca_cert，并在 community.docker 3.6.0 中重命名为 ca_path。 旧名称已添加为别名，仍可使用。

client_cert

别名：tls_client_cert, cert_path

路径

客户端 TLS 证书文件的路径。

如果在任务中未指定该值，并且设置了环境变量 DOCKER_CERT_PATH，则将使用环境变量 DOCKER_CERT_PATH 中指定的目录中的文件 cert.pem。

client_key

别名：tls_client_key, key_path

路径

客户端 TLS 密钥文件的路径。

如果在任务中未指定该值，并且设置了环境变量 DOCKER_CERT_PATH，则将使用环境变量 DOCKER_CERT_PATH 中指定的目录中的文件 key.pem。

调试

布尔值

调试模式

选项

  • false ← (默认)

  • true

docker_host

别名: docker_url

字符串

用于连接 Docker API 的 URL 或 Unix 套接字路径。要连接到远程主机，请提供 TCP 连接字符串。例如，tcp://192.0.2.23:2376。如果使用 TLS 加密连接，模块会自动将连接 URL 中的 tcp 替换为 https。

如果任务中未指定该值，则将使用环境变量 DOCKER_HOST 的值。如果未设置环境变量，则将使用默认值。

默认值: "unix:///var/run/docker.sock"

force

布尔值

即使 .tar 文件已存在且似乎包含正确的镜像，也强制导出镜像。

选项

  • false ← (默认)

  • true

names

别名: name

list / elements=string / 必需

一个或多个镜像名称。名称格式为以下之一：name，repository/name，registry_server:port/name。在推送或拉取镜像时，名称可以选择性地包含标签，通过追加 :tag_name。

请注意，也可以使用镜像 ID（哈希值）。

路径

路径

镜像应该导出到的 .tar 文件。

tag

字符串

要标记的镜像名称 name 的标签。

如果 name 的格式为 name:tag，则 name 中的标签值将优先。

默认值: "latest"

timeout

整数

等待 API 响应的最长时间（以秒为单位）。

如果任务中未指定该值，则将使用环境变量 DOCKER_TIMEOUT 的值。如果未设置环境变量，则将使用默认值。

默认值: 60

tls

布尔值

通过使用 TLS 来保护与 API 的连接，而不验证 Docker 主机服务器的真实性。请注意，如果同时将 validate_certs 设置为 true，它将优先。

如果任务中未指定该值，则将使用环境变量 DOCKER_TLS 的值。如果未设置环境变量，则将使用默认值。

选项

  • false ← (默认)

  • true

tls_hostname

字符串

在验证 Docker 主机服务器的真实性时，请提供服务器的预期名称。

如果任务中未指定该值，则将使用环境变量 DOCKER_TLS_HOSTNAME 的值。如果未设置环境变量，则将使用默认值。

请注意，此选项在旧版本中具有默认值 localhost。它已在 community.docker 3.0.0 中删除。

use_ssh_client

布尔值

在 community.docker 1.5.0 中添加

对于 SSH 传输，请使用 ssh CLI 工具而不是 paramiko。

选项

  • false ← (默认)

  • true

validate_certs

别名: tls_verify

布尔值

通过使用 TLS 并验证 Docker 主机服务器的真实性来保护与 API 的连接。

如果任务中未指定该值，则将使用环境变量 DOCKER_TLS_VERIFY 的值。如果未设置环境变量，则将使用默认值。

选项

  • false ← (默认)

  • true

属性

属性

支持

描述

action_group

操作组: community.docker.docker, docker

在 module_defaults 中使用 group/docker 或 group/community.docker.docker 来为此模块设置默认值。

check_mode

支持: 完整

可以在 check_mode 中运行，并返回已更改的状态预测，而无需修改目标。

diff_mode

支持: 无

在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

说明

注意

另请参阅

另请参阅

community.docker.docker_image

管理 docker 镜像。

community.docker.docker_image_info

检查 docker 镜像。

community.docker.docker_image_load

从存档加载 docker 镜像。

示例

- name: Export an image
  community.docker.docker_image_export:
    name: pacur/centos-7
    path: /tmp/centos-7.tar

- name: Export multiple images
  community.docker.docker_image_export:
    names:
      - hello-world:latest
      - pacur/centos-7:latest
    path: /tmp/various.tar

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

images

list / elements=dictionary

受影响镜像的镜像检查结果。

返回: 成功

示例: []

作者

  • Felix Fontein (@felixfontein)