summaryrefslogtreecommitdiffstats
path: root/doc/dev/vstart-ganesha.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/dev/vstart-ganesha.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/dev/vstart-ganesha.rst b/doc/dev/vstart-ganesha.rst
new file mode 100644
index 000000000..4e77deb8b
--- /dev/null
+++ b/doc/dev/vstart-ganesha.rst
@@ -0,0 +1,45 @@
+==============================
+NFS CephFS-RGW Developer Guide
+==============================
+
+CephFS exports are supported since Octopus and RGW exports are supported since
+Quincy.
+
+Configuring NFS Ganesha to export CephFS with vstart
+====================================================
+
+1) Using ``cephadm``
+
+ .. code:: bash
+
+ $ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d --cephadm
+
+ This will deploy a single NFS Ganesha daemon using ``vstart.sh``, where the
+ daemon will listen on the default NFS Ganesha port. Also cephfs export is
+ created.
+
+2) Using test orchestrator
+
+ .. code:: bash
+
+ $ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d
+
+ Environment variable ``NFS`` is the number of NFS Ganesha daemons to be
+ deployed, each listening on a random port.
+
+ .. note:: NFS Ganesha packages must be pre-installed for this to work.
+
+Configuring NFS Ganesha to export RGW with vstart
+=================================================
+
+1) Using ``cephadm``
+
+ .. code:: bash
+
+ $ MON=1 OSD=3 RGW=1 NFS=1 ../src/vstart.sh -n -d --cephadm
+
+ This will deploy a single NFS Ganesha daemon using ``vstart.sh``, where the
+ daemon will listen on the default NFS Ganesha port. Also rgw export is
+ created.
+
+ .. note:: boto python module must be pre-installed for this to work.