Add Voltha 2.14 release notes
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: I3ad8efe7512d35d5be159c79e258145629c8b4da
diff --git a/release_notes/index.rst b/release_notes/index.rst
index deb7fa7..b695638 100644
--- a/release_notes/index.rst
+++ b/release_notes/index.rst
@@ -4,6 +4,7 @@
.. toctree::
:maxdepth: 1
+ voltha_2.14.rst
voltha_2.13.rst
voltha_2.12.rst
voltha_2.11.rst
diff --git a/release_notes/voltha_2.14.rst b/release_notes/voltha_2.14.rst
new file mode 100644
index 0000000..9c9a8c3
--- /dev/null
+++ b/release_notes/voltha_2.14.rst
@@ -0,0 +1,478 @@
+.. figure:: images/voltha.svg
+ :alt: voltha- Release Notes
+ :width: 40%
+ :align: center
+
+
+VOLTHA 2.14 Release Notes
+=========================
+
+
+New Features
+------------
+
+- Multiple NNI support
+
+- On demand stats on OLT and ONT
+
+- Support for LINECARD reset in DMI
+
+
+Improvements to existing features
+---------------------------------
+
+- Optimization on call flow on ONU reboot
+
+- Several third party library updates across all components
+
+- Go version upgrade
+
+
+Bug Fixes
+---------
+For 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>`_
+
+
+Documentation
+-------------
+
+As usual documentation is published on https://docs.voltha.org
+
+
+Known Issues
+------------
+.. list-table:: Known Issues
+ :widths: 10, 40
+ :header-rows: 1
+
+ * - Jira
+ - Description
+ * - `VOL-5427 <https://lf-broadband.atlassian.net/browse/VOL-5427>`_
+ - Multicast does not work for GPON TT test pipeline
+ * - `VOL-5426 <https://lf-broadband.atlassian.net/browse/VOL-5426>`_
+ - ONUs not in the state expected by the tests
+
+
+Jira stories
+------------
+A full list of stories and bugs completed can be found under the
+`VOLTHA 2.14 <https://lf-broadband.atlassian.net/projects/VOL/versions/10023>`_ release page in Jira.
+
+
+Component Versions in VOLTHA 2.14 release
+-----------------------------------------
+
+ONOS and Atomix
++++++++++++++++
+
+.. list-table:: ONOS and Atomix
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - Component
+ - with
+ - Gerrit
+ - Github
+ * - Name
+ - Ver
+ - Ver
+ - Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - 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>`_
+ - ``2.5.5``
+ - ``2.5.9``, ``2.5.8``
+ -
+ -
+ -
+ * - `ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_
+ -
+ - ``3.1.9``
+ -
+ -
+ -
+
+ONOS Components
++++++++++++++++
+
+.. list-table:: ONOS Components
+ :widths: 10, 2, 2, 2, 2, 2, 2, 2
+ :header-rows: 2
+
+ * - Component
+ - Artifact
+ - Api
+ - App
+ - Pkg
+ - Gerrit
+ - Github
+ - Released
+ * - Name
+ - Ver
+ - Ver
+ - Ver
+ - Ver
+ - URL
+ - URL
+ -
+ * -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ * - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
+ - :mvn-cord:`2.11.2 <aaai/2.11.2>`
+ - :mvn-cord:`X <aaa-api/2.11.2>`
+ - :mvn-cord:`X <aaa-app/2.11.2>`
+ - :mvn-cord:`X <aaa/2.11.2>`
+ - :vol-ger:`X <aaa/+/refs/tags/2.11.2>`
+ - :vol-git:`X <aaa/releases/tag/2.11.2>`
+ -
+ * - `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`__
+ - :mvn-cord:`2.5.3 <bng/2.5.3>`
+ - :mvn-cord:`X <bng-api/2.5.3>`
+ - :mvn-cord:`X <bng-app/2.5.3>`
+ - :mvn-cord:`X <bng/2.5.3>`
+ - :vol-ger:`X <bng/+/refs/tags/2.5.3>`
+ - :vol-git:`X <bng/releases/tag/2.5.3>`
+ -
+ * - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`__
+ - :mvn-cord:`2.11.2 <dhcpl2relay/2.11.2>`
+ - :mvn-cord:`X <dhcpl2relay-api/2.11.2>`
+ - :mvn-cord:`X <dhcpl2relay-app/2.11.2>`
+ - :mvn-cord:`X <dhcpl2relay>`
+ - :vol-ger:`X <dhcpl2relay/+/refs/tags/2.11.2>`
+ - :vol-git:`X <dhcpl2relay/releases/tag/2.11.2>`
+ -
+ * - `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`__
+ - :mvn-cord:`2.9.1 <onos-app-igmpproxy/2.9.1>`
+ - :mvn-cord:`X <onos-app-igmpproxy-api/2.9.1>`
+ - :mvn-cord:`X <onos-app-igmpproxy-app/2.9.1>`
+ - :mvn-cord:`X <onos-app-igmpproxy/2.9.1>`
+ - :vol-ger:`X <igmpproxy/+/refs/tags/2.9.1>`
+ - :vol-git:`X <igmpproxy/releases/tag/2.9.1>`
+ -
+ * - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`__
+ - :mvn-cord:`2.13.3 <kafka/2.13.3>`
+ - :mvn-cord:`X <kafka-api/2.13.3>`
+ - :mvn-cord:`X <kafka-app/2.13.3>`
+ - :mvn-cord:`X <kafka/2.13.3>`
+ - :vol-ger:`X <kafka-onos/+/refs/tags/2.13.3>`
+ - :vol-git:`X <kafka-onos/releases/tag/2.13.3>`
+ - ``N``
+ * - :vol-ger:`maclearner <mac-learning>`
+ - :mvn-cord:`1.2.4 <maclearner/1.2.4>`
+ - :mvn-cord:`X <maclearner-api/1.2.4>`
+ - :mvn-cord:`X <maclearner-app/1.2.4>`
+ - :mvn-cord:`X <maclearner>`
+ - :vol-ger:`X <mac-learning/+/refs/tags/1.2.4>`
+ - :vol-git:`X </mac-learning/releases/tag/1.2.4>`, :vol-git:`T <mac-learning/tree/1.2.4>`
+ -
+ * - `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`__
+ - :mvn-cord:`2.9.3 <mcast/2.9.3>`
+ - :mvn-cord:`X <mcast-api/2.9.3>`
+ - :mvn-cord:`X <mcast-app/2.9.3>`
+ - :mvn-cord:`X <mcast/2.9.3>`
+ - :vol-ger:`X <mcast/+/refs/tags/2.9.3>`
+ - :vol-git:`X </mcast/releases/tag/2.9.3>`, :vol-git:`T <mcast/tree/2.9.3>`
+ -
+ * - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`__
+ - :mvn-cord:`5.2.8 <olt/5.2.8>`
+ - :mvn-cord:`X <olt-api/5.2.8>`
+ - :mvn-cord:`X <olt-app/5.2.8>`
+ - :mvn-cord:`X <olt/5.2.8>`
+ - :vol-ger:`X <olt/+/refs/tags/5.2.8>`
+ - :vol-git:`X <olt/releases/tag/5.2.8>`
+ -
+ * - :vol-ger:`olttopology <olttopology/>`
+ - :mvn-cord:`1.3.1 <olttopology/1.3.1>`
+ - :mvn-cord:`X <olttopology-api/1.3.1>`
+ - :mvn-cord:`X <olttopology-app/1.3.1>`
+ - :mvn-cord:`X <olttopology>`
+ - :vol-ger:`X <olttopology/+/refs/tags/1.3.1>`
+ - :vol-git:`X <olttopology/releases/tag/1.3.1>`
+ -
+ * - :vol-ger:`pppoeagent <pppoeagent/>`
+ - :mvn-cord:`1.3.2 <pppoeagent/1.3.2>`
+ - :mvn-cord:`X <pppoeagent-api/1.3.2>`
+ - :mvn-cord:`X <pppoeagent-app/1.3.2>`
+ - :mvn-cord:`X <pppoeagent>`
+ - :vol-ger:`X <pppoeagent/+/refs/tags/1.3.2>`
+ - :vol-git:`X <pppoeagent/releases/tag/1.3.2>`
+ -
+ * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`__
+ - :mvn-cord:`5.12.3 <sadis/5.12.3>`
+ - :mvn-cord:`X <sadis-api/5.12.3>`
+ - :mvn-cord:`X <sadis-app/5.12.3>`
+ - :mvn-cord:`X <sadis>`
+ - :vol-ger:`X <sadis/+/refs/tags/5.12.3>`
+ - :vol-git:`X <sadis/releases/tag/5.12.3>`
+ -
+
+- See Also
+
+ - :ref:`Release Notes Legend for ONOS Components`
+ - `Docker Images: opencord <https://hub.docker.com/search?q=opencord>`_
+
+
+VOLTHA Components
++++++++++++++++++
+
+.. list-table:: VOLTHA Components
+ :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - :vol-ger:`Chart.yaml <voltha-helm-charts/+/refs/heads/master>`
+ - `Gerrit <https://gerrit.opencord.org/admin/repos>`_
+ - :vol-git:`Github<>`
+ - `Docker <https://hub.docker.com/search?q=voltha>`_
+ - `Golang <https://pkg.go.dev>`_
+ - `Pypi <https://pypi.org>`_
+ * - Name
+ - Version
+ - Version
+ - ULR
+ - URL
+ - URL
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ * - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
+ - :vol-ger:`2.3.2 <ofagent-go/+/refs/heads/voltha-2.14/VERSION>`
+ - ``N/A``
+ - :vol-ger:`X <ofagent-go/+/refs/tags/v2.3.2>`
+ - :vol-git:`X <ofagent-go/releases/tag/v2.3.2>`
+ - `1.1.4(stale) <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
+ - `1.6.5(stale) <https://pkg.go.dev/github.com/opencord/ofagent-go/cmd/ofagent>`_
+ -
+ * - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
+ - :vol-ger:`3.6.17 <voltha-go/+/refs/heads/voltha-2.14/VERSION>`
+ - ``N/A``
+ - :vol-ger:`X <voltha-go/+/refs/tags/v3.6.17>`
+ - :vol-git:`X <voltha-go/releases/tag/v3.6.17>`
+ - ``N/A``
+ - ``v7:?``
+ -
+ * - :vol-ger:`voltha-lib-go <voltha-lib-go>`
+ - :vol-ger:`7.6.8 <voltha-lib-go/+/refs/heads/master/VERSION>`
+ - ``N/A``
+ - :vol-ger:`X <voltha-lib-go/+/refs/tags/v7.6.8>`
+ - :vol-git:`X <voltha-lib-go/releases/tag/v7.6.8>`
+ - ``?``
+ - `v7 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v7@v7.6.8>`__
+ - ``?``
+ * - `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_
+ - ``5.1.10``
+ - ``0.1.27``
+ - :vol-ger:`X <voltha-onos/+/refs/tags/5.1.10>`
+ - :vol-git:`X <voltha-onos/releases/tag/5.1.10>`
+ - `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.10/images/sha256-d2498af38194a1cd01a1b9072a58af8647ed50fea2dbc9bd3ac4d4e4b583d72a?context=explore>`__
+ -
+ -
+ * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
+ - :vol-ger:`4.5.16 <voltha-openolt-adapter/+/refs/heads/voltha-2.14/VERSION>`
+ - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml#20>`
+ - :vol-ger:`X <voltha-openolt-adapter/+/refs/tags/v4.5.16>`
+ - :vol-git:`X <voltha-openolt-adapter/releases/tag/v4.5.16>`
+ - `X <https://hub.docker.com/repository/docker/voltha/voltha-openolt-adapter/tags/4.5.16/sha256-d6d79c08350a6fd9d9bd5cb121e009667421b90df280ea4bb8726525b65be295>`__
+ - ``N/A``
+ - ``N/A``
+ * - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
+ - :vol-ger:`2.12.25 <voltha-openonu-adapter-go/+/refs/heads/voltha-2.14/VERSION>`
+ - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#17>`
+ - :vol-ger:`X <voltha-openonu-adapter-go/+/refs/tags/v2.12.25>`
+ - :vol-git:`X <voltha-openonu-adapter-go/releases/tag/v2.12.25>`
+ - `X <https://hub.docker.com/repository/docker/voltha/voltha-openonu-adapter-go/tags/2.12.25/sha256-d8f2eb5f2a7e886e98a383e01ea002a22e93ac9dc6348570f457604ea8a67098>`__
+ - `stale <https://pkg.go.dev/github.com/opencord/voltha-openonu-adapter-go>`_
+ - ``N/A``
+ * - :vol-ger:`voltha-protos <voltha-protos>`
+ - :vol-ger:`5.6.5 <voltha-protos/+/refs/heads/voltha-2.14/VERSION>`
+ - ``N/A``
+ - :vol-ger:`X <voltha-protos/+/refs/tags/v5.6.5>`
+ - :vol-git:`X <voltha-protos/releases/tag/v5.6.5>`
+ - `stale <https://hub.docker.com/r/voltha/voltha-protos/tags>`__
+ - `stale <https://pkg.go.dev/github.com/opencord/voltha-protos>`__
+ - `5.6.5 <https://pypi.org/project/voltha-protos/5.6.5>`__
+ * - :vol-git:`voltha-system-tests <voltha-system-tests/releases/tag/v2.14.0>`
+ - ``v2.14.0``
+ -
+ - :vol-ger:`X <voltha-system-tests/+/refs/tags/v2.14.0>`
+ - :vol-git:`X <voltha-system-tests/tree/v2.14.0>`
+ -
+ -
+ -
+
+- See Also
+
+ - :ref:`Release Notes Legend for VOLTHA Components`
+ - `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
+
+
+VOLTHA Tools
+++++++++++++
+
+.. list-table:: VOLTHA Components
+ :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - :vol-ger:`Chart.yaml <voltha-helm-charts/+/refs/heads/master>`
+ - `Gerrit <https://gerrit.opencord.org/admin/repos>`_
+ - :vol-git:`Github<>`
+ - `Docker <https://hub.docker.com/search?q=voltha>`_
+ - `Golang <https://pkg.go.dev>`_
+ - `Pypi <https://pypi.org>`_
+ * - Name
+ - Version
+ - Version
+ - ULR
+ - URL
+ - URL
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ * - :vol-ger:`voltha-docs <voltha-docs>` , `docs.voltha.org <https://docs.voltha.org>`
+ - ``2.14.0``
+ - ``N/A``
+ - :vol-ger:`X <voltha-docs/+/refs/tags/2.14.0>`
+ - :vol-git:`X <voltha-docs/releases/tag/2.14.0>`
+ -
+ -
+ -
+ * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
+ - ``1.16.8``
+ - ``2.14.0`` :vol-ger:`chart <voltha-helm-charts/+/refs/heads/voltha-2.14/bbsim/Chart.yaml>`
+ - :vol-ger:`X <bbsim>`
+ - :vol-git:`X <bbsim/tree/v1.16.8>`
+ - `X <https://hub.docker.com/layers/voltha/bbsim/1.16.8/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
+ - ``?``
+ - ``?``
+ * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`__
+ - :vol-ger:`0.4.0 <bbsim-sadis-server/+/refs/heads/voltha-2.14/VERSION>`
+ - :vol-ger:`0.3.5 <voltha-helm-charts/+/refs/heads/voltha-2.14/voltha-infra/Chart.yaml#45>`
+ - :vol-ger:`X <bbsim-sadis-server/+/refs/tags/v0.4.0/VERSION>`
+ - :vol-git:`X <bbsim-sadis-server/releases/tag/v0.4.0>`
+ - `X <https://hub.docker.com/layers/voltha/bbsim-sadis-server/0.4.0/images/sha256-0ea9df1be13f8b1d0a8314cbf0e0800e4a4b7e2920ae3ce5e119abddb9359350?context=explore>`__
+ -
+ -
+ * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
+ - :vol-ger:`1.11.9 <voltctl/+/refs/heads/voltha-2.14/VERSION>`
+ - ``N/A``
+ - :vol-ger:`X <voltctl/+/refs/tags/v1.11.9>`
+ - :vol-git:`? <voltctl/releases/tag/v1.11.9>`
+ - ``N/A``
+ - `X <https://pkg.go.dev/github.com/opencord/voltctl@v1.11.9>`__
+ - ``N/A``
+
+
+
+Helm Chart Versions
++++++++++++++++++++
+This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
+
+.. list-table:: Helm Chart Versions
+ :widths: 30, 30
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ * - Name
+ - Version
+ * -
+ -
+ * - Helm Charts (voltha-helm-charts)
+ - :vol-ger:`3.6.0 <voltha-helm-charts/+/refs/heads/voltha-2.14/VERSION>`
+ * - Voltha
+ - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#20>`
+ * - Voltha-infra
+ - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-infra/Chart.yaml#38>`
+ * - Voltha-stack
+ - :vol-ger:`2.14.0 <voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#37>`
+
+
+Get Involved
+------------
+We'd love to accept your patches and contributions to the VOLTHA project, join the community!
+
+| 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>`__
+
+Slack
++++++
+
+ - `voltha-discuss <https://lfbroadband.slack.com/archives/C081SFNQ7JS>`_
+ - `voltha-tst <https://lfbroadband.slack.com/archives/C081JJ2K26T>`_
+
+Mailing List
+++++++++++++
+
+ - `Discuss@lists.voltha.org <https://lists.voltha.org/g/Discuss/messages>`_
+
+Bi-Weekly TST Meetings
+++++++++++++++++++++++
+
+ - `Calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/broadband-fund?view=month>`_
+ - `Rolling Agenda/Minutes <https://lf-broadband.atlassian.net/wiki/spaces/HOME/pages/6291531/Running+VOLTHA+TST+Meeting+Minutes>`_
+
+Websites
+++++++++
+
+ - `VOLTHA <https://lfbroadband.org/projects/voltha/>`_
+ - `docs.voltha.org <https://docs.voltha.org>`_
+ - `Wiki <https://lf-broadband.atlassian.net/wiki>`_
+
+|