deb-networking-midonet/devstack
YAMAMOTO Takashi b3790c72ac doc: Rearrange documentation layout
Following the doc spec. [1]

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Closes-Bug: #1701204
Change-Id: Ie6e58a6379b51bf53f8f12c1372599cde1164d78
2017-07-07 14:11:33 +09:00
..
ci gate_hook: Enable n-api-meta 2017-06-30 18:17:50 +09:00
magnum Drop LBaaS v1 2016-11-02 15:26:42 +09:00
midonet devstack: Support v2 plugin for lib/neutron 2017-05-08 15:11:30 +09:00
midonet-pkg devstack: Use devstack's die rather than having our own copy 2017-07-03 15:13:19 +09:00
ml2 Merge "devstack: Update for the latest lib/neutron" 2017-04-25 05:40:16 +00:00
tz devstack: Set up tunnel zone for MIDONET_USE_UPLINK=True 2016-07-11 15:44:14 +09:00
upgrade Fix a few bashate complaints 2017-06-30 15:33:47 +09:00
uplink devstack: Remove an OSC issue workaround 2017-02-10 07:55:52 +09:00
README.rst doc: Rearrange documentation layout 2017-07-07 14:11:33 +09:00
devstackgaterc Move the gate configuration from devstackgaterc to gate hook 2016-09-01 16:08:45 +09:00
functions devstack: Switch to OSC 2017-01-18 12:32:38 +09:00
midonet_v2 devstack: Support v2 plugin for lib/neutron 2017-05-08 15:11:30 +09:00
override-defaults devstack: Disable Q_USE_PROVIDERNET_FOR_PUBLIC 2016-07-22 15:04:19 +09:00
plugin.sh Fix a few bashate complaints 2017-06-30 15:33:47 +09:00
settings Merge "devstack: Support CentOS" 2017-06-22 02:32:30 +00:00

README.rst

DevStack external plugin

networking-midonet has its devstack plugin. The following local.conf snippet would enable it:

enable_plugin networking-midonet https://git.openstack.org/openstack/networking-midonet

local.conf examples

ML2 Plugin with MidoNet drivers

You can find an example at devstack/ml2/local.conf.sample in the source tree.

../../../devstack/ml2/local.conf.sample

MidoNet plugin (deprecated)

You can find an example at devstack/midonet/local.conf.sample in the source tree.

../../../devstack/midonet/local.conf.sample

MidoNet backend communication

MidoNet exposes two ways to communicate to its service:

  1. REST (synchronous)
  2. Tasks DB (asynchronous - experimental)

By default, the plugin is configured to use the REST API service. The REST API client is specified as:

MIDONET_CLIENT=midonet.neutron.client.api.MidonetApiClient

If you want to use the experimental Tasks based API, set the following:

MIDONET_CLIENT=midonet.neutron.client.cluster.MidonetClusterClient

FWaaS

MidoNet implements Neutron FWaaS extension API. To configure it with devstack, make sure the following is defined in local.conf:

enable_plugin neutron-fwaas https://github.com/openstack/neutron-fwaas
enable_service q-fwaas
FWAAS_PLUGIN=midonet_firewall

VPNaaS

Starting v5.1, MidoNet implements Neutron VPNaaS extension API. To configure MidoNet as the VPNaaS driver when running devstack, make sure the following is defined in local.conf:

enable_plugin neutron-vpnaas https://github.com/openstack/neutron-vpnaas
enable_service neutron-vpnaas
NEUTRON_VPNAAS_SERVICE_PROVIDER="VPN:Midonet:midonet.neutron.services.vpn.service_drivers.midonet_ipsec.MidonetIPsecVPNDriver:default"

NOTE: Currently, this devstack plugin doesn't install ipsec package "libreswan". Please install it manually.

Gateway Device Management Service

Starting v5.1, MidoNet implements Neutron Gateway Device Management Service extension API. To configure MidoNet including Gateway Device Management Service when running devstack, make sure the following is defined in local.conf:

Q_SERVICE_PLUGIN_CLASSES=midonet_gwdevice

L2 Gateway Management Service

Starting v5.1, MidoNet implements Neutron L2 Gateway Management Service extension API. To configure MidoNet including L2 Gateway Management Service when running devstack, make sure the following is defined in local.conf:

enable_plugin networking-l2gw https://github.com/openstack/networking-l2gw
enable_service l2gw-plugin
Q_PLUGIN_EXTRA_CONF_PATH=/etc/neutron
Q_PLUGIN_EXTRA_CONF_FILES=(l2gw_plugin.ini)
L2GW_PLUGIN="midonet_l2gw"
NETWORKING_L2GW_SERVICE_DRIVER="L2GW:Midonet:midonet.neutron.services.l2gateway.service_drivers.l2gw_midonet.MidonetL2gwDriver:default"

BGP dynamic routing service

Starting v5.2, MidoNet implements Neutron BGP dynamic routing service extension API. The implementation differs slightly from upstream. In MidoNet, router treated as bgp-speaker must be specified.

To configure MidoNet including BGP dynamic routing service when running devstack, make sure the following is defined in local.conf:

enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing
DR_MODE=dr_plugin
BGP_PLUGIN=midonet_bgp
enable_service q-dr

Logging Resource Service

Starting v5.2, MidoNet implements Neutron Logging Resource Service extension API.

To configure MidoNet including Logging Resource Service when running devstack, make sure the following is defined in local.conf:

Q_SERVICE_PLUGIN_CLASSES=midonet_logging_resource

QoS

The following local.conf snippet would enable QoS extension with MidoNet driver:

enable_plugin neutron https://github.com/openstack/neutron
enable_service q-qos

LBaaS v2

The following local.conf snippet would enable LBaaS v2 extension with MidoNet driver:

enable_plugin neutron-lbaas https://git.openstack.org/openstack/neutron-lbaas
enable_service q-lbaasv2
NEUTRON_LBAAS_SERVICE_PROVIDERV2="LOADBALANCERV2:Midonet:midonet.neutron.services.loadbalancer.v2_driver.MidonetLoadBalancerDriver:default"

Tap as a service

The following local.conf snippet would enable Tap-as-a-service support:

enable_plugin tap-as-a-service https://git.openstack.org/openstack/tap-as-a-service
enable_service taas
TAAS_SERVICE_DRIVER="TAAS:Midonet:midonet.neutron.services.taas.service_drivers.taas_midonet.MidonetTaasDriver:default"