From: Varsha Rao <varao@redhat.com>
Date: Tue, 25 Feb 2020 14:21:06 +0000 (+0530)
Subject: doc: Add document about fs nfs interface to create CephFS exports
X-Git-Tag: v16.1.0~2626^2~17
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=48c8e8b546066085c9a32c7214c34efd15692a4d;p=ceph.git

doc: Add document about fs nfs interface to create CephFS exports

Signed-off-by: Varsha Rao <varao@redhat.com>
---

diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst
new file mode 100644
index 000000000000..5f2b6e501917
--- /dev/null
+++ b/doc/cephfs/fs-nfs-exports.rst
@@ -0,0 +1,61 @@
+=======================
+CephFS Exports over NFS
+=======================
+
+CephFS namespaces can be exported over NFS protocol using the
+`NFS-Ganesha NFS server <https://github.com/nfs-ganesha/nfs-ganesha/wiki>`_.
+
+Requirements
+============
+
+-  Latest Ceph file system with mgr and dashboard enabled
+-  'nfs-ganesha', 'nfs-ganesha-ceph' and nfs-ganesha-rados-grace packages
+   (version 2.7.6-2 and above)
+
+Create NFS Ganesha Cluster
+==========================
+
+.. code:: bash
+
+    $ ceph fs nfs cluster create [--size=1] <cluster_id>
+
+This creates a common recovery pool for all Ganesha daemons, new user based on
+cluster_id and common ganesha config rados object.
+
+Here size denotes the number of ganesha daemons within a cluster.
+
+.. note:: This does not setup ganesha recovery database and start the daemons.
+          It needs to be done manually if not using vstart for creating
+          clusters. Please refer `ganesha-rados-grace doc
+          <https://github.com/nfs-ganesha/nfs-ganesha/blob/next/src/doc/man/ganesha-rados-grace.rst>`_
+
+Create CephFS Export
+====================
+
+.. code:: bash
+
+    $ ceph fs nfs export create <fsname> <binding> [--readonly] [--path=/path/in/cephfs] [--attach=<cluster_id>]
+
+It creates export rados objects containing the export block. Here binding is
+the pseudo root name.
+
+Configuring NFS-Ganesha to export CephFS with vstart
+====================================================
+
+.. code:: bash
+
+    $ MDS=1 MON=1 OSD=3 GANESHA=1 ../src/vstart.sh -n -d
+
+GANESHA: It denotes the number of ganesha clusters to be created.
+
+Mount
+=====
+
+After the exports are successfully created and Ganesha daemons are no longer in
+grace period. The exports can be mounted by
+
+.. code:: bash
+
+    $ mount -t nfs -o port=<ganesha-port> <ganesha-host-name>:<ganesha-pseudo-path> <mount-point>
+
+.. note:: Only NFS v4.0+ is supported.
diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst
index 1a304f899f30..ada09693f0af 100644
--- a/doc/cephfs/index.rst
+++ b/doc/cephfs/index.rst
@@ -83,6 +83,7 @@ Administration
     MDS Configuration Settings <mds-config-ref>
     Manual: ceph-mds <../../man/8/ceph-mds>
     Export over NFS <nfs>
+    Export over NFS with volume nfs interface <fs-nfs-exports>
     Application best practices <app-best-practices>
     FS volume and subvolumes <fs-volumes>
     CephFS Quotas <quota>