Welcome to OpenEBS

OpenEBS is a modern Block-Mode storage platform, a Hyper-Converged software Storage System and virtual NVMe-oF SAN (vSAN) Fabric that is natively & tightly integrated into the core of Kubernetes.

	Try our Slack channel If you have questions about using OpenEBS, please use the CNCF Kubernetes OpenEBS slack channel, it is open for anyone to ask a question

Important

OpenEBS provides...

• Stateful persistent Dynamically provisioned storage volumes for Kubernetes
• High Performance NVMe-oF storage access optimized for All-Flash Solid State storage media
• Block devices, LVM, ZFS, ext2/ext3/ext4, XFS, BTRFS...and more
• 100% Cloud-Native K8s declarative storage platform
• A cluster-wide vSAN block-mode fabric that provides containers/Pods with HA resilient access to storage across the entire cluster.
• Node local K8s PV's and n-way Replciated K8s PV's
• Deployable On-premise & in-cloud: (AWS EC2/EKS, Google GCP/GKE, Azure VM/AKS, Oracle OCI, IBM/RedHat OpenShift, Civo Cloud, Hetzner Cloud... and more)
• Enterprise Grade data management capabilities such as snapshots, clones, replicated volumes, DiskGroups, Volume Groups, Aggregates, RAID
  

openEBS has 2 Editions:

1. STANDARD ✔️ > Ready Player 1
2. LEGACY ⚠️ Game Over

Within STANDARD, you have a choice of 2 Types of K8s Storage Services. Replicated PV and Local PV.

---

Type	Storage Engine	Type of data services	Status	In OSS ver
Replicated_PV		Replicated data volumes (in a Cluster wide vSAN block mode fabric)
	Mayastor	for High Availability deploymemnts distributing & replicating volumes across the cluster	Stable, deployable in PROD	v4.0.1
Local PV		Non-replicated node local data volumes	(Local-PV has multiple variants. See below)	v4.0.1
	Local PV HostPath	for integration with local node hostpath (e.g. /mnt/fs1)	Stable, deployable in PROD	v4.0.1
	Local PV ZFS	for integration with local ZFS storage deployments	Stable, deployable in PROD	v4.0.1
	Local PV LVM	for integration with local LVM2 storage deployments	Stable, deployable in PROD	v4.0.1
	Local PV Rawfile	for integration with Loop mounted Raw device-file filesystem	Stable, deployable in PROD, undergoing evaluation & integration release: v0.70	v4.0.1

STANDARD (Open Source Standard) is our Ultra modern Datastore stack that is strongly aligned with the cutting edge direction of storage use-cases in the K8s industry. It is designed to facilitate modern K8s datastore architectures, key K8s I/O patterns, K8s data access methods, K8s data use-cases and where K8s Datastore applications are heading.

STANDARD is optimized for NVMe and SSD Flash storage media, and integrates ultra modern cutting-edge high performance storage technologies at its core...

☑️   It uses the High performance SPDK storage stack - (SPDK is an open-source NVMe project initiated by INTEL)
☑️   The hyper modern IO_Uring Linux Kernel Async polling-mode I/O Interface - (fastest kernel I/O mode possible)
☑️   Native abilities for RDMA and Zero-Copy I/O
☑️   NVMe-oF TCP Block storage Hyper-converged data fabric
☑️   Block layer volume replication
☑️   Logical volumes and Diskpool based data managment
☑️   a Native high performance Blobstore
☑️   Native Block layer Thin provisioning
☑️   Native Block layer Snapshots and Clones

Get in touch with our team.

Vishnu Attur	@avishnu		Admin, Maintainer
Abhinandan Purkait	😎 @Abhinandan-Purkait		Maintainer
Niladri Halder	🚀 @niladrih		Maintainer
Ed Robinson	🐶 @edrob999		CNCF Primary Liason Special Maintainer
Tiago Castro	⚡ @tiagolobocastro		Admin, Maintainer
David Brace	⭐ @orville-wright		Admin, Maintainer

---

Activity dashbaord

Current status

Release	Support	Twitter/X	Contrib	License statue	CI Staus

---

Read this in 🇩🇪 🇷🇺 🇹🇷 🇺🇦 🇨🇳 🇫🇷 🇧🇷 🇪🇸 🇵🇱 🇰🇷 other languages.

Some key aspects that make OpenEBS different compared to other traditional storage solutions:

