Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clastix/kamaji-console

Console for Kamaji the Kubernetes Control Plane Manager
https://github.com/clastix/kamaji-console

Last synced: 2 months ago
JSON representation

Console for Kamaji the Kubernetes Control Plane Manager

Awesome Lists containing this project

README

        

# Kamaji Console

View and control Kamaji with a simple user interface from the web.

![Kamaji Console](.github/images/screen.png)

## Deploy on Kubernetes

A sample manifest is available: `deploy/kamaji-console.yaml`. To deploy the console in the admin cluster, edit the manifest according to your environment and apply:

```bash
kubectl apply -f deploy/
```

Alternatively, install with Helm:

helm repo add clastix https://clastix.github.io/charts
helm repo update
helm install console clastix/kamaji-console -n kamaji-system --create-namespace

## Development

Create a `.env` file with the information contained in [.env.example](.env.example)

```bash
$ npm install
$ npm run dev
```

The console should be run in an environment with a default connection to kubenretes API.

## Storybook

This repo contains visual UI tests using storybook. To run storybook

```bash
$ npm run storybook
```

## Connect to a child cluster

When reading child cluster resources, such as node, the console uses the TCP kubeconfig in order to connect to the child cluster.
When running in dev mode, using `npm run dev`, the console uses raw kubeconfig to connect to the cluster, in this way you should check that the child kubernetes API are reachable from your local development tool.

When build and deployed using docker, the console supposes to be runned inside parent kubernetes cluster, so it connects to the TCP using the tcp service fqdn in order to talk with child cluster kubernetes api.