From 387369373cba9f569b5fd84e64fffb0fe8de6821 Mon Sep 17 00:00:00 2001 From: Varsha Rao Date: Mon, 12 Jul 2021 13:01:49 +0530 Subject: [PATCH] doc/mgr/nfs: update about RGW exports This patch just moves the RGW exports created using nfs module to mgr/nfs document. The RGW requirements will be updated in a different PR. Signed-off-by: Varsha Rao --- doc/mgr/nfs.rst | 42 ++++++++++++++++++++++++++++------------ doc/radosgw/nfs.rst | 47 +++------------------------------------------ 2 files changed, 33 insertions(+), 56 deletions(-) diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst index 51182f39ec189..a6ec25547ed51 100644 --- a/doc/mgr/nfs.rst +++ b/doc/mgr/nfs.rst @@ -1,11 +1,12 @@ .. _mgr-nfs: -======================= -CephFS Exports over NFS -======================= +============================= +CephFS & RGW Exports over NFS +============================= -CephFS namespaces can be exported over NFS protocol using the `NFS-Ganesha NFS server`_ +CephFS namespaces and RGW buckets can be exported over NFS protocol using the +`NFS-Ganesha NFS server`_ Requirements ============ @@ -240,8 +241,25 @@ permissible values. .. note:: Export creation is supported only for NFS Ganesha clusters deployed using nfs interface. -Delete CephFS Export -==================== +Create RGW Export +================= + +To export a bucket + +.. code:: + + $ ceph nfs export create rgw [--readonly] [--client_addr ...] [--realm ] + +For example, to export *mybucket* via NFS cluster *mynfs* at the pseudo-path */bucketdata* to any host in the ``192.168.10.0/24`` network + +.. code:: + + $ ceph nfs export create rgw mybucket mynfs /bucketdata --client_addr 192.168.10.0/24 + +.. note:: Export creation is supported only for NFS Ganesha clusters deployed using nfs interface. + +Delete Export +============= .. code:: bash @@ -253,8 +271,8 @@ This deletes an export in an NFS Ganesha cluster, where: ```` is the pseudo root path (must be an absolute path). -List CephFS Exports -=================== +List Exports +============ .. code:: bash @@ -266,8 +284,8 @@ It lists exports for a cluster, where: With the ``--detailed`` option enabled it shows entire export block. -Get CephFS Export -================= +Get Export +========== .. code:: bash @@ -281,8 +299,8 @@ where: ```` is the pseudo root path (must be an absolute path). -Create or update CephFS Export via JSON specification -===================================================== +Create or update Export via JSON specification +============================================== An existing export can be dumped in JSON format with: diff --git a/doc/radosgw/nfs.rst b/doc/radosgw/nfs.rst index 9be7572686fb8..336736e4cc59a 100644 --- a/doc/radosgw/nfs.rst +++ b/doc/radosgw/nfs.rst @@ -11,6 +11,9 @@ protocols (S3 and Swift). In particular, the Ceph Object Gateway can now be configured to provide file-based access when embedded in the NFS-Ganesha NFS server. +The simplest and preferred way of managing nfs-ganesha clusters and rgw exports +is using ``ceph nfs ...`` commands. See :doc:`/mgr/nfs` for more details. + librgw ====== @@ -98,50 +101,6 @@ following characteristics: * additional RGW authentication types such as Keystone are not currently supported - -Enabling a bucket export -======================== - -.. note: If you do not already have NFS service deployed, see - :ref:`deploy-cephadm-nfs-ganesha`. - -To export a bucket, - - .. prompt:: bash # - - ceph nfs export create rgw ** ** ** [--readonly] [--addr ** - -For example, to export *mybucket* via NFS cluster *mynfs* at the pseudo-path */bucketdata* to any host in the ``192.168.10.0/24`` network, - - .. prompt:: bash # - - ceph nfs export create rgw mybucket mynfs /bucketdata --addr 192.168.10.0/24 - -Listing exports -=============== - -You can list current exports with: - - .. prompt:: bash # - - ceph nfs export ls ** [--detailed] - -Disabling a bucket export -========================= - -To disable an existing export, - - .. prompt:: bash # - - ceph nfs export rm ** ** - -For example, to disable an export from cluster *mynfs* on ``/my-export``, - - .. prompt:: bash # - - ceph nfs export rm mynfs /my-export - - Manually configuring an NFS-Ganesha Instance ============================================ -- 2.39.5