KubernetesJS

TypeScript Client for Kubernetes

KubernetesJS is a fully-typed, zero-dependency TypeScript library designed to simplify interactions with Kubernetes APIs. With comprehensive TypeScript support, it provides a strongly-typed interface that makes managing Kubernetes resources clear and predictable, ideal for TypeScript developers looking to integrate Kubernetes management into their applications.

Features

• 🔒 Fully Typed: Complete TypeScript definitions for all functions and models for an enhanced development experience.
• 🚀 Zero Dependencies: Works out of the box without the need for additional installations.
• 📡 Full Kubernetes API Coverage: Supports all Kubernetes API endpoints with detailed TypeScript types.
• 🌐 Cross-Platform: Works with both Node.js and browser environments.

Installation

To install KubernetesJS, you can use npm or yarn:

npm install kubernetesjs
# or
yarn add kubernetesjs

Example

import { KubernetesClient } from "kubernetesjs";

const client = new KubernetesClient({
  restEndpoint: 'http://127.0.0.1:8001'
});

client.listCoreV1NamespacedPod({
  path: {
    namespace: 'default'
  },
  query: {
    // Add any necessary query parameters here
  }
}).then(result => {
  if (result.items && result.items.length) {
    result.items.forEach(item => {
      console.log('NODE:', item.spec.nodeName);

      const initContainers = item.status.initContainerStatuses?.map(ic => ({
        image: ic.image,
        name: ic.name,
        ready: ic.ready,
        state: ic.state
      }));

      const containers = item.status.containerStatuses?.map(c => ({
        image: c.image,
        name: c.name,
        ready: c.ready,
        state: c.state
      }));

      console.log({ containers });
      console.log({ initContainers });
    });
  }
}).catch(reason => {
  console.error('Failed to fetch pods:', reason);
});

Related

Checkout these related projects:

• schema-typescript
  Provides robust tools for handling JSON schemas and converting them to TypeScript interfaces with ease and efficiency.
• @schema-typescript/cli
  CLI is the command line utility for schema-typescript.
• schema-sdk
  Provides robust tools for handling OpenAPI schemas and converting them to TypeScript clients with ease and efficiency.
• starship Unified Testing and Development for the Interchain.

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.