Browse Source

Add text to README.rst describing MDs and Plugins

Partial bug: #1452010

Change-Id: I4dd285c7a97bdd213a50f4fc67c60b8c62fabec7
tags/kilo-eol
Shiv Haris 4 years ago
parent
commit
158b634d13
1 changed files with 68 additions and 3 deletions
  1. 68
    3
      README.rst

+ 68
- 3
README.rst View File

@@ -7,7 +7,72 @@ Brocade Networking Mech. Drivers and Plugins
7 7
 * Free software: Apache license
8 8
 * Source: http://git.openstack.org/cgit/stackforge/networking-brocade
9 9
 
10
-Features
11
---------
10
+The followin Mechanism Driver and Plugins are available in this repository:
11
+
12
+1. VDX ML2 Mechanism Driver (L2)
13
+2. VDX SVI Driver (L3)
14
+3. ...
15
+
16
+Documentation:
17
+
18
+VDX ML2 Mechanism Driver:
19
+
20
+* N.B.: Please see Prerequisites section  regarding ncclient (netconf client library)
21
+* Supports VCS (Virtual Cluster of Switches)
22
+* Issues/Questions/Bugs: sharis@brocade.com
23
+
24
+
25
+
26
+   1. VDX 67xx series of switches
27
+   2. VDX 87xx series of switches
28
+
29
+ML2 plugin requires mechanism driver to support configuring of hardware switches.
30
+Brocade Mechanism for ML2 uses NETCONF at the backend to configure the Brocade switch.
31
+Currently the mechanism drivers support VLANs only.
32
+
33
+             +------------+        +------------+          +-------------+
34
+             |            |        |            |          |             |
35
+   Neutron   |            |        |            |          |   Brocade   |
36
+     v2.0    | Openstack  |        |  Brocade   |  NETCONF |  VCS Switch |
37
+         ----+ Neutron    +--------+  Mechanism +----------+             |
38
+             | ML2        |        |  Driver    |          |  VDX 67xx   |
39
+             | Plugin     |        |            |          |  VDX 87xx   |
40
+             |            |        |            |          |             |
41
+             |            |        |            |          |             |
42
+             +------------+        +------------+          +-------------+
43
+
44
+
45
+Configuration
46
+
47
+In order to use this mechnism the brocade configuration file needs to be edited with the appropriate
48
+configuration information:
49
+
50
+        % cat /etc/neutron/plugins/ml2/ml2_conf_brocade.ini
51
+        [switch]
52
+        username = admin
53
+        password = password
54
+        address  = <switch mgmt ip address>
55
+        ostype   = NOS
56
+
57
+Additionally the brocade mechanism driver needs to be enabled from the ml2 config file:
58
+
59
+       % cat /etc/neutron/plugins/ml2/ml2_conf.ini
60
+
61
+       [ml2]
62
+       tenant_network_types = vlan
63
+       type_drivers = local,flat,vlan,gre,vxlan
64
+       mechanism_drivers = brocade
65
+       ...
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
12 78
 
13
-* TODO

Loading…
Cancel
Save