Single-Click OpenEBS Upgrade

This blog post provides a glimpse of the OpenEBS Director, and one of the most anticipated features, OpenEBS Upgrade.

OpenEBS Upgrade has always been very important as well as a tedious part of the OpenEBS day-to-day operations.

Tedious work

Upgrading OpenEBS components the traditional way is very tedious, i.e., you have to upgrade volumes one at a time, then keep watching the logs of the upgrading job to see whether it is successful or not. Together, this process makes for a very cumbersome task.

OpenEBS Upgrade via Director

The good news is that we now have a solution for this: OpenEBS Director. Director is free for primary usage and is available both as a SaaS service and OnPrem (as a Kubernetes-native application).

1OpenEBS Upgrade via Director

It supports upgrades to even the latest OpenEBS version, 1.4, and it can even complete that too with a single click. Multiple pools and volumes can also be updated at once. Director’s GUI allows you to continuously monitor the upgrade status of all resources being upgraded. Later, you can also look at the upgrade history, which shows details from all previous upgrades conducted through Director.

Steps for OpenEBS Upgrade via Director

  1. Connect your OpenEBS cluster to Director. To connect your cluster to Director Online, follow these steps.
  2. After connecting your cluster to Director Online,
    a. Go to Clusters on the sidebar menu.
    b. Click the OpenEBS cluster that you want to upgrade.
    c. Go to OpenEBS (You can handle all upgrade-related activities from here).
  3. Now, you can see the OpenEBS control-plane components listed within the Control Plane tab.

Note: We are not supporting the control-plane component’s upgrade through Director just yet. You can follow these steps to upgrade control-plane components on your own. The control-plane upgrade will be supported in upcoming releases.

Control Plane components

4. Click on the cStor Pools tab, where you can view all CSPCs and cStor Pools.

Note: Upgrade functionality is still under active development. We strongly recommend you schedule downtime for the application using the OpenEBS PV while performing this upgrade. Also, ensure you have taken a backup of the data before starting the following upgrade procedure.

All cStor pools are grouped by their version.

3cStor Pools (CSPC view)

In the image above, you can see the pools, which are in the 1.3.0 version with CSPC view enabled.

There are two views that can be selected to list the cStor pools:

a. CSPC view: cStor pools will be displayed based on the CSPC to which they belong. All CSPCs and their pools can be seen in this view (the image above is an example of this view).

b. Pool view: This view will list all pools in the selected version.

pool view cStor Pools (Pool view)

Note: An upgrade option is available for upgrading all the pools of a CSPC at once, as well as for one pool at a time. The upgrade can be triggered after selecting the available upgrade versions from Upgrade to the dropdown list.

unnamedTrigger Upgrade

5. Click View live status or the Live button located at the top right to view the live status of the ongoing upgrades.

5Pool Upgrade Live Status

6. Click on the individual resources to view the detailed upgrade status of that particular resource.

6Link to view detailed upgrade status of pools
7Pool Upgrade Detailed Status

7. Similarly, you can upgrade OpenEBS volumes once the corresponding pools have been upgraded (in cases of cStor).

All OpenEBS Volumes are also grouped by their version.

There are also two views for volumes, which can be selected to list the volumes as follows:

a. Application view: All the applications and their corresponding volumes will be listed per the selected volume version.

8OpenEBS Volumes (Application view)

b. Volumes view: All volumes belonging to the selected version will be listed.

9OpenEBS Volumes (Volumes view)

Note: All the volumes of an application can be upgraded at once by selecting the available upgrade version from the Upgrade to the dropdown list and triggering the upgrade. Follow Steps 5 and 6 to view the live status of the volumes being upgraded.11

Link to view detailed upgrade status of volumes

Volumes Upgrade In Progress

Volume Upgrade Live Status

Volume Upgrade Detailed Status

12Volume Upgrade Detailed Status

8. You can view the upgrade history of all upgrades you have conducted via OpenEBS Director. Simply click the History button located at the top right to view your upgrade history.

13OpenEBS Upgrade History


Now OpenEBS users can easily upgrade their OpenEBS components with just a single click using OpenEBS Director, and they can do it for free! Users can now freely access a GUI that displays the detailed upgrade status of all resources being upgraded as well as the upgrade history. Sign up now at MayaData to upgrade your OpenEBS components with just a single click.

Important Links

Join the OpenEBS community —


Pawan Sharma
It's been an amazing experience in Software Engineering because of my love for coding. I have a very good system understanding and I enjoy solving puzzles. In my free time, I read books, play table tennis and watch tv series
Shivesh Abhishek
As a software engineer at MayaData, Shivesh has worked on integrating and configuring the logging stack(EFK stack) in DirectorOnline. Currently, he is handling the monitoring of applications and volumes and trying to bring more features to it. In parallel, he's preparing for the CKA exam. In his free time, he likes to explore GitHub trending projects, read books and blogs, code, and play guitar.
Harshvardhan Karn
Harshvardhan Karn works at MayaData Inc. He initially started with ReactJS and gradually moved to started contributing to projects based on GoLang, JavaScript, and Python per se. He was an active contributor to LitmusChaos before he moved full time working in DirectorOnline. He is fascinated by small ARM computers like Raspberry Pi. He is a public speaker, has talked in few local meetups and at two major conferences, ContainerDays 2019 - Hamburg & Rejekts 2019, San Diego. In his free time, he likes to play Guitar, Netflix and trying to learn Español, Dutch & Hebrew.