Helm Schema Gen 插件使用教程

Helm Schema Gen 插件使用教程

helm-schema-gen So that you don't have to write values.schema.json by hand from scratch for your Helm 3 charts. [CURRENTLY NOT MAINTAINED] 项目地址: https://gitcode.com/gh_mirrors/he/helm-schema-gen

1. 项目介绍

helm-schema-gen 是一个 Helm 插件，旨在帮助 Helm 图表开发人员生成 JSON Schema 文件，以便自动验证 values.yaml 文件的结构。通过使用这个插件，开发者可以避免手动编写 values.schema.json 文件，从而简化 Helm 图表的开发流程。

该项目目前处于非维护状态，但仍然可以作为参考和学习使用。

2. 项目快速启动

2.1 安装 Helm 插件

首先，确保你已经安装了 Helm。然后，使用以下命令安装 helm-schema-gen 插件：

helm plugin install https://github.com/karuppiah7890/helm-schema-gen.git

安装完成后，你可以通过以下命令验证插件是否安装成功：

helm plugin list

你应该会看到 schema-gen 插件在列表中。

2.2 生成 JSON Schema

假设你有一个 Helm 图表，并且已经定义了 values.yaml 文件。你可以使用以下命令生成对应的 JSON Schema 文件：

helm schema-gen values.yaml > values.schema.json

生成的 values.schema.json 文件将包含 values.yaml 文件的结构定义，可以用于验证 values.yaml 文件的格式。

3. 应用案例和最佳实践

3.1 自动化验证

在 CI/CD 流程中，可以使用 helm-schema-gen 生成的 JSON Schema 文件来自动验证 values.yaml 文件的格式。例如，在 GitLab CI 中，可以添加以下步骤：

stages:
  - validate

validate_values:
  stage: validate
  script:
    - helm schema-gen values.yaml > values.schema.json
    - ajv validate -s values.schema.json -d values.yaml

3.2 版本控制

将生成的 values.schema.json 文件与 Helm 图表一起纳入版本控制，确保每次更新 values.yaml 文件时，都能生成最新的 JSON Schema 文件。

4. 典型生态项目

4.1 Helm

helm-schema-gen 是 Helm 生态系统中的一个插件，主要用于 Helm 图表的开发和验证。Helm 是 Kubernetes 的包管理工具，通过 Helm 图表，开发者可以轻松地部署和管理 Kubernetes 应用。

4.2 JSON Schema

JSON Schema 是一种用于描述和验证 JSON 数据的格式。helm-schema-gen 利用 JSON Schema 来验证 Helm 图表中的 values.yaml 文件，确保其格式符合预期。

4.3 Ajv

Ajv 是一个高性能的 JSON Schema 验证器，可以与 helm-schema-gen 结合使用，实现对 values.yaml 文件的自动化验证。

通过以上步骤，你可以快速上手并使用 helm-schema-gen 插件，简化 Helm 图表的开发和验证流程。

helm-schema-gen So that you don't have to write values.schema.json by hand from scratch for your Helm 3 charts. [CURRENTLY NOT MAINTAINED] 项目地址: https://gitcode.com/gh_mirrors/he/helm-schema-gen