1 =================================================================================================
2 OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
3 =================================================================================================
8 This work is licensed under a Creative Commons Attribution 4.0
9 International License. .. http://creativecommons.org/licenses/by/4.0 ..
10 (c) Jonas Bjurel (Ericsson AB) and others
15 This document describes how to build the Fuel deployment tool for the
16 Brahmaputra release of OPNFV build system, dependencies and required
22 This document describes the build system used to build the Fuel
23 deployment tool for the Brahmaputra release of OPNFV, required
24 dependencies and minimum requirements on the host to be used for the
27 The Fuel build system is designed around Docker containers such that
28 dependencies outside of the build system can be kept to a minimum. It
29 also shields the host from any potential dangerous operations
30 performed by the build system.
32 The audience of this document is assumed to have good knowledge in
33 network and Unix/Linux administration.
38 Minimum Hardware Requirements
39 -----------------------------
41 - ~30 GB available disc
45 Minimum Software Requirements
46 -----------------------------
48 The build host should run Ubuntu 14.04 operating system.
50 On the host, the following packages must be installed:
52 - An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed
54 - A kernel equal- or later than 3.19 (Vivid) (simply available through sudo apt-get install linux-generic-lts-vivid)
56 - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported
58 - docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Tested against version 1.9.x and greater
60 - git (simply available through $ sudo apt-get install git)
62 - make (simply available through $ sudo apt-get install make)
64 - curl (simply available through $ sudo apt-get install curl)
66 - p7zip-full (simply available through $ sudo apt-get install p7zip-full)
71 Setting up the Docker build container
72 -------------------------------------
73 After having installed Docker, add yourself to the docker group:
75 $ sudo usermod -a -G docker [userid]
77 Also make sure to define relevant DNS servers part of the global
78 DNS chain in your </etc/default/docker> configuration file.
79 Uncomment, and modify the values appropriately.
83 <DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4">
87 .. code-block:: console
89 $ sudo service docker restart
91 Setting up OPNFV Gerrit in order to being able to clone the code
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93 - Start setting up OPNFV gerrit by creating a SSH key (unless you
94 don't already have one), create one with ssh-keygen
96 - Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
97 (this requires a Linux foundation account, create one if you do not
100 - Select "SSH Public Keys" to the left and then "Add Key" and paste
103 Clone the OPNFV code Git repository with your SSH key
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105 Now it is time to clone the code repository:
109 $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
111 Now you should have the OPNFV fuel repository with the Fuel
112 directories stored locally on your build host.
114 Check out the Brahmaputra release:
119 $ git checkout brahmaputra.1.0
121 Clone the OPNFV code Git repository without a SSH key
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 You can also opt to clone the code repository without a SSH key:
127 $ git clone https://gerrit.opnfv.org/gerrit/fuel
129 Make sure to checkout the release tag as described above.
131 Support for building behind a http/https/rsync proxy
132 ----------------------------------------------------
134 The build system is able to make use of a web proxy setup if the
135 http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or
136 RSYNC_CONNECT_PROG environment variables have been set before invoking make.
138 The proxy setup must permit port 80 (http), 443 (https) and 873
141 Important note about the host Docker daemon settings
142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144 The Docker daemon on the host must be configured to use the http proxy
145 for it to be able to pull the base Ubuntu 14.04 image from the Docker
146 registry before invoking make! In Ubuntu this is done by adding a line
149 export http_proxy="http://10.0.0.1:8888/"
151 to /etc/default/docker and restarting the Docker daemon.
153 Setting proxy environment variables prior to build
154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156 The build system will make use the following environment variables
157 that needs to be exported to subshells by using export (bash) or
160 | http_proxy (or HTTP_PROXY)
161 | https_proxy (or HTTP_PROXY)
162 | no_proxy (or NO_PROXY)
166 As an example, these are the settings that were put in the user's
167 .bashrc when verifying the proxy build functionality:
169 | export RSYNC_PROXY=10.0.0.1:8888
170 | export http_proxy=http://10.0.0.1:8888
171 | export https_proxy=http://10.0.0.1:8888
172 | export no_proxy=localhost,127.0.0.1,.consultron.com,.sock
174 Using a ssh proxy for the rsync connection
175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177 If the proxy setup is not allowing the rsync protocol, an alternative
178 solution is to use a SSH tunnel to a machine capable of accessing the
179 outbound port 873. Set the RSYNC_CONNECT_PROG according to the rsync
180 manual page (for example to "ssh <username>@<hostname> nc %H 873")
181 to enable this. Also note that netcat needs to be installed on the
184 Make sure that the ssh command also refers to the user on the remote
185 system, as the command itself will be run from the Docker build container
186 as the root user (but with the invoking user's SSH keys).
188 Disabling the Ubuntu repo cache if rsync is not allowed
189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191 During the build phase, a local Ubuntu package repository is fetched
192 from upstream in order to be added to the OPNFV Fuel ISO and for parts
193 of this process rsync is used.
195 If neither of the two available methods for proxying rsync are
196 available, the last resort is to turn off the caching of the Ubuntu
197 packages in the build system. This is done by removing the
198 "f_repobuild" from SUBDIRS in the beginning of
199 the fuel/build/f_isoroot/Makefile.
201 Note! Doing this will require the Fuel master node to have Internet
202 access when installing the ISO artifact built as no Ubuntu package
203 cache will be on the ISO!
205 Configure your build environment
206 --------------------------------
208 ** Configuring the build environment should not be performed if building
209 standard Brahmaputra release **
211 Select the versions of the components you want to build by editing the
212 fuel/build/config.mk file.
214 Non official build: Selecting which plugins to build
215 ----------------------------------------------------
216 In order to cut the build time for unofficial builds (made by an
217 individual developer locally), the selection if which Fuel plugins to
218 build (if any) can be done by environment variable
219 "BUILD_FUEL_PLUGINS" prior to building.
221 Only the plugin targets from fuel/build/f_isoroot/Makefile that are
222 specified in the environment variable will then be built. In order to
223 completely disable the building of plugins, the environment variable
224 is set to " ". When using this functionality, the resulting iso file
225 will be prepended with the prefix "unofficial-" to clearly indicate
226 that this is not a full build.
228 This method of plugin selection is not meant to be used from within
234 There are two methods available for building Fuel:
236 - A low level method using Make
238 - An abstracted method using build.sh
240 Low level build method using make
241 ---------------------------------
242 The low level method is based on Make:
244 From the <fuel/build> directory, invoke <make [target]>
246 Following targets exist:
248 - none/all - this will:
250 - Initialize the docker build environment
252 - Build Fuel from upstream (as defined by fuel-build/config-spec)
254 - Build the OPNFV defined plugins/features from upstream
256 - Build the defined additions to fuel (as defined by the structure
259 - Apply changes and patches to fuel (as defined by the structure of
262 - Reconstruct a fuel .iso image
264 - clean - this will remove all artifacts from earlier builds.
266 - debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso"
268 If the build is successful, you will find the generated ISO file in
269 the <fuel/build/release> subdirectory!
271 Abstracted build method using build.sh
272 --------------------------------------
273 The abstracted build method uses the <fuel/ci/build.sh> script which
276 - Create and use a build cache - significantly speeding up the
277 build time if upstream repositories have not changed.
279 - push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:)
281 For more info type <fuel/ci/build.sh -h>.
286 The artifacts produced are:
288 - <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is
289 replaced with the build identity provided to the build system
291 - <OPNFV_XXXX.iso.txt> - Which holds version metadata.
296 1) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/installation-instruction.html>`_
298 2) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_
300 3) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_