diff options
Diffstat (limited to 'docs/build-instruction.rst')
| -rw-r--r-- | docs/build-instruction.rst | 65 |
1 files changed, 39 insertions, 26 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst index 2eb6b658d..7e381500b 100644 --- a/docs/build-instruction.rst +++ b/docs/build-instruction.rst @@ -1,6 +1,6 @@ -================================================================================================= -OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool -================================================================================================= +============================================================================================== +OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool +============================================================================================== License ======= @@ -13,14 +13,14 @@ Abstract ======== This document describes how to build the Fuel deployment tool for the -Brahmaputra release of OPNFV build system, dependencies and required +Colorado release of OPNFV build system, dependencies and required system resources. Introduction ============ This document describes the build system used to build the Fuel -deployment tool for the Brahmaputra release of OPNFV, required +deployment tool for the Colorado release of OPNFV, required dependencies and minimum requirements on the host to be used for the build system. @@ -51,9 +51,12 @@ On the host, the following packages must be installed: - An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed - - A kernel equal- or later than 3.19 (Vivid) (simply available through sudo apt-get install linux-generic-lts-vivid) - - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported + - A kernel equal- or later than 3.19 (Vivid), simply available through + +.. code-block:: bash + + $ sudo apt-get install linux-generic-lts-vivid - docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Note: use the latest version from @@ -74,7 +77,9 @@ Setting up the Docker build container ------------------------------------- After having installed Docker, add yourself to the docker group: -$ sudo usermod -a -G docker [userid] +.. code-block:: bash + + $ sudo usermod -a -G docker [userid] Also make sure to define relevant DNS servers part of the global DNS chain in your </etc/default/docker> configuration file. @@ -82,11 +87,13 @@ Uncomment, and modify the values appropriately. For example: -<DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4"> +.. code-block:: bash + + DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" Then restart docker: -.. code-block:: console +.. code-block:: bash $ sudo service docker restart @@ -113,12 +120,12 @@ Now it is time to clone the code repository: Now you should have the OPNFV fuel repository with the Fuel directories stored locally on your build host. -Check out the Brahmaputra release: +Check out the Colorado release: .. code-block:: bash $ cd fuel - $ git checkout brahmaputra.1.0 + $ git checkout colorado.1.0 Clone the OPNFV code Git repository without a SSH key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -148,7 +155,9 @@ for it to be able to pull the base Ubuntu 14.04 image from the Docker registry before invoking make! In Ubuntu this is done by adding a line like: -export http_proxy="http://10.0.0.1:8888/" +.. code-block:: bash + + export http_proxy="http://10.0.0.1:8888/" to /etc/default/docker and restarting the Docker daemon. @@ -159,19 +168,23 @@ The build system will make use the following environment variables that needs to be exported to subshells by using export (bash) or setenv (csh/tcsh). -| http_proxy (or HTTP_PROXY) -| https_proxy (or HTTP_PROXY) -| no_proxy (or NO_PROXY) -| RSYNC_PROXY -| RSYNC_CONNECT_PROG +.. code-block:: bash + + http_proxy (or HTTP_PROXY) + https_proxy (or HTTP_PROXY) + no_proxy (or NO_PROXY) + RSYNC_PROXY + RSYNC_CONNECT_PROG As an example, these are the settings that were put in the user's .bashrc when verifying the proxy build functionality: -| export RSYNC_PROXY=10.0.0.1:8888 -| export http_proxy=http://10.0.0.1:8888 -| export https_proxy=http://10.0.0.1:8888 -| export no_proxy=localhost,127.0.0.1,.consultron.com,.sock +.. code-block:: bash + + export RSYNC_PROXY=10.0.0.1:8888 + export http_proxy=http://10.0.0.1:8888 + export https_proxy=http://10.0.0.1:8888 + export no_proxy=localhost,127.0.0.1,.consultron.com,.sock Using a ssh proxy for the rsync connection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -208,7 +221,7 @@ Configure your build environment -------------------------------- ** Configuring the build environment should not be performed if building -standard Brahmaputra release ** +standard Colorado release ** Select the versions of the components you want to build by editing the fuel/build/config.mk file. @@ -295,8 +308,8 @@ The artifacts produced are: References ========== -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>`_ +1) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_ -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>`_ +2) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ -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>`_ +3) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ |