kubernetes.core.helm_info 模块 – 从集群内部署的 Helm 包获取信息

注意

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

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

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

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

kubernetes.core 0.11.0 中的新功能

概要 

从集群内部署的 Helm 包获取信息（值、状态等）。

注意

此模块具有相应的 action 插件。

要求 

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

helm (https://github.com/helm/helm/releases)
yaml (https://pypi.ac.cn/project/PyYAML/)

参数 

参数	注释
api_key 字符串在 kubernetes.core 1.2.0 中添加	用于通过 API 进行身份验证的令牌。也可以通过 `K8S_AUTH_API_KEY` 环境变量指定。
binary_path 路径	要使用的 helm 二进制文件的路径。
ca_cert 别名：ssl_ca_cert 路径在 kubernetes.core 1.2.0 中添加	用于通过 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链，以避免证书验证错误。也可以通过 `K8S_AUTH_SSL_CA_CERT` 环境变量指定。
context 别名：kube_context 字符串	Helm 选项，用于指定要使用的 kubeconfig 上下文。如果任务中未指定该值，则将改用环境变量 `K8S_AUTH_CONTEXT` 的值。
get_all_values 布尔值在 kubernetes.core 2.4.0 中添加	如果要获取发布的全部（计算后的）值，请设置为 `True`。当 `False`（默认）时，仅返回用户提供的值。选项 `false` ←（默认） `true`
host 字符串在 kubernetes.core 1.2.0 中添加	提供用于访问 API 的 URL。也可以通过 `K8S_AUTH_HOST` 环境变量指定。
kubeconfig 别名：kubeconfig_path 任意	Helm 选项，用于指定要使用的 kubeconfig 路径。如果任务中未指定该值，则将改用环境变量 `K8S_AUTH_KUBECONFIG` 的值。该配置可以作为字典提供。在版本 2.4.0 中添加。
release_name 别名：name 字符串 / 必需	要管理的发布名称。
release_namespace 别名：namespace 字符串 / 必需	Kubernetes 命名空间，应在其中安装 chart。
release_state 列表 / 元素=字符串在 kubernetes.core 2.3.0 中添加	根据其状态显示发布。默认值为 `deployed` 和 `failed`。如果设置为 `all`，则显示所有发布，不应用任何过滤器。如果设置为 `deployed`，则显示已部署的发布。如果设置为 `failed`，则显示失败的发布。如果设置为 `pending`，则显示待处理的发布。如果设置为 `superseded`，则显示被取代的发布。如果设置为 `uninstalled`，则显示已卸载的发布（如果使用了 `helm uninstall --keep-history`）。如果设置为 `uninstalling`，则显示当前正在卸载的发布。默认值： `[]`
validate_certs 别名：verify_ssl 布尔值在 kubernetes.core 1.2.0 中添加	是否验证 API 服务器的 SSL 证书。也可以通过 `K8S_AUTH_VERIFY_SSL` 环境变量指定。选项 `false` `true` ←（默认）

示例 

- name: Gather information of Grafana chart inside monitoring namespace
  kubernetes.core.helm_info:
    name: test
    release_namespace: monitoring

- name: Gather information about test-chart with pending state
  kubernetes.core.helm_info:
    name: test-chart
    release_namespace: testenv
    release_state:
    - pending

返回值 

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

键	描述
status complex	状态输出的字典返回: 仅当发布存在时返回
app_version 字符串	已部署的应用程序版本返回: 总是返回
chart 字符串	Chart 名称和 chart 版本返回: 总是返回
hooks list / elements=dictionary 在 kubernetes.core 2.4.0 中添加	发布的 Hooks 返回: 总是返回
manifest list / elements=dictionary 在 kubernetes.core 2.4.0 中添加	发布的 Manifest 返回: 总是返回
name 字符串	发布的名称返回: 总是返回
namespace 字符串	发布部署的命名空间返回: 总是返回
notes 字符串在 kubernetes.core 2.4.0 中添加	发布的 Notes 返回: 总是返回
revision 字符串	发布已更新的次数返回: 总是返回
status 字符串	发布的状态 (可以是 DEPLOYED, FAILED, …) 返回: 总是返回
updated 字符串	上次更新的日期返回: 总是返回
values 字符串	用于部署的值的字典返回: 总是返回

作者

Lucas Boisserie (@LucasBoisserie)