]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr/nfs: add section for manual ganesha config; reframe
authorSage Weil <sage@newdream.net>
Mon, 26 Jul 2021 20:04:15 +0000 (16:04 -0400)
committerSage Weil <sage@newdream.net>
Tue, 27 Jul 2021 14:47:55 +0000 (10:47 -0400)
This documentation is incomplete because this mode of operation is not
tested/validated.

Signed-off-by: Sage Weil <sage@newdream.net>
doc/mgr/nfs.rst

index 04d5df653f38c1d25b7453a1ae0eb10d21536b7d..ae7b8bcb545181f7b66688a2d68fd30980cfe000 100644 (file)
@@ -465,12 +465,36 @@ The NFS log level can be adjusted using `nfs cluster config set` command (see :r
 
 .. _nfs-ganesha-config:
 
-Ganesha Configuration Hierarchy
-===============================
+
+Manual Ganesha deployment
+=========================
+
+It may be possible to deploy and manage the NFS ganesha daemons manually
+instead of allowing cephadm or rook to do so.
+
+.. note:: Manual configuration is not tested or fully documented; your
+          mileage may vary. If you make this work, please help us by
+          updating this documentation.
+
+Known issues
+------------
+
+* The ``mgr/nfs`` module enumerates NFS clusters via the orchestrator API; if NFS is
+  not managed by the orchestrator (e.g., cephadm or rook) then this will not work.  It
+  may be possible to create the cluster, mark the cephadm service as 'unmanaged', but this
+  is awkward and not ideal.
+
+Requirements
+------------
+
+The following packages are required to enable CephFS and RGW exports with nfs-ganesha:
 
 -  ``nfs-ganesha``, ``nfs-ganesha-ceph``, ``nfs-ganesha-rados-grace`` and
    ``nfs-ganesha-rados-urls`` packages (version 3.3 and above)
 
+Ganesha Configuration Hierarchy
+-------------------------------
+
 Cephadm and rook start each nfs-ganesha daemon with a minimal
 `bootstrap` configuration file that pulls from a shared `common`
 configuration stored in the ``.nfs`` RADOS pool and watches the common