Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update OpenEBS Drivers and remove cStor #615

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

krishnaGajabi
Copy link

No description provided.

Cstore is now deprecated.
added new drivers from openebs project
Cstor is now deprecated
Added new drivers from openebs project
1. OpenEBS Mayastor
2. OpenEBS Local PV LVM
3. OpenEBS Local PV ZFS
Removed OpenEBS Cstor as it is deprecated.
Added Drives for the following Openebs Engines.
1. OpenEBS Replicated PV Mayastor
2. OpenEBS Local PV LVM
3. OpenEBS Local PV ZFS
@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Mar 5, 2025
Copy link

linux-foundation-easycla bot commented Mar 5, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: krishnaGajabi
Once this PR has been reviewed and has the lgtm label, please assign xing-yang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from lpabon and xing-yang March 5, 2025 12:14
@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 5, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @krishnaGajabi!

It looks like this is your first PR to kubernetes-csi/docs 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/docs has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 5, 2025
@krishnaGajabi
Copy link
Author

Release Notes: Update Driver Documentation for OpenEBS CSI Drivers

Pull Request: [#615]

Description:

This pull request updates the driver.md documentation to reflect the deprecation of the legacy OpenEBS cStor driver and introduces the recommended CSI drivers for modern OpenEBS deployments. This update adds documentation for Mayastor Replicated PV, Local PV LVM, and Local PV ZFS Data engines.

Changes:

  • Deprecated cStor: Marked the OpenEBS cStor driver as deprecated.
  • Introduced Mayastor Replicated PV: Added comprehensive documentation for the OpenEBS Mayastor CSI driver, highlighting its capabilities for high-availability replicated persistent volumes.
  • Introduced Local PV LVM: Added detailed documentation for the OpenEBS Local PV LVM CSI driver, emphasizing its suitability for high-performance local storage leveraging LVM.
  • Introduced Local PV ZFS: Added detailed documentation for the OpenEBS Local PV ZFS CSI driver, emphasizing its suitability for high-performance local storage leveraging ZFS.

Rationale:

The OpenEBS cStor driver is considered legacy and is no longer the recommended solution for new deployments. The CSI drivers for Mayastor, Local PV LVM, and Local PV ZFS offer improved performance, stability, and features. This update ensures that users are guided towards the current best practices for OpenEBS storage provisioning, and now includes ZFS local provisioning.

Impact:

  • Users will be provided with clear guidance on using the recommended CSI drivers for Mayastor, Local PV LVM, and Local PV ZFS.
  • The documentation will reflect the current state of OpenEBS driver support, including the addition of ZFS based local provisioning.

Testing:

  • Documentation has been reviewed for accuracy and clarity.
  • Verification that the document builds correctly.
  • Verification that all three new drivers have accurate documentation.

@krishnaGajabi
Copy link
Author

Hi @xing-yang , this PR includes updates to the documentation with OpenEBS CSI Drivers. Please review the changes and let me know your thoughts. Thanks!"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants