Garden项目中Pulumi多变量文件合并问题的分析与解决

在基础设施即代码(IaC)领域，Garden和Pulumi是两个重要的工具。Garden作为一个开发自动化平台，能够与Pulumi集成，用于部署云基础设施。然而，在实际使用中，开发者发现了一个关于Pulumi变量文件合并的重要问题。

问题背景

当使用Garden部署Pulumi项目时，可以通过pulumiVarFiles配置项指定一个或多个变量文件。按照Garden文档说明，这些变量文件中的配置项不需要嵌套在config字段下，而是可以直接在顶层定义。然而，这种设计在处理Pulumi特有的元数据配置时出现了问题。

Pulumi的密钥管理功能需要两个特殊的顶层配置项：

• secretsprovider：指定密钥管理服务的URI
• encryptedkey：加密密钥内容

这些配置项不属于应用配置，而是Pulumi运行时的元数据设置。按照Pulumi的要求，它们应该直接位于文件顶层，而不是嵌套在config字段下。

问题表现

当前Garden在合并多个Pulumi变量文件时，会将所有配置项（包括上述元数据配置）都放入config字段下。这导致生成的配置文件结构不符合Pulumi的要求，使得密钥管理功能无法正常工作。

错误的结构示例：

config:
  secretsprovider: gcpkms://...  # 错误位置
  encryptedkey: AQICAH...       # 错误位置
  someOtherConfig: value

而正确的结构应该是：

secretsprovider: gcpkms://...    # 应该在顶层
encryptedkey: AQICAH...         # 应该在顶层
config:
  someOtherConfig: value        # 应用配置

解决方案

Garden团队认识到这是一个重要的功能缺陷，并迅速采取了行动。由于这个修改会影响现有配置文件的结构，属于破坏性变更，团队决定：

1. 首先通过特性标志引入新行为
2. 在下一个主要版本中默认启用新行为
3. 确保修改同时支持Garden 0.13.x的模块配置和新的Action配置

解决方案的核心是改进变量文件合并逻辑，使其能够识别并保留Pulumi特定的元数据配置项在顶层，同时将其他应用配置放入config字段下。

实施与验证

开发者可以通过以下步骤验证修复：

1. 更新到包含修复的边缘版本
2. 检查合并后的配置文件结构是否符合预期
3. 确认Pulumi的密钥管理功能正常工作

团队已经确认该修复在Garden 0.13.x版本中工作正常，并计划在次年年初的正式版本中包含此修复。

技术启示

这个案例展示了工具集成时可能遇到的微妙问题。虽然Garden的设计简化了普通配置项的管理，但未能考虑到Pulumi特有的元数据需求。这提醒我们，在工具集成时：

1. 需要深入理解被集成工具的特殊需求
2. 破坏性变更需要谨慎处理，通过特性标志逐步推出
3. 保持向后兼容性对用户迁移至关重要

对于使用Garden和Pulumi的开发者来说，这个修复意味着现在可以无缝地使用Pulumi的全部功能，包括重要的密钥管理特性，同时享受Garden提供的自动化部署优势。