• Built using K8s micro-services architecture like the applications it serves. OpenEBS is deployed as a set of intelligent K8s Deployments, Containers, Servcies, Stateful sets, CRD's, Sidecars, Jobs and Binaries all on K8s worker nodes. It uses Kubernetes itself to orchestrate and manage all components.
• Built completely in userspace making it highly portable and able to run across any OS/platform.
• Completely intent-driven & declaritive. Inheriting the same principles that align with Kubernetes.
• OpenEBS has 5 Storgae Engines to support Distributed applications (like Cassandra), Monolithic applications (like MySQL and PostgreSQL), Streaming applications like Kafka.
• Listed in CNCF Hyper-Converged Storage refernce architecture whitepaper: CNCF Storage White Paper

Deployment

• TBD

Roadmap (as of June 2024)

• Replciated PV Mayastor Roadmap

---

Installation and Getting Started

OpenEBS can be deployed on any Kubernetes cluster - either in the cloud, on-premise or developer laptop (minikube). Note that there are no changes to the underlying kernel that are required as OpenEBS operates in userspace.

1. Setup helm repository.

# helm repo add openebs https://openebs.github.io/openebs
# helm repo update

2a. Install the Full OpenEBS helm chart with default values.

• This installs ALL OpenEBS Storage Engines* in the openebs namespace and chart name as openebs:
  Local PV Hostpath, Local PV LVM, Local PV ZFS, Replicated Mayastor

# helm install openebs --namespace openebs openebs/openebs --create-namespace

2b. To Install just the OpenEBS Replicated Mayastor Storage Engine, use the following command:

# helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace

3. To view the chart

# helm ls -n openebs

Output:
NAME     NAMESPACE   REVISION  UPDATED                                   STATUS     CHART           APP VERSION
openebs  openebs     1         2024-03-25 09:13:00.903321318 +0000 UTC   deployed   openebs-4.0.1   4.0.1

4. Verify installation
   • List the pods in namespace
   • Verify StorageClasses

# kubectl get pods -n openebs

Example Ouput:
NAME                                              READY   STATUS    RESTARTS   AGE
openebs-agent-core-674f784df5-7szbm               2/2     Running   0          11m
openebs-agent-ha-node-nnkmv                       1/1     Running   0          11m
openebs-agent-ha-node-pvcrr                       1/1     Running   0          11m
openebs-agent-ha-node-rqkkk                       1/1     Running   0          11m
openebs-api-rest-79556897c8-b824j                 1/1     Running   0          11m
openebs-csi-controller-b5c47d49-5t5zd             6/6     Running   0          11m
openebs-csi-node-flq49                            2/2     Running   0          11m
openebs-csi-node-k8d7h                            2/2     Running   0          11m
openebs-csi-node-v7jfh                            2/2     Running   0          11m
openebs-etcd-0                                    1/1     Running   0          11m
openebs-etcd-1                                    1/1     Running   0          11m
openebs-etcd-2                                    1/1     Running   0          11m
...

# kubectl get sc

Example Output:
NAME                                              READY   STATUS    RESTARTS   AGE
openebs-localpv-provisioner-6ddf7c7978-jsstg      1/1     Running   0          3m9s
openebs-lvm-localpv-controller-7b6d6b4665-wfw64   5/5     Running   0          3m9s
openebs-lvm-localpv-node-62lnq                    2/2     Running   0          3m9s
openebs-lvm-localpv-node-lhndx                    2/2     Running   0          3m9s
openebs-lvm-localpv-node-tlcqv                    2/2     Running   0          3m9s
openebs-zfs-localpv-controller-f78f7467c-k7ldb    5/5     Running   0          3m9s
...

For more details, please refer to OpenEBS Documentation.

OpenEBS is a CNCF project and DataCore, Inc is a CNCF Silver member. DataCore support's CNCF extensively and has funded OpenEBS participating in every KubeCon event since 2020. Our project team is managed under the CNCF Storage Landscape and we contribute to the CNCF CSI and TAG Storage project initiatives. We proudly support CNCF Cloud Native Community Groups initiatives.

Project updates, subscribe to OpenEBS Announcements
Interacting with other OpenEBS users, subscribe to OpenEBS Users

Commercial Offerings

This is a list of third-party companies and individuals who provide products or services related to OpenEBS. OpenEBS is a CNCF project which does not endorse any company. The list is provided in alphabetical order.

• Clouds Sky GmbH
• CodeWave
• DataCore
• Gridworkz Cloud Services