blob: e3aeb7303b484217b3c4f8ffb2cffdbbd21a2b90 [file] [log] [blame]
Joey Armstrong9bb4b102024-02-10 13:09:12 -05001# Update Helm Chart for repo:votlha-openolt-adapter
2
3## HOWTO: Helm Chart Update
4
Joey Armstrong82180592024-02-10 15:34:21 -05005- Update copyright notices :ref:`Release Task Copyright`
6- Update VOLTHA artifact and chart versions :ref:`Release Task Helm Charts`
Joey Armstrong9bb4b102024-02-10 13:09:12 -05007
8- Increment repository `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/heads/master/VERSION>`_. Build, test and deploy.
9- 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 openolt-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
35 * - `voltha-adapter-openolt/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml>`_
36 - Chart.yaml : appVersion
37 - 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>`_
Joey Armstrong82180592024-02-10 15:34:21 -050038 * - `voltha-adapter-openolt/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml>`_
39 - Chart.yaml : version
40 - Increment `OLT chart version <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openolt/Chart.yaml#20>`_
Joey Armstrong9bb4b102024-02-10 13:09:12 -050041 * - voltha-infra/Chart.yaml
42 -
Joey Armstrong82180592024-02-10 15:34:21 -050043 - N/A
Joey Armstrong9bb4b102024-02-10 13:09:12 -050044 * - voltha-stack/Chart.yaml
45 - dependencies : name=voltha-adapter-openolt : version
46 - 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>`_
47 * - voltha-stack/Chart.yaml
48 - Chart.yaml : version
49 - 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>`_.
50 * - voltha-stack/Chart.yaml
51 - dependency : name=voltha : version
52 - 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>`_
53 * - voltha/Chart.yaml
54 - Chart.yaml : version
55 - 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>`_
56 * - voltha/Chart.yaml
57 - Chart.yaml : version
58 - 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>`_.
59
60### Extra Credit
61
Joey Armstrong82180592024-02-10 15:34:21 -050062- make lint
Joey Armstrong9bb4b102024-02-10 13:09:12 -050063
64.. seealso::
65
66`voltha-docs::charts <../charts/index>`