Welcome to OpenEBS Documentation

Documentation for OpenEBS v1.12.0 is no longer actively maintained. The version you are currently viewing is a static snapshot. Click here for the latest version.

Introduction

OpenEBS is the leading open-source project for container-attached and container-native storage on Kubernetes. OpenEBS adopts Container Attached Storage (CAS) approach, where each workload is provided with a dedicated storage controller. OpenEBS implements granular storage policies and isolation that enable users to optimize storage for each specific workload. OpenEBS runs in user space and does not have any Linux kernel module dependencies. See OpenEBS Features & Benefits and Use cases.

Quickstart

  • OpenEBS requires iSCSI client to be configured and iscsid service running on the worker nodes. Verify if iSCSI service is up and running before starting the installation.

  • Default installation works in most of the cases. As a Kubernetes cluster-admin, start the default installation using either

    1. helm repo add openebs https://openebs.github.io/charts
    2. helm repo update
    3. helm install --namespace openebs --name openebs openebs/openebs

    More information about OpenEBS installation using different Helm versions can be found here.

    (or)

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

    For advanced installation steps, see Installation section.

  • Verify if OpenEBS is installed successfully and start provisioning OpenEBS volumes through Kubernetes PVC interface by using kubectl command. For more details on how to provision different types of OpenEBS volumes, see guides for cStor Volume, Jiva Volume, OpenEBS Local Volume - Hostpath and OpenEBS Local Volume - Device.

Explore documentation

OpenEBS Architecture

OpenEBS quick start

OpenEBS platforms

OpenEBS use cases

Troubleshooting OpenEBS

OpenEBS Support

Run stateful applications on OpenEBS

OpenEBS Architecture

OpenEBS Archipdate ntecture

OpenEBS Architecture

OpenEBS Minio

OpenEBS Redis

OpenEBS NFS

OpenEBS Architecture

OpenEBS Architecture

OpenEBS Architecture

OpenEBS for Percona

OpenEBS for NuoDB

OpenEBS for MongoDB

See Also:

Container Attached Storage (CAS)

CNCF CAS Blog

OpenEBS architecture

Feedback

Was this page helpful?

YesNo

Thanks for the feedback. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement. Engage and get additional help on https://kubernetes.slack.com/messages/openebs/.