containers.podman.podman_login 模块 – 使用 podman 登录容器注册表

注意

此模块是 containers.podman 集合 (版本 1.16.2) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install containers.podman。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定：containers.podman.podman_login。

概要

  • 使用 podman login 命令登录容器注册表服务器。如果未指定注册表，则将使用 `registries.conf` 中 `[registries.search]` 下的第一个注册表。用户可以通过设置 `authfile` 标志来覆盖身份验证文件的路径。使用的默认路径为 `${XDG_RUNTIME_DIR}/containers/auth.json`。

要求

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

  • 主机上已安装 Podman

参数

参数

注释

authfile

路径

身份验证文件的路径。默认为 ``${XDG_RUNTIME_DIR}/containers/auth.json`` 您还可以通过设置 ``REGISTRY_AUTH_FILE`` 环境变量来覆盖身份验证文件的默认路径。``export REGISTRY_AUTH_FILE=path``

certdir

路径

使用路径下的证书 (*.crt, *.cert, *.key) 连接到注册表。默认证书目录为 /etc/containers/certs.d。

executable

字符串

podman 可执行文件的路径（如果它不在运行 podman 的机器上的 $PATH 中）。

默认值： "podman"

password

字符串

注册表服务器的密码。

registry

字符串

注册表服务器。如果未指定注册表，则将使用 `registries.conf` 中 `[registries.search]` 下的第一个注册表。

secret

字符串

要用于对目标注册表进行身份验证的现有 podman 密钥的名称。

tlsverify

布尔值

联系注册表时要求 HTTPS 并验证证书。如果明确设置为 true，则将使用 TLS 验证。如果设置为 false，则不会使用 TLS 验证。如果未指定，则除非目标注册表在 registries.conf 中列为不安全注册表，否则将使用 TLS 验证。

选项

  • false

  • true

username

字符串

注册表服务器的用户名。

示例

- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
  containers.podman.podman_login:
    username: user
    password: 'p4ssw0rd'

- name: Login to quay.io and create ${XDG_RUNTIME_DIR}/containers/auth.json
  containers.podman.podman_login:
    username: user
    password: 'p4ssw0rd'
    registry: quay.io

- name: Login to quay.io using existing secret called password
  containers.podman.podman_login:
    username: user
    secret: password
    registry: quay.io

作者

  • Jason Hiatt (@jthiatt)

  • Clemens Lange (@clelange)

  • Michael Fox (@spmfox)