Honeycomb Facts
Project Lead: Michal Cmarada Committers: Dave Wallace Maros Marsalek Marek Gradzki Ed Warnicke Robert Varga Juraj Sloboda Michal Cmarada Repository: git clone https://gerrit.fd.io/r/honeycomb Mailing List: [email protected] Jenkins: jenkins silo Gerrit Patches: code patches/reviews Bugs: HONEYCOMB bugs

## Intro Honeycomb is a generic NETCONF/RESTCONF java-based management agent and provides a framework for building specialized agents. It uses many features and utilities from different [Opendaylight (ODL)](http://www.opendaylight.org) projects (e.g. yangtools, controller, mdsal and netconf). The biggest use case of honeycomb is VPP (fd.io’s Vector packet processor). Honeycomb delivers a management agent to enable integration of VPP with e.g. SDN controllers such as Opendaylight. For VPP specific distribution of Honeycomb, please refer to [hc2vpp](view/Hc2vpp.md) project. ### Overview #### Project Termination [Honeycomb/Termination Review](view/Honeycomb/Termination_Review.md) #### Slides Honeycomb overview presentation from Paris FD.io 2016 event: [File:Honeycomb overview.pptx](view/File:Honeycomb_overview.md) Honeycomb 1609 overview update from fd.io Seattle summit 2016: [File:HC 1609 overview.pptx](view/File:HC_1609_overview.md) #### Generic nature Honeycomb provides a distribution to control VPP. However HC is developed as a generic agent that can be positioned on top of any other software/system etc. that can be controlled from Java(or some other JVM language) code. This is achieved thanks to the modularity of HC enabling any "translation plugin" such as V3PO (VPP core management translation code) to work in HC framework. #### Minimal distribution Honeycomb provides a minimal distribution that contains only: - HC framework jars + plugin jars + dependencies from Opendaylight - HC framework config files + plugin config files - Runnable shell scripts ## Project Contact Name and Email - honeycomb-dev list, - Michal Cmarada, LF-ID: mcmarada, - Marek Gradzki, LF-ID: mgradzki, - Maros Marsalek, LF-ID: mmarsale, - Ed Warnicke, LF-ID: hagbard, - Dave Wallace, LF-ID: dwallacelf ## Meeting [Honeycomb meeting](view/Honeycomb/Meeting.md) ## Scope This section is devided into 2 sections: in-scope and out-of-scope to clearly define what is developed as part of Honeycomb project and what will be just reused from other projects (or where Honeycomb relies on other projects). **Honeycomb project scope: ** - Northbound interfaces: - [Netconf](http://tools.ietf.org/html/rfc4741,) northbound interface - [Restconf](https://tools.ietf.org/html/draft-ietf-netconf-restconf-05,) northbound interface - [BGP](https://www.ietf.org/rfc/rfc4271,) - Translation layer between device management and Yang based data structures - Honeycomb distribution - Minimal distribution for Honeycomb management agent with all dependencies from ODL and their wiring **Out of scope: ** - Yang models and translation code for VPP management - Moved to [hc2vpp](view/Hc2vpp.md) in 17.01 - Vpp-japi - Java APIs for VPP, allowing JVM to interact with VPP is out of scope of Honeycomb project and is part of the base VPP project - Yang parser - Available from ODL's [yangtools](https://git.opendaylight.org/gerrit/#/admin/projects/yangtools,) project - Base implementation of northbound interfaces - Base implementation of generic northbound interfaces is out of scope and will be reused from ODL's [netconf](https://git.opendaylight.org/gerrit/#/admin/projects/netconf,) project - Yang based data structures and a dedicated DataTree(storage) - Available from ODL's [yangtools](https://git.opendaylight.org/gerrit/#/admin/projects/yangtools,) and [mdsal](https://git.opendaylight.org/gerrit/#/admin/projects/mdsal,) projects, not necessarily the entire projects, only required parts in binary form. - Integration/performance testing - Complex integration or performance tests are out of scope of Honeycomb project and are part of CSIT project - Any other application based on top of Honeycomb is out of scope of this project and needs to be hosted in a dedicated project inside or outside of fd.io ## Releases ### 19.01 - Last stable **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_19.01.md)**: - Work planned for release - Milestones leading to the release [**Documentation**](https://docs.fd.io/honeycomb/1.19.101/honeycomb-aggregator/index.html): - Devel documentation - Overview - Details - Javadocs - ... for each module in Honeycomb project [**Release notes**](https://docs.fd.io/honeycomb/1.19.01/release-notes-aggregator/release_notes.html): - New/Updated/Removed/Deprecated Features - Install guide - Devel guide - User guide ### 19.04 - Current master **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_19.04.md)**: - Work planned for release - Milestones leading to the release [**Documentation**](https://docs.fd.io/honeycomb/1.19.04-SNAPSHOT/honeycomb-aggregator/index.html): - Devel documentation - Overview - Details - Javadocs - ... for each module in Honeycomb project [**Release notes**](https://docs.fd.io/honeycomb/1.19.04-SNAPSHOT/release-notes-aggregator/release_notes.html): - New/Updated/Removed/Deprecated Features - Install guide - Devel guide - User guide ### Previous releases #### 18.10 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_18.10.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.18.10/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.18.10/honeycomb-aggregator/index.html): #### 18.07 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_18.07.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.18.07/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.18.07/honeycomb-aggregator/index.html): #### 18.04 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_18.04.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.18.04/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.18.04/honeycomb-aggregator/index.html): #### 18.01 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_18.01.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.18.01/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.18.01/honeycomb-aggregator/index.html): #### 17.10 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_17.10.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.17.10/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.17.10/honeycomb-aggregator/index.html): #### 17.07 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_17.07.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.17.07/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.17.07/honeycomb-aggregator/index.html): #### 17.04 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_17.04.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.17.04/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.17.04/honeycomb-aggregator/index.html): #### 17.01 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_17.01.md)**: - [**Release notes**](https://docs.fd.io/honeycomb/1.17.01/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/honeycomb/1.17.01/honeycomb-aggregator/index.html): #### 16.09 **[Honeycomb 1609 release page](view/Honeycomb/Releases/1609.md)** ## Honeycomb backlog Backlog can be found in: [Honeycomb's JIRA](https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10200). ## Code quality Current sonar analysis can be found at: [Honeycomb's sonar](https://sonar.fd.io/overview?id=1107) ## Devel [HowTo: Cutting stable branches](view/Honeycomb/BranchCutting.md) [HowTo: Bumping versions](view/Honeycomb/BumpingVersions.md) ### Design and architecture // TODO These all should be part of the code in e.g. adoc format, built during CI, deployed and just linked here [JVpp Java facade for VPP](view/VPP/Java_API.md) Honeycomb Translation layer/SPI [Honeycomb persistence/Reconciliation with VPP](view/Honeycomb/Persistence.md) [Modifying the VPP JVPP API and testing in Honeycomb](view/Honeycomb/VPPJAPI_workflow.md) [IETF_ACL model implementation](view/Honeycomb/IETF-ACL_model.md)