aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/build-instruction.rst65
-rw-r--r--docs/installation-instruction.rst79
2 files changed, 86 insertions, 58 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>`_
diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index d1036dd9e..fea90af0d 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -1,5 +1,5 @@
========================================================================================================
-OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool
========================================================================================================
License
@@ -12,7 +12,7 @@ License. .. http://creativecommons.org/licenses/by/4.0 ..
Abstract
========
-This document describes how to install the Brahmaputra release of
+This document describes how to install the Colorado release of
OPNFV when using Fuel as a deployment tool, covering it's usage,
limitations, dependencies and required system resources.
@@ -20,14 +20,14 @@ Introduction
============
This document provides guidelines on how to install and
-configure the Brahmaputra release of OPNFV when using Fuel as a
+configure the Colorado release of OPNFV when using Fuel as a
deployment tool, including required software and hardware configurations.
Although the available installation options give a high degree of
freedom in how the system is set-up, including architecture, services
and features, etc., said permutations may not provide an OPNFV
compliant reference architecture. This instruction provides a
-step-by-step guide that results in an OPNFV Brahmaputra compliant
+step-by-step guide that results in an OPNFV Colorado compliant
deployment.
The audience of this document is assumed to have good knowledge in
@@ -35,7 +35,7 @@ networking and Unix/Linux administration.
Preface
=======
-Before starting the installation of the Brahmaputra release of
+Before starting the installation of the Colorado release of
OPNFV, using Fuel as a deployment tool, some planning must be
done.
@@ -43,24 +43,30 @@ Retrieving the ISO image
------------------------
First of all, the Fuel deployment ISO image needs to be retrieved, the
-Fuel .iso image of the Brahmaputra release can be found at *Reference: 2*
+Fuel .iso image of the Colorado release can be found at *Reference: 2*
Building the ISO image
----------------------
Alternatively, you may build the Fuel .iso from source by cloning the
-opnfv/fuel git repository. To retrieve the repository for the Brahmaputra release use the following command:
+opnfv/fuel git repository. To retrieve the repository for the Colorado release use the following command:
-$ git clone https://gerrit.opnfv.org/gerrit/fuel
+.. code-block:: bash
-Check-out the Brahmaputra release tag to set the HEAD to the
-baseline required to replicate the Brahmaputra release:
+ $ git clone https://gerrit.opnfv.org/gerrit/fuel
-$ git checkout brahmaputra.1.0
+Check-out the Colorado release tag to set the HEAD to the
+baseline required to replicate the Colorado release:
+
+.. code-block:: bash
+
+ $ git checkout colorado.1.0
Go to the fuel directory and build the .iso:
-$ cd fuel/build; make all
+.. code-block:: bash
+
+ $ cd fuel/build; make all
For more information on how to build, please see *Reference: 14*
@@ -69,11 +75,11 @@ Other preparations
Next, familiarize yourself with Fuel by reading the following documents:
-- Fuel planning guide, please see *Reference: 8*
+- Fuel Installation Guide, please see *Reference: 8*
-- Fuel user guide, please see *Reference: 9*
+- Fuel User Guide, please see *Reference: 9*
-- Fuel operations guide, please see *Reference: 10*
+- Fuel Developer Guide, please see *Reference: 10*
- Fuel Plugin Developers Guide, please see *Reference: 11*
@@ -103,7 +109,7 @@ Hardware requirements
=====================
The following minimum hardware requirements must be met for the
-installation of Brahmaputra using Fuel:
+installation of Colorado using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
@@ -176,7 +182,7 @@ the Fuel 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 Brahmaputra hardware platform should
+Manual configuration of the Colorado hardware platform should
be carried out according to the OPNFV Pharos specification:
<https://wiki.opnfv.org/pharos/pharos_specification>
@@ -189,7 +195,7 @@ reference platform stack across a server cluster.
Install Fuel master
-------------------
-#. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
+#. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server.
#. Reboot the jump host to establish the Fuel server.
@@ -301,8 +307,17 @@ Install additional Plugins/Features on the FUEL node
#. Select wanted plugins/features from the /opt/opnfv/ directory.
-#. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm"
- Expected output: "Plugin ....... was successfully installed." (see figure below)
+#. Install the wanted plugin with the command
+
+ .. code-block:: bash
+
+ $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
+
+ Expected output (see figure below):
+
+ .. code-block:: bash
+
+ Plugin ....... was successfully installed.
.. figure:: img/plugin_install.png
@@ -315,7 +330,7 @@ Create an OpenStack Environment
.. figure:: img/newenv.png
-#. Select "<Liberty on Ubuntu 14.04>" and press <Next>
+#. Select "<Mitaka on Ubuntu 14.04>" and press <Next>
#. Select "compute virtulization method".
@@ -528,9 +543,9 @@ that can be used for installation / deployment of openstack.
- "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
- - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
+ - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos8.0 main restricted"
- - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
+ - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted"
- Click <Save Settings> at the bottom to Save your changes
@@ -639,7 +654,7 @@ OPNFV
OpenStack
---------
-3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
4) `OpenStack documentation <http://docs.openstack.org>`_
@@ -652,23 +667,23 @@ Fuel
----
6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
-7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
+7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_
-8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
+8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
+9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
-10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
+10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
-11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
Fuel in OPNFV
-------------
-13) `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>`_
+13) `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>`_
-14) `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>`_
+14) `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>`_
-15) `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>`_
+15) `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>`_