From 6e583a87052ffcf6d4dd11f46cb103515e477f20 Mon Sep 17 00:00:00 2001
From: Konrad Bucheli <konrad.bucheli@psi.ch>
Date: Mon, 29 Apr 2024 13:31:48 +0200
Subject: [PATCH] document NFS server setup

---
 _toc.yml                                |  1 +
 admin-guide/configuration.md            |  1 +
 admin-guide/configuration/nfs_server.md | 32 +++++++++++++++++++++++++
 3 files changed, 34 insertions(+)
 create mode 100644 admin-guide/configuration/nfs_server.md

diff --git a/_toc.yml b/_toc.yml
index 56b638c1..16041aa2 100644
--- a/_toc.yml
+++ b/_toc.yml
@@ -61,6 +61,7 @@ chapters:
           - file: admin-guide/configuration/journald
           - file: admin-guide/configuration/metrics_telegraf
           - file: admin-guide/configuration/ntp_server
+          - file: admin-guide/configuration/nfs_server
           - file: admin-guide/configuration/ssh_host_hopping
           - file: admin-guide/configuration/citrix_vda
           - file: admin-guide/configuration/configuration_email
diff --git a/admin-guide/configuration.md b/admin-guide/configuration.md
index 944c4045..793860ff 100644
--- a/admin-guide/configuration.md
+++ b/admin-guide/configuration.md
@@ -38,6 +38,7 @@ Here starts a so far small collections of configuration guides for sysadmins of
 
 ## Special Installations
 - [NTP Server](configuration/ntp_server)
+- [NTP Server](configuration/nfs_server)
 - [SSH Host Hopping as Root (e.g. between cluster members)](configuration/ssh_host_hopping)
 - [Install Citrix VDA](configuration/citrix_vda)
 - [Sending / Relaying Emails](configuration/configuration_email)
diff --git a/admin-guide/configuration/nfs_server.md b/admin-guide/configuration/nfs_server.md
new file mode 100644
index 00000000..6ea5491e
--- /dev/null
+++ b/admin-guide/configuration/nfs_server.md
@@ -0,0 +1,32 @@
+# NFS Server
+
+Your node can serve as NTP server.
+
+To enable the NFS server, set `base::enable_nfs_server` accordingly in Hiera:
+```
+base::enable_nfs_server: true
+```
+
+Then the exports go below `nfs_server::exports`:
+```
+  '/home/meg/dcbboot':
+    clients:
+      - hosts: '*'
+        options: 'rw,sync,no_root_squash,no_subtree_check'
+  '/export/swissfel_athos/raw/maloja-staff':
+    options: 'fsid=1012'
+    clients:
+      - hosts: 'sf-export-1[2-3]-100g'
+        options: 'rw,async,no_root_squash'
+```
+
+If you wish non-standard configuration in `/etc/nfs.conf`, you may set it in Hiera with key `nfs_server::nfs_conf`:
+
+```
+nfs_server::nfs_conf:
+  nfsd:
+    udp: 'y'
+    vers3: 'n'
+```
+
+If you need/want to provide Kerberos authenticated access, please speak to the Core Linux Team.