]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephfs: update 'nfs export {get,apply}' docs
authorSage Weil <sage@newdream.net>
Thu, 17 Jun 2021 20:15:03 +0000 (16:15 -0400)
committerSage Weil <sage@newdream.net>
Mon, 21 Jun 2021 18:13:15 +0000 (14:13 -0400)
Signed-off-by: Sage Weil <sage@newdream.net>
doc/cephfs/fs-nfs-exports.rst

index fde0a4c57411ac09e91ff89d813fbeec9373c257..6d08323bccd822e7e190da431baa24fc8278532e 100644 (file)
@@ -273,15 +273,23 @@ where:
 ``<binding>`` is the pseudo root path (must be an absolute path).
 
 
-Update CephFS Export
-====================
+Create or update CephFS Export via JSON specification
+=====================================================
 
-.. code:: bash
+An existing export can be dumped in JSON format with:
+
+.. prompt:: bash #
+
+    ceph nfs export get *<pseudo-path>*
 
-    $ ceph nfs export update -i <json_file>
+An export can be created or modified by importing a JSON description in the
+same format:
 
-This updates the cephfs export specified in the json file. Export in json
-format can be fetched with above get command. For example::
+.. prompt:: bash #
+
+    ceph nfs export apply -i <json_file>
+
+For example,::
 
    $ ceph nfs export get vstart /cephfs > update_cephfs_export.json
    $ cat update_cephfs_export.json
@@ -307,8 +315,11 @@ format can be fetched with above get command. For example::
      },
      "clients": []
    }
-   # Here in the fetched export, pseudo and access_type is modified. Then the modified file is passed to update interface
-   $ ceph nfs export update -i update_cephfs_export.json
+
+The exported JSON can be modified and then reapplied.  Here, *pseudo*
+and *access_type* are modified::
+
+   $ ceph nfs export apply -i update_cephfs_export.json
    $ cat update_cephfs_export.json
    {
      "export_id": 1,