Helm子Chart中CRD无法安装，求CRD模板化最佳实践及解决方案

问题背景 #

Helm官方文档建议待部署的CRD放在Chart的顶层crd目录下，现有目录结构如下：

app-charts
  |_ charts
      |_ app1
          |_ charts
              |_ internal-app1-chart-1
              |   |_ charts
              |   |_ templates
              |_ internal-app1-chart-2
              |   |_ charts
              |   |    |_ crd-chart-3
              |   |       |_ crds -----------> 此处CRD未安装
              |   |_ chart.yaml ------------> 通过条件添加CRD Chart作为依赖
              |_ crds  ---------------------> 顶层目录下的CRD可正常安装
              |_ chart.yaml 

明确需求 #

• CR存放在子Chart中，使用lookup模板函数验证CRD部署完成后再应用CR
• 将CRD移至crd-chart-3子Chart，通过crd-chart-3.enabled标志控制CRD部署
• 用同一个enabled标志禁用CR验证逻辑

当前遇到的问题 #

• 子Chartcrd-chart-3下的CRD无法被安装
• 顶层crd目录的CRD能正常安装，但无法进行模板化处理
• 找不到CRD模板化的官方最佳实践文档

解决方案 #

1. 修复子Chart CRD的安装问题 #

Helm只会自动安装顶层Chart和直接依赖的子Chart中crd目录下的CRD，嵌套层级较深的子Chart（比如crd-chart-3）的CRD不会被自动安装。要解决这个问题，需要在internal-app1-chart-2的chart.yaml中显式声明依赖并配置CRD安装策略：

# internal-app1-chart-2/chart.yaml
dependencies:
  - name: crd-chart-3
    version: "x.x.x"
    condition: crd-chart-3.enabled
    # 开启CRD安装传递，让Helm处理嵌套子Chart的CRD
    import-values:
      - child: crds
        parent: crds

同时确保crd-chart-3的Chart.yaml无CRD禁用配置，且crds目录下的CRD文件以.yaml结尾。

2. 实现CR的条件验证逻辑 #

在存放CR的子Chart模板中，结合crd-chart-3.enabled标志和lookup函数控制验证逻辑：

# 示例：CR模板文件
{{- if .Values.crd-chart-3.enabled }}
{{- $crd := lookup "apiextensions.k8s.io/v1" "CustomResourceDefinition" "" "your-crd-name.example.com" }}
{{- if not $crd }}
{{- fail "CRD未部署完成，请先安装CRD" }}
{{- end }}
{{- end }}
apiVersion: example.com/v1
kind: YourCR
metadata:
  name: example-cr
spec:
  # CR配置内容

当crd-chart-3.enabled设为false时，直接跳过验证渲染CR；设为true时，先检查CRD是否存在，不存在则终止部署。

3. 顶层CRD模板化处理建议 #

Helm会直接读取顶层crd目录下的文件而不渲染模板，要实现模板化可以这么做：

• 将CRD模板移到templates目录下，命名为crd-xxx.yaml
• 添加条件判断控制渲染：

{{- if .Values.installCRDs }}
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: your-crd-name.example.com
spec:
  # 可模板化的CRD配置，比如引用Values中的变量
  group: example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                replicaCount:
                  type: integer
                  default: {{ .Values.replicaCount }}
{{- end }}

通过installCRDs标志控制CRD的部署，同时实现配置的模板化。

内容的提问来源于stack exchange，提问作者Tim