Skip to content

安装 Helm Release

当你想把一个 Chart 装到某个命名空间时,使用"安装 Release"向导。一次安装会创建一个 Release(Helm 对一次安装的封装),之后可在 Release 列表 中查看与管理它。

入口

安装向导有两个入口,按你的使用习惯任选其一:

入口路径适用场景
Helm Release 列表页右上角 安装 Release 按钮集群 → 应用管理 → Helm Release → Release 列表已确定要装的 Chart(手动填写名称)
Chart 市场详情页的 安装此 Chart 按钮集群 → 应用管理 → Chart 市场 → 查看详情先浏览市场、再安装(自动带入 Chart 与 values)

从市场进入时,向导会自动预填 Chart 名称、当前选中的 Chart 版本,以及该版本的默认 values,你只需要确认 Release 名称等信息即可提交。

权限要求

打开安装向导需要命名空间级的 helm.kuboard.cn releases 资源 create 权限。未授权时,列表页的 安装 Release 按钮不会显示。

填写安装向导

页面表单字段如下:

字段是否必填说明
集群必选默认选中当前用户可访问的第一个集群
命名空间必选默认选中 default,可切换为其他命名空间
Chart 名称必填格式为 仓库/Chart,例如 bitnami/redis
Chart 版本可选留空则使用该 Chart 的最新版本
Release 名称必填同一命名空间内必须唯一
超时 (秒)可选30 – 3600 秒,默认 300,超出后安装判定失败
选项见下文"高级选项"
Values (YAML)可选覆盖 Chart 的默认配置,见下文"配置 values"

选择 Chart 来源与版本

  • 从市场挑选:在 Chart 市场找到目标 Chart → 点击 查看详情 → 右侧选择版本 → 点击 安装此 Chart,向导自动带入 Chart 与版本;
  • 手动指定:在列表页进入向导后,直接填写 仓库/Chart 格式的名称。Chart 名称需在你的集群已添加的 Chart 仓库(repo)中真实存在,否则安装会失败。

填写 Chart 名称并选择集群、命名空间后,向导会尝试从市场获取该 Chart 的 values-schema;若获取成功,Values 编辑器会多出"表单"模式(见下)。

Release 名称自动生成

从市场带入 Chart 时,Release 名称会自动预填为 Chart 名称的最后一段(转小写,非字母数字字符替换为 -)。例如 Chart bitnami/redis → 默认 Release 名 redis。你可以修改它。

配置 values

Values 是传给 Chart 的参数,用于覆盖 Chart 的默认配置。向导提供两种编辑方式:

  • YAML 直编:始终可用,直接编辑 YAML 文本;
  • 表单模式:仅当向导成功获取到该 Chart 的 values-schema 时可用。此时 Values 区域上方出现 表单 / YAML 两个标签页,切换后两种编辑方式双向同步。

表单模式下,支持按字段类型渲染为对应控件:

Schema 字段类型表单控件
string文本输入框
number数字输入(遵循 schema 的 min / max 限制)
boolean开关
enum下拉选择
object可折叠的分组,子字段逐层展开
array数组列表,可 + Add Item 增项、逐项删除

表单中标 必填 的字段来自 schema 的 required 声明;字段的描述文案会作为输入框的占位提示。

嵌套过深的 schema

当字段嵌套层级达到 5 层以上时,表单模式会提示"该 schema 嵌套过深,建议使用 YAML 编辑"。此时请切到 YAML 标签页直接编写配置。

高级选项

选项默认作用
自动创建命名空间目标命名空间不存在时自动创建(对应 Helm 的 --create-namespace
等待就绪等待应用就绪后才判定安装完成,并在进度页实时展示各资源的就绪状态(对应 Helm 的 --wait
仅 Dry-Run只校验模板与配置,不真正创建任何资源(对应 Helm 的 --dry-run

建议新装应用时保持 等待就绪 开启,这样进度页会直观显示每个资源的创建与就绪情况;若只关心安装是否成功,可关闭以加快返回。

Dry-Run 失败后自动恢复 values

勾选 仅 Dry-Run 后若校验失败(例如 values 配置错误),你编辑过的 values 会被临时保存,30 分钟内再次进入安装向导会自动恢复,无需重填。

提交后发生什么

点击 安装 后,向导将请求提交给后台异步执行,页面跳转到操作进度页(与卸载、升级共用同一套事件流机制,详见 操作事件):

  1. 提交即返回:安装任务以事件流(SSE)方式在后台执行,页面实时接收进度,无需等待请求返回;
  2. 进度展示:进度页包含三部分——
    • 进度条:显示已运行时间与总超时时间;
    • 资源状态:逐行列出正在创建的资源(类型、名称、状态,Deployment 额外显示 就绪副本/期望副本);
    • 日志面板:滚动输出 helm 命令的实时日志,失败行标红、完成行标绿;
  3. 安装结果
    • 成功:状态标签变为 已完成,点击 查看 Release 进入该 Release 的详情页;点击 返回 Releases 列表 回到列表,此时新 Release 已出现在列表中(状态为 deployed);
    • 失败:状态标签变为 失败,日志面板中可查看具体错误原因,据此调整 Chart 版本、values 或权限后重试。

中途取消

进度页右上角可点击 取消操作 终止安装。取消后,取消前已经创建出来的资源不会被自动删除,需要手工清理。

常见注意

  • Release 名称在命名空间内唯一:同一命名空间下不允许存在两个同名 Release。安装时使用已存在的名称,helm 会直接报错(release already exists),进度页日志显示失败。不同命名空间之间互不影响,可以存在同名 Release;
  • 版本留空代表最新版本,但最新版本可能包含不兼容变更,生产环境建议显式指定版本;
  • values 只在安装时生效一次:安装后再修改 values 需要走 升级,而非重新安装;
  • 安装失败不会产生 Release 记录(或仅留下 failed 状态记录),可在 Release 列表中查看确认。