| Joey Armstrong | 8218059 | 2024-02-10 15:34:21 -0500 | [diff] [blame] | 1 | # 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 | |
| 8 | - Increment repository `VERSION file <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-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 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 |
| 35 | * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_ |
| 36 | - Chart.yaml : appVersion |
| 37 | - 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>`_ |
| 38 | * - `voltha-adapter-openonu/Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml>`_ |
| 39 | - Chart.yaml : version |
| 40 | - Increment `ONU chart version <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-adapter-openonu/Chart.yaml#17>`_ |
| 41 | |
| 42 | * - voltha-infra/Chart.yaml |
| 43 | - |
| 44 | - |
| 45 | * - voltha-stack/Chart.yaml |
| 46 | - dependencies : name=voltha-adapter-openonu : version |
| 47 | - 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>`_ |
| 48 | * - voltha-stack/Chart.yaml |
| 49 | - Chart.yaml : version |
| 50 | - 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>`_. |
| 51 | * - voltha-stack/Chart.yaml |
| 52 | - dependency : name=voltha : version |
| 53 | - 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>`_ |
| 54 | * - voltha/Chart.yaml |
| 55 | - Chart.yaml : version |
| 56 | - 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>`_ |
| 57 | * - voltha/Chart.yaml |
| 58 | - Chart.yaml : version |
| 59 | - 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>`_. |
| 60 | |
| 61 | ### Extra Credit |
| 62 | |
| 63 | - Update copyright notices :ref:`Release Task Copyright` |
| 64 | - make lint # lint everything |
| 65 | |
| 66 | .. seealso:: |
| 67 | |
| 68 | `voltha-docs::charts <../charts/index>` |