Skip to content

otterscale/types

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OtterScale Types

Release npm License

TypeScript type definitions for Kubernetes and OtterScale custom resources.

@otterscale/types is a type-only package that gives the OtterScale frontend a type-safe view of every resource it works with — core Kubernetes kinds, common operators (KubeVirt, CDI, Rook Ceph, KServe, Flux), and OtterScale's own custom resources. The definitions are generated from the JSON Schemas served by the OtterScale API, so the types always track the platform's actual resource shapes.

Coverage

  • Core Kubernetes — Deployments, StatefulSets, DaemonSets, CronJobs, and the standard API groups (autoscaling, batch, networking, storage, RBAC, and more).
  • Operators — KubeVirt, CDI, Rook Ceph, KServe, and the Flux toolkit.
  • OtterScale custom resources — fleet, model, module, tenant, and workload kinds under the *.otterscale.io API groups.

Documentation

Generation and release details will be published in the project documentation. Because this is a declaration-only package, importing a type pulls in its interface with no runtime code.

Ecosystem

OtterScale Types is generated from the otterscale/api schemas and consumed by the OtterScale frontend. See the otterscale repository for an overview of the full project and its components.

Contributing

Contributions are welcome. A contribution guide (CONTRIBUTING.md) covering the schema-sync workflow will follow; until then, please open an issue or a pull request to get involved.

License

This project is licensed under the Apache License 2.0.

About

TypeScript types for Kubernetes generated from OpenAPI

Resources

License

Stars

Watchers

Forks

Contributors