cubefs-dashboard

Introduction

cubefs Console (cfs-gui) is a graphical management tool for cubeFS system, which is designed to meet the needs of system administrators and ordinary users for daily file management. It is an independent web service that is more intuitive and easier to get started with than cfs-cli.

Governance

• CubeFS-dashboard is a sub-project of the CubeFS main project, complying with the rules of CubeFS main projects.
• CubeFS-dashboard does not have independent leadership, adopting the same leadership strategy as the CubeFS main project.
• Contributions to CubeFS-dashboard are equivalent to contributions to the main project and can be used as a basis for community role promotion.

Architecture

The cfs-gui backend interacts directly with the CubeFS cluster, manages multiple clusters simultaneously, and stores its own data in the database. The permission module can assign accounts to different application scenarios. cfs-gui has four main functional modules, as follows:

• Logical resource management: volume, data-partition, meta-partition, erasure-coding stripe, etc
• Physical resource management: nodes, disks, etc
• Authorization management: users and roles
• File management: file upload, download, list

Features

• Multi-cluster management: the dashboard can be deployed independently from the storage cluster and can manage multiple storage clusters
  
• Flexible authorization management: Each user can be associated with multiple roles, and each role has access permissions to a set of resources
• Volume creation and authorization: it supports authorizing other tenants to read and write the volumes created by oneself
• Resource migration: it supports resource decommissioning or migration at the granularity of partition, disk, or machine
• File management: List, upload, download
  

Compilation

Requirements:

node version: v12-v14
npm version: the npm in node package
go version: v1.16 and later

## clone code
git clone https://github.com/cubefs/cubefs-dashboard.git

## build
make

## product
ll bin/
total 26256
-rwxr-xr-x 1 root root 26876984 Jul 27 17:26 cfs-gui
-rw-r--r-- 1 root root     1009 Jul 27 17:26 config.yml
drwxr-xr-x 6 root root     4096 Jul 27 17:27 dist

Configuration

/src/config/config.yaml

server:
  port: 6007
  mode: dev
  static_resource:
    enable: true
    relative_path: /portal
    root_path: ./dist
prefix:
   api: /api/cubefs

/src/config/mysql.yaml

mysql:
  host: 
  port: 
  slaveHost: 
  slavePort: 
  database:
  user:
  password:
  maxIdleConn: 20
  MaxOpenConn: 300

Preview

Cluster overview

Role management

File management