diff options
| author |   Maros Marsalek <mmarsale@cisco.com> | 2016-09-21 13:51:57 +0200 |
|---|---|---|
| committer | Maros Marsalek <mmarsale@cisco.com> | 2016-09-26 11:02:04 +0200 |
| commit | bc335de41876acd8720dce1030a79b3a7b39c3b1 (patch) | |
| tree | c3b1b99c72fbcc36db5b7ff3e4c4e37680481eb0 /infra/Readme.adoc | |
| parent | 09df17bb630b5bf594efbd9f869ef17da5e2b6ac (diff) | |
HONEYCOMB-209 Configure maven site
To produce site for Honeycomb +
javadoc
asciidoc
To build the site:
mvn clean install site:attach-descriptor site
mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage
Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'infra/Readme.adoc')
| -rw-r--r-- | infra/Readme.adoc | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/infra/Readme.adoc b/infra/Readme.adoc deleted file mode 100644 index 33e882f8c..000000000 --- a/infra/Readme.adoc +++ /dev/null @@ -1,67 +0,0 @@ -= 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. - - - - |