update ceph source to reef 18.2.1

[ceph.git] / ceph / doc / mgr / nfs.rst

diff --git a/ceph/doc/mgr/nfs.rst b/ceph/doc/mgr/nfs.rst
index c25410fcdf5e26e5211f4a5c977e13f38d58d5c0..7e6637684faa75ba036c1901277cbac9a1934e8b 100644 (file)
--- a/ceph/doc/mgr/nfs.rst
+++ b/ceph/doc/mgr/nfs.rst
@@ -107,22 +107,29 @@ of the details of NFS redirecting traffic on the virtual IP to the
 appropriate backend NFS servers, and redeploying NFS servers when they
 fail.
 
-If a user additionally supplies ``--ingress-mode keepalive-only`` a
-partial *ingress* service will be deployed that still provides a virtual
-IP, but has nfs directly binding to that virtual IP and leaves out any
-sort of load balancing or traffic redirection. This setup will restrict
-users to deploying only 1 nfs daemon as multiple cannot bind to the same
-port on the virtual IP.
-
-Instead providing ``--ingress-mode default`` will result in the same setup
-as not providing the ``--ingress-mode`` flag. In this setup keepalived will be
-deployed to handle forming the virtual IP and haproxy will be deployed
-to handle load balancing and traffic redirection.
-
-Enabling ingress via the ``ceph nfs cluster create`` command deploys a
-simple ingress configuration with the most common configuration
-options.  Ingress can also be added to an existing NFS service (e.g.,
-one created without the ``--ingress`` flag), and the basic NFS service can
+An optional ``--ingress-mode`` parameter can be provided to choose
+how the *ingress* service is configured:
+
+- Setting ``--ingress-mode keepalive-only`` deploys a simplified *ingress*
+  service that provides a virtual IP with the nfs server directly binding to
+  that virtual IP and leaves out any sort of load balancing or traffic
+  redirection. This setup will restrict users to deploying only 1 nfs daemon
+  as multiple cannot bind to the same port on the virtual IP.
+- Setting ``--ingress-mode haproxy-standard`` deploys a full *ingress* service
+  to provide load balancing and high-availability using HAProxy and keepalived.
+  Client IP addresses are not visible to the back-end NFS server and IP level
+  restrictions on NFS exports will not function.
+- Setting ``--ingress-mode haproxy-protocol`` deploys a full *ingress* service
+  to provide load balancing and high-availability using HAProxy and keepalived.
+  Client IP addresses are visible to the back-end NFS server and IP level
+  restrictions on NFS exports are usable. This mode requires NFS Ganesha version
+  5.0 or later.
+- Setting ``--ingress-mode default`` is equivalent to not providing any other
+  ingress mode by name. When no other ingress mode is specified by name
+  the default ingress mode used is ``haproxy-standard``.
+
+Ingress can be added to an existing NFS service (e.g., one initially created
+without the ``--ingress`` flag), and the basic NFS service can
 also be modified after the fact to include non-default options, by modifying
 the services directly.  For more information, see :ref:`cephadm-ha-nfs`.