[VOL-5020] Release patch repo:voltha-helm-charts
howto/release/charts/index.rst
howto/release/charts/voltha-openolt-adapter.rst
-----------------------------------------------
o Documenty howto update helm charts for repo:voltha-openolt-adapter
Change-Id: I37313bbc199aca4b258f53b1622efdf4f06c1087
diff --git a/VERSION b/VERSION
index 02d7139..2e21b72 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.30
+2.12.31
diff --git a/howto/release/charts/index.rst b/howto/release/charts/index.rst
index b1a4f20..59f4308 100644
--- a/howto/release/charts/index.rst
+++ b/howto/release/charts/index.rst
@@ -1,22 +1,8 @@
-RELEASE: voltha-helm-charts
-===========================
+repo:voltha-helm-charts
+=======================
-- Repository `voltha-helm-charts <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`_.
-- Modify `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/VERSION>`_.
+.. toctree::
+ :maxdepth: 1
- - 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>`_.
-
-- lint/syntax checking
-
- - make test
- - make lint-chart
- - make lint-helm
-
-onos
-----
-
-- Update ONOS components `voltha-infra/values.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-infra/values.yaml>`_
-
-
+ voltha-openolt-adapter
+ notes
diff --git a/howto/release/charts/notes.rst b/howto/release/charts/notes.rst
new file mode 100644
index 0000000..b1a4f20
--- /dev/null
+++ b/howto/release/charts/notes.rst
@@ -0,0 +1,22 @@
+RELEASE: voltha-helm-charts
+===========================
+
+- Repository `voltha-helm-charts <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`_.
+- Modify `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/VERSION>`_.
+
+ - 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>`_.
+
+- lint/syntax checking
+
+ - make test
+ - make lint-chart
+ - make lint-helm
+
+onos
+----
+
+- 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
new file mode 100644
index 0000000..86de231
--- /dev/null
+++ b/howto/release/charts/voltha-openolt-adapter.rst
@@ -0,0 +1,71 @@
+# Update Helm Chart for repo:votlha-openolt-adapter
+
+## 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
+
+- 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
+
+ - 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 openolt-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-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-infra/Chart.yaml
+ -
+ -
+ * - 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>`_
+ * - voltha-stack/Chart.yaml
+ - Chart.yaml : version
+ - voltha-adapter-openolt/Chart.yaml modified so notify voltha-stack. Update `version="2.12.6" <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.2" <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.11"' <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.11"' <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.11"' <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/index.rst b/howto/release/index.rst
index a276db6..507ec11 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -28,4 +28,5 @@
repositories/index
scripts/preparation
scripts/repository-voltha-release
+ voltha-helm-charts
voltha-system-tests/index
diff --git a/requirements.txt b/requirements.txt
index ba388d7..3ef3566 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -17,4 +17,6 @@
## Implicit unused dependency -- requires Sphinx v5.0.2
# sphinxcontrib-applehelp==1.0.8
+# emacs .venv/lib/python3.10/site-packages/Sphinx-4.1.2.dist-info/METADATA
+
# [EOF]