]> 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)
committerSebastian Wagner <sewagner@redhat.com>
Thu, 9 Sep 2021 14:17:50 +0000 (16:17 +0200)
Signed-off-by: Sage Weil <sage@newdream.net>
(cherry picked from commit f0798cf0681325bb780d2737db3bf86c199c0aa1)

doc/cephfs/fs-nfs-exports.rst

index 1a95a1cb01f362a0ec9f36ae13b9b6bf0b07ad5e..043dacfcd4f3386a426ac3af50e3ee1c297ccd09 100644 (file)
@@ -272,15 +272,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
@@ -306,8 +314,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,