community.docker.docker_login 模块 – 登录到 Docker 注册表。

注意

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

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

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

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

概要

  • 提供类似于 docker login 命令的功能。

  • 使用 Docker 注册表进行身份验证，并将凭据添加到本地 Docker 配置文件或与注册表关联的凭据存储。 将凭据添加到配置文件或凭据存储允许将来使用 Ansible 的 Docker 模块、Docker CLI 和 Docker SDK for Python 等工具连接到注册表，而无需提供凭据。

  • 在检查模式下运行将执行身份验证，而不会更新配置文件。

要求

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

  • 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 文件。

config_path

别名：dockercfg_path

路径

Docker CLI 配置文件的自定义路径。

默认值： "~/.docker/config.json"

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"

password

字符串

注册表帐户的明文密码。

当 state=present 时，此参数为必填项。

reauthorize

别名: reauth

布尔值

刷新配置文件中找到的现有身份验证。

选择

  • false ← (默认)

  • true

registry_url

别名: registry, url

字符串

注册表 URL。

默认值: "https://index.docker.io/v1/"

state

字符串

此参数控制用户的当前状态。present 将登录用户，absent 将注销用户。

要注销，您只需要注册表服务器，默认情况下为 DockerHub。

在 2.1 版本之前，您只能登录。

Docker 不支持使用自定义配置文件进行“注销”。

选择

  • "present" ← (默认)

  • "absent"

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

username

字符串

注册表帐户的用户名。

当 state=present 时，此参数为必填项。

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 中更改）的内容的详细信息。

说明

注意

示例

- name: Log into DockerHub
  community.docker.docker_login:
    username: docker
    password: rekcod

- name: Log into private registry and force re-authorization
  community.docker.docker_login:
    registry_url: your.private.registry.io
    username: yourself
    password: secrets3
    reauthorize: true

- name: Log into DockerHub using a custom config file
  community.docker.docker_login:
    username: docker
    password: rekcod
    config_path: /tmp/.mydockercfg

- name: Log out of DockerHub
  community.docker.docker_login:
    state: absent

返回值

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

键

描述

login_results

字典

登录的结果。

返回: 当 state=present 时

示例: {"serveraddress": "localhost:5000", "username": "testuser"}

作者

  • Olaf Kilian (@olsaki)

  • Chris Houseknecht (@chouseknecht)