WebStorm 2025.2 Help

Helm

Helm 是管理 Kubernetes 应用程序的工具。 Helm chart 是一组您可以在 Kubernetes 集群中运行的预配置资源定义的软件包。 Chart 包含软件包的说明( Chart.yaml )以及一个或多个用于生成 Kubernetes 清单文件的模板。

安装 Kubernetes 插件

此功能依赖于 Kubernetes 插件,您需要安装并启用。

  1. Ctrl+Alt+S 打开设置,然后选择 插件

  2. 打开 Marketplace 选项卡,找到 Kubernetes 插件,点击 安装 (如提示,请重启 IDE)。

指定 Helm 的自定义路径

如果您在自定义目录中安装了 Helm,可以手动指定其路径。

  1. %首选项对话框% 对话框(Ctrl+Alt+S )中,选择 构建、执行、部署 | Kubernetes

  2. Helm 可执行文件的路径 字段中,指定 helm 可执行文件的路径。

  3. 点击 测试 检查文件位置。 如果未找到,您可以手动检查文件位置,或点击 安装 ,WebStorm 会下载并安装缺失的软件。

Kubernetes 设置窗口

Helm chart 与模板的编码辅助功能包括代码补全、重构、检查、快速修复和快速文档。 代码补全包含来自指定仓库的依赖项值(默认来自 Helm Hub)。

在 Go 模板指令中,WebStorm 提供 Helm 内置对象 的补全,以及从 values.yaml 文件或自定义 values 文件传入的值。 按 Ctrl+B 可跳转到对象值的来源,例如父 Chart 中导入的子 Chart 值。

在模板对象中,您可以使用 代码折叠 :按 Ctrl+NumPad +Ctrl+NumPad - 在值与指令间切换。 您还可以将鼠标悬停在某个值上,以展开并显示指令。

Helm 导入的数据

您还可以使用标记图标在标签定义与标签选择器之间、重写值与被重写值之间导航。

创建新的 Helm Chart

  1. 项目 工具窗口中,右键点击文件夹并选择 新建(N) | Helm 图表

  2. 在打开的 新建Helm 图表 窗口中,输入 chart 的名称。

这将运行 helm create 命令,添加所需的基础文件以便开始使用:

  • .helmignore :打包时忽略的模式

  • Chart.yaml :带有元数据的基础 Chart 描述

  • values.yaml :Chart 模板的默认值

  • charts/ :子 Chart 的目录

  • templates/ :Chart 定义的目录

    • _helpers.tpl :模板中的 partial 与函数

    • NOTES.txt :Chart 部署后打印的信息

    • deployment.yaml :Kubernetes 部署定义示例

    • ingress.yaml :Kubernetes Ingress 定义示例

    • service.yaml :Kubernetes Service 定义示例

预览 Helm 模板渲染结果

您可以使用 helm template 命令在本地渲染 chart 模板。 指定一个或多个包含值的 YAML 文件,这些文件可来自文件系统中的任意文件夹。 这支持一些使用场景,例如为不同环境使用不同的值文件。

  1. 如果模板文件已在编辑器中打开,请点击编辑器右侧的 Helm 模板

    或者,右键点击 chart,并在上下文菜单中选择 Helm(H) | Helm 模板(T)

  2. 呈现Helm 模板 对话框中,添加一个或多个包含渲染值的文件。 这些可以是文件系统中的任意 YAML 文件。

    您也可以在 附加值 部分提供以逗号分隔的独立值。

    “渲染 Helm 模板”对话框
  3. 点击 继续。 这将运行 helm template 命令,并使用指定值渲染 Helm chart。

    WebStorm 会在差异查看器中打开渲染预览,并与原始模板文件进行比较。

更新外部依赖项

  • 右键点击 chart,并在上下文菜单中选择 Helm(H) | Helm 依赖项更新(D)

这将运行 helm dependency update 命令。

在 Helm 2 中,应在 requirements.yaml 文件中指定依赖项。 此操作还会生成或更新 requirements.lock

在 Helm 3 中,应在 Chart.yaml 文件中指定依赖项。 如果您在错误的文件中指定了依赖项,WebStorm 会通过检查提供快速修复操作以将其移动。

requirements.yaml Chart.yaml 文件中还包含用于更新依赖项的标记图标。

检查 Chart 中可能存在的问题

  • 右键点击 chart,指向 Helm(H) ,然后点击 Helm Lint(L)

这将运行 helm lint 命令,在不实际安装 chart 的情况下执行一系列测试以识别可能存在的问题。

最后修改日期: 2025年 9月 26日