# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
-How to setup and use the OPNFV/BGS/FUEL build system - work in progress
+How to setup and use the OPNFV/BGS/FUEL build system
+====================================================
1. Build system requirements
----------------------------
1.1 Host HW/VM requirements
---------------------------
-- A x86_64 host (real iron or VM) with Ubuntu 12.04/14.04 LTS installed
-- 100 GB storage
-- 8 GB RAM
+- An x86_64 host (real iron or VM) with Ubuntu 14.04 LTS installed
+- ~30 GB available disc
+- 4 GB RAM
1.2 Host SW dependencies
------------------------
+The host should run Ubuntu 14.04
On the host, the following packages must be installed:
-- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes for 12.04 and 14.04
+- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes
+for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io)
- git (simply available through apt-get install git)
+- make (simply available through apt-get install make)
2 Setting up the Docker build container
----------------------------------------
in your /etc/default/docker config file, eg.
DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4"
-Then restart docker with "service docker restart".:
+Then restart docker with "service docker.io restart".:
3. Setting up OPNFV Gerrit in order to being able to clone the code
-------------------------------------------------------------------
5. Set up (build) your build environment
----------------------------------------
-YOU DO NOT NEED TO SET UP YOUR BUILD ENVIRONMENT, THE TOP MAKE ALL TARGET WILL DO THAT FOR YOU IF NOT ALREADY DONE,
-THE BELOW ACTIONS IN THIS SECTION ARE NOT NEEDED!
-
-Note and TODO:
-The build system will for now partly run as sudo as that is needed for the debootstrap procedure to create the root file
-system for the Ubuntu 12.04 Docker image - BUT NOTE, NONE OF THE MAKEFILES OR SCRIPTS SHALL BE EXECUTED WITH SUDO/ROOT PRIVILEDGES!
-(TODO: Change the scripts so that no root priviledges will be needed)
-
-With your ordinary user-, run the following commands from your git root:
-cd docker
-make (and you will be prompted for your password by sudo)
-cd ..
+Select the versions of the components you want to build by editing the
+fuel-build/config-spec file. Note if you want to build with OpenDaylight
+SDN controller you need to uncomment the lines starting with odl-main and
+java-main
6. Build your fuel .iso image
-----------------------------
This will:
- If not allready existing, initialize the docker build environment
-- If not already done, build fuel from upstream
-- Build the defined derivate of fuel (as defined by the structure of this framework)
+- If not already done, build OpenDaylight from upstream (as defined by fuel-build/
+ config-spec)
+- If not already done, build fuel from upstream (as defined by fuel-build/config-spec)
+- Build the defined additions to fuel (as defined by the structure of this framework)
+- Apply changes and patches to fuel (as defined by the structure of this framework)
+- Reconstruct a fuel .iso image
+
+If the build is successful, you will find the generated ISO file in the release
+subdirectory!
-If the build is successful, you will find the generated ISO file in the release subdirectory!
+NOTE: the build of the baseline for Fuel and odl are cached, if build results reffering
+to the same versions as specified in fuel-build/config spec has been built before, these
+packages will not be rebuilt. The cache is cleared by "make clean"
7. Install your stack
---------------------
Please see DOC/INSTALL/README
+
+NOTES and TODO:
+---------------
+The build system will for now partly run as sudo
+BUT NOTE, NONE OF THE MAKEFILES OR SCRIPTS SHALL BE EXECUTED WITH
+SUDO/ROOT PRIVILEDGES!
+TODO: Change the scripts so that no root priviledges will be needed
+
Code Review / genesis.git / blobdiff