Rancher 的应用商店服务要求所有自定义应用商店都必须以特定格式构建，以便应用商店服务能够在 Rancher 中使用它。

有关开发 Chart 的完整步骤，请参阅 Helm Chart 开发人员参考。

Charts 类型

Rancher 支持两种不同类型的 Chart：

  • Helm Chart

    原生 Helm Charts 包括应用程序以及运行它所需的其他软件。部署原生 Helm Chart 时，您将需要了解学习每个 Chart 的参数，然后使用应答（它们是键值对的集合）来配置这些参数。

    Rancher 中的 Helm Stable 和 Helm Incubators 均为原生的 Helm Chart。您也可以添加其他的 Helm Charts（尽管我们建议使用 Rancher Chart）。

  • Rancher Chart

    Rancher Chart 基本与原生 Helm Chart 一样。Rancher Chart 添加了两个额外的文件app-readme.md和questions.yaml来增强用户体验，但它们与原生 Helm Chart 的使用方式完全相同。在 Rancher Chart 独有的文件中了解有关它们的更多信息。

    Rancher Charts 的优点包括：

    • 增强的修订跟踪

      虽然 Helm 支持版本化的部署，但 Rancher 添加了修订跟踪历史记录，以显示 Charts 的不同版本之间的更改。

    • 简化的应用启动流程

      Rancher Chart 添加了简化的 Chart 说明和配置表单，以简化应用商店中应用的部署。Rancher 用户无需阅读整个 Helm Chart 变量的列表即可了解如何启动应用。

    • 应用资源管理

      Rancher 将跟踪由特定应用创建的所有资源。用户可以轻松地在 UI 上进行故障排查，该页面列出了此应用的所有工作负载和其他相关对象。

应用商店的文件结构

下表为应用商店 Chart 的结构，展示了charts/<APPLICATION>/<APP_VERSION>/目录下的结构。在为自定义应用商店定制 Chart 时，此信息很有用。带有 * 的文件代表 Rancher Chart 独有的文件，但这些文件不是必须的。

  1. charts/<APPLICATION>/<APP_VERSION>/
  2. | --charts /            # 包含依赖的 Chart 的应用商店。
  3. | --templates/          # 包含应用商店的模板，当与 values.yml 结合使用时，将生成 Kubernetes YAML。
  4. | --app-readme.md       # 文本为显示在 Rancher UI 的 Chart 标题中。*
  5. | --Chart.yml           # 必需的 Helm Chart 信息文件。
  6. | --questions.yml       # 用于生成在 Rancher UI 中显示的应答表单。它们将显示在配置选项中。*
  7. | --README.md           # 可选：在 Rancher UI 中显示的 Helm 自述文件。该文本显示在“详细描述”中。
  8. | --requirements.yml    # 可选：YAML 文件列出了 Chart 的依赖关系。
  9. | --values.yml          # Chart 的默认配置值。

Rancher Chart 独有的文件

在创建自己的自定义应用商店之前，您应该对 Rancher Chart 与本地 Helm Chart 的区别有基本的了解。Rancher Chart 的应用商店结构与 Helm Chart 略有不同。Rancher Chart 包含了两个 Helm Chart 不包含的文件。

  • app-readme.md

    在 Chart 的 UI 标题中提供描述性文本的文件。下图显示了 Rancher Chart（包括app-readme.md）和原生 Helm Chart（不包括app-readme.md）之间的差异。

    带有 “app-readme.md” 的 Rancher Chart(左)与没有“app-readme.md”的 Helm Chart(右)

    app-readme.md

  • questions.yml

    包含 Chart 问题的文件。这些问题简化了 Chart 的部署。没有它，您必须使用键值对配置部署。下图显示了 Rancher Chart（包括questions.yml）和原生 Helm Chart（不包括questions.yml）之间的差异。

    带有 “questions.yml” 的 Rancher Chart(左)与没有“questions.yml”的 Helm Chart(右)

    questions.yml

Questions.yml 详解

在questions.yml中，大多数内容都围绕着用户关心的应用配置的问题，但是也可以在此文件中设置一些其他字段。

最小/最大 Rancher 版本

自 v2.3.0 起可用

对于每个 Chart，您可以添加最小和/或最大的 Rancher 版本，该版本确定是否可以从 Rancher 部署此 Chart。

注意： 即使 Rancher 发行版的前缀为v，使用该选项时发行版的前缀也为空。

  1. rancher_min_version: 2.3.0
  2. rancher_max_version: 2.3.99

问题变量参考

以下选项可在questions.yml文件中嵌套的questions:部分中使用。

变量类型必填描述
variablestring是定义values.yml文件中指定的变量名。如果是嵌套对象，可以使用foo.bar这种形式。
labelstring是指定变量的标题显示内容。
descriptionstring否指定变量的描述显示内容。
typestring否变量类型，如果未指定，则默认为string(当前支持的类型为 string，multiline，boolean，int，enum，password，storageclass，hostname，pvc 和 secret。
requiredbool否定义变量是否为必填(true | false)
defaultstring否指定默认值。
groupstring否根据输入值对变量进行分组。
min_lengthint否最小字符长度。
max_lengthint否最大字符长度。
minint否最小整数值。
maxint否最大整数值。
options[]string否当变量类型为enum时指定选项，例如：options:
- “ClusterIP”
- “NodePort”
- “LoadBalancer”
valid_charsstring否用于对输入字符进行验证的正则表达式。
invalid_charsstring否用于对无效输入字符验证的正则表达式。
subquestions[]subquestion否添加一个子问题数组。
show_ifstring否如果条件变量为 true，则显示当前变量。例如show_if: “serviceType=Nodeport”
show_subquestion_ifstring否如果条件变量为 true，或等于某个选项，则显示它的子问题。例如show_subquestion_if: “true”

注意： subquestions[] 不能包含 subquestions 或 show_subquestions_if 键，但是支持上表中的所有其他键。

教程：创建应用的示例

有关将自定义应用添加到自定义应用商店的教程，请参阅此页面。