# @01/kube-tools

> The tollbox contains utilies to deploy kubernetes services

Latest version **2.0.0-alpha** (published 2020-02-08) · 0 weekly downloads

## Install

```sh
npm install @01/kube-tools
pnpm add @01/kube-tools
yarn add @01/kube-tools
bun add @01/kube-tools
```

Provides the commands `kube-push`, `kube-build`, `kube-deploy`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0-alpha |
| Published | 2020-02-08 |
| First published | 2019-07-29 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 134.8 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nidin Vinayakan |
| Maintainers | 01 |
| Keywords | kubernetes, deployment, tools |

## Links

- npm: https://www.npmjs.com/package/@01/kube-tools
- Repository: https://github.com/01alchemist/kube-tools
- Homepage: https://github.com/01alchemist/kube-tools#readme
- Issues: https://github.com/01alchemist/kube-tools/issues
- npm.io page: https://npm.io/package/@01/kube-tools

## Dependencies (6)

- [core-js](https://npm.io/package/core-js.md) 3.1.4
- [minimist](https://npm.io/package/minimist.md) 1.2.0
- [sls-yaml](https://npm.io/package/sls-yaml.md) 1.0.29
- [lodash.get](https://npm.io/package/lodash.get.md) ^4.4.2
- [@01/launcher](https://npm.io/package/@01/launcher.md) 1.0.9
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.12

## Recent versions

- 2.0.0-alpha (latest) — 2020-02-08
- 1.0.19 — 2019-08-29
- 1.0.18 — 2019-08-25
- 1.0.17 — 2019-08-23
- 1.0.16 — 2019-08-23
- 1.0.15 — 2019-08-20
- 1.0.14 — 2019-08-06
- 1.0.13 — 2019-08-06
- 1.0.12 — 2019-08-06
- 1.0.11 — 2019-08-01
- 1.0.10 — 2019-08-01
- 1.0.9 — 2019-07-31
- 1.0.8 — 2019-07-30
- 1.0.7 — 2019-07-30
- 1.0.6 — 2019-07-30
- … 5 more at https://npm.io/package/@01/kube-tools/versions

## README

# 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

---
_Source: https://npm.io/package/@01/kube-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._