openstack/neutron-dynamic-routing
Code Issues Proposed changes

Update docs

Browse Source 
- Start using OSC instead of neutron CLI
- Fix description of speaker scheduling
- Increase readability
- Fix some minor issues

Change-Id: I354c33bb825a8ec58e46a13a0a9e9f412ec01541
Closes-Bug: 1750562
This commit is contained in:
Jens Harbott 2017-09-12 11:42:44 +00:00
parent 3e10853df1
commit 1e5d33f80e
2 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
devstack/README.rst
View File

@ -10,7 +10,8 @@
additions are following:: additions are following::
cd devstack cd devstack
cat << EOF >> local.conf cat << EOF > local.conf
> [[local|localrc]]
> enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing > enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing
> EOF > EOF
@ -20,21 +21,23 @@
Notes: Notes:
1. In default case, neutron-dynamic-routing is installed in allinone mode. 1. In the default case, neutron-dynamic-routing is installed in allinone mode.
In multiple nodes environment, for controller node:: In multiple nodes environment, for controller node::
cd devstack cd devstack
cat << EOF >> local.conf cat << EOF > local.conf
> [[local|localrc]]
> enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing > enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing
> DR_MODE=dr_plugin > DR_MODE=dr_plugin
> EOF > EOF
For the nodes where you want to run dr-agent:: For the nodes where you want to run dr-agent::
cd devstack cd devstack
cat << EOF >> local.conf cat << EOF > local.conf
> [[local|localrc]]
> enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing > enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing
> DR_MODE=dr_agent > DR_MODE=dr_agent
> EOF > EOF
2. In default case, protocol BGP is enabled for neutron-dynamic-routing. 2. In the default case, protocol BGP is enabled for neutron-dynamic-routing.
You can change "DR_SUPPORTED_PROTOCOLS" in "devstack/settings" to protocols wanted. You can change "DR_SUPPORTED_PROTOCOLS" in "devstack/settings" to protocols wanted.

54
doc/source/contributor/testing.rst
View File

