blob: e5b2dfa2cdd9c0094c0f4d487cf1ede70600bbe2 [file] [log] [blame]
Joey Armstrong82180592024-02-10 15:34:21 -05001# Update Helm Chart for repo:votlha-openonu-adapter
2
3## HOWTO: Helm Chart Update
4
5- Update copyright notices :ref:`Release Task Copyright`
6- Update VOLTHA artifact and chart versions :ref:`Release Task Helm Charts`
7
Eric Ball74a2e762025-08-27 12:34:53 -07008- Increment repository `VERSION file <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-openonu-adapter/+/refs/heads/master/VERSION>`_. Build, test and deploy.
Joey Armstrong82180592024-02-10 15:34:21 -05009- Modify repo:voltha-helm-charts
10
11 - Update component version in the component chart file.
12 - Update chart version for all charts dependent on the component chart.
13 - Run ``make lint-chart lint-helm`` to validate chart changes.
14 - chart:voltha, chart:voltha-infra and chart:voltha-stack can be confusing
15 due to a layer of indirection:
16
17 - chart:voltha-{infra,stack} are not not named for code repositories,
18 they are a container chart used to capture a list of dependencies
19 and versions.
20 - chart:voltha depends on these two charts which in turn depend on
21 sets of voltha components & versions.
22 - When ``make lint-chart`` report this error
23
24 - [ERROR] Chart modified but version unchanged: voltha/Chart.yaml (2.12.11)
25 - It will imply that a component like openonu-adapter has been updated
26 but chart:voltha and chart:voltha-{infra,stack} have not.
27
28.. list-table:: repo:voltha-helm-charts edits
29 :widths: 10, 20, 60
30 :header-rows: 1
31
32 * - Repository Path
33 - Key
34 - Description
Eric Ball74a2e762025-08-27 12:34:53 -070035 * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_
Joey Armstrong82180592024-02-10 15:34:21 -050036 - Chart.yaml : appVersion
Eric Ball74a2e762025-08-27 12:34:53 -070037 - Assign `repo:voltha-openonu-adapter::VERSION <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-openonu-adapter/+/refs/heads/master/VERSION>`_ to `Chart.yaml::appVersion <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#35>`_
38 * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_
Joey Armstrong82180592024-02-10 15:34:21 -050039 - Chart.yaml : version
Eric Ball74a2e762025-08-27 12:34:53 -070040 - Increment `ONU chart version <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#17>`_
Joey Armstrong82180592024-02-10 15:34:21 -050041
42 * - voltha-infra/Chart.yaml
43 -
44 -
45 * - voltha-stack/Chart.yaml
46 - dependencies : name=voltha-adapter-openonu : version
Eric Ball74a2e762025-08-27 12:34:53 -070047 - Component openonu-adapter modified so update `dependencies : name='voltha-adapter-onu' : version="2.12.2" <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#38>`_
Joey Armstrong82180592024-02-10 15:34:21 -050048 * - voltha-stack/Chart.yaml
49 - Chart.yaml : version
Eric Ball74a2e762025-08-27 12:34:53 -070050 - voltha-adapter-openonu/Chart.yaml modified so notify voltha-stack. Update `version="2.12.2" <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#30>`_.
Joey Armstrong82180592024-02-10 15:34:21 -050051 * - voltha-stack/Chart.yaml
52 - dependency : name=voltha : version
Eric Ball74a2e762025-08-27 12:34:53 -070053 - voltha-stack/Chart.yaml modified so notify chart voltha. Update `dependencies : name=voltha : version="2.12.14" <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-stack/Chart.yaml#34>`_
Joey Armstrong82180592024-02-10 15:34:21 -050054 * - voltha/Chart.yaml
55 - Chart.yaml : version
Eric Ball74a2e762025-08-27 12:34:53 -070056 - voltha/Chart.yaml updated so modify chart `Chart.yaml : version='"2.12.14"' <https://gerrit.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#17>`_
Joey Armstrong82180592024-02-10 15:34:21 -050057 * - voltha/Chart.yaml
58 - Chart.yaml : version
Eric Ball74a2e762025-08-27 12:34:53 -070059 - Update `voltha/Chart.yaml : version='"2.12.14"' <https://gerrit.lfbroadband.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.lfbroadband.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha/Chart.yaml#17>`_.
Joey Armstrong82180592024-02-10 15:34:21 -050060
61### Extra Credit
62
63- Update copyright notices :ref:`Release Task Copyright`
64- make lint # lint everything
65
66.. seealso::
67
Eric Ball4cc56b02025-03-25 12:36:33 -070068 `voltha-docs::charts <../charts/index>`