npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pubgcorp/kubectl-node

v1.5.0

Published

Limited and partial implementation of kubectl.

Downloads

38

Readme

kubectl-node

Limited and partial implementation of kubectl.

⚠️ Caution ⚠️

"kubectl-node" uses server-side-apply to modify resources. Modification by "kubectl-node" may cause conflict.

Install

# NPM
npm install @pubgcorp/kubectl-node

# YARN
yarn add @pubgcorp/kubectl-node

Basic Usage

Create kubectl instance

Javascript

const fs = require("fs");
const os = require("os");
const yaml = require("js-yaml"); // if you use js-yaml, need to install

const { NewKubectl } = require("@pubgcorp/kubectl-node");
// kubeconfig sample

const kubeconfig = yaml.load(fs.readFileSync(`${os.homedir()}/.kube/config`, "utf8"));
const kubectl = NewKubectl(kubeconfig)

Typescript

import * as fs from "fs"
import * as os from "os"
import * as yaml from "js-yaml" // if you use js-yaml, need to install

import { NewKubectl, KubeConfig } from "@pubgcorp/kubectl-node";
// kubeconfig sample

const kubeconfig = yaml.load(fs.readFileSync(`${os.homedir()}/.kube/config`, "utf8")) as KubeConfig;
const kubectl = NewKubectl(kubeconfig)

kubectl api-resources, api-versions, version

Get api-resources, api-versions and version from cluster

const apiResources = await kubectl.apiResources();
const apiVersions = await kubectl.apiVersions();
const version = await kubectl.version();

kubectl get

Get single resource

// get without namespace (search `default` namespace by default);
//  => equivalant to `kubectl.get('deployment', 'nginx', { namespace: "default" })`;
const result = await kubectl.get('deployment', 'nginx');
// get with namespace
const result = await kubectl.get('deployment', 'nginx', { namespace: 'my-namespace' });

kubectl list

Get collection of resources

// list without namespace (search `default` namespace by default);
const result = await kubectl.list('deployment');
// list with namespace
const namespace = "my-namespace";
const result = await kubectl.list('deployment', { namespace });
// list all resources in all namespaces
const result = await kubectl.list('deployment', { allNamespaces: true });
// list with labelSelector
const result1 = await kubectl.list('deployment', { allNamespaces: true, labelSelector: { app: 'nginx' }});
const result2 = await kubectl.list('deployment', { allNamespaces: true, labelSelector: { app: { op: 'In', values: ['nginx'] } }});
// list with fieldSelector
const result1 = await kubectl.list('pod', { allNamespaces: true, fieldSelector: [{ path: 'spec.nodeName', op: 'Equal', value: 'docker-desktop' }] })
const result2 = await kubectl.list('pod', { allNamespaces: true, fieldSelector: [{ path: 'status.podIP', op: 'NotEqual', value: '10.1.0.8' }] })
const result3 = await kubectl.list('pod', { allNamespaces: true, labelSelector: { tier: 'control-plane' }, fieldSelector: [{ path: 'status.podIP', op: 'NotEqual', value: '10.1.0.8' }] })

kubectl scale

Scale single resource if resource"s spec.replicas exists and spec.replicas is number

// scale without namespace
const result = await kubectl.scale('deployment', 'nginx', 2);
// scale with namespace
const namespace = "my-namespace";
const result = await kubectl.scale('deployment', 'nginx', 2, { namespace });

kubectl patch

Patch single resource

Sequence

  1. Get resource from remort
  2. Apply json-patch locally
  3. Apply the modification through server-side-apply patch.

See json-patch for additional information.

// patch without namespace
const result = await kubectl.patch('deployment', 'nginx', [{ op: "add", path: "/metadata/annotations", value: { key1: "value1" } }]);
// patch with namespace
const namespace = "my-namespace";
const result = await kubectl.scale('deployment', 'nginx', [{ op: "add", path: "/metadata/annotations", value: { key1: "value1" } }], { namespace });

kubectl delete

Delete single resource

// delete without namespace
const result = await kubectl.delete('deployment', 'nginx');
// delete with namespace
const namespace = "my-namespace";
const result = await kubectl.delete('deployment', 'nginx', { namespace });

kubectl apply

const objects = [
    {
        "apiVersion": "apps/v1",
        "kind": "Deployment",
        "metadata": {
            "labels": {
                "app": "nginx"
            },
            "name": "nginx",
            "namespace": "default"
        },
        "spec": {
            "selector": {
                "matchLabels": {
                    "app": "nginx"
                }
            },
            "template": {
                "metadata": {
                    "labels": {
                        "app": "nginx"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "image": "nginx",
                            "name": "nginx"
                        }
                    ]
                }
            }
        }
    },
    {
        "apiVersion": "apps/v1",
        "kind": "Deployment",
        "metadata": {
            "labels": {
                "app": "nginx"
            },
            "name": "nginx",
            "namespace": "my-namespace",
        },
        "spec": {
            "selector": {
                "matchLabels": {
                    "k8s-app": "nginx"
                }
            },
            "template": {
                "metadata": {
                    "labels": {
                        "k8s-app": "nginx"
                    }
                },
                "spec": {
                    "containers": [
                        {
                            "image": "nginx",
                            "name": "nginx"
                        }
                    ]
                }
            }
        }
    }
]
const result = await kubectl.apply(objects);

To-Dos

  • [ ] (Not sure) Support list resources using get (= conbine list and get)
  • [ ] (Not sure) Support delete with labelSelect
  • [ ] (Not sure) Support other methods (create, label, annotate, taint, drain, cordon, uncordon, etc.)