From: Ramana Raja <rraja@redhat.com>
Date: Sun, 10 Apr 2022 18:21:24 +0000 (-0400)
Subject: doc/mgr/nfs: Add commands to check the statuses
X-Git-Tag: v18.0.0~969^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F45843%2Fhead;p=ceph.git

doc/mgr/nfs: Add commands to check the statuses

.. of NFS and ingress services after creating/deleting a NFS cluster.
The `nfs cluster info` command is not sufficient to show that the
NFS cluster is created/deleted as expected.

Signed-off-by: Ramana Raja <rraja@redhat.com>
---

diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst
index 777e2ee8173b2..a30bd2db13340 100644
--- a/doc/mgr/nfs.rst
+++ b/doc/mgr/nfs.rst
@@ -76,6 +76,17 @@ service.
 For more details, refer :ref:`orchestrator-cli-placement-spec` but keep
 in mind that specifying the placement via a YAML file is not supported.
 
+Deployment of NFS daemons and the ingress service is asynchronous: the
+command may return before the services have completely started. You may
+wish to check that these services do successfully start and stay running.
+When using cephadm orchestration, these commands check service status:
+
+.. code:: bash
+
+    $ ceph orch ls --service_name=nfs.<cluster_id>
+    $ ceph orch ls --service_name=ingress.nfs.<cluster_id>
+
+
 Ingress
 -------
 
@@ -128,6 +139,18 @@ Delete NFS Ganesha Cluster
 
 This deletes the deployed cluster.
 
+
+Removal of NFS daemons and the ingress service is asynchronous: the
+command may return before the services have been completely deleted. You may
+wish to check that these services are no longer reported. When using cephadm
+orchestration, these commands check service status:
+
+.. code:: bash
+
+    $ ceph orch ls --service_name=nfs.<cluster_id>
+    $ ceph orch ls --service_name=ingress.nfs.<cluster_id>
+
+
 Updating an NFS Cluster
 -----------------------