Kosko

Write Less

Reuse variables, functions or any JavaScript libraries. Write Kubernetes manifests with less code. Eliminate duplicated YAML snippets here and there.

apiVersion: apps/v1
kind: Deployment
spec:
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app

apiVersion: v1
kind: Service
metadata:
  name: my-app
spec:
  selector:
    app: my-app
  ports:
    - port: 80
      targetPort: 8080

Deploy Everywhere

Stop copy and paste when deploying to a new Kubernetes cluster. In Kosko, manifests are split into components and environments. It's faster to create a new environment file than copy and modify existing YAML files.

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

const params = env.component("nginx");

export default new Deployment({
  metadata: { name: "nginx", namespace: params.namespace },
  spec: {
    replicas: params.replicas,
    template: {
      spec: {
        containers: [{ name: "nginx", image: params.image }]
      }
    }
  }
});

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx
  namespace: prod
spec:
  replicas: 15
  template:
    spec:
      containers:
        - name: nginx
          image: nginx:stable

Type Safe

Kosko automatically validates manifests against Kubernetes OpenAPI schema, which helps you locate issues before applying to clusters.

With TypeScript support, you can get type definitions, documentation, autocomplete suggestions and more right in your editors.

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

export default new Deployment({
  metadata: { name: "my-app" },
  spec: {
    replicas: "wrong_replicas"(property) IDeploymentSpec["replicas"]?: number
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
,
    selector: {
      matchLabels: { app: "my-app" }
    }
  }
});

Type 'string' is not assignable to type 'number'.

ts(2322)

Find Issues

Besides checking if a field should be a number or a string, Kosko can find issues such as missing namespaces, invalid pod selectors, require container probes, and much more!

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

export default new Deployment({
  metadata: { name: "nginx" },
  spec: {
    selector: { matchLabels: { app: "nginx" } },
    template: {
      metadata: { name: "nginx" },
      spec: {
        containers: [{ name: "nginx", image: "nginx:stable" }]
      }
    }
  }
});

Pod selector must match template labels.

valid-pod-selector