From b1ce931100bf774f7a05bfbe5f45a511d8a0caeb Mon Sep 17 00:00:00 2001 From: Thomas Goirand Date: Thu, 1 Oct 2020 08:57:03 +0200 Subject: Warning about /healthcheck Add a warning in the doc to explain '/healthcheck' doesn't provide any sort of check if the API actually works. Change-Id: Ib4a065f31140f885d3de53e2423e7b4a6635f345 --- oslo_middleware/healthcheck/__init__.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/oslo_middleware/healthcheck/__init__.py b/oslo_middleware/healthcheck/__init__.py index 66c713e..5f97914 100644 --- a/oslo_middleware/healthcheck/__init__.py +++ b/oslo_middleware/healthcheck/__init__.py @@ -65,6 +65,12 @@ class Healthcheck(base.ConfigurableMiddleware): the activity of the server. * *(and more)* + .. note:: + + This middleware indicates that the API is accessible but it does + indicate that it is necessarily functional or that any other API + request will actually work. + Example requests/responses (**not** detailed mode):: $ curl -i -X HEAD "http://0.0.0.0:8775/healthcheck" -- cgit v1.2.1