Improve help text for neutron_opts

This commit adds additional help text to
url, region_name, ovs_bridge, extension_sync_interval
neutron config options.

Blueprint centralize-config-options-newton

Change-Id: Ieece4e81f5fef148148303226617630bf49f0e30

nova/conf/neutron.py

@@ -24,19 +24,77 @@ neutron_group = cfg.OptGroup(NEUTRON_GROUP, title='Neutron Options')
 neutron_options = None
 
 neutron_opts = [
-    cfg.StrOpt('url',
+    cfg.StrOpt(
-               default='http://127.0.0.1:9696',
+        'url',
-               help='URL for connecting to neutron'),
+        default='http://127.0.0.1:9696',
-    cfg.StrOpt('region_name',
+        help="""
-               help='Region name for connecting to neutron in admin context'),
+This option specifies the URL for connecting to Neutron.
-    cfg.StrOpt('ovs_bridge',
+
-               default='br-int',
+Possible values:
-               help='Default OVS bridge name to use if not specified '
+
-                    'by Neutron'),
+  * The default is 'http://127.0.0.1:9696' however any valid URL that
-    cfg.IntOpt('extension_sync_interval',
+    points to the Neutron API service is appropriate here. This typically
-                default=600,
+    matches the URL returned for the 'network' service type from the
-                help='Number of seconds before querying neutron for'
+    Keystone service catalog.
-                     ' extensions'),
+
+Related options:
+
+  * None
+"""),
+    cfg.StrOpt(
+        'region_name',
+        default='RegionOne',
+        help="""
+Region name for connecting to Neutron in admin context.
+
+This option is used in multi-region setups. If there are two Neutron
+servers running in two regions in two different machines, then two
+services need to be created in Keystone with two different regions and
+associate corresponding endpoints to those services. When requests are made
+to Keystone, the Keystone service uses the region_name to determine the
+region the request is coming from.
+
+Possible values:
+
+  * Any string representing a region name.
+
+Related options:
+
+  * None
+"""),
+    cfg.StrOpt(
+        'ovs_bridge',
+         default='br-int',
+         help="""
+Specifies the name of an integration bridge interface used by OpenvSwitch.
+This option is used only if Neutron does not specify the OVS bridge name.
+
+Possible values:
+
+  * Any string representing OVS bridge name.
+  * default value is 'br-int'
+
+Related options:
+
+  * None
+"""),
+    cfg.IntOpt(
+        'extension_sync_interval',
+         default=600,
+         help="""
+Number of seconds to wait before querying Neutron for extensions.
+After this number of seconds the next time Nova needs to create a resource in
+Neutron it will requery Neutron for the extensions that it has loaded.
+
+Possible values:
+
+  * Any positive Integer value
+  * default value is 600
+
+Related options:
+
+  * None
+"""),
 ]
 
 metadata_proxy_opts = [