| commit | d6a9912844437126c4c8c49f61d954e334c4507c | [log] [tgz] |
|---|---|---|
| author | pierventre <pier@opennetworking.org> | Wed Jan 12 17:23:34 2022 +0100 |
| committer | pierventre <pier@opennetworking.org> | Wed Jan 12 17:23:34 2022 +0100 |
| tree | 2f21d3bb1ce74b0bc257a0ebdc80a713933ea986 | |
| parent | f969c743733cfe4c9f9b63d87c88ccc35c0b8001 [diff] |
[SDFAB-905] Update README with the steps to build custom images Change-Id: If358ad329831c69e87b6a7d8c87dfde62081a92a
Docker build environment capable of producing a version of ONOS and needed apps that make the SD-Fabric control plane.
The name TOST comes from the early days of the SD-Fabric project. It stands for Trellis ONOS Stratum Tofino. We keep this name for backward compatibility.
Typically the ONOS restful api would be used to include apps after ONOS is started.
We provide multiple build targets for the Makefile. Versions of the components are defined in Makefile.vars.* files; stable version points to well known stable commits and master branch points to ONOS master and to the tip of the TOST components. DOCKER_TAG is used to select which version to build, by default points to stable.
onos-build is used to build a specialized Docker image of ONOS (tost-onos) that will contain only the apps needed by TOST. It depends on onos target, which is used to setup the onos workspace for the build. It clones onos if it does not exist in the workspace, it will try to checkout the ONOS_VERSION first and in case of failure will try to download the patchset from remote repository. ONOS_VERSION is defined in Makefile.vars.DOCKER_TAG file, overriding the variable at run time it is possible to build a different version of ONOS.
# Build a tost-onos image from the current workspace. make onos-build
# Build a tost-onos image from the tip of the onos-2.2 branch. make ONOS_VERSION=onos-2.2 onos-build
# Build a tost-onos image from the review 12345. make ONOS_VERSION=ref/changes/72/12345/1 onos-build
Makefile will build also the apps. These are the apps currently integrated in the script: trellis-control, trellis-t3, up4 and fabric-tna. For each one, there is a build target.
appname-build builds with the version specified in the Makefile.vars.DOCKER_TAG, using the following sources in order: (1) Maven central (for released versions or snapshots); (2) Local source code (for local branch not yet pushed); (3) Gerrit/Github (for pending review in the form of refs/changes/... or pending pull request). As a prerequisite, the script prepares mvn_settings.xml file, creates the local-apps folder and checks out the code if it is not present (relies on appname target). APPNAME_VERSION, defined in Makefile.vars.DOCKER_TAG file, can be overridden at runtime.
# Build trellis-control from the source code. make trellis-control-build
# Build up4 app from the source code. make up4-build
apps-build is an additional target that automates the build process of the apps building one by one all the apps.
# Build one by one all the apps. make apps-build
Finally, the last build target is tost-build. It builds a tost monolithic image using as base the tost-onos image. It basically adds the external apps used by TOST. It does not activate all the required apps. This step is performed during the deployment and the required apps are specified in the chart.
# Build a tost image from the current workspace. make tost-build
When doing ONOS API changes, we don't want to fetch ONOS maven artifacts from the remote sonatype SNAPSHOT repository. To do so, we need to set an environment variable (USE_LOCAL_SNAPSHOT_ARTIFACTS=true) and follow a specific order when building the tost image.
.m2 folder): USE_LOCAL_SNAPSHOT_ARTIFACTS=true [DOCKER_TAG=master] make onos-buildUSE_LOCAL_SNAPSHOT_ARTIFACTS=true [DOCKER_TAG=master] make trellis-control-build up4-buildUSE_LOCAL_SNAPSHOT_ARTIFACTS=true [DOCKER_TAG=master] make fabric-tna-build trellis-t3-buildUSE_LOCAL_SNAPSHOT_ARTIFACTS=true [DOCKER_TAG=master] make tost-buildIt is not always possible to build images with the latests changes, as sometimes hotfixes need to be delivered quickly in order to fix the issues identified in production. Hereafter the steps to build images with custom changes not yet merged - please note that we don't have the full flexibility provided by a separated “production” branch which means that sometimes the following workflow could not be realizable.
ONOS 1.1 Identify a stable commit that has been well tested and do reset to that commit 1.2 Take a note about the SNAPSHOT version 1.3 Organize the hotfixes as a train (on top of each other) 1.4 Rebase the train on top of the stable commit 1.5 Write the ref/changes path of the tip patch in the Makefile.vars.stable file
trellis-control 2.1 Identify a stable commit that has been well tested and do reset to that commit 2.2 Take a note about the SNAPSHOT version 2.3 Organize the hotfixes as a train (on top of each other) 2.4 Rebase the train on top of the stable commit 2.5 Update the onos-dependencies to the ONOS SNAPSHOT version and push a review 2.6 Write the ref/changes path of the step 2.5 in the Makefile.vars.stable file
trellis-t3 3.1 Identify a stable commit that has been well tested and do reset to that commit 3.2 Organize the hotfixes as a train (on top of each other) 3.3 Rebase the train on top of the stable commit 3.4 Update the onos-dependencies to the ONOS SNAPSHOT version and the trellis.api version to the trellis-control SNAPSHOT version and push a review 3.5 Write the ref/changes path of the step 3.4 in the Makefile.vars.stable file
fabric-tna 4.1 Identify a stable commit that has been well tested and do reset to that commit 4.2 Create a branch out of the stable commit; update the onos-dependencies to the ONOS SNAPSHOT version and the trellis-api version to the trellis-control SNAPSHOT version and push a patch 4.3 Merge all the hotfixes in the branch created at the step 4.2 and push a new commit 4.4 Write the branch name created at the step 4.2 in the Makefile.vars.stable file, alternatively the PR number using pull/#PR/head
up4 5.1 Identify a stable commit that has been well tested and do reset to that commit 5.2 Create a branch out of the stable commit; update the onos-dependencies to the ONOS SNAPSHOT version and push a patch 5.3 Merge all the hotfixes in the branch created at the step 5.2 and push a new commit 5.4 Write the branch name created at the step 5.2 in the Makefile.vars.stable file, alternatively the PR number using pull/#PR/head
Build a stable image with the docker-build target using the locally built maven artifacts USE_LOCAL_SNAPSHOT_ARTIFACTS=true DOCKER_TAG=stable make docker-build
Use apps or appname targets to downloads commits, files, and refs from remotes.
# Update one by one all the apps. make apps
Use clean target to remove the local artificats generated by the tool.
# Cleans the workspace. make clean
We provide multiple push target for the Makefile. Typically, you need to first login by docker login command to push the image on a repository.
onos-push will push the tost-onos image.
make onos-push
tost-push will push the tost image on the defined DOCKER_REGISTRY and DOCKER_REPOSITORY.
make DOCKER_REPOSITORY=onosproject/ tost-push
There are two special targets used by the CI/CD jobs: docker-build and docker-push. The first target automates the build process of the tost image (check-scripts, onos-build, apps-build and tost-build). While the second one, it is just a tost-push called in a different way (temporary). Feel free to use them if you are ok with the prerequisites steps.