[VOL-5252] Update release matrix for repo:voltha-openonu-adapter-go
release_notes/voltha_2.12.rst
-----------------------------
o Update release matrix with onu-adapter-go artifact and chart version.
howto/release/tasks/charts.rst
------------------------------
o Create an anchored document for chart editing.
o This common document can then be referenced by per-repo chart edit docs.
howto/release/charts/notes.rst
howto/release/charts/voltha-openolt-adapter.rst
howto/release/charts/voltha-openonu-adapter.rst
-----------------------------------------------
o Document edits for openonu.
o Re-arrange some of the content.
howto/code/index.rst
howto/code/lint/
howto/code/linting.rst
----------------------
o Move help topics lint-chart and lint-helm into an individual rst file.
o This helps support creation of an anchor for document linking.
Change-Id: I03bf4742a3ce8075c93827004466f9c1d7408859
diff --git a/howto/release/charts/notes.rst b/howto/release/charts/notes.rst
index b1a4f20..1851adb 100644
--- a/howto/release/charts/notes.rst
+++ b/howto/release/charts/notes.rst
@@ -6,7 +6,7 @@
- For release remove all version decorations: -dev, -SNAPSHOT
-- Release job will `publish to <https://gerrit.opencord.org/plugins/gitiles/cord-charts-repo/+/refs/heads/master>`_.
+- Release job will publish to `cord-charts-repo <https://gerrit.opencord.org/plugins/gitiles/cord-charts-repo/+/refs/heads/master>`_.
- lint/syntax checking
@@ -18,5 +18,3 @@
----
- Update ONOS components `voltha-infra/values.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-infra/values.yaml>`_
-
-
diff --git a/howto/release/charts/voltha-openolt-adapter.rst b/howto/release/charts/voltha-openolt-adapter.rst
index 86de231..e3aeb73 100644
--- a/howto/release/charts/voltha-openolt-adapter.rst
+++ b/howto/release/charts/voltha-openolt-adapter.rst
@@ -2,15 +2,8 @@
## HOWTO: Helm Chart Update
-.. code-block:: shell-session
- :caption: Cookbook of edits
-
- % git clone "ssh://gerrit.opencord.org:29418/voltha-helm-charts.git"
- % cd voltha-helm-charts
- % vi $(grep -r 'adapter' . | cut -d: -f1 | sort -u)
-
- % make lint-chart
- % make lint-helm
+- Update copyright notices :ref:`Release Task Copyright`
+- Update VOLTHA artifact and chart versions :ref:`Release Task Helm Charts`
- Increment repository `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/heads/master/VERSION>`_. Build, test and deploy.
- Modify repo:voltha-helm-charts
@@ -42,9 +35,12 @@
* - `voltha-adapter-openolt/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml>`_
- Chart.yaml : appVersion
- Assign `repo:voltha-openolt-adapter::VERSION <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/heads/master/VERSION>`_ to `Chart.yaml::appVersion <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml#35>`_
+ * - `voltha-adapter-openolt/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml>`_
+ - Chart.yaml : version
+ - Increment `OLT chart version <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml#20>`_
* - voltha-infra/Chart.yaml
-
- -
+ - N/A
* - voltha-stack/Chart.yaml
- dependencies : name=voltha-adapter-openolt : version
- Component openolt-adapter modified so update `dependencies : name='voltha-adapter-olt' : version="2.12.6" <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#38>`_
@@ -63,8 +59,7 @@
### Extra Credit
-- Update copyright notices :ref:`Release Task Copyright`
-- make lint # lint everything
+- make lint
.. seealso::
diff --git a/howto/release/charts/voltha-openonu-adapter.rst b/howto/release/charts/voltha-openonu-adapter.rst
new file mode 100644
index 0000000..bd4ad85
--- /dev/null
+++ b/howto/release/charts/voltha-openonu-adapter.rst
@@ -0,0 +1,68 @@
+# Update Helm Chart for repo:votlha-openonu-adapter
+
+## HOWTO: Helm Chart Update
+
+- Update copyright notices :ref:`Release Task Copyright`
+- Update VOLTHA artifact and chart versions :ref:`Release Task Helm Charts`
+
+- Increment repository `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter/+/refs/heads/master/VERSION>`_. Build, test and deploy.
+- Modify repo:voltha-helm-charts
+
+ - Update component version in the component chart file.
+ - Update chart version for all charts dependent on the component chart.
+ - Run ``make lint-chart lint-helm`` to validate chart changes.
+ - chart:voltha, chart:voltha-infra and chart:voltha-stack can be confusing
+ due to a layer of indirection:
+
+ - chart:voltha-{infra,stack} are not not named for code repositories,
+ they are a container chart used to capture a list of dependencies
+ and versions.
+ - chart:voltha depends on these two charts which in turn depend on
+ sets of voltha components & versions.
+ - When ``make lint-chart`` report this error
+
+ - [ERROR] Chart modified but version unchanged: voltha/Chart.yaml (2.12.11)
+ - It will imply that a component like openonu-adapter has been updated
+ but chart:voltha and chart:voltha-{infra,stack} have not.
+
+.. list-table:: repo:voltha-helm-charts edits
+ :widths: 10, 20, 60
+ :header-rows: 1
+
+ * - Repository Path
+ - Key
+ - Description
+ * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_
+ - Chart.yaml : appVersion
+ - Assign `repo:voltha-openonu-adapter::VERSION <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter/+/refs/heads/master/VERSION>`_ to `Chart.yaml::appVersion <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#35>`_
+ * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_
+ - Chart.yaml : version
+ - Increment `ONU chart version <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#17>`_
+
+ * - voltha-infra/Chart.yaml
+ -
+ -
+ * - voltha-stack/Chart.yaml
+ - dependencies : name=voltha-adapter-openonu : version
+ - Component openonu-adapter modified so update `dependencies : name='voltha-adapter-onu' : version="2.12.2" <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#38>`_
+ * - voltha-stack/Chart.yaml
+ - Chart.yaml : version
+ - voltha-adapter-openonu/Chart.yaml modified so notify voltha-stack. Update `version="2.12.2" <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#30>`_.
+ * - voltha-stack/Chart.yaml
+ - dependency : name=voltha : version
+ - voltha-stack/Chart.yaml modified so notify chart voltha. Update `dependencies : name=voltha : version="2.12.14" <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#34>`_
+ * - voltha/Chart.yaml
+ - Chart.yaml : version
+ - voltha/Chart.yaml updated so modify chart `Chart.yaml : version='"2.12.14"' <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#17>`_
+ * - voltha/Chart.yaml
+ - Chart.yaml : version
+ - Update `voltha/Chart.yaml : version='"2.12.14"' <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#17>`_ to match `voltha-stack:dependencies : name=voltha : version='"2.12.14"' <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#17>`_.
+
+### Extra Credit
+
+- Update copyright notices :ref:`Release Task Copyright`
+- make lint # lint everything
+
+.. seealso::
+
+`voltha-docs::charts <../charts/index>`
diff --git a/howto/release/tasks/charts.rst b/howto/release/tasks/charts.rst
new file mode 100644
index 0000000..c6b70aa
--- /dev/null
+++ b/howto/release/tasks/charts.rst
@@ -0,0 +1,21 @@
+.. _Release Task Helm Charts:
+
+Helm Chart Update
+=================
+
+.. code-block:: shell-session
+ :caption: Update helm charts for deployed VOLTHA and ONOS artifacts
+
+ # clone repo:voltha-helm-charts
+ % git clone "ssh://gerrit.opencord.org:29418/voltha-helm-charts.git"
+ % cd voltha-helm-charts
+
+ # Gather files to edit
+ % vi $(grep -r 'adapter' . | cut -d: -f1 | sort -u)
+
+ # Gather indirect dependencies to edit
+ vi voltha/Chart.yaml voltha-infra/Chart.yaml voltha-stack/Chart.yaml
+
+ # Sanity check edits
+ % make lint-chart
+ % make lint-helm