x/vmware-nsx
Code Issues Proposed changes

Finish adding help strings to all config options in Quantum code.

Browse Source 
This adds reasonable help strings to all remaining config options
in Quantum code. This includes all the plugins as well.

Fixes bug 1101356

Change-Id: I1cbe8303ad6d86756b992ae302707a0365625f52
This commit is contained in:
Kyle Mestery 2013-01-28 10:18:32 +00:00
parent 9ea39353b4
commit 5b748b128c
14 changed files with 175 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
quantum/agent/dhcp_agent.py
View File

@ -43,8 +43,10 @@ NS_PREFIX = 'qdhcp-'
class DhcpAgent(object): class DhcpAgent(object):
OPTS = [ OPTS = [
cfg.StrOpt('root_helper', default='sudo'), cfg.StrOpt('root_helper', default='sudo',
cfg.IntOpt('resync_interval', default=30), help=_("Root helper application.")),
cfg.IntOpt('resync_interval', default=30,
help=_("Interval to resync.")),
cfg.StrOpt('dhcp_driver', cfg.StrOpt('dhcp_driver',
default='quantum.agent.linux.dhcp.Dnsmasq', default='quantum.agent.linux.dhcp.Dnsmasq',
help=_("The driver used to manage the DHCP server.")), help=_("The driver used to manage the DHCP server.")),
@ -374,13 +376,18 @@ class NetworkCache(object):
class DeviceManager(object): class DeviceManager(object):
OPTS = [ OPTS = [
cfg.StrOpt('admin_user'), cfg.StrOpt('admin_user',
cfg.StrOpt('admin_password'), help=_("Admin username")),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_password',
cfg.StrOpt('auth_url'), help=_("Admin password")),
cfg.StrOpt('admin_tenant_name',
help=_("Admin tenant name")),
cfg.StrOpt('auth_url',
help=_("Authentication URL")),
cfg.StrOpt('auth_strategy', default='keystone', cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")), help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region',
help=_("Authentication region")),
cfg.StrOpt('interface_driver', cfg.StrOpt('interface_driver',
help=_("The driver used to manage the virtual interface.")) help=_("The driver used to manage the virtual interface."))
] ]

6
quantum/agent/l3_agent.py
View File

@ -111,7 +111,8 @@ class RouterInfo(object):
class L3NATAgent(manager.Manager): class L3NATAgent(manager.Manager):
OPTS = [ OPTS = [
cfg.StrOpt('root_helper', default='sudo'), cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
cfg.StrOpt('external_network_bridge', default='br-ex', cfg.StrOpt('external_network_bridge', default='br-ex',
help=_("Name of bridge used for external network " help=_("Name of bridge used for external network "
"traffic.")), "traffic.")),
@ -140,7 +141,8 @@ class L3NATAgent(manager.Manager):
help=_("UUID of external network for routers implemented " help=_("UUID of external network for routers implemented "
"by the agents.")), "by the agents.")),
cfg.StrOpt('l3_agent_manager', cfg.StrOpt('l3_agent_manager',
default='quantum.agent.l3_agent.L3NATAgent'), default='quantum.agent.l3_agent.L3NATAgent',
help=_("The Quantum L3 Agent manager.")),
] ]
def __init__(self, host, conf=None): def __init__(self, host, conf=None):

15
quantum/agent/metadata/agent.py
View File

