hc2vpp Facts
Project Lead: Michal Cmarada Committers: Maros Marsalek Marek Gradzki Hongjun Ni Michal Cmarada Jan Srnicek (Emeritus) Repository: git clone https://gerrit.fd.io/r/hc2vpp Mailing List: [email protected] Jenkins: jenkins silo Gerrit Patches: code patches/reviews Bugs: HC2VPP bugs

## Intro Hc2vpp is a java-based agent that runs on the same host as a VPP instance, and exposes yang models via netconf or restconf to allow the management of that VPP instance from off box. The Hc2vpp project used to be part of [honeycomb](view/Honeycomb.md). Process of spiting honeycomb project into generic (honeycomb) and vpp related (hc2vpp) parts was done during 1.17.01 release. ### Overview #### 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) ## Project Contact Name and Email - hc2vpp list, - Michal Cmarada, - Marek Gradzki, - Maros Marsalek, LF-ID: mmarsale, - Ed Warnicke, LF-ID: hagbard ## Meeting [Honeycomb&hc2vpp meeting](view/Honeycomb/Meeting.md) ## Scope Hc2vpp's main responsibility is to enable communication between it's northbound interfaces and VPP's management APIs, performing all necessary translations in the background. This section is divided 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 hc2vpp relies on other projects). **Hc2vpp project scope: ** - Yang models for VPP management - Configuration data - Operational data - Translation layer between VPP management and Yang based data structures - Must support all features of VPP exposed in its APIs in an extensible manner **Out of scope: ** - Northbound interfaces: - generic NETCONF/RESTCONF/BGP support is part of honeycomb project - 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 - 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 ## Supported Features - [List of Features](view/Hc2vpp/Features.md) ## Releases ### 19.01 - last stable **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_19.01.md)**: - Work planned for release - Milestones leading to the release [**Site**](https://docs.fd.io/hc2vpp/1.19.01/hc2vpp-parent/hc2vpp-aggregator/index.html): - Devel documentation - Overview - Details - Javadocs - ... for each module in Hc2vpp project [**Release notes**](https://docs.fd.io/hc2vpp/1.19.01/hc2vpp-parent/release-notes-aggregator/release_notes.html): - New/Updated/Removed/Deprecated Features - Install guide - Devel guide - User guide ### 19.04 - current master **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_19.04.md)**: - Work planned for release - Milestones leading to the release [**Site**](https://docs.fd.io/hc2vpp/1.19.04-SNAPSHOT/hc2vpp-parent/hc2vpp-aggregator/index.html): - Devel documentation - Overview - Details - Javadocs - ... for each module in Hc2vpp project [**Release notes**](https://docs.fd.io/hc2vpp/1.19.04-SNAPSHOT/hc2vpp-parent/release-notes-aggregator/release_notes.html): - New/Updated/Removed/Deprecated Features - Install guide - Devel guide - User guide ### Previous releases #### 18.10 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_18.10.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.18.10/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.18.10/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 18.07 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_18.07.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.18.07/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.18.07/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 18.04 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_18.04.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.18.04/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.18.04/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 18.01 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_18.01.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.18.01/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.18.01/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 17.10 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_17.10.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.17.10/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.17.10/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 17.07 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_17.07.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.17.07/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.17.07/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 17.04 - **[Release plan](view/Hc2vpp/Release_Plans/Release_Plan_17.04.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.17.04/hc2vpp-parent/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.17.04/hc2vpp-parent/hc2vpp-aggregator/index.html) #### 17.01 - **[Release plan](view/Honeycomb/Release_Plans/Release_Plan_17.01.md)** - [**Release notes**](https://docs.fd.io/hc2vpp/1.17.01/release-notes-aggregator/release_notes.html) - [**Documentation**](https://docs.fd.io/hc2vpp/1.17.01/hc2vpp-aggregator/index.html) ## Honeycomb backlog Backlog can be found in: [Hc2vpp's JIRA](https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10701). ## Code quality Current sonar analysis can be found at: [Hc2vpp's sonar](https://sonar.fd.io/overview?id=2320) ## Devel [HowTo: Cutting stable branches & version bumping](view/Hc2vpp/BranchCutting.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)