diff options
| author | Thomas Goirand <zigo@debian.org> | 2020-10-01 08:57:03 +0200 |
|---|---|---|
| committer | Stephen Finucane <stephenfin@redhat.com> | 2021-04-21 15:33:12 +0000 |
| commit | b1ce931100bf774f7a05bfbe5f45a511d8a0caeb (patch) | |
| tree | 5f92333fbb58f5928194125659958574a9d36f62 | |
| parent | e413cb73de8f8613a90163ea6813f2c5ee5f3164 (diff) | |
| download | oslo-middleware-b1ce931100bf774f7a05bfbe5f45a511d8a0caeb.tar.gz | |
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
| -rw-r--r-- | oslo_middleware/healthcheck/__init__.py | 6 |
1 files changed, 6 insertions, 0 deletions
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" |