kubernetes.core.k8s_cluster_info 模块 – 描述 Kubernetes (K8s) 集群、可用 API 及其各自的版本

注意

此模块是 kubernetes.core 集合 (版本 5.0.0) 的一部分。

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

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

要在 playbook 中使用它，请指定：kubernetes.core.k8s_cluster_info。

kubernetes.core 0.11.1 中的新增功能

概要 

使用 Kubernetes Python 客户端对 K8s 对象执行读取操作。
使用配置文件、证书、密码或令牌进行身份验证。
支持检查模式。

注意

此模块具有相应的操作插件。

要求 

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

python >= 3.9
kubernetes >= 24.2.0
PyYAML >= 3.11

参数 

参数	注释
api_key 字符串	用于与 API 进行身份验证的令牌。也可以通过 K8S_AUTH_API_KEY 环境变量指定。
ca_cert 别名：ssl_ca_cert 路径	用于与 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链以避免证书验证错误。也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。
client_cert 别名：cert_file 路径	用于与 API 进行身份验证的证书的路径。也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。
client_key 别名：key_file 路径	用于与 API 进行身份验证的密钥文件的路径。也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。
context 字符串	配置文件中找到的上下文名称。也可以通过 K8S_AUTH_CONTEXT 环境变量指定。
host 字符串	提供用于访问 API 的 URL。也可以通过 K8S_AUTH_HOST 环境变量指定。
impersonate_groups 列表 / 元素=字符串 kubernetes.core 2.3.0 中新增	要为操作模拟的用户组。也可以通过 K8S_AUTH_IMPERSONATE_GROUPS 环境变量指定。示例：Group1,Group2
impersonate_user 字符串 kubernetes.core 2.3.0 中新增	要为操作模拟的用户名。也可以通过 K8S_AUTH_IMPERSONATE_USER 环境变量指定。
invalidate_cache 布尔值	在检索有关集群的信息之前使缓存失效。选项 `false` `true` ← (默认)
kubeconfig 任意	现有 Kubernetes 配置文件的路径。如果没有提供，并且没有提供其他连接选项，Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。可以使用分隔符“;” (Windows 平台) 或“:” (其他平台) 提供多个 Kubernetes 配置文件。 Kubernetes 配置可以作为字典提供。此功能需要 python kubernetes 客户端版本 >= 17.17.0。在 2.2.0 版本中添加。
no_proxy 字符串 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 字符串	提供用于与 API 进行身份验证的密码。也可以通过 K8S_AUTH_PASSWORD 环境变量指定。请阅读 `username` 选项的描述，了解此选项适用的情况。
persist_config 布尔值	是否保存 kube 配置刷新令牌。也可以通过 K8S_AUTH_PERSIST_CONFIG 环境变量指定。当 k8s 上下文使用具有刷新令牌的用户凭据（如 oidc 或 gke/gcloud auth）时，令牌由 k8s python 客户端库刷新，但默认情况下不会保存。因此，旧的刷新令牌可能会过期，并且下一次身份验证可能会失败。将此标志设置为 true 将告诉 k8s python 客户端将新的刷新令牌保存到 kube 配置文件。默认为 false。请注意，当前版本的 k8s python 客户端库尚不支持将此标志设置为 True。此 k8s python 库的修复程序位于：https://github.com/kubernetes-client/python-base/pull/169 选项 `false` `true`
proxy 字符串	用于连接的 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 字符串	用于基本身份验证标头的冒号分隔的用户名:密码。也可以通过 K8S_AUTH_PROXY_HEADERS_BASIC_AUTH 环境变量指定。
proxy_basic_auth 字符串	用于代理基本身份验证标头的冒号分隔的用户名:密码。也可以通过 K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH 环境变量指定。
user_agent 字符串	表示所需用户代理的字符串，例如 foo/1.0。也可以通过 K8S_AUTH_PROXY_HEADERS_USER_AGENT 环境变量指定。
username 字符串	提供用于与 API 进行身份验证的用户名。也可以通过 K8S_AUTH_USERNAME 环境变量指定。请注意，这只适用于配置为使用 HTTP 基本身份验证的集群。如果您的集群采用其他形式的身份验证（例如 OpenShift 中的 OAuth2），则此选项将无法按预期工作，您应该查看 community.okd.k8s_auth 模块，因为它可能满足您的需求。
validate_certs 别名：verify_ssl 布尔值	是否验证 API 服务器的 SSL 证书。也可以通过 K8S_AUTH_VERIFY_SSL 环境变量指定。选项 `false` `true`

注释 

注意

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

示例 

- name: Get Cluster information
  kubernetes.core.k8s_cluster_info:
  register: api_status

- name: Do not invalidate cache before getting information
  kubernetes.core.k8s_cluster_info:
    invalidate_cache: False
  register: api_status

返回值 

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

键	描述
apis 字典	从集群中找到的资源的组+版本的字典返回：成功
categories 列表 / 元素=字符串	API 类别返回：成功
name 字符串	资源简称返回：成功
namespaced 布尔值	如果资源是命名空间的返回：成功
preferred 布尔值	如果资源版本优先返回：成功
short_names 字符串	资源简称返回：成功
singular_name 字符串	资源单数名称返回：成功
connection 字典	连接信息返回：成功
cert_file 字符串	客户端证书路径。返回：成功
host 字符串	主机URL 返回：成功
password 字符串	用户密码返回：成功
proxy 字符串	代理详细信息返回：成功
ssl_ca_cert 字符串	CA 证书路径返回：成功
username 字符串	用户名返回：成功
verify_ssl 布尔值	SSL 验证状态返回：成功
version 字典	关于服务器和客户端版本的信息返回：成功
client 字符串	客户端版本返回：成功
server 字典	服务器版本返回：成功

作者

Abhijeet Kasurde (@Akasurde)