如何使用Pulumi Transformations精准修改K8s清单中的特定环境变量

问题场景 #

我需要通过Pulumi Transformations更新Kubernetes清单里的环境变量值，当前清单的容器环境变量部分如下：

containers:
        - name: pgbouncer
          image: edoburu/pgbouncer:1.15.0
          env:
          # order of env vars should not change because pulumi code depends on it
          - name: DATABASE_URL
            value: 'psql://${username}:${password}@${endpoint}/${name}'
          - name: POOL_MODE
            value: 'transaction'
          - name: MAX_CLIENT_CONN
            value: '50'
          - name: ADMIN_USERS
            value: '${username}'

目前我是通过数组索引的方式修改值，但这种方式可读性差，后续如果环境变量顺序变动就会出错：

const pg_bouncer_reader = new k8s.yaml.ConfigFile("pg-bouncer-reader", {
    file: "../../pulumi-common/pg-bouncer.deployment.yaml",
    transformations: [
      (obj: any) => {
        obj.spec.template.spec.containers[0].env[0].value = readerConnectionString;
        obj.spec.template.spec.containers[0].env[3].value = defaultCluster.masterUsername;
      },
    ],
  });

想知道是否支持类似obj.spec.template.spec.containers[0].env[name = 'DATABASE_URL']的语法来定位YAML列表元素？

解决方案 #

JavaScript/TypeScript原生不支持你提到的那种直接按属性值定位数组元素的语法，但可以用数组的find()方法实现按环境变量名称精准定位，完全替代索引的方式，代码更健壮且可读性更高。

改造后的代码示例 #

const pg_bouncer_reader = new k8s.yaml.ConfigFile("pg-bouncer-reader", {
    file: "../../pulumi-common/pg-bouncer.deployment.yaml",
    transformations: [
      (obj: any) => {
        const container = obj.spec.template.spec.containers[0];
        // 按name查找DATABASE_URL并更新value
        const dbUrlEnv = container.env.find((e: any) => e.name === 'DATABASE_URL');
        if (dbUrlEnv) {
          dbUrlEnv.value = readerConnectionString;
        }
        // 按name查找ADMIN_USERS并更新value
        const adminUsersEnv = container.env.find((e: any) => e.name === 'ADMIN_USERS');
        if (adminUsersEnv) {
          adminUsersEnv.value = defaultCluster.masterUsername;
        }
      },
    ],
  });

进一步优化：封装复用函数 #

如果需要多次修改环境变量，可以封装一个小函数来避免重复代码：

const updateEnvVar = (envList: any[], varName: string, newValue: string) => {
  const envVar = envList.find(e => e.name === varName);
  if (envVar) {
    envVar.value = newValue;
  }
};

const pg_bouncer_reader = new k8s.yaml.ConfigFile("pg-bouncer-reader", {
    file: "../../pulumi-common/pg-bouncer.deployment.yaml",
    transformations: [
      (obj: any) => {
        const containerEnv = obj.spec.template.spec.containers[0].env;
        updateEnvVar(containerEnv, 'DATABASE_URL', readerConnectionString);
        updateEnvVar(containerEnv, 'ADMIN_USERS', defaultCluster.masterUsername);
      },
    ],
  });

这种方式完全不依赖环境变量的顺序，即使清单里的env顺序变动，代码也能正常工作，同时可读性和可维护性都大幅提升。

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