如何为Terraform CDK(TypeScript)声明的Kubernetes Service指定topologyKeys

自Kubernetes 1.17版本起，Service定义已支持alpha级别的topologyKeys字段，但Terraform Kubernetes Provider的官方文档及对应的Terraform CDK TypeScript SDK暂未支持该字段。在代码中尝试在Service spec中添加topologyKeys时，TypeScript报错：

对象字面量只能指定已知属性，且topologyKeys不存在于ServiceSpec类型中

解决方案 #

方法1：使用addOverride方法（推荐） #

Terraform CDK提供了addOverride方法，允许直接向资源添加未被SDK类型定义覆盖的字段，这是官方推荐的处理此类场景的方式。

修改后的代码如下：

import { Service } from "@cdktf/provider-kubernetes/lib/service";
import { Construct } from "constructs";

export class MyConstruct extends Construct {
  constructor(scope: Construct, name: string) {
    super(scope, name);

    const selector = {
      app: "my-app",
      name,
    };

    const myService = new Service(this, "my-service", {
      metadata: {
        labels: {
          app: "my-app",
          name,
        },
        name,
      },
      spec: {
        port: [
          {
            // 配置你的端口信息，示例如下：
            port: 80,
            targetPort: 8080,
            protocol: "TCP",
          },
        ],
        selector,
      },
    });

    // 添加topologyKeys字段，路径为spec.topologyKeys
    myService.addOverride("spec.topologyKeys", ["kubernetes.io/hostname"]);
    // 如需多个拓扑键，直接在数组中追加即可，示例：
    // myService.addOverride("spec.topologyKeys", ["kubernetes.io/hostname", "topology.kubernetes.io/zone"]);
  }
}

方法2：类型断言绕过TypeScript检查 #

如果只是临时绕过类型校验，可以将spec断言为any类型，跳过TypeScript的字段存在性检查：

import { Service } from "@cdktf/provider-kubernetes/lib/service";
import { Construct } from "constructs";

export class MyConstruct extends Construct {
  constructor(scope: Construct, name: string) {
    super(scope, name);

    const selector = {
      app: "my-app",
      name,
    };

    new Service(this, "my-service", {
      metadata: {
        labels: {
          app: "my-app",
          name,
        },
        name,
      },
      spec: {
        port: [
          {
            port: 80,
            targetPort: 8080,
            protocol: "TCP",
          },
        ],
        selector,
        // 为topologyKeys字段添加类型断言
        topologyKeys: ["kubernetes.io/hostname"] as any,
      } as any, // 将整个spec对象断言为any类型
    });
  }
}

注意：方法2会丢失TypeScript的类型校验能力，可能引入其他潜在错误，因此更推荐使用方法1。

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