Ceph-CSI Documentation¶
Welcome to the Ceph-CSI documentation. Ceph-CSI implements Container Storage Interface (CSI) drivers for Ceph storage, enabling dynamic provisioning and management of Ceph volumes in Kubernetes.
Overview¶
Ceph-CSI provides CSI drivers for the following Ceph storage types:
- RBD (RADOS Block Device): Block storage for Kubernetes workloads
- CephFS: Shared filesystem storage with ReadWriteMany support
- NFS: NFS-based storage provisioning
- NVMe-oF: NVMe over Fabrics storage
All drivers are packaged in a single binary, making deployment and management straightforward.
Quick Links¶
Getting Started¶
- Development Guide - Set up your development environment
- Coding Conventions - Learn about code style and best practices
Deployment¶
- RBD Deployment Guide - Deploy the RBD CSI driver
- CephFS Deployment Guide - Deploy the CephFS CSI driver
Features¶
- Capabilities - Supported CSI features and operations
- Snapshots and Clones - Volume snapshot and cloning support
- Volume Expansion - Expand persistent volumes dynamically
- Static PVC - Use pre-existing Ceph volumes
- Metrics - Monitoring and observability
CSI-Addons¶
Ceph-CSI integrates with CSI-Addons to provide advanced storage operations and disaster recovery capabilities.
- Disaster Recovery - Volume replication and failover/failback procedures
- Network Fencing - Network-based access control for storage resources
- CSI-Addons Documentation - Official CSI-Addons documentation
Operations¶
- Upgrade Guide - Upgrade Ceph-CSI to newer versions
- In-tree Migration - Migrate from in-tree Ceph plugins
- Resource Cleanup - Clean up resources properly
- Releases - Release process and versioning
Architecture¶
Ceph-CSI implements the CSI specification with three main components:
- IdentityServer: Provides driver identification and capabilities
- ControllerServer: Manages volume lifecycle (create, delete, attach, detach, snapshot, clone)
- NodeServer: Handles node-local operations (stage, unstage, publish, unpublish, mount)
Contributing¶
Contributions are welcome! Please see our development guide and coding conventions to get started.
Support¶
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions and discuss
- Ceph Community: Join the Ceph community
License¶
Ceph-CSI is licensed under the Apache License 2.0. See the LICENSE file for details.