kubernetes-models-ts icon indicating copy to clipboard operation
kubernetes-models-ts copied to clipboard

Kubernetes models in TypeScript.

kubernetes-models-ts

Test

Kubernetes models in TypeScript.

Installation

Install with npm.

npm install kubernetes-models

Usage

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

// Create a new instance
const pod = new Pod({
  metadata: {
    name: "foo"
  },
  spec: {
    containers: []
  }
});

// Validate against JSON schema
pod.validate();

See examples folder for more examples.

Packages

Models

  • kubernetes-models - Kubernetes models.
  • @kubernetes-models/apimachinery - Types for Kubernetes API objects.

3rd-party Models

Generators

  • @kubernetes-models/crd-generate - Generate Kubernetes models for custom resource definitions (CRD).
  • @kubernetes-models/openapi-generate - Generate Kubernetes models from OpenAPI schema.

Runtime Dependencies

  • @kubernetes-models/base - Base model for Kubernetes models.
  • @kubernetes-models/validate - Validation library for Kubernetes models.

Utilities

  • @kubernetes-models/generate - Type declarations and utilities for Kubernetes model generation.
  • @kubernetes-models/read-input - Read input from file, URL or stdin.
  • @kubernetes-models/string-util - Utility functions for strings.

License

MIT