Topolvm-Operator is an open source cloud-native local storage orchestrator for Kubernetes, which bases on topolvm.

• Kubernetes: >= 1.19
• Node OS: Linux with LVM2
• Filesystems: ext4, xfs

if kubernetes < 1.21 The CSIStorageCapacity feature gate should be turned on

• Orchestrate topolvm
• Storage capacity expand dynamically
• Perception of storage topology
• Volume capacity limit
• PVC snapshot
• Prometheus metric and alarm
• Auto discover available devices

Topolvm Operator had been shared in operatorhub.io home.

• Raid of volume group
• Manage volume group that user created

see our roadmap

• operator: orchestrate topolvm include TopolvmCluster controller and ConfigMap controller
• preparevg: prepare volume group on each node

A diagram of components and the how they work see below:

1. Topolvm-operator watch the TopolvmCluster(CRD)
2. Topolvm-operator watch the operator-setting ConfigMap
3. Topolvm-operator start discover devices Daemonset
4. Topolvm-operator start ConfigMap controller to watch lvmd ConfigMap if TopolvmCluster created
5. TopolvmCluster controller create preparevg Job,Topolvm-controller Deployment depend on TopolvmCluster
6. preparevg Job on specific node check disk that provided in TopolvmCluster and create volume group, if volume group created successfully and then create lvmd ConfigMap for the node
7. ConfigMap controller finds the new lvmd ConfigMap then create Topolvm-node Deployment
8. TopolvmCluster controller update TopolvmCluster status

docs directory contains documents about installation and specifications

topolvm-operator is based on topolvm, we fork topolvm/topolvm and do some enhancements.

see alauda/topolvm

the enhancements are below:

• remove topolvm-scheduler
• lvmd containerized
• add new feature snapshot

• topolvm-operator alaudapublic/topolvm-operator
• topolvm alaudapublic/topolvm

For filing bugs, suggesting improvements, or requesting new features, please open an issue.