@kubernetes/client-node

What is @kubernetes/client-node?

@kubernetes/client-node is an official Kubernetes client library for Node.js. It allows developers to interact with Kubernetes clusters programmatically, providing a way to manage Kubernetes resources, perform CRUD operations, and watch for changes in the cluster.

What are @kubernetes/client-node's main functionalities?

CRUD Operations on Kubernetes Resources

This feature allows you to perform CRUD operations on Kubernetes resources. The code sample demonstrates how to list all pods in the default namespace.

const k8s = require('@kubernetes/client-node');
const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const k8sApi = kc.makeApiClient(k8s.CoreV1Api);

// List all pods in the default namespace
k8sApi.listNamespacedPod('default').then((res) => {
  console.log(res.body);
});

Watch for Changes in the Cluster

This feature allows you to watch for changes in the Kubernetes cluster. The code sample demonstrates how to watch for changes in pods in the default namespace.

const k8s = require('@kubernetes/client-node');
const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const watch = new k8s.Watch(kc);

// Watch for changes in pods in the default namespace
watch.watch('/api/v1/namespaces/default/pods', {},
  (type, obj) => {
    console.log(`Type: ${type}`);
    console.log(`Object: ${JSON.stringify(obj)}`);
  },
  (err) => {
    console.error(err);
  }
);

Custom Resource Definitions (CRDs)

This feature allows you to interact with Custom Resource Definitions (CRDs). The code sample demonstrates how to list all custom resources of a specific type in the default namespace.

const k8s = require('@kubernetes/client-node');
const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const customObjectsApi = kc.makeApiClient(k8s.CustomObjectsApi);

// List all custom resources of a specific type
customObjectsApi.listNamespacedCustomObject('example.com', 'v1', 'default', 'examples').then((res) => {
  console.log(res.body);
});

Other packages similar to @kubernetes/client-node

kubernetes-client

The 'kubernetes-client' package, also known as 'node-kubernetes-client', is another Node.js client for Kubernetes. It provides similar functionalities to @kubernetes/client-node, such as managing Kubernetes resources and performing CRUD operations. However, it is not an official client library and may have different API conventions and support.

k8s

The 'k8s' package is a lightweight Kubernetes client for Node.js. It offers basic functionalities for interacting with Kubernetes clusters, such as listing, creating, and deleting resources. Compared to @kubernetes/client-node, it is simpler and may lack some advanced features but can be easier to use for basic tasks.

README

The README file is missing