Archived-Hc2vpp

hc2vpp Facts

Project Lead: Marek Gradzki Committers: Maros Marsalek Marek Gradzki Hongjun Ni Jan Srnicek Repository: git clone https://gerrit.fd.io/r/hc2vpp Mailing List: hc2vpp@lists.fd.io 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.

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

Honeycomb 1609 overview update from fd.io Seattle summit 2016: File:HC 1609 overview.pptx

Project Contact Name and Email

• hc2vpp list,
• Maros Marsalek, LF-ID: mmarsale,
• Marek Gradzki, LF-ID: mmarsale,
• Ed Warnicke, LF-ID: hagbard

Meeting

Honeycomb&hc2vpp meeting

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 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

Releases

18.07 - current master

Release plan:

• Work planned for release
• Milestones leading to the release

Site:

• Devel documentation
• Overview
• Details
• Javadocs
• ... for each module in Hc2vpp project

Release notes:

• New/Updated/Removed/Deprecated Features
• Install guide
• Devel guide
• User guide

18.04 - last stable

Release plan:

• Work planned for release
• Milestones leading to the release

Site:

• Devel documentation
• Overview
• Details
• Javadocs
• ... for each module in Hc2vpp project

Release notes:

• New/Updated/Removed/Deprecated Features
• Install guide
• Devel guide
• User guide

Previous releases

18.01

• Release plan
• Release notes
• Documentation

17.10

• Release plan
• Release notes
• Documentation

17.07

• Release plan
• Release notes
• Documentation

17.04

• Release plan
• Release notes
• Documentation

17.01

• Release plan
• Release notes
• Documentation

Honeycomb backlog

Backlog can be found in: Hc2vpp's JIRA.

Code quality

Current sonar analysis can be found at: Hc2vpp's sonar

Devel

HowTo: Cutting stable branches & version bumping

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

Honeycomb Translation layer/SPI

Honeycomb persistence/Reconciliation with VPP

Modifying the VPP JVPP API and testing in Honeycomb

IETF_ACL model implementation