Difference between revisions of "Archived-Sweetcomb"
From fd.io
| Line 1: | Line 1: | ||
{{Project Facts | {{Project Facts | ||
| − | |name= | + | |name=Sweetcomb |
| − | |shortname= | + | |shortname=sweetcomb |
| − | |jiraName= | + | |jiraName=sweetcomb |
| − | |projectLead= | + | |projectLead=[mailto:hongjun.ni@intel.com Hongjun Ni], @ Intel |
|committers= | |committers= | ||
| − | * | + | * [mailto:drenfong.wang@intel.com Drenfong Wang], @ Intel, |
| − | * | + | * [mailto:wangchuanguo@huachentel.com Chuanguo Wang], @ HuachenTel, |
| − | * | + | * [mailto:chenhui@huachentel.com Hui Chen], @ HuachenTel, |
| − | * | + | * [mailto:lizhuoqun@cmhi.chinamobile.com Zhuoqun Li], @ China Mobile, |
| − | * | + | * [mailto:lihf140@chinaunicom.cn Hongfeng Li], @ China Unicom, |
| − | * | + | * [mailto:zhijl.bri@chinatelecom.cn Jinglong Zhi], @ China Telecom, |
| + | * [mailto:changlin.li@nxp.com Changlin Li], @ NXP, | ||
| + | * [mailto:tianyi.wang@tieto.com Tianyi Wang], @ Tieto, | ||
| + | * [mailto:davidfgao@tencent.com Feng Gao], @ Tencent, | ||
| + | * [mailto:jingqing.cjy@alibaba-inc.com Jianyong Chen], @ Alibaba, | ||
| + | * [mailto:gu.jian1@zte.com.cn Jian Gu], @ ZTE, | ||
| + | * [mailto:jtollet@cisco.com Jerome Tollet], @ Cisco, | ||
| + | * [mailto:mkonstan@cisco.com Maciek Konstantynowicz], @ Cisco, | ||
| + | * [mailto:raszabo@cisco.com Rastislav Szabo], @ Cisco, | ||
| + | * [mailto:hongjun.ni@intel.com Hongjun Ni], @ Intel, | ||
}} | }} | ||
== Intro == | == Intro == | ||
| − | + | Sweetcomb is a management agent that runs on the same host as a VPP instance, and exposes yang models via NETCONF or RESTCONFto allow the management of that VPP instance from out-of-box. And users also can manage VPP through SSL and JSON. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== Overview === | === Overview === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==== Generic nature ==== | ==== 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 ==== | ==== Minimal distribution ==== | ||
| − | + | Sweetcomb provides a minimal distribution that contains only: | |
* HC framework jars + plugin jars + dependencies from Opendaylight | * HC framework jars + plugin jars + dependencies from Opendaylight | ||
* HC framework config files + plugin config files | * HC framework config files + plugin config files | ||
| Line 43: | Line 40: | ||
== Project Contact Name and Email == | == Project Contact Name and Email == | ||
| − | * [mailto: | + | * [mailto:hongjun.ni@intel.com Hongjun Ni], @ Intel, |
| − | * [mailto: | + | * [mailto:lixingfu@huachentel.com Xingfu Li], @ HuachenTel, |
| − | * [mailto: | + | * [mailto:lizhuoqun@cmhi.chinamobile.com Zhuoqun Li], @ China Mobile, |
| − | * [mailto: | + | * [mailto:lihf140@chinaunicom.cn Hongfeng Li], @ China Unicom, |
| − | * [mailto: | + | * [mailto:zhijl.bri@chinatelecom.cn Jinglong Zhi], @ China Telecom, |
| + | * [mailto:changlin.li@nxp.com Changlin Li], @ NXP, | ||
| + | * [mailto:tianyi.wang@tieto.com Tianyi Wang], @ Tieto, | ||
| + | * [mailto:davidfgao@tencent.com Feng Gao], @ Tencent, | ||
| + | * [mailto:jingqing.cjy@alibaba-inc.com Jianyong Chen], @ Alibaba, | ||
| + | * [mailto:gu.jian1@zte.com.cn Jian Gu], @ ZTE, | ||
| + | * [mailto:jtollet@cisco.com Jerome Tollet], @ Cisco, | ||
| + | * [mailto:mkonstan@cisco.com Maciek Konstantynowicz], @ Cisco, | ||
| + | * [mailto:raszabo@cisco.com Rastislav Szabo], @ Cisco, | ||
== Meeting == | == Meeting == | ||
| − | [https://wiki.fd.io/view/ | + | [https://wiki.fd.io/view/Sweetcomb/Meeting Sweetcomb meeting] |
== Scope == | == Scope == | ||
| − | This section is devided into 2 sections: in-scope and out-of-scope to clearly define what is developed as part of | + | 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: | * Northbound interfaces: | ||
** [http://tools.ietf.org/html/rfc4741, Netconf] northbound interface | ** [http://tools.ietf.org/html/rfc4741, Netconf] northbound interface | ||
| Line 65: | Line 70: | ||
* Translation layer between device management and Yang based data structures | * Translation layer between device management and Yang based data structures | ||
| − | * | + | * Sweetcomb distribution |
| − | ** Minimal distribution for | + | ** Minimal distribution for Sweetcomb management agent with all dependencies from ODL and their wiring |
'''Out of scope:''' | '''Out of scope:''' | ||
| Line 73: | Line 78: | ||
* Vpp-japi | * Vpp-japi | ||
| − | ** Java APIs for VPP, allowing JVM to interact with VPP is out of scope of | + | ** 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 | * Yang parser | ||
| Line 85: | Line 90: | ||
* Integration/performance testing | * Integration/performance testing | ||
| − | ** Complex integration or performance tests are out of scope of | + | ** 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 | + | * 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 |
== Releases == | == Releases == | ||
| Line 93: | Line 98: | ||
=== 18.07 - Last stable === | === 18.07 - Last stable === | ||
| − | '''[[ | + | '''[[Sweetcomb/Release_Plans/Release_Plan_18.07| Release plan]]''': |
* Work planned for release | * Work planned for release | ||
* Milestones leading to the release | * Milestones leading to the release | ||
| − | [https://docs.fd.io/ | + | [https://docs.fd.io/Sweetcomb/1.18.07/Sweetcomb-aggregator/index.html '''Documentation''']: |
* Devel documentation | * Devel documentation | ||
* Overview | * Overview | ||
* Details | * Details | ||
* Javadocs | * Javadocs | ||
| − | * ... for each module in | + | * ... for each module in Sweetcomb project |
| − | [https://docs.fd.io/ | + | [https://docs.fd.io/Sweetcomb/1.18.07/release-notes-aggregator/release_notes.html '''Release notes''']: |
* New/Updated/Removed/Deprecated Features | * New/Updated/Removed/Deprecated Features | ||
* Install guide | * Install guide | ||
| Line 112: | Line 117: | ||
=== 18.10 - Current master === | === 18.10 - Current master === | ||
| − | '''[[ | + | '''[[Sweetcomb/Release_Plans/Release_Plan_18.10| Release plan]]''': |
* Work planned for release | * Work planned for release | ||
* Milestones leading to the release | * Milestones leading to the release | ||
| − | [https://docs.fd.io/ | + | [https://docs.fd.io/Sweetcomb/1.18.10-SNAPSHOT/Sweetcomb-aggregator/index.html '''Documentation''']: |
* Devel documentation | * Devel documentation | ||
* Overview | * Overview | ||
* Details | * Details | ||
* Javadocs | * Javadocs | ||
| − | * ... for each module in | + | * ... for each module in Sweetcomb project |
| − | [https://docs.fd.io/ | + | [https://docs.fd.io/Sweetcomb/1.18.10-SNAPSHOT/release-notes-aggregator/release_notes.html '''Release notes''']: |
* New/Updated/Removed/Deprecated Features | * New/Updated/Removed/Deprecated Features | ||
* Install guide | * Install guide | ||
| Line 130: | Line 135: | ||
=== Previous releases === | === Previous releases === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | |
| − | Backlog can be found in: [https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10200 | + | == Sweetcomb backlog == |
| + | Backlog can be found in: [https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10200 Sweetcomb's JIRA]. | ||
== Code quality == | == Code quality == | ||
| − | Current sonar analysis can be found at: [https://sonar.fd.io/overview?id=1107 | + | Current sonar analysis can be found at: [https://sonar.fd.io/overview?id=1107 Sweetcomb's sonar] |
== Devel == | == Devel == | ||
| − | [[ | + | [[Sweetcomb/BranchCutting|HowTo: Cutting stable branches]] |
| − | [[ | + | [[Sweetcomb/BumpingVersions|HowTo: Bumping versions]] |
=== Design and architecture === | === Design and architecture === | ||
<span style="color:red">// TODO These all should be part of the code in e.g. adoc format, built during CI, deployed and just linked here</span> | <span style="color:red">// TODO These all should be part of the code in e.g. adoc format, built during CI, deployed and just linked here</span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 05:39, 9 November 2018
| Sweetcomb Facts |
|
Project Lead: Hongjun Ni, @ Intel
Repository: git clone https://gerrit.fd.io/r/sweetcomb |
Contents
Intro
Sweetcomb is a management agent that runs on the same host as a VPP instance, and exposes yang models via NETCONF or RESTCONFto allow the management of that VPP instance from out-of-box. And users also can manage VPP through SSL and JSON.
Overview
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
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:
- 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)
- 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
Releases
18.07 - Last stable
- Work planned for release
- Milestones leading to the release
- Devel documentation
- Overview
- Details
- Javadocs
- ... for each module in Sweetcomb project
- New/Updated/Removed/Deprecated Features
- Install guide
- Devel guide
- User guide
18.10 - Current master
- Work planned for release
- Milestones leading to the release
- Devel documentation
- Overview
- Details
- Javadocs
- ... for each module in Sweetcomb project
- New/Updated/Removed/Deprecated Features
- Install guide
- Devel guide
- User guide
Previous releases
Sweetcomb backlog
Backlog can be found in: Sweetcomb's JIRA.
Code quality
Current sonar analysis can be found at: Sweetcomb's sonar
Devel
HowTo: Cutting stable branches
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
