commit | 164af071cb33d7d2f6cc457227605ee78d723aa0 | [log] [tgz] |
---|---|---|
author | pierventre <pier@opennetworking.org> | Wed Jul 29 20:27:49 2020 +0200 |
committer | Charles Chan <charles@opennetworking.org> | Wed Jul 29 21:54:15 2020 +0000 |
tree | 441b6ace2d14e8d3b6e245b59c3c9feb443dbf4e | |
parent | 1670916de18d7bceb67e2d319d5f408db8af13e8 [diff] |
[AETHER-458] Improves README Change-Id: I78d2a1a237e8d74e8c5b7c1c0129453578ff3f46
Docker build environment capable of producing a version of ONOS and needed apps that can run with TOST. Typically the ONOS restful api would be used to include apps after ONOS is started.
We provide multiple build targets for the Makefile
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 is possible to build the image by using a specific branch (export ONOS_BRANCH
variable) or by defining a specific review (export ONOS_REVIEW
variable). It clones onos
if it does not exist in the workspace and uses current workspace unless above vars are defined.
# Build a tost-onos image from the current workspace. make onos-build
# Build a tost-onos image from the onos-2.2 branch. make ONOS_BRANCH=onos-2.2 onos-build
# Build a tost-onos image from the review 12345. make ONOS_REVIEW=12345 onos-build
Makefile will build also the apps. These are the apps currently integrated in the script: trellis-control, trellis-t3, fabric-tofino, up4 and kafka-onos. For each one, there is a build target.
app-name-build
builds the oar from the source code. If APPNAME_MVN is specified, the script will download the oar from the maven repositories. As 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 app-name
target). app-name
allows the developers to specify an APPNAME_BRANCH or an APPNAME_REVIEW.
# Build trellis-control from the source code. make trellis-control-build
# Build up4 app from the source code. make up4-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
Use target clean
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 on the defined DOCKER_REGISTRY and DOCKER_REPOSITORY.
make DOCKER_REPOSITORY=onosproject/ 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. 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.