Release notes and tag for 2.5.0
Change-Id: Iff3a561d04323ff4b175e1f5fd4a508550579696
diff --git a/release_notes/voltha_2.5.rst b/release_notes/voltha_2.5.rst
new file mode 100644
index 0000000..dde26e5
--- /dev/null
+++ b/release_notes/voltha_2.5.rst
@@ -0,0 +1,135 @@
+VOLTHA 2.5 Release Notes
+========================
+
+Highlights
+----------
+
+After the successful completion of MVP 1.0 requirements in the last release (VOLTHA 2.4 - July end),
+this release of VOLTHA 2.5 together with ONOS 2.2.6 features several bug fixes as well as progress
+towards meeting MVP 2.0 requirements. In particular, BAL software was upgraded to v3.4.7.5 which fixed
+a critical bug in downstream bandwidth limiting, and the logging infrastructure was enhanced by employing
+Jaeger for log-correlation, while also including the capability to import the logs in a deployed EFK
+(Elasticsearch, Fluentd and Kibana) stack for persistence and analysis. In parallel, the Device Management
+Interface brigade made its first release of the interface, and the GoLang based ONU adapter continued to
+make progress with preliminary support for the DT and ATT workflows, showing remarkable performance
+improvements over the python version. Significant progress was also made by incorporating the Turk Telekom
+(TT) workflow in BBSim so that the latter can be used for development and deployed in scale tests similar to the ones
+for AT&T and DT workflows. Additionally, preliminary support was added for soak testing and server-sizing. As part of a
+multi-release effort to increase security of the system we introduced the capability to encrypt the OMCC GEM channel
+and added static code checks to many of the services. Finally, while not part of the release, design discussions were
+completed on a number of issues that are part of the MVP 2.0 requirements. We expect the implementation of such design
+decisions will be completed in the next release.
+
+Features & Improvements
+-----------------------
+
+- Across service Log correlation through Jaeger
+- EFK (Elasticsearch, Fluentd and Kibana) log exporter stack integration including openolt logs
+- OpenOnu Go implemented support for DT and ATT workflows and container restart.
+- Device management interface `release <https://github.com/opencord/device-management-interface/releases/tag/v0.9.0>`_
+- OFagent improvement to send packet ins only to the controller master instance, support for smaller flow chunks due to
+ “heavier” flows in the TT workflow
+- ONOS and ONOS apps improvements, including meter store fixes, support for multiple DHCP allocations, trap flows
+ modifications
+- Encryption of the OMCC GEM channel
+- BAL 3.4.7.5 including the downstream bandwidth limiting bugfix
+
+Development/Deployment process
+------------------------------
+
+- ONOS helm chart improvements with app based liveliness and openflow ports exposure outside of the cluster
+- Static code analysis (SCA) checks for the different services’ repo.
+
+Test
+----
+
+Voltha-2.5 tests are available on `Jenkins <https://jenkins.opencord.org/view/VOLTHA%202.5/>`_.
+
+- OLT Disable/enable test, ONOS HA test and some more
+- BBSim Turk Telekom workflow support
+- Turk Telekom scale job with 1 OLT 512 ONUs
+- Initial Soak testing
+- Initial Load measurement
+- Openolt-scale-tester enhancements to provision up to 64 subscribers in parallel
+
+Design Discussions
+------------------
+
+- Error handling within the VOLTHA stack
+- ONU software upgrades, and upgrades of the VOLTHA/ONOS stack
+- OLT Software upgrade through DMI and standby/active partition
+- Distinction between OLT reboot and openolt agent disconnect
+- Security/ encryption through certs on gRPC channels (e.g. openolt agent-adapter)
+- Initial evaluation of kafka to gRPC swap
+- Moving flow replication down to the openolt agent
+- LAG support
+- Mac-learning as HostLocationProvider with security
+
+Documentation
+-------------
+
+- Updated documentation with workflow specific orientation and published on https://docs.voltha.org
+
+Known Issues
+------------
+
+- `VOL-3377 <https://jira.opencord.org/browse/VOL-3377>`_: The in-band interface on the OLT does not get IP sometimes.
+ The workaround is to reboot the OLT through a watchdog script after a timeout waiting to get the IP.
+- `VOL-3521 <https://jira.opencord.org/browse/VOL-3521>`_: At scale: intermittent issue in AT&T workflow -
+ VOLTHA complains that different meter is in use for subscriber
+- `VOL-3499 <https://jira.opencord.org/browse/VOL-3499>`_ and `VOL-3500 <https://jira.opencord.org/browse/VOL-3500>`_:
+ At scale: intermittent failures in TT workflow for DHCP relay
+- `VOL-3419 <https://jira.opencord.org/browse/VOL-3419>`_:
+ At scale: OpenOLT adapter constantly takes more that 10 seconds to react to flows
+
+
+Component Versions in VOLTHA 2.5 release
+----------------------------------------
+
+ONOS Apps:
+++++++++++
+
+- `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_: ``2.1.0``
+- `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_: ``2.2.2``
+- `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_: ``2.1.2``
+- `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_: ``2.4.0``
+- `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_: ``2.1.0``
+- `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_: ``4.2.1``
+- `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_: ``5.1.0``
+
+VOLTHA Components:
+++++++++++++++++++
+
+`kind-voltha <https://gerrit.opencord.org/gitweb?p=kind-voltha.git>`_ - ``5.1.6``
+
+`Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``2.5.2``
+
+- `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`_- ``1.1.3`` with `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_ ``4.0.3``
+- `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``2.5.4`` with chart ``2.6.4``
+- `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``1.3.2`` with chart ``2.6.4``
+- `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_ - ``1.2.1``
+- `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``2.5.6`` with chart ``2.6.4``
+- `voltha-openonu-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``2.5.0`` with chart ``2.5.0``
+- `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``4.1.8`` with chart ``0.1.8``
+- `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree;h=refs/heads/voltha-2.5>`_ - ``2.5.1``
+
+**Available from EdgeCore site**
+
+- Out of band management
+
+ - ONL version (both GPON and XGSPON) ONL-onl-4.14_ONL-OS8_2020-04-14.1946-72b95a7_AMD64_INSTALLED_INSTALLER available
+ at /ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution
+ - ``openolt_asfvolt16-2.5.1-cb175000207c7dc9b1468189290ee3df80fadb4a.deb`` for ASFVOLT16 available at
+ /ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/voltha-2.5/OUT-OF-BAND
+ - ``openolt_asgvolt64-2.5.1-cb175000207c7dc9b1468189290ee3df80fadb4a.deb`` for ASGVOLT64 available at
+ /ASGvOLT64/OpenOLT_Agent/From_ONF_Distribution/voltha-2.5
+
+- In band management
+
+ - use ONL image, comprising of Bal and openolt (available from edgecore site) for ASFVOLT16
+ ``ONL-onl-4.14_ONL-OS8_2020-09-27.2315-72b95a7_AMD64_INSTALLED_INSTALLER-asfvolt16-inband-BAL3.4.7.5`` available at
+ /ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/voltha-2.5/IN-BAND
+
+Get access credentials for https://edgecore.quickconnect.to and then login
+and navigate to File_Station -> EdgecoreNAS, and then the folder
+/ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ and pick the version above