From: Sage Weil <sage@newdream.net>
Date: Wed, 11 Aug 2021 16:31:21 +0000 (-0500)
Subject: doc/mgr/nfs: add section on updating an nfs cluster
X-Git-Tag: v17.1.0~1135^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F42759%2Fhead;p=ceph.git

doc/mgr/nfs: add section on updating an nfs cluster

Signed-off-by: Sage Weil <sage@newdream.net>
---

diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst
index 4b05544f60a4..988e33c4d9dc 100644
--- a/doc/mgr/nfs.rst
+++ b/doc/mgr/nfs.rst
@@ -126,6 +126,22 @@ Delete NFS Ganesha Cluster
 
 This deletes the deployed cluster.
 
+Updating an NFS Cluster
+-----------------------
+
+In order to modify cluster parameters (like the port or placement), you need to
+use the orchestrator interface to update the NFS service spec.  The safest way to do
+that is to export the current spec, modify it, and then re-apply it.  For example,
+to modify the ``nfs.foo`` service,
+
+.. code:: bash
+
+    $ ceph orch ls --service-name nfs.foo --export > nfs.foo.yaml
+    $ vi nfs.foo.yaml
+    $ ceph orch apply -i nfs.foo.yaml
+
+For more information about the NFS service spec, see :ref:`deploy-cephadm-nfs-ganesha`.
+
 List NFS Ganesha Clusters
 -------------------------