kubernetes.core.helm_plugin 模块 – 管理 Helm 插件

注意

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

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

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

要在 playbook 中使用它,请指定:kubernetes.core.helm_plugin

kubernetes.core 1.0.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

字符串

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

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

host

字符串

kubernetes.core 1.2.0 中新增

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

kubeconfig

别名:kubeconfig_path

任意

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

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

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

plugin_name

字符串

Helm 插件的名称。

仅当 state=absentstate=latest 时才需要。

plugin_path

字符串

本地文件系统上插件的路径或远程 VCS 仓库的 URL。

如果提供来自文件系统的插件路径,请确保远程机器上存在 tar,而不是 Ansible 控制器上。

仅当 state=present 时才需要。

plugin_version

字符串

kubernetes.core 2.3.0 中新增

要安装的插件版本。如果未指定,则安装最新版本。

state=absentstate=latest 时被忽略。

state

字符串

如果 state=present,则将安装 Helm 插件。

如果 state=latest,则将更新 Helm 插件。在 2.3.0 版本中新增。

如果 state=absent,则将删除 Helm 插件。

选项

  • "absent"

  • "present" ← (默认)

  • "latest"

validate_certs

别名:verify_ssl

布尔值

kubernetes.core 1.2.0 中新增

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

选项

  • false

  • true ← (默认)

示例

- name: Install Helm env plugin
  kubernetes.core.helm_plugin:
    plugin_path: https://github.com/adamreese/helm-env
    state: present

- name: Install Helm plugin from local filesystem
  kubernetes.core.helm_plugin:
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Remove Helm env plugin
  kubernetes.core.helm_plugin:
    plugin_name: env
    state: absent

- name: Install Helm plugin with a specific version
  kubernetes.core.helm_plugin:
    plugin_version: 2.0.1
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Update Helm plugin
  kubernetes.core.helm_plugin:
    plugin_name: secrets
    state: latest

返回值

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

描述

command

字符串

此模块构建的完整 `helm` 命令,如果您想在模块外部重新运行命令或调试问题,可以使用。

返回:始终

示例:"helm plugin list ..."

msg

字符串

关于成功命令的信息

返回:始终

示例:"Plugin installed successfully"

rc

整数

Helm 插件命令返回代码

返回:始终

示例:1

stderr

字符串

完整的 `helm` 命令 stderr,如果您想显示它或检查事件日志,可以使用。

返回:始终

示例:""

stdout

字符串

完整的 `helm` 命令 stdout,如果您想显示它或检查事件日志,可以使用。

返回:始终

示例:""

作者

  • Abhijeet Kasurde (@Akasurde)