# 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](https://docs.openg2p.org/operations/deployment/scaling/hardware-requirements)

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

  ```bash
  ./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)
* Create a new folder in `/srv/nfs` folder on the NFS node. Suggested folder structure: `/srv/nfs/<cluster name>`.

  ```bash
  Example:
  sudo mkdir /srv/nfs/rancher
  sudo mkdir /srv/nfs/prod
  sudo mkdir /srv/nfs/staging
  ```
* Run this command to provide full accces for `nfs` folder.

  ```bash
  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](https://docs.openg2p.org/operations/deployment/scaling/openg2p-cluster/cluster-setup#backups).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.openg2p.org/operations/deployment/scaling/base-infrastructure/nfs-server.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.