Add help strings to config file options in Quantum code.

Fixes bug 1094989

Change-Id: Ic8f875b41871c79be6a26b829a5af6d3e95b6052
This commit is contained in:
Kyle Mestery 2013-01-17 11:46:59 +00:00
parent 09c1b1d668
commit 823b639513
5 changed files with 40 additions and 21 deletions

View File

@ -378,7 +378,8 @@ class DeviceManager(object):
cfg.StrOpt('admin_password'), cfg.StrOpt('admin_password'),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_tenant_name'),
cfg.StrOpt('auth_url'), cfg.StrOpt('auth_url'),
cfg.StrOpt('auth_strategy', default='keystone'), cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region'),
cfg.StrOpt('interface_driver', cfg.StrOpt('interface_driver',
help="The driver used to manage the virtual interface.") help="The driver used to manage the virtual interface.")

View File

@ -43,7 +43,8 @@ class MetadataProxyHandler(object):
cfg.StrOpt('admin_password'), cfg.StrOpt('admin_password'),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_tenant_name'),
cfg.StrOpt('auth_url'), cfg.StrOpt('auth_url'),
cfg.StrOpt('auth_strategy', default='keystone'), cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region'),
cfg.StrOpt('nova_metadata_ip', default='127.0.0.1', cfg.StrOpt('nova_metadata_ip', default='127.0.0.1',
help="IP address used by Nova metadata server."), help="IP address used by Nova metadata server."),

View File

@ -34,23 +34,38 @@ from quantum.version import version_info as quantum_version
LOG = logging.getLogger(__name__) LOG = logging.getLogger(__name__)
core_opts = [ core_opts = [
cfg.StrOpt('bind_host', default='0.0.0.0'), cfg.StrOpt('bind_host', default='0.0.0.0',
cfg.IntOpt('bind_port', default=9696), help=_("The host IP to bind to")),
cfg.StrOpt('api_paste_config', default="api-paste.ini"), cfg.IntOpt('bind_port', default=9696,
cfg.StrOpt('api_extensions_path', default=""), help=_("The port to bind to")),
cfg.StrOpt('policy_file', default="policy.json"), cfg.StrOpt('api_paste_config', default="api-paste.ini",
cfg.StrOpt('auth_strategy', default='keystone'), help=_("The API paste config file to use")),
cfg.StrOpt('core_plugin'), cfg.StrOpt('api_extensions_path', default="",
cfg.ListOpt('service_plugins', help=_("The path for API extensions")),
default=[]), cfg.StrOpt('policy_file', default="policy.json",
cfg.StrOpt('base_mac', default="fa:16:3e:00:00:00"), help=_("The policy file to use")),
cfg.IntOpt('mac_generation_retries', default=16), cfg.StrOpt('auth_strategy', default='keystone',
cfg.BoolOpt('allow_bulk', default=True), help=_("The type of authentication to use")),
cfg.IntOpt('max_dns_nameservers', default=5), cfg.StrOpt('core_plugin',
cfg.IntOpt('max_subnet_host_routes', default=20), help=_("The core plugin Quantum will use")),
cfg.IntOpt('dhcp_lease_duration', default=120), cfg.ListOpt('service_plugins', default=[],
cfg.BoolOpt('allow_overlapping_ips', default=False), help=_("The service plugins Quantum will use")),
cfg.StrOpt('host', default=utils.get_hostname()), cfg.StrOpt('base_mac', default="fa:16:3e:00:00:00",
help=_("The base MAC address Quantum will use for VIFs")),
cfg.IntOpt('mac_generation_retries', default=16,
help=_("How many times Quantum will retry MAC generation")),
cfg.BoolOpt('allow_bulk', default=True,
help=_("Allow the usage of the bulk API")),
cfg.IntOpt('max_dns_nameservers', default=5,
help=_("Maximum number of DNS nameservers")),
cfg.IntOpt('max_subnet_host_routes', default=20,
help=_("Maximum number of host routes per subnet")),
cfg.IntOpt('dhcp_lease_duration', default=120,
help=_("DHCP lease duration")),
cfg.BoolOpt('allow_overlapping_ips', default=False,
help=_("Allow overlapping IP support in Quantum")),
cfg.StrOpt('host', default=utils.get_hostname(),
help=_("The hostname Quantum is running on")),
cfg.BoolOpt('force_gateway_on_subnet', default=False, cfg.BoolOpt('force_gateway_on_subnet', default=False,
help=_("Ensure that configured gateway is on subnet")), help=_("Ensure that configured gateway is on subnet")),
] ]

View File

@ -41,7 +41,8 @@ class QuantumDebugAgent():
cfg.StrOpt('admin_password'), cfg.StrOpt('admin_password'),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_tenant_name'),
cfg.StrOpt('auth_url'), cfg.StrOpt('auth_url'),
cfg.StrOpt('auth_strategy', default='keystone'), cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region'),
cfg.BoolOpt('use_namespaces', default=True), cfg.BoolOpt('use_namespaces', default=True),
cfg.StrOpt('interface_driver', cfg.StrOpt('interface_driver',

View File

@ -32,7 +32,8 @@ proxy_plugin_opts = [
cfg.StrOpt('admin_password'), cfg.StrOpt('admin_password'),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_tenant_name'),
cfg.StrOpt('auth_url'), cfg.StrOpt('auth_url'),
cfg.StrOpt('auth_strategy', default='keystone'), cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region'),
] ]