@ -39,13 +39,18 @@ DEVICE_OWNER_ROUTER_INTF = "network:router_interface"
class MetadataProxyHandler(object): class MetadataProxyHandler(object):
OPTS = [ OPTS = [
cfg.StrOpt('admin_user'), cfg.StrOpt('admin_user',
cfg.StrOpt('admin_password'), help=_("Admin user")),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_password',
cfg.StrOpt('auth_url'), help=_("Admin password")),
cfg.StrOpt('admin_tenant_name',
help=_("Admin tenant name")),
cfg.StrOpt('auth_url',
help=_("Authentication URL")),
cfg.StrOpt('auth_strategy', default='keystone', cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")), help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region',
help=_("Authentication region")),
cfg.StrOpt('nova_metadata_ip', default='127.0.0.1', cfg.StrOpt('nova_metadata_ip', default='127.0.0.1',
help=_("IP address used by Nova metadata server.")), help=_("IP address used by Nova metadata server.")),
cfg.IntOpt('nova_metadata_port', cfg.IntOpt('nova_metadata_port',

3
quantum/agent/netns_cleanup_util.py
View File

@ -56,7 +56,8 @@ def setup_conf():
""" """
opts = [ opts = [
cfg.StrOpt('root_helper', default='sudo'), cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
cfg.StrOpt('dhcp_driver', cfg.StrOpt('dhcp_driver',
default='quantum.agent.linux.dhcp.Dnsmasq', default='quantum.agent.linux.dhcp.Dnsmasq',
help=_("The driver used to manage the DHCP server.")), help=_("The driver used to manage the DHCP server.")),

3
quantum/agent/ovs_cleanup_util.py
View File

@ -42,7 +42,8 @@ def setup_conf():
] ]
agent_opts = [ agent_opts = [
cfg.StrOpt('root_helper', default='sudo'), cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
] ]
conf = cfg.CommonConfigOpts() conf = cfg.CommonConfigOpts()

21
quantum/debug/debug_agent.py
View File

@ -35,16 +35,23 @@ DEVICE_OWNER_PROBE = 'network:probe'
class QuantumDebugAgent(): class QuantumDebugAgent():
OPTS = [ OPTS = [
cfg.StrOpt('root_helper', default='sudo'), cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
# Needed for drivers # Needed for drivers
cfg.StrOpt('admin_user'), cfg.StrOpt('admin_user',
cfg.StrOpt('admin_password'), help=_("Admin user")),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_password',
cfg.StrOpt('auth_url'), help=_("Admin password")),
cfg.StrOpt('admin_tenant_name',
help=_("Admin tenant name")),
cfg.StrOpt('auth_url',
help=_("Authentication URL")),
cfg.StrOpt('auth_strategy', default='keystone', cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")), help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region',
cfg.BoolOpt('use_namespaces', default=True), help=_("Authentication region")),
cfg.BoolOpt('use_namespaces', default=True,
help=_("Use Linux network namespaces")),
cfg.StrOpt('interface_driver', cfg.StrOpt('interface_driver',
help=_("The driver used to manage the virtual " help=_("The driver used to manage the virtual "
"interface.")), "interface.")),

17
quantum/plugins/bigswitch/plugin.py
View File

@ -66,11 +66,18 @@ LOG = logging.getLogger(__name__)
restproxy_opts = [ restproxy_opts = [
cfg.StrOpt('servers', default='localhost:8800'), cfg.StrOpt('servers', default='localhost:8800',
cfg.StrOpt('serverauth', default='username:password'), help=_("A comma separated list of servers and port numbers "
cfg.BoolOpt('serverssl', default=False), "to proxy request to.")),
cfg.BoolOpt('syncdata', default=False), cfg.StrOpt('serverauth', default='username:password',
cfg.IntOpt('servertimeout', default=10), help=_("Server authentication")),
cfg.BoolOpt('serverssl', default=False,
help=_("Use SSL to connect")),
cfg.BoolOpt('syncdata', default=False,
help=_("Sync data on connect")),
cfg.IntOpt('servertimeout', default=10,
help=_("Maximum number of seconds to wait for proxy request "
"to connect and complete.")),
] ]

4
quantum/plugins/hyperv/agent/hyperv_quantum_agent.py
View File

@ -47,7 +47,9 @@ agent_opts = [
'local_network_vswitch', 'local_network_vswitch',
default='private', default='private',
help=_('Private vswitch name used for local networks')), help=_('Private vswitch name used for local networks')),
cfg.IntOpt('polling_interval', default=2), cfg.IntOpt('polling_interval', default=2,
help=_("The number of seconds the agent will wait between "
"polling for local device changes.")),
] ]

7
quantum/plugins/linuxbridge/common/config.py
View File

@ -40,8 +40,11 @@ bridge_opts = [
] ]
agent_opts = [ agent_opts = [
cfg.IntOpt('polling_interval', default=2), cfg.IntOpt('polling_interval', default=2,
cfg.StrOpt('root_helper', default='sudo'), help=_("The number of seconds the agent will wait between "
"polling for local device changes.")),
cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
] ]

33
quantum/plugins/metaplugin/common/config.py
View File

@ -19,22 +19,33 @@ from quantum.openstack.common import cfg
meta_plugin_opts = [ meta_plugin_opts = [
cfg.StrOpt('plugin_list', default=''), cfg.StrOpt('plugin_list', default='',
cfg.StrOpt('l3_plugin_list', default=''), help=_("List of plugins to load")),
cfg.StrOpt('default_flavor', default=''), cfg.StrOpt('l3_plugin_list', default='',
cfg.StrOpt('default_l3_flavor', default=''), help=_("List of L3 plugins to load")),
cfg.StrOpt('supported_extension_aliases', default=''), cfg.StrOpt('default_flavor', default='',
cfg.StrOpt('extension_map', default='') help=_("Default flavor to use")),
cfg.StrOpt('default_l3_flavor', default='',
help=_("Default L3 flavor to use")),
cfg.StrOpt('supported_extension_aliases', default='',
help=_("Supported extension aliases")),
cfg.StrOpt('extension_map', default='',
help=_("A list of extensions, per plugin, to load.")),
] ]
proxy_plugin_opts = [ proxy_plugin_opts = [
cfg.StrOpt('admin_user'), cfg.StrOpt('admin_user',
cfg.StrOpt('admin_password'), help=_("Admin user")),
cfg.StrOpt('admin_tenant_name'), cfg.StrOpt('admin_password',
cfg.StrOpt('auth_url'), help=_("Admin password")),
cfg.StrOpt('admin_tenant_name',
help=_("Admin tenant name")),
cfg.StrOpt('auth_url',
help=_("Authentication URL")),
cfg.StrOpt('auth_strategy', default='keystone', cfg.StrOpt('auth_strategy', default='keystone',
help=_("The type of authentication to use")), help=_("The type of authentication to use")),
cfg.StrOpt('auth_region'), cfg.StrOpt('auth_region',
help=_("Authentication region")),
] ]
cfg.CONF.register_opts(meta_plugin_opts, "META") cfg.CONF.register_opts(meta_plugin_opts, "META")

