Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 3.98 KB

README.md

File metadata and controls

82 lines (55 loc) · 3.98 KB
Raw

TopoLVM logo GitHub release Main PkgGoDev Go Report Card

TopoLVM

TopoLVM is a CSI plugin using LVM for Kubernetes. It can be considered as a specific implementation of local persistent volumes using CSI and LVM.

The team presented the motivation and implementation of TopoLVM at KubeCon Europe 2020: https://kccnceu20.sched.com/event/ZerD

Join our community on Slack: Invitation form

  • Project Status: Testing for production
  • Conformed CSI version: 1.5.0

Supported environments

  • Kubernetes: 1.22, 1.21, 1.20
  • Node OS: Linux with LVM2 (*1)
  • Filesystems: ext4, xfs

*1 The host's Linux Kernel must be v4.9 or later which supports rmapbt and reflink, if you use xfs filesystem with an official docker image.

Features

  • Dynamic provisioning: Volumes are created dynamically when PersistentVolumeClaim objects are created.
  • Raw block volume: Volumes are available as block devices inside containers.
  • Ephemeral inline volume: Volumes can be directly embedded in the Pod specification.
  • Topology: TopoLVM uses CSI topology feature to schedule Pod to Node where LVM volume exists.
  • Extended scheduler: TopoLVM extends the general Pod scheduler to prioritize Nodes having larger storage capacity.
  • Volume metrics: Usage stats are exported as Prometheus metrics from kubelet.
  • Volume Expansion: Volumes can be expanded by editing PersistentVolumeClaim objects.

Planned features

Programs

A diagram of components is available in docs/design.md.

This repository contains these programs:

  • topolvm-controller: CSI controller service.
  • topolvm-scheduler: A scheduler extender for TopoLVM.
  • topolvm-node: CSI node service.
  • lvmd: gRPC service to manage LVM volumes.

lvmd is a standalone program that should be run on Node OS as a systemd service. Other programs are packaged into a container image.

Getting started

A demonstration of TopoLVM running on kind (Kubernetes IN Docker) is available at example directory.

For production deployments, see deploy/README.md.

User manual is at docs/user-manual.md.

Deprecated: If you want to use TopoLVM on Rancher/RKE, see docs/deprecated/rancher.md.

Documentation

docs directory contains documents about designs and specifications.

Docker images

Docker images are available on Quay.io