hwameistor

README

HwameiStor

English | 简体中文

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 Computing Foundation sandbox project.

The latest release of HwameiStor is

Build Status

Release Status

See current releases.

Running Environments

Kubernetes compatibility

kubernetes	v0.4.3	>=v0.5.0	>= 0.13.0
>=1.18&&<=1.20	Yes	No	No
1.21	Yes	Yes	No
1.22	Yes	Yes	No
1.23	Yes	Yes	No
1.24	Yes	Yes	Yes
1.25	No	Yes	Yes
1.26	No	Yes	Yes
1.27	No	No	Yes
1.28	No	No	Yes

Modules and Code

HwameiStor contains several modules:

• local-disk-manager
• local-storage
• scheduler
• admission-controller
• Evictor
• Exporter
• HA module installer
• Volume Snapshot
• Volume Auto Resize
• Volume IO Throtting
• App Failover
• Audit
• UI

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

HA module installer

DRBD (Distributed Replicated Block Device) is one of third-party HA modules which the HwameiStor will leverage to provide HA volume. It 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.

Exporter

Exporter will collect the system metrics including nodes, storage pools, volumes, disks. It supports Prometheus. Learn more

Volume Snapshot

HwameiStor provides the feature of snapshot and restore on the LVM volumes. Currently, the snapshot/restore feature works for LVM non-HA volume. Learn more

Volume Auto Resize

HwameiStor can automatically expand the LVM volume according the pre-defined resize policy. User can define the preferred policy and describe how and when to expand the volume, and HwameiStor will take the policy into effect. Learn more

Volume IO Throtting

HwameiStor can set a maxmium rate (e.g. bandwidth, IOPS) to access a volume. This feature is very important to prevent the Pod from crashing, especially in the low-resource condition. Learn more

App Failover

The feature of failover is to actively help the application to fail over to another health node with the volume replica, and continue the working. Learn more

Audit

HwameiStor provides the information about the resource history, including cluster, node, storage pool, volume, etc. Learn more

UI

HwameiStor provides a friendly UI to the user to operate the cluster. 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.

Build and Preview Website Locally

It's a good practice to build and preview your modifications locally before submit a PR to HwameiStor Website. You can run the following commands to preview locally:

cd docs
npm run start  # for english
npm run start -- --locale cn # for i18n/cn

Change Navigation

To change the navigation (left sidebar) sequence, you can change the content in _category_.json that exists in each folder:

{
  "label": "Installation", // The name displayed on the left sidebar
  "position": 4, // The sequence identifier, 1 is listed at top
  "link": {
    "type": "generated-index",
    "description": "In this section, we will introduce the installation procedure:"
  }
}

For i18n/cn, you can change the nav in current.json:

{
  "sidebar.tutorialSidebar.category.Modules": {
    "message": "Modules", // The section titles displayed on the left sidebar
    "description": "The label for category Modules in sidebar tutorialSidebar"
  },
  "sidebar.tutorialSidebar.category.Modules.link.generated-index.description": {
    "message": "This chapter introduces the following modules included in HwameiStor:", // The description before sub-section cards
    "description": "The generated-index page description for category Modules in sidebar tutorialSidebar"
  }
}

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	Planned		Recover the LVM HA volume in problem
HwameiStor Operator	Completed	v0.9.0	Operator for HwameiStor install, maintain, etc.
Observability	Completed	v0.9.2	Observability, such as metrics, logs, etc.
Failover	Completed	v0.12.0	Fail over the pod with HwameiStor volume
IO throttling	Completed	v0.11.0	Limit IO bandwidth to access the HwameiStor volume
Disk replacement	Planned		Replace disk which fails or will fail soon
LVM volume auto-expansion	Completed	v0.12.0	Expand LVM volume automatically
LVM volume snapshot	Completed	v0.12.0	Snapshot of LVM volume
LVM volume clone	Completed	v0.13.1	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
System Consistency	Planned		Consistent check and recovery from a disaster
Volume backup	Planned		Backup the volume data to remote server and restore
HwameiStor CLI command	Completed	v0.12.4	CLI command is to manage the HwameiStor cluster
HwameiStor GUI	Completed	v0.11.0	Manage the HwameiStor cluster

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

If you want to join the hwameistor channel on CNCF slack, please get invite to CNCF slack and then join the #hwameistor channel.

WeChat

HwameiStor tech-talk group:

Discussion

Welcome to follow our roadmap discussions here

Pull 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-2023 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

  

HwameiStor enriches the CNCF CLOUD NATIVE Landscape.