Jump to: navigation, search

Difference between revisions of "Brocade-neutron-plugin"

 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
+
 
 
<!-- ##master-page:[[HomepageTemplate]] -->
 
<!-- ##master-page:[[HomepageTemplate]] -->
 
<!-- #format wiki -->
 
<!-- #format wiki -->
 
<!-- #language en -->
 
<!-- #language en -->
  
= Brocade Quantum Plugin =
+
= Brocade Neutron Plugin =
 
----------------------
 
----------------------
  
 
== Overview ==
 
== Overview ==
  
Brocade Quantum Plugin implements the Quantum v2.0 API. Switches running NOS  [http://www.brocade.com/products/all/switches/index.page  (e.g. VDX 67xx, VDX 87xx)] are supported. It uses NETCONF at the backend to configure the Brocade switch.
+
Openstack is an open source infrastructure as a service (IaaS) initiative for creating and managing large groups of virtual private servers in a cloud computing environment. Brocade Neutron Plugin for VDX/VCS provides a means to interface Openstack’s Networking (formerly Quantum Networking) to orchestrate Brocade’s physical switches.
 +
 
 +
In cloud environments where VMs are hosted by physical servers, the VMs see a new virtual access layer provided by the host machine. This new access layer can be created at the via many mechanisms e.g. Linux Bridges or a Virtual Switches. The policies of the virtual access layer (virtual network), when set must now be coordinated with the policies set in the hardware switches. Brocade’s Neutron Plugin helps in coordinating this behavior automatically without any intervention from the administrator.
 +
 
 +
 
 +
 
 +
 
 +
[[File:Brocade1.PNG|frame|center|Virtual and Physical Network Orchestration]]
 +
 
 +
 
 +
 
 +
 
 +
Brocade Neutron Plugin implements the Neutron v2.0 API. Switches running NOS  [http://www.brocade.com/products/all/switches/index.page  (e.g. VDX 67xx, VDX 87xx)] are supported. It uses NETCONF at the backend to configure the Brocade switch.  
 +
 
 +
The plugin orchestrates virtual network and physical networks at appropriate times in the life cycle of a 'Neutron network' and virtual machines.
 +
 
 +
 
 +
<pre><nowiki>
 +
            +------------+        +------------+          +-------------+
 +
            |            |        |            |          |            |
 +
            |            |        |            |          |  Brocade  |
 +
            | Openstack  |  v2.0  |  Brocade  |  NETCONF |  VCS Switch |
 +
            | Neutron    +--------+  Neutron  +----------+            |
 +
            |            |        |  Plugin    |          |  VDX 67xx  |
 +
            |            |        |            |          |  VDX 87xx  |
 +
            |            |        |            |          |            |
 +
            |            |        |            |          |            |
 +
            +------------+        +------------+          +-------------+
 +
 
 +
</nowiki></pre>
  
 
== Directory Structure ==
 
== Directory Structure ==
  
(this paragraph is relevant ONLY if you have download the Brocade Quantum Plugin from: http://www.github.com/brocade/brocade )
+
(this paragraph is relevant ONLY if you have download the Brocade Neutron Plugin from the repository located at: http://www.github.com/brocade/brocade )
  
 
Normally you will have your Openstack directory structure as follows:
 
Normally you will have your Openstack directory structure as follows:
Line 21: Line 50:
 
/opt/stack/nova/
 
/opt/stack/nova/
 
/opt/stack/horizon/
 
/opt/stack/horizon/
/opt/stack/quantum/quantum/plugins/
+
/opt/stack/neutron/neutron/plugins/
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 29: Line 58:
  
 
<pre><nowiki>
 
<pre><nowiki>
/opt/stack/quantum/quantum/plugins/brocade
+
/opt/stack/neutron/neutron/plugins/brocade
 +
</nowiki></pre>
 +
 
 +
 
 +
== Prerequsites ==
 +
 
 +
ncclient v0.3.1 - Python library for NETCONF clients. http://github.com/brocade/ncclient
 +
 
 +
 
 +
<pre><nowiki>
 +
% git clone https://www.github.com/brocade/ncclient
 +
% cd ncclient; sudo python ./setup.py install
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 35: Line 75:
 
== Configuration ==
 
== Configuration ==
  
1. Specify to Quantum that you will be using the Brocade Plugin - this is done
+
1. Specify to Neutron that you will be using the Brocade Plugin - this is done
by setting the parameter core_plugin in Quantum:
+
by setting the parameter core_plugin in Neutron:
  
  
 
<pre><nowiki>
 
<pre><nowiki>
core_plugin = quantum.plugins.brocade.QuantumPlugin.BrcdPluginV2
+
core_plugin = neutron.plugins.brocade.NeutronPlugin.BrocadePluginV2
 
</nowiki></pre>
 
</nowiki></pre>
  
  
 
2. Physical switch configuration parameters and Brocade specific database configuration is specified in
 
2. Physical switch configuration parameters and Brocade specific database configuration is specified in
the configuration file specified in the brocade.ini files:
+
the configuration file specified in the brocade.ini file:
  
  
 
<pre><nowiki>
 
<pre><nowiki>
% cat /etc/quantum/plugins/brocade/brocade.ini
+
% cat /etc/neutron/plugins/brocade/brocade.ini
  
 
[SWITCH]
 
[SWITCH]
Line 58: Line 98:
  
 
[DATABASE]
 
[DATABASE]
sql_connection = mysql://root:pass@localhost/brcd_quantum?charset=utf8
+
sql_connection = mysql://root:pass@localhost/brcd_Neutron?charset=utf8
 
</nowiki></pre>
 
</nowiki></pre>
  
  
        (please see list of more configuration parameters in the brocade.ini file)
+
Please see list of more configurable parameters in the brocade.ini file.
  
 
== Running Setup.py ==
 
== Running Setup.py ==
  
 
Running setup.py with appropriate permissions will copy the default configuration
 
Running setup.py with appropriate permissions will copy the default configuration
file to /etc/quantum/plugins/brocade/brocade.ini. This file MUST be edited to
+
file to /etc/Neutron/plugins/brocade/brocade.ini. This file MUST be edited to
 
suit your setup/environment.
 
suit your setup/environment.
  
  
 
<pre><nowiki>
 
<pre><nowiki>
% cd /opt/stack/quantum/quantum/plugins/brocade
+
% cd /opt/stack/neutron/neutron/plugins/brocade
 
% python setup.py
 
% python setup.py
 
</nowiki></pre>
 
</nowiki></pre>
Line 80: Line 120:
  
 
Please see special notes for devstack at:
 
Please see special notes for devstack at:
http://wiki.openstack.org/brocade-quantum-plugin
+
http://wiki.openstack.org/brocade-Neutron-plugin
  
In order to use Brocade Quantum Plugin, add the following lines in localrc, if localrc
+
 
 +
Brocade Neutron plugin has been tested to work on Redhat and Ubuntu releases. Devstack is normally run by a non-root user 'stack'. It is advisable to create a userid 'stack' on your Linux machine.
 +
 
 +
<pre><nowiki>
 +
% cd /home/stack
 +
% git clone https://www.github.com/brocade/devstack
 +
% cd devstack
 +
</nowiki></pre>
 +
 
 +
In order to use Brocade Neutron Plugin, add the following lines in localrc, if localrc
 
file does not exist you may have to create one:
 
file does not exist you may have to create one:
 
  
 
<pre><nowiki>
 
<pre><nowiki>
ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xv\
+
ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xvnc,n-cauth,horizon,rabbit,neutron,q-svc,q-agt
nc,n-cauth,horizon,rabbit,quantum,q-svc,q-agt
+
Q_PLUGIN=brocade
Q_PLUGIN=BrcdQuantumPlugin
 
 
</nowiki></pre>
 
</nowiki></pre>
  
  
As part of using devstack, the files above are copied over from quantum to their
+
As part of using devstack, the files above are copied over from Neutron to their
 
final destination. So it will be advisable to edit the files appropriately.
 
final destination. So it will be advisable to edit the files appropriately.
  
  
 
<pre><nowiki>
 
<pre><nowiki>
/opt/stack/quantum/etc/quantum.conf -> /etc/quantum/quantum.conf
+
/opt/stack/neutron/etc/neutron.conf -> /etc/neutron/neutron.conf
/opt/stack/quantum/etc/quantum/plugins/brocade/brocade.ini -> /etc/quantum/plugins/brocade/brocade.ini
+
/opt/stack/neutron/etc/neutron/plugins/brocade/brocade.ini -> /etc/neutron/plugins/brocade/brocade.ini
 
</nowiki></pre>
 
</nowiki></pre>
  
  
hence it is important to make any changes to the configuration in:
+
Hence it is important to make any changes to the configuration in:
 +
 
 +
<pre><nowiki>
 +
/opt/stack/neutron/etc/neutron/plugins/brocade/brocade.ini
 +
</nowiki></pre>
 +
 
 +
Run devstack as:
  
 
<pre><nowiki>
 
<pre><nowiki>
/opt/stack/quantum/etc/quantum/plugins/brocade/brocade.ini
+
% cd /home/stack/devstack;  ./stack.sh
 
</nowiki></pre>
 
</nowiki></pre>
 +
 +
 +
== Example Topology ==
 +
 +
[[File:BQP Application.png|center|frame]]

Latest revision as of 22:29, 31 October 2013


Brocade Neutron Plugin


Overview

Openstack is an open source infrastructure as a service (IaaS) initiative for creating and managing large groups of virtual private servers in a cloud computing environment. Brocade Neutron Plugin for VDX/VCS provides a means to interface Openstack’s Networking (formerly Quantum Networking) to orchestrate Brocade’s physical switches.

In cloud environments where VMs are hosted by physical servers, the VMs see a new virtual access layer provided by the host machine. This new access layer can be created at the via many mechanisms e.g. Linux Bridges or a Virtual Switches. The policies of the virtual access layer (virtual network), when set must now be coordinated with the policies set in the hardware switches. Brocade’s Neutron Plugin helps in coordinating this behavior automatically without any intervention from the administrator.



Virtual and Physical Network Orchestration



Brocade Neutron Plugin implements the Neutron v2.0 API. Switches running NOS (e.g. VDX 67xx, VDX 87xx) are supported. It uses NETCONF at the backend to configure the Brocade switch.

The plugin orchestrates virtual network and physical networks at appropriate times in the life cycle of a 'Neutron network' and virtual machines.


 
             +------------+        +------------+          +-------------+
             |            |        |            |          |             |
             |            |        |            |          |   Brocade   |
             | Openstack  |  v2.0  |  Brocade   |  NETCONF |  VCS Switch |
             | Neutron    +--------+  Neutron   +----------+             |
             |            |        |  Plugin    |          |  VDX 67xx   |
             |            |        |            |          |  VDX 87xx   |
             |            |        |            |          |             |
             |            |        |            |          |             |
             +------------+        +------------+          +-------------+

Directory Structure

(this paragraph is relevant ONLY if you have download the Brocade Neutron Plugin from the repository located at: http://www.github.com/brocade/brocade )

Normally you will have your Openstack directory structure as follows:


/opt/stack/nova/
/opt/stack/horizon/
/opt/stack/neutron/neutron/plugins/


This repository represents code that will be put into the brocade directory as:


/opt/stack/neutron/neutron/plugins/brocade


Prerequsites

ncclient v0.3.1 - Python library for NETCONF clients. http://github.com/brocade/ncclient


% git clone https://www.github.com/brocade/ncclient
% cd ncclient; sudo python ./setup.py install


Configuration

1. Specify to Neutron that you will be using the Brocade Plugin - this is done by setting the parameter core_plugin in Neutron:


core_plugin = neutron.plugins.brocade.NeutronPlugin.BrocadePluginV2


2. Physical switch configuration parameters and Brocade specific database configuration is specified in the configuration file specified in the brocade.ini file:


% cat /etc/neutron/plugins/brocade/brocade.ini

[SWITCH]
username = admin
password = password
address  = <switch mgmt ip address>
ostype   = NOS

[DATABASE]
sql_connection = mysql://root:pass@localhost/brcd_Neutron?charset=utf8


Please see list of more configurable parameters in the brocade.ini file.

Running Setup.py

Running setup.py with appropriate permissions will copy the default configuration file to /etc/Neutron/plugins/brocade/brocade.ini. This file MUST be edited to suit your setup/environment.


% cd /opt/stack/neutron/neutron/plugins/brocade
% python setup.py


Devstack

Please see special notes for devstack at: http://wiki.openstack.org/brocade-Neutron-plugin


Brocade Neutron plugin has been tested to work on Redhat and Ubuntu releases. Devstack is normally run by a non-root user 'stack'. It is advisable to create a userid 'stack' on your Linux machine.

% cd /home/stack
% git clone https://www.github.com/brocade/devstack
% cd devstack

In order to use Brocade Neutron Plugin, add the following lines in localrc, if localrc file does not exist you may have to create one:

ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xvnc,n-cauth,horizon,rabbit,neutron,q-svc,q-agt
Q_PLUGIN=brocade


As part of using devstack, the files above are copied over from Neutron to their final destination. So it will be advisable to edit the files appropriately.


/opt/stack/neutron/etc/neutron.conf -> /etc/neutron/neutron.conf
/opt/stack/neutron/etc/neutron/plugins/brocade/brocade.ini -> /etc/neutron/plugins/brocade/brocade.ini


Hence it is important to make any changes to the configuration in:

/opt/stack/neutron/etc/neutron/plugins/brocade/brocade.ini

Run devstack as:

% cd /home/stack/devstack;  ./stack.sh


Example Topology

BQP Application.png