- THIS NAPP IS STILL EXPERIMENTAL AND ITS EVENTS, METHODS AND STRUCTURES MAY
- CHANGE A LOT ON THE NEXT FEW DAYS/WEEKS. USE IT AT YOUR OWN DISCRETION
+ NApp that manages OpenFlow 1.3 entries
+
-The *kytos/flow_manager* NApp exports a REST API to add, remove and
-list flows from OpenFlow switches, for versions 1.0 and 1.3.
-It can be used by other applications to manage flows with the supported fields.
-This application creates an abstraction layer to other applications:
-it is only necessary to know the endpoints. The application handles
-the requests and returns the information already formatted.
+Features
+========
+
+- REST API to create/update/read/delete flows
+- Expose events to create/update/delete flows
+- Store flows in memory and in a permanent storage
+- Consistency check based on FlowStats to ensure that only expected flows are installed
+- Consistency check ignored flows based on a cookie range and/or table id range
+- Send barrier request and replies
+- Handle southbound socket connection errors as applicable
+- Option to allow to install a flow later on when a switch is connected
Supported Fields
-****************
+================
This NApp supports a subset of the OpenFlow specification fields in the bodies of
the requests when creating and removing flows:
@@ -62,40 +67,53 @@ the requests when creating and removing flows:
Other fields are not supported and will generate error messages from the NApp.
-##########
Installing
-##########
+==========
-All of the Kytos Network Applications are located in the NApps online repository.
-To install this NApp, run:
+To install this NApp, first, make sure to have the same venv activated as you have ``kytos`` installed on:
.. code:: shell
- $ kytos napps install kytos/flow_manager
+ $ git clone https://github.com/kytos-ng/flow_manager.git
+ $ cd flow_manager
+ $ python setup.py develop
-############
Requirements
-############
+============
-- kytos/of_core
-- kytos/storehouse
+- `kytos/of_core `_
+- `kytos/storehouse `_
-######
Events
-######
+======
Generated
-*********
+---------
+
+kytos/flow_manager.flow.pending
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*buffer*: ``app``
+
+Event reporting that a FlowMod was sent to a Datapath.
+
+Content:
+
+.. code-block:: python3
+
+ {
+ 'datapath': ,
+ 'flow':