KubeSphere Console
KubeSphere Console is a general purpose, web-based UI for KubeSphere clusters.
Getting Started
A KubeSphere cluster is required before getting started.
Read Installation guide to install a cluster.
Read To start using KubeSphere to get start using.
Features Map:
Developer Guide
Preparation
Make sure the following software is installed and added to the $PATH variable:
- A KubeSphere cluster (Installation)
- Node.js 8+ (installation with nvm)
- Yarn 1.19.1+
Install yarn with npm:
npm install -g yarn
Clone the repository and install the dependencies:
yarn
Or you can start development in dokcer. See Development with Docker.
Access the backend services of KubeSphere
Follow Access Backend Services to access the backend services.
Start KubeSphere Console for development
yarn lego
yarn start
Now, you can access http://localhost:8000 in the browser.
Run tests
yarn test
Build KubeSphere Console for production
The project can be built for production by using the following task:
yarn build
To build and serve from dist, using the following task:
yarn serve
To build KubeSphere console to an image, run the following task after yarn build
:
docker build -t ks-console .
Test KubeSphere console image by run:
./docker-run
Development Workflow
Follow Development Workflow to commit your codes.
Support, Discussion, and Community
If you need any help with KubeSphere, please join us at Slack Channel.
Please submit any KubeSphere Console bugs, issues, and feature requests to KubeSphere Console GitHub Issue.
Contributing to the project
Welcome to contribute to KubeSphere Console, see Contributing Guide.