From: Sage Weil Date: Thu, 17 Jun 2021 20:15:03 +0000 (-0400) Subject: doc/cephfs: update 'nfs export {get,apply}' docs X-Git-Tag: v16.2.7~116^2~84 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=8c7fffe384afce0f7a6046fcfedfb90f3b412916;p=ceph.git doc/cephfs: update 'nfs export {get,apply}' docs Signed-off-by: Sage Weil (cherry picked from commit f0798cf0681325bb780d2737db3bf86c199c0aa1) --- diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst index 1a95a1cb01f..043dacfcd4f 100644 --- a/doc/cephfs/fs-nfs-exports.rst +++ b/doc/cephfs/fs-nfs-exports.rst @@ -272,15 +272,23 @@ where: ```` 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 ** - $ ceph nfs export update -i +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 + +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,