Improve the help text for the API options (4)
The previous commit moved several of the non-deprecated legacy API options to a central location. This commit adds additional help text to those options. Blueprint centralize-config-options-newton Change-Id: Ic92631fd5de2a6ff6d1802bef71cbf6aca0039f5
This commit is contained in:
104
nova/conf/api.py
104
nova/conf/api.py
@@ -316,28 +316,100 @@ The full path to the fping binary.
|
|||||||
|
|
||||||
os_network_opts = [
|
os_network_opts = [
|
||||||
cfg.BoolOpt("enable_network_quota",
|
cfg.BoolOpt("enable_network_quota",
|
||||||
default=False,
|
default=False,
|
||||||
help='Enables or disables quota checking for tenant '
|
help="""
|
||||||
'networks'),
|
This option is used to enable or disable quota checking for tenant networks.
|
||||||
|
|
||||||
|
* Services that use this:
|
||||||
|
|
||||||
|
``nova-api``
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
True, False (default)
|
||||||
|
|
||||||
|
* Related options:
|
||||||
|
|
||||||
|
quota_networks
|
||||||
|
"""),
|
||||||
cfg.StrOpt('use_neutron_default_nets',
|
cfg.StrOpt('use_neutron_default_nets',
|
||||||
default="False",
|
default="False",
|
||||||
help='Control for checking for default networks'),
|
help="""
|
||||||
|
When "True" (note that this is a string value, not a boolean), the
|
||||||
|
TenantNetworkController will query the Neutron API to get the default networks
|
||||||
|
to use.
|
||||||
|
|
||||||
|
* Services that use this:
|
||||||
|
|
||||||
|
``nova-api``
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
Either "True" or "False" (default)
|
||||||
|
|
||||||
|
* Related options:
|
||||||
|
|
||||||
|
neutron_default_tenant_id
|
||||||
|
"""),
|
||||||
cfg.StrOpt('neutron_default_tenant_id',
|
cfg.StrOpt('neutron_default_tenant_id',
|
||||||
default="default",
|
default="default",
|
||||||
help='Default tenant id when creating neutron '
|
help="""
|
||||||
'networks'),
|
When getting the default network from the Neutron API, this is the tenant ID
|
||||||
|
(also referred in some places as the 'project ID') to use. The default is the
|
||||||
|
string 'default'.
|
||||||
|
|
||||||
|
* Services that use this:
|
||||||
|
|
||||||
|
``nova-api``
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
A string representing a valid tenant ID
|
||||||
|
|
||||||
|
* Related options:
|
||||||
|
|
||||||
|
use_neutron_default_nets
|
||||||
|
"""),
|
||||||
cfg.IntOpt('quota_networks',
|
cfg.IntOpt('quota_networks',
|
||||||
default=3,
|
default=3,
|
||||||
help='Number of private networks allowed per project'),
|
help="""
|
||||||
|
This option controls the number of private networks that can be created per
|
||||||
|
project (or per tenant).
|
||||||
|
|
||||||
|
* Services that use this:
|
||||||
|
|
||||||
|
``nova-api``
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
Any positive integer. The default is 3.
|
||||||
|
|
||||||
|
* Related options:
|
||||||
|
|
||||||
|
enable_network_quota
|
||||||
|
"""),
|
||||||
]
|
]
|
||||||
|
|
||||||
enable_inst_pw_opt = cfg.BoolOpt('enable_instance_password',
|
enable_inst_pw_opt = cfg.BoolOpt('enable_instance_password',
|
||||||
default=True,
|
default=True,
|
||||||
help='Enables returning of the instance password by the'
|
help="""
|
||||||
' relevant server API calls such as create, rebuild'
|
Enables returning of the instance password by the relevant server API calls
|
||||||
' or rescue, If the hypervisor does not support'
|
such as create, rebuild, evacuate, or rescue. If the hypervisor does not
|
||||||
' password injection then the password returned will'
|
support password injection, then the password returned will not be correct, so
|
||||||
' not be correct')
|
if your hypervisor does not support password injection, set this to False.
|
||||||
|
|
||||||
|
* Services that use this:
|
||||||
|
|
||||||
|
``nova-api``
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
True (default), False
|
||||||
|
|
||||||
|
* Related options:
|
||||||
|
|
||||||
|
None
|
||||||
|
""")
|
||||||
|
|
||||||
ALL_OPTS = (auth_opts +
|
ALL_OPTS = (auth_opts +
|
||||||
metadata_opts +
|
metadata_opts +
|
||||||
|
Reference in New Issue
Block a user