README
¶
HwameiStor
HwameiStor is an HA local storage system for cloud-native stateful workloads. It creates a local storage resource pool for centrally managing all disks such as HDD, SSD, and NVMe. It uses the CSI architecture to provide distributed services with local volumes and provides data persistence capabilities for stateful cloud-native workloads or components.
Current Status
HwameiStor is a cloud-native storage project listed in CNCF Landscape, with capabilities to support for your production environment.
At present, HwameiStor is still in the alpha stage.
The latest release of HwameiStor is 
Build Status
Release Status
| Release | Version | Type |
|---|---|---|
| v0.8.0 | v0.8.0 | latest |
See current releases.
Running Environments
Kubernetes compatiblity
| kubernetes | v0.4.3 | >=v0.5.0 |
|---|---|---|
| >=1.18&&<=1.20 | Yes | No |
| 1.21 | Yes | Yes |
| 1.22 | Yes | Yes |
| 1.23 | Yes | Yes |
| 1.24 | Yes | Yes |
| 1.25 | No | Yes |
Modules and Code
HwameiStor contains several modules:
local-disk-manager
local-disk-manager (LDM) is designed to hold the management of disks on nodes. Other modules such as local-storage can take advantage of the disk management feature provided by LDM. Learn more
local-storage
local-storage (LS) provides a cloud-native local storage system. It aims to provision high-performance persistent LVM volume with local access to applications. Learn more
Scheduler
Scheduler is to automatically schedule a pod to a correct node which has the associated HwameiStor volumes. Learn more
admission-controller
admission-controller is a webhook that can automatically determine which pod uses the HwameiStor volume and, help to modify the schedulerName to hwameistor-scheduler. Learn more
Evictor
Evictor is used to automatically migrate HwameiStor volumes in case of node or pod eviction. When a node or pod is evicted as either Planned or Unplanned, the associated HwameiStor volumes, which have a replica on the node, will be detected and migrated out this node automatically. Learn more
DRBD installer
DRBD (Distributed Replicated Block Device) is composed of Linux kernel modules and related scripts to build high available clusters. It is implemented by mirroring the entire device over the network, which can be thought of as a kind of network RAID. This installer can directly install DRBD to a container cluster. Currently this module is only for testing purposes. Learn more
Documentation
For full documentation, please see our website hwameistor.io.
For detailed adopters that have HwameiStor deployed in a production environment or a user acceptance testing environment, please check the adopters list.
Roadmap
| Features | Status | Release | Description |
|---|---|---|---|
| CSI for LVM volume | Completed | v0.3.2 | Provision volume with lvm |
| CSI for disk volume | Completed | v0.3.2 | Provision volume with disk |
| HA LVM Volume | Completed | v0.3.2 | Volume with HA |
| LVM Volume expansion | Completed | v0.3.2 | Expand LVM volume capacity online |
| LVM Volume conversion | Completed | v0.3.2 | Convert a non-HA LVM volume to the HA |
| LVM Volume migration | Completed | v0.4.0 | Migrate a LVM volume replica to a different node |
| Volume Group | Completed | v0.3.2 | Support volume group allocation |
| Disk health check | Completed | v0.7.0 | Disk fault prediction, status reporting |
| LVM HA Volume Recovery | Planed | Recover the LVM HA volume in problem | |
| HwameiStor Operator | Planed | Operator for HwameiStor install, maintain, etc. | |
| Observability | Planed | Observability, such as metrics, logs, etc. | |
| Failover | Planed | Fail over the pod with HwameiStor volume | |
| IO throttling | Planed | Limit IO bandwith to access the HwameiStor volume | |
| Disk replacement | Planed | Replace disk which fails or will fail soon | |
| LVM volume auto-expansion | Planed | Expand LVM volume automatically | |
| LVM volume snapshot | Planed | Snapshot of LVM volume | |
| LVM volume clone | Unplaned | Clone LVM volume | |
| LVM volume thin provision | Unplaned | LVM volume thin provision | |
| LVM volume stripe mode | Unplaned | LVM volume stripe read/write | |
| Data encryption | Unplaned | Data encryption |
Community
We welcome contributions of any kind. If you have any questions about contributing, please consult the contributing documentation.
Blog
Please follow our weekly blogs.
Slack
Welcome to join our slack channel
HwameiStor tech-talk group:
Discussion
Welcome to follow our roadmap discussions here
Requests and Issues
Please feel free to raise requests on chats or by a PR.
We will try our best to respond to every issue reported on community channels, but the issues reported here on this repo will be addressed first.
License
Copyright (c) 2014-2021 The HwameiStor Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
scheduler
k8s scheduler with local-storage replica scheduling scheduling for pod which mount local-storage volume
|
k8s scheduler with local-storage replica scheduling scheduling for pod which mount local-storage volume |
|
pkg
|
|
|
apis/client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
apis/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
apis/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
apis/client/clientset/versioned/typed/hwameistor/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
apis/client/clientset/versioned/typed/hwameistor/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
apis/hwameistor
Package hwameistor contains hwameistor API versions.
|
Package hwameistor contains hwameistor API versions. |
|
apis/hwameistor/v1alpha1
Package v1alpha1 contains API Schema definitions for the localstorage v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=hwameistor.io
|
Package v1alpha1 contains API Schema definitions for the localstorage v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=hwameistor.io |
|
apiserver/docs
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
|
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag |
|
apiserver/types
Package classification User API.
|
Package classification User API. |
|
apiserver/util
Package classification User API.
|
Package classification User API. |
|
local-storage/member/controller
Package controller is a generated GoMock package.
|
Package controller is a generated GoMock package. |
|
local-storage/member/controller/volumegroup
Package volumegroup is a generated GoMock package.
|
Package volumegroup is a generated GoMock package. |
|
local-storage/member/csi
Package csi is a generated GoMock package.
|
Package csi is a generated GoMock package. |
|
local-storage/member/node/configer
Package configer is a generated GoMock package.
|
Package configer is a generated GoMock package. |
|
local-storage/member/node/storage
Package storage is a generated GoMock package.
|
Package storage is a generated GoMock package. |
|
local-storage/utils/datacopy
Design for copy data from source PVC to destination PVC, continuously push statue into status channel for notifications
|
Design for copy data from source PVC to destination PVC, continuously push statue into status channel for notifications |
|
scheduler/genscheduler
Package genscheduler is a generated GoMock package.
|
Package genscheduler is a generated GoMock package. |
|
test
|
|