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 镜像创建归档文件（tarball）。
这可以复制到另一台机器上，并使用 community.docker.docker_image_load 加载。

要求 

以下要求需要在执行此模块的主机上满足。

Docker API >= 1.25
backports.ssl_match_hostname（在 Python 2 上使用 TLS 时）
paramiko（当使用 SSH 和 use_ssh_client=false 时）
pyOpenSSL（当使用 TLS 时）
pywin32（当在 Windows 32 上使用命名管道时）
请求

参数 

参数	注释
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`。
debug 布尔值	调试模式选项 `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 列表 / 元素=字符串 / 必需	一个或多个镜像名称。名称格式为以下之一：`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` 中可能需要更改的内容）的详细信息。

说明 

注意

通过为每个任务提供参数或定义环境变量来连接到 Docker 守护进程。您可以定义 DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY 和 DOCKER_TIMEOUT。如果您正在使用 docker machine，请运行随产品提供的脚本，该脚本将设置环境。它将为您设置这些变量。有关详细信息，请参阅 https://docs.docker.net.cn/machine/reference/env/。
此模块不使用 Docker SDK for Python 与 Docker 守护进程通信。它使用来自 Docker SDK 或 Python 的代码，该代码包含在此集合中。

另请参阅 

另请参阅

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 列表 / 元素=字典	受影响镜像的镜像检查结果。返回: 成功示例: `[]`

作者

Felix Fontein (@felixfontein)

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

作者

集合链接