Sidecar

This helper function can help you inject sidecar with less code.

For example, if you want to inject an Envoy container to your deployment, you can define a helper function as below.

TypeScript

import type { IPodSpec } from "kubernetes-models/v1";

export function withEnvoy(spec: IPodSpec): IPodSpec {
  return {
    ...spec,
    containers: [
      ...spec.containers,
      {
        name: "envoy",
        image: "envoyproxy/envoy"
      }
    ]
  };
}

JavaScript (ESM)

export function withEnvoy(spec) {
  return {
    ...spec,
    containers: [
      ...spec.containers,
      {
        name: "envoy",
        image: "envoyproxy/envoy"
      }
    ]
  };
}

JavaScript (CJS)

function withEnvoy(spec) {
  return {
    ...spec,
    containers: [
      ...spec.containers,
      {
        name: "envoy",
        image: "envoyproxy/envoy"
      }
    ]
  };
}
exports.withEnvoy = withEnvoy;

And then you can use it in your deployment.

TypeScript

import { Deployment } from "kubernetes-models/apps/v1/Deployment";

new Deployment({
  spec: {
    template: {
      spec: withEnvoy({
        containers: [
          {
            name: "my-app",
            image: "my-app"
          }
        ]
      })
    }
  }
});

JavaScript (ESM)

import { Deployment } from "kubernetes-models/apps/v1/Deployment";

new Deployment({
  spec: {
    template: {
      spec: withEnvoy({
        containers: [
          {
            name: "my-app",
            image: "my-app"
          }
        ]
      })
    }
  }
});

JavaScript (CJS)

const { Deployment } = require("kubernetes-models/apps/v1/Deployment");

new Deployment({
  spec: {
    template: {
      spec: withEnvoy({
        containers: [
          {
            name: "my-app",
            image: "my-app"
          }
        ]
      })
    }
  }
});