Adds help text to brocade configuration options

Help text was added to the configuration options defined in the brocade neutron
plugin. This help text should assist users of the brocade plugin. The OSTYPE
configuration option was not used in the plugin and was labeled as such so a
user of the plugin would not worry about the meaning of it.

The example etc file /etc/neutron/plugins/brocade/brocade.ini has been updated
to share the same help values where applicable.

Fixes-Bug: #1157511

Change-Id: Ie068396e77902037a7a0b5334d4dfb0dcdd3575e
This commit is contained in:
Justin Hammond 2013-09-03 15:57:52 -05:00
parent 478cef0c28
commit a97c34a125
2 changed files with 16 additions and 10 deletions

View File

@ -1,8 +1,8 @@
[switch] [switch]
# username = <mgmt admin username> # username = The SSH username to use
# password = <mgmt admin password> # password = The SSH password to use
# address = <switch mgmt ip address> # address = The address of the host to SSH to
# ostype = NOS # ostype = Should be NOS, but is unused otherwise
# #
# Example: # Example:
# username = admin # username = admin
@ -11,7 +11,7 @@
# ostype = NOS # ostype = NOS
[physical_interface] [physical_interface]
# physical_interface = <physical network name> # physical_interface = The network interface to use when creating a port
# #
# Example: # Example:
# physical_interface = physnet1 # physical_interface = physnet1

View File

@ -59,13 +59,19 @@ PLUGIN_VERSION = 0.88
AGENT_OWNER_PREFIX = "network:" AGENT_OWNER_PREFIX = "network:"
NOS_DRIVER = 'neutron.plugins.brocade.nos.nosdriver.NOSdriver' NOS_DRIVER = 'neutron.plugins.brocade.nos.nosdriver.NOSdriver'
SWITCH_OPTS = [cfg.StrOpt('address', default=''), SWITCH_OPTS = [cfg.StrOpt('address', default='',
cfg.StrOpt('username', default=''), help=_('The address of the host to SSH to')),
cfg.StrOpt('password', default='', secret=True), cfg.StrOpt('username', default='',
cfg.StrOpt('ostype', default='NOS') help=_('The SSH username to use')),
cfg.StrOpt('password', default='', secret=True,
help=_('The SSH password to use')),
cfg.StrOpt('ostype', default='NOS',
help=_('Currently unused'))
] ]
PHYSICAL_INTERFACE_OPTS = [cfg.StrOpt('physical_interface', default='eth0') PHYSICAL_INTERFACE_OPTS = [cfg.StrOpt('physical_interface', default='eth0',
help=_('The network interface to use when creating'
'a port'))
] ]
cfg.CONF.register_opts(SWITCH_OPTS, "SWITCH") cfg.CONF.register_opts(SWITCH_OPTS, "SWITCH")