K8sresources NPM

`k8sresources`

This repository contains constructors for common Kubernetes resources.

Usage

Installation for Development

npm install -D k8sresources @types/node;

For appliying with `kubectl`

To apply the JavaScript-based templates, use the k8sjs package.

Install it using:

npm install -g k8sjs

And you can generate the template using:

kubectl js template ./path/to/yourfile.js

To apply it directly:

kubectl js template ./path/to/yourfile.js | kubectl apply -f -

To dump the output into a yaml manifest:

kubectl js template ./path/to/yourfile.js > ./path/to/yourfile.yaml

Using

With JavaScript

const {createDeployment} = require('k8sresources');

const deployment = createDeployment('apps/v1', {name: 'test'});
deployment.spec.template.spec.containers.push(
  {
    image: 'zephinzer/demo-echoserver:latest',
    imagePullPolicy: 'IfNotPresent',
    name: 'echoserver',
  },
);

module.exports = deployment;

// if you'd like to see the output:
// console.info(JSON.stringify(deployment, null, 2));

With TypeScript

import {createDeployment} from 'k8sresources';

const deployment = createDeployment('apps/v1', {name: 'test'});
deployment.spec.template.spec.containers.push(
  {
    image: 'zephinzer/demo-echoserver:latest',
    imagePullPolicy: 'IfNotPresent',
    name: 'echoserver',
  },
);

export default deployment;

// if you'd like to see the output:
// console.info(JSON.stringify(deployment, null, 2));