]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/mgr/nfs: update about RGW exports
authorVarsha Rao <varao@redhat.com>
Mon, 12 Jul 2021 07:31:49 +0000 (13:01 +0530)
committerVarsha Rao <varao@redhat.com>
Tue, 13 Jul 2021 09:34:54 +0000 (15:04 +0530)
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 <varao@redhat.com>
doc/mgr/nfs.rst
doc/radosgw/nfs.rst

index 51182f39ec189688f0272ada12d0fe21402f2d51..a6ec25547ed5183549e7ae3d9b216442b53aa94d 100644 (file)
@@ -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 <bucket_name> <cluster_id> <pseudo_path> [--readonly] [--client_addr <value>...] [--realm <value>]
+
+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:
 
 ``<pseudo_path>`` 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:
 ``<pseudo_path>`` 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:
 
index 9be7572686fb8f9a3b428a47eb6fef242b15bc19..336736e4cc59a8220a035187c94b4b73091e35d6 100644 (file)
@@ -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 *<bucket-name>* *<cluster-id>* *<pseudo>* [--readonly] [--addr *<client-ip-or-cidr>*
-
-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 *<cluster-id>* [--detailed]
-
-Disabling a bucket export
-=========================
-
-To disable an existing export,
-
-  .. prompt:: bash #
-
-    ceph nfs export rm *<cluster-id>* *<pseudo>*
-
-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
 ============================================