.. _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
============
.. 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
``<pseudo_path>`` is the pseudo root path (must be an absolute path).
-List CephFS Exports
-===================
+List Exports
+============
.. code:: bash
With the ``--detailed`` option enabled it shows entire export block.
-Get CephFS Export
-=================
+Get Export
+==========
.. code:: bash
``<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:
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
======
* 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
============================================