From 6a216628f75cb40fa3acffaa4faf280f09679f5b Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Mon, 20 Mar 2017 16:49:11 +0200 Subject: docs: Copy OPNFV docs dir as documentation base Copy the files from fuel as base documentation. A subsequent commit will adapt it with aarch64 specifics. JIRA: ARMBAND-243 Change-Id: I085d3cfab3a65d8ab7954dcdc876f2b922889ee2 Signed-off-by: Cristina Pauna --- docs/conf.py | 28 -- .../buildprocedure/build.instruction.rst | 342 --------------------- docs/development/buildprocedure/index.rst | 18 -- .../overview/build/build.instruction.rst | 293 ++++++++++++++++++ docs/development/overview/build/index.rst | 16 + docs/release/installation/img/fuelmenu1.png | Bin 9276 -> 24730 bytes docs/release/installation/img/fuelmenu2.png | Bin 9774 -> 26118 bytes docs/release/installation/img/fuelmenu2a.png | Bin 11511 -> 0 bytes docs/release/installation/img/fuelmenu3.png | Bin 9783 -> 25739 bytes docs/release/installation/img/fuelmenu4.png | Bin 8843 -> 24365 bytes docs/release/installation/img/fuelmenu5.png | Bin 20442 -> 26661 bytes docs/release/installation/img/fuelmenu6.png | Bin 10322 -> 27230 bytes docs/release/installation/img/fuelwsrepsst.png | Bin 59206 -> 0 bytes docs/release/installation/img/grub-1.png | Bin 388991 -> 464529 bytes docs/release/installation/img/plugins_aarch64.png | Bin 59910 -> 0 bytes docs/release/installation/index.rst | 18 +- .../installation/installation.instruction.rst | 209 ++++--------- docs/release/release-notes/index.rst | 19 +- docs/release/release-notes/release-notes.rst | 186 +++++------ 19 files changed, 463 insertions(+), 666 deletions(-) delete mode 100644 docs/conf.py delete mode 100644 docs/development/buildprocedure/build.instruction.rst delete mode 100644 docs/development/buildprocedure/index.rst create mode 100644 docs/development/overview/build/build.instruction.rst create mode 100644 docs/development/overview/build/index.rst delete mode 100644 docs/release/installation/img/fuelmenu2a.png delete mode 100644 docs/release/installation/img/fuelwsrepsst.png delete mode 100644 docs/release/installation/img/plugins_aarch64.png (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 6cd69313..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,28 +0,0 @@ -# SPDX-license-identifier: Apache-2.0 -############################################################################## -# Copyright (c) 2016 Linux Foundation and others. -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -# Copied from releng/docs/etc/conf.py -extensions = ['sphinxcontrib.httpdomain', - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon'] - -needs_sphinx = '1.3' -master_doc = 'index' -pygments_style = 'sphinx' - -html_use_index = False -numfig = True -html_logo = 'opnfv-logo.png' - -latex_domain_indices = False -latex_logo = 'opnfv-logo.png' - -# addtional config -latex_elements = {'figure_align': 'H'} diff --git a/docs/development/buildprocedure/build.instruction.rst b/docs/development/buildprocedure/build.instruction.rst deleted file mode 100644 index 405a0e70..00000000 --- a/docs/development/buildprocedure/build.instruction.rst +++ /dev/null @@ -1,342 +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 . - -======== -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. - -============ -Introduction -============ - -This document describes the build system used to build the Fuel -deployment tool for the AArch64 Colorado release of OPNFV, required -dependencies and minimum requirements on the host to be used for the -build system. - -The Fuel build system is designed around Docker containers such that -dependencies outside of the build system can be kept to a minimum. It -also shields the host from any potential dangerous operations -performed by the build system. - -The audience of this document is assumed to have good knowledge in -network and Unix/Linux administration. - -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 - -- 4 GB RAM - -Minimum Software Requirements -============================= - -The build host should run Ubuntu 14.04 or 16.04 (x86_64) 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 - -.. code-block:: bash - - $ sudo apt-get install linux-generic-lts-vivid - -- docker - see https://docs.docker.com/installation/ubuntulinux/ for - installation notes for Ubuntu 14.04. Note: use the latest version from - Docker (docker-engine) and not the one in Ubuntu 14.04. - -- git - -- make - -- curl - -Apart from docker, all other package requirements listed above are -simply available through: - -.. code-block:: bash - - $ sudo apt-get install git make curl - - -============ -Preparations -============ - -Setting up the Docker build container -===================================== - -After having installed Docker, add yourself to the docker group: - -.. code-block:: bash - - $ sudo usermod -a -G docker [userid] - -Also make sure to define relevant DNS servers part of the global -DNS chain in your configuration file. -Uncomment, and modify the values appropriately. - -For example: - -.. code-block:: bash - - DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" - -Then restart docker: - -.. code-block:: bash - - $ 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/) - (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 -------------------------------------------------------------- - -Now it is time to clone the code repository: - -.. code-block:: bash - - $ git clone ssh://@gerrit.opnfv.org:29418/armband - -Now you should have the OPNFV armband repository with its -directories stored locally on your build host. - -Check out the Colorado release: - -.. code-block:: bash - - $ cd armband - $ git checkout colorado.3.0.1 - -Clone the armband@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 - -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) 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 -registry before invoking make! In Ubuntu this is done by adding a line -like: - -.. code-block:: bash - - export http_proxy="http://10.0.0.1:8888/" - -to 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 -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 - -As an example, these are the settings that were put in the user's -.bashrc when verifying the proxy build functionality: - -.. code-block:: bash - - export RSYNC_PROXY=10.0.0.1:8888 - export http_proxy=http://10.0.0.1:8888 - export https_proxy=http://10.0.0.1:8888 - export no_proxy=localhost,127.0.0.1,.consultron.com,.sock - -Using a ssh proxy for the rsync connection ------------------------------------------- - -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 @ 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 -as the root user (but with the invoking user's SSH keys). - - -Note! Armband build system uses git submodules to track fuel and -other upstream repos, so in order to apply the above change, one -should first initialize the submodules and apply armband patches -(only needed once): - -.. code-block:: bash - - $ make patches-import - - -Configure your build environment -================================ - -** Configuring the build environment should not be performed if building -standard Colorado release ** - -Select the versions of the components you want to build by editing the - and - files. - -Note! The same observation as above, before altering Makefile, run: - -.. code-block:: bash - - $ make patches-import - - -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 that -are specified in the environment variable will then be built. In order -to completely disable the building of plugins, the environment variable -is set to " ". When using this functionality, the resulting iso file -will be prepended with the prefix "unofficial-" to clearly indicate -that this is not a full build. - -This method of plugin selection is not meant to be used from within -Gerrit! - -Note! So far, only ODL, OVS, BGPVPN and Tacker plugins were ported to AArch64. - -======== -Building -======== - -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 directory, invoke - -Following targets exist: - -- release - this will do the same as: - - - make submodules-clean patches-import build - -- none/all/build - this will: - - - Initialize the docker build environment - - - 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) - - - Apply changes and patches to fuel (as defined by the structure of - this framework) - - - Reconstruct a fuel .iso image - -- clean - this will remove all artifacts from earlier builds. - -- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso" - -If the build is successful, you will find the generated ISO file in -the subdirectory! - -Abstracted build method using build.sh -====================================== - -The abstracted build method uses the script which -allows you to: - -- Create and use a build cache - significantly speeding up the - build time if upstream repositories have not changed. - -- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) - -For more info type . - -========= -Artifacts -========= - -The artifacts produced are: - -- - Which represents the bootable Fuel for AArch64 image, - XXXX is replaced with the build identity provided to the build system - -- - Which holds version metadata. - -========== -References -========== - -1) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html - -2) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html - -3) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html diff --git a/docs/development/buildprocedure/index.rst b/docs/development/buildprocedure/index.rst deleted file mode 100644 index 386f1e46..00000000 --- a/docs/development/buildprocedure/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _armband-buildprocedure: - -.. This document is protected/licensed under the following conditions -.. (c) Jonas Bjurel (Ericsson AB) -.. Licensed under a Creative Commons Attribution 4.0 International License. -.. You should have received a copy of the license along with this work. -.. If not, see . - -******************************************** -Build instruction for Fuel\@OPNFV on AArch64 -******************************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - build.instruction.rst - diff --git a/docs/development/overview/build/build.instruction.rst b/docs/development/overview/build/build.instruction.rst new file mode 100644 index 00000000..5fe38cbf --- /dev/null +++ b/docs/development/overview/build/build.instruction.rst @@ -0,0 +1,293 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======== +Abstract +======== + +This document describes how to build the Fuel deployment tool for the +Danube release of OPNFV build system, dependencies and required +system resources. + +============ +Introduction +============ + +This document describes the build system used to build the Fuel +deployment tool for the Danube release of OPNFV, required +dependencies and minimum requirements on the host to be used for the +build system. + +The Fuel build system is designed around Docker containers such that +dependencies outside of the build system can be kept to a minimum. It +also shields the host from any potential dangerous operations +performed by the build system. + +The audience of this document is assumed to have good knowledge in +network and Unix/Linux administration. + +============ +Requirements +============ + +Minimum Hardware Requirements +============================= + +- ~30 GB available disc + +- 4 GB RAM + +Minimum Software Requirements +============================= + +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 + +.. code-block:: bash + + $ sudo apt-get install linux-generic-lts-vivid + +- docker - see https://docs.docker.com/installation/ubuntulinux/ for + installation notes for Ubuntu 14.04. Note: use the latest version from + Docker (docker-engine) and not the one in Ubuntu 14.04. + +- git (simply available through $ sudo apt-get install git) + +- make (simply available through $ sudo apt-get install make) + +- 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 + + $ sudo usermod -a -G docker [userid] + +Also make sure to define relevant DNS servers part of the global +DNS chain in your configuration file. +Uncomment, and modify the values appropriately. + +For example: + +.. code-block:: bash + + DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" + +Then restart docker: + +.. code-block:: bash + + $ 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 + (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 OPNFV code Git repository with your SSH key +----------------------------------------------------- + +Now it is time to clone the code repository: + +.. code-block:: bash + + $ git clone ssh://@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 Danube release: + +.. code-block:: bash + + $ cd fuel + $ git checkout danube.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: + +.. code-block:: bash + + $ 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) 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 +registry before invoking make! In Ubuntu this is done by adding a line +like: + +.. code-block:: bash + + export http_proxy="http://10.0.0.1:8888/" + +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 +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 + +As an example, these are the settings that were put in the user's +.bashrc when verifying the proxy build functionality: + +.. code-block:: bash + + export RSYNC_PROXY=10.0.0.1:8888 + export http_proxy=http://10.0.0.1:8888 + export https_proxy=http://10.0.0.1:8888 + export no_proxy=localhost,127.0.0.1,.consultron.com,.sock + +Using a ssh proxy for the rsync connection +------------------------------------------ + +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 @ 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 +as the root user (but with the invoking user's SSH keys). + +Configure your build environment +================================ + +** Configuring the build environment should not be performed if building +standard Danube release ** + +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 +==================================================== + +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 fuel/build/f_isoroot/Makefile that are +specified in the environment variable will then be built. In order to +completely disable the building of plugins, the environment variable +is set to " ". When using this functionality, the resulting iso file +will be prepended with the prefix "unofficial-" to clearly indicate +that this is not a full build. + +This method of plugin selection is not meant to be used from within +Gerrit! + +======== +Building +======== + +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 directory, invoke + +Following targets exist: + +- none/all - this will: + + - Initialize the docker build environment + + - 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) + + - Apply changes and patches to fuel (as defined by the structure of + this framework) + + - Reconstruct a fuel .iso image + +- clean - this will remove all artifacts from earlier builds. + +- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso" + +If the build is successful, you will find the generated ISO file in +the subdirectory! + +Abstracted build method using build.sh +====================================== + +The abstracted build method uses the script which +allows you to: + +- Create and use a build cache - significantly speeding up the + build time if upstream repositories have not changed. + +- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) + +For more info type . + +========= +Artifacts +========= + +The artifacts produced are: + +- - Which represents the bootable Fuel image, XXXX is + replaced with the build identity provided to the build system + +- - Which holds version metadata. diff --git a/docs/development/overview/build/index.rst b/docs/development/overview/build/index.rst new file mode 100644 index 00000000..355e6b72 --- /dev/null +++ b/docs/development/overview/build/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _armband-development-overview-build-label: + +********************************* +Build instruction for Fuel\@OPNFV +********************************* + +.. toctree:: + :numbered: + :maxdepth: 2 + + build.instruction.rst + diff --git a/docs/release/installation/img/fuelmenu1.png b/docs/release/installation/img/fuelmenu1.png index ee7a0edb..4b5097ff 100644 Binary files a/docs/release/installation/img/fuelmenu1.png and b/docs/release/installation/img/fuelmenu1.png differ diff --git a/docs/release/installation/img/fuelmenu2.png b/docs/release/installation/img/fuelmenu2.png index 4dcbb6e6..42cd75f6 100644 Binary files a/docs/release/installation/img/fuelmenu2.png and b/docs/release/installation/img/fuelmenu2.png differ diff --git a/docs/release/installation/img/fuelmenu2a.png b/docs/release/installation/img/fuelmenu2a.png deleted file mode 100644 index 396c1237..00000000 Binary files a/docs/release/installation/img/fuelmenu2a.png and /dev/null differ diff --git a/docs/release/installation/img/fuelmenu3.png b/docs/release/installation/img/fuelmenu3.png index 23e61975..174cb500 100644 Binary files a/docs/release/installation/img/fuelmenu3.png and b/docs/release/installation/img/fuelmenu3.png differ diff --git a/docs/release/installation/img/fuelmenu4.png b/docs/release/installation/img/fuelmenu4.png index 3be29cd6..0e218fca 100644 Binary files a/docs/release/installation/img/fuelmenu4.png and b/docs/release/installation/img/fuelmenu4.png differ diff --git a/docs/release/installation/img/fuelmenu5.png b/docs/release/installation/img/fuelmenu5.png index e3d21545..b1063d57 100644 Binary files a/docs/release/installation/img/fuelmenu5.png and b/docs/release/installation/img/fuelmenu5.png differ diff --git a/docs/release/installation/img/fuelmenu6.png b/docs/release/installation/img/fuelmenu6.png index cafbcddf..16d641e9 100644 Binary files a/docs/release/installation/img/fuelmenu6.png and b/docs/release/installation/img/fuelmenu6.png differ diff --git a/docs/release/installation/img/fuelwsrepsst.png b/docs/release/installation/img/fuelwsrepsst.png deleted file mode 100644 index 90ded440..00000000 Binary files a/docs/release/installation/img/fuelwsrepsst.png and /dev/null differ diff --git a/docs/release/installation/img/grub-1.png b/docs/release/installation/img/grub-1.png index e64b7937..11317894 100644 Binary files a/docs/release/installation/img/grub-1.png and b/docs/release/installation/img/grub-1.png differ diff --git a/docs/release/installation/img/plugins_aarch64.png b/docs/release/installation/img/plugins_aarch64.png deleted file mode 100644 index 8bd58d12..00000000 Binary files a/docs/release/installation/img/plugins_aarch64.png and /dev/null differ diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 20fcbc32..c143a9eb 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -1,14 +1,14 @@ -.. _armband-installation: +.. _fuel-installation: -.. 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 . +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors -*************************************************** -Installation instruction for Fuel\@OPNFV on AArch64 -*************************************************** +.. _armband-release-installation-label: + +**************************************** +Installation instruction for Fuel\@OPNFV +**************************************** .. toctree:: :numbered: diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index ec55d3eb..a879116a 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -1,32 +1,28 @@ -.. 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 . +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors ======== Abstract ======== -This document describes how to install the Colorado release of -OPNFV when using Fuel as a deployment tool, with an AArch64 (only) -target node pool. It covers its usage, limitations, dependencies -and required system resources. +This document describes how to install the Danube 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 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 Danube release of OPNFV when using Fuel as a +deployment tool, including required software and hardware configurations. Although the available installation options give a high degree of freedom in how the system is set-up, including architecture, services and features, etc., said permutations may not provide an OPNFV compliant reference architecture. This instruction provides a -step-by-step guide that results in an OPNFV Colorado compliant +step-by-step guide that results in an OPNFV Danube compliant deployment. The audience of this document is assumed to have good knowledge in @@ -36,55 +32,54 @@ networking and Unix/Linux administration. Preface ======= -Before starting the installation of the AArch64 Colorado release -of OPNFV, using Fuel as a deployment tool, some planning must be +Before starting the installation of the Danube 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 Danube release can be found at `OPNFV Downloads `_. Building the ISO image ====================== -Alternatively, you may build the Armband Fuel .iso from source by cloning -the opnfv/armband git repository. To retrieve the repository for the AArch64 -Colorado 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 Danube +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: +Check-out the Danube release tag to set the HEAD to the +baseline required to replicate the Danube release: .. code-block:: bash - $ git checkout colorado.3.0.1 + $ git checkout danube.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 all + $ cd fuel/build; make all -For more information on how to build, please see *Reference: 14* +For more information on how to build, please see :ref:`Build instruction for Fuel\@OPNFV ` Other preparations ================== Next, familiarize yourself with Fuel by reading the following documents: -- Fuel Installation Guide, please see *Reference: 8* +- `Fuel Installation Guide `_ -- Fuel QuickStart, please see *Reference: 9* +- `Fuel User Guide `_ -- Fuel Developer Guide, please see *Reference: 10* +- `Fuel Developer Guide `_ -- Fuel Plugin Developers Guide, please see *Reference: 11* +- `Fuel Plugin Developers Guide `_ Prior to installation, a number of deployment specific parameters must be collected, those are: @@ -113,13 +108,13 @@ Hardware requirements ===================== The following minimum hardware requirements must be met for the -installation of AArch64 Colorado using Fuel: +installation of Danube 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) | | | | @@ -129,7 +124,7 @@ installation of AArch64 Colorado 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) | @@ -138,8 +133,6 @@ installation of AArch64 Colorado 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 | @@ -148,8 +141,6 @@ installation of AArch64 Colorado 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 @@ -157,6 +148,8 @@ Help with Hardware Requirements Calculate hardware requirements: +For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List `_. + When choosing the hardware on which you will deploy your OpenStack environment, you should think about: @@ -189,9 +182,9 @@ the Fuel OPNFV reference platform. All the networks involved in the OPNFV infrastructure as well as the provider networks and the private tenant VLANs needs to be manually configured. -Manual configuration of the Colorado hardware platform should -be carried out according to the OPNFV Pharos specification: - +Manual configuration of the Danube hardware platform should +be carried out according to the `OPNFV Pharos Specification +`_. ========================================== OPNFV Software installation and deployment @@ -204,7 +197,7 @@ reference platform stack across a server cluster. Install Fuel master =================== -#. Mount the Colorado Armband Fuel ISO file/media as a boot device to the jump host server. +#. Mount the Danube Fuel ISO file/media as a boot device to the jump host server. #. Reboot the jump host to establish the Fuel server. @@ -230,16 +223,13 @@ Install Fuel master #. 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). -- **NOTE**: Configuration of ETH1 interface for connectivity into your corporate/lab - network is optional + - 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 + - DHCP Pool Start 10.20.0.4 - DHCP Pool End 10.20.0.254 @@ -264,14 +254,11 @@ Install Fuel master .. figure:: img/fuelmenu4.png -#. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below). +#. 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) - 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. + - Navigate to "HTTP proxy" and enter your http proxy address - **NOTE:** Cannot be used in tandem with local repository support. + - Select and press [Enter] .. figure:: img/fuelmenu5.png @@ -287,7 +274,7 @@ Install Fuel master #. Start the installation. - - Press + - Select Quit Setup and press Save and Quit. - The installation will now start, wait until the login screen is shown. @@ -299,15 +286,9 @@ the login prompt, you should boot the Node Servers (Your 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. @@ -340,9 +321,6 @@ Install additional Plugins/Features on the FUEL node .. figure:: img/plugin_install.png - **NOTE**: AArch64 Colorado 1.0 ships only with ODL, OVS, BGPVPN and Tacker - plugins, see *Reference 15*. - Create an OpenStack Environment =============================== @@ -352,7 +330,7 @@ Create an OpenStack Environment .. figure:: img/newenv.png -#. Select "" and press +#. Select "" and press #. Select "compute virtulization method". @@ -362,7 +340,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 @@ -497,7 +475,7 @@ 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 ========================================================= @@ -510,7 +488,7 @@ Allocate nodes to environment and assign functional roles - Click on the <+Add Nodes> button - - Check , and optionally an SDN Controller role (OpenDaylight controller) in the "Assign Roles" Section. + - Check , 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 @@ -546,51 +524,10 @@ Allocate nodes to environment and assign functional roles .. figure:: img/interfaceconf.png -OPTIONAL - Set Local Mirror Repos -================================= - -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. - -#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane. - - - Replace the URI values for the "Name" values outlined below: - - - "ubuntu" URI="deb http://:8080/mirrors/ubuntu/ trusty main" - - - "mos" URI="deb http://::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted" - - - "Auxiliary" URI="deb http://:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted" - - - Click at the bottom to Save your changes Target specific configuration ============================= -#. [AArch64 specific] Configure MySQL WSREP SST provider - - **NOTE**: This option is only available for ArmbandFuel@OPNFV, since it - currently only affects AArch64 targets (see *Reference 15*). - - When using some AArch64 platforms as controller nodes, WSREP SST - synchronisation using default backend provider (xtrabackup-v2) used to fail, - so a mechanism that allows selecting a different WSREP SST provider - has been introduced. - - In the FUEL UI of your Environment, click the tab, click - on the left side pane (see figure below), then - select one of the following options: - - - xtrabackup-v2 (default provider, AArch64 stability issues); - - - rsync (AArch64 validated, better or comparable speed to xtrabackup, - takes the donor node offline during state transfer); - - - mysqldump (untested); - - .. figure:: img/fuelwsrepsst.png - #. Set up targets for provisioning with non-default "Offloading Modes" Some target nodes may require additional configuration after they are @@ -678,55 +615,35 @@ Installation health-check - Allow tests to run and investigate results where appropriate - - Check *Reference 15* for known issues / limitations on AArch64 - .. figure:: img/health.png -========== -References -========== -OPNFV -===== +============= +Release Notes +============= -1) `OPNFV Home Page `_: http://www.opnfv.org +Please refer to the :ref:`Release Notes ` article. -2) `OPNFV documentation- and software downloads `_: https://www.opnfv.org/software/download +========== +References +========== OpenStack -========= - -3) `OpenStack Mitaka Release artifacts `_: http://www.openstack.org/software/mitaka -4) `OpenStack documentation `_: http://docs.openstack.org +3) `OpenStack Newton Release Artifacts `_ +4) `OpenStack Documentation `_ OpenDaylight -============ -5) `OpenDaylight artifacts `_: http://www.opendaylight.org/software/downloads +5) `OpenDaylight Artifacts `_ Fuel -==== - -6) `The Fuel OpenStack project `_: https://wiki.openstack.org/wiki/Fuel - -7) `Fuel documentation overview `_: http://docs.openstack.org/developer/fuel-docs - -8) `Fuel Installation Guide `_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html - -9) `Fuel QuickStart Guide `_: https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html - -10) `Fuel Developer Guide `_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html - -11) `Fuel Plugin Developers Guide `_: 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 - -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/colorado/3.0/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/colorado/3.0/docs/buildprocedure/index.html +6) `The Fuel OpenStack Project `_ +7) `Fuel Documentation Overview `_ +8) `Fuel Installation Guide `_ +9) `Fuel User Guide `_ +10) `Fuel Developer Guide `_ +11) `Fuel Plugin Developers Guide `_ +12) `Fuel OpenStack Hardware Compatibility List `_ -15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index b9121b46..8f8be893 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -1,18 +1,17 @@ -.. _armband-releasenotes: +.. _fuel-releasenotes: -.. 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 . +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors -**************************************** -Release notes for Fuel\@OPNFV on AArch64 -**************************************** +.. _armband-release-notes-label: + +***************************** +Release notes for Fuel\@OPNFV +***************************** .. toctree:: :numbered: :maxdepth: 2 release-notes.rst - diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index b4e8bc81..465d0881 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -1,33 +1,24 @@ -.. 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 . +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors ======== Abstract ======== -This document compiles the release notes for the Colorado 3.0 release of -OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target -node pool. +This document compiles the release notes for the Danube release of +OPNFV when using Fuel as a deployment tool. =============== -Important notes +Important Notes =============== These notes provides release information for the use of Fuel as deployment -tool for the AArch64 Colorado 3.0 release of OPNFV. +tool for the Danube release of OPNFV. -The goal of the AArch64 Colorado release and this Fuel-based deployment process -is to establish a lab ready platform accelerating further development -of the OPNFV on AArch64 infrastructure. - -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. +The goal of the Danube 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*. @@ -35,32 +26,22 @@ Carefully follow the installation-instructions provided in *Reference 13*. Summary ======= -For AArch64 Colorado, the typical use of Fuel as an OpenStack installer is +For Danube, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as: -- `OpenDaylight `_ version "Boron" [1]_ - 'http://www.opendaylight.org/software' - -- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' - -- `BGPVPN `_ 'http://docs.openstack.org/developer/networking-bgpvpn/' - -- Tacker `_ 'https://wiki.openstack.org/wiki/Tacker' - -The following OPNFV plugins are not yet ported for AArch64: - -- `ONOS `_ version "Drake" - 'http://onosproject.org/' +- `OpenDaylight `_ +- `Service Function Chaining `_ +- `SDN distributed routing and VPN `_ +- `NFV Hypervisors-KVM `_ +- `Open vSwitch for NFV `_ +- `VSPERF `_ +- `Promise `_ +- `Parser `_ +- `Doctor `_ -- `Service function chaining `_ 'https://wiki.opnfv.org/service_function_chaining' +As well as OPNFV-unique configurations of the Hardware and Software stack. -- `SDN distributed routing and VPN `_ 'https://wiki.opnfv.org/sdnvpn' - -- `NFV Hypervisors-KVM `_ 'https://wiki.opnfv.org/nfv-kvm' - -- `VSPERF `_ '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 +This Danube artifact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: - Documentation built by Jenkins @@ -73,99 +54,103 @@ OPNFV CI pipeline including: - build-instructions -- The Colorado Fuel installer image AArch64 (.iso) built by Jenkins +- The Danube Fuel installer image (.iso) built by Jenkins -- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM) +- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM) -- Automated validation of the Colorado deployment +- Automated validation of the Danube deployment ============ Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | armband | +| **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | colorado.3.0 | +| **Repo/tag** | danube.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 3.0 follow-up release | +| **Release designation** | Danube 1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | December 05 2016 | +| **Release date** | March 27 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado alignment to Released | -| | Fuel 9.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | +| **Purpose of the delivery** | Danube alignment to Released | +| | Fuel 10.0 baseline + features and | +| | bug-fixes for the following | +| | feaures: | +| | - NFV Hypervisors-KVM | | | - Open vSwitch for NFV | | | - OpenDaylight | +| | - SDN distributed routing and VPN | +| | - Service function chaining | +| | - Promise | +| | - Parser | +| | - Doctor | | | - Tacker | -| | | +--------------------------------------+--------------------------------------+ -Version change +Version Change ============== -Module version changes +Module Version Changes ---------------------- -This is the Colorado 3.0 follow-up release. +This is the Danube 1.0 release. It is based on following upstream versions: -- Fuel 9.0 Base release - -- OpenStack Mitaka release +- Fuel 10.0 Base Release -- OpenDaylight Boron release [1]_ +- OpenStack Newton Release +- OpenDaylight -Document changes +Document Changes ---------------- -This is the Colorado 3.0 follow-up release. +This is the Danube 1.0 release. It comes with the following documentation: -- Installation instructions - *Reference 13* - **Changed** +- Installation instructions -- Build instructions - *Reference 14* - **Changed** +- Build instructions -- Release notes - *Reference 15* - **Changed** (This document) +- Release notes (This document) -Reason for version +Reason for Version ================== -Feature additions +Feature Additions ----------------- **JIRA TICKETS:** -- -Bug corrections +Bug Corrections --------------- **JIRA TICKETS:** -`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11404' +`Danube 1.0 bug fixes `_ (Also See respective Integrated feature project's bug tracking) Deliverables ============ -Software deliverables +Software Deliverables --------------------- -AArch64 Fuel-based installer iso file found in *Reference 2* +Fuel-based installer iso file found in `OPNFV Downloads `. -Documentation deliverables +Documentation Deliverables -------------------------- -- Installation instructions - *Reference 13* +- Installation instructions -- Build instructions - *Reference 14* +- Build instructions -- Release notes - *Reference 15* (This document) +- Release notes(This document) ========================================= Known Limitations, Issues and Workarounds @@ -182,16 +167,13 @@ System Limitations - **Max number of networks:** 65k -- **Fuel master arch:** x86_64 -- **Target node arch:** aarch64 - -Known issues +Known Issues ============ **JIRA TICKETS:** -`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11405' +`Known issues `_ (Also See respective Integrated feature project's bug tracking) @@ -200,64 +182,42 @@ Workarounds **JIRA TICKETS:** -- +`Workarounds `_ (Also See respective Integrated feature project's bug tracking) ============ -Test results +Test Results ============ -The Colorado 3.0 release with the Fuel deployment tool has undergone QA test +The Danube 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 3.0 release, please see: +For more information on the OPNFV Danube 1.0 release, please see: OPNFV ===== -1) `OPNFV Home Page `_ 'http://www.opnfv.org' - -2) `OPNFV documentation- and software downloads `_ 'https://www.opnfv.org/software/download' +1) `OPNFV Home Page `_ +2) `OPNFV Documentation - and Software Downloads `_ OpenStack ========= -3) `OpenStack Mitaka Release artifacts `_ 'http://www.openstack.org/software/mitaka' +3) `OpenStack Newton Release Artifacts `_ -4) `OpenStack documentation `_ 'http://docs.openstack.org' +4) `OpenStack Documentation `_ OpenDaylight ============ -5) `OpenDaylight artifacts `_ 'http://www.opendaylight.org/software/downloads' +5) `OpenDaylight Artifacts `_ Fuel ==== -6) `The Fuel OpenStack project `_: https://wiki.openstack.org/wiki/Fuel - -7) `Fuel documentation overview `_: http://docs.openstack.org/developer/fuel-docs - -8) `Fuel Installation Guide `_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html - -9) `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 - -11) `Fuel Plugin Developers Guide `_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html - -12) `Fuel OpenStack Hardware Compatibility List `_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list - -Fuel in OPNFV -============= - -13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/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/colorado/3.0/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/colorado/3.0/docs/releasenotes/index.html' +6) `The Fuel OpenStack Project `_ +7) `Fuel Documentation `_ -.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. -- cgit 1.2.3-korg