Improve help text for vmware

Blueprint centralize-config-options-newton

Change-Id: Ie80d33893f11e06b42db638e595e966e7e106519

nova/conf/vmware.py

@@ -20,8 +20,6 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import itertools
-
 from oslo_config import cfg
 
 vmware_group = cfg.OptGroup('vmware', title='VMWare Options')
@@ -29,28 +27,64 @@ vmware_group = cfg.OptGroup('vmware', title='VMWare Options')
 vmwareapi_vif_opts = [
     cfg.StrOpt('vlan_interface',
                default='vmnic0',
-               help='Physical ethernet adapter name for vlan networking'),
+               help="""
+This option specifies the physical ethernet adapter name for VLAN
+networking.
+
+Set the vlan_interface configuration option to match the ESX host
+interface that handles VLAN-tagged VM traffic.
+
+Possible values:
+
+* Any valid string representing VLAN interface name
+"""),
     cfg.StrOpt('integration_bridge',
-               help='This option should be configured only when using the '
+               help="""
-                    'NSX-MH Neutron plugin. This is the name of the '
+This option should be configured only when using the NSX-MH Neutron
-                    'integration bridge on the ESXi. This should not be set '
+plugin. This is the name of the integration bridge on the ESXi server
-                    'for any other Neutron plugin. Hence the default value '
+or host. This should not be set for any other Neutron plugin. Hence
-                    'is not set.'),
+the default value is not set.
+
+Possible values:
+
+* Any valid string representing the name of the integration bridge
+"""),
 ]
 
 vmware_utils_opts = [
     cfg.IntOpt('console_delay_seconds',
-               help='Set this value if affected by an increased network '
+               min=0,
-                    'latency causing repeated characters when typing in '
+               help="""
-                    'a remote console.'),
+Set this value if affected by an increased network latency causing
+repeated characters when typing in a remote console.
+"""),
     cfg.StrOpt('serial_port_service_uri',
-               help='Identifies the remote system that serial port traffic '
+               help="""
-                    'will be sent to. If this is not set, no serial ports '
+Identifies the remote system where the serial port traffic will
-                    'will be added to the created VMs.'),
+be sent.
+
+This option adds a virtual serial port which sends console output to
+a configurable service URI. At the service URI address there will be
+virtual serial port concentrator that will collect console logs.
+If this is not set, no serial ports will be added to the created VMs.
+
+Possible values:
+
+* Any valid URI
+"""),
     cfg.StrOpt('serial_port_proxy_uri',
-               help='Identifies a proxy service that provides network access '
+               help="""
-                    'to the serial_port_service_uri. This option is ignored '
+Identifies a proxy service that provides network access to the
-                    'if serial_port_service_uri is not specified.'),
+serial_port_service_uri.
+
+Possible values:
+
+* Any valid URI
+
+Related options:
+This option is ignored if serial_port_service_uri is not specified.
+* serial_port_service_uri
+"""),
 ]
 
 vmwareapi_opts = [
@@ -104,49 +138,77 @@ vmwareapi_opts = [
 spbm_opts = [
     cfg.BoolOpt('pbm_enabled',
                 default=False,
-                help='The PBM status.'),
+                help="""
-    cfg.StrOpt('pbm_wsdl_location',
+This option enables or disables storage policy based placement
-               help='PBM service WSDL file location URL. '
+of instances.
-                    'e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl '
-                    'Not setting this will disable storage policy based '
-                    'placement of instances.'),
-    cfg.StrOpt('pbm_default_policy',
-               help='The PBM default policy. If pbm_wsdl_location is set and '
-                    'there is no defined storage policy for the specific '
-                    'request then this policy will be used.'),
-]
 
-vimutil_opts = [
+Related options:
-    cfg.IntOpt('maximum_objects',
+
-               default=100,
+* pbm_default_policy
-               help='The maximum number of ObjectContent data '
+"""),
-                    'objects that should be returned in a single '
+    cfg.StrOpt('pbm_wsdl_location',
-                    'result. A positive value will cause the '
+               help="""
-                    'operation to suspend the retrieval when the '
+This option specifies the PBM service WSDL file location URL.
-                    'count of objects reaches the specified '
+
-                    'maximum. The server may still limit the count '
+Setting this will disable storage policy based placement
-                    'to something less than the configured value. '
+of instances.
-                    'Any remaining objects may be retrieved with '
+
-                    'additional requests.')
+Possible values:
+
+* Any valid file path
+  e.g file:///opt/SDK/spbm/wsdl/pbmService.wsdl
+"""),
+    cfg.StrOpt('pbm_default_policy',
+               help="""
+This option specifies the default policy to be used.
+
+If pbm_enabled is set and there is no defined storage policy for the
+specific request, then this policy will be used.
+
+Possible values:
+
+* Any valid storage policy such as VSAN default storage policy
+
+Related options:
+
+* pbm_enabled
+"""),
 ]
 
 vmops_opts = [
+    cfg.IntOpt('maximum_objects',
+               min=0,
+               default=100,
+               help="""
+This option specifies the limit on the maximum number of objects to
+return in a single result.
+
+A positive value will cause the operation to suspend the retrieval
+when the count of objects reaches the specified limit. The server may
+still limit the count to something less than the configured value.
+Any remaining objects may be retrieved with additional requests.
+"""),
     cfg.StrOpt('cache_prefix',
-               help='The prefix for where cached images are stored. This is '
+               help="""
-                    'NOT the full path - just a folder prefix. '
+This option adds a prefix to the folder where cached images are stored
-                    'This should only be used when a datastore cache should '
+
-                    'be shared between compute nodes. Note: this should only '
+This is not the full path - just a folder prefix. This should only be
-                    'be used when the compute nodes have a shared file '
+used when a datastore cache is shared between compute nodes.
-                    'system.'),
+
+Note: This should only be used when the compute nodes are running on same
+host or they have a shared file system.
+
+Possible values:
+
+* Any string representing the cache prefix to the folder
+""")
 ]
 
-ALL_VMWARE_OPTS = list(itertools.chain(
+ALL_VMWARE_OPTS = (vmwareapi_vif_opts +
-                  vmwareapi_vif_opts,
+                  vmware_utils_opts +
-                  vmware_utils_opts,
+                  vmwareapi_opts +
-                  vmwareapi_opts,
+                  spbm_opts +
-                  spbm_opts,
+                  vmops_opts)
-                  vimutil_opts,
-                  vmops_opts))
 
 
 def register_opts(conf):