VOL-4890 - VOLTHA 2.11 release notes page
VOL-4840 - v2.11 documentation
howto/release/index.rst
-----------------------
o Relocate list of legacy release note links from the left margin main
index into release_notes/index.html to condense the index.
overview/release_process.rst
----------------------------
o Misc cleanups & edits: change v2.10 -> v2.11.
release_notes/voltha_2.11.rst
-----------------------------
o Add Mahir(s) v2.11 release notes wiki to the document.
o Component name and version expanded into a table that includes links to gerrit and github (wip).
o Removed agent packages section from v2.10.
Change-Id: I79b35f2bc6aca51567e78f92285904cac7696f4b
diff --git a/VERSION b/VERSION
index 82a1ba0..a1fcd4a 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.11.0-dev2
+2.11.0-dev3
diff --git a/howto/release/components/index.rst b/howto/release/components/index.rst
new file mode 100644
index 0000000..a63e5dc
--- /dev/null
+++ b/howto/release/components/index.rst
@@ -0,0 +1,17 @@
+VOLTHA Components (wip)
+=======================
+
+- `Jenkins Release Job <https://jenkins.opencord.org/job/onos-app-release/>`_
+
+ - Initiate a build for the target component, specify appVersion & apiVersion.
+ - Job will modify pom.xml and create pull requests based on version strings.
+ - Approve and merge the pom.xml changes.
+ - Next a jenkins job will publish changes to maven central.
+
+ - A user login is required.
+ - `Wait until artifacts are published <https://search.maven.org/search?q=g:org.opencord>`_
+ - Verify status then manually initiate.
+ - `Visit <https://oss.sonatype.org>`_
+ - Select app to release.
+ - Click Show all versions.
+ - TODO: Girish to provide remaining steps.
diff --git a/howto/release/index.rst b/howto/release/index.rst
index f3a6ed7..d98e421 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -3,6 +3,7 @@
.. toctree::
:maxdepth: 2
+ voltctl/index
voltctl/install
voltctl/release
voltctl/see_also
diff --git a/overview/release_process.rst b/overview/release_process.rst
index 5bc12b1..37b84cb 100644
--- a/overview/release_process.rst
+++ b/overview/release_process.rst
@@ -28,7 +28,7 @@
each component repo's VERSION file should have it's minor version increased in master. (ex: 1.1.X to 1.2.0-dev,
so future 1.1.X+1 component release can easily be created for the released VOLTHA version).
-The same should be done on Helm charts in the chart repos post release,but the versions there shouldn't include a
+The same should be done on Helm charts in the chart repos post release, but the versions there shouldn't include a
-dev suffix because chart publishing requires that every new chart version be unique and using un-suffixed SemVer is a
better release numbering pattern.
@@ -204,7 +204,7 @@
If a fix is needed to the components/containers that are included by the helm charts:
- Develop a fix to the issue on the master branch, get it approved after passing master tests.
-- Manually cherry-pick to the voltha-X.Y branch of the component (create one fi needed)
+- Manually cherry-pick to the voltha-X.Y branch of the component (create one if needed)
- incrementing the patch version in the VERSION file,
- test with the voltha-X.Y version of voltha-system-tests and helm charts.
- Update helm charts and go through the helm chart update process above.
diff --git a/release_notes/voltha_2.11.rst b/release_notes/voltha_2.11.rst
index 229e6b9..964bf28 100644
--- a/release_notes/voltha_2.11.rst
+++ b/release_notes/voltha_2.11.rst
@@ -4,33 +4,66 @@
:align: center
-
VOLTHA 2.11 Release Notes
=========================
Highlights
----------
-
+VOLTHA-2.11 builds on the 2.10 release for VOLTHA. It is the second LTS release after VOLTHA 2.8. During this release, automated operator tests are reconfigured after the relocation of some test pods. CI/CD scripts are revisited for better visibility of job steps and failures. ONU OMCI counters enabled on CLI for better debugging of the system. OMCI extended message support in openonu-adapter has been enhanced to be used in alarm and PM (Performance Management) data retrievals.
+The Broadband Forum(BBF) models have been extended to align with VOLTHA interfaces and implemented in an adapter layer at the northbound of VOLTHA. The POC work on Broadband Forum integration is demonstrated in the `NetworkX event <https://networkxevent.com/>`_ in Amsterdam in October `2022 <https://networkxevent.com/agenda/>`_. New robustness tests have also been introduced to exercise corner cases in openonu-adapter as well as the tests for OMCI extended message support.
Features & Improvements
-----------------------
+- OMCI extended message support.
+
+ - Support alarm data retrieval.
+ - Support PM data retrieval.
+
+- Configure encryption ring on XGS PON:
+
+ - Configure the GEM Encryption Key Ring with the values defined in `G.988 <https://www.itu.int/rec/T-REC-G.988/en>`_.
+
+ - Use the value in XGS_PON tech profile definition.
+
+- ONU OMCI counter retrieval via `voltctl <https://github.com/opencord/voltctl>`__:
+
+ - Number of TX/RX-frames (separated for baseline and extended format):
+ - TX AR=1, RX AK=1, TX AR=0, RX AK=0 (AR: Acknowledge Request, AK: Acknowledgement).
+ - Number of repeated TX-frames due to missing answer.
+ - Number of TX-frames running into timeout (even after repetition).
+
+- OMCI extended message support in BBSIM:
+
+ - support alarm data retrieval.
Bug Fixes
---------
-
+- Error in handling multiple ONU Discovery indications.
+- ONUs are now discoverable after multiple OLT reboots.
+- Panic in openonu-adapter during scale test, due to permanently disrupted OMCI communication.
+- Proper resource initialization for individual failed PON ports.
+- Avoid ONUs being set to unreachable after multiple unsuccessful OMCI communication attempts.
+- Panic during serialization of extended GetAllAlarmsNextResponse.
Test
----
+- Robustness Tests
+ - Verify ONU power-off during flow configuration.
+ - Verification/correlation of ONU capabilities against configuration requirements Priority Queues
+ - Verification/correlation of ONU capabilities against configuration requirements TConts
+ - Test for detecting potential memory leaks
+ - Test for ONU Model display via voltctl
-Design Discussions
-------------------
+- OMCI Extended Message Tests
+ - Test verify SW upgrade
+ - Test verify MIB upload
Documentation
@@ -41,18 +74,46 @@
Known Issues
------------
+.. list-table:: Known Issues
+ :widths: 10, 40
+ :header-rows: 1
+ * - Jira
+ - Description
+ * - `VOL-4521 <https://jira.opencord.org/browse/VOL-4521>`_
+ - Packets arrive on the wrong gem port in the upstream after XGSPON ONU disable/enable.
+ * - `VOL-4698 <https://jira.opencord.org/browse/VOL-4698>`_
+ - Device actual state not visible during device deletion.
+ * - `VOL-4747 <https://jira.opencord.org/browse/VOL-4747>`_
+ - Flows stuck in pending-add when subscriber is provisioned after open-olt-adapter pod restart.
Certification Program
---------------------
+Thanks to the Continuous Certification program at ONF we can also ensure
+that the following ONF member products are compatible with the VOLTHA 2.11
+release:
+
+- Edgecore ASGVolt64 GPON OLT
+- Edgecore ASXVolt16 XGSGPON OLT
+- Radisys 3200G GPON OLT
+- Radisys 1600G GPON OLT
+- Radisys 1600X COMBO OLT
+- Adtran 6320X COMBO OLT
+- Zyxel SDA3016SS Combo OLT
+- Sercomm FG1000 GPON ONU
+- Sercomm Glasfaser GPON ONU
+- Edgecore 6712-32X Switch
+- Edgecore 7712-32X Switch
Jira stories
------------
A full list of stories and bugs completed can be found under the
-`VOLTHA 2.11 <https://jira.opencord.org/secure/ReleaseNote.jspa?projectId=10106&version=12300>`_ release page in Jira.
+`VOLTHA 2.11 <https://jira.opencord.org/projects/VOL/versions/12500>`_ (`formatted <https://jira.opencord.org/secure/ReleaseNote.jspa?projectId=10106&version=12500>`_) release page in Jira.
+
+|
Component Versions in VOLTHA 2.11 release
-----------------------------------------
@@ -122,9 +183,9 @@
-
* - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
-
- - ``2.6.0``
+ - ``master: 2.7.0``
-
- -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/aaa/+/refs/tags/2.6.0>`__
-
* - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_
-
@@ -212,7 +273,7 @@
-
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`__
- `X <https://github.com/opencord/voltha-helm-charts/tree/3.2.0>`__
- * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`_
+ * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
- ``1.14.4``
- ``4.8.6``
- `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
@@ -278,13 +339,14 @@
-
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.3.6>`__
- `X <https://github.com/opencord/voltha-protos/tree/v5.3.6>`__
- * - `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`_
+ * - `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`__
- ``2.11.10``
-
-
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-system-tests/+/refs/tags/2.11.10>`__
- `X <https://github.com/opencord/voltha-system-tests/tree/2.11.10>`__
+
Helm Chart Versions
+++++++++++++++++++
This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
@@ -356,22 +418,39 @@
-
-
-Openolt Agent packages:
-+++++++++++++++++++++++
-**EdgeCore**
-Get access credentials for https://edgecore.quickconnect.to from Edgecore.
-Then login and navigate to ``File_Station`` -> ``EdgecoreNAS``, and then the folder
-``/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/voltha-2.11`` or
-``/ASGvOLT64/OpenOLT_Agent/From_ONF_Distribution/voltha-2.11`` based on ``ASXvOLT16`` or ``ASGvOLT64`` platform,
-and pick the suitable OLT debian package based on ``BAL 3.10.2.2`` applicable for you.
-Please make sure to use the ONL
-``/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ONL-onl-4.14_ONL-OS8_2021-11-26.0058-0de1c30_AMD64_INSTALLED_INSTALLER``
-for running ``BAL 3.10.2.2``.
+|
-**Radisys**
-Please write to `Cameron Lundberg <cameron.lundberg@radisys.com>`_
-to get the OLT debian package validated on 3200G, 1600x and 1600G platforms for VOLTHA-2.11 release
+Get Involved
+------------
+We'd love to accept your patches and contributions to the VOLTHA project, join the community!
-**Zyxel**
-Please write to `Emanuel Villalobos <Emanuel.Villalobos@zyxel.com.tw>`_
-to get the OLT debian package validated on the SDA3016SS for VOLTHA-2.11 release.
+| Here are a few resources to get you started:
+
+
+Index/Entry points
+++++++++++++++++++
+
+ - `https://docs.voltha.org <https://docs.voltha.org/master/index.html>`_
+ - `Getting Started <https://docs.voltha.org/master/overview/contributing.html>`_
+
+HOWTO
++++++
+
+ - `Code, Documentation, Makefiles <https://docs.voltha.org/master/howto/index.html>`_
+ - `Setup a test pod <https://docs.voltha.org/master/overview/lab_setup.html>`_
+ - `Troubleshooting <https://docs.voltha.org/master/overview/troubleshooting.html>`_
+
+Testing
++++++++
+
+ - `Automation <https://docs.voltha.org/master/testing/voltha_test_automation.html>`_
+ - `Robot testing harness <https://docs.voltha.org/master/testing/index.html>`_
+ - `voltha-system-tests <https://docs.voltha.org/master/voltha-system-tests/README.html>`_
+
+CLI Tools
++++++++++
+
+ - `BBSIM <https://docs.voltha.org/master/bbsim/docs/source/index.html>`__
+ - `voltctl <https://docs.voltha.org/master/voltctl/README.html?highlight=voltctl>`__
+
+|
diff --git a/todo b/todo
new file mode 100644
index 0000000..f16856d
--- /dev/null
+++ b/todo
@@ -0,0 +1,2 @@
+Files ../vd/overview/release_process.rst and ./overview/release_process.rst differ
+Only in .: todo