如何通过Pulumi在Helm Chart中设置Null配置值

问题分析 #

用Pulumi Golang配置OpenTelemetry Collector Helm Chart时，尝试把prometheus receiver等配置设为nil或pulumi.Any(nil)来移除默认组件，但部署后默认配置依然存在。这是因为Pulumi的pulumi.Map会自动过滤掉nil值，不会将其转换为Helm所需的null值传递给Chart模板。

解决方案 #

要在Pulumi中正确传递null到Helm Chart，需要使用pulumi.Null类型显式标记该值为null。修改后的代码如下：

package main

import (
    helmv3 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/helm/v3"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := helmv3.NewChart(ctx, "otel-collect", helmv3.ChartArgs{
            Chart:   pulumi.String("opentelemetry-collector"),
            Version: pulumi.String("0.31.1"),
            FetchArgs: helmv3.FetchArgs{
                Repo: pulumi.String("https://open-telemetry.github.io/opentelemetry-helm-charts"),
            },
            Values: pulumi.Map{
                "fullnameOverride": pulumi.String("otel-collector"),
                "mode":             pulumi.String("deployment"),
                "config": pulumi.Map{
                    "receivers": pulumi.Map{
                        "jaeger": pulumi.Map{
                            "protocols": pulumi.Map{
                                "thrift_compact": pulumi.Null(pulumi.Bool), // 显式设置为null
                            },
                        },
                        "prometheus": pulumi.Null(pulumi.Map), // 显式将prometheus设为null
                    },
                    "service": pulumi.Map{
                        "pipelines": pulumi.Map{
                            "metrics": pulumi.Null(pulumi.Map), // 显式将metrics pipeline设为null
                        },
                    },
                },
            },
        })
        if err != nil {
            return err
        }

        return nil
    })
}

原理说明 #

• pulumi.Null(T)会生成一个pulumi.Input类型，明确告知Pulumi要将该值序列化为null，而非直接忽略。
• 针对不同的配置类型（比如Map、Bool等），需要传入对应的类型参数，确保序列化后的类型匹配Helm Chart模板的预期。
• 这样修改后，Helm模板会接收到null值，从而移除对应的默认组件。

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