110231b9d44ee473c568bae2f0836cd718c90399
[docs.git] / docs / release-notes / projects / openflowplugin.rst
1 ===============
2 OpenFlow Plugin
3 ===============
4
5 Overview
6 ========
7
8 The OpenFlow Plugin project provides the following functionality:
9
10 * **OpenFlow 1.0/1.3 implementation project**: This provides the implementation of the
11   OpenFlow 1.0 and OpenFlow 1.3 specification.
12 * **ONF Approved Extensions Project**: This provides the implementation of following ONF
13   OpenFlow 1.4 feature, which is approved as extensions for the OpenFlow 1.3
14   specification:
15
16   * **Nicira Extensions Project**: This provides the implementation of the Nicira extensions.
17     Some of the important extensions implemented are **Connection Tracking Extension**
18     and **Group Add-Mod Extension**
19
20 * **OpenFlow-Based Applications Project**: This provides the following applications that user can
21   leverage out-of-the-box in developing their application or as a direct end consumer:
22
23   .. list-table:: OpenFlow-Based Applications
24      :widths: 15 55
25      :header-rows: 1
26
27      * - **Application**
28        - **Description**
29
30      * - **Forwarding Rules Manager**
31        -  Application provides functionality to add/remove/update flow/groups/meters.
32      * - **LLDP Speaker**
33        - Application sends periodic LLDP packet out on each OpenFlow switch port for link discovery.
34      * - **Topology LLDP Discovery**
35        - Application intercept the LLDP packets and discover the link information.
36      * - **Topology Manager**
37        - Application receives the discovered links information from Topology LLDP
38          Discovery application and stores in the topology yang model datastore.
39      * - **Reconciliation Framework**
40        - Framework that exposes the APIs that consumer application (in-controller) can
41          leverage to participate in the switch reconciliation process in the event of
42          switch connection/reconnection.
43      * - **Arbitrator Reconciliation**
44        - Application exposes the APIs that consumer application or direct user can
45          leverage to trigger the device configuration reconciliation.
46      * - **OpenFlow Java Library Project**
47        - Provides the OpenFlow Java Library that converts the data based on OpenFlow
48          plugin data models to the OpenFlow java models before sending it down the
49          wire to the device.
50      * - **Reconciliation**
51        - Reconciles the state using Openflow 1.4 bundles.
52
53 Behavior/Feature Changes
54 ========================
55
56 This release introduces the following behavior changes:
57
58 *
59
60 New Features
61 ============
62
63 This release provides the following new features:
64
65 *
66
67 Deprecated Features
68 ===================
69
70 This release removed the following features:
71
72 *
73
74 Resolved Issues
75 ===============
76
77 The following table lists the resolved issues fixed this release.
78
79 .. list-table::
80    :widths: 15 55
81    :header-rows: 1
82
83    * - **Key**
84      - **Summary**
85
86    * - <bug ID>
87      -
88
89 Known Issues
90 ============
91
92 The following table lists the known issues that exist in this release.
93
94 .. list-table::
95    :widths: 15 55
96    :header-rows: 1
97
98    * - **Key**
99      - **Summary**
100
101    * - <bug ID>
102      -