godaddy/kubernetes-client

Add config examples for constructing clients

Open

#220 opened on Mar 10, 2018

View on GitHub
 (10 comments) (1 reaction) (0 assignees)JavaScript (954 stars) (206 forks)batch import
help wantedrequest for example

Description

All the current examples rely on config.fromKubeconfig(). Add examples that manually specify some of the config options.

  1. create a new example in examples/. The goal is to illustrate how to use basic auth and provide an end-to-end working example. With that in mind, the example should construct a new client instance using basic auth, and make an API call (e.g., get Pods or Deployments) to illustrate functionality.
  2. Update README.md the More examples section to include the new example.

Contributor guide

Tech stack
javascriptnodejs
Domain
backendapidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsKubernetes basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Create a new example file in the examples/ directory (e.g., examples/basic auth.js) that demonstrates constructing a Kubernetes client using basic auth credentials instead of fromKubeconfig(). Then update the 'More examples' section in README.md to link to this new example. Refer to existing examples in the same directory for structure. Ensure the example makes an API call like getPods() to verify it works.