community.docker.docker_image_push 模块 – 将 Docker 镜像推送到注册表

注意

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

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

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

要在剧本中使用它，请指定：community.docker.docker_image_push。

community.docker 3.6.0 中的新增功能

概要 

将 Docker 镜像推送到注册表。

要求 

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

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"`
name 字符串 / 必选	镜像名称。名称格式必须为 `name`、`repository/name` 或 `registry_server:port/name` 之一。 - 名称可以选择包含标签，通过附加 `:tag_name`，或者包含摘要，通过附加 `@hash:digest`。
tag 字符串	选择要推送的镜像。默认为 `latest`。如果 `name` 参数格式为 `name:tag` 或 `image@hash:digest`，则 `tag` 将被忽略。默认值： `"latest"`
timeout 整数	等待 API 响应的最大时间（以秒为单位）。如果任务中未指定该值，则将使用环境变量 `DOCKER_TIMEOUT` 的值。如果未设置环境变量，则将使用默认值。默认值： `60`
tls 布尔值	通过使用 TLS 但不验证 Docker 主机服务器的真实性来保护与 API 的连接。请注意，如果 `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_pull: 从注册表拉取 Docker 镜像。
community.docker.docker_image_remove: 删除 Docker 镜像。
community.docker.docker_image_tag: 使用新名称和/或标签标记 Docker 镜像。

示例 

- name: Push an image
  community.docker.docker_image_push:
    name: registry.example.com:5000/repo/image
    tag: latest

返回值 

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

键	描述
image 字典	受影响镜像的镜像检查结果。已返回：成功示例： `{}`

作者

Felix Fontein (@felixfontein)

community.docker.docker_image_push 模块 – 将 Docker 镜像推送到注册表

作者

集合链接