Environment Variables

This helper function can help you organize environment variables in a pod with an object instead of an array.

TypeScript

import { EnvVar } from "kubernetes-models/v1/EnvVar";
import type { IEnvVarSource } from "kubernetes-models/v1/EnvVarSource";

export function envVars(
  envs: Record<string, string | IEnvVarSource>
): EnvVar[] {
  return Object.entries(envs).map(([name, value]) => {
    if (typeof value === "string") {
      return new EnvVar({ name, value });
    }

    return new EnvVar({ name, valueFrom: value });
  });
}

JavaScript (ESM)

import { EnvVar } from "kubernetes-models/v1/EnvVar";


export function envVars(
  envs
) {
  return Object.entries(envs).map(([name, value]) => {
    if (typeof value === "string") {
      return new EnvVar({ name, value });
    }

    return new EnvVar({ name, valueFrom: value });
  });
}

JavaScript (CJS)

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


function envVars(
  envs
) {
  return Object.entries(envs).map(([name, value]) => {
    if (typeof value === "string") {
      return new EnvVar({ name, value });
    }

    return new EnvVar({ name, valueFrom: value });
  });
}
exports.envVars = envVars;

Let's say you have some environment variables like this.

TypeScript

import { Pod } from "kubernetes-models/v1/Pod";

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: [
          { name: "NGINX_HOST", value: "foobar.com" },
          { name: "NGINX_PORT", value: "80" }
        ]
      }
    ]
  }
});

JavaScript (ESM)

import { Pod } from "kubernetes-models/v1/Pod";

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: [
          { name: "NGINX_HOST", value: "foobar.com" },
          { name: "NGINX_PORT", value: "80" }
        ]
      }
    ]
  }
});

JavaScript (CJS)

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

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: [
          { name: "NGINX_HOST", value: "foobar.com" },
          { name: "NGINX_PORT", value: "80" }
        ]
      }
    ]
  }
});

The env array can be replaced as an object with envVars function. It's much shorter and easier to maintain.

TypeScript

import { Pod } from "kubernetes-models/v1/Pod";

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: envVars({
          NGINX_HOST: "foobar.com",
          NGINX_PORT: "80"
        })
      }
    ]
  }
});

JavaScript (ESM)

import { Pod } from "kubernetes-models/v1/Pod";

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: envVars({
          NGINX_HOST: "foobar.com",
          NGINX_PORT: "80"
        })
      }
    ]
  }
});

JavaScript (CJS)

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

new Pod({
  spec: {
    containers: [
      {
        name: "nginx",
        image: "nginx",
        env: envVars({
          NGINX_HOST: "foobar.com",
          NGINX_PORT: "80"
        })
      }
    ]
  }
});

Plus, you can override environment variables with the spread syntax.

envVars({
  ...BASE_ENVS,
  NGINX_PORT: "8080"
});

Furthermore, you can define more helper functions to reduce more codes.

TypeScript

import { IEnvVarSource } from "kubernetes-models/v1/EnvVarSource";

export function envConfigMapRef(name: string, key: string): IEnvVarSource {
  return {
    configMapKeyRef: { name, key }
  };
}

export function envSecretRef(name: string, key: string): IEnvVarSource {
  return {
    secretKeyRef: { name, key }
  };
}

export function envFieldRef(path: string): IEnvVarSource {
  return {
    fieldRef: {
      fieldPath: path
    }
  };
}

JavaScript (ESM)

export function envConfigMapRef(name, key) {
  return {
    configMapKeyRef: { name, key }
  };
}

export function envSecretRef(name, key) {
  return {
    secretKeyRef: { name, key }
  };
}

export function envFieldRef(path) {
  return {
    fieldRef: {
      fieldPath: path
    }
  };
}

JavaScript (CJS)

function envConfigMapRef(name, key) {
  return {
    configMapKeyRef: { name, key }
  };
}
exports.envConfigMapRef = envConfigMapRef;

function envSecretRef(name, key) {
  return {
    secretKeyRef: { name, key }
  };
}
exports.envSecretRef = envSecretRef;

function envFieldRef(path) {
  return {
    fieldRef: {
      fieldPath: path
    }
  };
}
exports.envFieldRef = envFieldRef;

envVars({
  TIMEZONE: envConfigMapRef("my-app", "timezone"),
  PASSWORD: envSecretRef("my-app", "password"),
  POD_NAME: envFieldRef("metadata.name")
});