@ -26,8 +26,8 @@ Testing
======= =======
Dynamic routing enables advertisement of self-service network prefixes to physical network Dynamic routing enables advertisement of self-service network prefixes to physical network
devices that support dynamic routing protocol such as routers. Neutron dynamic routing project that devices that support a dynamic routing protocol, such as routers. The Neutron dynamic routing project
consists of a service plugin-in and agent can advertise neutron private network to outside of consists of a service plugin-in and an agent that can advertise Neutron private network to outside of
OpenStack. This document will describe how to test the Dynamic Routing functionalities, introduce OpenStack. This document will describe how to test the Dynamic Routing functionalities, introduce
what the environment architecture is for dynamic routing test and show how to setup dynamic routing what the environment architecture is for dynamic routing test and show how to setup dynamic routing
environment using Devstack. environment using Devstack.
@ -35,9 +35,9 @@ environment using Devstack.
Environment Architecture Environment Architecture
------------------------- -------------------------
Using the following example architecture as a test environment to deploy neutron-dynamic-routing in Use the following example architecture as a test environment to deploy neutron-dynamic-routing in
your environment. The example architecture will deploy an all-in-one OpenStack and pick up an Ubuntu your environment. The example architecture will deploy an all-in-one OpenStack and connect to an Ubuntu
VM running Quagga as a router outside of OpenStack . See following:: VM running Quagga as a router outside of OpenStack. See following::
@ -49,11 +49,12 @@ VM running Quagga as a router outside of OpenStack . See following::
| +--------------+ | +--------------+
| | | |
|10.156.18.21 | External Network(172.24.4.0/24) |10.156.18.21 | External Network(172.24.4.0/24)
-------------------------------------------------------------------------------------------------- |ETH0 |br-ex --------------------------------------------------------------------------------------------------
|eth0
+---------------------------------------+ +---------------------------------------+
| | | | | | |
| | | | | | br-ex |
| | +-------+ | | +----------------+ |
| | |172.24.4.1 | | | |172.24.4.1 |
| +------------+ +-------+ | | +------------+ +-------+ |
| | | |Router | | | | | |Router | |
@ -75,7 +76,7 @@ Devstack Setup
git clone https://git.openstack.org/openstack-dev/devstack.git git clone https://git.openstack.org/openstack-dev/devstack.git
2. Enable neutron-dynamic-routing:: 2. Enable neutron-dynamic-routing by including this in your local.conf file::
[[local|localrc]] [[local|localrc]]
enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing enable_plugin neutron-dynamic-routing https://git.openstack.org/openstack/neutron-dynamic-routing
@ -103,9 +104,9 @@ it on Ubuntu Linux.
$ sudo chown quagga.quagga /etc/quagga/zebra.conf $ sudo chown quagga.quagga /etc/quagga/zebra.conf
$ sudo chmod 640 /etc/quagga/zebra.conf $ sudo chmod 640 /etc/quagga/zebra.conf
3. Update quagga deamon file. 3. Update quagga daemon file.
You can enable/disable the daemons routing in the /etc/quagga/daemons file. Update /etc/quagga/deamons to enable zebra and bgp:: You can enable/disable the daemons routing in the /etc/quagga/daemons file. Update /etc/quagga/daemons to enable zebra and bgp::
zebra=yes zebra=yes
bgpd=yes bgpd=yes
@ -160,17 +161,17 @@ Service Test
$ . devstack/openrc admin admin $ . devstack/openrc admin admin
2. Verify the neutron dynamic routing agent is running. 2. Verify that the neutron dynamic routing agent is running.
.. code-block:: console .. code-block:: console
$ neutron agent-list --agent-type 'BGP dynamic routing agent' $ openstack network agent list --agent-type bgp
+--------------------+--------------------+--------------------+-------------------+-------+----------------+---------------------+ +--------------------+--------------------+--------------------+-------------------+-------+-------+---------------------+
| id | agent_type | host | availability_zone | alive | admin_state_up | binary | | ID | Agent Type | Host | Availability Zone | Alive | State | Binary |
+--------------------+--------------------+--------------------+-------------------+-------+----------------+---------------------+ +--------------------+--------------------+--------------------+-------------------+-------+-------+---------------------+
| 69ad386f-e055-4284 | BGP dynamic | yang-devstack- | | :-) | True | neutron-bgp-dragent | | 69ad386f-e055-4284 | BGP dynamic | yang-devstack- | | :-) | UP | neutron-bgp-dragent |
| -8c8e-ef9bd540705c | routing agent | ubuntu-1604 | | | | | | -8c8e-ef9bd540705c | routing agent | ubuntu-1604 | | | | |
+--------------------+--------------------+--------------------+-------------------+-------+----------------+---------------------+ +--------------------+--------------------+--------------------+-------------------+-------+-------+---------------------+
3. Create an address scope. 3. Create an address scope.
@ -180,16 +181,15 @@ Service Test
.. code-block:: console .. code-block:: console
$ neutron address-scope-create --shared public 4 $ openstack address scope create --ip-version 4 --share public
Created a new address_scope:
+------------+--------------------------------------+ +------------+--------------------------------------+
| Field | Value | | Field | Value |
+------------+--------------------------------------+ +------------+--------------------------------------+
| id | c02c358a-9d35-43ea-8313-986b3e4a91c0 | | id | c02c358a-9d35-43ea-8313-986b3e4a91c0 |
| ip_version | 4 | | ip_version | 4 |
| name | public | | name | public |
| project_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
| shared | True | | shared | True |
| tenant_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
+------------+--------------------------------------+ +------------+--------------------------------------+
4. Create subnet pools. The provider and tenant networks use different pools. 4. Create subnet pools. The provider and tenant networks use different pools.
@ -521,12 +521,8 @@ Service Test
* Schedule the BGP speaker to ``BGP dynamic routing agent`` * Schedule the BGP speaker to ``BGP dynamic routing agent``
BGP speakers require manual scheduling to an agent. BGP speakers only form peering sessions. The first BGP speaker is scheduled to the first dynamic routing agent automatically.
So for a simple setup, there is nothing to be done here.
.. code-block:: console
$ neutron bgp-speaker-network-add bgp-speaker provider
Added network provider to BGP speaker bgpspeaker.
* Verify scheduling of the BGP speaker to the agent. * Verify scheduling of the BGP speaker to the agent.