> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/1.3/deployment/base-infrastructure/nfs-server.md).

# NFS Server

NFS-based storage is recommended for providing persistent storage volumes to Kubernetes Clusters and backing up data of sandbox/pilot environments.

## Installation

#### Prerequisites

* One Virtual machine running on the same network as the rest of the nodes, and is accessible by them. For recommended configuration of the VM refer to [Hardware Requirements](/1.3/deployment/hardware-requirements.md)

#### Install

* Download/copy this install script from <https://github.com/OpenG2P/openg2p-deployment/blob/main/nfs-server/install-nfs-server.sh> into the NFS server machine.
* Run the script with root privileges.

  ```
  ./install-nfs-server.sh
  ```
* Make sure to edit the firewall rules of this VM to enable incoming traffic to the NFS server port `tcp 2049` and disable incoming traffic on all other ports (excluding SSH)
* For every sandbox/namespace, create a new folder in `/srv/nfs` folder on the NFS node. Suggested folder structure: `/srv/nfs/<cluster name>`. Example:

  ```
  sudo mkdir /srv/nfs/rancher
  sudo mkdir /srv/nfs/prod
  sudo mkdir /srv/nfs/staging
  sudo chmod -R 777 /srv/nfs
  ```

## Backups

If your NFS holds critical data, there should be some mechanism to backup the same. On AWS you may use the 'snapshot' feature to schedule periodic (daily/weekly) backups of the VM running NFS.

{% hint style="info" %}
The Persistent Volumes (PV) of Kubernetes create folders of corresponding names in the NFS storage. The folders are not deleted even if you delete the PV from the cluster. Hence, it is recommended that a cleanup exercise is carried out to free up space. To identify folders with their respective applications see the notes [here](/1.3/deployment/base-infrastructure/openg2p-cluster/cluster-setup.md#backups).
{% endhint %}


---

# 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.openg2p.org/1.3/deployment/base-infrastructure/nfs-server.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.