--- /dev/null
+= 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.
+
+
+
+
--- /dev/null
+= Honeycomb. Translation layer configuration
+
+Defines ReaderRegistry and WriterRegistry for VPP.
+Data layer delegates actual reads and writes to these registers.
+Registries define root readers and writers for supported YANG models.
+
+
+
+
+
--- /dev/null
+= Honeycomb Data layer. API
+
+Provides data tree abstraction for data store modeling.
+ModifiableDataTree can be used to model CONFIG data store.
+ReadableDataTree can be used to model OPERATIONAL data store.
+
+
+
+
+
--- /dev/null
+= Honeycomb Data layer. Implementation
+
+Models CONFIG data store as a DataTree.
+
+Every read transaction reads directly from the DataTree.
+Every write transaction is validated, then passed to the translation layer.
+After successful update, config data tree is updated.
+
+OPERATIONAL data store reads are passed directly to the translation layer.
+
+Data transaction functionality for higher layers (i.e NETCONF/RESTCONF layer) is provided by DataBroker.
+
+[ditaa, "data-layer-architecture"]
+....
+ /------------------\
+ | RESTCONF/NETCONF |
+ \--------+---------/
+ |
+----------------------------|------------------------------------
+ v
+ /------------------\
+ | DataBroker |
+ \-+--------------+-/
+ | |
+ | read | read/write
+ Honeycomb v v
+ data layer /------+------\ /--+--------\ /----------\
+ | | | | | |
+ | Operational | | Config +------>+ DataTree +
+ | DataTree | | DataTree | | |
+ | | | | \----------/
+ \------+------/ \--+--------/
+ | |
+---------------------|--------------|----------------------------
+ v v
+ /-----+--------------+-----\
+ | Translation layer |
+ \--------------------------/
+....
+
+
+
+
--- /dev/null
+= Honeycomb translation layer API
+
+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.
+For every supported YANG model there should be at least one reader and writer registered.
+Readers and writers form two tree structures matching corresponding YANG models.
+Readers and writers can be attached to any non-leaf YANG node.
\ No newline at end of file
--- /dev/null
+= Honeycomb translation layer implementation
+
+Provides composite implementations of child, list and root readers/writers.
+
+Root readers/writers can be used to provide data translation at root node level.
+List readers/writers help with data translation for nodes modeled as YANG lists.
+Child readers/writers can be used to provide data translation for non-leaf nodes.
+
+Readers and writers can be easily extended using customizers defined in the translate-spi module.
\ No newline at end of file
--- /dev/null
+= Honeycomb translation layer SPI
+
+Provides root, child and list customizer interfaces for extending readers/writers.
+Customizers can be used to implement actual data reads and writes.
\ No newline at end of file
--- /dev/null
+= Honeycomb translation layer utils
+
+Provides utility classes useful in translation layer implementation.
\ No newline at end of file
--- /dev/null
+= Honeycomb translation layer SPI implementation for VPP
+
+Provides customizers for VPP YANG models translation.
\ No newline at end of file
--- /dev/null
+= Honeycomb. VPP translation layer utils
+
+Provides utility classes useful in translation layer implementation for the VPP.
\ No newline at end of file
Code Review / honeycomb.git / commitdiff