31
quantum/plugins/nec/common/config.py
View File

@ -21,22 +21,33 @@ from quantum.openstack.common import rpc
ovs_opts = [ ovs_opts = [
cfg.StrOpt('integration_bridge', default='br-int'), cfg.StrOpt('integration_bridge', default='br-int',
help=_("Integration bridge to use")),
] ]
agent_opts = [ agent_opts = [
cfg.IntOpt('polling_interval', default=2), cfg.IntOpt('polling_interval', default=2,
cfg.StrOpt('root_helper', default='sudo'), help=_("The number of seconds the agent will wait between "
"polling for local device changes.")),
cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
] ]
ofc_opts = [ ofc_opts = [
cfg.StrOpt('host', default='127.0.0.1'), cfg.StrOpt('host', default='127.0.0.1',
cfg.StrOpt('port', default='8888'), help=_("Host to connect to")),
cfg.StrOpt('driver', default='trema'), cfg.StrOpt('port', default='8888',
cfg.BoolOpt('enable_packet_filter', default=True), help=_("Port to connect to")),
cfg.BoolOpt('use_ssl', default=False), cfg.StrOpt('driver', default='trema',
cfg.StrOpt('key_file', default=None), help=_("Driver to use")),
cfg.StrOpt('cert_file', default=None), cfg.BoolOpt('enable_packet_filter', default=True,
help=_("Enable packet filter")),
cfg.BoolOpt('use_ssl', default=False,
help=_("Use SSL to connect")),
cfg.StrOpt('key_file', default=None,
help=_("Key file")),
cfg.StrOpt('cert_file', default=None,
help=_("Certificate file")),
] ]

41
quantum/plugins/nicira/nicira_nvp_plugin/common/config.py
View File

@ -18,20 +18,41 @@ from quantum.openstack.common import cfg
nvp_opts = [ nvp_opts = [
cfg.IntOpt('max_lp_per_bridged_ls', default=64), cfg.IntOpt('max_lp_per_bridged_ls', default=64,
cfg.IntOpt('max_lp_per_overlay_ls', default=256), help=_("Maximum number of ports of a logical switch on a "
cfg.IntOpt('concurrent_connections', default=5), "bridged transport zone (default 64)")),
cfg.IntOpt('nvp_gen_timeout', default=-1), cfg.IntOpt('max_lp_per_overlay_ls', default=256,
cfg.StrOpt('default_cluster_name') help=_("Maximum number of ports of a logical switch on an "
"overlay transport zone (default 64)")),
cfg.IntOpt('concurrent_connections', default=5,
help=_("Maximum concurrent connections")),
cfg.IntOpt('nvp_gen_timeout', default=-1,
help=_("Number of seconds a generation id should be valid for "
"(default -1 meaning do not time out)")),
cfg.StrOpt('default_cluster_name',
help=_("Default cluster name")),
] ]
cluster_opts = [ cluster_opts = [
cfg.StrOpt('default_tz_uuid'), cfg.StrOpt('default_tz_uuid',
cfg.StrOpt('nvp_cluster_uuid'), help=_("This is uuid of the default NVP Transport zone that "
cfg.StrOpt('nova_zone_id'), "will be used for creating tunneled isolated "
cfg.MultiStrOpt('nvp_controller_connection') "\"Quantum\" networks. It needs to be created in NVP "
"before starting Quantum with the nvp plugin.")),
cfg.StrOpt('nvp_cluster_uuid',
help=_("Optional paramter identifying the UUID of the cluster "
"in NVP. This can be retrieved from NVP management "
"console \"admin\" section.")),
cfg.StrOpt('nova_zone_id',
help=_("Optional parameter identifying the Nova \"zone\" that "
"maps to this NVP cluster.")),
cfg.MultiStrOpt('nvp_controller_connection',
help=_("Describes a connection to a single NVP "
"controller. A different connection for each "
"controller in the cluster can be specified; "
"there must be at least one connection per "
"cluster."))
] ]
cfg.CONF.register_opts(nvp_opts, "NVP") cfg.CONF.register_opts(nvp_opts, "NVP")

