vmware-nsx/neutron/plugins/metaplugin
Itsuro Oda 80e2a16775 Make help texts more descriptive in Metaplugin
This patch makes help texts of configuration parameters of
metaplugin.ini more descriptive. Comments in metaplugin.ini
are also improved.

Change-Id: I1fac888ecc223a7199cc9c9aeb603b7493f22171
Closes-Bug: #1283930
2014-04-22 07:30:53 +09:00
..
common Make help texts more descriptive in Metaplugin 2014-04-22 07:30:53 +09:00
__init__.py Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
meta_db_v2.py Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
meta_models_v2.py Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
meta_neutron_plugin.py Add support for multiple RPC workers under Metaplugin 2014-04-15 13:29:27 +09:00
proxy_neutron_plugin.py Plugins should call __init__ of db_base_plugin for db.configure 2014-02-21 13:30:12 -08:00
README Fix misspells 2013-12-03 15:03:47 -08:00

# -- Background

This plugin supports multiple plugin at same time. This plugin is for L3 connectivility
between networks which are realized by different plugins.This plugin adds new attributes 'flavor:network' and 'flavor:router".
flavor:network corresponds to specific l2 plugin ( flavor-plugin mapping could be configurable by plugin_list config.
flavor:router corresponds to specific l3 plugin ( flavor-plugin mapping could be configurable by l3_plugin_list config. Note that Metaplugin can provide l3 functionaliteis for l2 plugin which didn't support l3 extension yet.
This plugin also support extensions. We can map extension to plugin by using extension_map config.

[database]
# This line MUST be changed to actually run the plugin.
# Example:
# connection = mysql://root:nova@127.0.0.1:3306/ovs_neutron
# Replace 127.0.0.1 above with the IP address of the database used by the
# main neutron server. (Leave it as is if the database runs on this host.)
connection = mysql://root:password@localhost/neutron_metaplugin?charset=utf8

# Database reconnection retry times - in event connectivity is lost
# set to -1 implgies an infinite retry count
# max_retries = 10
# Database reconnection interval in seconds - in event connectivity is lost
retry_interval = 2

[meta]
## This is list of flavor:neutron_plugins
# extension method is used in the order of this list
plugin_list= 'openvswitch:neutron.plugins.openvswitch.ovs_neutron_plugin.OVSneutronPluginV2,linuxbridge:neutron.plugins.linuxbridge.lb_neutron_plugin.LinuxBridgePluginV2'
# plugin for l3
l3_plugin_list= 'openvswitch:neutron.plugins.openvswitch.ovs_neutron_plugin.OVSneutronPluginV2,linuxbridge:neutron.plugins.linuxbridge.lb_neutron_plugin.LinuxBridgePluginV2'

# Default value of flavor
default_flavor = 'openvswitch'
# Default value for l3
default_l3_flavor = 'openvswitch'

# supported extensions
supported_extension_aliases = 'providernet'
# specific method map for each flavor to extensions
extension_map = 'get_port_stats:nvp'

# -- BridgeDriver Configration
# In order to use metaplugin, you should use MetaDriver. Following configation is needed.

[DEFAULT]
# Meta Plugin
# Mapping between flavor and driver
meta_flavor_driver_mappings = openvswitch:neutron.agent.linux.interface.OVSInterfaceDriver, linuxbridge:neutron.agent.linux.interface.BridgeInterfaceDriver
# interface driver for MetaPlugin
interface_driver = neutron.agent.linux.interface.MetaInterfaceDriver

[proxy]
auth_url = http://10.0.0.1:35357/v2.0
auth_region = RegionOne
admin_tenant_name = service
admin_user =      neutron
admin_password = password


# -- Agent
Agents for Metaplugin are in neutron/plugins/metaplugin/agent
linuxbridge_neutron_agent and ovs_neutron_agent is available.

# -- Extensions

- flavor
MetaPlugin supports flavor and provider net extension.
Metaplugin select plugin_list using flavor.
One plugin may use multiple flavor value. If the plugin support flavor, it may provide
multiple flavor of network.

- Attribute extension
Each plugin can use attribute extension such as provider_net, if you specify that in supported_extension_aliases.

- providernet
Vlan ID range of each plugin should be different, since Metaplugin dose not manage that.

#- limitations

Basically, All plugin should inherit NeutronDbPluginV2.
Metaplugin assumes all plugin share same Database especially for IPAM part in NeutronV2 API.
You can use another plugin if you use ProxyPluginV2, which proxies request to the another neutron server.

Example flavor configration for ProxyPluginV2

meta_flavor_driver_mappings = "openvswitch:neutron.agent.linux.interface.OVSInterfaceDriver,proxy:neutron.plugins.metaplugin.proxy_neutron_plugin.ProxyPluginV2"

- Limited L3 support
In folsom version, l3 is an extension. There is no way to extend exntension attributes.
so you can set flavor:router value but you can't get flavor:router value in API output.
L3 agent dont's support flavor:router.