-==============================================================================================
-OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool
-==============================================================================================
-
-License
-=======
-
-This work is licensed under a Creative Commons Attribution 4.0
-International License. .. http://creativecommons.org/licenses/by/4.0 ..
-(c) Jonas Bjurel (Ericsson AB) and others
+.. This document is protected/licensed under the following conditions
+.. (c) Jonas Bjurel (Ericsson AB)
+.. Licensed under a Creative Commons Attribution 4.0 International License.
+.. You should have received a copy of the license along with this work.
+.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
+========
Abstract
========
Colorado release of OPNFV build system, dependencies and required
system resources.
+============
Introduction
============
The audience of this document is assumed to have good knowledge in
network and Unix/Linux administration.
+============
Requirements
============
Minimum Hardware Requirements
------------------------------
+=============================
- ~30 GB available disc
- 4 GB RAM
Minimum Software Requirements
------------------------------
+=============================
-The build host should run Ubuntu 14.04 operating system.
+The build host should run Ubuntu 14.04 or 16.04 operating system.
On the host, the following packages must be installed:
- curl (simply available through $ sudo apt-get install curl)
+============
Preparations
============
Setting up the Docker build container
--------------------------------------
+=====================================
+
After having installed Docker, add yourself to the docker group:
.. code-block:: bash
$ sudo service docker restart
Setting up OPNFV Gerrit in order to being able to clone the code
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------------------------------------------
+
- Start setting up OPNFV gerrit by creating a SSH key (unless you
don't already have one), create one with ssh-keygen
your public key in.
Clone the OPNFV code Git repository with your SSH key
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------------------
+
Now it is time to clone the code repository:
.. code-block:: bash
.. code-block:: bash
$ cd fuel
- $ git checkout colorado.1.0
+ $ git checkout colorado.3.0
Clone the OPNFV code Git repository without a SSH key
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------------------
+
You can also opt to clone the code repository without a SSH key:
.. code-block:: bash
Make sure to checkout the release tag as described above.
Support for building behind a http/https/rsync proxy
-----------------------------------------------------
+====================================================
The build system is able to make use of a web proxy setup if the
http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or
RSYNC_CONNECT_PROG environment variables have been set before invoking make.
-The proxy setup must permit port 80 (http), 443 (https) and 873
-(rsync).
+The proxy setup must permit port 80 (http) and 443 (https).
+Rsync protocol is currently not used during build process.
Important note about the host Docker daemon settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------------------------------
The Docker daemon on the host must be configured to use the http proxy
for it to be able to pull the base Ubuntu 14.04 image from the Docker
to /etc/default/docker and restarting the Docker daemon.
Setting proxy environment variables prior to build
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------
The build system will make use the following environment variables
that needs to be exported to subshells by using export (bash) or
export no_proxy=localhost,127.0.0.1,.consultron.com,.sock
Using a ssh proxy for the rsync connection
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------
If the proxy setup is not allowing the rsync protocol, an alternative
solution is to use a SSH tunnel to a machine capable of accessing the
system, as the command itself will be run from the Docker build container
as the root user (but with the invoking user's SSH keys).
-Disabling the Ubuntu repo cache if rsync is not allowed
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-During the build phase, a local Ubuntu package repository is fetched
-from upstream in order to be added to the OPNFV Fuel ISO and for parts
-of this process rsync is used.
-
-If neither of the two available methods for proxying rsync are
-available, the last resort is to turn off the caching of the Ubuntu
-packages in the build system. This is done by removing the
-"f_repobuild" from SUBDIRS in the beginning of
-the fuel/build/f_isoroot/Makefile.
-
-Note! Doing this will require the Fuel master node to have Internet
-access when installing the ISO artifact built as no Ubuntu package
-cache will be on the ISO!
-
Configure your build environment
---------------------------------
+================================
** Configuring the build environment should not be performed if building
standard Colorado release **
fuel/build/config.mk file.
Non official build: Selecting which plugins to build
-----------------------------------------------------
+====================================================
+
In order to cut the build time for unofficial builds (made by an
individual developer locally), the selection if which Fuel plugins to
build (if any) can be done by environment variable
This method of plugin selection is not meant to be used from within
Gerrit!
+========
Building
========
- An abstracted method using build.sh
Low level build method using make
----------------------------------
+=================================
+
The low level method is based on Make:
From the <fuel/build> directory, invoke <make [target]>
the <fuel/build/release> subdirectory!
Abstracted build method using build.sh
---------------------------------------
+======================================
+
The abstracted build method uses the <fuel/ci/build.sh> script which
allows you to:
For more info type <fuel/ci/build.sh -h>.
+=========
Artifacts
=========
- <OPNFV_XXXX.iso.txt> - Which holds version metadata.
+==========
References
==========
-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
+1) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html
-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
+2) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html
-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
+3) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html
Code Review / fuel.git / blobdiff