Skip to content
Leading Open Source Container Attached Storage, built using Cloud Native Architecture, simplifies running Stateful Applications on Kubernetes.
Branch: master
Clone or download
mkosett and AmitKumarDas Fixed NOTICE.md typo (#2804)
Signed-off-by: mkosett <clitellgaming@gmail.com>
Latest commit de53ce9 Oct 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Better issue and pull request templates Oct 31, 2018
adopters docs(adopters): update with details from arista and comcast Sep 21, 2019
community update join our community link May 13, 2019
contribute oep(add_replicas): proposal to enable user to add/move replicas of vo… Oct 12, 2019
k8s refact(README): updated README for upgrades with some comments (#2750) Oct 15, 2019
translations docs(readme): change reference to openebs.org website (#2800) Oct 16, 2019
.codespell-ignores.txt Run codespell on Travis Oct 31, 2018
.gitattributes Add a new method to kick-start iSCSI tests using go routines Jul 29, 2017
.gitignore Adds github gitignore template Oct 31, 2018
.travis.yml Run codespell on Travis Oct 31, 2018
ADOPTERS.md docs(adopters): update with details from arista and comcast Sep 21, 2019
CODE_OF_CONDUCT.md Updated the mail id to community@openebs.io Mar 22, 2018
CONTRIBUTING.md update join our community link May 13, 2019
GOVERNANCE.md Fix spelling (#2755) Oct 3, 2019
LICENSE updated copyright details Oct 1, 2019
MAINTAINERS docs(contributor): add current maintainers and reviewers file May 6, 2019
Makefile chore(cleanup): remove unused files Apr 18, 2019
NOTICE.md Fixed NOTICE.md typo (#2804) Oct 19, 2019
README.md docs(readme): change reference to openebs.org website (#2800) Oct 16, 2019
SECURITY.md doc(governance): add initial draft on security policy (#2740) Sep 11, 2019

README.md

OpenEBS

Releases Slack Twitter PRs Welcome FOSSA Status CII Best Practices

https://openebs.org/

OpenEBS is the most widely deployed and easy to use open source storage solution for Kubernetes.

OpenEBS is the leading open source example of a category of storage solutions sometimes called Container Attached Storage. OpenEBS is listed as an open source example in the CNCF Storage Landscape White Paper under the hyperconverged storage solutions.

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

  • Built using the micro-services architecture like the applications it serves. OpenEBS is itself deployed as a set of containers on Kubernetes worker nodes. Uses Kubernetes itself to orchestrate and manage OpenEBS components
  • Built completely in userspace making it highly portable to run across any OS/platform
  • Completely intent-driven, inheriting the same principles that drive the ease of use with Kubernetes
  • OpenEBS supports a range of storage engines so that developers can deploy the storage technology appropriate to their application design objectives. Distributed applications like Cassandra can use the LocalPV engine for lowest latency writes. Monolithic applications like MySQL and PostgresQL can use the ZFS engine (cStor) for resilience. Streaming applications like Kafka can use the NVMe engine MayaStor for best performance in edge environments. Across engine types, OpenEBS provides a consistent framework for high availability, snapshots, clones and manageability.

OpenEBS itself is deployed as just another container on your host and enables storage services that can be designated on a per pod, application, cluster or container level, including:

  • Automate the management of storage attached to the Kubernetes worker nodes and allow the storage to be used for Dynamically provisioning OpenEBS PVs or Local PVs.
  • Data persistence across nodes, dramatically reducing time spent rebuilding Cassandra rings for example.
  • Synchronization of data across availability zones and cloud providers improving availability and decreasing attach/detach times for example.
  • A common layer so whether you are running on AKS, or your bare metal, or GKE, or AWS - your wiring and developer experience for storage services is as similar as possible.
  • Management of tiering to and from S3 and other targets.

An added advantage of being a completely Kubernetes native solution is that administrators and developers can interact and manage OpenEBS using all the wonderful tooling that is available for Kubernetes like: kubectl, Helm, Prometheus, Grafana, Weave Scope, etc.

Our vision is simple: let storage and storage services for persistent workloads be fully integrated into the environment so that each team and workload benefits from the granularity of control and Kubernetes native behavior.

Read this in other languages.

🇩🇪 🇷🇺 🇹🇷

Scalability

OpenEBS can scale to include an arbitrarily large number of containerized storage controllers. Kubernetes is used to provide fundamental pieces such as using etcd for inventory. OpenEBS scales to the extent your Kubernetes scales.

Installation and Getting Started

OpenEBS can be set up in a few easy steps. You can get going on your choice of Kubernetes cluster by having open-iscsi installed on the Kubernetes nodes and running the openebs-operator using kubectl.

Start the OpenEBS Services using operator

# apply this yaml
kubectl apply -f https://openebs.github.io/charts/openebs-operator.yaml

Start the OpenEBS Services using helm

helm repo update
helm install --namespace openebs --name openebs stable/openebs

You could also follow our QuickStart Guide.

OpenEBS can be deployed on any Kubernetes cluster - either in 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. Please follow our OpenEBS Setup documentation. Also, we have a Vagrant environment available that includes a sample Kubernetes deployment and synthetic load that you can use to simulate the performance of OpenEBS. You may also find interesting the related project called Litmus (https://www.openebs.io/litmus) which helps with chaos engineering for stateful workloads on Kubernetes.

Status

OpenEBS is one of the most widely used and tested Kubernetes storage infrastructures in the industry. A CNCF Sandbox project since May 2019, OpenEBS is the first and only storage system to provide a consistent set of software-defined storage capabilities on multiple backends (local, nfs, zfs, nvme) across both on-premise and cloud systems, and was the first to open source its own Chaos Engineering Framework for Stateful Workloads, the Litmus Project, which the community relies on to automatically readiness assess the monthly cadence of OpenEBS versions. Enterprise customers have been using OpenEBS in production since 2018 and the project supports 2.5M+ docker pulls a week.

The status of various storage engines that power the OpenEBS Persistent Volumes is provided below.

Storage Engine Status Details
Jiva stable Best suited for running Replicated Block Storage on nodes that make use of ephemeral storage on the Kubernetes worker nodes
cStor beta A preferred option for running on nodes that have Block Devices. Recommended option if Snapshot and Clones are required
Local Volumes beta Best suited for Distributed Application that need low latency storage - direct attached storage from the Kubernetes nodes.
MayaStor alpha A new storage engine that operates at the efficiency of Local Storage but also offers storage services like Replication. Development is underway to support Snapshots and Clones.

For more details, please refer to OpenEBS Documentation.

Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

Show me the Code

This is a meta-repository for OpenEBS. Please start with the pinned repositories or with OpenEBS Architecture document.

License

OpenEBS is developed under Apache 2.0 license at the project level. Some components of the project are derived from other open source projects and are distributed under their respective licenses.

OpenEBS is part of the CNCF Projects.

CNCF Sandbox Project

Commercial Offerings

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

You can’t perform that action at this time.