From: Zac Dover <zac.dover@proton.me>
Date: Sun, 5 May 2024 19:12:55 +0000 (+1000)
Subject: doc/mgr: edit "Resolve IP address to hostname before redirect"
X-Git-Tag: v20.0.0~2013^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=e0838daa9bc1d549a8da2b21608153c77b15455a;p=ceph.git

doc/mgr: edit "Resolve IP address to hostname before redirect"

Edit the section "Resolve IP address to hostname before redirect" in
doc/mgr/dashboard.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index 3080533e2166e..2f396350956be 100644
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -1243,19 +1243,29 @@ code of standby dashboards. To do so you need to run the command:
 Resolve IP address to hostname before redirect
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The redirect from a standby to the active dashboard is done via the IP
-address. This is done because resolving IP addresses to hostnames can be error
-prone in containerized environments. It is also the reason why the option is
+Redirection from a standby dashboard to the active dashboard is done via the
+manager's IP address, not via the manager's hostname. In virtualized
+environments, IP-address-based redirection reduces the incidence of error as
+compared to hostname-based resolution.  Because of the increased risk of error
+due to hostname-based resolution, the option for hostname resolution is
 disabled by default.
+
 However, in some situations it might be helpful to redirect via the hostname.
-For example if the configured TLS certificate matches only the hostnames. To
-activate the redirection via the hostname run the following command::
+For example, if the configured TLS certificate matches only the hostnames and
+not the IP addresses of those hosts, hostname redirection would be preferable.
+
+To activate redirection from standby dashboards to active dashboards via the
+manager's hostname, run the following command:
+
+.. prompt:: bash $
+
+   ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr True
 
-  $ ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr True
+Disable hostname redirection by running the following command:
 
-You can disable it again by::
+.. prompt:: bash #
 
-  $ ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr False
+   ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr False
 
 .. warning::