latest
latest1.0.02.1.02.0.01.12.01.11.01.10.01.9.02.2.01.7.01.6.01.5.01.4.01.3.01.2.01.1.01.8.0

›User Guides

Introduction

  • Overview
  • Features and Benefits
  • Alpha Features
  • Use cases
  • Releases
  • Support

Concepts

  • Container Attached Storage
  • OpenEBS Architecture
  • CAS Engines
  • NDM
  • cStor
  • Jiva
  • Local PV
  • Read-Write-Many (RWM)

User Guides

  • Quickstart
  • Prerequisites
  • Installation
  • NDM
  • cStor
  • Jiva
  • Local PV Hostpath
  • Local PV Device
  • mayactl
  • Upgrade
  • Uninstall

Stateful Applications

  • RDS like MySQL
  • Prometheus
  • MinIO
  • GitLab
  • Percona
  • Elasticsearch
  • Cassandra
  • NuoDB
  • PostgreSQL
  • Redis
  • MongoDB
  • Jira

Troubleshooting

  • Overview
  • Install
  • Uninstall
  • NDM
  • Volume Provisioning
  • Jiva
  • cStor

Additional Info

  • Performance testing
  • FAQs
  • Kubernetes upgrades
  • Knowledge Base

Deprecated Releases

  • Releases 0.x
EditCreate An Issue

Quickstart Guide to OpenEBS



OpenEBS configuration flow


Steps:

  • Kubernetes 1.13+ installed. Latest tested Kubernetes version is 1.17.2.
  • For using features like Local PV and Backup & Restore, you must have Kubernetes version 1.13 or above.
  • For provisioning cStor volume via CSI driver support and performing basic operations on this volume such as expanding volume and snapshot & clone, you must have Kubernetes version 1.14 or above
  • Understand the pre-requisites for your Kubernetes platform
  • Start installation through OpenEBS operator.
  • For production deployments or to test OpenEBS volumes on real disks, create cStorPools, cStor-StorageClasses and start provisioning volumes using the newly created cStor-StorageClasses. More details can be found from here.
  • For applications requiring high performance, which manage their own replication, data protection and other storage features, provision OpenEBS Local PV. More details can be found here.


As a first step, follow the instructions to setup or verify iSCSI clients on any of the platforms below

Ubuntu

RHEL

CentOS

OpenShift

Rancher

ICP

EKS

GKE

AKS

Digital Ocean

Konvoy


Provide feedback if a platform is missing in the above list




Feedback


Was this page helpful?

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/.

← Provisioning Read-Write-Many (RWM) PVCsPrerequisites (iSCSI client) →

Get in touch with OpenEBS community