19
quantum/plugins/openvswitch/common/config.py
View File

@ -22,16 +22,20 @@ DEFAULT_VLAN_RANGES = []
DEFAULT_TUNNEL_RANGES = [] DEFAULT_TUNNEL_RANGES = []
ovs_opts = [ ovs_opts = [
cfg.StrOpt('integration_bridge', default='br-int'), cfg.StrOpt('integration_bridge', default='br-int',
cfg.BoolOpt('enable_tunneling', default=False), help=_("Integration bridge to use")),
cfg.StrOpt('tunnel_bridge', default='br-tun'), cfg.BoolOpt('enable_tunneling', default=False,
help=_("Enable tunneling support")),
cfg.StrOpt('tunnel_bridge', default='br-tun',
help=_("Tunnel bridge to use")),
cfg.StrOpt('int_peer_patch_port', default='patch-tun', cfg.StrOpt('int_peer_patch_port', default='patch-tun',
help=_("Peer patch port in integration bridge for tunnel " help=_("Peer patch port in integration bridge for tunnel "
"bridge")), "bridge")),
cfg.StrOpt('tun_peer_patch_port', default='patch-int', cfg.StrOpt('tun_peer_patch_port', default='patch-int',
help=_("Peer patch port in tunnel bridge for integration " help=_("Peer patch port in tunnel bridge for integration "
"bridge")), "bridge")),
cfg.StrOpt('local_ip', default=''), cfg.StrOpt('local_ip', default='',
help=_("Local IP address of GRE tunnel endpoints.")),
cfg.ListOpt('bridge_mappings', cfg.ListOpt('bridge_mappings',
default=DEFAULT_BRIDGE_MAPPINGS, default=DEFAULT_BRIDGE_MAPPINGS,
help=_("List of <physical_network>:<bridge>")), help=_("List of <physical_network>:<bridge>")),
@ -48,8 +52,11 @@ ovs_opts = [
] ]
agent_opts = [ agent_opts = [
cfg.IntOpt('polling_interval', default=2), cfg.IntOpt('polling_interval', default=2,
cfg.StrOpt('root_helper', default='sudo'), help=_("The number of seconds the agent will wait between "
"polling for local device changes.")),
cfg.StrOpt('root_helper', default='sudo',
help=_("Root helper application.")),
] ]

34
quantum/plugins/ryu/common/config.py
View File

@ -18,21 +18,31 @@ from quantum.openstack.common import cfg
ovs_opts = [ ovs_opts = [
cfg.StrOpt('integration_bridge', default='br-int'), cfg.StrOpt('integration_bridge', default='br-int',
cfg.StrOpt('openflow_controller', default='127.0.0.1:6633'), help=_("Integration bridge to use")),
cfg.StrOpt('openflow_rest_api', default='127.0.0.1:8080'), cfg.StrOpt('openflow_controller', default='127.0.0.1:6633',
cfg.IntOpt('tunnel_key_min', default=1), help=_("OpenFlow controller to connect to")),
cfg.IntOpt('tunnel_key_max', default=0xffffff), cfg.StrOpt('openflow_rest_api', default='127.0.0.1:8080',
cfg.StrOpt('tunnel_ip', default=None), help=_("OpenFlow REST API location")),
cfg.StrOpt('tunnel_interface', default=None), cfg.IntOpt('tunnel_key_min', default=1,
cfg.IntOpt('ovsdb_port', default=6634), help=_("Minimum tunnel ID to use")),
cfg.StrOpt('ovsdb_ip', default=None), cfg.IntOpt('tunnel_key_max', default=0xffffff,
cfg.StrOpt('ovsdb_interface', default=None), help=_("Maximum tunnel ID to use")),
cfg.StrOpt('tunnel_ip', default=None,
help=_("Tunnel IP to use")),
cfg.StrOpt('tunnel_interface', default=None,
help=_("Tunnel interface to use")),
cfg.IntOpt('ovsdb_port', default=6634,
help=_("OVSDB port to connect to")),
cfg.StrOpt('ovsdb_ip', default=None,
help=_("OVSDB IP to connect to")),
cfg.StrOpt('ovsdb_interface', default=None,
help=_("OVSDB interface to connect to")),
] ]
agent_opts = [ agent_opts = [
cfg.IntOpt('polling_interval', default=2), cfg.StrOpt('root_helper', default='sudo',
cfg.StrOpt('root_helper', default='sudo'), help=_("Root helper application.")),
] ]