From: Varsha Rao <varao@redhat.com>
Date: Mon, 18 Jan 2021 16:24:32 +0000 (+0530)
Subject: doc/cephfs/nfs: Add rook pod restart note, export and log block example
X-Git-Tag: v17.1.0~3082^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=01db81e2bc8bae908bcd3600dc9b54fb80c2a554;p=ceph.git

doc/cephfs/nfs: Add rook pod restart note, export and log block example

Fixes: https://tracker.ceph.com/issues/48914
Signed-off-by: Varsha Rao <varao@redhat.com>
---

diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst
index 6d69284354f3c..b7ca99d41e493 100644
--- a/doc/cephfs/fs-nfs-exports.rst
+++ b/doc/cephfs/fs-nfs-exports.rst
@@ -104,6 +104,37 @@ Set Customized NFS Ganesha Configuration
 With this the nfs cluster will use the specified config and it will have
 precedence over default config blocks.
 
+Example use cases
+
+1) Changing log level
+
+  It can be done by adding LOG block in the following way::
+
+   LOG {
+    COMPONENTS {
+        ALL = FULL_DEBUG;
+    }
+   }
+
+2) Adding custom export block
+
+  The following sample block creates a single export. This export will not be
+  managed by `ceph nfs export` interface::
+
+   EXPORT {
+     Export_Id = 100;
+     Transports = TCP;
+     Path = /;
+     Pseudo = /ceph/;
+     Protocols = 4;
+     Access_Type = RW;
+     Attr_Expiration_Time = 0;
+     Squash = None;
+     FSAL {
+       Name = CEPH;
+     }
+   }
+
 Reset NFS Ganesha Configuration
 ===============================
 
@@ -113,6 +144,9 @@ Reset NFS Ganesha Configuration
 
 This removes the user defined configuration.
 
+.. note:: With a rook deployment, ganesha pods must be explicitly restarted
+   for the new config blocks to be effective.
+
 Create CephFS Export
 ====================