# @docamole/kubernetes-pilot

> Dashboard and GraphQL API for managing Kubernetes resources.

Latest version **0.0.3** (published 2018-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @docamole/kubernetes-pilot
pnpm add @docamole/kubernetes-pilot
yarn add @docamole/kubernetes-pilot
bun add @docamole/kubernetes-pilot
```

Provides the command `pilot`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-10-15 |
| First published | 2018-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nicholaus Brabant |
| Maintainers | docamole |

## Links

- npm: https://www.npmjs.com/package/@docamole/kubernetes-pilot
- Repository: https://github.com/Docamole/kubernetes-pilot
- Homepage: https://github.com/Docamole/kubernetes-pilot#readme
- Issues: https://github.com/Docamole/kubernetes-pilot/issues
- npm.io page: https://npm.io/package/@docamole/kubernetes-pilot

## Dependencies (4)

- [express](https://npm.io/package/express.md) ^4.16.4
- [graphql](https://npm.io/package/graphql.md) 0.13.1
- [kubernetes-client](https://npm.io/package/kubernetes-client.md) ^6.1.0
- [apollo-server-express](https://npm.io/package/apollo-server-express.md) ^2.1.0

## Recent versions

- 0.0.3 (latest) — 2018-10-15
- 0.0.2 — 2018-10-14
- 0.0.1 — 2018-10-14

## README

# kubernetes-pilot

> A maritime pilot, sometimes simply called a **Pilot**, is a
> sailor who maneuvers ships through dangerous or congested waters.

## :sparkles: Features

- Kubernetes GraphQL API
- Configuration Dashboard

## :package: Installation

You can install Pilot globally, or as a development dependency:
```bash
yarn global add @docamole/kubernetes-pilot
# npm install -g @docamole/kubernetes-pilot

# or

yarn add -D @docamole/kubernetes-pilot
# npm install --save-dev @docamole/kubernetes-pilot
```

## :rocket: Usage

Simply run the `pilot` cli tool to start the API and dashboard.
```bash
pilot
# > Pilot Dashboard:  http://localhost:8080/
# > Pilot API:        http://localhost:8080/graphql
```

Visit [http://localhost:8080/](http://localhost:8080) for a visual resource management dashboard.

Visit [http://localhost:8080/graphql](http://localhost:8080/graphql) to explore the API

## :octocat: Development

Clone this repo, then install the dependencies, you'll need to install them for
both /dashboard and /server as well as the base project. (This is done
to minimize the final package size and to keep components/dependencies isolated)
```bash
git clone https://github.com/docamole/kubernetes-pilot.git
cd kubernetes-pilot
yarn install
yarn --cwd dashboard install
yarn --cwd server install
```

Scripts:

  - `yarn start` Launch the API server and Dashboard
  - `yarn build` Bundle the dashboard and pack npm package for publishing
  - `yarn --cwd server start` Launch the standalone API server

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