docs/build-instruction.rst

   1 =================================================================================================
   2 OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
   3 =================================================================================================
   4
   5 License
   6 =======
   7
   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
  11
  12 Abstract
  13 ========
  14
  15 This document describes how to build the Fuel deployment tool for the
  16 Brahmaputra release of OPNFV build system, dependencies and required
  17 system resources.
  18
  19 Introduction
  20 ============
  21
  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
  25 build system.
  26
  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.
  31
  32 The audience of this document is assumed to have good knowledge in
  33 network and Unix/Linux administration.
  34
  35 Requirements
  36 ============
  37
  38 Minimum Hardware Requirements
  39 -----------------------------
  40
  41 - ~30 GB available disc
  42
  43 - 4 GB RAM
  44
  45 Minimum Software Requirements
  46 -----------------------------
  47
  48 The build host should run Ubuntu 14.04 operating system.
  49
  50 On the host, the following packages must be installed:
  51
  52 - An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed
  53
  54   - A kernel equal- or later than 3.19 (Vivid) (simply available through sudo apt-get install linux-generic-lts-vivid)
  55
  56   - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported
  57
  58 - docker - see https://docs.docker.com/installation/ubuntulinux/ for
  59   installation notes for Ubuntu 14.04. Note: use the latest version from
  60   Docker (docker-engine) and not the one in Ubuntu 14.04.
  61
  62 - git (simply available through $ sudo apt-get install git)
  63
  64 - make (simply available through $ sudo apt-get install make)
  65
  66 - curl (simply available through $ sudo apt-get install curl)
  67
  68 - p7zip-full (simply available through $ sudo apt-get install p7zip-full)
  69
  70 Preparations
  71 ============
  72
  73 Setting up the Docker build container
  74 -------------------------------------
  75 After having installed Docker, add yourself to the docker group:
  76
  77 $ sudo usermod -a -G docker [userid]
  78
  79 Also make sure to define relevant DNS servers part of the global
  80 DNS chain in your </etc/default/docker> configuration file.
  81 Uncomment, and modify the values appropriately.
  82
  83 For example:
  84
  85 <DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4">
  86
  87 Then restart docker:
  88
  89 .. code-block:: console
  90
  91     $ sudo service docker restart
  92
  93 Setting up OPNFV Gerrit in order to being able to clone the code
  94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95 - Start setting up OPNFV gerrit by creating a SSH key (unless you
  96   don't already have one), create one with ssh-keygen
  97
  98 - Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
  99   (this requires a Linux foundation account, create one if you do not
 100   already have one)
 101
 102 - Select "SSH Public Keys" to the left and then "Add Key" and paste
 103   your public key in.
 104
 105 Clone the OPNFV code Git repository with your SSH key
 106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 107 Now it is time to clone the code repository:
 108
 109 .. code-block:: bash
 110
 111     $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
 112
 113 Now you should have the OPNFV fuel repository with the Fuel
 114 directories stored locally on your build host.
 115
 116 Check out the Brahmaputra release:
 117
 118 .. code-block:: bash
 119
 120     $ cd fuel
 121     $ git checkout brahmaputra.1.0
 122
 123 Clone the OPNFV code Git repository without a SSH key
 124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 125 You can also opt to clone the code repository without a SSH key:
 126
 127 .. code-block:: bash
 128
 129     $ git clone https://gerrit.opnfv.org/gerrit/fuel
 130
 131 Make sure to checkout the release tag as described above.
 132
 133 Support for building behind a http/https/rsync proxy
 134 ----------------------------------------------------
 135
 136 The build system is able to make use of a web proxy setup if the
 137 http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or
 138 RSYNC_CONNECT_PROG environment variables have been set before invoking make.
 139
 140 The proxy setup must permit port 80 (http), 443 (https) and 873
 141 (rsync).
 142
 143 Important note about the host Docker daemon settings
 144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 145
 146 The Docker daemon on the host must be configured to use the http proxy
 147 for it to be able to pull the base Ubuntu 14.04 image from the Docker
 148 registry before invoking make! In Ubuntu this is done by adding a line
 149 like:
 150
 151 export http_proxy="http://10.0.0.1:8888/"
 152
 153 to /etc/default/docker and restarting the Docker daemon.
 154
 155 Setting proxy environment variables prior to build
 156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 157
 158 The build system will make use the following environment variables
 159 that needs to be exported to subshells by using export (bash) or
 160 setenv (csh/tcsh).
 161
 162 | http_proxy (or HTTP_PROXY)
 163 | https_proxy (or HTTP_PROXY)
 164 | no_proxy (or NO_PROXY)
 165 | RSYNC_PROXY
 166 | RSYNC_CONNECT_PROG
 167
 168 As an example, these are the settings that were put in the user's
 169 .bashrc when verifying the proxy build functionality:
 170
 171 | export RSYNC_PROXY=10.0.0.1:8888
 172 | export http_proxy=http://10.0.0.1:8888
 173 | export https_proxy=http://10.0.0.1:8888
 174 | export no_proxy=localhost,127.0.0.1,.consultron.com,.sock
 175
 176 Using a ssh proxy for the rsync connection
 177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 178
 179 If the proxy setup is not allowing the rsync protocol, an alternative
 180 solution is to use a SSH tunnel to a machine capable of accessing the
 181 outbound port 873. Set the RSYNC_CONNECT_PROG according to the rsync
 182 manual page (for example to "ssh <username>@<hostname> nc %H 873")
 183 to enable this. Also note that netcat needs to be installed on the
 184 remote system!
 185
 186 Make sure that the ssh command also refers to the user on the remote
 187 system, as the command itself will be run from the Docker build container
 188 as the root user (but with the invoking user's SSH keys).
 189
 190 Disabling the Ubuntu repo cache if rsync is not allowed
 191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 192
 193 During the build phase, a local Ubuntu package repository is fetched
 194 from upstream in order to be added to the OPNFV Fuel ISO and for parts
 195 of this process rsync is used.
 196
 197 If neither of the two available methods for proxying rsync are
 198 available, the last resort is to turn off the caching of the Ubuntu
 199 packages in the build system. This is done by removing the
 200 "f_repobuild" from SUBDIRS in the beginning of
 201 the fuel/build/f_isoroot/Makefile.
 202
 203 Note! Doing this will require the Fuel master node to have Internet
 204 access when installing the ISO artifact built as no Ubuntu package
 205 cache will be on the ISO!
 206
 207 Configure your build environment
 208 --------------------------------
 209
 210 ** Configuring the build environment should not be performed if building
 211 standard Brahmaputra release **
 212
 213 Select the versions of the components you want to build by editing the
 214 fuel/build/config.mk file.
 215
 216 Non official build: Selecting which plugins to build
 217 ----------------------------------------------------
 218 In order to cut the build time for unofficial builds (made by an
 219 individual developer locally), the selection if which Fuel plugins to
 220 build (if any) can be done by environment variable
 221 "BUILD_FUEL_PLUGINS" prior to building.
 222
 223 Only the plugin targets from fuel/build/f_isoroot/Makefile that are
 224 specified in the environment variable will then be built. In order to
 225 completely disable the building of plugins, the environment variable
 226 is set to " ". When using this functionality, the resulting iso file
 227 will be prepended with the prefix "unofficial-" to clearly indicate
 228 that this is not a full build.
 229
 230 This method of plugin selection is not meant to be used from within
 231 Gerrit!
 232
 233 Building
 234 ========
 235
 236 There are two methods available for building Fuel:
 237
 238 - A low level method using Make
 239
 240 - An abstracted method using build.sh
 241
 242 Low level build method using make
 243 ---------------------------------
 244 The low level method is based on Make:
 245
 246 From the <fuel/build> directory, invoke <make [target]>
 247
 248 Following targets exist:
 249
 250 - none/all -  this will:
 251
 252   - Initialize the docker build environment
 253
 254   - Build Fuel from upstream (as defined by fuel-build/config-spec)
 255
 256   - Build the OPNFV defined plugins/features from upstream
 257
 258   - Build the defined additions to fuel (as defined by the structure
 259     of this framework)
 260
 261   - Apply changes and patches to fuel (as defined by the structure of
 262     this framework)
 263
 264   - Reconstruct a fuel .iso image
 265
 266 - clean - this will remove all artifacts from earlier builds.
 267
 268 - debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso"
 269
 270 If the build is successful, you will find the generated ISO file in
 271 the <fuel/build/release> subdirectory!
 272
 273 Abstracted build method using build.sh
 274 --------------------------------------
 275 The abstracted build method uses the <fuel/ci/build.sh> script which
 276 allows you to:
 277
 278 - Create and use a build cache - significantly speeding up the
 279   build time if upstream repositories have not changed.
 280
 281 - push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:)
 282
 283 For more info type <fuel/ci/build.sh -h>.
 284
 285 Artifacts
 286 =========
 287
 288 The artifacts produced are:
 289
 290 - <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is
 291   replaced with the build identity provided to the build system
 292
 293 - <OPNFV_XXXX.iso.txt> - Which holds version metadata.
 294
 295 References
 296 ==========
 297
 298 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>`_
 299
 300 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>`_
 301
 302 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>`_