conf: Resolve Sphinx errors

This resolves all the warnings currently emitted by oslo.config for nova
and makes the output nicer looking to boot. There are still some issues
but these lie without other projects (osprofiler, oslo.db) and will be
resolved in a future update of those packages.

Change-Id: Ie4eddda36439e6746cb2d97e43b91f63d835877b
This commit is contained in:
Stephen Finucane 2018-07-02 13:36:05 +01:00
parent aeb95b5739
commit 4ed254f757

View File

@ -78,12 +78,13 @@ for the original request, even if it was removed by a SSL terminating proxy.
Possible values:
* None (default) - the request scheme is not influenced by any HTTP headers
* Valid HTTP header, like HTTP_X_FORWARDED_PROTO
* Valid HTTP header, like ``HTTP_X_FORWARDED_PROTO``
WARNING: Do not set this unless you know what you are doing.
Make sure ALL of the following are true before setting this (assuming the
values from the example above):
* Your API is behind a proxy.
* Your proxy strips the X-Forwarded-Proto header from all incoming requests.
In other words, if end users include that header in their requests, the proxy
@ -92,7 +93,6 @@ values from the example above):
for requests that originally come in via HTTPS.
If any of those are not true, you should keep this setting set to None.
"""),
cfg.StrOpt(
'ssl_ca_file',