-:Authors: Jonas Bjurel (Ericsson)
-:Version: 0.1.0
+========================================================================
+OPNFV Build instructions for - Fuel deployment tool - OPNFV Arno release
+========================================================================
-================================================================
-OPNFV Build instructions for - < Component denomination >
-================================================================
+.. contents:: Table of Contents
+ :backlinks: none
Abstract
========
-This document describes how to build <Component>, build system dependencies and required system resources.
+This document describes how to build the Fuel deployment tool for the Arno release of OPNFV, the build system, dependencies and required system resources.
License
=======
-Fuel@OPNFV DOCs (c) by Jonas Bjurel (Ericsson AB)
-
-Fuel@OPNFV DOCs (c) is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-
-**Contents**
-
-1 Version history
-
-2 Introduction
+Arno release of OPNFV when using Fuel as a deployment tool DOCs (c) by Jonas Bjurel (Ericsson AB)
-3 Requirements
+Arno release of OPNFV when using Fuel as a deployment tool DOCs (c) are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-4 Building
-5 Artifacts
-
-1 Version history
-===================
+Version history
+===============
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 2015-04-23 | 0.1.0 | Jonas Bjurel | First draft |
-| | | | |
+| 2015-06-03 | 1.0.0 | Jonas Bjurel | Instructions for |
+| | | (Ericsson AB) | the Arno release |
+--------------------+--------------------+--------------------+--------------------+
-2 Introduction
-================
+Introduction
+============
-This document describes build system used to build Fuel@OPNFV, required dependencies and minimum requirements on the host to be used for the buildsystem.
+This document describes the build system used to build the Fuel deployment tool for the Arno release of OPNFV, required dependencies and minimum requirements on the host to be used for the buildsystem.
The Fuel build system is desigened around Docker containers such that dependencies outside of the build system can be kept to a minimum. It also shields the host from any potential dangerous operations performed by the build system.
The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.
-3 Requirements
-================
+Requirements
+============
-3.1 Minimum Hardware Requirements
----------------------------------
+Minimum Hardware Requirements
+-----------------------------
- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed
- 4 GB RAM
-3.2 Minimum Software Requirements
----------------------------------
+Minimum Software Requirements
+-----------------------------
The build host should run Ubuntu 14.04 operating system.
- curl (simply available through sudo apt-get install curl)
-3.3 Preparations
-----------------
+Preparations
+------------
-3.3.1 Setting up the Docker build container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Setting up the Docker build container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After having installed Docker, add yourself to the docker group:
<usermod -a -G docker [userid]>
<sudo service docker.io restart>
-3.3.2 Setting up OPNFV Gerrit in order to being able to clone the code
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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/>
- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in.
-3.3.3 Clone the OPNFV code git repository
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Clone the OPNFV code git repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now it is time to clone the code repository:
<git clone ssh://'Linux foundation user'@gerrit.opnfv.org:29418/genesis>
-Now you should have the OPNFV genesis repository with Fuel@OPNFV stored locally on your build host.
+Now you should have the OPNFV genesis repository with the Fuel directories stored locally on your build host.
-4 Building
-============
+Check out the Arno release:
+<cd genesis>
+<git checkout arno.2015.1.0>
+
+Building
+========
-There are two methods available for building Fuel@OPNFV:
+There are two methods available for building Fuel:
- A low level method using Make
- An abstracted method using build.sh
-4.1 Configure your build environment
+Configure your build environment
-------------------------------------
+** Configuring the build environment should not be performed if building standard Arno release **
+
Select the versions of the components you want to build by editing the fuel/build/config.mk file.
-Note if you want to build with OpenDaylight SDN controller you need to uncomment the lines starting
-with odl-main and java-main
-4.2 Low level build method using make
---------------------------------------
+Low level build method using make
+---------------------------------
The low level method is based on Make:
-From the <fuel/build directory> invoke <make [target]>
+From the <fuel/build> directory, invoke <make [target]>
Following targets exist:
- none/all - this will:
- - If not allready existing, initialize the docker build environment
+ - If not already existing, initialize the docker build environment
- If not already done, build OpenDaylight from upstream (as defined by fuel-build config-spec)
If the build is successful, you will find the generated ISO file in the <fuel/build/release> subdirectory!
-4.3 Abstracted build method using build.sh
-===========================================
-The abstracted build method useses the <fuel/ci/build.sh> script which allows you to:
+Abstracted build method using build.sh
+======================================
+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 buildtime if upstream repositories have not changed.
For more info type <fuel/ci/build.sh -h>.
-5 Artifacts
-=============
+Artifacts
+=========
The artifacts produced are:
-- <OPNFV_XXXX.iso> - Which represents the bootable Fuel@OPNFV 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.
-6 References
-=============
+References
+==========
+-
+
+:Authors: Jonas Bjurel (Ericsson)
+:Version: 1.0.0
+
+**Documentation tracking**
+
+Revision: _sha1
+
+Build date: _date
| 2015-06-02 | 0.0.5 | Christopher Price | Minor changes |
| | | (Ericsson AB) | |
+--------------------+--------------------+--------------------+--------------------+
+| 2015-06-03 | 0.0.6 | Jonas Bjurel | Minor changes |
+| | | (Ericsson AB) | |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-06-03 | 0.0.7 | Jonas Bjurel | Added instructions |
+| | | (Ericsson AB) | on how to enable |
+| | | | ODL |
++--------------------+--------------------+--------------------+--------------------+
Introduction
The physical TOR switches are **not** automatically configured from the OPNFV reference platform. All the networks involved in the OPNFV infrastructure as well as the provider networks and the private tenant VLANs needs to be manually configured.
-Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification http://artifacts.opnfv.org/arno.2015.1.0/docs/pharos-spec.arno.2015.1.0.pdf
+Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification http://artifacts.opnfv.org/arno.2015.1.0/docs/pharos-spec.arno.2015.1.0.pdf
OPNFV Software installation and deployment
==========================================
6. Select DNS & Hostname and change the following fields to appropriate values:
- - Hostname <CEE Region name>-fuel
+ - Hostname <OPNFV Region name>-fuel
- Domain <Domain Name>
- NTP Server 2 <Customer NTP server 2>
- - NTP Server 3<Customer NTP server 3>
+ - NTP Server 3 <Customer NTP server 3>
**Note: This step is only to pass the network sanity test, the actual ntp parameters will be set with the pre-deploy script.**
Installation health-check
=========================
+38. Perform system health-check
Now that the OPNFV environment has been created, and before the post installation configurations is started, perform a system health check from the Fuel GUI:
- Select the “Health check” TAB.
- Select all test cases
- And click “Run tests”
-All test cases except the following should pass:
+All test cases should pass.
Post installation and deployment actions
========================================
-**-**
+
+Activate OpenDaylight and VXLAN network segmentation
+----------------------------------------------------
+** Note: With the current release, the OpenDaylight option is experimental!**
+** Note: With ODL enabled, L3 features will no longer be available **
+The activation of ODL within a deployed Fuel system is a two part process.
+
+The first part involves staging the ODL container, i.e. starting the ODL container itself.
+The second part involves a reconfiguration of the underlying networking components to enable VXLAN tunneling.
+The staging of the ODL container works without manual intervention except for editing with a valid DNS IP for your system
+
+For the second part - the reconfiguration of the networking, the script <config_net_odl.sh> is provided as a baseline example to show what needs to be configured for your system system setup. Since there are many variants of valid networking topologies, this script will not be 100% correct in all deployment cases and some manual script modifications maybe required.
+
+39. Enable the ODL controller
+ssh to any of the OpenStack controllers and issue the following command as root user: </opt/opnfv/odl/stage_odl.sh>
+This script will start ODL, load modules and make the Controller ready for use.
+** Note: - The script should only be ran on a single controller (even if the system is setup in a High Availability OpenStack mode). **
+
+40. Verify that the OpenDaylight GUI is accessible
+Point your browser to the following URL: <http://{ODL-CONTROLLER-IP}:8181/dlux/index.html> and login:
+Username: Admin
+Password: Admin
+
+41. Reconfiguring the networking and switch to VXLAN network segmentation
+ssh to all of the nodes and issue the following command </opt/opnfv/odl/config_net_odl.sh> in the order specified below:
+a. All compute nodes
+b. All OpenStack controller nodes except the one running the ODL-controller
+c. The OpenStack controller also running the ODL controller
+
+This script will reconfigure the networking from VLAN Segregation to VXLAN mode.
+
References
==========
OPNFV
-----
+<www.opnfv.org>
+<https://wiki.opnfv.org/get_started>
OpenStack
---------
+<http://www.openstack.org/software/juno>
+<http://docs.openstack.org>
OpenDaylight
------------
+<http://www.opendaylight.org/software/downloads>
Fuel
----
+<https://wiki.openstack.org/wiki/Fuel>
+
:Authors: Jonas Bjurel (Ericsson AB)
-:Version: 0.0.5
+:Version: 0.0.7
**Documentation tracking**
-Revision: _sha1_
-
-Build date: _date_
+Revision: _sha1
+Build date: _date
Code Review / genesis.git / commitdiff