fuel/build/opendaylight/README

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   3 # stefan.k.berg@ericsson.com
   4 # jonas.bjurel@ericsson.com
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 ##############################################################################
  10
  11 This directory builds the OpenDaylight debian package by cloning the
  12 opendaylight.org repo, building the odl tag specified in
  13 "fuel-build/config-spec" and constructing a debian package source tree under
  14 "f_odl", which automatically is linked into "fuel_build/." for further build processing.
  15
  16 The opendaylight has the following structure:
  17 .
  18 +--------+-------------+-----------+
  19 |        |             |           |
  20 |     Makefile  make-odl-deb.sh  README
  21 |                              (this file)
  22 |
  23 +----------+----------+
  24            |          |
  25        odl_maven/   f_odl/
  26
  27 Makefile:
  28 Invoked by the git root Makefile, it builds the clones the odl repo from
  29 odl, checkout the tag/branch indicated in "fuelbuild/config-spec", builds
  30 odl, and calls "make-odl-deb.sh" to create a debian package source tree.
  31
  32 make-odl-deb.sh:
  33 Creates the odl debian package source tree in "f_odl" from the odl build
  34 results.
  35
  36 odl_maven/:
  37 Contains needed control files for maven OpenDaylight build
  38
  39 f_odl/:
  40 Contains buildscripts and the generated odl debian package source tree produced
  41 by the odl build (make-odl-deb.sh) which is later used by the root build system.
  42
  43 NOTE on the controller/ git repo clone:
  44 The git controller repo clone Contains all artifacts from the odl build, it only
  45 exists in /tmp inside the build docker container and is not visible anywhere on
  46 the build host
  47
  48 Note on build caching:
  49 The latest build results are cached, and will not be rebuilt unless the fuel-build/
  50 config-spec is changed in respect to odl version or if make clean is applied.
  51 ./.odl-build.log and ./.odl-build.history are used to keep adequate bookmaking to
  52 track caching and needed cleanout.