1. Project Overview

KubePi [kubəˈpaɪ], a modern K8s dashboard.

KubePi is a modern K8s dashboard. KubePi allows administrators to import multiple Kubernetes clusters and assign permissions for different clusters and namespaces to designated users through access control. It also allows developers to manage and troubleshoot applications running in Kubernetes clusters, helping them better handle the complexities of Kubernetes environments.

2. Open Source License

Licensed under GPL-3.0

3. Screenshots

4. Feature Overview

• KubePi is a modern K8s dashboard.

• KubePi allows administrators to import multiple Kubernetes clusters and assign permissions for different clusters and namespaces to designated users through access control. It allows developers to manage and troubleshoot applications running in Kubernetes clusters, helping them better handle the complexities of Kubernetes environments.

5. Tech Stack

Project Structure

.
├── Dockerfile                                      # Dockerfile Used to Build the Container Image
├── Makefile                                        # Compilation Files
├── LICENSE
├── README.md
├── go.mod
├── conf                                            # Configuration Files
├── pkg                                             # Main Directory
├── interanl                                        # Private Business Code
├── migrate                                         # Database Migration Files Directory
├── web
│   ├── dashboard                                   # Front-End Dashboard Module
│   ├── kubepi                                      # Front-End Management Module
│   └── terminal                                    # Terminal Module

Configuration File

• By default, KubePi loads the configuration file from /etc/kubepi/app.yaml. Please create the corresponding directories and configuration files according to the configuration below.

apiVersion: v1
kind: AppConfig
spec:
    server:
    bind:
        host: 0.0.0.0
        port: 80
    ssl:
        enable: false
        certificate:
        certificateKey:
    db:
    path: /var/lib/kubepi/db/kubepi.db

Database File

• KubePi uses BoltDB as its underlying data storage and storm as its upper-level ORM framework.

Database File Location /var/lib/kubepi/db/kubepi.db

Build the Binary File

make build_web

Start the Backend Service

# Run in the cmd/server directory
go run main.go

Start the Frontend Service

The KubePi front end mainly consists of two parts, which need to be started separately.

• Management Module

Run in the web/kubepi directory

npm install

npm run serve

• Dashboard Module

Run in the web/dashboard directory

npm install

npm run serve

Installation Instructions

docker

• Non-Persistent Deployment

# Installation
sudo docker run --privileged -d --restart=unless-stopped -p 80:80 1panel/kubepi

• Persistent Deployment

# Create the Persistent Storage Directory
mkdir -p /opt/kubepi

# Installation
sudo docker run --privileged -d -v /opt/kubepi:/var/lib/kubepi --restart=unless-stopped -p 80:80 1panel/kubepi

• Log in to the System

Address: [http://localhost
Username](http://localhost
Username): admin
Password: kubepi

kubernetes

Detailed content please refer to README.md document