]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commitdiff
Improve help strings for radware LbaaS driver
authorAndreas Jaeger <aj@suse.de>
Thu, 1 May 2014 17:40:59 +0000 (19:40 +0200)
committerAndreas Jaeger <aj@suse.de>
Fri, 2 May 2014 04:53:23 +0000 (06:53 +0200)
Make strings consistent with what we use elsewhere:
* Capitalize first word
* End with "."
* Improve wording and spelling

Partial-Bug: #1315111
Change-Id: Ic378aa7e4f936c3f3da0a23598620c3b978cbf45

neutron/services/loadbalancer/drivers/radware/driver.py

index 97bcc7a7b2d9ea5158794c6965b2902c353b79de..a250b96acf8a06d72747459f733bf18b7eeec1b4 100644 (file)
@@ -60,40 +60,42 @@ CREATE_SERVICE_HEADER = {'Content-Type':
 
 driver_opts = [
     cfg.StrOpt('vdirect_address',
-               help=_('vdirect server IP address')),
+               help=_('IP address of vDirect server.')),
     cfg.StrOpt('vdirect_user',
                default='vDirect',
-               help=_('vdirect user name')),
+               help=_('vDirect user name.')),
     cfg.StrOpt('vdirect_password',
                default='radware',
-               help=_('vdirect user password')),
+               help=_('vDirect user password.')),
     cfg.StrOpt('service_adc_type',
                default="VA",
-               help=_('Service ADC type')),
+               help=_('Service ADC type. Default: VA.')),
     cfg.StrOpt('service_adc_version',
                default="",
-               help=_('Service ADC version')),
+               help=_('Service ADC version.')),
     cfg.BoolOpt('service_ha_pair',
                 default=False,
-                help=_('service HA pair')),
+                help=_('Enables or disables the Service HA pair. '
+                       'Default: False.')),
     cfg.IntOpt('service_throughput',
                default=1000,
-               help=_('service throughtput')),
+               help=_('Service throughput. Default: 1000.')),
     cfg.IntOpt('service_ssl_throughput',
                default=100,
-               help=_('service ssl throughtput')),
+               help=_('Service SSL throughput. Default: 100.')),
     cfg.IntOpt('service_compression_throughput',
                default=100,
-               help=_('service compression throughtput')),
+               help=_('Service compression throughput. Default: 100.')),
     cfg.IntOpt('service_cache',
                default=20,
-               help=_('service cache')),
+               help=_('Size of service cache. Default: 20.')),
     cfg.StrOpt('l2_l3_workflow_name',
                default='openstack_l2_l3',
-               help=_('l2_l3 workflow name')),
+               help=_('Name of l2_l3 workflow. Default: '
+                      'openstack_l2_l3.')),
     cfg.StrOpt('l4_workflow_name',
                default='openstack_l4',
-               help=_('l4 workflow name')),
+               help=_('Name of l4 workflow. Default: openstack_l4.')),
     cfg.DictOpt('l2_l3_ctor_params',
                 default={"service": "_REPLACE_",
                          "ha_network_name": "HA-Network",
@@ -101,31 +103,32 @@ driver_opts = [
                          "allocate_ha_vrrp": True,
                          "allocate_ha_ips": True,
                          "twoleg_enabled": "_REPLACE_"},
-                help=_('l2_l3 workflow constructor params')),
+                help=_('Parameter for l2_l3 workflow constructor.')),
     cfg.DictOpt('l2_l3_setup_params',
                 default={"data_port": 1,
                          "data_ip_address": "192.168.200.99",
                          "data_ip_mask": "255.255.255.0",
                          "gateway": "192.168.200.1",
                          "ha_port": 2},
-                help=_('l2_l3 workflow setup params')),
+                help=_('Parameter for l2_l3 workflow setup.')),
     cfg.ListOpt('actions_to_skip',
                 default=['setup_l2_l3'],
-                help=_('List of actions that we dont want to push to '
-                       'the completion queue')),
+                help=_('List of actions that are not pushed to '
+                       'the completion queue.')),
     cfg.StrOpt('l4_action_name',
                default='BaseCreate',
-               help=_('l4 workflow action name')),
+               help=_('Name of the l4 workflow action. '
+                      'Default: BaseCreate.')),
     cfg.ListOpt('service_resource_pool_ids',
                 default=[],
-                help=_('Resource pool ids')),
+                help=_('Resource pool IDs.')),
     cfg.IntOpt('service_isl_vlan',
                default=-1,
-               help=_('A required VLAN for the interswitch link to use')),
+               help=_('A required VLAN for the interswitch link to use.')),
     cfg.BoolOpt('service_session_mirroring_enabled',
                 default=False,
-                help=_('Support an Alteon interswitch '
-                       'link for stateful session failover'))
+                help=_('Enable or disable Alteon interswitch link for '
+                       'stateful session failover. Default: False.'))
 ]
 
 cfg.CONF.register_opts(driver_opts, "radware")