Difference between revisions of "Archived-Honeycomb"

From fd.io
Jump to: navigation, search
(Demos)
(Weekly meeting)
Line 34: Line 34:
 
== Weekly meeting ==
 
== Weekly meeting ==
  
Weekly [https://wiki.fd.io/view/Honeycomb/Meeting call]
+
[https://wiki.fd.io/view/Honeycomb/Meeting Weekly call]
  
 
== Scope ==
 
== Scope ==

Revision as of 15:12, 27 June 2016

Honeycomb Facts

Project Lead: Maros Marsalek
Committers:

  • Dave Wallace
  • Maros Marsalek
  • Marek Gradzki
  • Stefan Kobza
  • Matej Spanik
  • Ed Warnicke
  • Daniel Malachovsky
  • Varun Seereeram
  • Robert Varga

Repository: git clone https://gerrit.fd.io/r/honeycomb
Mailing List: honeycomb-dev@lists.fd.io
Jenkins: jenkins silo
Gerrit Patches: code patches/reviews
Bugs: HONEYCOMB bugs

Intro

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.

Overview

Honeycomb in VPP stack

Honeycomb overview presentation from Paris FD.io 2016 event: File:Honeycomb overview.pptx

Project Contact Name and Email

Weekly meeting

Weekly call

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

Honeycomb backlog/plan

The plans for honeycomb are still being developed, however the backlog with a few items already in progress can be found in: Honeycomb's JIRA.

Supported features/models

Devel

Start Here

Setting Up Your Dev Environment

Running Honeycomb

Design and architecture

Honeycomb architecture and design guide

JVpp Java facade for VPP

Honeycomb Translation layer/SPI

Honeycomb persistence/Reconciliation with VPP

Modifying the VPP JVPP API and testing in Honeycomb

Virtual Bridge Domain (VBD) API and Documentation

Demos

Honeycomb bridge domain demo

Honeycomb Bridge Domain Demo

Binary Packages

Install honeycomb from binary packages