@01/kube-tools - npm Package Compare versions

Comparing version 1.0.10 to 1.0.11

dist/index.js

@@ -35,3 +35,3 @@ (function webpackUniversalModuleDefinition(root, factory) {
 /******/ 	// eslint-disable-next-line no-unused-vars
-/******/ 	var hotCurrentHash = "7c35d1a00a18bc1b28fa";
+/******/ 	var hotCurrentHash = "f06f402583c221778a95";
 /******/ 	var hotRequestTimeout = 10000;
@@ -831,3 +831,3 @@ /******/ 	var hotCurrentModuleData = {};
     dryRun: false,
-    context: process.env.KUBE_CONTEXT || "minikube"
+    context: process.env.KUBE_CONTEXT || ""
 };
@@ -834,0 +834,0 @@ function printConfig(_a) {

package.json

 {
   "name": "@01/kube-tools",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "author": "Nidin Vinayakan <[e-mail]>",
@@ -42,3 +42,3 @@ "repository": "[e-mail]:01alchemist/kube-tools.git",
   "dependencies": {
-    "sls-yaml": "1.0.6",
+    "sls-yaml": "1.0.11",
     "minimist": "1.2.0",
@@ -45,0 +45,0 @@ "source-map-support": "^0.5.12"

README.md

@@ -1,2 +0,49 @@
-# kube-tool
-Kubernetes toolbox
+# Kubernetes toolbox 🐬 ☸  ️ 
+The tollbox contains utilies to deploy kubernetes services
+
+## Commands
+
+### `kube-deploy` command
+`kube-deploy` will take a yml configuration file under `--config` argument and deploy your service to default kubernetes cluster
+
+#### config file
+Config file can be written in `yaml` file. it support serverless framework style extensions using [sls-yaml]
+
+##### Sample config
+```yaml
+# common.yml
+version: 1
+name: awesome-service
+
+# context: ${global:env}-context # Optional
+image.tag: ${env:GIT_COMMIT_SHA1}
+values: ../helm/values-${global:env}.yml
+chart: ../helm/chart
+```
+```yaml
+# prod.yml
+env: prod
+app: ${file(./common.yml)}
+```
+```yaml
+# stage.yml
+env: stage
+app: ${file(./common.yml)}
+```
+
+### Deployment
+```bash
+kube-deploy --config=.kube/config/prod.yml
+```
+#### Options
+|  Argument    | Description             |
+|--------------|-------------------------|
+| `--context`  | Set kubernetes context  |
+| `--name`     | Service name            |
+| `--chart`    | Chart path              | 
+| `--values`   | Values path             |
+| `--dryRun`   | Simulate deployment     |
+| `--image.tag`| Docker image tag        |
+
+[sls-yaml]: https://github.com/01alchemist/sls-yaml
+

No alert changes

Improved metrics

Total package byte prevSize

78457

increased by1.51%

Number of lines in readme file

50

increased by1566.67%

Dependency changes

• + Addedsls-yaml@1.0.11(transitive)

• - Removedsls-yaml@1.0.6(transitive)

• Updatedsls-yaml@1.0.11