From b832a3e82070e12dff555e2a83d604de7e398acb Mon Sep 17 00:00:00 2001 From: cristinapauna Date: Thu, 8 Sep 2016 16:38:15 +0300 Subject: 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 --- docs/build-instruction.rst | 344 ---------- docs/buildprocedure/build.instruction.rst | 305 +++++++++ docs/buildprocedure/index.rst | 16 + docs/configguide/installerconfig.rst | 332 --------- docs/configguide/postinstall.rst | 24 - docs/img/addnodes.png | Bin 24624 -> 0 bytes docs/img/compute.png | Bin 49919 -> 0 bytes docs/img/computelist.png | Bin 70343 -> 0 bytes docs/img/fuelconsole1.png | Bin 8269 -> 0 bytes docs/img/fuelmenu1.png | Bin 8766 -> 0 bytes docs/img/fuelmenu2.png | Bin 9679 -> 0 bytes docs/img/fuelmenu2a.png | Bin 11511 -> 0 bytes docs/img/fuelmenu3.png | Bin 9634 -> 0 bytes docs/img/fuelmenu4.png | Bin 9843 -> 0 bytes docs/img/fuelmenu5.png | Bin 22548 -> 0 bytes docs/img/fuelmenu6.png | Bin 10703 -> 0 bytes docs/img/grub-1.png | Bin 381031 -> 0 bytes docs/img/health.png | Bin 54348 -> 0 bytes docs/img/interfaceconf.png | Bin 58890 -> 0 bytes docs/img/interfaces.png | Bin 58851 -> 0 bytes docs/img/network.png | Bin 53472 -> 0 bytes docs/img/neutronl3.png | Bin 71846 -> 0 bytes docs/img/newenv.png | Bin 37483 -> 0 bytes docs/img/nodes.png | Bin 9155 -> 0 bytes docs/img/offloadingmodes.png | Bin 23017 -> 0 bytes docs/img/other.png | Bin 71641 -> 0 bytes docs/img/plugin_install.png | Bin 17431 -> 0 bytes docs/img/plugins_aarch64.png | Bin 34853 -> 0 bytes docs/img/verifynet.png | Bin 61499 -> 0 bytes docs/index.rst | 19 - docs/installation-instruction.rst | 745 --------------------- docs/installationprocedure/img/addnodes.png | Bin 0 -> 24089 bytes docs/installationprocedure/img/compute.png | Bin 0 -> 25978 bytes docs/installationprocedure/img/computelist.png | Bin 0 -> 67975 bytes docs/installationprocedure/img/fuelconsole1.png | Bin 0 -> 8269 bytes docs/installationprocedure/img/fuelmenu1.png | Bin 0 -> 9276 bytes docs/installationprocedure/img/fuelmenu2.png | Bin 0 -> 9774 bytes docs/installationprocedure/img/fuelmenu3.png | Bin 0 -> 9783 bytes docs/installationprocedure/img/fuelmenu4.png | Bin 0 -> 8843 bytes docs/installationprocedure/img/fuelmenu5.png | Bin 0 -> 20442 bytes docs/installationprocedure/img/fuelmenu6.png | Bin 0 -> 10322 bytes docs/installationprocedure/img/grub-1.png | Bin 0 -> 388991 bytes docs/installationprocedure/img/health.png | Bin 0 -> 51840 bytes docs/installationprocedure/img/interfaceconf.png | Bin 0 -> 25676 bytes docs/installationprocedure/img/interfaces.png | Bin 0 -> 58851 bytes docs/installationprocedure/img/network.png | Bin 0 -> 55423 bytes docs/installationprocedure/img/neutronl3.png | Bin 0 -> 40478 bytes docs/installationprocedure/img/newenv.png | Bin 0 -> 37483 bytes docs/installationprocedure/img/nodes.png | Bin 0 -> 9155 bytes docs/installationprocedure/img/offloadingmodes.png | Bin 0 -> 23017 bytes docs/installationprocedure/img/other.png | Bin 0 -> 41526 bytes docs/installationprocedure/img/plugin_install.png | Bin 0 -> 17431 bytes docs/installationprocedure/img/plugins.png | Bin 0 -> 52382 bytes docs/installationprocedure/img/verifynet.png | Bin 0 -> 33162 bytes docs/installationprocedure/index.rst | 15 + .../installation.instruction.rst | 714 ++++++++++++++++++++ docs/release-notes.rst | 259 ------- docs/releasenotes/index.rst | 16 + docs/releasenotes/release-notes.rst | 250 +++++++ 59 files changed, 1316 insertions(+), 1723 deletions(-) delete mode 100644 docs/build-instruction.rst create mode 100644 docs/buildprocedure/build.instruction.rst create mode 100644 docs/buildprocedure/index.rst delete mode 100644 docs/configguide/installerconfig.rst delete mode 100644 docs/configguide/postinstall.rst delete mode 100644 docs/img/addnodes.png delete mode 100644 docs/img/compute.png delete mode 100644 docs/img/computelist.png delete mode 100644 docs/img/fuelconsole1.png delete mode 100644 docs/img/fuelmenu1.png delete mode 100644 docs/img/fuelmenu2.png delete mode 100644 docs/img/fuelmenu2a.png delete mode 100644 docs/img/fuelmenu3.png delete mode 100644 docs/img/fuelmenu4.png delete mode 100644 docs/img/fuelmenu5.png delete mode 100644 docs/img/fuelmenu6.png delete mode 100644 docs/img/grub-1.png delete mode 100644 docs/img/health.png delete mode 100644 docs/img/interfaceconf.png delete mode 100644 docs/img/interfaces.png delete mode 100644 docs/img/network.png delete mode 100644 docs/img/neutronl3.png delete mode 100644 docs/img/newenv.png delete mode 100644 docs/img/nodes.png delete mode 100644 docs/img/offloadingmodes.png delete mode 100644 docs/img/other.png delete mode 100644 docs/img/plugin_install.png delete mode 100644 docs/img/plugins_aarch64.png delete mode 100644 docs/img/verifynet.png delete mode 100644 docs/index.rst delete mode 100644 docs/installation-instruction.rst create mode 100644 docs/installationprocedure/img/addnodes.png create mode 100644 docs/installationprocedure/img/compute.png create mode 100644 docs/installationprocedure/img/computelist.png create mode 100644 docs/installationprocedure/img/fuelconsole1.png create mode 100644 docs/installationprocedure/img/fuelmenu1.png create mode 100644 docs/installationprocedure/img/fuelmenu2.png create mode 100644 docs/installationprocedure/img/fuelmenu3.png create mode 100644 docs/installationprocedure/img/fuelmenu4.png create mode 100644 docs/installationprocedure/img/fuelmenu5.png create mode 100644 docs/installationprocedure/img/fuelmenu6.png create mode 100644 docs/installationprocedure/img/grub-1.png create mode 100644 docs/installationprocedure/img/health.png create mode 100644 docs/installationprocedure/img/interfaceconf.png create mode 100644 docs/installationprocedure/img/interfaces.png create mode 100644 docs/installationprocedure/img/network.png create mode 100644 docs/installationprocedure/img/neutronl3.png create mode 100644 docs/installationprocedure/img/newenv.png create mode 100644 docs/installationprocedure/img/nodes.png create mode 100644 docs/installationprocedure/img/offloadingmodes.png create mode 100644 docs/installationprocedure/img/other.png create mode 100644 docs/installationprocedure/img/plugin_install.png create mode 100644 docs/installationprocedure/img/plugins.png create mode 100644 docs/installationprocedure/img/verifynet.png create mode 100644 docs/installationprocedure/index.rst create mode 100644 docs/installationprocedure/installation.instruction.rst delete mode 100644 docs/release-notes.rst create mode 100644 docs/releasenotes/index.rst create mode 100644 docs/releasenotes/release-notes.rst (limited to 'docs') diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst deleted file mode 100644 index e1ead30e..00000000 --- a/docs/build-instruction.rst +++ /dev/null @@ -1,344 +0,0 @@ -================================================================================================= -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 - -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 (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/engine/installation/ubuntulinux/ for - installation notes for Ubuntu 14.04. Tested against version 1.9.x and greater - -- git - -- make - -- curl - -- fuseiso - -Apart from docker, all other package requirements listed above are -simply available through: - -.. code-block:: bash - - $ sudo apt-get install git make curl fuseiso - -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.1.0 - -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), 443 (https) and 873 (rsync). - -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). - -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 -. - -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 - file. - -Note! The same observation as above, before altering Makefile, run: - -.. code-block:: bash - - $ make submodules-init 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! 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: - -- A low level method using Make - -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 clean-docker clean-build - - - make submodules-init 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 - -- submodules-init - Initialize git submodules (fuel@OPNFV, fuel-library etc.) - -- submodules-clean - cleanup git submodules (fuel@OPNFV, fuel-library etc.) - -- patches-import - this will apply armband@OPNFV patches to git submodules - -- patches-export - this will export git submodules changes as armband patches - -- clean-build - this will remove all artifacts from earlier builds. - -- clean-docker - this will remove all docker caches from earlier builds. - -If the build is successful, you will find the generated ISO file in -the subdirectory! - -Artifacts -========= - -The artifacts produced are: - -- - Which represents the bootable (x86_64) 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 1.0 release of OPNFV when using Fuel as a deployment tool `_ - -2) `OPNFV Build instruction for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool `_ - -3) `OPNFV Release Note for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/buildprocedure/build.instruction.rst b/docs/buildprocedure/build.instruction.rst new file mode 100644 index 00000000..d755ee5f --- /dev/null +++ b/docs/buildprocedure/build.instruction.rst @@ -0,0 +1,305 @@ +.. 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 +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 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. + +============ +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 Colorado release: + +.. code-block:: bash + + $ cd fuel + $ git checkout colorado.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 Colorado 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. + +========== +References +========== + +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 + +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 + +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 diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst new file mode 100644 index 00000000..4f88814b --- /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 . + +********************************* +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 83fc605d..00000000 --- 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 . - -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 `_ - -2) `OPNFV documentation- and software downloads `_ - -OpenStack -~~~~~~~~~ - -3) `OpenStack Liberty Release artifacts `_ - -4) `OpenStack documentation `_ - -OpenDaylight -~~~~~~~~~~~~ - -5) `OpenDaylight artifacts `_ - -Fuel -~~~~ - -6) `The Fuel OpenStack project `_ - -7) `Fuel documentation overview `_ - -8) `Fuel planning guide `_ - -9) `Fuel quick start guide `_ - -10) `Fuel user guide `_ - -11) `Fuel Plugin Developers Guide `_ - -12) `Fuel OpenStack Hardware Compatibility List `_ - -Fuel in OPNFV -~~~~~~~~~~~~~ - -13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool `_ - -14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool `_ - -15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index 5064e4a2..00000000 --- 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 . - -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 15730db9..00000000 Binary files a/docs/img/addnodes.png and /dev/null differ diff --git a/docs/img/compute.png b/docs/img/compute.png deleted file mode 100644 index fd7811f3..00000000 Binary files a/docs/img/compute.png and /dev/null differ diff --git a/docs/img/computelist.png b/docs/img/computelist.png deleted file mode 100644 index a4453d95..00000000 Binary files a/docs/img/computelist.png and /dev/null differ diff --git a/docs/img/fuelconsole1.png b/docs/img/fuelconsole1.png deleted file mode 100644 index 61703cab..00000000 Binary files a/docs/img/fuelconsole1.png and /dev/null differ diff --git a/docs/img/fuelmenu1.png b/docs/img/fuelmenu1.png deleted file mode 100644 index 15fccc43..00000000 Binary files a/docs/img/fuelmenu1.png and /dev/null differ diff --git a/docs/img/fuelmenu2.png b/docs/img/fuelmenu2.png deleted file mode 100644 index 1f87c53e..00000000 Binary files a/docs/img/fuelmenu2.png and /dev/null differ diff --git a/docs/img/fuelmenu2a.png b/docs/img/fuelmenu2a.png deleted file mode 100644 index 396c1237..00000000 Binary files a/docs/img/fuelmenu2a.png and /dev/null differ diff --git a/docs/img/fuelmenu3.png b/docs/img/fuelmenu3.png deleted file mode 100644 index c9fa2795..00000000 Binary files a/docs/img/fuelmenu3.png and /dev/null differ diff --git a/docs/img/fuelmenu4.png b/docs/img/fuelmenu4.png deleted file mode 100644 index 1bc9c041..00000000 Binary files a/docs/img/fuelmenu4.png and /dev/null differ diff --git a/docs/img/fuelmenu5.png b/docs/img/fuelmenu5.png deleted file mode 100644 index 11247986..00000000 Binary files a/docs/img/fuelmenu5.png and /dev/null differ diff --git a/docs/img/fuelmenu6.png b/docs/img/fuelmenu6.png deleted file mode 100644 index 9ff62c79..00000000 Binary files a/docs/img/fuelmenu6.png and /dev/null differ diff --git a/docs/img/grub-1.png b/docs/img/grub-1.png deleted file mode 100644 index 7488503a..00000000 Binary files a/docs/img/grub-1.png and /dev/null differ diff --git a/docs/img/health.png b/docs/img/health.png deleted file mode 100644 index 71675069..00000000 Binary files a/docs/img/health.png and /dev/null differ diff --git a/docs/img/interfaceconf.png b/docs/img/interfaceconf.png deleted file mode 100644 index e8b45578..00000000 Binary files a/docs/img/interfaceconf.png and /dev/null differ diff --git a/docs/img/interfaces.png b/docs/img/interfaces.png deleted file mode 100644 index 291e434f..00000000 Binary files a/docs/img/interfaces.png and /dev/null differ diff --git a/docs/img/network.png b/docs/img/network.png deleted file mode 100644 index 04c67d38..00000000 Binary files a/docs/img/network.png and /dev/null differ diff --git a/docs/img/neutronl3.png b/docs/img/neutronl3.png deleted file mode 100644 index dd8d7954..00000000 Binary files a/docs/img/neutronl3.png and /dev/null differ diff --git a/docs/img/newenv.png b/docs/img/newenv.png deleted file mode 100644 index d6bc2827..00000000 Binary files a/docs/img/newenv.png and /dev/null differ diff --git a/docs/img/nodes.png b/docs/img/nodes.png deleted file mode 100644 index 771e4813..00000000 Binary files a/docs/img/nodes.png and /dev/null differ diff --git a/docs/img/offloadingmodes.png b/docs/img/offloadingmodes.png deleted file mode 100644 index 5b3cb17b..00000000 Binary files a/docs/img/offloadingmodes.png and /dev/null differ diff --git a/docs/img/other.png b/docs/img/other.png deleted file mode 100644 index 4e740eb0..00000000 Binary files a/docs/img/other.png and /dev/null differ diff --git a/docs/img/plugin_install.png b/docs/img/plugin_install.png deleted file mode 100644 index ff50633e..00000000 Binary files a/docs/img/plugin_install.png and /dev/null differ diff --git a/docs/img/plugins_aarch64.png b/docs/img/plugins_aarch64.png deleted file mode 100644 index 83c0262d..00000000 Binary files a/docs/img/plugins_aarch64.png and /dev/null differ diff --git a/docs/img/verifynet.png b/docs/img/verifynet.png deleted file mode 100644 index 5932bc22..00000000 Binary files a/docs/img/verifynet.png and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 815d4068..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,19 +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 . - -***************** -ArmbandFuel@OPNFV -***************** - -.. toctree:: - :maxdepth: 4 - - build-instruction.rst - installation-instruction.rst - release-notes.rst - -.. :titlesonly: - diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst deleted file mode 100644 index 356f4110..00000000 --- a/docs/installation-instruction.rst +++ /dev/null @@ -1,745 +0,0 @@ -==================================================================================================================== -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 - -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. - -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. - -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 -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 -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* - -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: - -.. code-block:: bash - - $ git clone https://gerrit.opnfv.org/gerrit/armband - -Check-out the Colorado release tag to set the HEAD to the -baseline required to replicate the Colorado release: - -.. code-block:: bash - - $ git checkout colorado.1.0 - -Go to the armband directory and build the .iso: - -.. code-block:: bash - - $ cd armband - $ make release - -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 user guide, please see *Reference: 9* - -- Fuel operations guide, please see *Reference: 10* - -- Fuel Plugin Developers Guide, please see *Reference: 11* - -Prior to installation, 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) - -#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes) - -#. Monitoring options you want to deploy (Ceilometer, Syslog, erc.). - -#. Other options not covered in the document are available in the links above - - -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: - -+--------------------+------------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+====================+======================================================+ -| **AArch64 nodes** | Minimum 5 (3 for non redundant deployment): | -| | | -| | - 3(1) Controllers (1 colocated mongo/ceilometer | -| | role, 2 Ceph-OSD roles) | -| | | -| | - 1 Compute (1 co-located Ceph-OSD role) | -| | | -+--------------------+------------------------------------------------------+ -| **CPU** | Minimum 1 socket AArch64 (ARMv8) with Virtualization | -| | support | -+--------------------+------------------------------------------------------+ -| **RAM** | Minimum 16GB/server (Depending on VNF work load) | -| | | -+--------------------+------------------------------------------------------+ -| **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 | -| | | -| | Note: These can be allocated to a single NIC - | -| | 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: - -When choosing the hardware on which you will deploy your OpenStack -environment, you should think about: - -- CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine. - -- Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node. - -- Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage. - -- Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage. - - -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 comprises a redundant 10GE switch pair for each of the -three physically separated networks. - -The physical TOR switches are **not** automatically configured from -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: - - -OPNFV Software installation and deployment -========================================== - -This section describes the installation of the OPNFV installation -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. - - - The system now boots from the ISO image. - - - Select "Fuel Install (Static IP)" (See figure below) - - - Press [Enter]. - - .. figure:: img/grub-1.png - -#. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). - -#. In the "Fuel User" section - Confirm/change the default password (See figure below) - - - Enter "admin" in the Fuel password input - - - Enter "admin" in the Confirm password input - - - Select "Check" and press [Enter] - - .. 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). - - - Configuration of ETH1 interface for connectivity into your corporate/lab - network is mandatory, as internet connection is required during deployment. - - .. 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 End 10.20.0.254 - - - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node) - - .. figure:: img/fuelmenu3.png - -#. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values: - - - Hostname - - - Domain - - - Search Domain - - - External DNS - - - Hostname to test DNS - - - Select and press [Enter] - - .. 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. - - **NOTE:** Cannot be used in tandem with local repository support. - - .. figure:: img/fuelmenu5.png - -#. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values: - - - NTP Server 1 - - - NTP Server 2 - - - NTP Server 3 - - .. figure:: img/fuelmenu6.png - -#. Start the installation. - - - Press or select Quit Setup and press Save and Quit. - - - Installation starts, 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 -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. - -#. Reboot all the control and compute blades. - -#. Wait for the availability of nodes showing up in the Fuel GUI. - - - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443) - - - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below). - - .. 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: - - .. code-block:: bash - - $ fuel plugins --install /opt/opnfv/-..rpm - - Expected output (see figure below): - - .. code-block:: bash - - 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) - -#. Create and name a new OpenStack environment, to be installed. - - .. figure:: img/newenv.png - -#. Select "" and press - -#. Select "compute virtulization method". - - - Select "QEMU-KVM as hypervisor" and press - -#. Select "network mode". - - - Select "Neutron with ML2 plugin" - - - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin) - - - Press - -#. Select "Storage Back-ends". - - - Select "Ceph for block storage" and press - -#. Select "additional services" you wish to install. - - - Check option "Install Ceilometer (OpenStack Telemetry)" and press - -#. Create the new environment. - - - Click 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). - - .. figure:: img/network.png - -#. Update the Public network configuration and change the following fields to appropriate values: - - - CIDR to - - - IP Range Start to - - - IP Range End to - - - Gateway to - - - Check . - - - Set appropriate VLAN id. - -#. Update the Storage Network Configuration - - - Set CIDR to appropriate value (default 192.168.1.0/24) - - - Set IP Range Start to appropriate value (default 192.168.1.1) - - - Set IP Range End to appropriate value (default 192.168.1.254) - - - Set vlan to appropriate value (default 102) - -#. Update the Management network configuration. - - - Set CIDR to appropriate value (default 192.168.0.0/24) - - - Set IP Range Start to appropriate value (default 192.168.0.1) - - - Set IP Range End to appropriate value (default 192.168.0.254) - - - Check . - - - Set appropriate VLAN id. (default 101) - -#. Update the Private Network Information - - - Set CIDR to appropriate value (default 192.168.2.0/24 - - - Set IP Range Start to appropriate value (default 192.168.2.1) - - - Set IP Range End to appropriate value (default 192.168.2.254) - - - Check . - - - Set appropriate VLAN tag (default 103) - -#. Select the "Neutron L3 Node Networks group" on the left pane. - - .. figure:: img/neutronl3.png - -#. Update the Floating Network configuration. - - - Set the Floating IP range start (default 172.16.0.130) - - - Set the Floating IP range end (default 172.16.0.254) - - - Set the Floating network name (default admin_floating_net) - -#. Update the Internal Network configuration. - - - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24) - - - Set Internal network gateway to an appropriate value - - - Set the Internal network name (default admin_internal_net) - -#. Update the Guest OS DNS servers. - - - Set Guest OS DNS Server values appropriately - -#. Save Settings. - -#. Select the "Other Node Networks group" on the left pane(see figure below). - - .. figure:: img/other.png - -#. Update the Public network assignment. - - - Check the box for "Assign public network to all nodes" (Required by OpenDaylight) - -#. Update Host OS DNS Servers. - - - Provide the DNS server settings - -#. Update Host OS NTP Servers. - - - 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) - - - 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 - -#. Select Other on the left side pane (see figure below) - - - Enable and configure the plugins of your choice - - .. figure:: img/plugins_aarch64.png - -Allocate nodes to environment and assign functional roles ---------------------------------------------------------- - -#. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below). - - .. figure:: img/addnodes.png - -#. Assign roles (see figure below). - - - Click on the <+Add Nodes> button - - - Check , and optionally an SDN Controller role (OpenDaylight controller) in the Assign Roles Section. - - - Check one node which you want to act as a Controller from the bottom half of the screen - - - Click . - - - Click on the <+Add Nodes> button - - - Check the and roles. - - - Check the two next nodes you want to act as Controllers from the bottom half of the screen - - - Click - - - Click on <+Add Nodes> button - - - Check the and roles. - - - Check the Nodes you want to act as Computes from the bottom half of the screen - - - Click . - - .. figure:: img/computelist.png - -#. Configure interfaces (see figure below). - - - Check Select to select all allocated nodes - - - Click - - - Assign interfaces (bonded) for mgmt-, admin-, private-, public- - and storage networks - - - Click - - .. 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! - -The following steps can 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" - - - "ubuntu-security" URI="deb http://:8080/mirrors/ubuntu/ trusty-security main" - - - "ubuntu-updates" URI="deb http://:8080/mirrors/ubuntu/ trusty-updates main" - - - "mos" URI="deb http://::8080/mitaka-8.0/ubuntu/x86_64 mos8.0 main restricted" - - - "Auxiliary" URI="deb http://:8080/mitaka-8.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) might 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 - PXE booted (bootstrapped); the most frequent changes are in defaults - for ethernet devices' "Offloading Modes" settings (e.g. some targets' - ethernet drivers may strip VLAN traffic by default). - - If your target ethernet drivers have wrong "Offloading Modes" defaults, - in "Configure interfaces" page (described above), expand affected - interface's "Offloading Modes" and [un]check the relevant settings - (see figure below): - - .. figure:: img/offloadingmodes.png - -#. Set up targets for "Verify Networks" with non-default "Offloading Modes" - - **NOTE**: Check *Reference 15* for an updated and comprehensive list of - known issues and/or limitations, including "Offloading Modes" not being - applied during "Verify Networks" step. - - Setting custom "Offloading Modes" in Fuel GUI will only apply those settings - during provisiong and **not** during "Verify Networks", so if your targets - need this change, you have to apply "Offloading Modes" settings by hand - to bootstrapped nodes. - - **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on - the Openstack interface(s) "eth1", preventing VLAN traffic from passing - during "Verify Networks". - - - From Fuel master console identify target nodes admin IPs (see figure below): - - .. code-block:: bash - - $ fuel nodes - - .. figure:: img/fuelconsole1.png - - - SSH into each of the target nodes and disable "rx-vlan-filter" on the - affected physical interface(s) allocated for OpenStack traffic (eth1): - - .. code-block:: bash - - $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off - - - 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 -packages needed for a successful deployment can be fetched. - -#. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below) - - - Select - - - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown - - .. figure:: img/verifynet.png - - -Deploy Your Environment ------------------------ - -38. Deploy the environment. - - - In the Fuel GUI, click on the "Dashboard" Tab. - - - Click on in the "Ready to Deploy?" section - - - Examine any information notice that pops up and click - - Wait for your deployment to complete, you can view the "Dashboard" - Tab to see the progress and status of your deployment. - -Installation health-check -========================= - -#. Perform system health-check (see figure below) - - - Click the "Health Check" tab inside your Environment in the FUEL Web UI - - - Check and Click + + - Allow tests to run and investigate results where appropriate + + .. figure:: img/health.png + +========== +References +========== + +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 `_: 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 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.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 + +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 diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 03763bab..00000000 --- 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 `_ version "Berylium SR3" - -- `Open vSwitch for NFV `_ - -- `VSPERF `_ - -The following OPNFV plugins are not yet ported for AArch64: - -- `ONOS `_ version "Drake" - -- `Service function chaining `_ - -- `SDN distributed routing and VPN `_ - -- `NFV Hypervisors-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' - -(Also See respective Integrated feature project's bug tracking) - -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -`AArch64 Workarounds `_ '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' - -(Also See respective Integrated feature project's bug tracking) - -Workarounds ------------ - -**JIRA TICKETS:** - -`AArch64 Workarounds `_ '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 `_ - -2) `OPNFV documentation- and software downloads `_ - -OpenStack ---------- - -3) `OpenStack Mitaka Release artifacts `_ - -4) `OpenStack documentation `_ - -OpenDaylight ------------- - -5) `OpenDaylight artifacts `_ - -Fuel ----- - -6) `The Fuel OpenStack project `_ - -7) `Fuel documentation overview `_ - -8) `Fuel planning guide `_ - -9) `Fuel quick start guide `_ - -10) `Fuel user guide `_ - -11) `Fuel Plugin Developers Guide `_ - -12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List `_ - -Fuel in OPNFV -------------- - -13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ - -14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ - -15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 00000000..db97a749 --- /dev/null +++ b/docs/releasenotes/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 . + +***************************** +Release notes for Fuel\@OPNFV +***************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + release-notes.rst + diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst new file mode 100644 index 00000000..fa9e98e0 --- /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 . + +======== +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 `_ version "Beryllium SR3" [1]_ - 'http://www.opendaylight.org/software' + +- `ONOS `_ version "Drake" - 'http://onosproject.org/' + +- `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' + +- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' + +- `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 +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' + +(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' + +(Also See respective Integrated feature project's bug tracking) + +Workarounds +=========== + +**JIRA TICKETS:** + +`Workarounds `_ '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' + +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.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' + +9) `Fuel quick start guide `_ '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' + +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/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' + +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' + +.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. -- cgit 1.2.3-korg