aboutsummaryrefslogtreecommitdiffstats
path: root/docs/development
diff options
context:
space:
mode:
authorCristina Pauna <cristina.pauna@enea.com>2017-03-20 16:49:11 +0200
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2017-03-21 20:28:21 +0000
commite185a63ff1781afcf819967c53438907ebb0528f (patch)
tree2f4457228e08b573433d976f0f9ec2249631519b /docs/development
parentad53b1e755ff3cd4d3ebc01376ef1f5c426f48d4 (diff)
docs: Copy OPNFV docs dir as documentation base
Copy the files from fuel as base documentation. A subsequent commit will adapt it with aarch64 specifics. JIRA: ARMBAND-243 Change-Id: I085d3cfab3a65d8ab7954dcdc876f2b922889ee2 Signed-off-by: Cristina Pauna <cristina.pauna@enea.com> (cherry picked from commit 6a216628f75cb40fa3acffaa4faf280f09679f5b)
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/buildprocedure/index.rst18
-rw-r--r--docs/development/overview/build/build.instruction.rst (renamed from docs/development/buildprocedure/build.instruction.rst)119
-rw-r--r--docs/development/overview/build/index.rst16
3 files changed, 51 insertions, 102 deletions
diff --git a/docs/development/buildprocedure/index.rst b/docs/development/buildprocedure/index.rst
deleted file mode 100644
index 386f1e4..0000000
--- a/docs/development/buildprocedure/index.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. _armband-buildprocedure:
-
-.. 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/>.
-
-********************************************
-Build instruction for Fuel\@OPNFV on AArch64
-********************************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- build.instruction.rst
-
diff --git a/docs/development/buildprocedure/build.instruction.rst b/docs/development/overview/build/build.instruction.rst
index 405a0e7..5fe38cb 100644
--- a/docs/development/buildprocedure/build.instruction.rst
+++ b/docs/development/overview/build/build.instruction.rst
@@ -1,23 +1,21 @@
-.. 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/>.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
========
Abstract
========
This document describes how to build the Fuel deployment tool for the
-AArch64 Colorado release of OPNFV build system, dependencies and
-required system resources.
+Danube 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 AArch64 Colorado release of OPNFV, required
+deployment tool for the Danube release of OPNFV, required
dependencies and minimum requirements on the host to be used for the
build system.
@@ -29,10 +27,6 @@ performed by the build system.
The audience of this document is assumed to have good knowledge in
network and Unix/Linux administration.
-Due to early docker and nodejs support on AArch64, we will still use an
-x86_64 Fuel Master to build and deploy an AArch64 target pool, as well
-as an x86_64 build machine for building the OPNFV ISO.
-
============
Requirements
============
@@ -40,14 +34,14 @@ Requirements
Minimum Hardware Requirements
=============================
-- ~50 GB available disc
+- ~30 GB available disc
- 4 GB RAM
Minimum Software Requirements
=============================
-The build host should run Ubuntu 14.04 or 16.04 (x86_64) operating system.
+The build host should run Ubuntu 14.04 or 16.04 operating system.
On the host, the following packages must be installed:
@@ -64,19 +58,11 @@ On the host, the following packages must be installed:
installation notes for Ubuntu 14.04. Note: use the latest version from
Docker (docker-engine) and not the one in Ubuntu 14.04.
-- git
-
-- make
-
-- curl
-
-Apart from docker, all other package requirements listed above are
-simply available through:
-
-.. code-block:: bash
+- git (simply available through $ sudo apt-get install git)
- $ sudo apt-get install git make curl
+- make (simply available through $ sudo apt-get install make)
+- curl (simply available through $ sudo apt-get install curl)
============
Preparations
@@ -113,40 +99,40 @@ 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
-- Add your generated public key in OPNFV Gerrit (https://gerrit.opnfv.org/)
+- Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
(this requires a Linux foundation account, create one if you do not
already have one)
- Select "SSH Public Keys" to the left and then "Add Key" and paste
your public key in.
-Clone the armband@OPNFV code Git repository with your SSH key
--------------------------------------------------------------
+Clone the OPNFV code Git repository with your SSH key
+-----------------------------------------------------
Now it is time to clone the code repository:
.. code-block:: bash
- $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/armband
+ $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
-Now you should have the OPNFV armband repository with its
+Now you should have the OPNFV fuel repository with the Fuel
directories stored locally on your build host.
-Check out the Colorado release:
+Check out the Danube release:
.. code-block:: bash
- $ cd armband
- $ git checkout colorado.3.0.1
+ $ cd fuel
+ $ git checkout danube.1.0
-Clone the armband@OPNFV code Git repository without a SSH key
--------------------------------------------------------------
+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
- $ git clone https://gerrit.opnfv.org/gerrit/armband
+ $ git clone https://gerrit.opnfv.org/gerrit/fuel
Make sure to checkout the release tag as described above.
@@ -172,7 +158,7 @@ like:
export http_proxy="http://10.0.0.1:8888/"
-to </etc/default/docker> and restarting the Docker daemon.
+to /etc/default/docker and restarting the Docker daemon.
Setting proxy environment variables prior to build
--------------------------------------------------
@@ -213,33 +199,14 @@ Make sure that the ssh command also refers to the user on the remote
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).
-
-Note! Armband build system uses git submodules to track fuel and
-other upstream repos, so in order to apply the above change, one
-should first initialize the submodules and apply armband patches
-(only needed once):
-
-.. code-block:: bash
-
- $ make patches-import
-
-
Configure your build environment
================================
** Configuring the build environment should not be performed if building
-standard Colorado release **
+standard Danube release **
Select the versions of the components you want to build by editing the
-<armband/upstream/fuel/build/config.mk> and
-<armband/upstream/fuel/build/armband.mk> files.
-
-Note! The same observation as above, before altering Makefile, run:
-
-.. code-block:: bash
-
- $ make patches-import
-
+fuel/build/config.mk file.
Non official build: Selecting which plugins to build
====================================================
@@ -249,9 +216,9 @@ individual developer locally), the selection if which Fuel plugins to
build (if any) can be done by environment variable
"BUILD_FUEL_PLUGINS" prior to building.
-Only the plugin targets from <armband/upstream/fuel/build/armband.mk> that
-are specified in the environment variable will then be built. In order
-to completely disable the building of plugins, the environment variable
+Only the plugin targets from fuel/build/f_isoroot/Makefile that are
+specified in the environment variable will then be built. In order to
+completely disable the building of plugins, the environment variable
is set to " ". When using this functionality, the resulting iso file
will be prepended with the prefix "unofficial-" to clearly indicate
that this is not a full build.
@@ -259,8 +226,6 @@ that this is not a full build.
This method of plugin selection is not meant to be used from within
Gerrit!
-Note! So far, only ODL, OVS, BGPVPN and Tacker plugins were ported to AArch64.
-
========
Building
========
@@ -276,15 +241,11 @@ Low level build method using make
The low level method is based on Make:
-From the <armband> directory, invoke <make [target]>
+From the <fuel/build> directory, invoke <make [target]>
Following targets exist:
-- release - this will do the same as:
-
- - make submodules-clean patches-import build
-
-- none/all/build - this will:
+- none/all - this will:
- Initialize the docker build environment
@@ -305,12 +266,12 @@ Following targets exist:
- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso"
If the build is successful, you will find the generated ISO file in
-the <armband/upstream/fuel/build/release> subdirectory!
+the <fuel/build/release> subdirectory!
Abstracted build method using build.sh
======================================
-The abstracted build method uses the <armband/ci/build.sh> script which
+The abstracted build method uses the <fuel/ci/build.sh> script which
allows you to:
- Create and use a build cache - significantly speeding up the
@@ -318,7 +279,7 @@ allows you to:
- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:)
-For more info type <armband/ci/build.sh -h>.
+For more info type <fuel/ci/build.sh -h>.
=========
Artifacts
@@ -326,17 +287,7 @@ Artifacts
The artifacts produced are:
-- <OPNFV_XXXX.iso> - Which represents the bootable Fuel for AArch64 image,
- XXXX is replaced with the build identity provided to the build system
+- <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is
+ replaced with the build identity provided to the build system
- <OPNFV_XXXX.iso.txt> - Which holds version metadata.
-
-==========
-References
-==========
-
-1) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html
-
-2) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html
-
-3) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html
diff --git a/docs/development/overview/build/index.rst b/docs/development/overview/build/index.rst
new file mode 100644
index 0000000..355e6b7
--- /dev/null
+++ b/docs/development/overview/build/index.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _armband-development-overview-build-label:
+
+*********************************
+Build instruction for Fuel\@OPNFV
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ build.instruction.rst
+