From: Sage Weil <sage@newdream.net>
Date: Mon, 24 May 2021 15:16:45 +0000 (-0400)
Subject: doc/cephfs/fs-nfs-exports: document --ingress --virtual-ip
X-Git-Tag: v16.2.5~87^2~28
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=fd4f74dfe4392fc189321dc4a24d90a7a4363b61;p=ceph.git

doc/cephfs/fs-nfs-exports: document --ingress --virtual-ip

Signed-off-by: Sage Weil <sage@newdream.net>
(cherry picked from commit ada85604ab3845fcd2d321791051b8da77eee748)
---

diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst
index dfb665e7d6134..a71ddf2158348 100644
--- a/doc/cephfs/fs-nfs-exports.rst
+++ b/doc/cephfs/fs-nfs-exports.rst
@@ -18,7 +18,7 @@ Create NFS Ganesha Cluster
 
 .. code:: bash
 
-    $ ceph nfs cluster create <clusterid> [<placement>]
+    $ ceph nfs cluster create <clusterid> [<placement>] [--ingress --virtual-ip <ip>]
 
 This creates a common recovery pool for all NFS Ganesha daemons, new user based on
 ``clusterid``, and a common NFS Ganesha config RADOS object.
@@ -47,6 +47,11 @@ cluster)::
 
     "2 host1,host2"
 
+To deploy NFS with an HA front-end (virtual IP and load balancer), add the
+``--ingress`` flag and specify a virtual IP address. This will deploy a combination
+of keepalived and haproxy to provide an high-availability NFS frontend for the NFS
+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.