| Charles Chan | fcfe890 | 2022-02-02 17:06:27 -0800 | [diff] [blame] | 1 | .. SPDX-FileCopyrightText: 2021 Open Networking Foundation <info@opennetworking.org> |
| 2 | .. SPDX-License-Identifier: Apache-2.0 |
| 3 | |
| Zack Williams | 98fe232 | 2021-09-20 15:02:11 -0700 | [diff] [blame] | 4 | Release Process |
| 5 | =============== |
| 6 | |
| Carmelo Cascone | d9f4916 | 2021-10-07 18:17:20 -0700 | [diff] [blame] | 7 | Release artifacts |
| 8 | ----------------- |
| 9 | There will be 4 major artifacts produced as the result of release process. |
| 10 | |
| 11 | - **SD-Fabric Docker image** - This includes all control plane software |
| 12 | - **Stratum Docker image** - This includes Stratum switch OS |
| 13 | - **SD-Fabric Helm charts** |
| 14 | - **SD-Fabric documentation** - The website you are currently viewing |
| 15 | |
| 16 | Prerequisite |
| 17 | ------------ |
| 18 | SD-Fabric releases are guarded by our system integration tests. |
| 19 | Before each release, we check the test result and make sure we have a "green light". |
| 20 | Visit :ref:`testing_guide` for more details. |
| 21 | |
| 22 | Stratum Docker image |
| 23 | -------------------- |
| 24 | Stratum has its own release process and release timeline. |
| 25 | We request Stratum TST to make a release when necessary. |
| 26 | |
| 27 | SD-Fabric Docker Image |
| 28 | ---------------------- |
| 29 | We tag and release the following repositories in order: |
| 30 | |
| 31 | - onos: |
| 32 | - Run Jenkins release job: https://jenkins.onosproject.org/view/onos-release/job/onos-bazel-release-build/ |
| 33 | - Manually publish artifacts to Maven central: https://oss.sonatype.org/ |
| 34 | |
| 35 | - trellis-control: |
| 36 | - Update ``pom.xml(s)``: |
| 37 | |
| 38 | - Update dependencies (use non-snapshot onos) |
| 39 | - Update version |
| 40 | - Push Gerrit change, merge |
| 41 | - Wait for Jenkins job to publish artifacts (https://jenkins.onosproject.org/view/Trellis/job/maven-publish_trellis-control) |
| 42 | - Manually release artifacts: https://oss.sonatype.org/ |
| 43 | |
| 44 | - fabric-tna: |
| 45 | - Update ``pom.xml``: |
| 46 | |
| 47 | - Update dependencies (use non-snapshot ``onos`` and ``trellis-control``) |
| 48 | - Update version |
| 49 | - Tag repository |
| 50 | |
| 51 | - up4: |
| 52 | - Update ``pom.xml(s)``: |
| 53 | |
| 54 | - Update dependencies (use non-snapshot onos) |
| 55 | - Update version |
| 56 | - Tag repository |
| 57 | |
| 58 | - SD-Fabric image: |
| 59 | - Update Makefile.stable with git tags used above |
| 60 | - Merge, wait for Jenkins to publish stable image |
| 61 | - Manually tag image on harbor |
| 62 | |
| 63 | SD-Fabric Helm charts |
| 64 | --------------------- |
| 65 | The SD-Fabric umbrella chart includes 5 sub-charts: |
| 66 | |
| 67 | - ONOS classic |
| 68 | - Stratum |
| 69 | - PFCP agent |
| 70 | - DBUF |
| 71 | - INT host reporter |
| 72 | |
| 73 | To update each sub-charts: |
| 74 | - Update chart version and default image in each charts |
| 75 | - Post-merge CI job will tag the repositories according to chart version |
| 76 | |
| 77 | To update the umbrella charts: |
| 78 | - Update chart version and dependencies in ``sdfabric-helm-charts/sdfabric/Chart.yaml`` |
| 79 | - Post-merge CI job will tag the repositories according to chart version |
| 80 | |
| 81 | |
| 82 | SD-Fabric documentation |
| 83 | ----------------------- |
| 84 | - Complete release note |
| 85 | - Tag documentation repository for each release |
| 86 | - Branch documentation repository for each major releases |