OpenEBS
Generated on 30 Sep 2021 from the OpenEBS catalog page
Container Attached Storage – OpenEBS is a Kubernetes native, 100% open source and 100% in userspace Cloud Native Storage (CNS) solution for container stateful applications in Kubernetes. OpenEBS is currently a CNCF Sandbox project and the most active Container Attached Storage (CAS) solution with the biggest user base and community.
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: Your stateful data can persistence across nodes, dramatically reducing time spent rebuilding failed workloads for example. Synchronization of data across availability zones and cloud providers improving availability and decreasing attach/detach times for example.
OpenEBS 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 granularity of control and Kubernetes native behavior. You can find out more about OpenEBS at openebs.io. Commercial support options for OpenEBS is provided by MayaData, see mayadata.io for additional details.
Minimum and Recommended Configuration
Note:
- This stack requires a minimum configuration of 1 Node at the $10/month plan (2GB memory / 1 vCPU) for LocalPV.
- For Jiva or cStor,the recommended configuration is 3 Nodes at the $20/month plan (4GB memory / 2 vCPUs) or higher and iSCSI should be installed and enabled on all worker nodes. 3 Node cluster is required to provide data high availability in case of node failures.
Software Included
Package | Version | License |
---|---|---|
OpenEBS | 3.0.0 | Apache 2 |
Creating an App using the Control Panel
Click the Deploy to DigitalOcean button to install a Kubernetes 1-Click Application. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.
Creating an App using the API
In addition to creating OpenEBS using the control panel, you can also use the DigitalOcean API. As an example, to create a 3 node DigitalOcean Kubernetes cluster made up of Basic Droplets in the SFO2 region, you can use the following doctl
command. You need to authenticate with doctl
with your API access token) and replace the $CLUSTER_NAME
variable with the chosen name for your cluster in the command below.
doctl kubernetes clusters create --size s-4vcpu-8gb $CLUSTER_NAME --1-clicks openebs
Getting Started After Deploying OpenEBS
After you have successfully deployed OpenEBS, then downloaded your kube config file, and are able to successfully connect to your DigitalOcean Kubernetes cluster (see https://cloud.digitalocean.com/kubernetes/clusters/ if you haven’t connected to your cluster) follow the instructions below to start using OpenEBS to manage your Container Attached Storage.
Verifying OpenEBS Pods
Verify the cluster is running OpenEBS pods in the openebs
namespace as expected:
kubectl get pod -n openebs -l openebs.io/version=3.0.0
You should see a list of pods running in the cluster similar to the following:
NAME READY STATUS RESTARTS AGE
openebs-localpv-provisioner-766d5f8b5d-glnd9 1/1 Running 0 4m37s
openebs-ndm-42zcs 1/1 Running 0 4m37s
openebs-ndm-9fw55 1/1 Running 0 4m37s
openebs-ndm-flfsg 1/1 Running 0 4m37s
openebs-ndm-operator-766cb8b878-qcbqg 1/1 Running 0 4m37s
Verifying OpenEBS Storage Classes
After verifying OpenEBS pods are running, you can check the OpenEBS Storage Classes:
kubectl get sc
You should see a list of default OpenEBS storage classes and DigitalOcean storage classes similar to the following:
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
do-block-storage (default) dobs.csi.digitalocean.com Delete Immediate true 9m31s
openebs-device openebs.io/local Delete WaitForFirstConsumer false 4m52s
openebs-hostpath openebs.io/local Delete WaitForFirstConsumer false 4m52s
Configuring Storage Pools
From here you’re ready to start configuring your Storage Pools. Please visit OpenEBS Getting Started Documentation for configuring Storage Pools and more.
In case you are using OpenEBS Dynamic LocalPV Provisioner please visit OpenEBS Local PV concepts
Managing OpenEBS
Updating
To update your installation of OpenEBS
helm repo add openebs https://openebs.github.io/charts
helm repo update
List the details of the currently installed OpenEBS version.
helm list --namespace openebs
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
openebs openebs 1 2021-09-30 03:26:23.783786715 +0000 UTC deployed openebs-3.0.0 3.0.0
If the latest version is available for upgrade, then you can do the OpenEBS upgrade using the following command.
helm upgrade $NAME openebs/openebs --namespace openebs
Note: Replace $NAME with the release name from the above command (In this case openebs
), then it will upgrade to the latest available version of OpenEBS.
Deleting
To delete your installation of OpenEBS
First, get the name of the release.
helm list --namespace openebs
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
openebs openebs 1 2021-09-30 03:26:23.783786715 +0000 UTC deployed openebs-3.0.0 3.0.0
To uninstall an OpenEBS version.
helm uninstall $NAME --namespace openebs
Note: Replace $NAME with the release name from the above command (In this case openebs
)