openstack
/
octavia
Code Issues Proposed changes

Add docs warning for PING health monitors 

This patch adds a warning box to the load balancer cookbook clarifying
that the health monitor type of 'PING' should only be used in specific
cases.
This was called out in release notes, but was not clear in the cookbook.

Change-Id: I6b95891bec82e01c44b288cbe9796b1f87a07c32
This commit is contained in:
Michael Johnson 2020-02-12 08:34:51 -08:00
parent af9edc30d7
commit bb0efa2a5d
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/user/guides/basic-cookbook.rst
View File

@ -822,6 +822,14 @@ and ``UDP-CONNECT``.
servers. Obviously, your back-end servers must be configured to allow PINGs in
order for these health checks to pass.
.. warning::
Health monitors of type ``PING`` only check if the member is reachable and
responds to ICMP echo requests. It will not detect if your application
running on that instance is healthy or not. Most pools should use one of
the other health monitor options. ``PING`` should only be used in specific
cases where an ICMP echo request is a valid health check.
``TCP`` health monitors open a TCP connection to the back-end server's protocol
port. Your custom TCP application should be written to respond OK to the load
balancer connecting, opening a TCP connection, and closing it again after the