README
kubernetes-models-ts
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
- @kubernetes-models/argo-cd - Argo CD models.
- @kubernetes-models/cert-manager - cert-manager models.
- @kubernetes-models/cilium - Cilium CRD.
- @kubernetes-models/contour - Contour models.
- @kubernetes-models/flux-cd - Flux CD models.
- @kubernetes-models/gke - Google Kubernetes Engine (GKE) models.
- @kubernetes-models/grafana-agent-operator - Grafana agent operator models.
- @kubernetes-models/grafana-operator - Grafana operator models.
- @kubernetes-models/istio - Istio models.
- @kubernetes-models/jaeger-operator - Jaeger operator models.
- @kubernetes-models/kapp-controller - Carvel kapp contoller models.
- @kubernetes-models/knative - Knative models.
- @kubernetes-models/prometheus-operator - Prometheus operator models.
- @kubernetes-models/sealed-secrets - sealed-secrets models.
- @kubernetes-models/spiffe - SPIFFE models.
- @kubernetes-models/thanos-operator - Thanos operator models.
- @kubernetes-models/victoria-metrics-operator - VictoriaMetrics operator 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/base - Base model for Kubernetes models.
- @kubernetes-models/export-map - Generate and inject export map.
- @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