Project Proposals/Honeycomb

Name

Honeycomb

Project Contact Name and Email

• Ed Warnicke, LF-ID: hagbard,
• Dave Wallace, LF-ID: dwallacelf,
• Matej Spanik, LF-ID: mspanik,
• Maros Marsalek, LF-ID: mmarsale.

Repository Name

honeycomb

Description

Honeycomb is an 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.

Scope

Honeycomb's main responsibility is to enable communication between it's northbound interfaces and VPP's management APIs, performing all necessary translations in the background. It is important to note that many features and utilities will be reused from different Opendaylight (ODL) projects (e.g. yangtools, controller, mdsal and netconf) and will not be a direct part of Honeycomb. 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 northbound interface
  • Restconf northbound interface
  • (Possibly) BGP

• 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

• Honeycomb distribution
  • Minimal distribution for Honeycomb management agent with all dependencies from ODL and their wiring

Out of scope:

• 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

• Base implementation of northbound interfaces
  • Base implementation of generic northbound interfaces is out of scope and will be reused from ODL's netconf project

• Yang based data structures and a dedicated DataTree(storage)
  • Available from ODL's yangtools and 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

Initial Committers

• Dave Wallace, LF-ID: dwallacelf,
• Maros Marsalek, LF-ID: mmarsale,
• Marek Gradzki, LF-ID: mgradzki,
• Stefan Kobza, LF-ID: skobza,
• Matej Spanik, LF-ID: mspanik,
• Ed Warnicke, LF-ID: hagbard,
• Daniel Malachovsky, LF-ID: dmalacho,
• Varun Seereeram, LF-ID: vseereer,
• Robert Varga, LF-ID: rovarga.

Vendor Neutral

No current or expected issues with vendor neutrality.

Meets Board Policy (including IPR, being within Board defined Scope etc)

Meets board policy as expressed in Technical Community Charter and IP Policy.