Release Summary
🎉 🎉 🎉 OpenEBS 3.1 is a maintenance release focused on code, tests and build refactoring along with some critical bug fixes and user enhancements. This release includes fixes for user-reported critical bugs as well as fixes and enhancements to improve the E2e test coverage.
Deprecation Notice: Jiva and cStor out-of-tree external provisioners are deprecated now in favor of the corresponding CSI Drivers. The out of tree provisioners for Jiva and cStor will stop working from Kubernetes 1.22 and forward as the version of the custom resources used by those provisioners will be deprecated. We strongly recommend you plan for migrating your volumes to cStor CSI or Jiva CSI as early as possible.
If you have any questions or need help with the migration please reach out to us on our Kubernetes Community slack channel #openebs.
Upgrade and Backward Incompatibilities
Please review this list prior to deciding to upgrade:
- Kubernetes 1.18 or higher release is recommended as this release uses features of Kubernetes that will not be compatible with older Kubernetes releases. Some of the engines might require you to have a higher Kubernetes version as the CSI drivers have been upgraded to the latest versions. For example, Kubernetes 1.19.12 or higher is recommended for using Rawfile Local PV.
- OpenEBS has deprecated arch-specific container images in favor of multi-arch container images. For example, images like
cstor-pool-arm64:x.y.xshould be replaced with corresponding multi-arch imagecstor-pool:x.y.x. - The non-csi provisioners for cstor and jiva are not included by default with 3.0 helm chart or operator.yaml. You can still continue to use them. The older provisioners are released with the v2.12.2 version at the moment and only patch releases (to fix severe security vulnerabilities) will be supported going forward. If you need help making a decision on upgrading or migrating, please reach out to us on our Kubernetes Community slack channel #openebs.
Component versions
OpenEBS is a collection of data engines and operators to create different types of replicated and local persistent volumes for Kubernetes Stateful workloads. Kubernetes volumes can be provisioned via CSI Drivers or using Out-of-tree Provisioners. The status of the various components as of v3.1.0 are as follows:
- CSI Drivers
- Mayastor 1.0.0 (beta)
- cStor 3.1.0 (stable)
- Jiva 3.1.0 (beta)
- Local PV ZFS 2.0.0 (stable)
- Local PV LVM 0.8.3 (stable)
- Local PV Rawfile 0.6.0 (beta)
- Local PV Partitions 0.6.0 (alpha)
- Out-of-tree provisioners
- Local PV hostpath 3.1.0 (stable)
- Local PV device 3.1.0 (stable)
- Dynamic NFS Volume 0.9.0 (beta)
- Other components
Change Summary
A detailed Changelog is available under the component repositories listed above. The focus was to close on the refactoring and maintenance-related activities and a few bug fixes that were required for some of the components to be declared GA or beta. Here is a quick summary of what has changed since the last release.
- Added the operator to clean up the Stale PersistentVolumeClaims (alpha)
- Enhanced Cstor storage engine to make it compatible with kernel ZFS
- Added support for zstd compression in ZFS-LocalPV
- Enhanced ZFS-LocalPV to register topologyKeys from environment
- Added Support for child dataset in CSI Storagecapacity feature for ZFS-LocalPV
- Enhanced NFS Provisioner to have support to change shared filesystem ownership and mode
- Enhanced OpenebsCtl to support creating an cStor Pool Cluster (CSPC) template
- Added error propagation for device localpv for better debugability
- Allow setting a different OPENEBS_IO_BASE_DIR (and others) in Helm chart
- Fixed the crash because of concurrent map write in cstor-csi
- Fixed Prometheus metrics issue for Jiva Volumes
- Added meta information on blockdevice to provide better disk selection
- Enhanced dynamic device localpv provisioner to bind bdc to bd using node affinity
Show your Support
Thank you @trathborne(Tom Rathborne), @jggc(Jean-Gab) for sharing your OpenEBS Adoption story.
Are you using or evaluating OpenEBS? You can help OpenEBS in its journey towards becoming a CNCF Incubation project by sharing your OpenEBS story and join the league of OpenEBS Adopters.
Shoutouts!
MANY THANKS to our existing contributors and for everyone helping OpenEBS Community going. @AVRahul @Ab-hishek @Abhinandan-Purkait @IsAmrish @Pallavi-PH @ParthS007 @semekh @z0marlin @akhilerm @anupriya0703 @avishnu @blaisedias @chriswldenyer @cjones1024 @gila @iyashu @jonathan-teh @kmova @mittachaitu @mtzaurus @mynktl @niladrih @nsathyaseelan @paulyoong @pawanpraka1 @prateekpandey14 @rajaSahil @rakeshPRaghu @satyapriyamishra222 @shovanmaity @shubham14bajpai @tiagolobocastro @vharsh @w3aman
A very special thanks to our first-time contributors to code, tests, and docs: @jdkramhoft, @ianroberts, @davidkarlsen, @abhisheksinghbaghel, @vakul-gupta-flp, @shazadbrohi, @jggc.
Documentation
Install
OpenEBS can be installed via kubectl or helm. Follow the installation instructions here.
Upgrade
The upgrade instructions for various OpenEBS engines are here.
Do not upgrade if you are using legacy cstor or jiva provisioners. You have to first migrate those to the corresponding CSI Drivers. Please reach out to us for support
Known Issues
Check our open issues uncovered through e2e and community testing.
Support
If you are having issues in setting up or upgrade, you can contact:
- OpenEBS Community for Support on Kubernetes Slack
- Already signed up? Head to our user discussions at #openebs
- Would you like to contribute to the OpenEBS project? Head to our contributor discussions at #openebs-dev
- Raise an issue
- Subscribe and reach out on our OpenEBS CNCF Mailing lists
- For OpenEBS project updates, subscribe to OpenEBS Announcements
- For interacting with other OpenEBS users, subscribe to OpenEBS Users
- Join Community Meetings