aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonas Bjurel <jonas.bjurel@ericsson.com>2016-02-10 21:42:40 +0100
committerJonas Bjurel <jonas.bjurel@ericsson.com>2016-02-16 16:42:25 +0100
commit5e6b6902829a3d13bc3cd7d0aed0f0a64b8d220c (patch)
treeefe0af29a66912705f6a2b59bc02b5e821b76d94
parentef0b33dcc34ee38d090487eabba122ae018980a0 (diff)
Final documentation review for Brahmaputra release
Issue of the Fuel documentation for Brahmaputra for final review as proposed by Sofia and me. This patch will constantly be amended with improvements, corrections, etc as we go. From time to time we will, merge this patch to generate consolidated scraped results. But we will re-issue a review patch with the same topic-branch and commit headline until we have a taged Brahmaputra release. To view/review the entire files from gerrit, click the settings icon almost at the top right, and select "lines of context: entire file" - Note: There is still unknowns highlighted by <TODO> - Please comment on disposition, content, directory placing, etc. - You can find the rendered versions of the Fuel@OPNFV specific docs from the CI-job for this patch. These include: - installation-instruction.rst - build-instruction.rst - release-notes.rst - Scraped document composit rendering are placed - TBD. These include: - installerconfig.rst - postinstall.rst Change-Id: I5e28141cf03d80e5da9c5e10f5e75a3a26994f38 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
-rw-r--r--docs/build-instruction.rst83
-rw-r--r--docs/configguide/installerconfig.rst101
-rw-r--r--docs/configguide/postinstall.rst3
-rw-r--r--docs/installation-instruction.rst92
-rw-r--r--docs/release-notes.rst88
5 files changed, 240 insertions, 127 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst
index f280799fd..d5721af0b 100644
--- a/docs/build-instruction.rst
+++ b/docs/build-instruction.rst
@@ -1,25 +1,24 @@
-============================================================================
-OPNFV Build instruction for the Fuel deployment tool
-============================================================================
+================================================================================================
+OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+================================================================================================
.. contents:: Table of Contents
:backlinks: none
+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
+
Abstract
========
This document describes how to build the Fuel deployment tool for the
-B release of OPNFV - the build system, dependencies and required
+Brahmaputra release of OPNFV build system, dependencies and required
system resources.
-
-License
-=======
-Brahmaputra release of OPNFV when using Fuel as a deployment tool DOCs (c) by Jonas Bjurel (Ericsson AB) and others.
-
-This document 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/>.
-
-
Introduction
============
@@ -55,17 +54,17 @@ 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)
+ - 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
-- docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Tested against ver 1.9.x and greater
+- docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Tested against version 1.9.x and greater
-- git (simply available through sudo apt-get install git)
+- git (simply available through $ sudo apt-get install git)
-- make (simply available through sudo apt-get install make)
+- make (simply available through $ sudo apt-get install make)
-- curl (simply available through sudo apt-get install curl)
+- curl (simply available through $ sudo apt-get install curl)
Preparations
============
@@ -74,17 +73,21 @@ Setting up the Docker build container
-------------------------------------
After having installed Docker, add yourself to the docker group:
-<sudo usermod -a -G docker [userid]>
+$ 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.
+Uncomment, and modify the values appropriately.
-Also make sure to define relevant DNS servers part of the global dns chain in
-in your </etc/default/docker> configuration file. Uncomment, modify the values appropriately
-and save and quit the file. For example:
+For example:
<DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4">
Then restart docker:
-<sudo service docker restart>
+.. code-block:: console
+
+$ sudo service docker restart
Setting up OPNFV Gerrit in order to being able to clone the code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -102,20 +105,20 @@ Clone the OPNFV code Git repository with your SSH key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now it is time to clone the code repository:
-<git clone ssh://'Linux foundation user'@gerrit.opnfv.org:29418/fuel>
+$ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
Now you should have the OPNFV fuel repository with the Fuel
directories stored locally on your build host.
Check out the Brahmaputra release:
-<cd fuel>
-<git checkout insert-b-release-tag-here0>
+$ cd fuel
+$ git checkout brahmaputra.1.0
Clone the OPNFV code Git repository without a SSH key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also opt to clone the code repository without a SSH key:
-<git clone https://gerrit.opnfv.org:29418/gerrit/fuel>
+$ git clone https://gerrit.opnfv.org:29418/gerrit/fuel
Make sure to checkout the release tag as described above.
@@ -168,9 +171,9 @@ 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
outbound port 873. Set the RSYNC_CONNECT_PROG according to the rsync
-manual page (for example to "ssh <username>@<hostname> nc %H 873") to enable
-this. Also note that netcat needs to be installed on the remote
-system!
+manual page (for example to "ssh <username>@<hostname> nc %H 873")
+to enable this. Also note that netcat needs to be installed on the
+remote system!
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
@@ -196,9 +199,11 @@ cache will be on the ISO!
Configure your build environment
--------------------------------
-** Configuring the build environment should not be performed if building standard Brahmaputra release **
+** Configuring the build environment should not be performed if building
+standard Brahmaputra release **
-Select the versions of the components you want to build by editing the fuel/build/config.mk file.
+Select the versions of the components you want to build by editing the
+fuel/build/config.mk file.
Non official build: Selecting which plugins to build
----------------------------------------------------
@@ -211,7 +216,7 @@ 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 indiciate
+will be prepended with the prefix "unofficial-" to clearly indicate
that this is not a full build.
This method of plugin selection is not meant to be used from within
@@ -236,13 +241,11 @@ Following targets exist:
- none/all - this will:
- - If not already existing, initialize the docker build environment
+ - Initialize the docker build environment
- - If not already done, build OpenDaylight from upstream (as defined
- by fuel-build config-spec)
+ - Build Fuel from upstream (as defined by fuel-build/config-spec)
- - If not already done, build fuel from upstream (as defined by
- fuel-build/config-spec)
+ - Build the OPNFV defined plugins/features from upstream
- Build the defined additions to fuel (as defined by the structure
of this framework)
@@ -284,4 +287,8 @@ The artifacts produced are:
References
==========
--
+1) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+
+2) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+
+3) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index f5ab62c26..ea08b6d31 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -6,12 +6,13 @@
Fuel configuration
==================
-This section provides brief guidelines on how to install and
+This section provides guidelines on how to install and
configure the Brahmaputra release of OPNFV when using Fuel as a
deployment tool including required software and hardware
configurations.
-For detailed instructions on how to install the Brahmaputra release using Fuel, see:<TODO>
+For detailed instructions on how to install the Brahmaputra release using
+Fuel, see *Reference 13* in section *"Fuel associated references"* below.
Pre-configuration activities
----------------------------
@@ -25,12 +26,13 @@ done.
Familiarize yourself with the Fuel by reading the
following documents:
-- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>
+- Fuel planning guide, please see *Reference: 8* in section *"Fuel associated references"* below.
-- Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>
+- Fuel user guide, please see *Reference: 9* in section *"Fuel associated references"* below.
-- Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>
+- Fuel operations guide, please see *Reference: 10* in section *"Fuel associated references"* below.
+- Fuel Plugin Developers Guide, please see *Reference: 11* in section *"Fuel associated references"* below.
Before the installation can start, a number of deployment specific parameters must be collected, those are:
@@ -54,12 +56,11 @@ Before the installation can start, a number of deployment specific parameters mu
Retrieving the ISO image
^^^^^^^^^^^^^^^^^^^^^^^^
First of all, the Fuel deployment ISO image needs to be retrieved, the
-.iso image of the Brahmaputra release of OPNFV when using Fuel as
-a deployment tool can be found at: <TODO>
+Fuel .iso image of the Brahmaputra release can be found at *Reference: 2*
Alternatively, you may build the .iso from source by cloning the
opnfv/fuel git repository. Detailed instructions on how to build
-a Fuel OPNFV .iso can be found here: <TODO>
+a Fuel OPNFV .iso can be found in *Reference: 14* at section *"Fuel associated references"* below.
Hardware requirements
---------------------
@@ -96,15 +97,15 @@ Following high level hardware requirements must be met:
| | over other nics as your hardware supports |
+--------------------+------------------------------------------------------+
-For a detailed hardware compatibility matrix - please see:
-<https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list/>
+For information on compatible hardware types available for use, please see
+*Reference: 11* in section *"Fuel associated references"* below.
Top of the rack (TOR) Configuration requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The switching infrastructure provides connectivity for the OPNFV
infrastructure operations, tenant networks (East/West) and provider
connectivity (North/South); it also provides needed
-connectivity for the storage Area Network (SAN). To avoid traffic
+connectivity for the Storage Area Network (SAN). To avoid traffic
congestion, it is strongly suggested that three physically separated
networks are used, that is: 1 physical network for administration and
control, one physical network for tenant private and public networks,
@@ -118,9 +119,6 @@ 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 Brahmaputra hardware platform should
-be carried out according to the OPNFV Pharos specification <TODO>
-
Jumphost configuration
----------------------
The Jumphost server, also known as the "Fuel master" provides needed
@@ -134,8 +132,8 @@ and another for jump-host communication with the OPNFV cluster.
Install the Fuel jump-host
^^^^^^^^^^^^^^^^^^^^^^^^^^
Mount the Fuel Brahmaputra ISO file as a boot device to the jump host
-server, reboot it, and install the Fuel Jumphost in accordance with the
-instructions found here: <TODO>
+server, reboot it, and install the Fuel Jumphost in accordance with installation instructions, see *Reference 13* in section *"Fuel associated references"*
+below.
Platform components configuration
@@ -218,7 +216,8 @@ developed by OPNFV:
for compatibility information**
The plugins come prepackaged, ready to install. To do so follow the
-instructions provided here: <TODO>
+installation instructions provided in *Reference 13* provided in section
+*"Fuel associated references"* below.
Fuel environment
^^^^^^^^^^^^^^^^
@@ -226,16 +225,17 @@ A Fuel environment is an OpenStack instance managed by Fuel,
one Fuel instance can manage several OpenStack instances/environments
with different configurations, etc.
-To create a Fuel instance, follow the instructions provided
-here: <TODO>
+To create a Fuel instance, follow the instructions provided in the installation
+instructions, see *Reference 13* in section *"Fuel associated references"* below.
Provisioning of aditional features and services
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Although the plugins have already previously been installed,
they are not per default enabled for the environment we just created.
-The plugins of you choice need to be enabled and configured.
+The plugins of your choice need to be enabled and configured.
-To enable a plugin, follow the instructions in the installation instructions <TODO>
+To enable a plugin, follow the installation instructions found in
+*Reference 13*, provided in section *"Fuel associated references"* below.
For configuration of the plugins, please refer to the corresponding feature in the ????? <TODO>
@@ -252,7 +252,8 @@ All the networking aspects need to be configured in terms of:
- etc.
For guidelines on how to configure networking, please refer to the
-installation instructions here: <TODO>
+installation instructions found in *Reference 13* provided in section
+*"Fuel associated references"* below.
Node allocation
^^^^^^^^^^^^^^^
@@ -262,7 +263,7 @@ while others don't; Some roles may be co-located with other roles, while
others may not. The Fuel GUI will guide you in the allocation of roles and
will not permit you to perform invalid allocations.
-For detailed guide-lines on node allocation, please refer to the installation instructions: <TODO>
+For detailed guide-lines on node allocation, please refer to the installation instructions found in *Reference 13*, provided in section *"Fuel associated references"* below.
Off-line deployment
^^^^^^^^^^^^^^^^^^^
@@ -271,11 +272,61 @@ repositories (default) or off-line using built-in local repositories on the
Fuel jump-start server.
For instructions on how to configure Fuel for off-line deployment, please
-refer to the installation instructions: <TODO>
+refer to the installation instructions found in, *Reference 13*, provided
+in section *"Fuel associated references"* below.
Deployment
^^^^^^^^^^
You should now be ready to deploy your OPNFV Brahmaputra environment - but before doing so you may want to verify your network settings.
For further details on network verification and deployment, please refer to
-the installation instructions: <TODO>
+the installation instructions found in, *Reference 13*, provided in section
+*"Fuel associated references"* below.
+
+Fuel associated references
+--------------------------
+
+OPNFV
+~~~~~
+
+1) `OPNFV Home Page <www.opnfv.org>`_
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+
+OpenStack
+~~~~~~~~~
+
+3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+
+4) `OpenStack documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+~~~~~~~~~~~~
+
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+
+Fuel
+~~~~
+
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
+
+8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
+
+9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+
+10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+
+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
+
+14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+
+15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
index b5d28e992..e80d72aaf 100644
--- a/docs/configguide/postinstall.rst
+++ b/docs/configguide/postinstall.rst
@@ -14,9 +14,10 @@ These validate the installation in terms of configuration, services,
networking, storage, policies, etc.
The execution of the full range of health checks takes less than 30 minutes.
-For instructions on how to run health-checks, please refer to the installation instructions: <TODO>
+For instructions on how to run health-checks, please refer to the Fuel installation instructions.
Platform components validation
------------------------------
Consult the feature sections in this document for any post-install
feature specific validation/health-checks.
+
diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index eb02d7860..aaf96becb 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -5,22 +5,20 @@ OPNFV Installation instruction for the Brahmaputra release of OPNFV when using F
.. contents:: Table of Contents
:backlinks: none
+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
+
Abstract
========
+
This document describes how to install the Brahmaputra release of
OPNFV when using Fuel as a deployment tool, covering it's usage,
limitations, dependencies and required system resources.
-License
-=======
-Brahmaputra release of OPNFV when using Fuel as a deployment tool
-Docs (c) by Jonas Bjurel (Ericsson AB)
-
-This document is licensed under a Creative Commons Attribution 4.0
-International License. You should have received a copy of the license
-along with this document. If not, see
-<http://creativecommons.org/licenses/by/4.0/>.
-
Introduction
============
@@ -48,40 +46,39 @@ 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 <TODO>
+Fuel .iso image of the Brahmaputra 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 Brahmaputra release use the following command:
$git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel
Check-out the Brahmaputra release tag to set the branch to the
baseline required to replicate the Brahmaputra release:
-$ git checkout stable/<TODO>
+$ git checkout brahmaputra.1.0
Go to the fuel directory and build the .iso:
$ cd fuel/build; make all
-For more information on how to build, please see "OPNFV Build
-instructions for - Brahmaputra release of OPNFV when using Fuel as
-a deployment tool which you retrieved with the repository at
-</fuel/fuel/docs/src/build-instructions.rst> <TODO>
+For more information on how to build, please see *Reference: 14*
+
+Other preparations
+------------------
Next, familiarize yourself with Fuel by reading the following documents:
-- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>
+- Fuel planning guide, please see *Reference: 8*
-- Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>
+- Fuel user guide, please see *Reference: 9*
-- Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>
+- Fuel operations guide, please see *Reference: 10*
-- Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>
+- Fuel Plugin Developers Guide, please see *Reference: 11*
Prior to installation, a number of deployment specific parameters must be collected, those are:
@@ -148,9 +145,7 @@ Help with Hardware Requirements
Calculate hardware requirements:
-Refer to the OpenStack Hardware Compatibility List:
-<https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list/>
-for more information on various hardware types available for use.
+For information on compatible hardware types available for use, please see *Reference: 11*.
When choosing the hardware on which you will deploy your OpenStack
environment, you should think about:
@@ -170,7 +165,7 @@ Top of the rack (TOR) Configuration requirements
The switching infrastructure provides connectivity for the OPNFV
infrastructure operations, tenant networks (East/West) and provider
connectivity (North/South); it also provides needed connectivity for
-the storage Area Network (SAN).
+the Storage Area Network (SAN).
To avoid traffic congestion, it is strongly suggested that three
physically separated networks are used, that is: 1 physical network
for administration and control, one physical network for tenant private
@@ -530,17 +525,15 @@ that can be used for installation / deployment of openstack.
- Replace the URI values for the "Name" values outlined below:
- - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
-
- - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
+ - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
- - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
+ - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main"
- - "mos-updates" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-updates main restricted"
+ - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
- - "mos-security" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-security main restricted"
+ - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
- - "mos-holdback" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-holdback main restricted"
+ - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
- Click <Save Settings> at the bottom to Save your changes
@@ -593,21 +586,44 @@ References
OPNFV
-----
-`OPNFV Home Page <www.opnfv.org>`_
+1) `OPNFV Home Page <www.opnfv.org>`_
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
OpenStack
---------
-`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
-`OpenStack documentation <http://docs.openstack.org>`_
+4) `OpenStack documentation <http://docs.openstack.org>`_
OpenDaylight
------------
-`OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
Fuel
----
-`Fuel documentation <https://wiki.openstack.org/wiki/Fuel>`_
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
+
+8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
+
+9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+
+10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+
+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
+
+14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+
+15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 0ffa683cb..253859bfe 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -5,23 +5,18 @@ OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a dep
.. contents:: Table of Contents
:backlinks: none
-Abstract
-========
-
-This document compiles the release notes for the Brahmaputra release of
-OPNFV when using Fuel as a deployment tool.
-
License
=======
-Brahmaputra release with the Fuel deployment tool Docs (c) by Jonas
-Bjurel (Ericsson AB)
+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 licensed under a Creative Commons Attribution 4.0
-International License.
+Abstract
+========
-You should have received a copy of the license along with this document.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
+This document compiles the release notes for the Brahmaputra release of
+OPNFV when using Fuel as a deployment tool.
Important notes
===============
@@ -33,7 +28,7 @@ The goal of the Brahmaputra release and this Fuel-based deployment process is
to establish a lab ready platform accelerating further development
of the OPNFV infrastructure.
-Carefully follow the installation-instructions.
+Carefully follow the installation-instructions provided in *Reference 13*.
Summary
=======
@@ -84,13 +79,13 @@ Release Data
| **Project** | fuel |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | fuel/<TODO> |
+| **Repo/tag** | brahmaputra.1.0 |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | Brahmaputra base release |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | <TODO> |
+| **Release date** | February 25 2016 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | Brahmaputra base release |
@@ -109,7 +104,7 @@ following upstream versions:
- OpenStack Liberty release
-- OpenDaylight Beryllium pre-release
+- OpenDaylight Beryllium pre-release <TODO>
- ONOS Drake release
@@ -118,11 +113,11 @@ Document changes
This is the third tracked version of the fuel installer for OPNFV. It
comes with the following documentation:
-- OPNFV Installation instructions for Brahmaputra with Fuel as deployment tool - **Changed**
+- Installation instructions - *Reference 13* - **Changed**
-- OPNFV Release Notes for Brahmaputra use of Fuel as deployment tool - **Changed**
+- Build instructions - *Reference 14* - **Changed**
-- OPNFV Build instructions for Brahmaputra with Fuel as deployment tool - **Changed**
+- Release notes - *Reference 15* - **Changed** (This document)
Reason for version
------------------
@@ -146,17 +141,16 @@ Deliverables
Software deliverables
~~~~~~~~~~~~~~~~~~~~~
-Fuel-based installer iso file <TODO>
+Fuel-based installer iso file found in *Reference 2*
Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for Brahmaputra release with the Fuel deployment tool
+- Installation instructions - *Reference 13*
-- OPNFV Build instructions for Brahmaputra release with the Fuel deployment
- tool
+- Build instructions - *Reference 14*
-- OPNFV Release Note for Brahmaputra release with the Fuel deployment tool - (this document)
+- Release notes - *Reference 15* (This document)
Known Limitations, Issues and Workarounds
=========================================
@@ -194,4 +188,48 @@ runs with the following results:
References
==========
For more information on the OPNFV Brahmaputra release, please see
-<TODO>
+
+OPNFV
+-----
+
+1) `OPNFV Home Page <www.opnfv.org>`_
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+
+OpenStack
+---------
+
+3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+
+4) `OpenStack documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+------------
+
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+
+Fuel
+----
+
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
+
+8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
+
+9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+
+10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+
+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
+
+14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
+
+15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool