Add golang notes to release checklist. Add version strings for sadis, aaa and dhcpl2relay in release notes
Change-Id: Ia1719de83ed7d2c0a1fee96bfc31369ef448e358
diff --git a/VERSION b/VERSION
index faad078..198d0ef 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.4.1
+2.12.4.2-dev
diff --git a/config.mk b/config.mk
index 2add84e..1a6c595 100644
--- a/config.mk
+++ b/config.mk
@@ -38,6 +38,7 @@
##-----------------------------##
##---] Custom exclusions [---##
##-----------------------------##
+lint-doc8-excl += --ignore-path '_build'
lint-doc8-excl += --ignore-path "vendor"
config-mk-version := 1.0
diff --git a/howto/release/checklist.rst b/howto/release/checklist.rst
index 10c22b9..66cd045 100644
--- a/howto/release/checklist.rst
+++ b/howto/release/checklist.rst
@@ -56,3 +56,60 @@
-----------
Once dependent packages are built update helm charts: charts/index
+
+Voltha with golang source
+-------------------------
+
+Review all repositories that contain golang sources.
+Version(s) of external packages in the vendor/ directory may need to be updated.
+
+.. code-block: shell-session
+ :linenos:
+ :hilight: 2, 4
+
+ # Clone repo:voltha-go
+ git clone ssh://gerrit.opencord.org:29418/voltha-go.git
+
+ cd voltha-go
+ make help
+
+.. list-table:: make targets
+ :header-rows: 1
+ :widths: 20,50
+
+ * - Command
+ - Description
+ * - make lint
+ - syntax check sources
+ * - make lint-dockerfile
+ - syntax check docker config
+ * - make lint-mod
+ - syntax check golang dependencies
+
+.. list-table:: build & test targets
+ :header-rows: 1
+ :widths: 20,50
+
+ * - Command
+ - Description
+ * - make build
+ - Build core docker image
+ * - make test
+ - Requires docker, test local build
+ * - make sca
+ - Generate a static code analysis report
+
+.. list-table:: Developer targets
+ :header-rows: 1
+ :widths: 20,50
+
+ * - Command
+ - Description
+ * - make local-lib-go
+ - Create a local version of voltha-lib-go beneath vendor/
+ * - make local-protos
+ - Create a local version of voltha-protos beneath vendor/
+ * - make fmt
+ - Run gofmt on sources
+ * - make mod-update
+ - Update go mod files
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index d72cbca..25ad44f 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -59,9 +59,6 @@
Component Versions in VOLTHA 2.12 release
-----------------------------------------
-Component Versions in VOLTHA 2.11 release
------------------------------------------
-
ONOS and Atomix
+++++++++++++++
@@ -89,13 +86,13 @@
-
* - `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``
-
-
-
@@ -104,7 +101,7 @@
+++++++++
.. list-table:: ONOS Apps
- :widths: 30, 5, 5, 5, 5, 5
+ :widths: 30, 5, 5, 5, 5, 5, 5
:header-rows: 2
* - Component
@@ -113,24 +110,306 @@
- with
- Gerrit
- Github
+ - Release
* - Name
- Version
- Version
- Chart
- URL
- URL
+ - Status
+ * -
+ -
+ -
+ -
+ -
+ -
+ -
+ * - `aaa <https://gerrit.opencord.org/gitweb?p=aaa.git;a=summary>`_
+ - N/A
+ - `2.10.3 <https://central.sonatype.com/artifact/org.opencord/aaa/2.10.3>`_
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/aaa/+/refs/tags/2.10.3>`__
+ - `X <https://github.com/opencord/aaa/tree/2.10.3>`__
+ -
+ * - `bng <https://gerrit.opencord.org/gitweb?p=bng.git;a=summary>`_
+ -
+ - ``2.4.0``
+ -
+ - `X <https://github.com/opencord/bng/tree/2.4.0>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/bng/+/refs/tags/2.4.0>`__
+ - !
+ * - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`_
+ -
+ - `2.10.0 <https://central.sonatype.com/artifact/org.opencord/dhcpl2relay/2.10.0>`_
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/dhcpl2relay/+/refs/tags/2.10.0>`__
+ - `X <https://github.com/opencord/dhcpl2relay/tree/2.10.0>`__
+ -
+ * - `igmpproxy <https://gerrit.opencord.org/gitweb?p=igmpproxy.git;a=summary>`_
+ -
+ - ``2.7.0``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/igmpproxy/+/refs/tags/2.7.0>`__
+ - `X <https://github.com/opencord/igmpproxy/tree/2.7.0>`__
+ - !
+ * - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`_
+ -
+ - ``2.11.1``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/kafka-onos/+/refs/tags/2.11.1>`__
+ - `X <https://github.com/opencord/kafka-onos/tree/2.11.1>`__
+ - !
+ * - `mcast <https://gerrit.opencord.org/gitweb?p=mcast.git;a=summary>`_
+ -
+ - ``2.8.0``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/mcast/+/refs/tags/2.8.0>`__
+ - `X <https://github.com/opencord/mcast/tree/2.8.0>`__
+ - !
+ * - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`_
+ -
+ - ``5.2.3``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/olt/+/refs/tags/5.2.3>`__
+ - `X <https://github.com/opencord/olt/tree/5.2.3>`__
+ - !
+ * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_
+ -
+ - `5.11.1 <https://central.sonatype.com/artifact/org.opencord/sadis/5.11.1>`_
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/tags/5.11.1>`__
+ - `X <https://github.com/opencord/sadis/tree/5.11.1>`__
+ -
+ * - `pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`_
+ -
+ - ``1.2.0``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/+/refs/tags/1.2.1>`__
+ - `X <https://github.com/opencord/pppoeagent/tree/1.2.1>`__
+ - !
+ * - `olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`_
+ -
+ - ``1.2.0``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/olttopology/+/refs/tags/1.2.1>`__
+ - `X <https://github.com/opencord/olttopology/tree/1.2.1>`__
+ - !
+
+VOLTHA Components
++++++++++++++++++
+
+.. list-table:: VOLTHA Components
+ :widths: 30, 5, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ - `Docker <https://hub.docker.com/search?q=voltha>`_
+ * - Name
+ - Version
+ - Version
+ - `with Chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
+ - ULR
+ - URL
+ - URL
* -
-
-
-
-
-
- * - `sadis <https://gerrit.opencord.org/gitweb?p=sadis.git;a=summary>`_
-
- - ``5.11.0``
+ * - `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_
+ - ``3.2.2-dev1``
-
- - `X <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/tags/5.11.0>`__
- - `5.10.0 <https://github.com/opencord/sadis/tree/5.10.0>`__
+ -
+ - `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://github.com/opencord/bbsim/tree/v1.14.4>`__
+ - `X <https://hub.docker.com/layers/voltha/bbsim/1.14.4/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
+ * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`_
+ -
+ - ``0.3.4``
+ - `0.3.2 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/bbsim-sadis-server/Chart.yaml>`_
+ - `X <https://gerrit.opencord.org/plugins/gitiles/bbsim-sadis-server/+/refs/tags/v0.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.1.3``
+ - ``2.1.3``
+ - ``2.11.3``
+ -
+ - `X <https://github.com/opencord/ofagent-go>`__
+ - `1.1.4-? <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
+ * - `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_
+ -
+ - ``4.2.12``
+ -
+ -
+ - `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.8``
+ - docker
+ - ``2.11.3``
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-go/+/refs/tags/v3.1.8>`__
+ - `X <https://github.com/opencord/voltha-go/tree/v3.1.8>`__
+ -
+ * - `voltha-lib-go <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go>`_
+ - ``2.11.3 (?)``
+ - ``7.3.2``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/tags/v7.3.2>`__
+ - `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.3.2>`__
+ -
+ * - `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.3>`__
+ - `X <https://github.com/opencord/voltha-onos/tree/5.1.3>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.3/images/sha256-d9c686acf177ed823ff359dc43ba59aab05ae067be27c92e48c08b72f94b9ca3?context=explore>`__
+ * - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
+ -
+ - ``2.7.3``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter-go/+/refs/tags/v2.7.3>`__
+ - `X <https://github.com/opencord/voltha-openonu-adapter-go/tree/v2.7.3>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-openonu-adapter-go/2.7.3/images/sha256-e9484a8963d08748af5766a6a8ce7f7485efb384488bcf93840ecc1142d7ad74?context=explore>`__
+ * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
+ - ``v4.2.12``
+ - ``4.2.6``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.2.12>`__
+ - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.2.12>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.2.12/images/sha256-844eac272323dc8bca10880a111957a95839578b3210dd777be5ac9370aaa52e?context=explore>`__
+ * - `voltha-protos <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`_
+ -
+ - `5.3.8 <https://pypi.org/project/voltha-protos/5.3.8>`__
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.3.8>`__
+ - `X <https://github.com/opencord/voltha-protos/tree/v5.3.8>`__
+ -
+ * - `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>`__
+ -
+ * - maclearner
+ - ``1.2.1``
+ -
+ -
+ -
+ -
+ -
+ * - ppoeagent
+ - ``1.2.1``
+ -
+ -
+ -
+ -
+ -
+ * - segmentrouting
+ - ``3.0.0``
+ -
+ -
+ -
+ -
+ -
+
+
+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, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - with Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - Voltha-infra
+ - ``2.10.10``
+ -
+ -
+ -
+ -
+ * - Voltha-stack
+ - ``2.10.10``
+ -
+ -
+ -
+ -
+
+BAL Version
++++++++++++
+
+.. list-table:: Helm Chart Versions
+ :widths: 30, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ * - Name
+ - Version
+ - Version
+ - with Chart
+ - URL
+ - URL
+ * -
+ -
+ -
+ -
+ -
+ -
+ * - Broadcom abstraction layer (BAL)
+ -
+ - ``3.10.2.2``
+ -
+ -
+ -
+
+|
Helm Chart Versions
+++++++++++++++++++