kubernetes.core.helm_template 模块 – 渲染图表模板

注意

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

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

要安装它，请使用： ansible-galaxy collection install kubernetes.core。

要在剧本中使用它，请指定： kubernetes.core.helm_template。

概要

• 将图表模板渲染到输出目录或作为串联的 yaml 文档的文本。

参数

参数	注释
binary_path 路径	要使用的 helm 二进制文件的路径。
chart_ref 路径 / 必需	带有仓库前缀的图表引用，例如，nginx-stable/nginx-ingress。 打包图表的路径。 解压图表目录的路径。 绝对 URL。
chart_repo_url 字符串	请求的图表所在的图表仓库 URL。
chart_version 字符串	要使用的图表版本。 如果未指定，则安装最新版本。
dependency_update 别名: dep_up 布尔值 在 kubernetes.core 2.4.0 中添加	在操作之前运行 helm dependency update。 dependency_update 选项需要在 Chart.yaml/requirements.yaml 文件中添加 dependencies 块。 有关更多信息，请访问 https://helm.kubernetes.ac.cn/docs/helm/helm_dependency/ 选项 false ←（默认） true
disable_hook 布尔值 在 kubernetes.core 2.4.0 中添加	阻止在安装过程中运行钩子。 选项 false ←（默认） true
include_crds 布尔值	在渲染的模板中包含自定义资源描述。 选项 false ←（默认） true
output_dir 路径	模板将写入的输出目录。 如果目录已存在，它将被覆盖。
release_name 别名: name 字符串 在 kubernetes.core 2.4.0 中添加	在渲染的模板中使用的发布名称。
release_namespace 字符串 在 kubernetes.core 2.4.0 中添加	此请求的命名空间范围。
release_values 别名: values 字典	传递给图表的值。 默认值: {}
set_values 列表 / 元素=字典 在 kubernetes.core 2.4.0 中添加	传递给图表配置的值。
value 字符串 / 必需	传递给图表配置的值（例如 phase=prod）。
value_type 字符串	使用 raw 设置单个值。 使用 string 强制将单个值设置为字符串。 当值本身对于命令行来说太长或动态生成时，使用 file 从文件中设置单个值。 使用 json 设置 json 值（标量/对象/数组）。此功能需要 helm>=3.10.0。 选项 "raw" ←（默认） "string" "json" "file"
show_only 列表 / 元素=字符串 在 kubernetes.core 2.4.0 中添加	仅显示从给定模板渲染的清单。 默认值: []
update_repo_cache 布尔值	在操作之前运行 helm repo update。 可以作为模板生成的一部分或作为单独的步骤运行。 选项 false ←（默认） true
values_files 列表 / 元素=字符串	要传递给图表的值文件。 路径将从目标主机的文件系统读取，而不是运行 ansible 的主机。 如果同时使用 values_files 选项和 values 选项，则 values_files 选项会在 values 选项之前进行评估。 路径按照指定路径的顺序进行评估。 默认值: []

示例

- name: Render templates to specified directory
  kubernetes.core.helm_template:
    chart_ref: stable/prometheus
    output_dir: mycharts

- name: Render templates
  kubernetes.core.helm_template:
    chart_ref: stable/prometheus
  register: result

- name: Write templates to file
  copy:
    dest: myfile.yaml
    content: "{{ result.stdout }}"

- name: Render MutatingWebhooksConfiguration for revision tag "canary", rev "1-13-0"
  kubernetes.core.helm_template:
    chart_ref: istio/istiod
    chart_version: "1.13.0"
    release_namespace: "istio-system"
    show_only:
      - "templates/revision-tags.yaml"
    release_values:
      revision: "1-13-0"
      revisionTags:
        - "canary"
  register: result

- name: Write templates to file
  copy:
    dest: myfile.yaml
    content: "{{ result.stdout }}"

返回值

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

键	描述
command 字符串	此模块运行的完整 helm 命令，以防您想在模块外部重新运行该命令或调试问题。 返回值: always 示例: "helm template --output-dir mychart nginx-stable/nginx-ingress"
stderr 字符串	完整的 helm 命令 stderr，以防您想显示它或检查事件日志。 返回值: always 示例: ""
stdout 字符串	完整的 helm 命令 stdout。 如果没有提供 output_dir，这将包含作为串联的 yaml 文档渲染的模板。 返回值: always 示例: ""

作者

• Mike Graves (@gravesm)

集合链接

• 问题跟踪器
• 仓库（来源）