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

@npm-wharf/auto-kubernetes-client

v0.6.1

Published

NodeJS Kubernetes Client with automatic API discovery

Downloads

5

Readme

auto-kubernetes-client Build Status Greenkeeper badge

NodeJS Kubernetes Client with automatic API discovery.

See this blog post for further information.

Installation

npm install --save auto-kubernetes-client

Usage

  1. Create a configuration object

    const config = {
        url: 'https://k8s.example.com',
        ca: 'PEM encoded CA certificate',
        cert: 'PEM encoded client certificate',
        key: 'PEM encoded client key'
    }
  2. Create the client and connect to the API server

    const AutoK8sClient = require('auto-kubernetes-client');
    AutoK8sClient(config, function(err, client) {
        if (err) {
            throw new Error(`Error when connecting: ${err.message}`);
        }
    
        // Use client
    });
  3. Invoke methods

    The client exposes resources available to the authenticated user using a fairly regular API.

    • API groups need to be selected using the group(name[, version]) method. The "core" API is available directly on the client instance.
    • Non-namespaced resources are available directly on the API instance (core/group), for namespaced-resources one must explicitly select the namespace using the ns(name) method.
    • Resource collections are available by their name in plural, for example client.ns('default').pods represents the "pods" resource collection. Resource collections offer resource methods list, watch, and deletecollection, as well as create to create a new resource.
    • Single (non-collection) resources are available by their singular name, for example client.ns('default').pod('pod1') represents the "pod" resources for the "pod1" pod. Single resources offer resource methods get, create, update, patch and delete.
    • Resource methods typically have the signature method([qs]), where qs is a hash for additional query parameters, and return a promise for the parsed response entity.
    • The watch resource method has the signature watch([resourceVersion[, qs]]), and returns an object stream for the observed changes. Each object has a type field ('ADDED', 'DELETED', 'MODIFIED', 'ERROR'), and the actual object that was modified.
    • By default the client interprets 'Status' responses from the server with a 'Failure' status as error responses, and translates them into actual promise rejections. This can be disabled by using '.options({ rawResponse: true}).resourceMethod(...)' on the resource collection or resource.

Examples

| Example | Description |---------|------------ |examples/list-pods|List all pods in the cluster |examples/watch-pods|Watch all pods in a specific namespace

License

This software is licensed under the Apache 2 license, quoted below.

Copyright 2017 Collaborne B.V. <http://github.com/Collaborne/>

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.