docs/buildprocedure/build.instruction.rst

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