KubeSphere Console is the web-based UI for KubeSphere clusters.
A KubeSphere cluster is required before getting started.
Read Installation guide to install a cluster.
Read the guide to start using KubeSphere.
Make sure the following software is installed and added to the $PATH variable:
Install yarn with npm:
npm install -g yarn
Fork the repository, then clone your repository and install the dependencies:
Note: If you are in China Mainland, execute the following command before running the command above for faster installation.
yarn config set registry https://registry.npm.taobao.org
Alternatively you can start development using docker. See Development with Docker.
Access the backend services of KubeSphere
Follow the guide to configure the backend services.
Start KubeSphere Console for development
yarn lego yarn start
Build KubeSphere Console for production
The project can be built for production by using the following task:
To build and serve from dist, using the following task:
To build KubeSphere console to an image, run the following task after
docker build -t ks-console .
Test KubeSphere console image by run:
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.