openstack
/
oslo.middleware
Code Issues Proposed changes

Document security considerations for detailed healthcheck 

The detailed healthcheck output includes some potentially sensitive
information like stack traces of the service. This may be
unacceptable in some organizations and we should point it out in the
help for the option.

Change-Id: Ic10c29f39ef601e4c7873acb0d56e1ec8e4ebcb3
This commit is contained in:
Ben Nemec 2018-10-05 19:45:38 +00:00
parent dc2ba62297
commit 1af38387a2
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
oslo_middleware/healthcheck/opts.py
View File

@ -20,7 +20,11 @@ HEALTHCHECK_OPTS = [
help='The path to respond to healtcheck requests on.'),
cfg.BoolOpt('detailed',
default=False,
help='Show more detailed information as part of the response'),
help='Show more detailed information as part of the response. '
'Security note: Enabling this option may expose '
'sensitive details about the service being monitored. '
'Be sure to verify that it will not violate your '
'security policies.'),
cfg.ListOpt('backends',
default=[],
help='Additional backends that can perform health checks and '