1= Honeycomb
2
3Honeycomb is an VPP agent that runs the same host as a VPP instance
4and exposes YANG models via NETCONF and RESTCONF to allow management of that VPP instance.
5Honeycomb uses jAPI to communicate with the VPP.
6
7[ditaa, "hc-architecture"]
8....
9                   /------------------\
10 ODL               | RESTCONF/NETCONF |
11                   \-+--------------+-/
12                     |              ^
13---------------------|--------------|---------------------
14                     v              |
15                   /------------------\
16                   |    Data layer    |
17                   \-+--------------+-/
18                     |              ^
19 Honeycomb           v              |
20               /-----+--------------+-----\
21               |     Translation layer    |
22               \----+----------------+----+
23                    |  VPP SPI impl  |
24                    +---+------+-----+
25                        |      ^
26------------------------|------|--------------------------
27                        v      |
28                       ++------++
29                       |  jAPI  |
30 VPP              /----+--------+------\
31                  |        VPP         |
32                  \--------------------/
33
34....
35
36== NETCONF/RESTCONF layer
37
38NETCONF and RESTCONF support is provided by ODL (Honeycomb is an ODL application).
39In the future we plan to minimize ODL dependencies or completely remove karaf.
40
41Transaction functionality is provided by the data layer.
42
43== Data layer
44
45Models CONFIG data store as a DataTree.
46
47OPERATIONAL data store reads are passed directly to the translation layer.
48
49Provides transaction functionality for NETCONF/RESTCONF layer.
50
51
52== Translation layer
53
54Extensible API for translation between Binding Aware data and actual device data.
55Consists of readers and writers responsible for communication with the device.
56
57Provides registry of readers and writers for the data layer.
58
59== Supported features
60
61List of supported requests for RESTCONF northbound interface can be found in
62postman_rest_collection.json within the codebase. 
63It is a POSTMAN compatible collection and can be imported into POSTMAN application.
64
65
66
67
68