-
Notifications
You must be signed in to change notification settings - Fork 509
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1754 from zfrhv/generic-api-1.x
add examples to generic api (inside object.ts)
- Loading branch information
Showing
6 changed files
with
140 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
// in a real program use require('@kubernetes/client-node') | ||
import * as k8s from '../../../dist/index'; | ||
|
||
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
// in a real program use require('@kubernetes/client-node') | ||
import * as k8s from '../../../dist/index'; | ||
|
||
const kc = new k8s.KubeConfig(); | ||
kc.loadFromDefault(); | ||
|
||
const client = k8s.KubernetesObjectApi.makeApiClient(kc); | ||
|
||
const namespace = { | ||
metadata: { | ||
name: 'test' | ||
} | ||
} | ||
|
||
client.create(namespace) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
// in a real program use require('@kubernetes/client-node') | ||
import * as k8s from '../../../dist/index'; | ||
|
||
const kc = new k8s.KubeConfig(); | ||
kc.loadFromDefault(); | ||
|
||
const client = k8s.KubernetesObjectApi.makeApiClient(kc); | ||
|
||
const namespace = { | ||
metadata: { | ||
name: 'test' | ||
} | ||
} | ||
|
||
client.delete(namespace) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
// in a real program use require('@kubernetes/client-node') | ||
import * as k8s from '../../../dist/index'; | ||
|
||
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,22 @@ | ||
// 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'; | ||
|
||
/** | ||
* 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// in a real program use require('@kubernetes/client-node') | ||
import * as k8s from '../../../dist'; | ||
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; | ||
} |