blob: 9c661bd9f09d4693afbad80be3b0c5fc84b107a2 [file] [log] [blame]
Andrea Campanellaab5306b2022-06-30 20:48:20 +02001VOLTHA 2.10 Release Notes
2=========================
3
4Highlights
5----------
6
7VOLTHA-2.10 builds on the 2.9 release for VOLTHA. The release focused on including new features, improving scale and
8interacting with the Broadband Forum BBF. With VOLTHA 2.10 Fiber to the Building (FTTB) capabilities were introduced,
9scale was enhanced to 4096 subscribers per stack, rolling software upgrade capabilities were introduced and the ONU
10adapter was improved with extended message support and unknown ME handling. ONU delete and automatic re-discovery
11was implemented. Finally collaboration with BBF defined the yang models extension needed to support VOLTHA, that were
12started to get implemented in the BBF adapter for the VOLTHA northbound.
13Finally new tests were introduced for FTTB, memory leaks and the Telecom Italia (TIM) workflow.
14
15
16VOLTHA 2.10 first and foremost introduced the support for FTTB use case with the 1 tcont 4 gem technology profile.
17VOLTHA now has capability to install ANCP, DPU management and subscriber rules flow rules. These rules are created in
18ONOS and translated in vlan swapping at the OLT (outer vlan swap). The rules get installed after the MAC address is
19learnt for the DPU device. These Rules configure the OMCI ONT within the DPU. Extensions have been made in ONOS and
20in the different adapters. Sadis has been extended with the subscriber and ANCP/Management traffic definitions and
21documentation.
22Extended work has been put in to increase scalability and in VOLTHA 2.10 a single stack can support up to
234096 subscribers, on one or two OLTs, while keeping the same 10 minute maximum provisioning time from when the OLT
24connects to VOLTHA. All the VOLTHA components have also been extended to ensure a smooth upgrade with no request
25downtime via the Kubernetes rolling upgrade functionality.
26The onu adapter now allows for ONU automatic re-discovery after deletion, unknown ME handling where we ignore
27unknown messages but still onboard the ONU. Extended message support has also been introduced allowing for
28faster ONU image installation and MIB initial download. Extended message support has been parameterized not to be
29enabled by default, it has also been tested only with BBSIM, according to according to ITU-T G.988 Amendment 3
30(03/2020, further hardware test will be done and required fixes will be applied, any report from the community
31is appreciated.
32
33The stack has been enhanced to provide a pathway for supporting COMBO PON OLTs with the introduction of a framework of
34dynamic detection of PON Transceiver Technology and then using that information to configure the MAC and PON modes.
35
36Alignment with the Broadband Forum progressed and a first agreement has been reached on the yang models that correctly
37map VOLTHA, both on the OLT and ONU side and the subscriber service abstraction. The BBF models have been extended and
38the proposals are ready for submission for official approval. In the meantime a BBF adapter has been written,
39exposing a netconf server on the NB which leverages the mentioned models and in turns call the VOLTHA/ONOS apis.
40
41Finally the release provided bug fixes across the stack, especially around Resource Cleanup and correct state assurance
42for devices and for the different containers. Also several panics and null pointer exceptions have been prevented,
43yielding a much more stable system.
44
45On the testing front VOLTHA 2.10 includes tests for the FTTB functionality, both on BBSIM and on a physical DPU in
46the Berlin POD. Also, TIM Workflow tests have been introduced in BBSIM, to avoid regression for that workflow,
47which includes the PPPoE application. New tests have been introduced to check for memory leaks during device deletion
48and re-creation both for the ONU adapter and the OLT adapter.
49Other new tests for the unknown MEs, ONU delete and re-discovery, rolling upgrade and extended OMCI message support.
50More tests have been extended, such as TT with unit-tag subscriber provisioning, mac learning, also the
51Device management Interface tests are now being run on hardware as well.
52
53Along with VOLTHA 2.10, the Device Management Brigade also released new major versions
54(up to `1.5.0 <https://github.com/opencord/device-management-interface/releases/tag/v1.5.0>`_) of the interface
55with COMBO PON support, NNI port speed runtime config, new events and states.
56
57
58Features & Improvements
59-----------------------
60
61- Fiber to the Building (FTTB) Support
62
63 - Support for DPU management and ancp traffic rules single tagged with VLAN swap
64 - Support for Subscriber traffic flows with outer VLAN swap
65 - Sadis integration with documentation
66 - Hardware integration with ADTRAN DPU
67 - 1 tcont 4 Gem technology profile
68
69- Scale enhancements
70
71 - 4096 subscribers on one OLT with 1 VOLTHA stack
72 - 4096 subscribers on two OLTs with 1 VOLTHA stack
73
74- Rolling software upgrade capabilities
75
76 - Kubernetes rolling upgrade of pods
77 - Requests always served with no pod downtime
78
79- Initial Combo PON support
80
81 - Framework for dynamic detection of PON Transceiver Technology
82
83- Extended Message Support in ONU Adapter
84
85 - Reduced number of messages for ONU Software Upgrade and MIB template download
86 - Higher speed of software image and MIB template download
87
88- Unknown MEs handling
89
90 - Relaxed decoding of unknown MEs
91 - Discarded unknown entities but proceed with ONU MIB download for that ONU.
92
93- ONU Delete and re-discovery
94
95- BBF Adapter Initial Implementation
96
97 - Northbound NETCONF server
98 - Southbound integration with VOLTHA protos, ONOS APIs
99 - Augmentation and use of existing BBF models
100 - Get OLT and ONU information via NETCONF and BBF models
101
Andrea Campanella01960222022-07-04 09:46:25 +0200102- Move to ONOS 2.5.8 with bug fixes
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200103
104Bug Fixes
105---------
106
107- Resource cleanup in ONOS, ETCD and final state machines, especially in case of device delete/restart and adapter(s)
108 restart
109- Avoid wrong state and missing notification for ONUs in several components and system states.
110- Avoid panic and runtime expectations in VOLTHA and ONOS Apis
111
112
113
114Test
115----
116
117Voltha-2.10 tests are available on `Jenkins <https://jenkins.opencord.org/>`_.
118
119- FTTB tests
120- Optimized ATT test for time reduction
121- Memory leak tests with 200 iterations of device deletion
122- Unknown ME tests
123- Extended OMCI message support for MIB Upload
124- ONU Delete and Rediscovery
125- Mac Learning in TT Sanity
126- Mib Audit
127- Device Management Interface tests on ADTRAN hardware
128- MDS mismatch
129- Voltha services Rolling upgrade
130- TIM workflow tests
131- Unknown attribute tests
132
133
134Design Discussions
135------------------
136
137- OLT Disconnect and Reconnect
138- ONOS replacement controller (lightweight VOLTHA controller)
139- ONF/BBF integration and models extension
140- COMBO PON support
141
142
143
144Documentation
145-------------
146
147- Contributing to VOLTHA
148- Certification program
149- release procedure and versioning guidelines
150- jenkins node setup for testing
151- Rollback scenarios
152
153As usual documentation is published on https://docs.voltha.org
154
155Known Issues
156------------
157
158- FTTB Upstream flow stays in pending add on openolt based devices. `[VOL-4742] <https://jira.opencord.org/browse/VOL-4742>`_
159- ATT Workflow fails EAPOL flow installation at scale `[VOL-4745] <https://jira.opencord.org/browse/VOL-4745>`_
160- Olt app removes flows based on the latest Sadis entry, if sadis changes flows cant be removed. `[VOL-4746] <https://jira.opencord.org/browse/VOL-4746>`_
161- Flows stuck in pending-add when subscriber is provisioned after open-olt-adapter pod restart `[VOL-4747] <https://jira.opencord.org/browse/VOL-4747>`_
162- Alpha ONUs on soak pod drop upstream ARP/ICMP packets `[VOL-4748] <https://jira.opencord.org/browse/VOL-4748>`_
163- Rolling update test failures `[VOL-4749] <https://jira.opencord.org/browse/VOL-4749>`_
164
165
166Certification Program
167---------------------
168
169Thanks to the `Continuous Certification <https://opennetworking.org/continuous-certification-program>`_ program at
170ONF we can also ensure that the following ONF member products are compatible with the VOLTHA 2.10 release:
171
172- Edgecore ASGVolt64 GPON OLT
173- Edgecore ASXVolt16 XGSGPON OLT
174- Radisys 3200G GPON OLT
175- Radisys 1600G GPON OLT
176- Radisys 1600X COMBO OLT
177- Adtran 6320X COMBO OLT
178- Zyxel SDA3016SS Combo OLT
179- Sercomm FG1000 GPON ONU
180- Sercomm Glasfaser GPON ONU
181- Edgecore 6712-32X Switch
182- Edgecore 7712-32X Switch
183
184In particular the 2.10 release added the Zyxel SDA3016SS COMBO OLT.
185
186Jira stories
187------------
188A full list of stories and bugs completed can be found under the
189`VOLTHA 2.10 <https://jira.opencord.org/secure/ReleaseNote.jspa?projectId=10106&version=12300>`_ release page in Jira.
190
191Component Versions in VOLTHA 2.10 release
192-----------------------------------------
193
194ONOS and Atomix:
195++++++++++++++++
196
197- `ONOS 2.5 LTS <https://github.com/opennetworkinglab/onos/releases/tag/2.5.8>`_: ``2.5.8``
198- `ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_: ``3.1.9``
199
200ONOS Apps:
201++++++++++
202
203- `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_: ``2.6.0``
204- `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_: ``2.6.0``
205- `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_: ``2.5.0``
206- `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_: ``2.9.0``
207- `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_: ``2.6.0``
Andrea Campanellac1e722e2022-07-07 19:11:43 +0200208- `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_: ``5.1.2``
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200209- `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_: ``5.6.0``
210- `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`_: ``2.2.0``
211- `pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`_: ``1.2.0``
212- `olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`_: ``1.2.0``
213
214VOLTHA Components:
215++++++++++++++++++
216
TorstenThiemea29f1c92022-07-12 08:40:33 +0000217- `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_ - ``3.1.4``
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200218- `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`_- ``1.12.10`` with `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_ ``4.8.6``
219- `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_ - ``3.1.5`` with chart ``2.11.3``
220- `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_ - ``2.1.2`` with chart ``2.11.3``
221- `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_ - ``1.7.6``
222- `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_ - ``4.2.6`` with chart ``2.11.3``
223- `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_ - ``2.2.8`` with chart ``2.10.3``
Andrea Campanellac1e722e2022-07-07 19:11:43 +0200224- `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_ - ``5.1.1`` with chart ``0.1.27``
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200225- `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_ - ``3.7.5``
226- `voltha-protos <https://github.com/opencord/voltha-protos/releases/tag/v5.2.5>`_ - ``5.2.5``
227- `voltha-lib-go <https://github.com/opencord/voltha-lib-go/releases/tag/v7.1.7>`_ - ``7.1.7``
228- `Bbsim-sadis-server <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`_ - ``0.3.4`` with chart ``0.3.1``
TorstenThiemeb0b67632022-07-13 10:43:39 +0000229- `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`_ - ``2.10.1``
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200230
231
232Helm Chart Versions:
233++++++++++++++++++++
234This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
235- Voltha-infra: ``2.10.7``
Andrea Campanellac1e722e2022-07-07 19:11:43 +0200236- Voltha-stack: ``2.10.5``
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200237
238BAL Version:
239++++++++++++
240Broadcom abstraction layer (BAL) version: ``3.10.2.2``.
241
242Openolt Agent packages:
243+++++++++++++++++++++++
244**EdgeCore**
245Get access credentials for https://edgecore.quickconnect.to from Edgecore.
246Then login and navigate to ``File_Station`` -> ``EdgecoreNAS``, and then the folder
247``/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/voltha-2.10`` or
248``/ASGvOLT64/OpenOLT_Agent/From_ONF_Distribution/voltha-2.10`` based on ``ASXvOLT16`` or ``ASGvOLT64`` platform,
249and pick the suitable OLT debian package based on ``BAL 3.10.2.2`` applicable for you.
250Please make sure to use the ONL
251``/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ONL-onl-4.14_ONL-OS8_2021-11-26.0058-0de1c30_AMD64_INSTALLED_INSTALLER``
252for running ``BAL 3.10.2.2``.
253
254**Radisys**
255Please write to `Cameron Lundberg <cameron.lundberg@radisys.com>`_
256to get the OLT debian package validated on 3200G, 1600x and 1600G platforms for VOLTHA-2.10 release
257
Andrea Campanella01960222022-07-04 09:46:25 +0200258**Zyxel**
Andrea Campanellaab5306b2022-06-30 20:48:20 +0200259Please write to `Emanuel Villalobos <Emanuel.Villalobos@zyxel.com.tw>`_
260to get the OLT debian package validated on the SDA3016SS for VOLTHA-2.10 release.