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.

Usage with zod

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

const pod: unknown = {
  apiVersion: "v1",
  kind: "Pod",
  spec: {
    containers: []
  }
};

// Validate against zod schema
iPodSchema.parse(pod);

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/argo-rollouts - Argo Rollouts models.
• @kubernetes-models/autoscaler - Kubernetes Autoscaler models.
• @kubernetes-models/cert-manager - cert-manager models.
• @kubernetes-models/cilium - Cilium CRD.
• @kubernetes-models/contour - Contour models.
• @kubernetes-models/elastic-cloud - Elastic Cloud on Kubernetes (ECK) models.
• @kubernetes-models/envoy-gateway - Envoy Gateway models.
• @kubernetes-models/external-secrets - External secrets models.
• @kubernetes-models/flagger - Flagger models.
• @kubernetes-models/flux-cd - Flux CD models.
• @kubernetes-models/gateway-api - Gateway API 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/hierarchical-namespaces - Hierarchical Namespace models.
• @kubernetes-models/istio - Istio models.
• @kubernetes-models/jaeger-operator - Jaeger operator models.
• @kubernetes-models/k8ssandra-operator - K8ssandra models.
• @kubernetes-models/kapp-controller - Carvel kapp contoller models.
• @kubernetes-models/karpenter - Karpenter models.
• @kubernetes-models/keda - KEDA models.
• @kubernetes-models/knative - Knative models.
• @kubernetes-models/kubedb - KubeDB models.
• @kubernetes-models/kyverno - Kyverno models.
• @kubernetes-models/linkerd - Linkerd models.
• @kubernetes-models/nats - NATS models.
• @kubernetes-models/pipelines-as-code - Pipelines-as-Code models.
• @kubernetes-models/postgres-operator - PostgreSQL operator models.
• @kubernetes-models/prometheus-operator - Prometheus operator models.
• @kubernetes-models/rabbitmq-cluster-operator - RabbitMQ cluster operator models.
• @kubernetes-models/rabbitmq-messaging-topology-operator - RabbitMQ Messaging Topology Operator models.
• @kubernetes-models/redis-operator - Redis Operator models.
• @kubernetes-models/sealed-secrets - sealed-secrets models.
• @kubernetes-models/seldon-core-operator - SeldonCore operator models.
• @kubernetes-models/shipwright - Shipwright CRD.
• @kubernetes-models/smi - Service Mesh Interface (SMI) models.
• @kubernetes-models/spicedb - SpiceDB models.
• @kubernetes-models/spiffe - SPIFFE models.
• @kubernetes-models/thanos-operator - Thanos operator models.
• @kubernetes-models/tidb-operator - TiDB Operator models.
• @kubernetes-models/traefik - Traefik 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/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.

Kubernetes vertsion update

Update the desired version in Makefile from kubernetes-openapi-spec folder and than run make all. After that update the versions in first-party/apimachinery and first-party/kubernetes-models generate scripts accordingly.

License

MIT

Публикация новой версии

В первый раз нужно сгенерировать токен на github с правами read:user, repo:status и положить его в переменную GITHUB_TOKEN файла .env Зайти на https://github.com/settings/tokens и создать. Выполнить pnpm changeset выбрать нужные пакеты Выполнить pnpm exec changeset version выбрать тип обновления major/minor/patch Выполнить pnpm run clean для очистки лишнего Выполнить pnpm run build для сборки всех пакетов, то что не обновлялось будет закешировано Выполнить публикацию на npm pnpm publish -r --access public --no-git-checks

Q: Пишет need auth You need to authorize this machine using npm adduser A: создать акк на npm и авторизоваться npm adduser

Q: Пишет например ERR! 404 Not Found - PUT https://registry.npmjs.org/@soft-stech%2fkubernetes-models - Not found A: Проверить что у юзера npm есть права на организацию soft-stech или на пакет