From 983a8377c55ad63133bf5be68a5b52928c592b11 Mon Sep 17 00:00:00 2001 From: Jonas Bjurel Date: Wed, 17 Aug 2016 13:11:15 +0200 Subject: REVISED DOCUMENT STRUCTURE Documentation structure changed according to docs team directions: - Configuration guide removed (only aplicable for features/scenarios) - Installation instructions moved to a separate directory - Build instructions moved to a separate directory - Release notes moved to a separate directory NOTE: Content not updated to the Colorado baseline Change-Id: I47f3bee0cf91bab6ed5c4a7f371b10347a917857 Signed-off-by: Jonas Bjurel --- docs/build-instruction.rst | 315 ------------------- docs/buildprocedure/build.instruction.rst | 315 +++++++++++++++++++ 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/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.png | Bin 39118 -> 0 bytes docs/img/verifynet.png | Bin 61499 -> 0 bytes docs/index.rst | 19 -- docs/installationprocedure/img/addnodes.png | Bin 0 -> 24624 bytes docs/installationprocedure/img/compute.png | Bin 0 -> 49919 bytes docs/installationprocedure/img/computelist.png | Bin 0 -> 70343 bytes docs/installationprocedure/img/fuelconsole1.png | Bin 0 -> 8269 bytes docs/installationprocedure/img/fuelmenu1.png | Bin 0 -> 8766 bytes docs/installationprocedure/img/fuelmenu2.png | Bin 0 -> 9679 bytes docs/installationprocedure/img/fuelmenu3.png | Bin 0 -> 9634 bytes docs/installationprocedure/img/fuelmenu4.png | Bin 0 -> 9843 bytes docs/installationprocedure/img/fuelmenu5.png | Bin 0 -> 22548 bytes docs/installationprocedure/img/fuelmenu6.png | Bin 0 -> 10703 bytes docs/installationprocedure/img/grub-1.png | Bin 0 -> 381031 bytes docs/installationprocedure/img/health.png | Bin 0 -> 54348 bytes docs/installationprocedure/img/interfaceconf.png | Bin 0 -> 58890 bytes docs/installationprocedure/img/interfaces.png | Bin 0 -> 58851 bytes docs/installationprocedure/img/network.png | Bin 0 -> 53472 bytes docs/installationprocedure/img/neutronl3.png | Bin 0 -> 71846 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 -> 71641 bytes docs/installationprocedure/img/plugin_install.png | Bin 0 -> 17431 bytes docs/installationprocedure/img/plugins.png | Bin 0 -> 39118 bytes docs/installationprocedure/img/verifynet.png | Bin 0 -> 61499 bytes docs/installationprocedure/index.rst | 14 +- docs/release-notes.rst | 246 --------------- docs/releasenotes/index.rst | 16 + docs/releasenotes/release-notes.rst | 246 +++++++++++++++ 56 files changed, 601 insertions(+), 942 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/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.png delete mode 100644 docs/img/verifynet.png delete mode 100644 docs/index.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 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 7e381500b..000000000 --- a/docs/build-instruction.rst +++ /dev/null @@ -1,315 +0,0 @@ -============================================================================================== -OPNFV Build instruction for the Colorado 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 -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 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) - -- p7zip-full (simply available through $ sudo apt-get install p7zip-full) - -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), 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 /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). - -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 fuel/build/f_isoroot/Makefile. - -Note! Doing this will require the Fuel master node to have Internet -access when installing the ISO artifact built as no Ubuntu package -cache will be on the ISO! - -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 `_ - -2) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool `_ - -3) `OPNFV Release Note for the Colorado 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 000000000..7e381500b --- /dev/null +++ b/docs/buildprocedure/build.instruction.rst @@ -0,0 +1,315 @@ +============================================================================================== +OPNFV Build instruction for the Colorado 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 +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 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) + +- p7zip-full (simply available through $ sudo apt-get install p7zip-full) + +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), 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 /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). + +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 fuel/build/f_isoroot/Makefile. + +Note! Doing this will require the Fuel master node to have Internet +access when installing the ISO artifact built as no Ubuntu package +cache will be on the ISO! + +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 `_ + +2) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool `_ + +3) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst new file mode 100644 index 000000000..99dc3ab27 --- /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 . + +***************************** +Fuel@OPNFV build instructions +***************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + build.instruction.rst + diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst deleted file mode 100644 index 07a50d941..000000000 --- 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 Brahmaputra release of OPNFV when using Fuel as a -deployment tool including required software and hardware -configurations. - -For detailed instructions on how to install the Brahmaputra release using -Fuel, see *Reference 13* in section *"Fuel associated references"* below. - -Pre-configuration activities ----------------------------- - -Planning the deployment - -Before starting the installation of the Brahmaputra 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 Brahmaputra release can be found at *Reference: 2* - -Alternatively, you may build the .iso from source by cloning the -opnfv/fuel git repository. Detailed instructions on how to build -a Fuel OPNFV .iso can be found 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 Brahmaputra 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 Brahmaputra 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 | -| | Brahmaputra 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 | -| | Brahmaputra 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 | -| | Brahmaputra 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 Brahmaputra 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 Brahmaputra 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 Brahmaputra 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 Brahmaputra 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 Brahmaputra 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 Brahmaputra environment - but before doing so you may want to verify your network settings. - -For further details on network verification and deployment, please refer to -the installation instructions 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 operations guide `_ - -11) `Fuel Plugin Developers Guide `_ - -12) `Fuel OpenStack Hardware Compatibility List `_ - -Fuel in OPNFV -~~~~~~~~~~~~~ - -13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ - -14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ - -15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index 5064e4a20..000000000 --- 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 15730db90..000000000 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 fd7811f37..000000000 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 a4453d958..000000000 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 61703cab1..000000000 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 15fccc434..000000000 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 1f87c53e5..000000000 Binary files a/docs/img/fuelmenu2.png and /dev/null differ diff --git a/docs/img/fuelmenu3.png b/docs/img/fuelmenu3.png deleted file mode 100644 index c9fa27959..000000000 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 1bc9c0410..000000000 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 11247986b..000000000 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 9ff62c798..000000000 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 7488503af..000000000 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 71675069e..000000000 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 e8b45578c..000000000 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 291e434f6..000000000 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 04c67d38e..000000000 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 dd8d7954b..000000000 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 d6bc2827f..000000000 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 771e4813d..000000000 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 5b3cb17bc..000000000 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 4e740eb06..000000000 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 ff50633ed..000000000 Binary files a/docs/img/plugin_install.png and /dev/null differ diff --git a/docs/img/plugins.png b/docs/img/plugins.png deleted file mode 100644 index bfe8781e8..000000000 Binary files a/docs/img/plugins.png and /dev/null differ diff --git a/docs/img/verifynet.png b/docs/img/verifynet.png deleted file mode 100644 index 5932bc223..000000000 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 6bba3aaf1..000000000 --- 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 . - -********** -Fuel@OPNFV -********** - -.. toctree:: - :maxdepth: 4 - - build-instruction.rst - installation-instruction.rst - release-notes.rst - -.. :titlesonly: - diff --git a/docs/installationprocedure/img/addnodes.png b/docs/installationprocedure/img/addnodes.png new file mode 100644 index 000000000..15730db90 Binary files /dev/null and b/docs/installationprocedure/img/addnodes.png differ diff --git a/docs/installationprocedure/img/compute.png b/docs/installationprocedure/img/compute.png new file mode 100644 index 000000000..fd7811f37 Binary files /dev/null and b/docs/installationprocedure/img/compute.png differ diff --git a/docs/installationprocedure/img/computelist.png b/docs/installationprocedure/img/computelist.png new file mode 100644 index 000000000..a4453d958 Binary files /dev/null and b/docs/installationprocedure/img/computelist.png differ diff --git a/docs/installationprocedure/img/fuelconsole1.png b/docs/installationprocedure/img/fuelconsole1.png new file mode 100644 index 000000000..61703cab1 Binary files /dev/null and b/docs/installationprocedure/img/fuelconsole1.png differ diff --git a/docs/installationprocedure/img/fuelmenu1.png b/docs/installationprocedure/img/fuelmenu1.png new file mode 100644 index 000000000..15fccc434 Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu1.png differ diff --git a/docs/installationprocedure/img/fuelmenu2.png b/docs/installationprocedure/img/fuelmenu2.png new file mode 100644 index 000000000..1f87c53e5 Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu2.png differ diff --git a/docs/installationprocedure/img/fuelmenu3.png b/docs/installationprocedure/img/fuelmenu3.png new file mode 100644 index 000000000..c9fa27959 Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu3.png differ diff --git a/docs/installationprocedure/img/fuelmenu4.png b/docs/installationprocedure/img/fuelmenu4.png new file mode 100644 index 000000000..1bc9c0410 Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu4.png differ diff --git a/docs/installationprocedure/img/fuelmenu5.png b/docs/installationprocedure/img/fuelmenu5.png new file mode 100644 index 000000000..11247986b Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu5.png differ diff --git a/docs/installationprocedure/img/fuelmenu6.png b/docs/installationprocedure/img/fuelmenu6.png new file mode 100644 index 000000000..9ff62c798 Binary files /dev/null and b/docs/installationprocedure/img/fuelmenu6.png differ diff --git a/docs/installationprocedure/img/grub-1.png b/docs/installationprocedure/img/grub-1.png new file mode 100644 index 000000000..7488503af Binary files /dev/null and b/docs/installationprocedure/img/grub-1.png differ diff --git a/docs/installationprocedure/img/health.png b/docs/installationprocedure/img/health.png new file mode 100644 index 000000000..71675069e Binary files /dev/null and b/docs/installationprocedure/img/health.png differ diff --git a/docs/installationprocedure/img/interfaceconf.png b/docs/installationprocedure/img/interfaceconf.png new file mode 100644 index 000000000..e8b45578c Binary files /dev/null and b/docs/installationprocedure/img/interfaceconf.png differ diff --git a/docs/installationprocedure/img/interfaces.png b/docs/installationprocedure/img/interfaces.png new file mode 100644 index 000000000..291e434f6 Binary files /dev/null and b/docs/installationprocedure/img/interfaces.png differ diff --git a/docs/installationprocedure/img/network.png b/docs/installationprocedure/img/network.png new file mode 100644 index 000000000..04c67d38e Binary files /dev/null and b/docs/installationprocedure/img/network.png differ diff --git a/docs/installationprocedure/img/neutronl3.png b/docs/installationprocedure/img/neutronl3.png new file mode 100644 index 000000000..dd8d7954b Binary files /dev/null and b/docs/installationprocedure/img/neutronl3.png differ diff --git a/docs/installationprocedure/img/newenv.png b/docs/installationprocedure/img/newenv.png new file mode 100644 index 000000000..d6bc2827f Binary files /dev/null and b/docs/installationprocedure/img/newenv.png differ diff --git a/docs/installationprocedure/img/nodes.png b/docs/installationprocedure/img/nodes.png new file mode 100644 index 000000000..771e4813d Binary files /dev/null and b/docs/installationprocedure/img/nodes.png differ diff --git a/docs/installationprocedure/img/offloadingmodes.png b/docs/installationprocedure/img/offloadingmodes.png new file mode 100644 index 000000000..5b3cb17bc Binary files /dev/null and b/docs/installationprocedure/img/offloadingmodes.png differ diff --git a/docs/installationprocedure/img/other.png b/docs/installationprocedure/img/other.png new file mode 100644 index 000000000..4e740eb06 Binary files /dev/null and b/docs/installationprocedure/img/other.png differ diff --git a/docs/installationprocedure/img/plugin_install.png b/docs/installationprocedure/img/plugin_install.png new file mode 100644 index 000000000..ff50633ed Binary files /dev/null and b/docs/installationprocedure/img/plugin_install.png differ diff --git a/docs/installationprocedure/img/plugins.png b/docs/installationprocedure/img/plugins.png new file mode 100644 index 000000000..bfe8781e8 Binary files /dev/null and b/docs/installationprocedure/img/plugins.png differ diff --git a/docs/installationprocedure/img/verifynet.png b/docs/installationprocedure/img/verifynet.png new file mode 100644 index 000000000..5932bc223 Binary files /dev/null and b/docs/installationprocedure/img/verifynet.png differ diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index 30dacbefd..0dd7a881b 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -1,10 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) +.. 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 Installation Instruction -***************************** +*********************************** +Fuel@OPNFV Installation Instruction +*********************************** .. toctree:: :numbered: diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 7339b596b..000000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,246 +0,0 @@ -============================================================================================ -OPNFV Release Note for the Brahmaputra 3.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 Brahmaputra 3.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 Brahmaputra 3.0 release of OPNFV. - -The goal of the Brahmaputra release and this Fuel-based deployment process is -to establish a lab ready platform accelerating further development -of the OPNFV infrastructure. - -Carefully follow the installation-instructions provided in *Reference 13*. - -Summary -======= - -For Brahmaputra, the typical use of Fuel as an OpenStack installer is -supplemented with OPNFV unique components such as: - -- `OpenDaylight `_ version "Berylium SR1" - -- `ONOS `_ version "Drake" - -- `Service function chaining `_ - -- `SDN distributed routing and VPN `_ - -- `NFV Hypervisors-KVM `_ - -- `Open vSwitch for NFV `_ - -- `VSPERF `_ - -As well as OPNFV-unique configurations of the Hardware- and Software stack. - -This Brahmaputra 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 Brahmaputra Fuel installer image (.iso) built by Jenkins - -- Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM) - -- Automated validation of the Brahmaputra deployment - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | fuel | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | brahmaputra.3.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Brahmaputra 3.0 follow-up release | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | April 28 2016 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Brahmaputra alignment to Released | -| | Fuel 8.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | -| | - NFV Hypervisors-KVM | -| | - Open vSwitch for NFV | -| | - OpenDaylight SR1 | -| | - SDN distributed routing and VPN | -| | - Service function chaining | -| | | -+--------------------------------------+--------------------------------------+ - -Version change --------------- - -Module version changes -~~~~~~~~~~~~~~~~~~~~~~ -This is a follow-up release to Brahmaputra 1.0. It is based on -following upstream versions: - -- Fuel 8.0 Base release - -- OpenStack Liberty release - -- OpenDaylight Beryllium SR1 release - -- ONOS Drake release - -Document changes -~~~~~~~~~~~~~~~~ -This is a follow-up release to Brahmaputra 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 Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test -runs, see separate test results. - -References -========== -For more information on the OPNFV Brahmaputra release, please see: - -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 operations guide `_ - -11) `Fuel Plugin Developers Guide `_ - -12) `Fuel OpenStack Hardware Compatibility List `_ - -Fuel in OPNFV -------------- - -13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ - -14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ - -15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 000000000..edce08908 --- /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 . + +************************ +Fuel@OPNFV release notes +************************ + +.. 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 000000000..7339b596b --- /dev/null +++ b/docs/releasenotes/release-notes.rst @@ -0,0 +1,246 @@ +============================================================================================ +OPNFV Release Note for the Brahmaputra 3.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 Brahmaputra 3.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 Brahmaputra 3.0 release of OPNFV. + +The goal of the Brahmaputra release and this Fuel-based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure. + +Carefully follow the installation-instructions provided in *Reference 13*. + +Summary +======= + +For Brahmaputra, the typical use of Fuel as an OpenStack installer is +supplemented with OPNFV unique components such as: + +- `OpenDaylight `_ version "Berylium SR1" + +- `ONOS `_ version "Drake" + +- `Service function chaining `_ + +- `SDN distributed routing and VPN `_ + +- `NFV Hypervisors-KVM `_ + +- `Open vSwitch for NFV `_ + +- `VSPERF `_ + +As well as OPNFV-unique configurations of the Hardware- and Software stack. + +This Brahmaputra 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 Brahmaputra Fuel installer image (.iso) built by Jenkins + +- Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM) + +- Automated validation of the Brahmaputra deployment + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | fuel | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | brahmaputra.3.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Brahmaputra 3.0 follow-up release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | April 28 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Brahmaputra alignment to Released | +| | Fuel 8.0 baseline + Bug-fixes for | +| | the following feaures/scenarios: | +| | - NFV Hypervisors-KVM | +| | - Open vSwitch for NFV | +| | - OpenDaylight SR1 | +| | - SDN distributed routing and VPN | +| | - Service function chaining | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ +This is a follow-up release to Brahmaputra 1.0. It is based on +following upstream versions: + +- Fuel 8.0 Base release + +- OpenStack Liberty release + +- OpenDaylight Beryllium SR1 release + +- ONOS Drake release + +Document changes +~~~~~~~~~~~~~~~~ +This is a follow-up release to Brahmaputra 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 Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test +runs, see separate test results. + +References +========== +For more information on the OPNFV Brahmaputra release, please see: + +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 operations guide `_ + +11) `Fuel Plugin Developers Guide `_ + +12) `Fuel OpenStack Hardware Compatibility List `_ + +Fuel in OPNFV +------------- + +13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ + +14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ + +15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool `_ -- cgit 1.2.3-korg