Remove duplicate doc in ironic.conf.sample

In the configuration sample file, the possible choices for some
configuration options is described twice. Once via `# Possible values:`
and the other as part of the help description. This will remove the
duplication in the help.

Change-Id: Ifaba17ea9029aa99db3ddffa9b7750c05b47460c

etc/ironic/ironic.conf.sample

@@ -4,10 +4,9 @@
 # Options defined in ironic.api.app
 #
 
-# Authentication strategy used by ironic-api: one of
+# Authentication strategy used by ironic-api. "noauth" should
-# "keystone" or "noauth". "noauth" should not be used in a
+# not be used in a production environment because all
-# production environment because all authentication will be
+# authentication will be disabled. (string value)
-# disabled. (string value)
 # Possible values: noauth, keystone
 #auth_strategy=keystone
 
@@ -281,6 +280,7 @@
 #rpc_zmq_bind_address=*
 
 # MatchMaker driver. (string value)
+# Possible values: redis, dummy
 #rpc_zmq_matchmaker=redis
 
 # Type of concurrency used. Either "native" or "eventlet"
@@ -468,8 +468,7 @@
 # Options defined in ironic.drivers.modules.amt.common
 #
 
-# Protocol used for AMT endpoint, support http/https (string
+# Protocol used for AMT endpoint (string value)
-# value)
 # Possible values: http, https
 #protocol=http
 
@@ -1093,8 +1092,7 @@
 #glance_num_retries=0
 
 # Authentication strategy to use when connecting to glance.
-# Only "keystone" and "noauth" are currently supported by
+# (string value)
-# ironic. (string value)
 # Possible values: keystone, noauth
 #auth_strategy=keystone
 
@@ -1254,8 +1252,7 @@
 # IP of remote image server (string value)
 #remote_image_server=<None>
 
-# Share type of virtual media, either "NFS" or "CIFS" (string
+# Share type of virtual media (string value)
-# value)
 # Possible values: CIFS, NFS
 #remote_image_share_type=CIFS
 
@@ -1276,26 +1273,23 @@
 # Options defined in ironic.drivers.modules.irmc.common
 #
 
-# Port to be used for iRMC operations, either 80 or 443 (port
+# Port to be used for iRMC operations (port value)
-# value)
 # Possible values: 443, 80
 #port=443
 
-# Authentication method to be used for iRMC operations, either
+# Authentication method to be used for iRMC operations (string
-# "basic" or "digest" (string value)
+# value)
 # Possible values: basic, digest
 #auth_method=basic
 
 # Timeout (in seconds) for iRMC operations (integer value)
 #client_timeout=60
 
-# Sensor data retrieval method, either "ipmitool" or "scci"
+# Sensor data retrieval method. (string value)
-# (string value)
 # Possible values: ipmitool, scci
 #sensor_method=ipmitool
 
-# SNMP protocol version, either "v1", "v2c" or "v3" (string
+# SNMP protocol version (string value)
-# value)
 # Possible values: v1, v2c, v3
 #snmp_version=v2c
 
@@ -1541,10 +1535,9 @@
 #retries=3
 
 # Default authentication strategy to use when connecting to
-# neutron. Can be either "keystone" or "noauth". Running
+# neutron. Running neutron in noauth mode (related to but not
-# neutron in noauth mode (related to but not affected by this
+# affected by this setting) is insecure and should only be
-# setting) is insecure and should only be used for testing.
+# used for testing. (string value)
-# (string value)
 # Possible values: keystone, noauth
 #auth_strategy=keystone
 
@@ -2061,8 +2054,8 @@
 # iPXE. Defaults to 0 (no timeout) (integer value)
 #ipxe_timeout=0
 
-# The IP version that will be used for PXE booting. Can be
+# The IP version that will be used for PXE booting. Defaults
-# either 4 or 6. Defaults to 4. EXPERIMENTAL (string value)
+# to 4. EXPERIMENTAL (string value)
 # Possible values: 4, 6
 #ip_version=4
 

ironic/api/app.py

@@ -31,9 +31,9 @@ api_opts = [
         'auth_strategy',
         default='keystone',
         choices=['noauth', 'keystone'],
-        help=_('Authentication strategy used by ironic-api: one of "keystone" '
+        help=_('Authentication strategy used by ironic-api. "noauth" should '
-               'or "noauth". "noauth" should not be used in a production '
+               'not be used in a production environment because all '
-               'environment because all authentication will be disabled.')),
+               'authentication will be disabled.')),
     cfg.BoolOpt('debug_tracebacks_in_api',
                 default=False,
                 help=_('Return server tracebacks in the API response for any '

ironic/common/image_service.py

@@ -70,8 +70,7 @@ glance_opts = [
                default='keystone',
                choices=['keystone', 'noauth'],
                help=_('Authentication strategy to use when connecting to '
-                      'glance. Only "keystone" and "noauth" are currently '
+                      'glance.')),
-                      'supported by ironic.')),
 ]
 
 CONF.register_opts(glance_opts, group='glance')

ironic/dhcp/neutron.py

@@ -47,7 +47,7 @@ neutron_opts = [
                default='keystone',
                choices=['keystone', 'noauth'],
                help=_('Default authentication strategy to use when connecting '
-                      'to neutron. Can be either "keystone" or "noauth". '
+                      'to neutron. '
                       'Running neutron in noauth mode (related to but not '
                       'affected by this setting) is insecure and should only '
                       'be used for testing.')),

ironic/drivers/modules/amt/common.py

@@ -51,8 +51,7 @@ opts = [
     cfg.StrOpt('protocol',
                default='http',
                choices=['http', 'https'],
-               help=_('Protocol used for AMT endpoint, '
+               help=_('Protocol used for AMT endpoint')),
-                      'support http/https')),
     cfg.IntOpt('awake_interval',
                default=60,
                min=0,

ironic/drivers/modules/irmc/boot.py

@@ -59,7 +59,7 @@ opts = [
                default='CIFS',
                choices=['CIFS', 'NFS'],
                ignore_case=True,
-               help=_('Share type of virtual media, either "NFS" or "CIFS"')),
+               help=_('Share type of virtual media')),
     cfg.StrOpt('remote_image_share_name',
                default='share',
                help=_('share name of remote_image_server')),

ironic/drivers/modules/irmc/common.py

@@ -29,25 +29,23 @@ opts = [
     cfg.PortOpt('port',
                 default=443,
                 choices=[443, 80],
-                help=_('Port to be used for iRMC operations, either 80 or '
+                help=_('Port to be used for iRMC operations')),
-                       '443')),
     cfg.StrOpt('auth_method',
                default='basic',
                choices=['basic', 'digest'],
-               help=_('Authentication method to be used for iRMC operations, '
+               help=_('Authentication method to be used for iRMC '
-                      'either "basic" or "digest"')),
+                      'operations')),
     cfg.IntOpt('client_timeout',
                default=60,
                help=_('Timeout (in seconds) for iRMC operations')),
     cfg.StrOpt('sensor_method',
                default='ipmitool',
                choices=['ipmitool', 'scci'],
-               help=_('Sensor data retrieval method, either '
+               help=_('Sensor data retrieval method.')),
-                      '"ipmitool" or "scci"')),
     cfg.StrOpt('snmp_version',
                default='v2c',
                choices=['v1', 'v2c', 'v3'],
-               help=_('SNMP protocol version, either "v1", "v2c" or "v3"')),
+               help=_('SNMP protocol version')),
     cfg.PortOpt('snmp_port',
                 default=161,
                 help=_('SNMP port')),

ironic/drivers/modules/pxe.py

@@ -89,7 +89,7 @@ pxe_opts = [
                default='4',
                choices=['4', '6'],
                help=_('The IP version that will be used for PXE booting. '
-                      'Can be either 4 or 6. Defaults to 4. EXPERIMENTAL')),
+                      'Defaults to 4. EXPERIMENTAL')),
 ]
 
 LOG = logging.getLogger(__name__)