> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/additional-protocols/nfs-support.md).

# Manage the NFS protocol

Provide file access over NFS, without installing a client on the host.

NFS (Network File System) is a protocol that enables clients to access the filesystem without requiring the WEKA client software. This leverages the standard NFS implementation of the client's operating system.

The NFS implementation is compatible with NFSv3 or NFSv4[^1] protocols and overcomes inherent limitations in the NFS protocol, including support for more than 16 user security groups and NFS file-locking.

{% hint style="info" %}
**Multi-tenancy:** When NFS multi-tenancy is enabled, each tenant gets isolated client groups, exports, and floating IP addresses, and several NFS features become available only in the root organization. See [Manage NFS for tenants](https://docs.weka.io/operation-guide/weka-native-multi-tenancy-management/manage-nfs-for-tenants.md).
{% endhint %}

## Requirements

Make sure the cluster meets these requirements before you deploy the NFS service:

* **Configuration filesystem:** A persistent cluster-wide configuration filesystem is required for the protocol's internal operations using NFSv4 or Kerberos integration.
* **Interface groups:** An interface group provides the floating IP addresses that NFS clients connect to, and moves them to a healthy server when a server fails. An interface group requires a minimum of two servers.
* **Round-robin DNS:** Resolve a round-robin DNS name to the floating IPs, with a TTL of 0, and mount the NFS clients by that name.
* **File-locking services:** Stop and mask the operating system's `rpc-statd` and `rpc-statd-notify` services on each server that runs the WEKA NFS service, and keep them masked after upgrades.
* **NFS mounts:** Do not mount NFS filesystems, WEKA or external, on a server that runs the WEKA NFS service.

**Related topics**

[Additional protocol containers](https://docs.weka.io/additional-protocols/additional-protocols-overview.md#dedicated-filesystem-requirement-for-cluster-wide-persistent-protocol-configurations)

[NFS networking and high availability](https://docs.weka.io/additional-protocols/nfs-support/nfs-networking-and-high-availability.md)

[NFS networking and high availability](https://docs.weka.io/additional-protocols/nfs-support/nfs-networking-and-high-availability.md#round-robin-dns-server-configuration).

## NFS service deployment high-level workflow

The workflow shows the order of the deployment tasks, from the NFS global settings to mounting the filesystems on the clients. Follow it to deploy the NFS service for the first time. Two of the tasks run outside the cluster: the round-robin DNS configuration and the client mounts.

<div data-with-frame="true"><figure><img src="https://2945940841-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9eAUfjPZz6inqBDXaG4%2Fuploads%2Fgit-blob-546b89066c1b965906db7ad125ab5fe637b94f46%2FNFS_deploy_workflow.png?alt=media" alt=""><figcaption><p>NFS service deployment high-level workflow</p></figcaption></figure></div>

## NFS concepts

Read the concept that matches what you plan before you configure it:

| Topic                                                                                                                                     | Description                                                                                         |
| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [NFS networking and high availability](https://docs.weka.io/additional-protocols/nfs-support/nfs-networking-and-high-availability.md)     | Interface groups, floating IPs, round-robin DNS, scalability, and failover.                         |
| [NFS client access rules](https://docs.weka.io/additional-protocols/nfs-support/nfs-client-access-rules.md)                               | IP, DNS, and netgroup rules that control which clients reach an export.                             |
| [NFS authentication, identity, and ACLs](https://docs.weka.io/additional-protocols/nfs-support/nfs-authentication-identity-and-acls.md)   | Kerberos authentication, user and group resolution from a directory, and ACL flavors.               |
| [NFS server resources](https://docs.weka.io/additional-protocols/nfs-support/nfs-server-resources.md)                                     | Client connections, open files, and memory of each NFS container, and the behavior at each maximum. |
| [NFS external load balancer integration](https://docs.weka.io/additional-protocols/nfs-support/nfs-external-load-balancer-integration.md) | The health API that tells an external load balancer which NFS containers are serving.               |
| [NFS file locking](https://docs.weka.io/additional-protocols/nfs-support/nfs-file-locking.md)                                             | Byte-range advisory locking, and how to prepare the servers and clients for NFSv3 locking.          |

**Related topics**

[Manage NFS using the GUI](https://docs.weka.io/additional-protocols/nfs-support/manage-nfs-using-the-gui.md)

[Manage NFS using the CLI](https://docs.weka.io/additional-protocols/nfs-support/manage-nfs-using-the-cli.md)

[Supported NFS client mount parameters](https://docs.weka.io/additional-protocols/nfs-support/supported-nfs-client-mount-parameters.md)

[Manage NFS for tenants](https://docs.weka.io/operation-guide/weka-native-multi-tenancy-management/manage-nfs-for-tenants.md)

[^1]: NFSv4.0 and NFSv4.1


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.weka.io/additional-protocols/nfs-support.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
