Template:Project Facts

From fd.io

Revision as of 03:48, 9 November 2018 by Henry Ni (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Jump to: navigation, search

Sweetcomb Facts
Project Lead: Hongjun Ni, @ Intel Committers: Drenfong Wang, @ Intel, Chuanguo Wang, @ HuachenTel, Hui Chen, @ HuachenTel, Zhuoqun Li, @ China Mobile, Hongfeng Li, @ China Unicom, Jinglong Zhi, @ China Telecom, Changlin Li, @ NXP, Tianyi Wang, @ Tieto, Feng Gao, @ Tencent, Jianyong Chen, @ Alibaba, Jian Gu, @ ZTE, Jerome Tollet, @ Cisco, Maciek Konstantynowicz, @ Cisco, Rastislav Szabo, @ Cisco, Hongjun Ni, @ Intel, Repository: git clone https://gerrit.fd.io/r/Sweetcomb Mailing List: Sweetcomb-dev@lists.fd.io Jenkins: jenkins silo Gerrit Patches: code patches/reviews Bugs: Sweetcomb bugs

1 Intro
- 1.1 Overview
2 Project Contact Name and Email
3 Meeting
4 Scope
5 Releases
6 Sweetcomb backlog
7 Code quality
8 Devel
- 8.1 Design and architecture

Intro

Sweetcomb is a generic NETCONF/RESTCONF java-based management agent and provides a framework for building specialized agents.

It uses many features and utilities from different Opendaylight (ODL) projects (e.g. yangtools, controller, mdsal and netconf). The biggest use case of Sweetcomb is VPP (fd.io’s Vector packet processor). Sweetcomb delivers a management agent to enable integration of VPP with e.g. SDN controllers such as Opendaylight.

For VPP specific distribution of Sweetcomb, please refer to hc2vpp project.

Overview

Sweetcomb in VPP stack

Slides

Sweetcomb overview presentation from Paris FD.io 2016 event:

File:Sweetcomb overview.pptx

Sweetcomb overview prepared for Paris FD.io 2016 event

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

Generic nature

Sweetcomb provides a distribution to control VPP. However HC is developed as a generic agent that can be positioned on top of any other software/system etc. that can be controlled from Java(or some other JVM language) code. This is achieved thanks to the modularity of HC enabling any "translation plugin" such as V3PO (VPP core management translation code) to work in HC framework.

Minimal distribution

Sweetcomb provides a minimal distribution that contains only:

HC framework jars + plugin jars + dependencies from Opendaylight
HC framework config files + plugin config files
Runnable shell scripts

Project Contact Name and Email

Hongjun Ni, @ Intel,
Xingfu Li, @ HuachenTel,
Zhuoqun Li, @ China Mobile,
Hongfeng Li, @ China Unicom,
Jinglong Zhi, @ China Telecom,
Changlin Li, @ NXP,
Tianyi Wang, @ Tieto,
Feng Gao, @ Tencent,
Jianyong Chen, @ Alibaba,
Jian Gu, @ ZTE,
Jerome Tollet, @ Cisco,
Maciek Konstantynowicz, @ Cisco,
Rastislav Szabo, @ Cisco,

Meeting

Sweetcomb meeting

Scope

This section is devided into 2 sections: in-scope and out-of-scope to clearly define what is developed as part of Sweetcomb project and what will be just reused from other projects (or where Sweetcomb relies on other projects).

Sweetcomb project scope:

Northbound interfaces:
- Netconf northbound interface
- Restconf northbound interface
- BGP

Translation layer between device management and Yang based data structures

Sweetcomb distribution
- Minimal distribution for Sweetcomb management agent with all dependencies from ODL and their wiring

Out of scope:

Yang models and translation code for VPP management
- Moved to hc2vpp in 17.01

Vpp-japi
- Java APIs for VPP, allowing JVM to interact with VPP is out of scope of Sweetcomb 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 Sweetcomb project and are part of CSIT project

Any other application based on top of Sweetcomb is out of scope of this project and needs to be hosted in a dedicated project inside or outside of fd.io