From f0798cf0681325bb780d2737db3bf86c199c0aa1 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Thu, 17 Jun 2021 16:15:03 -0400 Subject: [PATCH] doc/cephfs: update 'nfs export {get,apply}' docs Signed-off-by: Sage Weil --- doc/cephfs/fs-nfs-exports.rst | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst index fde0a4c5741..6d08323bccd 100644 --- a/doc/cephfs/fs-nfs-exports.rst +++ b/doc/cephfs/fs-nfs-exports.rst @@ -273,15 +273,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 @@ -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, -- 2.47.3