blob: 36bb6471048871a57fb6d20c64c74753350b9955 [file] [log] [blame]
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -07001VOLTHA 2.4 Release Notes
2========================
3
4Highlights
5----------
6
7VOLTHA 2.4 together with ONOS 2.2.3 is the first release with full support for
8all 3 operator workflows - AT&Ts 1 TCONT- 4 GEMs, Deutsche Telekoms FTTH 1
9TCONT- 8 GEMs, and Turk Telekoms Multi-TCONT triple-play workflows. Also,
10for the first time, this release supports whitebox GPON OLTs and in-band management
11of remotely-located OLTs. It improves on performance and scale, achieving the
12MVP 1.0 requirements for production deployments of 2 OLTs with 500 ONUs each for
13the AT&T and DT workflows. The release also expands on automated-tests,
14with over 100+ tests run nightly in regression testing jobs across 3 hardware pods,
15delivering improved stability and robustness. VOLTHA 2.4 also comes on top of
16up-to-date versions of key infrastructure components such as HELM 3 and Kubernetes 1.18.
17
18
19Features & Improvements
20-----------------------
21
22- Full support for Turk Telekom triple play workflow with HSIA, Multicast IPTV, VoIP and VoD using T-CONTS per service.
23 Two new ONOS apps introduced - igmp-proxy and mcast
24- Support for multiple OLTs in a single-VOLTHA stack.
25- Support for GPON OLTs, specifically EdgeCores ASGvOLT64 OLT
26- Support for ONOS controller clustering (typically with 3 ONOS instances and 3 Atomix instances) for scale and high
27 availability. All 7 ONOS applications used with VOLTHA upgraded to work in a clustered setting.
28- Support for multiple ONU adaptor instances for scaling out (internal to a VOLTHA stack)
29- Support for In-band Management of OLTs
30- BAL transitioned from version 3.2.3.2 to version 3.4.3.3 with several bug fixes
31- Full DT and ATT workflow support on BBSIM simulator for scale testing
32- Scale improvements to meet MVP 1 targets of 2 OLTs with 500 ONUs each for both DT and ATT workflows,
33 including several improvements to VOLTHA core data models.
34- Enhanced Meter handling for Bandwidth profile support.
35- Enhanced Group handling and cleanup.
36
37Development process
38-------------------
39
40- Update to Kubernetes 1.18.5
41- Update to Helm3 of all the charts and deployment tools.
42
43Testing
44-------
45
46- Integration Tests
47
48 - Automated tests run on both hardware and BBSim platforms, please use the VOLTHA-2.4 view under https://jenkins.opencord.org/
49 - Sanity test on hardware for TT workflow
50 - In Band Management of OLT on one of the ONF Menlo testing pods
51 - GPON OLT test job in Berlin pod
52
53- Scale Tests
54
55 - Met required scale measurements with 2 OLTs and 500 ONUs each for both ATT and DT workflows
56
57Documentation
58-------------
59
60- Updated documentation with workflow specific orientation and published on https://docs.voltha.org
61
62Known Issues
63------------
64
65- [VOL-3376] Data rate error margin beyond allowed limit
66- [VOL-3377] In-band interface does not get an IP address from DHCP sometimes due to an issue in BAL.
67 Workaround automatically reboots the OLT.
68- [VOL-3125] Bandwidth profile not enforced with BAL 3.4.3.3.
69- [VOL-3241] Scale measurements require the use of etcd in-memory
70
71Component Versions
72------------------
73
74`Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree;h=refs/heads/voltha-2.4>`_
75
Matteo Scandolo0604f772020-08-13 15:56:37 -070076voltha ``2.5.7`` with container images:
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -070077
Matteo Scandolo0604f772020-08-13 15:56:37 -070078- `voltha-rw-core <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree;h=refs/heads/voltha-2.4>`_: ``2.4.5``
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -070079- `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree;h=refs/heads/voltha-2.4>`_: ``1.2.6``
80
Andrea Campanellaf20b0652020-08-24 14:51:07 +020081voltha-adapter-openolt: ``2.5.10`` with container image `voltha-openolt-adapter
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -070082<https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree;h=refs/heads/voltha-2.4>`_:
Matteo Scandolo0604f772020-08-13 15:56:37 -070083``2.4.14``
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -070084
85voltha-adapter-openonu ``2.4.6`` with container image `voltha-openonu-adapter
86<https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter.git;a=tree;h=refs/heads/voltha-2.4>`_:
87``2.4.8``
88
89`voltha-onos
90<https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree;h=refs/heads/voltha-2.4>`_:
91`onos chart
92<https://github.com/onosproject/onos-helm-charts/tree/master/onos-classic>`_
Andrea Campanellaa2f20842020-08-12 15:32:44 +020093``0.1.1`` using container image ``4.1.4``
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -070094
95`ONOS <https://gerrit.onosproject.org/plugins/gitiles/onos>`_: ``2.2.3``
96
97ONOS App versions:
98
99- `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_: ``2.1.0``
100- `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_: ``2.1.0``
101- `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_: ``2.1.2``
102- `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_: ``2.3.1``
103- `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_: ``2.1.0``
Matteo Scandolo0604f772020-08-13 15:56:37 -0700104- `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_: ``4.1.3``
Matteo Scandolob0fcd4e2020-07-28 15:54:52 -0700105- `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_: ``5.1.0``
106
107`bbsim
108<https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree;h=refs/heads/voltha-2.4>`_:
109`bbsim chart
110<https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
111``3.1.0`` using container image: ``0.2.6``
112
113`OpenOLT Agent
114<https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree;h=refs/heads/voltha-2.4>`_
115``2.4.9`` using ``BAL 3.4.3.3`` SDK
116
117**Available from EdgeCore site**
118
119- Out of band management
120
121 - ONL version (both GPON and XGSPON) ONL-onl-4.14_ONL-OS8_2020-04-14.1946-72b95a7_AMD64_INSTALLED_INSTALLER
122 - ``openolt_asfvolt16-2.4.9-dev-d4aeca5a2094f7dc7c519913ab1558348c546dab.deb`` for ASFVOLT16
123 - ``openolt_asgvolt64-2.4.9-dev-d4aeca5a2094f7dc7c519913ab1558348c546dab.deb`` for ASGVOLT64
124
125- In band management
126
127 - use ONL image, comprising of Bal and openolt (available from edgecore site)
128 for ASFVOLT16 ``ONL-onl-4.14_ONL-OS8_2020-07-24.2214-72b95a7_AMD64_INSTALLED_INSTALLER``
129
130Get access credentials for https://edgecore.quickconnect.to and then login
131and navigate to File_Station -> EdgecoreNAS, and then the folder
132/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ and pick the version above
133
134A full list of Jira tickets releated to the VOLTHA 2.4 release is available
135`here <https://docs.google.com/document/d/1BolYA52uJ0LVJkYz5SYPWdWamkt4J3yP6CLhH7FNjBg/edit?usp=sharing>`_ .