From 0578156b721fa01c8c645b8f9625ecebdb6449e4 Mon Sep 17 00:00:00 2001
From: Maros Marsalek <mmarsale@cisco.com>
Date: Wed, 27 Jul 2016 11:05:51 +0200
Subject: HONEYCOMB-130: Separate v3po plugin from HC infra

Creating folders:
- common/
- infra/
- v3po/
- vpp-common/

Change-Id: I2c39e1b17e39e7c0f0628f44aa5fe08563fa06e4
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
---
 infra/Readme.adoc | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 infra/Readme.adoc

(limited to 'infra/Readme.adoc')

diff --git a/infra/Readme.adoc b/infra/Readme.adoc
new file mode 100644
index 000000000..33e882f8c
--- /dev/null
+++ b/infra/Readme.adoc
@@ -0,0 +1,67 @@
+= Honeycomb
+
+Honeycomb is an VPP agent that runs the same host as a VPP instance
+and exposes YANG models via NETCONF and RESTCONF to allow management of that VPP instance.
+Honeycomb uses jAPI to communicate with the VPP.
+
+[ditaa, "hc-architecture"]
+....
+                   /------------------\
+ ODL               | RESTCONF/NETCONF |
+                   \-+--------------+-/
+                     |              ^
+---------------------|--------------|---------------------
+                     v              |
+                   /------------------\
+                   |    Data layer    |
+                   \-+--------------+-/
+                     |              ^
+ Honeycomb           v              |
+               /-----+--------------+-----\
+               |     Translation layer    |
+               \----+----------------+----+
+                    |  VPP SPI impl  |
+                    +---+------+-----+
+                        |      ^
+------------------------|------|--------------------------
+                        v      |
+                       ++------++
+                       |  jAPI  |
+ VPP              /----+--------+------\
+                  |        VPP         |
+                  \--------------------/
+
+....
+
+== NETCONF/RESTCONF layer
+
+NETCONF and RESTCONF support is provided by ODL (Honeycomb is an ODL application).
+In the future we plan to minimize ODL dependencies or completely remove karaf.
+
+Transaction functionality is provided by the data layer.
+
+== Data layer
+
+Models CONFIG data store as a DataTree.
+
+OPERATIONAL data store reads are passed directly to the translation layer.
+
+Provides transaction functionality for NETCONF/RESTCONF layer.
+
+
+== Translation layer
+
+Extensible API for translation between Binding Aware data and actual device data.
+Consists of readers and writers responsible for communication with the device.
+
+Provides registry of readers and writers for the data layer.
+
+== Supported features
+
+List of supported requests for RESTCONF northbound interface can be found in
+postman_rest_collection.json within the codebase. 
+It is a POSTMAN compatible collection and can be imported into POSTMAN application.
+
+
+
+
-- 
cgit 1.2.3-korg

