README.md

KubeSphere Console

KubeSphere Console is the web-based UI for KubeSphere clusters.

Getting Started

A KubeSphere cluster is required before getting started.

Read Installation guide to install a cluster.

Read the guide to start using KubeSphere.

Features Map:

Developer Guide

Preparation

Make sure the following software is installed and added to the $PATH variable:

• A KubeSphere cluster (Installation)
• Node.js 12.18+ (installation with nvm)
• Yarn 1.22.4+

Install yarn with npm:

npm install -g yarn

Fork the repository, then clone your repository and install the dependencies:

yarn

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 start

Now, you can access http://localhost:8000 to view the console using the default account admin / P@88w0rd.

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

Build KubeSphere Console Docker Image

If you don't have NodeJs environment, it's also easy to build the Docker image:

make image image-push -e REPO=kubespheredev/ks-console

Please replace the dockerHub repository to your personal account.

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.