aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorcristinapauna <cristina.pauna@enea.com>2016-09-08 16:38:15 +0300
committercristinapauna <cristina.pauna@enea.com>2016-09-16 19:03:18 +0300
commitb832a3e82070e12dff555e2a83d604de7e398acb (patch)
tree52cc5df48f845cd32c3c46ce54f847a8bc11d30c /docs
parentdf00772021308f2f9a09f9a87db164daf104d1db (diff)
docs: Copy OPNFV docs dir as documentation base
There has been some restructuring of the documentation in fuel project. This commit copies those files, while a subsequent commit will adapt the documentation with aarch64 specifics. Change-Id: I56b52d5d16975b88fd5b26099b43046c6a5d5747 Signed-off-by: cristinapauna <cristina.pauna@enea.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/buildprocedure/build.instruction.rst (renamed from docs/build-instruction.rst)205
-rw-r--r--docs/buildprocedure/index.rst16
-rw-r--r--docs/configguide/installerconfig.rst332
-rw-r--r--docs/configguide/postinstall.rst24
-rw-r--r--docs/img/addnodes.pngbin24624 -> 0 bytes
-rw-r--r--docs/img/compute.pngbin49919 -> 0 bytes
-rw-r--r--docs/img/computelist.pngbin70343 -> 0 bytes
-rw-r--r--docs/img/fuelmenu1.pngbin8766 -> 0 bytes
-rw-r--r--docs/img/fuelmenu2.pngbin9679 -> 0 bytes
-rw-r--r--docs/img/fuelmenu2a.pngbin11511 -> 0 bytes
-rw-r--r--docs/img/fuelmenu3.pngbin9634 -> 0 bytes
-rw-r--r--docs/img/fuelmenu4.pngbin9843 -> 0 bytes
-rw-r--r--docs/img/fuelmenu5.pngbin22548 -> 0 bytes
-rw-r--r--docs/img/fuelmenu6.pngbin10703 -> 0 bytes
-rw-r--r--docs/img/grub-1.pngbin381031 -> 0 bytes
-rw-r--r--docs/img/health.pngbin54348 -> 0 bytes
-rw-r--r--docs/img/interfaceconf.pngbin58890 -> 0 bytes
-rw-r--r--docs/img/network.pngbin53472 -> 0 bytes
-rw-r--r--docs/img/neutronl3.pngbin71846 -> 0 bytes
-rw-r--r--docs/img/other.pngbin71641 -> 0 bytes
-rw-r--r--docs/img/plugins_aarch64.pngbin34853 -> 0 bytes
-rw-r--r--docs/img/verifynet.pngbin61499 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/addnodes.pngbin0 -> 24089 bytes
-rw-r--r--docs/installationprocedure/img/compute.pngbin0 -> 25978 bytes
-rw-r--r--docs/installationprocedure/img/computelist.pngbin0 -> 67975 bytes
-rw-r--r--docs/installationprocedure/img/fuelconsole1.png (renamed from docs/img/fuelconsole1.png)bin8269 -> 8269 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu1.pngbin0 -> 9276 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu2.pngbin0 -> 9774 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu3.pngbin0 -> 9783 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu4.pngbin0 -> 8843 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu5.pngbin0 -> 20442 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu6.pngbin0 -> 10322 bytes
-rw-r--r--docs/installationprocedure/img/grub-1.pngbin0 -> 388991 bytes
-rw-r--r--docs/installationprocedure/img/health.pngbin0 -> 51840 bytes
-rw-r--r--docs/installationprocedure/img/interfaceconf.pngbin0 -> 25676 bytes
-rw-r--r--docs/installationprocedure/img/interfaces.png (renamed from docs/img/interfaces.png)bin58851 -> 58851 bytes
-rw-r--r--docs/installationprocedure/img/network.pngbin0 -> 55423 bytes
-rw-r--r--docs/installationprocedure/img/neutronl3.pngbin0 -> 40478 bytes
-rw-r--r--docs/installationprocedure/img/newenv.png (renamed from docs/img/newenv.png)bin37483 -> 37483 bytes
-rw-r--r--docs/installationprocedure/img/nodes.png (renamed from docs/img/nodes.png)bin9155 -> 9155 bytes
-rw-r--r--docs/installationprocedure/img/offloadingmodes.png (renamed from docs/img/offloadingmodes.png)bin23017 -> 23017 bytes
-rw-r--r--docs/installationprocedure/img/other.pngbin0 -> 41526 bytes
-rw-r--r--docs/installationprocedure/img/plugin_install.png (renamed from docs/img/plugin_install.png)bin17431 -> 17431 bytes
-rw-r--r--docs/installationprocedure/img/plugins.pngbin0 -> 52382 bytes
-rw-r--r--docs/installationprocedure/img/verifynet.pngbin0 -> 33162 bytes
-rw-r--r--docs/installationprocedure/index.rst15
-rw-r--r--docs/installationprocedure/installation.instruction.rst (renamed from docs/installation-instruction.rst)241
-rw-r--r--docs/release-notes.rst259
-rw-r--r--docs/releasenotes/index.rst (renamed from docs/index.rst)13
-rw-r--r--docs/releasenotes/release-notes.rst250
50 files changed, 474 insertions, 881 deletions
diff --git a/docs/build-instruction.rst b/docs/buildprocedure/build.instruction.rst
index e1ead30..d755ee5 100644
--- a/docs/build-instruction.rst
+++ b/docs/buildprocedure/build.instruction.rst
@@ -1,26 +1,23 @@
-=================================================================================================
-OPNFV Build instruction for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool
-=================================================================================================
-
-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
+.. 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/>.
+========
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.
+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 AArch64 Colorado 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.
@@ -32,60 +29,50 @@ 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
============
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 (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:
- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed
- **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported
-
- - A kernel equal- or later than 3.19 (Vivid), simply available through:
+ - 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/engine/installation/ubuntulinux/ for
- installation notes for Ubuntu 14.04. Tested against version 1.9.x and greater
-
-- git
-
-- make
+- docker - see https://docs.docker.com/installation/ubuntulinux/ for
+ installation notes for Ubuntu 14.04. Note: use the latest version from
+ Docker (docker-engine) and not the one in Ubuntu 14.04.
-- curl
+- git (simply available through $ sudo apt-get install git)
-- fuseiso
-
-Apart from docker, all other package requirements listed above are
-simply available through:
-
-.. code-block:: bash
+- make (simply available through $ sudo apt-get install make)
- $ sudo apt-get install git make curl fuseiso
+- curl (simply available through $ sudo apt-get install curl)
+============
Preparations
============
Setting up the Docker build container
--------------------------------------
+=====================================
+
After having installed Docker, add yourself to the docker group:
.. code-block:: bash
@@ -109,56 +96,60 @@ Then restart docker:
$ sudo service docker restart
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:
.. code-block:: bash
- $ cd armband
+ $ cd fuel
$ git checkout colorado.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.
Support for building behind a http/https/rsync proxy
-----------------------------------------------------
+====================================================
The build system is able to make use of a web proxy setup if the
http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or
RSYNC_CONNECT_PROG environment variables have been set before invoking make.
-The proxy setup must permit port 80 (http), 443 (https) and 873 (rsync).
+The proxy setup must permit port 80 (http) and 443 (https).
+Rsync protocol is currently not used during build process.
Important note about the host Docker daemon settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------------------------------
The Docker daemon on the host must be configured to use the http proxy
for it to be able to pull the base Ubuntu 14.04 image from the Docker
@@ -169,10 +160,10 @@ 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
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------
The build system will make use the following environment variables
that needs to be exported to subshells by using export (bash) or
@@ -180,11 +171,11 @@ setenv (csh/tcsh).
.. code-block:: bash
- http_proxy (or HTTP_PROXY)
- https_proxy (or HTTP_PROXY)
- no_proxy (or NO_PROXY)
- RSYNC_PROXY
- RSYNC_CONNECT_PROG
+ 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:
@@ -197,7 +188,7 @@ As an example, these are the settings that were put in the user's
export no_proxy=localhost,127.0.0.1,.consultron.com,.sock
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
@@ -210,57 +201,24 @@ 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).
-Disabling the Ubuntu repo cache if rsync is not allowed
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-During the build phase, a local Ubuntu package repository is fetched
-from upstream in order to be added to the OPNFV Fuel ISO and for parts
-of this process rsync is used.
-
-If neither of the two available methods for proxying rsync are
-available, the last resort is to turn off the caching of the Ubuntu
-packages in the build system. This is done by removing the
-"f_repobuild" from SUBDIRS in the beginning of the
-<armband/upstream/fuel/build/f_isoroot/Makefile>.
-
-Note! Doing this will require the Fuel master node to have Internet
-access when installing the ISO artifact built as no Ubuntu package
-cache will be on the ISO!
-
-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 submodules-init
- $ make patches-import
-
Configure your build environment
---------------------------------
+================================
** Configuring the build environment should not be performed if building
standard Colorado release **
Select the versions of the components you want to build by editing the
-<armband/upstream/fuel/build/config.mk> file.
-
-Note! The same observation as above, before altering Makefile, run:
-
-.. code-block:: bash
-
- $ make submodules-init patches-import
+fuel/build/config.mk file.
Non official build: Selecting which plugins to build
-----------------------------------------------------
+====================================================
+
In order to cut the build time for unofficial builds (made by an
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/f_isoroot/Makefile> that are
+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
@@ -270,30 +228,26 @@ that this is not a full build.
This method of plugin selection is not meant to be used from within
Gerrit!
-Note! Not all plugins are ported to AArch64. Full list of supported plugins is in release notes.
-
+========
Building
========
-There is only one preffered method available for building Fuel for AArch64:
+There are two methods available for building Fuel:
- A low level method using Make
+- An abstracted method using build.sh
+
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 clean-docker clean-build
-
- - make submodules-init patches-import build
-
-- none/all/build - this will:
+- none/all - this will:
- Initialize the docker build environment
@@ -309,36 +263,43 @@ Following targets exist:
- Reconstruct a fuel .iso image
-- submodules-init - Initialize git submodules (fuel@OPNFV, fuel-library etc.)
+- clean - this will remove all artifacts from earlier builds.
-- submodules-clean - cleanup git submodules (fuel@OPNFV, fuel-library etc.)
+- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso"
-- patches-import - this will apply armband@OPNFV patches to git submodules
+If the build is successful, you will find the generated ISO file in
+the <fuel/build/release> subdirectory!
-- patches-export - this will export git submodules changes as armband patches
+Abstracted build method using build.sh
+======================================
-- clean-build - this will remove all artifacts from earlier builds.
+The abstracted build method uses the <fuel/ci/build.sh> script which
+allows you to:
-- clean-docker - this will remove all docker caches from earlier builds.
+- Create and use a build cache - significantly speeding up the
+ build time if upstream repositories have not changed.
-If the build is successful, you will find the generated ISO file in
-the <armband/upstream/fuel/build/release> subdirectory!
+- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:)
+
+For more info type <fuel/ci/build.sh -h>.
+=========
Artifacts
=========
The artifacts produced are:
-- <OPNFV_XXXX.iso> - Which represents the bootable (x86_64) 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 1.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html
-2) `OPNFV Build instruction for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/buildprocedure/index.html
-3) `OPNFV Release Note for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html
diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst
new file mode 100644
index 0000000..4f88814
--- /dev/null
+++ b/docs/buildprocedure/index.rst
@@ -0,0 +1,16 @@
+.. 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
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ build.instruction.rst
+
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
deleted file mode 100644
index 83fc605..0000000
--- a/docs/configguide/installerconfig.rst
+++ /dev/null
@@ -1,332 +0,0 @@
-.. 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/>.
-
-Fuel configuration
-==================
-This section provides guidelines on how to install and
-configure the Colorado release of OPNFV when using Fuel as a
-deployment tool including required software and hardware
-configurations.
-
-For detailed instructions on how to install the Colorado release using
-Fuel, see *Reference 13* in section *"Fuel associated references"* below.
-
-Pre-configuration activities
-----------------------------
-
-Planning the deployment
-
-Before starting the installation of the Colorado release of
-OPNFV when using Fuel as a deployment tool, some planning must be
-done.
-
-Familiarize yourself with the Fuel by reading the
-following documents:
-
-- Fuel planning guide, please see *Reference: 8* in section *"Fuel associated references"* below.
-
-- Fuel quick start guide, please see *Reference: 9* in section *"Fuel associated references"* below.
-
-- 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:
-
-#. Provider sub-net and gateway information
-
-#. Provider VLAN information
-
-#. Provider DNS addresses
-
-#. Provider NTP addresses
-
-#. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
-
-#. Monitoring Options you want to deploy (Ceilometer, Syslog, etc.)
-
-#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
-
-#. Other options not covered in the document are available in the links above
-
-
-Retrieving the ISO image
-^^^^^^^^^^^^^^^^^^^^^^^^
-First of all, the Fuel deployment ISO image needs to be retrieved, the
-Fuel .iso image of the Colorado 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 in *Reference: 14* at section *"Fuel associated references"* below.
-
-Hardware requirements
----------------------
-Following high level hardware requirements must be met:
-
-+--------------------+------------------------------------------------------+
-| **HW Aspect** | **Requirement** |
-| | |
-+====================+======================================================+
-| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
-| | |
-| | - 1 Fuel deployment master (may be virtualized) |
-| | |
-| | - 3(1) Controllers (1 colocated mongo/ceilometer |
-| | role, 2 Ceph-OSD roles) |
-| | |
-| | - 1 Compute (1 co-located Ceph-OSD role) |
-| | |
-+--------------------+------------------------------------------------------+
-| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
-| | support |
-+--------------------+------------------------------------------------------+
-| **RAM** | Minimum 16GB/server (Depending on VNF work load) |
-| | |
-+--------------------+------------------------------------------------------+
-| **Disk** | Minimum 256GB 10kRPM spinning disks |
-| | |
-+--------------------+------------------------------------------------------+
-| **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
-| | |
-| | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
-| | |
-| | note: These can be run on single NIC - or spread out |
-| | over other nics as your hardware supports |
-+--------------------+------------------------------------------------------+
-
-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
-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,
-and one physical network for SAN. The switching connectivity can (but
-does not need to) be fully redundant, in such case it and comprises a
-redundant 10GE switch pair for each of the three physically separated
-networks.
-
-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.
-
-Jumphost configuration
-----------------------
-The Jumphost server, also known as the "Fuel master" provides needed
-services/functions to deploy an OPNFV/OpenStack cluster as well functions
-for cluster life-cycle management (extensions, repair actions and upgrades).
-
-The Jumphost server requires 2 (4 if redundancy is required) Ethernet
-interfaces - one for external management of the OPNFV installation,
-and another for jump-host communication with the OPNFV cluster.
-
-Install the Fuel jump-host
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-Mount the Fuel Colorado ISO file as a boot device to the jump host
-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
----------------------------------
-
-Fuel-Plugins
-^^^^^^^^^^^^
-Fuel plugins enable you to install and configure additional capabilities for
-your Fuel OPNFV based cloud, such as additional storage types, networking
-functionality, or NFV features developed by OPNFV.
-
-Fuel offers an open source framework for creating these plugins, so there’s
-a wide range of capabilities that you can enable Fuel to add to your OpenStack
-clouds.
-
-The OPNFV Colorado version of Fuel provides a set of pre-packaged plugins
-developed by OPNFV:
-
-+--------------------+------------------------------------------------------+
-| **Plugin name** | **Short description** |
-| | |
-+====================+======================================================+
-| OpenDaylight | OpenDaylight provides an open-source SDN Controller |
-| | providing networking features such as L2 and L3 |
-| | network control, "Service Function Chaining", |
-| | routing, networking policies, etc. |
-| | More information on OpenDaylight in the OPNFV |
-| | Colorado release can be found in a separate |
-| | section in this document. |
-+--------------------+------------------------------------------------------+
-| ONOS | ONOS is another open-source SDN controller which |
-| | in essense fill the same role as OpenDaylight. |
-| | More information on ONOS in the OPNFV |
-| | Colorado release can be found in a separate |
-| | section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-| BGP-VPN | BGP-VPN provides an BGP/MPLS VPN service |
-| | More information on BGP-VPN in the OPNFV |
-| | Colorado release can be found in a separate |
-| | section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-| OVS-NSH | OVS-NSH provides a variant of Open-vSwitch |
-| | which supports "Network Service Headers" needed |
-| | for the "Service function chaining" feature |
-| | More information on "Service Function Chaining" |
-| | in the OPNFV Colorado release can be found in a |
-| | in a separate section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-| OVS-NFV | OVS-NFV provides a variant of Open-vSwitch |
-| | with carrier grade characteristics essential for |
-| | NFV workloads. |
-| | More information on OVS-NFV |
-| | in the OPNFV Colorado release can be found in a |
-| | in a separate section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-| KVM-NFV | KVM-NFV provides a variant of KVM with improved |
-| | virtualization characteristics essential for NFV |
-| | workloads. |
-| | More information on KVM-NFV |
-| | in the OPNFV Colorado release can be found in a |
-| | in a separate section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-| VSPERF | VSPERF provides a networking characteristics test |
-| | bench that facilitates characteristics/performance |
-| | evaluation of vSwithches |
-| | More information on VSPERF |
-| | in the OPNFV Colorado release can be found in a |
-| | in a separate section in this document. |
-| | |
-+--------------------+------------------------------------------------------+
-
-*Additional third-party plugins can be found here:*
-*https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/*
-**Note: Plugins are not necessarilly compatible with each other, see section
-"Configuration options, OPNFV scenarios" for compatibility information**
-
-The plugins come prepackaged, ready to install. To do so follow the
-installation instructions provided in *Reference 13* provided in section
-*"Fuel associated references"* below.
-
-Fuel environment
-^^^^^^^^^^^^^^^^
-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 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 your choice need to be enabled and configured.
-
-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 see section "Feature Configuration".
-
-Networking
-^^^^^^^^^^
-All the networking aspects need to be configured in terms of:
-- Interfaces/NICs
-- VLANs
-- Sub-nets
-- Gateways
-- User network segmentation (VLAN/VXLAN)
-- DNS
-- NTP
-- etc.
-
-For guidelines on how to configure networking, please refer to the
-installation instructions found in *Reference 13* provided in section
-*"Fuel associated references"* below.
-
-Node allocation
-^^^^^^^^^^^^^^^
-Now, it is time to allocate the nodes in your OPNFV cluster to OpenStack-,
-SDN-, and other feature/service roles. Some roles may require redundancy,
-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 found in *Reference 13*, provided in section *"Fuel associated references"* below.
-
-Off-line deployment
-^^^^^^^^^^^^^^^^^^^
-The OPNFV Colorado version of Fuel can be deployed using on-line upstream
-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 found in, *Reference 13*, provided
-in section *"Fuel associated references"* below.
-
-Deployment
-^^^^^^^^^^
-You should now be ready to deploy your OPNFV Colorado 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 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.mirantis.com/openstack/fuel/fuel-9.0/>`_
-
-8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
-
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
-
-10) `Fuel user guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.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 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/docs/installation-instruction.html>`_
-
-14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/docs/build-instruction.html>`_
-
-15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/docs/release-notes.html>`_
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
deleted file mode 100644
index 5064e4a..0000000
--- a/docs/configguide/postinstall.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-.. 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/>.
-
-Fuel post installation procedures
-=================================
-
-Automated post installation activities
---------------------------------------
-Fuel provides a fairly broad coverage of built in automated health checks.
-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 read 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/img/addnodes.png b/docs/img/addnodes.png
deleted file mode 100644
index 15730db..0000000
--- a/docs/img/addnodes.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/compute.png b/docs/img/compute.png
deleted file mode 100644
index fd7811f..0000000
--- a/docs/img/compute.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/computelist.png b/docs/img/computelist.png
deleted file mode 100644
index a4453d9..0000000
--- a/docs/img/computelist.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu1.png b/docs/img/fuelmenu1.png
deleted file mode 100644
index 15fccc4..0000000
--- a/docs/img/fuelmenu1.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu2.png b/docs/img/fuelmenu2.png
deleted file mode 100644
index 1f87c53..0000000
--- a/docs/img/fuelmenu2.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu2a.png b/docs/img/fuelmenu2a.png
deleted file mode 100644
index 396c123..0000000
--- a/docs/img/fuelmenu2a.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu3.png b/docs/img/fuelmenu3.png
deleted file mode 100644
index c9fa279..0000000
--- a/docs/img/fuelmenu3.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu4.png b/docs/img/fuelmenu4.png
deleted file mode 100644
index 1bc9c04..0000000
--- a/docs/img/fuelmenu4.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu5.png b/docs/img/fuelmenu5.png
deleted file mode 100644
index 1124798..0000000
--- a/docs/img/fuelmenu5.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/fuelmenu6.png b/docs/img/fuelmenu6.png
deleted file mode 100644
index 9ff62c7..0000000
--- a/docs/img/fuelmenu6.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/grub-1.png b/docs/img/grub-1.png
deleted file mode 100644
index 7488503..0000000
--- a/docs/img/grub-1.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/health.png b/docs/img/health.png
deleted file mode 100644
index 7167506..0000000
--- a/docs/img/health.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/interfaceconf.png b/docs/img/interfaceconf.png
deleted file mode 100644
index e8b4557..0000000
--- a/docs/img/interfaceconf.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/network.png b/docs/img/network.png
deleted file mode 100644
index 04c67d3..0000000
--- a/docs/img/network.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/neutronl3.png b/docs/img/neutronl3.png
deleted file mode 100644
index dd8d795..0000000
--- a/docs/img/neutronl3.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/other.png b/docs/img/other.png
deleted file mode 100644
index 4e740eb..0000000
--- a/docs/img/other.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/plugins_aarch64.png b/docs/img/plugins_aarch64.png
deleted file mode 100644
index 83c0262..0000000
--- a/docs/img/plugins_aarch64.png
+++ /dev/null
Binary files differ
diff --git a/docs/img/verifynet.png b/docs/img/verifynet.png
deleted file mode 100644
index 5932bc2..0000000
--- a/docs/img/verifynet.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/addnodes.png b/docs/installationprocedure/img/addnodes.png
new file mode 100644
index 0000000..b624056
--- /dev/null
+++ b/docs/installationprocedure/img/addnodes.png
Binary files differ
diff --git a/docs/installationprocedure/img/compute.png b/docs/installationprocedure/img/compute.png
new file mode 100644
index 0000000..fc1cf0f
--- /dev/null
+++ b/docs/installationprocedure/img/compute.png
Binary files differ
diff --git a/docs/installationprocedure/img/computelist.png b/docs/installationprocedure/img/computelist.png
new file mode 100644
index 0000000..4741965
--- /dev/null
+++ b/docs/installationprocedure/img/computelist.png
Binary files differ
diff --git a/docs/img/fuelconsole1.png b/docs/installationprocedure/img/fuelconsole1.png
index 61703ca..61703ca 100644
--- a/docs/img/fuelconsole1.png
+++ b/docs/installationprocedure/img/fuelconsole1.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu1.png b/docs/installationprocedure/img/fuelmenu1.png
new file mode 100644
index 0000000..ee7a0ed
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu1.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu2.png b/docs/installationprocedure/img/fuelmenu2.png
new file mode 100644
index 0000000..4dcbb6e
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu2.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu3.png b/docs/installationprocedure/img/fuelmenu3.png
new file mode 100644
index 0000000..23e6197
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu3.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu4.png b/docs/installationprocedure/img/fuelmenu4.png
new file mode 100644
index 0000000..3be29cd
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu4.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu5.png b/docs/installationprocedure/img/fuelmenu5.png
new file mode 100644
index 0000000..e3d2154
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu5.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu6.png b/docs/installationprocedure/img/fuelmenu6.png
new file mode 100644
index 0000000..cafbcdd
--- /dev/null
+++ b/docs/installationprocedure/img/fuelmenu6.png
Binary files differ
diff --git a/docs/installationprocedure/img/grub-1.png b/docs/installationprocedure/img/grub-1.png
new file mode 100644
index 0000000..e64b793
--- /dev/null
+++ b/docs/installationprocedure/img/grub-1.png
Binary files differ
diff --git a/docs/installationprocedure/img/health.png b/docs/installationprocedure/img/health.png
new file mode 100644
index 0000000..57bd8cf
--- /dev/null
+++ b/docs/installationprocedure/img/health.png
Binary files differ
diff --git a/docs/installationprocedure/img/interfaceconf.png b/docs/installationprocedure/img/interfaceconf.png
new file mode 100644
index 0000000..e00b03f
--- /dev/null
+++ b/docs/installationprocedure/img/interfaceconf.png
Binary files differ
diff --git a/docs/img/interfaces.png b/docs/installationprocedure/img/interfaces.png
index 291e434..291e434 100644
--- a/docs/img/interfaces.png
+++ b/docs/installationprocedure/img/interfaces.png
Binary files differ
diff --git a/docs/installationprocedure/img/network.png b/docs/installationprocedure/img/network.png
new file mode 100644
index 0000000..7bef050
--- /dev/null
+++ b/docs/installationprocedure/img/network.png
Binary files differ
diff --git a/docs/installationprocedure/img/neutronl3.png b/docs/installationprocedure/img/neutronl3.png
new file mode 100644
index 0000000..36291ef
--- /dev/null
+++ b/docs/installationprocedure/img/neutronl3.png
Binary files differ
diff --git a/docs/img/newenv.png b/docs/installationprocedure/img/newenv.png
index d6bc282..d6bc282 100644
--- a/docs/img/newenv.png
+++ b/docs/installationprocedure/img/newenv.png
Binary files differ
diff --git a/docs/img/nodes.png b/docs/installationprocedure/img/nodes.png
index 771e481..771e481 100644
--- a/docs/img/nodes.png
+++ b/docs/installationprocedure/img/nodes.png
Binary files differ
diff --git a/docs/img/offloadingmodes.png b/docs/installationprocedure/img/offloadingmodes.png
index 5b3cb17..5b3cb17 100644
--- a/docs/img/offloadingmodes.png
+++ b/docs/installationprocedure/img/offloadingmodes.png
Binary files differ
diff --git a/docs/installationprocedure/img/other.png b/docs/installationprocedure/img/other.png
new file mode 100644
index 0000000..c088488
--- /dev/null
+++ b/docs/installationprocedure/img/other.png
Binary files differ
diff --git a/docs/img/plugin_install.png b/docs/installationprocedure/img/plugin_install.png
index ff50633..ff50633 100644
--- a/docs/img/plugin_install.png
+++ b/docs/installationprocedure/img/plugin_install.png
Binary files differ
diff --git a/docs/installationprocedure/img/plugins.png b/docs/installationprocedure/img/plugins.png
new file mode 100644
index 0000000..8f7ea59
--- /dev/null
+++ b/docs/installationprocedure/img/plugins.png
Binary files differ
diff --git a/docs/installationprocedure/img/verifynet.png b/docs/installationprocedure/img/verifynet.png
new file mode 100644
index 0000000..e675562
--- /dev/null
+++ b/docs/installationprocedure/img/verifynet.png
Binary files differ
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
new file mode 100644
index 0000000..8e61be2
--- /dev/null
+++ b/docs/installationprocedure/index.rst
@@ -0,0 +1,15 @@
+.. 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/>.
+
+****************************************
+Installation instruction for Fuel\@OPNFV
+****************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ installation.instruction.rst
diff --git a/docs/installation-instruction.rst b/docs/installationprocedure/installation.instruction.rst
index 356f411..5dedb14 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installationprocedure/installation.instruction.rst
@@ -1,28 +1,24 @@
-====================================================================================================================
-OPNFV Installation instruction for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool
-====================================================================================================================
-
-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
+.. 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/>.
+========
Abstract
========
-This document describes how to install the Colorado 1.0 release of
-OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
-node pool.
+This document describes how to install the Colorado release of
+OPNFV when using Fuel as a deployment tool, covering its usage,
+limitations, dependencies and required system resources.
+============
Introduction
============
This document provides guidelines on how to install and
-configure the Colorado 1.0 release of OPNFV when using Fuel as a
-deployment tool, with an AArch64 (only) target node pool,
-including required software and hardware configurations.
+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
@@ -34,29 +30,30 @@ deployment.
The audience of this document is assumed to have good knowledge in
networking and Unix/Linux administration.
+=======
Preface
=======
-Before starting the installation of the AArch64 Colorado 1.0 release of
+
+Before starting the installation of the Colorado release of
OPNFV, using Fuel as a deployment tool, some planning must be
done.
Retrieving the ISO image
-------------------------
+========================
First of all, the Fuel deployment ISO image needs to be retrieved, the
-ArmbandFuel .iso image of the AArch64 Colorado 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 ArmbandFuel .iso from source by cloning the
-opnfv/armband git repository. To retrieve the repository for the AArch64
-Colorado 1.0 release use the following command:
+Alternatively, you may build the Fuel .iso from source by cloning the
+opnfv/fuel git repository. To retrieve the repository for the Colorado
+release use the following command:
.. code-block:: bash
- $ git clone https://gerrit.opnfv.org/gerrit/armband
+ $ git clone https://gerrit.opnfv.org/gerrit/fuel
Check-out the Colorado release tag to set the HEAD to the
baseline required to replicate the Colorado release:
@@ -65,25 +62,24 @@ baseline required to replicate the Colorado release:
$ git checkout colorado.1.0
-Go to the armband directory and build the .iso:
+Go to the fuel directory and build the .iso:
.. code-block:: bash
- $ cd armband
- $ make release
+ $ cd fuel/build; make all
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, 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*
@@ -101,7 +97,7 @@ Prior to installation, a number of deployment specific parameters must be collec
#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
-#. Monitoring options you want to deploy (Ceilometer, Syslog, erc.).
+#. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
#. Other options not covered in the document are available in the links above
@@ -109,17 +105,20 @@ Prior to installation, a number of deployment specific parameters must be collec
This information will be needed for the configuration procedures
provided in this document.
+=====================
Hardware requirements
=====================
The following minimum hardware requirements must be met for the
-installation of AArch64 Colorado 1.0 using Fuel:
+installation of Colorado using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+====================+======================================================+
-| **AArch64 nodes** | Minimum 5 (3 for non redundant deployment): |
+| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
+| | |
+| | - 1 Fuel deployment master (may be virtualized) |
| | |
| | - 3(1) Controllers (1 colocated mongo/ceilometer |
| | role, 2 Ceph-OSD roles) |
@@ -127,7 +126,7 @@ installation of AArch64 Colorado 1.0 using Fuel:
| | - 1 Compute (1 co-located Ceph-OSD role) |
| | |
+--------------------+------------------------------------------------------+
-| **CPU** | Minimum 1 socket AArch64 (ARMv8) with Virtualization |
+| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
| | support |
+--------------------+------------------------------------------------------+
| **RAM** | Minimum 16GB/server (Depending on VNF work load) |
@@ -136,8 +135,6 @@ installation of AArch64 Colorado 1.0 using Fuel:
| **Disk** | Minimum 256GB 10kRPM spinning disks |
| | |
+--------------------+------------------------------------------------------+
-| **Firmware** | UEFI compatible (e.g. EDK2) with PXE support |
-+--------------------+------------------------------------------------------+
| **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
| | |
| | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
@@ -146,14 +143,15 @@ installation of AArch64 Colorado 1.0 using Fuel:
| | or spread out over multiple NICs as your hardware |
| | supports. |
+--------------------+------------------------------------------------------+
-| **1 x86_64 node** | - 1 Fuel deployment master, x86 (may be virtualized) |
-+--------------------+------------------------------------------------------+
+===============================
Help with Hardware Requirements
===============================
Calculate hardware requirements:
+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:
@@ -165,7 +163,7 @@ environment, you should think about:
- Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
-
+================================================
Top of the rack (TOR) Configuration requirements
================================================
@@ -188,8 +186,9 @@ VLANs needs to be manually configured.
Manual configuration of the Colorado hardware platform should
be carried out according to the OPNFV Pharos specification:
-<https://wiki.opnfv.org/display/pharos/Pharos+Specification>
+<https://wiki.opnfv.org/pharos/pharos_specification>
+==========================================
OPNFV Software installation and deployment
==========================================
@@ -198,7 +197,8 @@ server (Fuel master) as well as the deployment of the full OPNFV
reference platform stack across a server cluster.
Install Fuel master
--------------------
+===================
+
#. 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.
@@ -211,7 +211,7 @@ Install Fuel master
.. figure:: img/grub-1.png
-#. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
+#. Wait until the Fuel setup screen is shown (Note: This can take up to 30 minutes).
#. In the "Fuel User" section - Confirm/change the default password (See figure below)
@@ -223,19 +223,12 @@ Install Fuel master
.. figure:: img/fuelmenu1.png
-#. In the "Network Setup" section - Configure DHCP/Static IP information for your FUEL node - For example, ETH0 is 10.20.0.2/24 for FUEL booting and ETH1 is DHCP/Static in your corporate/lab network (see figure below).
-
- - **NOTE**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
- image building, due to missing arm64 (AArch64) packages in the partial
- local Ubuntu mirror (consequence of ports.ubuntu.com mirror architecture).
+#. In the "Network Setup" section - Configure DHCP/Static IP information for your FUEL node - For example, ETH0 is 10.20.0.2/24 for FUEL booting and ETH1 is DHCP in your corporate/lab network (see figure below).
- - Configuration of ETH1 interface for connectivity into your corporate/lab
- network is mandatory, as internet connection is required during deployment.
+ - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
.. figure:: img/fuelmenu2.png
- .. figure:: img/fuelmenu2a.png
-
#. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
- DHCP Pool Start 10.20.0.3
@@ -262,14 +255,12 @@ Install Fuel master
.. figure:: img/fuelmenu4.png
-#. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below).
- In ArmbandFuel@OPNFV, this data is **NOT** actually used for bootstrap
- image building. Any change here will replace the configuration from
- the OPNFV bootstrap build scripts and will lead to a failed bootstrap
- image build.
+#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section (see figure below), edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support)
+
+ - Navigate to "HTTP proxy" and enter your http proxy address
- **NOTE:** Cannot be used in tandem with local repository support.
+ - Select <Check> and press [Enter]
.. figure:: img/fuelmenu5.png
@@ -285,28 +276,21 @@ Install Fuel master
#. Start the installation.
- - Press <F8> or select Quit Setup and press Save and Quit.
-
- - Installation starts, wait until the login screen is shown.
+ - Select Quit Setup and press Save and Quit.
+ - The installation will now start, wait until the login screen is shown.
Boot the Node Servers
----------------------
+=====================
After the Fuel Master node has rebooted from the above steps and is at
the login prompt, you should boot the Node Servers (Your
-Compute/Control/Storage blades (nested or real) with a PXE booting
+Compute/Control/Storage blades, nested or real) with a PXE booting
scheme so that the FUEL Master can pick them up for control.
-**NOTE**: AArch64 target nodes are expected to support PXE booting an
-EFI binary, i.e. an EFI-stubbed GRUB2 bootloader.
-
-**NOTE**: UEFI (EDK2) firmware is **highly** recommended, becoming
-the **de facto** standard for ARMv8 nodes.
-
#. Enable PXE booting
- - For every controller and compute server: enable PXE Booting as the first boot device in the UEFI (EDK2) boot order menu and hard disk as the second boot device in the same menu.
+ - For every controller and compute server: enable PXE Booting as the first boot device in the BIOS boot order menu, and hard disk as the second boot device in the same menu.
#. Reboot all the control and compute blades.
@@ -318,15 +302,14 @@ the **de facto** standard for ARMv8 nodes.
.. figure:: img/nodes.png
-
Install additional Plugins/Features on the FUEL node
-----------------------------------------------------
+====================================================
#. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
#. Select wanted plugins/features from the /opt/opnfv/ directory.
-#. Install the wanted plugin with the command:
+#. Install the wanted plugin with the command
.. code-block:: bash
@@ -338,21 +321,18 @@ Install additional Plugins/Features on the FUEL node
Plugin ....... was successfully installed.
- **NOTE**: Not all plugins are ported to AArch64 Colorado 1.0
- see *Reference 15*.
-
.. figure:: img/plugin_install.png
Create an OpenStack Environment
--------------------------------
+===============================
-#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
+#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin)
#. Create and name a new OpenStack environment, to be installed.
.. figure:: img/newenv.png
-#. Select "<Mitaka on Ubuntu 14.04 (aarch64)>" and press <Next>
+#. Select "<Mitaka on Ubuntu 14.04>" and press <Next>
#. Select "compute virtulization method".
@@ -362,7 +342,7 @@ Create an OpenStack Environment
- Select "Neutron with ML2 plugin"
- - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
+ - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
- Press <Next>
@@ -372,18 +352,18 @@ Create an OpenStack Environment
#. Select "additional services" you wish to install.
- - Check option "Install Ceilometer (OpenStack Telemetry)" and press <Next>
+ - Check option "Install Ceilometer and Aodh" and press <Next>
#. Create the new environment.
- Click <Create> Button
Configure the network environment
----------------------------------
+=================================
#. Open the environment you previously created.
-#. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
+#. Open the networks tab and select the "default" Node Networks group to on the left pane (see figure below).
.. figure:: img/network.png
@@ -435,7 +415,7 @@ Configure the network environment
- Set appropriate VLAN tag (default 103)
-#. Select the "Neutron L3 Node Networks group" on the left pane.
+#. Select the "Neutron L3" Node Networks group on the left pane.
.. figure:: img/neutronl3.png
@@ -461,7 +441,7 @@ Configure the network environment
#. Save Settings.
-#. Select the "Other Node Networks group" on the left pane(see figure below).
+#. Select the "Other" Node Networks group on the left pane (see figure below).
.. figure:: img/other.png
@@ -478,18 +458,18 @@ Configure the network environment
- Provide the NTP server settings
Select Hypervisor type
-----------------------
+======================
#. In the FUEL UI of your Environment, click the "Settings" Tab
-#. Select Compute on the left side pane (see figure below)
+#. Select "Compute" on the left side pane (see figure below)
- Check the KVM box and press "Save settings"
.. figure:: img/compute.png
Enable Plugins
---------------
+==============
#. In the FUEL UI of your Environment, click the "Settings" Tab
@@ -497,10 +477,10 @@ Enable Plugins
- Enable and configure the plugins of your choice
- .. figure:: img/plugins_aarch64.png
+ .. figure:: img/plugins.png
Allocate nodes to environment and assign functional roles
----------------------------------------------------------
+=========================================================
#. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
@@ -510,7 +490,7 @@ Allocate nodes to environment and assign functional roles
- Click on the <+Add Nodes> button
- - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller) in the Assign Roles Section.
+ - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the "Assign Roles" Section.
- Check one node which you want to act as a Controller from the bottom half of the screen
@@ -540,26 +520,16 @@ Allocate nodes to environment and assign functional roles
- Click <Configure Interfaces>
- - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
- and storage networks
+ - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
- Click <Apply>
.. figure:: img/interfaceconf.png
-OPTIONAL - UNTESTED - Set Local Mirror Repos
----------------------------------
-
-**NOTE**: AArch64 Colorado 1.0 does not fully support local Ubuntu mirrors,
-or at least does not ship with arm64 packages in local repos by default.
-In order to use local (partial) Ubuntu mirrors, one should add arm64 packages
-by hand to the existing amd64 mirrors and re-generate repo metadata.
-Local MOS/Auxiliary repos contain packages for both amd64 and arm64.
-
-**NOTE**: Below instruction assume you already added (by hand) arm64
-Ubuntu necessary packages to the local repository!
+OPTIONAL - Set Local Mirror Repos
+=================================
-The following steps can be executed if you are in an environment with
+The following steps must be executed if you are in an environment with
no connection to the Internet. The Fuel server delivers a local repo
that can be used for installation / deployment of openstack.
@@ -573,14 +543,14 @@ 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/mitaka-8.0/ubuntu/x86_64 mos8.0 main restricted"
+ - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted"
- - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-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
Target specific configuration
------------------------------
+=============================
#. [AArch64 specific] Configure MySQL WSREP SST provider
@@ -652,7 +622,7 @@ Target specific configuration
- Repeat the step above for all affected nodes/interfaces in the POD.
Verify Networks
----------------
+===============
It is important that the Verify Networks action is performed as it will verify
that communicate works for the networks you have setup, as well as check that
@@ -666,11 +636,10 @@ packages needed for a successful deployment can be fetched.
.. figure:: img/verifynet.png
-
Deploy Your Environment
------------------------
+=======================
-38. Deploy the environment.
+#. Deploy the environment.
- In the Fuel GUI, click on the "Dashboard" Tab.
@@ -681,6 +650,7 @@ Deploy Your Environment
Wait for your deployment to complete, you can view the "Dashboard"
Tab to see the progress and status of your deployment.
+=========================
Installation health-check
=========================
@@ -692,54 +662,53 @@ Installation health-check
- Allow tests to run and investigate results where appropriate
- - Check *Reference 15* for known issues / limitations on AArch64, like
- unsupported migration tests when using a GICv3 interrupt controller
-
.. figure:: img/health.png
+==========
References
==========
OPNFV
------
+=====
-1) `OPNFV Home Page <http://www.opnfv.org>`_
+1) `OPNFV Home Page <http://www.opnfv.org>`_: http://www.opnfv.org
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_: https://www.opnfv.org/software/download
OpenStack
----------
+=========
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
+3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_: http://www.openstack.org/software/mitaka
-4) `OpenStack documentation <http://docs.openstack.org>`_
+4) `OpenStack documentation <http://docs.openstack.org>`_: http://docs.openstack.org
OpenDaylight
-------------
+============
-5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_: http://www.opendaylight.org/software/downloads
Fuel
-----
-6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+====
+
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
-7) `Fuel documentation overview <https://docs.mirantis.com/openstack/fuel/fuel-9.0>`_
+7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
-8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
+8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
+9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
-10) `Fuel user guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
+10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: 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>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
-12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
+12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
Fuel in OPNFV
--------------
+=============
-13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html
-14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/buildprocedure/index.html
-15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/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/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
deleted file mode 100644
index 03763ba..0000000
--- a/docs/release-notes.rst
+++ /dev/null
@@ -1,259 +0,0 @@
-============================================================================================
-OPNFV Release Note for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool
-============================================================================================
-
-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 compiles the release notes for the Colorado 1.0 release of
-OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
-node pool.
-
-Important notes
-===============
-
-These notes provide release information for the use of Fuel as deployment
-tool for the AArch64 Colorado 1.0 release of OPNFV.
-
-The goal of the Colorado release and this Fuel-based deployment process is
-to establish a lab ready platform accelerating further development
-of the OPNFV infrastructure on AArch64 architecture.
-
-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.
-
-Although not currently supported, mixing x86_64 and AArch64 architectures
-inside the target pool will be possible later.
-
-Carefully follow the installation-instructions provided in *Reference 13*.
-
-Summary
-=======
-
-For AArch64 Colorado, the typical use of Fuel as an OpenStack installer is
-supplemented with OPNFV unique components such as:
-
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium SR3"
-
-- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
-
-- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
-
-The following OPNFV plugins are not yet ported for AArch64:
-
-- `ONOS <http://onosproject.org/>`_ version "Drake"
-
-- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
-
-- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
-
-- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
-
-As well as OPNFV-unique configurations of the Hardware- and Software stack.
-
-This Colorado artifact provides Fuel as the deployment stage tool in the
-OPNFV CI pipeline including:
-
-- Documentation built by Jenkins
-
- - overall OPNFV documentation
-
- - this document (release notes)
-
- - installation instructions
-
- - build-instructions
-
-- The Colorado Fuel installer image for AArch64 (.iso) built by Jenkins
-
-- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
-
-- Automated validation of the Colorado deployment
-
-Release Data
-============
-
-+--------------------------------------+--------------------------------------+
-| **Project** | fuel |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag** | colorado.1.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | Colorado 1.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release date** | Sep 22 2016 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | Colorado alignment to Released |
-| | Fuel 9.0 baseline + Bug-fixes for |
-| | the following feaures/scenarios: |
-| | - Added AArch64 target support |
-| | - OpenDaylight SR3 |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Version change
---------------
-
-Module version changes
-~~~~~~~~~~~~~~~~~~~~~~
-This is the first AArch64 release for Colorado 1.0. It is based on
-following upstream versions:
-
-- Fuel 9.0 Base release
-
-- OpenStack Mitaka release
-
-- OPNFV Fuel Colorado 1.0 release
-
-- OpenDaylight Beryllium SR3 release
-
-
-Document changes
-~~~~~~~~~~~~~~~~
-This is based upon a follow-up release to Colorado 1.0. It
-comes with the following documentation:
-
-- Installation instructions - *Reference 13* - **Changed**
-
-- Build instructions - *Reference 14* - **Changed**
-
-- Release notes - *Reference 15* - **Changed** (This document)
-
-Reason for version
-------------------
-
-Feature additions
-~~~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-`AArch64 new features <https://jira.opnfv.org/issues/?filter=11129>`_ 'https://jira.opnfv.org/issues/?filter=11129'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Bug corrections
-~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-`AArch64 Workarounds <https://jira.opnfv.org/issues/?filter=11126>`_ 'https://jira.opnfv.org/issues/?filter=11126'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Deliverables
-------------
-
-Software deliverables
-~~~~~~~~~~~~~~~~~~~~~
-
-Fuel-based installer iso file for AArch64 targets found in *Reference 2*
-
-Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- Installation instructions - *Reference 13*
-
-- Build instructions - *Reference 14*
-
-- Release notes - *Reference 15* (This document)
-
-Known Limitations, Issues and Workarounds
-=========================================
-
-System Limitations
-------------------
-
-- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
-
-- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
-
-- **Storage:** Ceph is the only supported storage configuration
-
-- **Max number of networks:** 65k
-
-- **Fuel master arch:** x86_64
-
-- **Target node arch:** aarch64
-
-
-Known issues
-------------
-
-**JIRA TICKETS:**
-
-`AArch64 Known issues <https://jira.opnfv.org/issues/?filter=11127>`_ 'https://jira.opnfv.org/issues/?filter=11127'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Workarounds
------------
-
-**JIRA TICKETS:**
-
-`AArch64 Workarounds <https://jira.opnfv.org/issues/?filter=11128>`_ 'https://jira.opnfv.org/issues/?filter=11128'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Test results
-============
-The Colorado 1.0 release with the Fuel deployment tool has undergone QA test
-runs, see separate test results.
-
-References
-==========
-For more information on the OPNFV Colorado release, please see:
-
-OPNFV
------
-
-1) `OPNFV Home Page <http://www.opnfv.org>`_
-
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
-
-OpenStack
----------
-
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
-
-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.mirantis.com/openstack/fuel/fuel-9.0/>`_
-
-8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
-
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
-
-10) `Fuel user guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
-
-11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
-
-12) `(N/A on AArch64) 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 AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/installation-instruction.html>`_
-
-14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/build-instruction.html>`_
-
-15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release-notes.html>`_
diff --git a/docs/index.rst b/docs/releasenotes/index.rst
index 815d406..db97a74 100644
--- a/docs/index.rst
+++ b/docs/releasenotes/index.rst
@@ -4,16 +4,13 @@
.. You should have received a copy of the license along with this work.
.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-*****************
-ArmbandFuel@OPNFV
-*****************
+*****************************
+Release notes for Fuel\@OPNFV
+*****************************
.. toctree::
- :maxdepth: 4
+ :numbered:
+ :maxdepth: 2
- build-instruction.rst
- installation-instruction.rst
release-notes.rst
-.. :titlesonly:
-
diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst
new file mode 100644
index 0000000..fa9e98e
--- /dev/null
+++ b/docs/releasenotes/release-notes.rst
@@ -0,0 +1,250 @@
+.. 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/>.
+
+========
+Abstract
+========
+
+This document compiles the release notes for the Colorado 1.0 release of
+OPNFV when using Fuel as a deployment tool.
+
+===============
+Important notes
+===============
+
+These notes provides release information for the use of Fuel as deployment
+tool for the Colorado 1.0 release of OPNFV.
+
+The goal of the Colorado 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 provided in *Reference 13*.
+
+=======
+Summary
+=======
+
+For Colorado, the typical use of Fuel as an OpenStack installer is
+supplemented with OPNFV unique components such as:
+
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Beryllium SR3" [1]_ - 'http://www.opendaylight.org/software'
+
+- `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/'
+
+- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
+
+- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
+
+- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
+
+- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
+
+- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases'
+
+As well as OPNFV-unique configurations of the Hardware- and Software stack.
+
+This Colorado artifact provides Fuel as the deployment stage tool in the
+OPNFV CI pipeline including:
+
+- Documentation built by Jenkins
+
+ - overall OPNFV documentation
+
+ - this document (release notes)
+
+ - installation instructions
+
+ - build-instructions
+
+- The Colorado Fuel installer image (.iso) built by Jenkins
+
+- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
+
+- Automated validation of the Colorado deployment
+
+============
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | fuel |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | Colorado 1.0 follow-up release |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | September 22 2016 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | Colorado alignment to Released |
+| | Fuel 9.0 baseline + Bug-fixes for |
+| | the following feaures/scenarios: |
+| | - NFV Hypervisors-KVM |
+| | - Open vSwitch for NFV |
+| | - OpenDaylight |
+| | - SDN distributed routing and VPN |
+| | - Service function chaining |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+==============
+
+Module version changes
+----------------------
+This is a follow-up release to Colorado 1.0. It is based on
+following upstream versions:
+
+- Fuel 9.0 Base release
+
+- OpenStack Mitaka release
+
+- OpenDaylight Beryllium SR3 release [1]_
+
+- ONOS Drake release
+
+Document changes
+----------------
+This is a follow-up release to Colorado 1.0. It
+comes with the following documentation:
+
+- Installation instructions - *Reference 13* - **Changed**
+
+- Build instructions - *Reference 14* - **Changed**
+
+- Release notes - *Reference 15* - **Changed** (This document)
+
+Reason for version
+==================
+
+Feature additions
+-----------------
+
+**JIRA TICKETS:**
+
+-
+
+Bug corrections
+---------------
+
+**JIRA TICKETS:**
+
+`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121'
+
+(Also See respective Integrated feature project's bug tracking)
+
+Deliverables
+============
+
+Software deliverables
+---------------------
+
+Fuel-based installer iso file found in *Reference 2*
+
+Documentation deliverables
+--------------------------
+
+- Installation instructions - *Reference 13*
+
+- Build instructions - *Reference 14*
+
+- Release notes - *Reference 15* (This document)
+
+=========================================
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+==================
+
+- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
+
+- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
+
+- **Storage:** Ceph is the only supported storage configuration
+
+- **Max number of networks:** 65k
+
+
+Known issues
+============
+
+**JIRA TICKETS:**
+
+`Known issues <https://jira.opnfv.org/issues/?filter=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119'
+
+(Also See respective Integrated feature project's bug tracking)
+
+Workarounds
+===========
+
+**JIRA TICKETS:**
+
+`Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120'
+
+(Also See respective Integrated feature project's bug tracking)
+
+============
+Test results
+============
+The Colorado 1.0 release with the Fuel deployment tool has undergone QA test
+runs, see separate test results.
+
+==========
+References
+==========
+For more information on the OPNFV Colorado release, please see:
+
+OPNFV
+=====
+
+1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
+
+OpenStack
+=========
+
+3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
+
+4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
+
+OpenDaylight
+============
+
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
+
+Fuel
+====
+
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ 'https://wiki.openstack.org/wiki/Fuel'
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/'
+
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html'
+
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html'
+
+10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html'
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ '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>`_ 'https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list'
+
+Fuel in OPNFV
+=============
+
+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>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/installation-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>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.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>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html'
+
+.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.