Skip to content

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sushant-suse
Copy link
Contributor

@sushant-suse sushant-suse commented Mar 27, 2025

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

Signed-off-by: sushant-suse <sushant.gaurav@suse.com>
@sushant-suse sushant-suse requested a review from a team as a code owner March 27, 2025 07:56
@sushant-suse sushant-suse requested a review from derekbit March 27, 2025 07:56
Copy link

netlify bot commented Mar 27, 2025

Deploy Preview for longhornio ready!

Name Link
🔨 Latest commit e9e52ad
🔍 Latest deploy log https://app.netlify.com/sites/longhornio/deploys/67e5049586c9d8000803b019
😎 Deploy Preview https://deploy-preview-1079--longhornio.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@jillian-maroket jillian-maroket left a 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.

Comment on lines +216 to +218
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**.
Copy link
Contributor

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?

@sushant-suse
Copy link
Contributor Author

The info you added already exists in the doc. Check my comment.

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.
This addition clarifies that the kernel support checks are a prerequisite, but the active NFS version is what matters for Longhorn functionality.

I asked Derek, and he suggested that we should not change the original doc, rather mention in a few sentences

For longhorn, some functionalities use NFS
backup/restore: use NFS4.2, NFS4.1 or NFS4.0.
rwx volume: use NFS4.1

@jillian-maroket
Copy link
Contributor

@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.

Some Longhorn features require specific NFS versions to function correctly. Before installing the NFSv4 client userspace daemon and utilities, verify that your kernel supports one of the following NFS versions:

  • Backup/Restore functionality: NFSv4.0, NFSv4.1, or NFSv4.2
  • ReadWriteMany (RWX) volumes: NFSv4.1

You can check if the kernel supports the listed NFS versions by running the following commands:

  • NFSv4.1: cat /boot/config-uname -r| grep CONFIG_NFS_V4_1
  • NFSv4.2: cat /boot/config-uname -r| grep CONFIG_NFS_V4_2

Important: You must also verify that the required NFS versions are in use.

@derekbit
Copy link
Member

derekbit commented Mar 28, 2025

@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.

Some Longhorn features require specific NFS versions to function correctly. Before installing the NFSv4 client userspace daemon and utilities, verify that your kernel supports one of the following NFS versions:

  • Backup/Restore functionality: NFSv4.0, NFSv4.1, or NFSv4.2
  • ReadWriteMany (RWX) volumes: NFSv4.1

You can check if the kernel supports the listed NFS versions by running the following commands:

  • NFSv4.1: cat /boot/config-uname -r| grep CONFIG_NFS_V4_1
  • NFSv4.2: cat /boot/config-uname -r| grep CONFIG_NFS_V4_2

Important: You must also verify that the required NFS versions are in use.

Sounds good. @sushant-suse Can you respond to the jira ticket and check the report's response?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants