kubeeye-console

README

KubeEye Console

KubeEye console is the web interface for KubeEye.

Getting Started

Console should be always used with KubeEye, To install kubeeye, please refer to this README The following will show you how to build console from source code.

Prerequisite

Node.js

Console is written using Javascript. If you don't have a Node.js development environment, please set it up. The minimum version required is 12.18.

Yarn

We use Yarn to do package management. If you don't have yarn, use the following to install:

npm install -g yarn@1.22.4

The minimum version required is 1.22.4, but you can use a newer version.

Go

We use Golang as the forwarding layer, If you don't have go environment, please set it up.

How to build

Clone the repository, and run yarn && yarn build

git clone https://github.com/kubesphere/kubeeye-console.git
cd kubeeye-console/
yarn && yarn build
go build web.go
./web

If you have trouble downloading the dependencies, try the following

yarn config set registry https://registry.npmmirror.com

After ./web, you should see the output like the following

> I0424 16:10:52.142951     332 web.go:122] Start listening on 9088

Now, console is up and running.

How to debug

A KubeEye backend is required to start debugging. You can refer to Installation to create install KubeEye.

Once the kubeeye is up, you run yarn dev to start the development environment.

How to submit a PR

Follow Development Workflow to commit your codes.

Contributing to the project

Welcome to contribute to KubeEye Console, see Contributing Guide.