如何阻止Pulumi CLI打乱栈设置文件的配置顺序并删除YAML注释

你遇到的两个问题是Pulumi旧版本的已知行为：CLI默认重写栈配置文件时会重新序列化配置结构，不保留自定义键顺序和注释。以下是具体解决方案：

方案1：升级Pulumi CLI（最推荐） #

Pulumi从v3.21.0版本开始正式支持YAML格式保留特性，可原生保留栈配置文件的注释、自定义键排序，不需要额外配置。你当前使用的v3.17.1版本低于该特性发布版本，直接升级到最新稳定版即可解决两个问题。

方案2：无法升级版本的替代方案 #

如果受环境限制暂时不能升级CLI，可选择以下适配方案：

• 避免手动修改栈配置文件，统一使用pulumi config set命令管理配置，操作嵌套结构时使用--path参数指定字段路径，示例：

  # 设置存储账户名称
  pulumi config set ns:MainStorageAccountArgs.AccountName xxxsa
  # 设置数组类型参数
  pulumi config set --path ns:SpokeVirtualNetworkArgs.AddressPrefixes[0] 10.10.0.0/18
  

• 将结构化资源配置拆分到独立的YAML文件中存储，栈配置里仅保留该配置文件的路径，在Pulumi代码中通过YAML解析库读取独立配置文件。独立文件的格式、注释、排序完全由你自己控制，Pulumi CLI不会修改该文件。
• 若必须手动维护栈配置文件，可将文件纳入Git版本管理，每次执行Pulumi命令后通过git diff筛选有效变更，回退自动生成的格式调整、注释删除内容。

注意：升级CLI前建议先在非生产环境测试兼容性，Pulumi v3大版本内基本保持向后兼容，极少出现破坏性变更。

内容的提问来源于stack exchange，提问作者MD TAREQ HASSAN