README
¶
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.
Join our community on Slack: Invitation form
- Project Status: Testing for production
- Conformed CSI version: 1.1.0
Supported environments
- Kubernetes
- 1.15
- 1.16
- 1.17
- Node OS
- Linux with LVM2
- Filesystems
- ext4
- xfs
- btrfs
Features
- Dynamic provisioning: Volumes are created dynamically when
PersistentVolumeClaimobjects 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
PersistentVolumeClaimobjects.
Planned features
- Snapshot: When we want it.
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 directory.
User manual is at docs/user-manual.md. If you want to use TopoLVM on Rancher/RKE, see docs/rancher.md.
Documentation
docs directory contains documents about designs and specifications.
Docker images
Docker images are available on Quay.io
Documentation
¶
Index ¶
Constants ¶
const CapacityKeyPrefix = "capacity.topolvm.cybozu.com/"
CapacityKeyPrefix is the key prefix of Node annotation that represents VG free space.
const CapacityResource = corev1.ResourceName("topolvm.cybozu.com/capacity")
CapacityResource is the resource name of topolvm capacity.
const DefaultCSISocket = "/run/topolvm/csi-topolvm.sock"
DefaultCSISocket is the default path of the CSI socket file.
const DefaultDeviceClassAnnotationName = "00default"
DefaultDeviceClassAnnotationName is the part of annotation name for the default device-class.
const DefaultDeviceClassName = ""
DefaultDeviceClassName is the name for the default device-class.
const DefaultLVMdSocket = "/run/topolvm/lvmd.sock"
DefaultLVMdSocket is the default path of the lvmd socket file.
const DefaultSize = DefaultSizeGb << 30
DefaultSize is DefaultSizeGb in bytes
const DefaultSizeGb = 1
DefaultSizeGb is the default size in GiB for volumes (PVC or inline ephemeral volumes) w/o capacity requests.
const DeviceClassKey = "topolvm.cybozu.com/device-class"
DeviceClassKey is the key used in CSI volume create requests to specify a device-class.
const EphemeralVolumeSizeKey = "topolvm.cybozu.com/size"
EphemeralVolumeSizeKey is the key used to obtain ephemeral inline volume size from the volume context
const LogicalVolumeFinalizer = "topolvm.cybozu.com/logicalvolume"
LogicalVolumeFinalizer is the name of LogicalVolume finalizer
const NodeFinalizer = "topolvm.cybozu.com/node"
NodeFinalizer is the name of Node finalizer of TopoLVM
const PVCFinalizer = "topolvm.cybozu.com/pvc"
PVCFinalizer is the name of PVC finalizer of TopoLVM
const PluginName = "topolvm.cybozu.com"
PluginName is the name of the CSI plugin.
const ResizeRequestedAtKey = "topolvm.cybozu.com/resize-requested-at"
ResizeRequestedAtKey is the key of LogicalVolume that represents the timestamp of the resize request.
const TopologyNodeKey = "topology.topolvm.cybozu.com/node"
TopologyNodeKey is the key of topology that represents node name.
const (
// Version is the topolvm version
Version = "0.5.0"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1
Package v1 contains API Schema definitions for the topolvm v1 API group +kubebuilder:object:generate=true +groupName=topolvm.cybozu.com
|
Package v1 contains API Schema definitions for the topolvm v1 API group +kubebuilder:object:generate=true +groupName=topolvm.cybozu.com |
|
pkg
|
|