Merge upstream to browser

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,68 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+# ******** NOTE ********
+
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '35 14 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Kubernetes Javascript Client - Validation
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '14', '12', '10' ]
+    name: Node ${{ matrix.node }} validation
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      # Pre-check to validate that versions match between package.json
+      # and package-lock.json. Needs to run before npm install
+      - run: node version-check.js
+      - run: npm install
+      - run: npm test
+      - run: npm run lint
+

OWNERS

@@ -1,9 +1,9 @@
 # See the OWNERS docs at https://go.k8s.io/owners
 approvers:
 - brendandburns
-- mbohlool
 reviewers:
 - brendandburns
-- mbohlool
 - drubin
 - itowlson 
+emeritus_approvers:
+- mbohlool # 10/22/2020

README.md

@@ -1,6 +1,6 @@
 # Javascript Kubernetes Client information
 
-[![Build Status](https://travis-ci.org/kubernetes-client/javascript.svg?branch=master)](https://travis-ci.org/kubernetes-client/javascript)
+[![Build Status](https://github.com/kubernetes-client/javascript/workflows/Kubernetes%20Javascript%20Client%20-%20Validation/badge.svg)](https://github.com/kubernetes-client/javascript/actions)
 [![Client Capabilities](https://img.shields.io/badge/Kubernetes%20client-Gold-blue.svg?style=flat&colorB=FFD700&colorA=306CE8)](http://bit.ly/kubernetes-client-capabilities-badge)
 [![Client Support Level](https://img.shields.io/badge/kubernetes%20client-beta-green.svg?style=flat&colorA=306CE8)](http://bit.ly/kubernetes-client-support-badge)
 
@@ -103,6 +103,33 @@ const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
 There are several more examples in the [examples](https://github.com/kubernetes-client/javascript/tree/master/examples) directory.
 
+# Compatibility
+
+Prior to the `0.13.0` release, release versions did not track Kubernetes versions. Starting with the `0.13.0`
+release, we will increment the minor version whenever we update the minor Kubernetes API version 
+(e.g. `1.19.x`) that this library is generated from.
+
+Generally speaking newer clients will work with older Kubernetes, but compatability isn't 100% guaranteed.
+
+| client version | older versions | 1.18 | 1.19 |
+|----------------|----------------|------|------|
+|  0.12.3        |       -        |  ✓   |  x   |
+|  0.13.0        |       -        |  +   |  ✓   |
+
+Key: 
+
+* `✓` Exactly the same features / API objects in both javascript-client and the Kubernetes
+  version.
+* `+` javascript-client has features or api objects that may not be present in the
+  Kubernetes cluster, but everything they have in common will work.
+* `-` The Kubernetes cluster has features the javascript-client library can't use
+  (additional API objects, etc).
+* `x` The Kubernetes cluster has no guarantees to support the API client of
+  this version, as it only promises _n_-2 version support. It is not tested,
+  and operations using API versions that have been deprecated and removed in
+  later server versions won't function correctly.
+
+
 # Development
 
 All dependencies of this project are expressed in its

examples/cache-example.js

@@ -5,7 +5,7 @@ kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
-const path = '/api/v1/namespaces/default/pods';
+const path = '/api/v1/pods';
 const watch = new k8s.Watch(kc);
 
 const listFn = () => k8sApi.listPodForAllNamespaces()

examples/ingress.js

@@ -0,0 +1,27 @@
+const k8s = require('@kubernetes/client-node')
+const kc = new k8s.KubeConfig()
+kc.loadFromDefault()
+
+const k8sApi = kc.makeApiClient(k8s.NetworkingV1beta1Api) // before 1.14 use extensions/v1beta1
+const clientIdentifier = 'my-subdomain'
+
+k8sApi.createNamespacedIngress('default', {
+  apiVersions: 'networking.k8s.io/v1beta1',
+  kind: 'Ingress',
+  metadata: { name: `production-custom-${clientIdentifier}` },
+  spec: {
+    rules: [{
+      host: `${clientIdentifier}.example.com`,
+      http: {
+        paths: [{
+          backend: {
+            serviceName: 'production-auto-deploy',
+            servicePort: 5000
+          },
+          path: '/'
+        }]
+      }
+    }],
+    tls: [{ hosts: [`${clientIdentifier}.example.com`] }]
+  }
+}).catch(e => console.log(e))

examples/patch-example.js

@@ -0,0 +1,23 @@
+const k8s = require('@kubernetes/client-node');
+
+const kc = new k8s.KubeConfig();
+kc.loadFromDefault();
+
+const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
+
+k8sApi.listNamespacedPod('default')
+    .then((res) => {
+        const patch = [
+            {
+                "op": "replace",
+                "path":"/metadata/labels",
+                "value": {
+                    "foo": "bar"
+                }
+            }
+        ];
+        const options = { "headers": { "Content-type": k8s.PatchUtils.PATCH_FORMAT_JSON_PATCH}};
+        k8sApi.patchNamespacedPod(res.body.items[0].metadata.name, 'default', patch, undefined, undefined, undefined, undefined, options)
+            .then(() => { console.log("Patched.")})
+            .catch((err) => { console.log("Error: "); console.log(err)});
+    });

examples/scale-deployment.js

@@ -0,0 +1,22 @@
+const k8s = require('@kubernetes/client-node');
+
+const kc = new k8s.KubeConfig();
+kc.loadFromDefault();
+
+const k8sApi = kc.makeApiClient(k8s.AppsV1Api);
+
+const targetDeploymentName = 'docker-test-deployment';
+
+async function scale(namespace, name, replicas) {
+  // find the particular deployment
+  const res = await k8sApi.readNamespacedDeployment(name, namespace);
+  let deployment = res.body;
+
+  // edit
+  deployment.spec.replicas = replicas;
+
+  // replace
+  await k8sApi.replaceNamespacedDeployment(name, namespace, deployment);
+}
+
+scale('default', 'docker-test-deployment', 3);

examples/top.js

@@ -0,0 +1,8 @@
+const k8s = require('../dist/index');
+
+const kc = new k8s.KubeConfig();
+kc.loadFromDefault();
+
+const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
+
+k8s.topNodes(k8sApi).then((obj) => console.log(obj));

examples/typescript/apply/apply-example.ts

@@ -0,0 +1,43 @@
+import * as k8s from '@kubernetes/client-node';
+import * as fs from 'fs';
+import * as yaml from 'js-yaml';
+import { promisify } from 'util';
+
+/**
+ * Replicate the functionality of `kubectl apply`.  That is, create the resources defined in the `specFile` if they do
+ * not exist, patch them if they do exist.
+ *
+ * @param specPath File system path to a YAML Kubernetes spec.
+ * @return Array of resources created
+ */
+export async function apply(specPath: string): Promise<k8s.KubernetesObject[]> {
+    const kc = new k8s.KubeConfig();
+    kc.loadFromDefault();
+    const client = k8s.KubernetesObjectApi.makeApiClient(kc);
+    const fsReadFileP = promisify(fs.readFile);
+    const specString = await fsReadFileP(specPath, 'utf8');
+    const specs: k8s.KubernetesObject[] = yaml.safeLoadAll(specString);
+    const validSpecs = specs.filter((s) => s && s.kind && s.metadata);
+    const created: k8s.KubernetesObject[] = [];
+    for (const spec of validSpecs) {
+        // this is to convince the old version of TypeScript that metadata exists even though we already filtered specs
+        // without metadata out
+        spec.metadata = spec.metadata || {};
+        spec.metadata.annotations = spec.metadata.annotations || {};
+        delete spec.metadata.annotations['kubectl.kubernetes.io/last-applied-configuration'];
+        spec.metadata.annotations['kubectl.kubernetes.io/last-applied-configuration'] = JSON.stringify(spec);
+        try {
+            // try to get the resource, if it does not exist an error will be thrown and we will end up in the catch
+            // block.
+            await client.read(spec);
+            // we got the resource, so it exists, so patch it
+            const response = await client.patch(spec);
+            created.push(response.body);
+        } catch (e) {
+            // we did not get the resource, so it does not exist, so create it
+            const response = await client.create(spec);
+            created.push(response.body);
+        }
+    }
+    return created;
+}

examples/typescript/cp/cp-example.ts

@@ -0,0 +1,7 @@
+import * as k8s from '@kubernetes/client-node';
+
+const kc = new k8s.KubeConfig();
+kc.loadFromDefault();
+
+const cp = new k8s.Cp(kc);
+cp.cpFromPod('default', 'nginx-4217019353-9gl4s', 'nginx', './test.txt', '/tmp');

examples/typescript/informer/informer.ts

@@ -6,12 +6,19 @@ kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
-const listFn = () => k8sApi.listPodForAllNamespaces();
+const listFn = () => k8sApi.listNamespacedPod('default');
 
 const informer = k8s.makeInformer(kc, '/api/v1/namespaces/default/pods', listFn);
 
 informer.on('add', (obj: k8s.V1Pod) => { console.log(`Added: ${obj.metadata!.name}`); });
 informer.on('update', (obj: k8s.V1Pod) => { console.log(`Updated: ${obj.metadata!.name}`); });
 informer.on('delete', (obj: k8s.V1Pod) => { console.log(`Deleted: ${obj.metadata!.name}`); });
+informer.on('error', (err: k8s.V1Pod) => {
+  console.error(err);
+  // Restart informer after 5sec
+  setTimeout(() => {
+    informer.start();
+  }, 5000);
+});
 
 informer.start();

examples/typescript/watch/watch-example.ts

@@ -4,11 +4,13 @@ const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
 const watch = new k8s.Watch(kc);
-const req = watch.watch('/api/v1/namespaces',
+watch.watch('/api/v1/namespaces',
     // optional query parameters can go here.
-    {},
+    {
+        allowWatchBookmarks: true,
+    },
     // callback is called for each received object.
-    (type, obj) => {
+    (type, apiObj, watchObj) => {
         if (type === 'ADDED') {
             // tslint:disable-next-line:no-console
             console.log('new object:');
@@ -18,18 +20,22 @@ const req = watch.watch('/api/v1/namespaces',
         } else if (type === 'DELETED') {
             // tslint:disable-next-line:no-console
             console.log('deleted object:');
+        } else if (type === 'BOOKMARK') {
+            // tslint:disable-next-line:no-console
+            console.log(`bookmark: ${watchObj.metadata.resourceVersion}`);
         } else {
             // tslint:disable-next-line:no-console
             console.log('unknown type: ' + type);
         }
         // tslint:disable-next-line:no-console
-        console.log(obj);
+        console.log(apiObj);
     },
     // done callback is called if the watch terminates normally
     (err) => {
         // tslint:disable-next-line:no-console
         console.log(err);
-    });
-
-// watch returns a request object which you can use to abort the watch.
-setTimeout(() => { req.abort(); }, 10 * 1000);
+    })
+.then((req) => {
+    // watch returns a request object which you can use to abort the watch.
+    setTimeout(() => { req.abort(); }, 10 * 1000);
+});

examples/yaml-example.js

@@ -1,5 +1,4 @@
 const k8s = require('@kubernetes/client-node');
-const fs = require('fs');
 
 const kc = new k8s.KubeConfig();
 kc.loadFromDefault();