blob: ef8895665262e93a3bef9dc327ca1566249dcfda [file] [log] [blame]
Andrea Campanella4dfe9322022-05-10 12:40:10 +02001======================
2VOLTHA Release process
3======================
4This document describes the technical steps of VOLTHA's release process.
5The document assumes you are creating a release named voltha-X.Y, where X is the major release versio
6and the y is the minor.
7See versioning in the :doc:`releases documentation </overview/releases>`
8
9Code Freeze and pre-release testing
10-----------------------------------
11
12VOLTHA is released every 6 months. The suggested codefreeze is 3 weeks before release.
13Code freeze means that no functionality is added, only bug fixes and tests can be added during the code freeze time.
14Code freeze is announced during the TST meetings and enforced by the core contributors that have +2/merge access.
15The 3 weeks of code freeze are used to stabilize the tests and prepare the components for the release.
16
17During code freeze the jenkins jobs test the latest code in master which, given the code freeze state, is the
18release candidate (RC) for the release.
19A release can be considered ready if the tests on Jenkins pass with no issue, both on hardware and bbsim jobs.
20
21Component releasing and Lazy Branching
22--------------------------------------
23In VOLTHA for a release we release components (services) and lazy branch when/if needed.
24Once a component (service) is ready to be released we increase the version in the VERSION file,
25going from the -dev or released version x.y.z to either a higher number in minor version (y) or in bug version (z).
26
27To allow for future patches to go into the repo in a way that does not conflict with the patch version,
28each component repo's VERSION file should have it's minor version increased in master. (ex: 1.1.X to 1.2.0-dev,
29so future 1.1.X+1 component release can easily be created for the released VOLTHA version).
30
Joey Armstrongd24a1122023-01-04 09:34:46 -050031The same should be done on Helm charts in the chart repos post release, but the versions there shouldn't include a
Andrea Campanella4dfe9322022-05-10 12:40:10 +020032-dev suffix because chart publishing requires that every new chart version be unique and using un-suffixed SemVer is a
33better release numbering pattern.
34
35If a repository is branched the `.gitreview` file needs to be changed, adding `defaultorigin=voltha-X.Y` at the end.
36
37.. note::
38 Given the dependency of the containers on the protos and the library, if the voltha-protos and/or voltha-lib-go or
39 omci-lib-go need to be released, it should be done first and then updated in the components:
40
41 - release `voltha-proto`
42 - update `voltha-lib-go` and release it
43 - change the protos and lib-go versions in the components (in `go.mod`)
44 - issue `make mod-update`
45 - release the component
46
47
48Every repository that need releasing is listed here.
49
50Services:
51
52- `VOLTHA Core <https://github.com/opencord/voltha-go>`_
53- `OpenFlow Agent <https://github.com/opencord/ofagent-go>`_
54- `Openonu Adapter <https://github.com/opencord/voltha-openonu-adapter-go>`_
55- `Openolt Adapter <https://github.com/opencord/voltha-openolt-adapter>`_
56- `Openolt Agent <https://github.com/opencord/openolt>`_
57- `ONOS controller <https://github.com/opencord/voltha-onos>`_ (Note, only do it after releasing all the apps below)
58- `BBSIM <https://github.com/opencord/bbsim>`_
59- `BBSIM Sadis Server <https://github.com/opencord/bbsim-sadis-server>`_
60
61Libraries and APIs:
62
63- `VOLTHA protos <https://github.com/opencord/voltha-protos>`_
64- `VOLTHA Library in Go <https://github.com/opencord/voltha-lib-go>`_
65- `OMCI Library in GO <https://github.com/opencord/omci-lib-go>`_
66
67Tools:
68
69- `voltctl <https://github.com/opencord/voltctl>`_
70
71Configuration:
72
73- `pod-configs <https://github.com/opencord/pod-configs>`_
74
75ONOS Apps
76^^^^^^^^^
77
78The ONOS Apps need to be released in a different manner.
79
80There is a Jenkins job to release ONOS app: https://jenkins.opencord.org/job/onos-app-release.
81It requires to be triggered with specific parameters, as an example you can check the latest job in that pipeline.
82
831. Build with parameters: use the name of the repo (not of the app itself)
842. Wait for build to complete
853. Merge the patches on gerrit https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
Joey Armstrong56334fc2023-01-15 22:53:19 -050086
87 - Two pull requests are created modifying pom.xml.
88 - Approve patch one (-SNAPSHOT: no) to initiate a release build.
89 - Approve patch two (-SNAPSHOT: yes) to revert pom.xml to a non-release version.
90
914. Approval and merge will trigger a `jenkins job <https://jenkins.opencord.org/job/maven-publish_sadis/>`_ that publish
92 an artifact into the staging repo on `sonatype <https://oss.sonatype.org>`_. From there the artifact will need
93 to be released into maven central.
94
95 - Login on sonatype (for username and password contact michelle@opennetworking.org)
96 - search for org.opencord
97 - Select the app you want to release and click "all versions"
98 - Click on "Staging repositories" (in the left side navigation)
99 - In the top right search for last part of the app name (eg: olt)
100 - Click release (top left bar, small button)
101
1025. Wait until the artifacts are published
103
104 - https://search.maven.org/search?q=g:org.opencord
105 - https://search.maven.org/artifact/org.opencord/dhcpl2relay/2.9.0/pom
106
1076. Iterate through apps:
108
109 - Modify pom.xml and dependencies.xml
110 - Update version string for all released dependencies.
111
Andrea Campanella4dfe9322022-05-10 12:40:10 +02001127. Start over with new app
113
114.. note::
115 Given their inter dependency the ONOS apps need to be released in order:
116
117 1. sadis
118 2. olt, aaa, dhcpl2relay, mcast, igmpproxy, maclearning
119 3. bng, PPPoE
120 4. kafka
121
122ONOS APPs:
123
124- `AAA <https://github.com/opencord/aaa>`_
125- `BNG <https://github.com/opencord/bng>`_
126- `DHCP L2 Relay <https://github.com/opencord/dhcpl2relay>`_
127- `IGMPProxy <https://github.com/opencord/igmpproxy>`_
128- `Kafka <https://github.com/opencord/kafka-onos>`_
129- `Mac Learning <https://github.com/opencord/mac-learning>`_
130- `Multicast <https://github.com/opencord/mcast>`_
131- `OLT <https://github.com/opencord/olt>`_
132- `OLT Topology <https://github.com/opencord/olttopology>`_
133- `PPPoE Agent <https://github.com/opencord/pppoeagent>`_
134- `Sadis <https://github.com/opencord/sadis>`_
135
136
137
138
139Creating the release
140--------------------
141
142Once the components have been tested and the release is considered ready there are 3 more elements that need to be
143tagged:
144
145- `VOLTHA Helm Charts <https://github.com/opencord/voltha-helm-charts>`_
146- `VOLTHA System Tests <https://github.com/opencord/voltha-system-tests>`_
147- `VOLTHA docs <https://github.com/opencord/voltha-docs>`_
148
149These 3 repos are the only ones that receive a X.Y.Z tag. Other repos that contain individual
150components have their own versioning/release cadence, driven by SemVer.
151
152Helm Charts
153^^^^^^^^^^^
154
155The official action of creating the voltha-X.Y release is releasing the voltha helm chart, and adapter charts
156with version:X.Y.Z (e.g. 2.10.0) specified in Chart.yaml within the voltha-helm-charts repo, and within the VERSION
157file in that repo.
158A branch named voltha-X.Y needs to be created on the voltha-helm-charts repo.
159The helm charts repo overall VERSION should also be incremented to the next minor version (X.Y+1-dev), so all X.Y.Z
160releases of the overall charts repo will happen on the voltha-X.Y branch.
161
162Voltha-system-tests
163^^^^^^^^^^^^^^^^^^^
164Accompanying tests for voltha-X.Y are created by creating a branch created named voltha-X.Y on the voltha-system-tests
165repo and creating a tag X.Y.Z on that branch.
166
167Documentation and Release Notes
168^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169Release notes for the voltha-X.Y release are created and added to the voltha-docs repo. Please follow the template of
170past releases, an :doc:`example </voltha_releases/voltha_2.9>`
171
172Also, if needed a voltha-X.Y branch is created on docs repo. These release notes also contain all the
173versions of components that will be released, and may be updated during the final QA process.
174At release we create a tag X.Y.Z in the VERSION file.
175
176CI-Management
177^^^^^^^^^^^^^
178In the `Ci management <https://github.com/opencord/ci-management>`_ repository create the /voltha-x.y.z folder and copy the /master repos
179Testing CI jobs should be created that check out the voltha-X.Y branch of the voltha-system-tests repo, testing the
180charts as checked out with the voltha-X.Y tag of voltha-helm-charts.
181
182
183Release support and bug-fixing
184------------------------------
185
186What changes can be brought into the X.Y.Z branch?
187^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
188Has to be a bug or non-code fix.
189
190Add a Jira item with type Bug, tag against VOLTHA vX.Y
191Discuss on the Voltha mailing list, or in all-Voltha meeting, get consensus on whether should be brought to X.Y.z
192Documentation or other non-code updates are also acceptable
193
194What is a bug? Not a new feature!
195Anything that causes a functional regression test (Robot tests) to fail
196Severe issue (causes data loss or crash), or frequently occurring -> add to X.Y
197Issues that are merely annoying and don't cause data loss or a crash, or are very infrequently occurring -> may
198wait for next release
199
200WHen a bug is found please add to tests both on the released version and the master branch, if tests don't cover
201the bug. Add to Robot tests for integration-related issues, to Unit tests for code-level or functional issues.
202
203Update/Fixes to the released version
204^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
205This section shows how to create minor releases on the X.Y.Z branch when a bug fix is required.
206
207If a fix is needed to the helm charts:
208
209- Make the fix on the master branch of voltha-helm-charts (assuming that it is required in both places).
210- After the master tests pass, manually cherry-pick the fix to the voltha-X.Y branch (the Chart version would be
211 different, requiring the manual step).
212- Cherry-picked patchsets on that branch will be checked by the voltha-X.Y branch of tests.
213- When it passes, submitting the change will make a new X.Y.Z release
214- Update the documentation to reflect the chart changes, a description of the changes made, and increment the tag
215 on the docs from X.Y.Z to X.Y.Z+1, to reflect the patch change.
216- If all the charts are updated and working correctly, create a new charts point release by increasing the
217 X.Y.Z VERSION file in the voltha-helm-charts repo. The versions need to be updated in the voltha-docs repo,
218 which needs to be tagged as well, thus releasing it.
219
220If a fix is needed to the components/containers that are included by the helm charts:
221
222- Develop a fix to the issue on the master branch, get it approved after passing master tests.
Joey Armstrongd24a1122023-01-04 09:34:46 -0500223- Manually cherry-pick to the voltha-X.Y branch of the component (create one if needed)
Andrea Campanella4dfe9322022-05-10 12:40:10 +0200224- incrementing the patch version in the VERSION file,
225- test with the voltha-X.Y version of voltha-system-tests and helm charts.
226- Update helm charts and go through the helm chart update process above.
227- Update the voltha-docs with the right version of the component.
228
229If a fix is needed to the ONOS apps:
230
231- Create a branch here https://gerrit.opencord.org/plugins/gitiles/olt/+/refs/heads/olt-4.1
232- then `Git checkout -b <branch-name> opencord/<version>`
233- Then push a commit changing to `.1-SNAPSHOT` more (see e.g. https://gerrit.opencord.org/c/igmpproxy/+/19589)
234- Then push you changes (e.g. https://gerrit.opencord.org/c/igmpproxy/+/19590)
235- Then release as per the process above.
Joey Armstrong56334fc2023-01-15 22:53:19 -0500236
237See Also
238========
239- `VOLTHA Release Process <https://docs.voltha.org/master/overview/release_process.html?highlight=charts%20yaml>`_
240- `release_notes: Release Process <https://docs.voltha.org/master/release_notes/release_process.html>`_
241- `VOLTHA and ONOS Software Update Procedure <https://docs.voltha.org/master/operations/software-upgrade.html?highlight=set%20global%20image>`_
242- `Helm Chart Deployment <https://docs.voltha.org/master/voltha-helm-charts/README.html?highlight=voltctl>`_