Difference between revisions of "Archived-Honeycomb"

From fd.io
Jump to: navigation, search
Line 15: Line 15:
 
}}
 
}}
 
== Intro ==
 
== 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.
 
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.
 
Currently, Honeycomb supports Bridge Domain models.
 
Currently, Honeycomb supports Bridge Domain models.
  
== Start Here ==
+
== Project Contact Name and Email ==
 +
* [mailto:honeycomb-dev@lists.fd.io honeycomb-dev list],
 +
* [mailto:mmarsale@cisco.com Maros Marsalek], LF-ID: mmarsale,
 +
* [mailto:mgradzki@cisco.com Marek Gradzki], LF-ID: mmarsale,
 +
* [mailto:hagbard@gmail.com Ed Warnicke], LF-ID: hagbard,
 +
* [mailto:dwallacelf@gmail.com Dave Wallace], LF-ID: dwallacelf,
 +
* [mailto:mspanik@cisco.com Matej Spanik], LF-ID: mspanik,
 +
 
 +
== Weekly meeting ==
 +
// TODO
 +
 
 +
== 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 [http://www.opendaylight.org/, 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:
 +
** [http://tools.ietf.org/html/rfc4741, Netconf] northbound interface
 +
** [https://tools.ietf.org/html/draft-ietf-netconf-restconf-05, Restconf] northbound interface
 +
** (Possibly) [https://www.ietf.org/rfc/rfc4271, 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 [https://git.opendaylight.org/gerrit/#/admin/projects/yangtools, yangtools] project
 +
 
 +
* Base implementation of northbound interfaces
 +
** Base implementation of generic northbound interfaces is out of scope and will be reused from ODL's [https://git.opendaylight.org/gerrit/#/admin/projects/netconf, netconf] project
 +
 
 +
* Yang based data structures and a dedicated DataTree(storage)
 +
** Available from ODL's [https://git.opendaylight.org/gerrit/#/admin/projects/yangtools, yangtools] and [https://git.opendaylight.org/gerrit/#/admin/projects/mdsal, 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: [https://jira.fd.io/projects/HONEYCOMB/issues Honeycomb's JIRA].
 +
 
 +
== Devel ==
 +
 
 +
=== Start Here ===
  
 
[[honeycomb/Setting_Up_Your_Dev_Environment|Setting Up Your Dev Environment]]
 
[[honeycomb/Setting_Up_Your_Dev_Environment|Setting Up Your Dev Environment]]
Line 25: Line 77:
 
== Demos ==
 
== Demos ==
  
 +
=== Honeycomb bridge domain demo ===
 
[https://www.youtube.com/watch?v=vs1XzOOpaCo&feature=youtu.be Honeycomb Bridge Domain Demo]
 
[https://www.youtube.com/watch?v=vs1XzOOpaCo&feature=youtu.be Honeycomb Bridge Domain Demo]

Revision as of 08:04, 12 April 2016

Honeycomb Facts

Project Lead: {{{projectLead}}}
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. Currently, Honeycomb supports Bridge Domain models.

Project Contact Name and Email

Weekly meeting

// TODO

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.

Devel

Start Here

Setting Up Your Dev Environment

Demos

Honeycomb bridge domain demo

Honeycomb Bridge Domain Demo