diff options
| author |   Maros Marsalek <mmarsale@cisco.com> | 2016-04-12 10:13:28 +0200 |
|---|---|---|
| committer | Maros Marsalek <mmarsale@cisco.com> | 2016-04-12 10:13:28 +0200 |
| commit | 5f82161cddaf35acbb6197139deaf604cdc4aca0 (patch) | |
| tree | 498ac674929071121ee502c8b4ff5073c65671f9 /v3po/Readme.adoc | |
| parent | a36279bc8bf595fc3d92cf8a59d2044e1f700358 (diff) | |
HONEYCOMB-8: HC ascii docs. Initial version
Change-Id: Id9540f9a7aa863517c1fbf54f9eb5bd20b565476
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'v3po/Readme.adoc')
| -rw-r--r-- | v3po/Readme.adoc | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/v3po/Readme.adoc b/v3po/Readme.adoc new file mode 100644 index 000000000..a2b6f4c4b --- /dev/null +++ b/v3po/Readme.adoc @@ -0,0 +1,61 @@ += 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. + + + + |