Skip to content

Commit

Permalink
basic generic api examples
Browse files Browse the repository at this point in the history
Signed-off-by: zahar <zfrhv2010@gmail.com>
  • Loading branch information
zfrhv committed Jun 24, 2024
1 parent 9f7a02b commit 1644400
Show file tree
Hide file tree
Showing 6 changed files with 136 additions and 42 deletions.
21 changes: 21 additions & 0 deletions examples/kubectl/equivalents/apply.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
const k8s = require('@kubernetes/client-node');

const kc = new k8s.KubeConfig();
kc.loadFromDefault();

const client = k8s.KubernetesObjectApi.makeApiClient(kc);

// update deployment "my-deployment" in namespace "my-namespace" to 3 replicas
const deployment = {
apiVersion: 'apps/v1',
kind: 'Deployment',
metadata: {
name: 'my-deployment',
namespace: 'my-namespace'
},
spec: {
replicas: 3
}
}

client.patch(deployment)
14 changes: 14 additions & 0 deletions examples/kubectl/equivalents/create.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const k8s = require('@kubernetes/client-node');

const kc = new k8s.KubeConfig();
kc.loadFromDefault();

const client = k8s.KubernetesObjectApi.makeApiClient(kc);

const namespace = {
metadata: {
name: 'test'
}
}

client.create(namespace)
14 changes: 14 additions & 0 deletions examples/kubectl/equivalents/delete.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const k8s = require('@kubernetes/client-node');

const kc = new k8s.KubeConfig();
kc.loadFromDefault();

const client = k8s.KubernetesObjectApi.makeApiClient(kc);

const namespace = {
metadata: {
name: 'test'
}
}

client.delete(namespace)
15 changes: 15 additions & 0 deletions examples/kubectl/equivalents/get.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
const k8s = require('@kubernetes/client-node');

const kc = new k8s.KubeConfig();
kc.loadFromDefault();

const client = k8s.KubernetesObjectApi.makeApiClient(kc);

const namespace = {
metadata: {
name: 'test'
}
}

const live_namespace = (await client.read(namespace)).body
console.log(live_namespace)
61 changes: 19 additions & 42 deletions examples/typescript/apply/apply-example.ts
Original file line number Diff line number Diff line change
@@ -1,44 +1,21 @@
// in a real program use require('@kubernetes/client-node')
import * as k8s from '../../../dist';
import * as fs from 'fs';
import * as yaml from 'js-yaml';
import { promisify } from 'util';
import * as k8s from '@kubernetes/client-node';

/**
* 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 = yaml.loadAll(specString) as k8s.KubernetesObject[];
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);
} 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);
}
}
return created;
const kc = new k8s.KubeConfig();
kc.loadFromDefault();

const client = k8s.KubernetesObjectApi.makeApiClient(kc);

// update deployment "my-deployment" in namespace "my-namespace" to 3 replicas
const deployment = {
apiVersion: 'apps/v1',
kind: 'Deployment',
metadata: {
name: 'my-deployment',
namespace: 'my-namespace'
},
spec: {
replicas: 3
}
}

client.patch(deployment)
53 changes: 53 additions & 0 deletions examples/typescript/apply/apply-from-file-example.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import * as k8s from '@kubernetes/client-node';
import * as yaml from 'js-yaml';
import { promises as fs } from 'fs';

/**
* 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 specString = await fs.readFile(specPath, 'utf8');
const specs: k8s.KubernetesObject[] = yaml.loadAll(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
//
// Note that this could fail if the spec refers to a custom resource. For custom resources you may need
// to specify a different patch merge strategy in the content-type header.
//
// See: https://github.com/kubernetes/kubernetes/issues/97423
const response = await client.patch(spec);
created.push(response.body);
} catch (err) {
// if the resource doesnt exist then create it
if (err instanceof k8s.HttpError && err.statusCode === 404) {
const response = await client.create(spec);
created.push(response.body);
} else {
throw err
}
}
}

return created;
}

0 comments on commit 1644400

Please sign in to comment.