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 插件

要求

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

参数

参数

注释

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

字符串

指定要使用的 kubeconfig 上下文的 Helm 选项。

如果任务中未指定该值,则将使用环境变量 K8S_AUTH_CONTEXT 的值。

get_all_values

布尔值

kubernetes.core 2.4.0 中新增

如果要获取发行版的全部(计算)值,则设置为 True

False(默认值)时,仅返回用户提供的 values。

选项

  • false ← (默认)

  • true

host

字符串

kubernetes.core 1.2.0 中新增

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

kubeconfig

别名:kubeconfig_path

任意

指定要使用的 kubeconfig 路径的 Helm 选项。

如果任务中未指定该值,则将使用环境变量 K8S_AUTH_KUBECONFIG 的值。

配置可以作为字典提供。在 2.4.0 版本中添加。

release_name

别名:name

字符串 / 必填

要管理的发行版名称。

release_namespace

别名:namespace

字符串 / 必填

应安装图表所在的 Kubernetes 命名空间。

release_state

列表 / 元素=字符串

kubernetes.core 2.3.0 中新增

根据其状态显示发行版。

默认值为 deployedfailed

如果设置为 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

复杂

状态输出的字典

返回:仅当发行版存在时

app_version

字符串

已部署应用程序的版本

返回:始终

chart

字符串

图表名称和图表版本

返回:始终

hooks

列表 / 元素=字典

kubernetes.core 2.4.0 中新增

发行版的钩子

返回:始终

manifest

列表 / 元素=字典

kubernetes.core 2.4.0 中新增

发布清单

返回:始终

名称

字符串

发布的名称

返回:始终

命名空间

字符串

部署发布的命名空间

返回:始终

备注

字符串

kubernetes.core 2.4.0 中新增

发布的备注

返回:始终

版本

字符串

发布更新的次数

返回:始终

status

字符串

发布状态(可以是已部署、失败……)

返回:始终

更新时间

字符串

最后更新日期

返回:始终

字符串

用于部署的值字典

返回:始终

作者

  • Lucas Boisserie (@LucasBoisserie)