Add help strings to config file options in Quantum code.

Fixes bug 1094989

Change-Id: Ic8f875b41871c79be6a26b829a5af6d3e95b6052

diff --git a/quantum/agent/dhcp_agent.py b/quantum/agent/dhcp_agent.py
index a85ce02ae748beace3bd2db357e3c85fecdf9467..6fd79031bf906f6d91be71b8436e529f4782b13e 100644 (file)
--- a/quantum/agent/dhcp_agent.py
+++ b/quantum/agent/dhcp_agent.py
@@ -378,7 +378,8 @@ class DeviceManager(object):
         cfg.StrOpt('admin_password'),
         cfg.StrOpt('admin_tenant_name'),
         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('interface_driver',
                    help="The driver used to manage the virtual interface.")

diff --git a/quantum/agent/metadata/agent.py b/quantum/agent/metadata/agent.py
index 760f4e6a47271af90723e3c493a4a004e58d1ecd..47b5ff1745ab021f8a2abb1d3aac0d95451383f7 100644 (file)
--- a/quantum/agent/metadata/agent.py
+++ b/quantum/agent/metadata/agent.py
@@ -43,7 +43,8 @@ class MetadataProxyHandler(object):
         cfg.StrOpt('admin_password'),
         cfg.StrOpt('admin_tenant_name'),
         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('nova_metadata_ip', default='127.0.0.1',
                    help="IP address used by Nova metadata server."),

diff --git a/quantum/common/config.py b/quantum/common/config.py
index 2394ed4381edc46ddc78239c8942d85daaa9daf2..0a46b1af3c3699d004d4ca4096c16df05545960c 100644 (file)
--- a/quantum/common/config.py
+++ b/quantum/common/config.py
@@ -34,23 +34,38 @@ from quantum.version import version_info as quantum_version
 LOG = logging.getLogger(__name__)
 
 core_opts = [
-    cfg.StrOpt('bind_host', default='0.0.0.0'),
-    cfg.IntOpt('bind_port', default=9696),
-    cfg.StrOpt('api_paste_config', default="api-paste.ini"),
-    cfg.StrOpt('api_extensions_path', default=""),
-    cfg.StrOpt('policy_file', default="policy.json"),
-    cfg.StrOpt('auth_strategy', default='keystone'),
-    cfg.StrOpt('core_plugin'),
-    cfg.ListOpt('service_plugins',
-                default=[]),
-    cfg.StrOpt('base_mac', default="fa:16:3e:00:00:00"),
-    cfg.IntOpt('mac_generation_retries', default=16),
-    cfg.BoolOpt('allow_bulk', default=True),
-    cfg.IntOpt('max_dns_nameservers', default=5),
-    cfg.IntOpt('max_subnet_host_routes', default=20),
-    cfg.IntOpt('dhcp_lease_duration', default=120),
-    cfg.BoolOpt('allow_overlapping_ips', default=False),
-    cfg.StrOpt('host', default=utils.get_hostname()),
+    cfg.StrOpt('bind_host', default='0.0.0.0',
+               help=_("The host IP to bind to")),
+    cfg.IntOpt('bind_port', default=9696,
+               help=_("The port to bind to")),
+    cfg.StrOpt('api_paste_config', default="api-paste.ini",
+               help=_("The API paste config file to use")),
+    cfg.StrOpt('api_extensions_path', default="",
+               help=_("The path for API extensions")),
+    cfg.StrOpt('policy_file', default="policy.json",
+               help=_("The policy file to use")),
+    cfg.StrOpt('auth_strategy', default='keystone',
+               help=_("The type of authentication to use")),
+    cfg.StrOpt('core_plugin',
+               help=_("The core plugin Quantum will use")),
+    cfg.ListOpt('service_plugins', default=[],
+                help=_("The service plugins Quantum will use")),
+    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,
                 help=_("Ensure that configured gateway is on subnet")),
 ]

diff --git a/quantum/debug/debug_agent.py b/quantum/debug/debug_agent.py
index 03b2d66845909d8c813dcb6015f4f241b727d52e..24169143a1e711fbbe05fdcc7dc1b8c528b60619 100644 (file)
--- a/quantum/debug/debug_agent.py
+++ b/quantum/debug/debug_agent.py
@@ -41,7 +41,8 @@ class QuantumDebugAgent():
         cfg.StrOpt('admin_password'),
         cfg.StrOpt('admin_tenant_name'),
         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.BoolOpt('use_namespaces', default=True),
         cfg.StrOpt('interface_driver',

diff --git a/quantum/plugins/metaplugin/common/config.py b/quantum/plugins/metaplugin/common/config.py
index 6af125efccee23968a75b52faa5cb22c2333355f..3b827bfc7081dc2dfef05db56ab936d437afb484 100644 (file)
--- a/quantum/plugins/metaplugin/common/config.py
+++ b/quantum/plugins/metaplugin/common/config.py
@@ -32,7 +32,8 @@ proxy_plugin_opts = [
     cfg.StrOpt('admin_password'),
     cfg.StrOpt('admin_tenant_name'),
     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'),
 ]