Skip to content

Commit 1602143

Browse files
Merge pull request ceph#57273 from zdover23/wip-doc-2024-05-06-mgr-dashboard
doc/mgr: edit "Resolve IP address to hostname before redirect"
2 parents 7dd8e5a + e0838da commit 1602143

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

doc/mgr/dashboard.rst

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1243,19 +1243,29 @@ code of standby dashboards. To do so you need to run the command:
12431243
Resolve IP address to hostname before redirect
12441244
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12451245

1246-
The redirect from a standby to the active dashboard is done via the IP
1247-
address. This is done because resolving IP addresses to hostnames can be error
1248-
prone in containerized environments. It is also the reason why the option is
1246+
Redirection from a standby dashboard to the active dashboard is done via the
1247+
manager's IP address, not via the manager's hostname. In virtualized
1248+
environments, IP-address-based redirection reduces the incidence of error as
1249+
compared to hostname-based resolution. Because of the increased risk of error
1250+
due to hostname-based resolution, the option for hostname resolution is
12491251
disabled by default.
1252+
12501253
However, in some situations it might be helpful to redirect via the hostname.
1251-
For example if the configured TLS certificate matches only the hostnames. To
1252-
activate the redirection via the hostname run the following command::
1254+
For example, if the configured TLS certificate matches only the hostnames and
1255+
not the IP addresses of those hosts, hostname redirection would be preferable.
1256+
1257+
To activate redirection from standby dashboards to active dashboards via the
1258+
manager's hostname, run the following command:
1259+
1260+
.. prompt:: bash $
1261+
1262+
ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr True
12531263

1254-
$ ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr True
1264+
Disable hostname redirection by running the following command:
12551265

1256-
You can disable it again by::
1266+
.. prompt:: bash #
12571267

1258-
$ ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr False
1268+
ceph config set mgr mgr/dashboard/redirect_resolve_ip_addr False
12591269

12601270
.. warning::
12611271

0 commit comments

Comments
 (0)