https://github.com/kubesan/kubesan

This is currently a read-only mirror of https://gitlab.com/kubesan/kubesan although we may flip which repo is master in the future
https://github.com/kubesan/kubesan

csi kubernetes lvm2 nbd san storage

Last synced: 6 months ago
JSON representation

This is currently a read-only mirror of https://gitlab.com/kubesan/kubesan although we may flip which repo is master in the future

• Host: GitHub
• URL: https://github.com/kubesan/kubesan
• Owner: kubesan
• License: apache-2.0
• Created: 2024-12-04T12:54:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-11-18T09:47:38.000Z (8 months ago)
• Last Synced: 2025-11-18T11:25:47.194Z (8 months ago)
• Topics: csi, kubernetes, lvm2, nbd, san, storage
• Language: Go
• Homepage: https://gitlab.com/kubesan/kubesan
• Size: 8.34 MB
• Stars: 4
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# The KubeSAN CSI Plugin

**Status: KubeSAN is not actively developed.**

KubeSAN is a [CSI] plugin for [Kubernetes] that enables you to provision

volumes backed by a single, cluster-wide, shared block device (*e.g.*, a single

big LUN on a SAN), exposed as a shared Volume Group under lvm2.

Whilst SANs often come with vendor CSI plugins, they cannot always be used.

KubeSAN is intended for cases where:

- No vendor CSI plugin is available, the vendor plugin is broken, or lacks features.

- The vendor CSI plugin cannot be used due to organizational reasons (storage

  team does not want to give Kubernetes team access).

- 1 SAN LUN per `PersistentVolume` is undesirable for scalability or

  organizational reasons.

In these cases KubeSAN steps in to provide storage without help from a

vendor CSI plugin.

![Diagram showing KubeSAN volumes backed by a SAN LUN](img/overview.png)

Features:

- Dynamic provisioning of `Block` and `Filesystem` volumes

- Snapshots

- Cloning

- `ReadWriteMany` (RWX) support for `Block` volumes

- Thin provisioning

Roadmap:

- [ ] Recovery after power failure. Currently requires manual intervention.

- [ ] Volume expansion

- [ ] Instant volume cloning via background copy

### Documentation

1. [Getting started](docs/1-getting-started.md)

2. [Architecture](docs/2-architecture.md)

3. [Development](docs/3-development.md)

### Reporting issues

[Create an issue] on GitLab or send an email to afaria@redhat.com.

### License

This project is released under the Apache 2.0 license. See [LICENSE](LICENSE).

[Create an issue]: https://gitlab.com/kubesan/kubesan/-/issues

[CSI]: https://github.com/container-storage-interface/spec

[Kubernetes]: https://kubernetes.io/