From: John Mulligan Date: Wed, 2 Feb 2022 20:58:08 +0000 (-0500) Subject: doc/mgr/nfs: document that nfs exports related mgr call requirements X-Git-Tag: v18.0.0~1332^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=b5b3e0bcb5e2a27375f50f7717786a3928cba711;p=ceph.git doc/mgr/nfs: document that nfs exports related mgr call requirements A recent change in the mgr/nfs module should enable the functioning of export management commands/API calls as long as the rados namespaces and objects have been already established. Document this fact, noting that now only the `ceph nfs cluster ...` calls *require* an orchestration module. Signed-off-by: John Mulligan --- diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst index 79e6c29be9f99..777e2ee8173b2 100644 --- a/doc/mgr/nfs.rst +++ b/doc/mgr/nfs.rst @@ -533,20 +533,26 @@ The NFS log level can be adjusted using `nfs cluster config set` command (see :r 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. +It may be possible to deploy and manage the NFS ganesha daemons without +orchestration frameworks such as cephadm or rook. .. 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 +Limitations ------------ -* 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. +If no orchestrator module is enabled for the Ceph Manager the NFS cluster +management commands, such as those starting with ``ceph nfs cluster``, will not +function. However, commands that manage NFS exports, like those prefixed with +``ceph nfs export`` are expected to work as long as the necessary RADOS objects +have already been created. The exact RADOS objects required are not documented +at this time as support for this feature is incomplete. A curious reader can +find some details about the object by reading the source code for the +``mgr/nfs`` module (found in the ceph source tree under +``src/pybind/mgr/nfs``). + Requirements ------------