blob: 59a54741f92c65797d4ea1542c532c209f55f0a9 [file] [log] [blame]
Joey Armstrong64b82492023-06-01 17:34:39 -04001.. figure:: images/voltha.svg
2 :alt: voltha- Release Notes
3 :width: 40%
4 :align: center
5
6
7VOLTHA 2.12 Release Notes
8=========================
9
10Highlights
11----------
12
13Features & Improvements
14-----------------------
15
16Bug Fixes
17---------
18
19Test
20----
21
22Documentation
23-------------
24
25As usual documentation is published on https://docs.voltha.org
26
27
28Known Issues
29------------
30.. list-table:: Known Issues
31 :widths: 10, 40
32 :header-rows: 1
33
34 * - Jira
35 - Description
36 * - Placeholder
37 - Placeholder
38
39Certification Program
40---------------------
41
42Thanks to the Continuous Certification program at ONF we can also ensure
43that the following ONF member products are compatible with the VOLTHA 2.11
44release:
45
46- Edgecore ASGVolt64 GPON OLT
47- Radisys 3200G GPON OLT
48- Radisys 1600G GPON OLT
49- Zyxel SDA3016SS Combo OLT
50
51
52Jira stories
53------------
54A full list of stories and bugs completed can be found under the
55`VOLTHA 2.12 <https://jira.opencord.org/projects/VOL/versions/12600>`_ (`formatted <https://jira.opencord.org/secure/ReleaseNote.jspa?projectId=10106&version=12600>`_) release page in Jira.
56
57|
58
59Component Versions in VOLTHA 2.12 release
60-----------------------------------------
61
Joey Armstrong83135fb2023-06-04 00:48:14 -040062ONOS and Atomix
63+++++++++++++++
64
65.. list-table:: ONOS and Atomix
66 :widths: 30, 5, 5, 5, 5, 5
67 :header-rows: 2
68
69 * - Component
70 - VOLTHA
71 - Component
72 - with
73 - Gerrit
74 - Github
75 * - Name
76 - Version
77 - Version
78 - Chart
79 - URL
80 - URL
81 * -
82 -
83 -
84 -
85 -
86 -
87 * - `ONOS 2.5 LTS <https://github.com/opennetworkinglab/onos/releases/tag/2.5.8>`_
88 -
Joey Armstrongb1498d72023-06-13 10:46:57 -040089 - ``2.5.8``
Joey Armstrong83135fb2023-06-04 00:48:14 -040090 -
91 -
92 -
93 * - `ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_
94 -
Joey Armstrongb1498d72023-06-13 10:46:57 -040095 - ``3.1.9``
Joey Armstrong83135fb2023-06-04 00:48:14 -040096 -
97 -
98 -
99
100ONOS Apps
101+++++++++
102
103.. list-table:: ONOS Apps
Joey Armstrong0c517b52023-07-07 17:29:54 -0400104 :widths: 10, 5, 2, 3, 5, 5, 5, 1
Joey Armstrong83135fb2023-06-04 00:48:14 -0400105 :header-rows: 2
106
107 * - Component
108 - VOLTHA
Joey Armstrong0c517b52023-07-07 17:29:54 -0400109 - Maven
Joey Armstrong83135fb2023-06-04 00:48:14 -0400110 - Component
111 - with
112 - Gerrit
113 - Github
Joey Armstrongb1498d72023-06-13 10:46:57 -0400114 - Release
Joey Armstrong83135fb2023-06-04 00:48:14 -0400115 * - Name
116 - Version
Joey Armstrong0c517b52023-07-07 17:29:54 -0400117 - Version(s)
118 - Artifact
Joey Armstrong83135fb2023-06-04 00:48:14 -0400119 - Chart
120 - URL
121 - URL
Joey Armstrongb1498d72023-06-13 10:46:57 -0400122 - Status
123 * -
124 -
125 -
126 -
127 -
128 -
129 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400130 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400131 * - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
Joey Armstrong0c517b52023-07-07 17:29:54 -0400132 -
133 - `2.10.3 <https://mvnrepository.com/artifact/org.opencord/aaa>`_
134 - `api <https://central.sonatype.com/artifact/org.opencord/aaa-api/2.10.3>`__
135 `app <https://central.sonatype.com/artifact/org.opencord/aaa-app/2.10.3>`__
136 `pkg <https://central.sonatype.com/artifact/org.opencord/aaa/2.10.3>`__
Joey Armstrongb1498d72023-06-13 10:46:57 -0400137 -
138 - `X <https://gerrit.opencord.org/plugins/gitiles/aaa/+/refs/tags/2.10.3>`__
139 - `X <https://github.com/opencord/aaa/tree/2.10.3>`__
140 -
141 * - `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`_
142 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400143 - `2.5.0 <https://central.sonatype.com/artifact/org.opencord/bng>`__
144 - `api <https://mvnrepository.com/artifact/org.opencord/bng-api/2.5.0>`__
145 `app <https://mvnrepository.com/artifact/org.opencord/bng-app/2.5.0>`__
146 `pkg <https://mvnrepository.com/artifact/org.opencord/bng/2.5.0>`__
Joey Armstrongb1498d72023-06-13 10:46:57 -0400147 -
Joey Armstrongbd9d7b22023-06-15 08:40:20 -0400148 - `X <https://github.com/opencord/bng/tree/2.5.0>`__
149 - `X <https://gerrit.opencord.org/plugins/gitiles/bng/+/refs/tags/2.5.0>`__
150 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400151 * - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_
152 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400153 - `2.10.0 <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay>`_
154 - `api <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay-api/2.10.0>`_
155 `app <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay-app/2.10.0>`_
156 `pkg <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay/2.10.0>`_
Joey Armstrongb1498d72023-06-13 10:46:57 -0400157 -
158 - `X <https://gerrit.opencord.org/plugins/gitiles/dhcpl2relay/+/refs/tags/2.10.0>`__
159 - `X <https://github.com/opencord/dhcpl2relay/tree/2.10.0>`__
160 -
161 * - `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_
162 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400163 - `2.8.0 <https://mvnrepository.com/artifact/org.opencord/onos-app-igmpproxy>`__
164 - `app <https://mvnrepository.com/artifact/org.opencord/onos-app-igmpproxy-app/2.8.0>`__
165 `api <https://mvnrepository.com/artifact/org.opencord/onos-app-igmpproxy-api/2.8.0>`__
166 `pkg <https://mvnrepository.com/artifact/org.opencord/onos-app-igmpproxy/2.8.0>`__
Joey Armstrongb1498d72023-06-13 10:46:57 -0400167 -
168 - `X <https://gerrit.opencord.org/plugins/gitiles/igmpproxy/+/refs/tags/2.7.0>`__
169 - `X <https://github.com/opencord/igmpproxy/tree/2.7.0>`__
170 - !
171 * - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_
172 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400173 - `2.12-unpublished <https://mvnrepository.com/artifact/org.opencord/kafka>`__
174 - `api <https://mvnrepository.com/artifact/org.opencord/kafka-api/2.10.0>`__
175 `app <https://mvnrepository.com/artifact/org.opencord/kafka-app/2.10.0>`__
176 `pkg <https://mvnrepository.com/artifact/org.opencord/kafka/2.10.0>`__
Joey Armstrongb1498d72023-06-13 10:46:57 -0400177 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400178 - ``X-unpublished`` ``https://gerrit.opencord.org/plugins/gitiles/kafka-onos/+/refs/tags/2.12.0``
179 - ``X-unpublished`` ``https://github.com/opencord/kafka-onos/tree/2.12.0``
Joey Armstrongb1498d72023-06-13 10:46:57 -0400180 - !
181 * - `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_
182 -
Joey Armstrongbd9d7b22023-06-15 08:40:20 -0400183 - `2.9.0 <https://central.sonatype.com/artifact/org.opencord/mcast/2.9.0>`_
Joey Armstrongb1498d72023-06-13 10:46:57 -0400184 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400185 -
Joey Armstrongbd9d7b22023-06-15 08:40:20 -0400186 - `X <https://gerrit.opencord.org/plugins/gitiles/mcast/+/refs/tags/2.9.0>`__
187 - `X <https://github.com/opencord/mcast/tree/2.9.0>`__
188 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400189 * - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_
190 -
Joey Armstrongbd9d7b22023-06-15 08:40:20 -0400191 - `5.2.4 <https://central.sonatype.com/artifact/org.opencord/olt/5.2.4>`_
Joey Armstrongb1498d72023-06-13 10:46:57 -0400192 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400193 -
Joey Armstrongbd9d7b22023-06-15 08:40:20 -0400194 - `X <https://gerrit.opencord.org/plugins/gitiles/olt/+/refs/tags/5.2.4>`__
195 - `X <https://github.com/opencord/olt/tree/5.2.4>`__
196 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400197 * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_
198 -
199 - `5.11.1 <https://central.sonatype.com/artifact/org.opencord/sadis/5.11.1>`_
200 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400201 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400202 - `X <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/tags/5.11.1>`__
203 - `X <https://github.com/opencord/sadis/tree/5.11.1>`__
204 -
205 * - `pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`_
206 -
207 - ``1.2.0``
208 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400209 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400210 - `X <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/+/refs/tags/1.2.1>`__
211 - `X <https://github.com/opencord/pppoeagent/tree/1.2.1>`__
212 - !
213 * - `olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`_
214 -
215 - ``1.2.0``
216 -
Joey Armstrong0c517b52023-07-07 17:29:54 -0400217 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400218 - `X <https://gerrit.opencord.org/plugins/gitiles/olttopology/+/refs/tags/1.2.1>`__
219 - `X <https://github.com/opencord/olttopology/tree/1.2.1>`__
220 - !
221
222VOLTHA Components
223+++++++++++++++++
224
225.. list-table:: VOLTHA Components
226 :widths: 30, 5, 5, 5, 5, 5, 5
227 :header-rows: 2
228
229 * - Component
230 - VOLTHA
231 - Component
232 -
233 - Gerrit
234 - Github
235 - `Docker <https://hub.docker.com/search?q=voltha>`_
236 * - Name
237 - Version
238 - Version
239 - `with Chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
240 - ULR
241 - URL
242 - URL
Joey Armstrong83135fb2023-06-04 00:48:14 -0400243 * -
244 -
245 -
246 -
247 -
248 -
Joey Armstrong83135fb2023-06-04 00:48:14 -0400249 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400250 * - `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_
251 - ``3.2.2-dev1``
Joey Armstrong83135fb2023-06-04 00:48:14 -0400252 -
Joey Armstrongb1498d72023-06-13 10:46:57 -0400253 -
254 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`__
255 - `X <https://github.com/opencord/voltha-helm-charts/tree/3.2.0>`__
256 -
257 * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
258 - ``1.14.4``
259 - ``4.8.6``
260 - `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
261 -
262 - `X <https://github.com/opencord/bbsim/tree/v1.14.4>`__
263 - `X <https://hub.docker.com/layers/voltha/bbsim/1.14.4/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
264 * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`_
265 -
266 - ``0.3.4``
267 - `0.3.2 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/bbsim-sadis-server/Chart.yaml>`_
268 - `X <https://gerrit.opencord.org/plugins/gitiles/bbsim-sadis-server/+/refs/tags/v0.3.4>`_
269 - `X <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`__
270 -
271 * - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
272 - ``2.1.3``
273 - ``2.1.3``
274 - ``2.11.3``
275 -
276 - `X <https://github.com/opencord/ofagent-go>`__
277 - `1.1.4-? <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
278 * - `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_
279 -
280 - ``4.2.12``
281 -
282 -
283 - `X <https://github.com/opencord/openolt>`__
284 -
285 * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
286 - ``1.8.3``
287 -
288 -
289 - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
290 - `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
291 -
292 * - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
293 - ``3.1.8``
294 - docker
295 - ``2.11.3``
296 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-go/+/refs/tags/v3.1.8>`__
297 - `X <https://github.com/opencord/voltha-go/tree/v3.1.8>`__
298 -
299 * - `voltha-lib-go <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go>`_
300 - ``2.11.3 (?)``
301 - ``7.3.2``
302 -
303 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/tags/v7.3.2>`__
304 - `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.3.2>`__
305 -
306 * - `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_
307 -
308 - ``5.1.2``
309 - ``0.1.27``
310 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-onos/+/refs/tags/5.1.3>`__
311 - `X <https://github.com/opencord/voltha-onos/tree/5.1.3>`__
312 - `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.3/images/sha256-d9c686acf177ed823ff359dc43ba59aab05ae067be27c92e48c08b72f94b9ca3?context=explore>`__
313 * - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
314 -
315 - ``2.7.3``
316 -
317 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter-go/+/refs/tags/v2.7.3>`__
318 - `X <https://github.com/opencord/voltha-openonu-adapter-go/tree/v2.7.3>`__
319 - `X <https://hub.docker.com/layers/voltha/voltha-openonu-adapter-go/2.7.3/images/sha256-e9484a8963d08748af5766a6a8ce7f7485efb384488bcf93840ecc1142d7ad74?context=explore>`__
320 * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
321 - ``v4.2.12``
322 - ``4.2.6``
323 -
324 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.2.12>`__
325 - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.2.12>`__
326 - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.2.12/images/sha256-844eac272323dc8bca10880a111957a95839578b3210dd777be5ac9370aaa52e?context=explore>`__
327 * - `voltha-protos <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`_
328 -
329 - `5.3.8 <https://pypi.org/project/voltha-protos/5.3.8>`__
330 -
331 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.3.8>`__
332 - `X <https://github.com/opencord/voltha-protos/tree/v5.3.8>`__
333 -
334 * - `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`__
335 - ``2.11.10``
336 -
337 -
338 - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-system-tests/+/refs/tags/2.11.10>`__
339 - `X <https://github.com/opencord/voltha-system-tests/tree/2.11.10>`__
340 -
341 * - maclearner
342 - ``1.2.1``
343 -
344 -
345 -
346 -
347 -
348 * - ppoeagent
349 - ``1.2.1``
350 -
351 -
352 -
353 -
354 -
355 * - segmentrouting
356 - ``3.0.0``
357 -
358 -
359 -
360 -
361 -
362
363
364Helm Chart Versions
365+++++++++++++++++++
366This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
367
368.. list-table:: Helm Chart Versions
369 :widths: 30, 5, 5, 5, 5, 5
370 :header-rows: 2
371
372 * - Component
373 - VOLTHA
374 - Component
375 -
376 - Gerrit
377 - Github
378 * - Name
379 - Version
380 - Version
381 - with Chart
382 - URL
383 - URL
384 * -
385 -
386 -
387 -
388 -
389 -
390 * - Voltha-infra
391 - ``2.10.10``
392 -
393 -
394 -
395 -
396 * - Voltha-stack
397 - ``2.10.10``
398 -
399 -
400 -
401 -
402
403BAL Version
404+++++++++++
405
406.. list-table:: Helm Chart Versions
407 :widths: 30, 5, 5, 5, 5, 5
408 :header-rows: 2
409
410 * - Component
411 - VOLTHA
412 - Component
413 -
414 - Gerrit
415 - Github
416 * - Name
417 - Version
418 - Version
419 - with Chart
420 - URL
421 - URL
422 * -
423 -
424 -
425 -
426 -
427 -
428 * - Broadcom abstraction layer (BAL)
429 -
430 - ``3.10.2.2``
431 -
432 -
433 -
434
435|
Joey Armstrong83135fb2023-06-04 00:48:14 -0400436
Joey Armstrong64b82492023-06-01 17:34:39 -0400437Helm Chart Versions
438+++++++++++++++++++
439This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
440
441BAL Version
442+++++++++++
443
444|
445
446Get Involved
447------------
448We'd love to accept your patches and contributions to the VOLTHA project, join the community!
449
450| Here are a few resources to get you started:
451
452
453Index/Entry points
454++++++++++++++++++
455
456 - `https://docs.voltha.org <https://docs.voltha.org/master/index.html>`_
457 - `Getting Started <https://docs.voltha.org/master/overview/contributing.html>`_
458
459HOWTO
460+++++
461
462 - `Code, Documentation, Makefiles <https://docs.voltha.org/master/howto/index.html>`_
463 - `Setup a test pod <https://docs.voltha.org/master/overview/lab_setup.html>`_
464 - `Troubleshooting <https://docs.voltha.org/master/overview/troubleshooting.html>`_
465
466Testing
467+++++++
468
469 - `Automation <https://docs.voltha.org/master/testing/voltha_test_automation.html>`_
470 - `Robot testing harness <https://docs.voltha.org/master/testing/index.html>`_
471 - `voltha-system-tests <https://docs.voltha.org/master/voltha-system-tests/README.html>`_
472
473CLI Tools
474+++++++++
475
476 - `BBSIM <https://docs.voltha.org/master/bbsim/docs/source/index.html>`__
477 - `voltctl <https://docs.voltha.org/master/voltctl/README.html?highlight=voltctl>`__
478
479Slack
480+++++
481 - `voltha-dev <https://app.slack.com/client/T095Z193Q/C01D229FP2A>`_
482 - `community <https://app.slack.com/client/T095Z193Q/C0184DT7116>`_
483 - `general <https://app.slack.com/client/T095Z193Q/C095YQBLL>`_
484
485Mailing List
486++++++++++++
487 - `voltha-discuss@opennetworking.org <https://groups.google.com/a/opennetworking.org/g/voltha-discuss>`_.
488
489Weekly TST Meetings
490+++++++++++++++++++
491- `Zoom Meeting <https://www.google.com/url?q=https://onf.zoom.us/j/978447356?pwd%3DdS9WajNLam9ZeFExOHV3SXB2Nk1VZz09&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3dMQpIMYLlyjTTmkvW_edp>`_.
492- `Rolling Agenda <https://www.google.com/url?q=https://docs.google.com/document/d/1mNqronCip_-tDjFI-ZoudNteC3AnOcVONPHz7HuW8Eg/edit?usp%3Dsharing&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3km2VVU2j1qa6JCGI0iSBx>`_.
493
Joey Armstrong7d32cbe2023-06-02 14:30:19 -0400494Website
495+++++++
496- `onf/VOLTHA <https://opennetworking.org/voltha/>`_
497- `docs.voltha.org <https://docs.voltha.org>`_
498
Joey Armstrong64b82492023-06-01 17:34:39 -0400499|