From: Sage Weil <sage@newdream.net>
Date: Fri, 9 Jul 2021 15:32:45 +0000 (-0400)
Subject: doc/cephfs/fs-nfs-exports: document new export apply capabilities
X-Git-Tag: v17.1.0~1390^2~6
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=3cfd779e5b5ce1307baece4267d3b94f1004786b;p=ceph.git

doc/cephfs/fs-nfs-exports: document new export apply capabilities

- import list
- import ganesha conf

Signed-off-by: Sage Weil <sage@newdream.net>
---

diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst
index a6ec25547ed5..1aa8706f2760 100644
--- a/doc/mgr/nfs.rst
+++ b/doc/mgr/nfs.rst
@@ -342,6 +342,9 @@ For example,::
      "clients": []
    }
 
+The imported JSON can be a single dict describing a single export, or a JSON list
+containing multiple export dicts.
+
 The exported JSON can be modified and then reapplied.  Below, *pseudo*
 and *access_type* are modified.  When modifying an export, the
 provided JSON should fully describe the new state of the export (just
@@ -351,7 +354,7 @@ previous state of the export where possible.
 
 ::
 
-   $ ceph nfs export apply -i update_cephfs_export.json
+   $ ceph nfs export apply mynfs -i update_cephfs_export.json
    $ cat update_cephfs_export.json
    {
      "export_id": 1,
@@ -376,6 +379,27 @@ previous state of the export where possible.
      "clients": []
    }
 
+An export can also be created or updated by injecting a Ganesha NFS EXPORT config
+fragment.  For example,::
+
+   $ ceph nfs export apply mynfs -i update_cephfs_export.conf
+   $ cat update_cephfs_export.conf
+   EXPORT {
+       FSAL {
+           name = "CEPH";
+           filesystem = "a";
+       }
+       export_id = 1;
+       path = "/";
+       pseudo = "/a";
+       access_type = "RW";
+       squash = "none";
+       attr_expiration_time = 0;
+       security_label = true;
+       protocols = 4;
+       transports = "TCP";
+   }
+
 
 Mount
 =====