VOL-4890 - Create a v2.11 release notes page
conf.py
-------
o Fixed voltha-helm-charts/README, rendering/viewing is html -vs- rst.
index.rst
release_notes/index.rst
-----------------------
o Move legacy release notes from the top level index into release_notes/index.rst.
o Manually sort files for display, sphinx alpha-sorted v2.11 before v2.2.
overview/contributing.rst
logging/centralised_log_analysis.rst
------------------------------------
o Update web redirected URLs so they stop being logged by "make linkcheck".
release_notes/voltha_2.11.rst
-----------------------------
o Update version strings to the latest captured in master/VERSION.
o Added convenience URLs for gerrit, github and helm charts.
o Change table format from csv to list-table:
- Improve readability and maintainability.
- Avoid run-on sentences, embedded urls span 4+ lines.
- Also corrected a few lint/syntax checking problems due to line length.
Change-Id: I0a93d27884712b512957ae04f7f2f4f9f2952ec1
diff --git a/VERSION b/VERSION
index ccb309c..82a1ba0 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.11.0-dev1
+2.11.0-dev2
diff --git a/conf.py b/conf.py
index fc4b455..78b1d20 100644
--- a/conf.py
+++ b/conf.py
@@ -303,6 +303,8 @@
r'../release_notes/voltha_2.9.html',
r'../release_notes/voltha_2.10.html',
r'../release_notes/voltha_2.11.html',
+ #
+ r'../voltha-helm-charts/README.html',
]
# -- Configure recommonmark to use AutoStructify -----------------------------
diff --git a/index.rst b/index.rst
index eae1574..7fc685e 100644
--- a/index.rst
+++ b/index.rst
@@ -201,7 +201,8 @@
:caption: Releases
:glob:
- release_notes/*
+ release_notes/release_process.rst
+ release_notes/index.rst
.. toctree::
:maxdepth: 2
diff --git a/logging/centralised_log_analysis.rst b/logging/centralised_log_analysis.rst
index 91cf309..61af969 100644
--- a/logging/centralised_log_analysis.rst
+++ b/logging/centralised_log_analysis.rst
@@ -79,7 +79,7 @@
To enable TLS/SSL encryption for elasticsearch pod refer the following
link
-`*https://github.com/elastic/helm-charts/tree/master/elasticsearch/examples/security* <https://github.com/elastic/helm-charts/tree/master/elasticsearch/examples/security>`__
+`*helm-charts::elasticsearch/examples/security* <https://github.com/elastic/helm-charts/tree/main/elasticsearch/examples/security>`__
To enable TLS/SSL encryption for kibana pod refer the following link
diff --git a/overview/contributing.rst b/overview/contributing.rst
index bfb14b1..019f1da 100644
--- a/overview/contributing.rst
+++ b/overview/contributing.rst
@@ -209,5 +209,6 @@
Community Guidelines
--------------------
-This project follows `Google's Open Source Community Guidelines <https://opensource.google.com/conduct/>`_
+This project follows `Google's Open Source Community Guidelines <https://opensource.google/conduct/>`_
+
and ONF's [Code of Conduct](CODE_OF_CONDUCT.md).
diff --git a/release_notes/index.rst b/release_notes/index.rst
new file mode 100644
index 0000000..7c3ca31
--- /dev/null
+++ b/release_notes/index.rst
@@ -0,0 +1,16 @@
+Release Notes
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ voltha_2.11.rst
+ voltha_2.10.rst
+ voltha_2.9.rst
+ voltha_2.8.rst
+ voltha_2.7.rst
+ voltha_2.6.rst
+ voltha_2.5.rst
+ voltha_2.4.rst
+ voltha_2.3.rst
+ voltha_2.2.rst
diff --git a/release_notes/see_also b/release_notes/see_also
new file mode 100644
index 0000000..4a16d82
--- /dev/null
+++ b/release_notes/see_also
@@ -0,0 +1 @@
+https://github.com/opencord
diff --git a/release_notes/voltha_2.11.rst b/release_notes/voltha_2.11.rst
index ac932b3..229e6b9 100644
--- a/release_notes/voltha_2.11.rst
+++ b/release_notes/voltha_2.11.rst
@@ -54,86 +54,315 @@
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.
-Component Versions in VOLTHA 2.10 release
+Component Versions in VOLTHA 2.11 release
-----------------------------------------
-ONOS and Atomix:
-++++++++++++++++
+ONOS and Atomix
++++++++++++++++
-.. csv-table::
- :header: "Component", "Version"
- :widths: 30, 10
+.. list-table:: ONOS and Atomix
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
- "`ONOS 2.5 LTS <https://github.com/opennetworkinglab/onos/releases/tag/2.5.8>`_", "``2.5.8``"
- "`ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_", "``3.1.9``"
+ * - Component
+ - VOLTHA
+ - Component
+ - with
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - `ONOS 2.5 LTS <https://github.com/opennetworkinglab/onos/releases/tag/2.5.8>`_
+ -
+ - ``2.5.8``
+ -
+ -
+ -
+ * - `ATOMIX <https://github.com/atomix/atomix/releases/tag/atomix-3.1.9>`_
+ -
+ - ``3.1.9``
+ -
+ -
+ -
-ONOS Apps:
-++++++++++
+ONOS Apps
++++++++++
-.. csv-table::
- :header: "Component", "Version"
- :widths: 30, 10
+.. list-table:: ONOS Apps
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
- "`aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_", "``2.6.0``"
- "`dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_", "``2.6.0``"
- "`igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_", "``2.5.0``"
- "`kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_", "``2.9.0``"
- "`mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_", "``2.6.0``"
- "`olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_", "``5.1.2``"
- "`sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_", "``5.6.0``"
- "`bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`_", "``2.2.0``"
- "`pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`_", "``1.2.0``"
- "`olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`_", "``1.2.0``"
+ * - Component
+ - VOLTHA
+ - Component
+ - with
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
+ -
+ - ``2.6.0``
+ -
+ -
+ -
+ * - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_
+ -
+ - ``2.6.0``
+ -
+ -
+ -
+ * - `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_
+ -
+ - ``2.5.0``
+ -
+ -
+ -
+ * - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_
+ -
+ - ``2.9.0``
+ -
+ -
+ -
+ * - `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_
+ -
+ - ``2.6.0``
+ -
+ -
+ -
+ * - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_
+ -
+ - ``5.1.2``
+ -
+ -
+ -
+ * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_
+ -
+ - ``5.6.0``
+ -
+ -
+ -
+ * - `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`_
+ -
+ - ``2.2.0``
+ -
+ -
+ -
+ * - `pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`_
+ -
+ - ``1.2.0``
+ -
+ -
+ -
+ * - `olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`_
+ -
+ - ``1.2.0``
+ -
+ -
+ -
-VOLTHA Components:
-++++++++++++++++++
+VOLTHA Components
++++++++++++++++++
-.. csv-table::
- :header: "Component", "Version", "Chart", "Version"
- :widths: 30, 10, 10, 10
+.. list-table:: VOLTHA Components
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
- "`Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_", "``3.1.4``", "", ""
- "`bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`_", "``1.12.10``", "`chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_", "``4.8.6``"
- "`Bbsim-sadis-server <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`_", "``0.3.4``", "?", "``0.3.1``"
- "`ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_", "``2.1.2``", "?", "``2.11.3``"
- "`openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_", "``3.7.5``", "?", ""
- "`voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_", "``1.7.6``", "?", ""
- "`voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_", "``3.1.5``", "?", "``2.11.3``"
- "`voltha-lib-go <https://github.com/opencord/voltha-lib-go/releases/tag/v7.1.7>`_", "``7.1.7``", "?", ""
- "`voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_", "``5.1.1``", "?", "``0.1.27``"
- "`voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_", "``4.2.6``", "?", "``2.11.3``"
- "`voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_", "``2.2.8``", "?", "``2.10.3``"
- "`voltha-protos <https://github.com/opencord/voltha-protos/releases/tag/v5.2.5>`_", "``5.2.5``", "?", ""
- "`voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`_", "``2.10.1``", "?", ""
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - with Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_
+ - ``3.2.1-dev1``
+ -
+ -
+ - `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>`_
+ - ``1.14.4``
+ - ``4.8.6``
+ - `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.2.10>`__
+ - `X <https://github.com/opencord/bbsim/tree/v1.14.4>`__
+ * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`_
+ -
+ - ``0.3.4``
+ -
+ -
+ - `X <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`__
+ * - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
+ - ``2.11.3``
+ - ``2.1.2``
+ -
+ -
+ - `X <https://github.com/opencord/ofagent-go>`__
+ * - `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_
+ -
+ - ``3.7.5``
+ -
+ -
+ - `X <https://github.com/opencord/openolt>`__
+ * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
+ - ``1.8.3``
+ -
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
+ - `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
+ * - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
+ - ``3.1.7``
+ -
+ - ``2.11.3``
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-go/+/refs/tags/v3.1.7>`__
+ - `X <https://github.com/opencord/voltha-go/tree/v3.1.7>`__
+ * - `voltha-lib-go <https://gerrit.opencord.org/gitweb?p=voltha-lib-go.git;a=tree>`_
+ - ``2.11.3``
+ - ``7.3.1``
+ -
+ -
+ - `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.3.1>`__
+ * - `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_
+ -
+ - ``5.1.2``
+ - ``0.1.27``
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-onos/+/refs/tags/5.1.2>`__
+ - `X <https://github.com/opencord/voltha-onos/tree/5.1.2>`__
+ * - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
+ - ``2.7.2``
+ - ``2.10.3``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter-go/+/refs/tags/v2.7.2>`__
+ - `X <https://github.com/opencord/voltha-openonu-adapter-go/tree/v2.7.2>`__
+ * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
+ - ``master: v4.2.11``
+ - ``4.2.6``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.2.10>`__
+ - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.2.11>`__
+ * - `voltha-protos <https://github.com/opencord/voltha-protos/releases/tag/v5.2.5>`__
+ - ``master: 5.3.6``
+ - ``5.3.6``
+ -
+ - `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>`_
+ - ``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:
-++++++++++++++++++++
+Helm Chart Versions
++++++++++++++++++++
This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
-.. csv-table::
- :header: "Component", "Version"
- :widths: 30, 10
+.. list-table:: Helm Chart Versions
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
- "Voltha-infra", "``2.10.7``"
- "Voltha-stack", "``2.10.5``"
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - with Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - Voltha-infra
+ - ``2.10.7``
+ -
+ -
+ -
+ -
+ * - Voltha-stack
+ - ``2.10.5``
+ -
+ -
+ -
+ -
-BAL Version:
-++++++++++++
+BAL Version
++++++++++++
-.. csv-table::
- :header: "Component", "Version"
- :widths: 30, 10
+.. list-table:: Helm Chart Versions
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
- "Broadcom abstraction layer (BAL)", "``3.10.2.2``"
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - with Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - Broadcom abstraction layer (BAL)
+ -
+ - ``3.10.2.2``
+ -
+ -
+ -
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.10`` or
-``/ASGvOLT64/OpenOLT_Agent/From_ONF_Distribution/voltha-2.10`` based on ``ASXvOLT16`` or ``ASGvOLT64`` platform,
+``/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``
@@ -141,8 +370,8 @@
**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.10 release
+to get the OLT debian package validated on 3200G, 1600x and 1600G platforms for VOLTHA-2.11 release
**Zyxel**
Please write to `Emanuel Villalobos <Emanuel.Villalobos@zyxel.com.tw>`_
-to get the OLT debian package validated on the SDA3016SS for VOLTHA-2.10 release.
+to get the OLT debian package validated on the SDA3016SS for VOLTHA-2.11 release.