Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
Goal
- Dynamic Configuration of Devices
- Enable a network operator to seamlessly bring up/down and configure devices from different vendors and to verify the configuration with minimal or no human intervention.
- Dynamic Configuration/Provisioning of Services
- Enable a network operator to seamlessly configure and provision a service on the network comprising many devices from many vendors with minimal or no human intervention
How to get involved
Help needed
- 1-2 developer for configuration Store, who is/are required to work with ONOS distributed core team to implement Store Mechanism, Application API, and advanced store features etc. Location can be local or remote.
- 1-2 QA engineer, whose responsibility will be setup related testing environment in ON.LAB, design stress and regression testing plan and testing cases, write automation script, work with developer on any issues by stress and regression test. Local resources are preferred.
- Invite 3 (at least) vendors to join the brigade. These vendors will provide one or two L3 devices with NETCONF and device model ready. Engineers are required to work with Brigade team to integrate their devices into the demo environment. They are required to know their device model and is able to help brigade team to debug any issue seen during the integration.
Contact the brigade:
- Join the mailing list at: brigade-dynconfig@onosproject.org
Story
- Dynamic Configuration Story slide is a reference to our vision and view how this dynamic configuration system works. It basically covers both device configuration and service provisioning.
- Story document:
Documents
- Dynamic Configuration Design Requirement
- Brigade DynConfig for ONOS Build.pdf
- Dynamic Configuration Design Document
Roadmap
Phase 1: Target ONS 2017 (April, 2017) - Demo 1, Demo 2
- ONOS Release “I” (now)
- APIs definitions for YangCompiler, YangRuntime, and DynamicConfigStore
- ONOS Release “J”
- Refactoring & code restructuring: YangCompiler, YMS -> YangRuntime,
- Implementation of DynamicConfigService & Store
- Implementation of RESTCONF & NETCONF Apps
- Sharding of subtrees will be opportunistic
Phase 2
– Demo 3 (Multi Vendor Device)
– ONOS Release "K" & “L”
- Sharding of subtrees
- Transactional updates
- Performance optimizations
- Driver model based on Behaviors
- Explore Common Driver Architecture (Add a new device without code release -
)
Requirements to Dynamic Configuration Brigade
Here is a requirement holder, which includes the features, bug fixing, etc.
| Requirements Description | Suggested Priority | contact (email) | comments and feedback |
|---|---|---|---|
| YANG Store Service notification API should support multiple operations on different node and subtree | high | ||
| Augment is required by L3VPN. the changes in yang tools in reflect to the recent architecture refactoring should support this. | high | patrick.liu@huawei.com | |
Weekly Meeting and Brigade Event
From 8am to 9/10 am (PST) on each Thursday morning.
----------------------------------------------
Dynamic Configuration Brigade
Please join my meeting from your computer, tablet or smartphone.
https://global.gotomeeting.com/join/193053677
You can also dial in using your phone.
United States (Toll Free): 1 866 899 4679
United States: +1 (312) 757-3117
Access Code: 193-053-677
More phone numbers
Austria: +43 7 2081 5337
Canada: +1 (647) 497-9373
China (Toll Free): 4008 866143
France: +33 170 950 590
Germany: +49 692 5736 7300
Italy: +39 0 230 57 81 80
Netherlands: +31 207 941 375
Spain: +34 932 75 1230
Switzerland: +41 225 4599 60
United Kingdom: +44 20 3713 5011
Joining from a video-conferencing room or system?
Dial: 67.217.95.2##193053677
Cisco devices: 193053677@67.217.95.2
----------------------------------------------
See ONOS event calendar for bridge details
| Date | Meeting and Event | Meeting highlights | Action Item |
|---|---|---|---|
| 11/30/2017 | Dynamic Configuration Brigade Weekly Meeting | Upcoming demonstration preparation
Magpie Sprint #4 Items and progresses
| |
| 09/14/2017 | Dynamic Configuration Brigade Weekly Meeting | Magpie Sprint #1 Items and progresses In Progress:
To-do:
Done:
- Fixed and merged in sprint3
- tested and merged.
- Was able to reproduce; fixed and merged in sprint3
- now merged | |
| 08/24/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #3 Items and progresses ONOS-6381 Event consolidation - in progress, under review ONOS-6494 Dyn-config List Child need to be ordered together - Fixed and merged in sprint3 ONOS-6861 Restconf Filter by nodes - depends on 6494. Will continue to be developed in the next release. ONOS-XYZW RESTCONF Device proxy support
ONOS-6878 Revisit DynConfig Event notification
ONOS-6884 Device tree restructuring
ONOS-6881 yangtools "uses" augmentation - tested and merged. ONOS-6694 OpenConfig integration issue
ONOS-6673 YANG Runtime: GET API's for YANG Models - low priority, there can be workaround for it. Take a look after OpenConfig work ONOS-6906 bug around update, no event issue - Was able to reproduce; fixed and merged in sprint3 RESTCONF Timestamp support
ONOS-XYZW Live Compilation in place CLI, REST - now merged | |
| 08/10/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #3 Items and progresses ONOS-6381 Event consolidation - in progress, under review ONOS-6494 Dyn-config List Child need to be ordered together - Fixed and merged in sprint3 ONOS-6861 Restconf Filter by nodes - depends on 6494 ONOS-XYZW RESTCONF Device proxy support
ONOS-6878 Revisit DynConfig Event notification
ONOS-6884 Device tree restructuring
ONOS-6881 yangtools "uses" augmentation - under review on gerrit ONOS-6694 OpenConfig integration issue
ONOS-6673 YANG Runtime: GET API's for YANG Models - low priority, there can be workaround for it. Take a look after OpenConfig work ONOS-6906 bug around update, no event issue - Was able to reproduce; fixed and merged in sprint3 RESTCONF Timestamp support
ONOS-XYZW Live Compilation in place CLI, REST - now merged Would be nice to have small YANG for Unit test purpose
| |
| 08/03/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #3 Items and progresses ONOS-6494 Dyn-config List Child need to be ordered together ONOS-6861 Restconf Filter ONOS-XYZW RESTCONF Device proxy support
ONOS-6878 Revisit DynConfig Event notification
ONOS-XYZW Device tree restructuring
ONOS-6881 yangtools "uses" augmentation ONOS-6694 OpenConfig integration issue
ONOS-6673 YANG Runtime: GET API's for YANG Models | |
| 07/27/2017 | Loon Sprint #3 Items and progresses [ONOS-6645] RPC abstractions and generated code clean up and optimize - yang tools side (merged, sprint 2) [ONOS-6385 RPC dispatcher implementation] (merged) [ONOS-6861] Transaction event listener
[ONOS 6861] RestConf Filter
[ONOS 6494] Dynamic Config: Changes to preserve ordering of children in the store
[ONOS 6745] Device synchronizer
[ONOS 6760] RestConf RPC
[ONOS 6761] RestConf PATCH support
[ONOS 6763] OpenConfig model compilation and integration
YANG tools and YANG runtime
YANG live compiler
| ||
| 07/20/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #2 Items and progresses [ONOS-6787] Rpc abstractions and clean up -Dynamic config side
[ONOS-6645] RPC abstractions and generated code clean up and optimize - yang tools side
[ONOS 6494] Dynamic Config: Changes to preserve ordering of children in the store
[ONOS 6745] Device synchronizer
[ONOS 6760] RestConf RPC
[ONOS 6761] RestConf PATCH support
[ONOS 6763] OpenConfig model compilation and integration
YANG tools and YANG runtime
YANG live compiler
| |
| 07/13/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #2 Items and progresses [ONOS-6645] RPC abstractions and generated code clean up and optimize
[ONOS 6494] Dynamic Config: Changes to preserve ordering of children in the store
[ONOS 6745] Device synchronizer
[ONOS 6760] RestConf RPC
[ONOS 6761] RestConf PATCH support
[ONOS 6763] OpenConfig model compilation and integration
YANG tools and YANG runtime
YANG live compiler
| |
| 07/06/2017 | Dynamic Configuration Brigade Weekly Meeting | Loon Sprint #2 Items and progresses [ONOS-6645] RPC abstractions and generated code clean up and optimize Patch is ready for review. Code compilation issue to be checked. Working on transactions and event consolidation. API of RPC registry is moved to YANG runtime, implementation still remains in Dynamic Config [ONOS 6494] Dynamic Config: Changes to preserve ordering of children in the store Not started yet. [ONOS 6745] Device synchronizer Description for device synchronizer document is done. Currently discussing about the designs in the mailing list. [ONOS 6760] RestConf RPC Integrating with Dynamic Config service API to be completed. Interface change to add resource id in Dyn Config API to be code reviewed and submitted along with Dyn Conf implementation; implementation in YANG runtime to be done. - suppress auto generated registration classes, comment out invocation code [ONOS 6761] RestConf PATCH support Not started yet. Fix to PUT operation (in compliance with RESTCONF standards) will be submitted. [ONOS 6763] OpenConfig model compilation and integration
YANG tools and YANG runtime YANG live compiler
| |
| 01/24//2017 | Review DataNode & Resourse Identifier usage | ||
| RPC brokerage and notification support by Dynamic config service(Sithara) | Code walk of the RPC brokerage Implementation of brokerage, correlation of responses to commands Different approaches to manage the concurrent executions at the executors were discussed Data change and YANG notifications handling at the store | Disaggregate RPC service and RPC context | |
| 12/20/2016 | Agenda YANG Schama validation for data | two options were proposed. is YANG runtime stateful? error handling during validation: giving back to application; tree might be traversed multiple time. not concluded yet. | update the design document about the options for schema validation (Gaurav) |
| 12/18/2016 | Agenda | ||
| 12/13/2016 | Agenda Gaurav on recent code changes in builder, model object, model converter and data node. Store APIs |
| YANG runtime API will be discussed in next meeting (Gaurav) Use case of merge operation during configuration (Vinod) Demo 1 requirement from SP (Thomas) Need close coder review on store APIs (Thomas) |
| 12/08/2016 | Agenda review DataNode definition (Gaurav) Review of Dynamic Config Service APIs (Sithara)
|
| |
| 12/5/2016 | Agenda
| ||
| 11/29/2016 | Agenda
|
| can Vinod help to make a summary about datanode discussion? |
| 11/22/2016 | Agenda
|
| Vinod will look into Path definition |
11/17/2016 weekly meeting | Agenda
| this meeting is rescheduled to 8-9am of 11/18/2016
| Patrick send out the link to the requirement holder. |
11/15/2016 Sprint Planning | Ibis Release Sprint# 3 planning | 11 Dynamic-config and 4 yang-tools JIRA tickets are planned key milestones:
| |
11/10/2016 weekly meeting | Agenda:
|
| Ibis Sprint #3 Planning |
11/3/2016 weekly meeting | Canceled because of ONOS Build Event | ||
11/2/2016 Team Meet together | Brigade team meet together at ONOS build in Paris
|
| |
10/27/2016 weekly meeting | Agenda:
| Review Design Requirement document | |
10/20/2016 weekly meeting | Introduction to current YMS, ElasticConfig subsystem, etc. and also Common Driver Idea.
| Need a system level model transform diagram to show NB model to SB model transform |
Brigade Leader:
- Patrick Liu
Brigade Members:
- Gigamon : Venkata Narayana Tata;
- Fujitsu: Aarun, Satoshi
- Huawei: Gaurav, Henry, Patrick, Sithara, Vinod, Jin
- ON.LAB: Brian, Ray, Thomas
- Verizon: Viswanath KSP, Jay Simha, Venkat Sravan, Vipul Malgotra
========= Announcement Please: the information below are under construction in reflect to the latest view, design and requirements.
Demo (under construction)
- Use ONOS YANG Utils to translate IETF L3SM L3VPN model to JAVA application framework
- Enable and disable L3VPN service on ONOS controller through dynamic configuration
- Add a new device through modifying ONOS driver configuration (.xml) file.
- Configuration data persistency. the initial consideration is through a 3 node ONOS cluster. more node clustering setup will be considered upon request.
- Demo topology is still under construction.
Scope (Under Construction)
Build a model driven architecture in ONOS to dynamically install/update/remove the configuration for NETCONF enabled devices. In the first release, we will use L3VPN as a use case and build related applications on top of this architecture to demonstrate how this architecture works. This project will be based on and integrate the results from existing projects (e.g. YANG Utils, YMS, etc) and create new several components when necessary. In the demo, we plan to use multi-vendor devices as network element in our demo setup. to be specific, five components are involved
1. YANG Utils. This tools is used to translate YANG defined service/network model and device model into JAVA code. After Releases "G" and Release "H" hard working, current YANG Utils can meet this brigade requirement and no new features are required for this brigade.
2. We need build L3VPN application and provide configuration interface to allow user enable/disable and configure L3VPN service on each device dynamically. This is a brand new application, which will be based on IETF L3SM L3VPN model. Please see L3VPN project proposal page for the implementation details
3. In order to make ONOS internal application development easier, we will use YMS to manage ONOS YANG-based services. The minimum requirement by this brigade is brokerage service, RESTConf, XML/JSON codec, etc. This part is pretty much L3VPN related, see L3VPN project proposal wiki for the dependency and development plan. For external application, it could request ONOS resource and topology service. We don't require YMS to provide the API for ONOS core services in our short team plan. This is required by our long term plan.
4. Distributed Configuration Store. This is expected to provide a powerful distrusted data store primitive DocTree to application to store their configuration. It provides two consistency models- eventual and strong consistency model. The operation rate targets to support 10-12K operations per second. We hope this will meet most of the application's configuration requirement. Store operation for APIs include get/put/update/delete. APIs are under construction. For more details of this store and the service to access this store, please refer to Dynamic Configuration Subsystem.
5. Device Driver. This is a new component. The target is to build a service and device independent driver. When a new device( from same vendor or different vendor) is added, it is not required,we hope, to build a new driver any more. In our current on-going design, this is achieved through modifying ONOS driver configuration file (in .xml format) by the results of comparing a "standard" device model with vendor's device model. Based on the comparison results, we category this into three group: SAME, RULE, and TRANSFORM. Driver will handle them differently.
1) SAME: both models are same (namespace can be different). In this case, we only need modify driver configuration file (.xml).
2) RULE: Vendor's device model can be translated into standard model by policy. For example, some construct missed, device mode is subset of standard model, etc. In this case, we only need modify ONOS driver configuration file (.xml)
3) TRANSFORMER: Vendor's device model cannot be translated or mapped to "standard" model through policy. Because the "Standard" device model is from IETF or a standard organization, we hope this case is not common. In this case, a new transformer code is required to translate the standard model to this special device model.
Short-term focus in 2016
Use IETF L3SW model in building both network layer application and network element layer application
Use 3-5 devices from different Vendors as network elements in the Demo setup
New components to be built
L3VPN Application. This is an external application (off-platform) that handle network model.
Ne L3VPN App. This is an ONOS internal application that processes device model. Its north bound interface is defined by IETF.
Configuration Store. This is used to store configuration of device.
Driver Mechanism. This is an service and device agonistic mechanism
Long-term focus in 2017
- Performance Assessment and do the enhancement if necessary
- Transactional Operation on Configuration Store