54.8 MB
3,654 files
Updated about 1 month ago
Name
Size
admissionregistration
api
apiextensions
apiserverinternal
apps
authentication
authorization
autoscaling
batch
certificates
coordination
core
discovery
events
flowcontrol
meta
networking
node
policy
rbac
resource
scheduling
storage
storagemigration
README.md1.01 kB
xet
package.json323 Bytes
xet
runtime.d.ts1.51 kB
xet
version.d.ts319 Bytes
xet
README.md

kubernetes-types

This package provides TypeScript definitions for Kubernetes API types, generated from the Kubernetes OpenAPI definitions.

Example

import {Pod} from 'kubernetes-types/core/v1'
import {ObjectMeta} from 'kubernetes-types/meta/v1'

let metadata: ObjectMeta = {name: 'example', labels: {app: 'example'}}
let pod: Pod = {
  apiVersion: 'v1',
  kind: 'Pod', // 'v1' and 'Pod' are the only accepted values for a Pod

  metadata,

  spec: {
    containers: [
      /* ... */
    ],
  },
}

Versioning

As an NPM package, kubernetes-types follows semver. The major and minor version of the package will track the Kubernetes API version, while the patch version will follow updates to the generated types.

You should install the version of the types matching the Kubernetes API version you want to be compatible with. Consult NPM for the list of available versions of this package.

Total size
54.8 MB
Files
3,654
Last updated
Jul 22
Pre-warmed CDN
US EU US EU

Contributors