community.okd.openshift_registry_info 模块 – 显示有关集成注册表的信息。

注意

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

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

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

要在 playbook 中使用它，请指定：community.okd.openshift_registry_info。

community.okd 2.2.0 中的新增功能

概要

  • 此模块公开有关集成注册表的信息。

  • 使用 check 来验证您的本地客户端是否可以访问注册表。

  • 如果管理员没有为注册表配置公共主机名，则此命令在服务器外部运行时可能会失败。

  • 类似于 oc registry info。

要求

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

  • python >= 3.6

  • kubernetes >= 12.0.0

  • docker-image-py

参数

参数

注释

api_key

string

用于向 API 进行身份验证的令牌。也可以通过 K8S_AUTH_API_KEY 环境变量指定。

ca_cert

别名：ssl_ca_cert

路径

用于向 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链以避免证书验证错误。也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。

check

boolean

尝试使用本地客户端联系集成注册表。

选择

  • false ←（默认）

  • true

client_cert

别名：cert_file

路径

用于向 API 进行身份验证的证书的路径。也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。

client_key

别名：key_file

路径

用于向 API 进行身份验证的密钥文件的路径。也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。

context

string

在配置文件中找到的上下文的名称。也可以通过 K8S_AUTH_CONTEXT 环境变量指定。

host

string

提供用于访问 API 的 URL。也可以通过 K8S_AUTH_HOST 环境变量指定。

impersonate_groups

list / elements=string

在 kubernetes.core 2.3.0 中添加

用于操作的要模拟的组。

也可以通过 K8S_AUTH_IMPERSONATE_GROUPS 环境变量指定。示例：Group1,Group2

impersonate_user

string

在 kubernetes.core 2.3.0 中添加

用于操作的要模拟的用户名。

也可以通过 K8S_AUTH_IMPERSONATE_USER 环境变量指定。

kubeconfig

any

现有 Kubernetes 配置文件的路径。如果未提供，并且未提供其他连接选项，则 Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。

可以使用分隔符 ‘;’（对于 Windows 平台）或 ‘:’（对于其他平台）提供多个 Kubernetes 配置文件。

Kubernetes 配置可以作为字典提供。此功能需要 Python Kubernetes 客户端版本 >= 17.17.0。在 2.2.0 版本中添加。

no_proxy

string

在 kubernetes.core 2.3.0 中添加

不应通过代理的主机/域/IP/CIDR 的逗号分隔列表。也可以通过 K8S_AUTH_NO_PROXY 环境变量指定。

请注意，此模块不会从环境中获取典型的代理设置（例如 NO_PROXY）。

此功能需要 kubernetes>=19.15.0。当 Kubernetes 库小于 19.15.0 时，即使 no_proxy 设置正确也会失败。

示例值为 “localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16”

password

string

提供用于向 API 进行身份验证的密码。也可以通过 K8S_AUTH_PASSWORD 环境变量指定。

请阅读 username 选项的描述，以了解何时适用此选项。

persist_config

boolean

是否保存 kube 配置刷新令牌。也可以通过 K8S_AUTH_PERSIST_CONFIG 环境变量指定。

当 k8s 上下文使用带有刷新令牌的用户凭据（如 oidc 或 gke/gcloud 身份验证）时，令牌由 k8s Python 客户端库刷新，但默认情况下不保存。因此，旧的刷新令牌可能会过期，下一次身份验证可能会失败。将此标志设置为 true 将告诉 k8s Python 客户端将新的刷新令牌保存到 kube 配置文件。

默认为 false。

请注意，当前版本的 k8s Python 客户端库尚不支持将此标志设置为 True。

此 k8s Python 库的修复程序在此处：https://github.com/kubernetes-client/python-base/pull/169

选择

  • false

  • true

proxy

string

用于连接的 HTTP 代理的 URL。也可以通过 K8S_AUTH_PROXY 环境变量指定。

请注意，此模块不会从环境中获取典型的代理设置（例如 HTTP_PROXY）。

proxy_headers

字典

在 kubernetes.core 2.0.0 中添加

用于 HTTP 代理的标头。

文档可以在这里找到 https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers。

basic_auth

string

用于基本身份验证标头的冒号分隔的用户名:密码。

也可以通过 K8S_AUTH_PROXY_HEADERS_BASIC_AUTH 环境变量指定。

proxy_basic_auth

string

用于代理基本身份验证标头的冒号分隔的用户名:密码。

也可以通过 K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH 环境变量指定。

user_agent

string

表示你想要的 user-agent 的字符串，例如 foo/1.0。

也可以通过 K8S_AUTH_PROXY_HEADERS_USER_AGENT 环境变量指定。

username

string

提供用于使用 API 进行身份验证的用户名。也可以通过 K8S_AUTH_USERNAME 环境变量指定。

请注意，这仅适用于配置为使用 HTTP 基本身份验证的集群。如果你的集群具有不同的身份验证形式（例如 OpenShift 中的 OAuth2），则此选项将无法按预期工作，你应该研究 community.okd.k8s_auth 模块，因为它可能会满足你的需求。

validate_certs

别名: verify_ssl

boolean

是否验证 API 服务器的 SSL 证书。也可以通过 K8S_AUTH_VERIFY_SSL 环境变量指定。

选择

  • false

  • true

备注

注意

  • 为了避免当 validate_certs 为 True 时出现 SSL 证书验证错误，必须通过 ca_cert 或在 kubeconfig 文件中提供 API 服务器的完整证书链。

示例

# Get registry information
- name: Read integrated registry information
  community.okd.openshift_registry_info:

# Read registry integrated information and attempt to contact using local client.
- name: Attempt to contact integrated registry using local client
  community.okd.openshift_registry_info:
    check: true

返回值

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

Key

描述

check

字典

本地客户端是否可以联系注册表。

返回: success

msg

string

描述 ping 操作的消息。

返回: always

reached

string

是否已连接到注册表。

返回: success

internal_hostname

string

内部注册表主机名。

返回: success

public_hostname

string

公共注册表主机名。

返回: success

作者

  • Aubin Bikouo (@abikouo)