-
Notifications
You must be signed in to change notification settings - Fork 178
docs: Clarify NFS version requirements for Longhorn features #1079
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
base: master
Are you sure you want to change the base?
docs: Clarify NFS version requirements for Longhorn features #1079
Conversation
Signed-off-by: sushant-suse <sushant.gaurav@suse.com>
✅ Deploy Preview for longhornio ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The info you added already exists in the doc. Check my comment.
To ensure Longhorn features function correctly, verify both that your kernel supports the required NFS versions and that the correct version is actively in use. | ||
- Backup/Restore functionality requires **NFSv4.2**, **NFSv4.1**, or **NFSv4.0**. | ||
- ReadWriteMany (RWX) volumes require **NFSv4.1**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 204 contains the same information. How does the new content address the customer's pain points?
The customer's pain point was that the documentation only checked for kernel support for NFSv4, v4.1, and v4.2, but didn't guide on active NFS version being used by the system. Simply having kernel support doesn't guarantee the correct version is in use, which could lead to issues with Longhorn's backup/restore and RWX volume features. Line 204 mentions the NFS version requirements for Longhorn and the need for kernel support, it does not tells above the active NFS version on their system. I asked Derek, and he suggested that we should not change the original doc, rather mention in a few sentences
|
@sushant-suse @derekbit Part of our job is to ensure that users are not forced to read unnecessarily lengthy documentation. Why add a block of text within the same section if we can reorganize the existing content to accommodate new information? This is not my task so you can make the final call. Just letting you know that this is how I would respond to the customer's feedback.
|
Sounds good. @sushant-suse Can you respond to the jira ticket and check the report's response? |
Which issue(s) this PR fixes:
Issue- JIRA: 9609
What this PR does / why we need it:
It updates the documentation (for installation in 1.9.x, 1.8.x, 1.7.x and 1.6.x.) to clarify the NFS version checks for Longhorn functionalities. It adds a clarification regarding the required NFS versions (NFSv4, NFSv4.1, and NFSv4.2) for Backup/Restore and ReadWriteMany (RWX) volumes.
Special notes for your reviewer:
The changes are primarily documentation updates, and there are no code modifications.
Additional documentation or context
No