kubernetes.core.helm_repository 模块 – 管理 Helm 仓库。

注意

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

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

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

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

kubernetes.core 0.11.0 中的新增功能

概要

  • 管理 Helm 仓库。

注意

此模块具有相应的 action 插件

要求

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

参数

参数

注释

api_key

字符串

kubernetes.core 2.3.0 中添加

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

binary_path

路径

要使用的 helm 二进制文件的路径。

ca_cert

别名:ssl_ca_cert

路径

kubernetes.core 2.3.0 中添加

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

context

别名:kube_context

字符串

kubernetes.core 2.4.0 中添加

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

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

force_update

别名:force

布尔值

kubernetes.core 2.4.0 中添加

是否替换(覆盖)已存在的仓库。

选项

  • false ← (默认)

  • true

host

字符串

kubernetes.core 2.3.0 中添加

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

kubeconfig

别名:kubeconfig_path

任意

kubernetes.core 2.4.0 中添加

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

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

配置可以作为字典提供。

pass_credentials

布尔值

kubernetes.core 2.3.0 中添加

将凭据传递给所有域。

选项

  • false ← (默认)

  • true

repo_name

别名:name

字符串 / 必需

图表仓库名称。

repo_password

别名:password

字符串

具有基本身份验证的仓库的图表仓库密码。

如果指定了 chart_repo_username,则为必需。

repo_state

别名:state

字符串

仓库的所需状态。

选项

  • "present" ← (默认)

  • "absent"

repo_url

别名:url

字符串

图表仓库 url

repo_username

别名:username

字符串

具有基本身份验证的仓库的图表仓库用户名。

如果指定了 chart_repo_password,则为必需。

validate_certs

别名:verify_ssl

布尔值

kubernetes.core 2.3.0 中添加

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

选项

  • false

  • true ← (默认)

示例

- name: Add a repository
  kubernetes.core.helm_repository:
    name: stable
    repo_url: https://kubernetes.github.io/ingress-nginx

- name: Add Red Hat Helm charts repository
  kubernetes.core.helm_repository:
    name: redhat-charts
    repo_url: https://redhat-developer.github.com/redhat-helm-charts

返回值

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

描述

command

字符串

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

返回:始终

示例:"/usr/local/bin/helm repo add bitnami https://charts.bitnami.com/bitnami"

msg

字符串

`helm` 命令返回的错误消息

返回:失败时

示例:"Repository already have a repository named bitnami"

stderr

字符串

完整的 `helm` 命令 stderr,如果您想显示它或检查事件日志,此命令非常有用

返回:始终

示例:""

stderr_lines

列表 / 元素=字符串

完整的 `helm` 命令 stderr 列表,如果您想显示它或检查事件日志,此命令非常有用

返回:始终

示例:[""]

stdout

字符串

完整的 `helm` 命令标准输出,您可以显示它或检查事件日志

返回:始终

示例: "\"bitnami\" has been added to your repositories"

stdout_lines

列表 / 元素=字符串

完整的 `helm` 命令标准输出列表,您可以显示它或检查事件日志

返回:始终

示例: ["\"bitnami\" has been added to your repositories"]

作者

  • Lucas Boisserie (@LucasBoisserie)