blob: 9c9a8c326bdd3751520bf6673dd7c9dafd9a8ab9 [file] [log] [blame]
Eric Ball3b87f752025-08-08 14:13:47 -07001.. figure:: images/voltha.svg
2 :alt: voltha- Release Notes
3 :width: 40%
4 :align: center
5
6
7VOLTHA 2.14 Release Notes
8=========================
9
10
11New Features
12------------
13
14- Multiple NNI support
15
16- On demand stats on OLT and ONT
17
18- Support for LINECARD reset in DMI
19
20
21Improvements to existing features
22---------------------------------
23
24- Optimization on call flow on ONU reboot
25
26- Several third party library updates across all components
27
28- Go version upgrade
29
30
31Bug Fixes
32---------
33For a full list of resolved issues, see the `full release notes on Confluence <https://lf-broadband.atlassian.net/wiki/spaces/HOME/pages/297697281/Release+Notes+for+VOLTHA+Release+2.14>`_
34
35
36Documentation
37-------------
38
39As usual documentation is published on https://docs.voltha.org
40
41
42Known Issues
43------------
44.. list-table:: Known Issues
45 :widths: 10, 40
46 :header-rows: 1
47
48 * - Jira
49 - Description
50 * - `VOL-5427 <https://lf-broadband.atlassian.net/browse/VOL-5427>`_
51 - Multicast does not work for GPON TT test pipeline
52 * - `VOL-5426 <https://lf-broadband.atlassian.net/browse/VOL-5426>`_
53 - ONUs not in the state expected by the tests
54
55
56Jira stories
57------------
58A full list of stories and bugs completed can be found under the
59`VOLTHA 2.14 <https://lf-broadband.atlassian.net/projects/VOL/versions/10023>`_ release page in Jira.
60
61
62Component Versions in VOLTHA 2.14 release
63-----------------------------------------
64
65ONOS and Atomix
66+++++++++++++++
67
68.. list-table:: ONOS and Atomix
69 :widths: 30, 5, 5, 5, 5, 5
70 :header-rows: 2
71
72 * - Component
73 - VOLTHA
74 - Component
75 - with
76 - Gerrit
77 - Github
78 * - Name
79 - Ver
80 - Ver
81 - Chart
82 - URL
83 - URL
84 * -
85 -
86 -
87 -
88 -
89 -
90 * - ONOS 2.5 LTS: `2.5.9 <https://github.com/opennetworkinglab/onos/releases/tag/2.5.9>`_, `2.5.8 <https://github.com/opennetworkinglab/onos/releases/tag/2.5.8>`_
91 - ``2.5.5``
92 - ``2.5.9``, ``2.5.8``
93 -
94 -
95 -
96 * - `ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_
97 -
98 - ``3.1.9``
99 -
100 -
101 -
102
103ONOS Components
104+++++++++++++++
105
106.. list-table:: ONOS Components
107 :widths: 10, 2, 2, 2, 2, 2, 2, 2
108 :header-rows: 2
109
110 * - Component
111 - Artifact
112 - Api
113 - App
114 - Pkg
115 - Gerrit
116 - Github
117 - Released
118 * - Name
119 - Ver
120 - Ver
121 - Ver
122 - Ver
123 - URL
124 - URL
125 -
126 * -
127 -
128 -
129 -
130 -
131 -
132 -
133 -
134 * - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
135 - :mvn-cord:`2.11.2 <aaai/2.11.2>`
136 - :mvn-cord:`X <aaa-api/2.11.2>`
137 - :mvn-cord:`X <aaa-app/2.11.2>`
138 - :mvn-cord:`X <aaa/2.11.2>`
139 - :vol-ger:`X <aaa/+/refs/tags/2.11.2>`
140 - :vol-git:`X <aaa/releases/tag/2.11.2>`
141 -
142 * - `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`__
143 - :mvn-cord:`2.5.3 <bng/2.5.3>`
144 - :mvn-cord:`X <bng-api/2.5.3>`
145 - :mvn-cord:`X <bng-app/2.5.3>`
146 - :mvn-cord:`X <bng/2.5.3>`
147 - :vol-ger:`X <bng/+/refs/tags/2.5.3>`
148 - :vol-git:`X <bng/releases/tag/2.5.3>`
149 -
150 * - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`__
151 - :mvn-cord:`2.11.2 <dhcpl2relay/2.11.2>`
152 - :mvn-cord:`X <dhcpl2relay-api/2.11.2>`
153 - :mvn-cord:`X <dhcpl2relay-app/2.11.2>`
154 - :mvn-cord:`X <dhcpl2relay>`
155 - :vol-ger:`X <dhcpl2relay/+/refs/tags/2.11.2>`
156 - :vol-git:`X <dhcpl2relay/releases/tag/2.11.2>`
157 -
158 * - `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`__
159 - :mvn-cord:`2.9.1 <onos-app-igmpproxy/2.9.1>`
160 - :mvn-cord:`X <onos-app-igmpproxy-api/2.9.1>`
161 - :mvn-cord:`X <onos-app-igmpproxy-app/2.9.1>`
162 - :mvn-cord:`X <onos-app-igmpproxy/2.9.1>`
163 - :vol-ger:`X <igmpproxy/+/refs/tags/2.9.1>`
164 - :vol-git:`X <igmpproxy/releases/tag/2.9.1>`
165 -
166 * - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`__
167 - :mvn-cord:`2.13.3 <kafka/2.13.3>`
168 - :mvn-cord:`X <kafka-api/2.13.3>`
169 - :mvn-cord:`X <kafka-app/2.13.3>`
170 - :mvn-cord:`X <kafka/2.13.3>`
171 - :vol-ger:`X <kafka-onos/+/refs/tags/2.13.3>`
172 - :vol-git:`X <kafka-onos/releases/tag/2.13.3>`
173 - ``N``
174 * - :vol-ger:`maclearner <mac-learning>`
175 - :mvn-cord:`1.2.4 <maclearner/1.2.4>`
176 - :mvn-cord:`X <maclearner-api/1.2.4>`
177 - :mvn-cord:`X <maclearner-app/1.2.4>`
178 - :mvn-cord:`X <maclearner>`
179 - :vol-ger:`X <mac-learning/+/refs/tags/1.2.4>`
180 - :vol-git:`X </mac-learning/releases/tag/1.2.4>`, :vol-git:`T <mac-learning/tree/1.2.4>`
181 -
182 * - `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`__
183 - :mvn-cord:`2.9.3 <mcast/2.9.3>`
184 - :mvn-cord:`X <mcast-api/2.9.3>`
185 - :mvn-cord:`X <mcast-app/2.9.3>`
186 - :mvn-cord:`X <mcast/2.9.3>`
187 - :vol-ger:`X <mcast/+/refs/tags/2.9.3>`
188 - :vol-git:`X </mcast/releases/tag/2.9.3>`, :vol-git:`T <mcast/tree/2.9.3>`
189 -
190 * - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`__
191 - :mvn-cord:`5.2.8 <olt/5.2.8>`
192 - :mvn-cord:`X <olt-api/5.2.8>`
193 - :mvn-cord:`X <olt-app/5.2.8>`
194 - :mvn-cord:`X <olt/5.2.8>`
195 - :vol-ger:`X <olt/+/refs/tags/5.2.8>`
196 - :vol-git:`X <olt/releases/tag/5.2.8>`
197 -
198 * - :vol-ger:`olttopology <olttopology/>`
199 - :mvn-cord:`1.3.1 <olttopology/1.3.1>`
200 - :mvn-cord:`X <olttopology-api/1.3.1>`
201 - :mvn-cord:`X <olttopology-app/1.3.1>`
202 - :mvn-cord:`X <olttopology>`
203 - :vol-ger:`X <olttopology/+/refs/tags/1.3.1>`
204 - :vol-git:`X <olttopology/releases/tag/1.3.1>`
205 -
206 * - :vol-ger:`pppoeagent <pppoeagent/>`
207 - :mvn-cord:`1.3.2 <pppoeagent/1.3.2>`
208 - :mvn-cord:`X <pppoeagent-api/1.3.2>`
209 - :mvn-cord:`X <pppoeagent-app/1.3.2>`
210 - :mvn-cord:`X <pppoeagent>`
211 - :vol-ger:`X <pppoeagent/+/refs/tags/1.3.2>`
212 - :vol-git:`X <pppoeagent/releases/tag/1.3.2>`
213 -
214 * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`__
215 - :mvn-cord:`5.12.3 <sadis/5.12.3>`
216 - :mvn-cord:`X <sadis-api/5.12.3>`
217 - :mvn-cord:`X <sadis-app/5.12.3>`
218 - :mvn-cord:`X <sadis>`
219 - :vol-ger:`X <sadis/+/refs/tags/5.12.3>`
220 - :vol-git:`X <sadis/releases/tag/5.12.3>`
221 -
222
223- See Also
224
225 - :ref:`Release Notes Legend for ONOS Components`
226 - `Docker Images: opencord <https://hub.docker.com/search?q=opencord>`_
227
228
229VOLTHA Components
230+++++++++++++++++
231
232.. list-table:: VOLTHA Components
233 :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5
234 :header-rows: 2
235
236 * - Component
237 - VOLTHA
238 - :vol-ger:`Chart.yaml <voltha-helm-charts/+/refs/heads/master>`
239 - `Gerrit <https://gerrit.opencord.org/admin/repos>`_
240 - :vol-git:`Github<>`
241 - `Docker <https://hub.docker.com/search?q=voltha>`_
242 - `Golang <https://pkg.go.dev>`_
243 - `Pypi <https://pypi.org>`_
244 * - Name
245 - Version
246 - Version
247 - ULR
248 - URL
249 - URL
250 - URL
251 - URL
252 * -
253 -
254 -
255 -
256 -
257 -
258 -
259 -
260 * - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
261 - :vol-ger:`2.3.2 <ofagent-go/+/refs/heads/voltha-2.14/VERSION>`
262 - ``N/A``
263 - :vol-ger:`X <ofagent-go/+/refs/tags/v2.3.2>`
264 - :vol-git:`X <ofagent-go/releases/tag/v2.3.2>`
265 - `1.1.4(stale) <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
266 - `1.6.5(stale) <https://pkg.go.dev/github.com/opencord/ofagent-go/cmd/ofagent>`_
267 -
268 * - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
269 - :vol-ger:`3.6.17 <voltha-go/+/refs/heads/voltha-2.14/VERSION>`
270 - ``N/A``
271 - :vol-ger:`X <voltha-go/+/refs/tags/v3.6.17>`
272 - :vol-git:`X <voltha-go/releases/tag/v3.6.17>`
273 - ``N/A``
274 - ``v7:?``
275 -
276 * - :vol-ger:`voltha-lib-go <voltha-lib-go>`
277 - :vol-ger:`7.6.8 <voltha-lib-go/+/refs/heads/master/VERSION>`
278 - ``N/A``
279 - :vol-ger:`X <voltha-lib-go/+/refs/tags/v7.6.8>`
280 - :vol-git:`X <voltha-lib-go/releases/tag/v7.6.8>`
281 - ``?``
282 - `v7 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v7@v7.6.8>`__
283 - ``?``
284 * - `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_
285 - ``5.1.10``
286 - ``0.1.27``
287 - :vol-ger:`X <voltha-onos/+/refs/tags/5.1.10>`
288 - :vol-git:`X <voltha-onos/releases/tag/5.1.10>`
289 - `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.10/images/sha256-d2498af38194a1cd01a1b9072a58af8647ed50fea2dbc9bd3ac4d4e4b583d72a?context=explore>`__
290 -
291 -
292 * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
293 - :vol-ger:`4.5.16 <voltha-openolt-adapter/+/refs/heads/voltha-2.14/VERSION>`
294 - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml#20>`
295 - :vol-ger:`X <voltha-openolt-adapter/+/refs/tags/v4.5.16>`
296 - :vol-git:`X <voltha-openolt-adapter/releases/tag/v4.5.16>`
297 - `X <https://hub.docker.com/repository/docker/voltha/voltha-openolt-adapter/tags/4.5.16/sha256-d6d79c08350a6fd9d9bd5cb121e009667421b90df280ea4bb8726525b65be295>`__
298 - ``N/A``
299 - ``N/A``
300 * - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
301 - :vol-ger:`2.12.25 <voltha-openonu-adapter-go/+/refs/heads/voltha-2.14/VERSION>`
302 - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#17>`
303 - :vol-ger:`X <voltha-openonu-adapter-go/+/refs/tags/v2.12.25>`
304 - :vol-git:`X <voltha-openonu-adapter-go/releases/tag/v2.12.25>`
305 - `X <https://hub.docker.com/repository/docker/voltha/voltha-openonu-adapter-go/tags/2.12.25/sha256-d8f2eb5f2a7e886e98a383e01ea002a22e93ac9dc6348570f457604ea8a67098>`__
306 - `stale <https://pkg.go.dev/github.com/opencord/voltha-openonu-adapter-go>`_
307 - ``N/A``
308 * - :vol-ger:`voltha-protos <voltha-protos>`
309 - :vol-ger:`5.6.5 <voltha-protos/+/refs/heads/voltha-2.14/VERSION>`
310 - ``N/A``
311 - :vol-ger:`X <voltha-protos/+/refs/tags/v5.6.5>`
312 - :vol-git:`X <voltha-protos/releases/tag/v5.6.5>`
313 - `stale <https://hub.docker.com/r/voltha/voltha-protos/tags>`__
314 - `stale <https://pkg.go.dev/github.com/opencord/voltha-protos>`__
315 - `5.6.5 <https://pypi.org/project/voltha-protos/5.6.5>`__
316 * - :vol-git:`voltha-system-tests <voltha-system-tests/releases/tag/v2.14.0>`
317 - ``v2.14.0``
318 -
319 - :vol-ger:`X <voltha-system-tests/+/refs/tags/v2.14.0>`
320 - :vol-git:`X <voltha-system-tests/tree/v2.14.0>`
321 -
322 -
323 -
324
325- See Also
326
327 - :ref:`Release Notes Legend for VOLTHA Components`
328 - `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
329
330
331VOLTHA Tools
332++++++++++++
333
334.. list-table:: VOLTHA Components
335 :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5
336 :header-rows: 2
337
338 * - Component
339 - VOLTHA
340 - :vol-ger:`Chart.yaml <voltha-helm-charts/+/refs/heads/master>`
341 - `Gerrit <https://gerrit.opencord.org/admin/repos>`_
342 - :vol-git:`Github<>`
343 - `Docker <https://hub.docker.com/search?q=voltha>`_
344 - `Golang <https://pkg.go.dev>`_
345 - `Pypi <https://pypi.org>`_
346 * - Name
347 - Version
348 - Version
349 - ULR
350 - URL
351 - URL
352 - URL
353 - URL
354 * -
355 -
356 -
357 -
358 -
359 -
360 -
361 -
362 * - :vol-ger:`voltha-docs <voltha-docs>` , `docs.voltha.org <https://docs.voltha.org>`
363 - ``2.14.0``
364 - ``N/A``
365 - :vol-ger:`X <voltha-docs/+/refs/tags/2.14.0>`
366 - :vol-git:`X <voltha-docs/releases/tag/2.14.0>`
367 -
368 -
369 -
370 * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
371 - ``1.16.8``
372 - ``2.14.0`` :vol-ger:`chart <voltha-helm-charts/+/refs/heads/voltha-2.14/bbsim/Chart.yaml>`
373 - :vol-ger:`X <bbsim>`
374 - :vol-git:`X <bbsim/tree/v1.16.8>`
375 - `X <https://hub.docker.com/layers/voltha/bbsim/1.16.8/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
376 - ``?``
377 - ``?``
378 * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`__
379 - :vol-ger:`0.4.0 <bbsim-sadis-server/+/refs/heads/voltha-2.14/VERSION>`
380 - :vol-ger:`0.3.5 <voltha-helm-charts/+/refs/heads/voltha-2.14/voltha-infra/Chart.yaml#45>`
381 - :vol-ger:`X <bbsim-sadis-server/+/refs/tags/v0.4.0/VERSION>`
382 - :vol-git:`X <bbsim-sadis-server/releases/tag/v0.4.0>`
383 - `X <https://hub.docker.com/layers/voltha/bbsim-sadis-server/0.4.0/images/sha256-0ea9df1be13f8b1d0a8314cbf0e0800e4a4b7e2920ae3ce5e119abddb9359350?context=explore>`__
384 -
385 -
386 * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
387 - :vol-ger:`1.11.9 <voltctl/+/refs/heads/voltha-2.14/VERSION>`
388 - ``N/A``
389 - :vol-ger:`X <voltctl/+/refs/tags/v1.11.9>`
390 - :vol-git:`? <voltctl/releases/tag/v1.11.9>`
391 - ``N/A``
392 - `X <https://pkg.go.dev/github.com/opencord/voltctl@v1.11.9>`__
393 - ``N/A``
394
395
396
397Helm Chart Versions
398+++++++++++++++++++
399This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
400
401.. list-table:: Helm Chart Versions
402 :widths: 30, 30
403 :header-rows: 2
404
405 * - Component
406 - VOLTHA
407 * - Name
408 - Version
409 * -
410 -
411 * - Helm Charts (voltha-helm-charts)
412 - :vol-ger:`3.6.0 <voltha-helm-charts/+/refs/heads/voltha-2.14/VERSION>`
413 * - Voltha
414 - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#20>`
415 * - Voltha-infra
416 - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-infra/Chart.yaml#38>`
417 * - Voltha-stack
418 - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#37>`
419
420
421Get Involved
422------------
423We'd love to accept your patches and contributions to the VOLTHA project, join the community!
424
425| Here are a few resources to get you started:
426
427
428Index/Entry points
429++++++++++++++++++
430
431 - `https://docs.voltha.org <https://docs.voltha.org/master/index.html>`_
432 - `Getting Started <https://docs.voltha.org/master/overview/contributing.html>`_
433
434HOWTO
435+++++
436
437 - `Code, Documentation, Makefiles <https://docs.voltha.org/master/howto/index.html>`_
438 - `Setup a test pod <https://docs.voltha.org/master/overview/lab_setup.html>`_
439 - `Troubleshooting <https://docs.voltha.org/master/overview/troubleshooting.html>`_
440
441Testing
442+++++++
443
444 - `Automation <https://docs.voltha.org/master/testing/voltha_test_automation.html>`_
445 - `Robot testing harness <https://docs.voltha.org/master/testing/index.html>`_
446 - `voltha-system-tests <https://docs.voltha.org/master/voltha-system-tests/README.html>`_
447
448CLI Tools
449+++++++++
450
451 - `BBSIM <https://docs.voltha.org/master/bbsim/docs/source/index.html>`__
452 - `voltctl <https://docs.voltha.org/master/voltctl/README.html?highlight=voltctl>`__
453
454Slack
455+++++
456
457 - `voltha-discuss <https://lfbroadband.slack.com/archives/C081SFNQ7JS>`_
458 - `voltha-tst <https://lfbroadband.slack.com/archives/C081JJ2K26T>`_
459
460Mailing List
461++++++++++++
462
463 - `Discuss@lists.voltha.org <https://lists.voltha.org/g/Discuss/messages>`_
464
465Bi-Weekly TST Meetings
466++++++++++++++++++++++
467
468 - `Calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/broadband-fund?view=month>`_
469 - `Rolling Agenda/Minutes <https://lf-broadband.atlassian.net/wiki/spaces/HOME/pages/6291531/Running+VOLTHA+TST+Meeting+Minutes>`_
470
471Websites
472++++++++
473
474 - `VOLTHA <https://lfbroadband.org/projects/voltha/>`_
475 - `docs.voltha.org <https://docs.voltha.org>`_
476 - `Wiki <https://lf-broadband.atlassian.net/wiki>`_
477
478|