From 86978392a9ba7e6a12af88b94852f3815efbb66a Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Fri, 17 Feb 2017 17:22:48 +0200 Subject: Migrate docs to the new Danube dir structure Change-Id: I6f15bcf5ea66fbdd1c3e4621e7f339dafcea9a7e Signed-off-by: Cristina Pauna --- docs/buildprocedure/build.instruction.rst | 342 ---------- docs/buildprocedure/index.rst | 16 - .../buildprocedure/build.instruction.rst | 342 ++++++++++ docs/development/buildprocedure/index.rst | 16 + docs/installationprocedure/img/addnodes.png | Bin 24089 -> 0 bytes docs/installationprocedure/img/compute.png | Bin 25978 -> 0 bytes docs/installationprocedure/img/computelist.png | Bin 67975 -> 0 bytes docs/installationprocedure/img/fuelconsole1.png | Bin 8269 -> 0 bytes docs/installationprocedure/img/fuelmenu1.png | Bin 9276 -> 0 bytes docs/installationprocedure/img/fuelmenu2.png | Bin 9774 -> 0 bytes docs/installationprocedure/img/fuelmenu2a.png | Bin 11511 -> 0 bytes docs/installationprocedure/img/fuelmenu3.png | Bin 9783 -> 0 bytes docs/installationprocedure/img/fuelmenu4.png | Bin 8843 -> 0 bytes docs/installationprocedure/img/fuelmenu5.png | Bin 20442 -> 0 bytes docs/installationprocedure/img/fuelmenu6.png | Bin 10322 -> 0 bytes docs/installationprocedure/img/fuelwsrepsst.png | Bin 59206 -> 0 bytes docs/installationprocedure/img/grub-1.png | Bin 388991 -> 0 bytes docs/installationprocedure/img/health.png | Bin 51840 -> 0 bytes docs/installationprocedure/img/interfaceconf.png | Bin 25676 -> 0 bytes docs/installationprocedure/img/interfaces.png | Bin 58851 -> 0 bytes docs/installationprocedure/img/network.png | Bin 55423 -> 0 bytes docs/installationprocedure/img/neutronl3.png | Bin 40478 -> 0 bytes docs/installationprocedure/img/newenv.png | Bin 37483 -> 0 bytes docs/installationprocedure/img/nodes.png | Bin 9155 -> 0 bytes docs/installationprocedure/img/offloadingmodes.png | Bin 23017 -> 0 bytes docs/installationprocedure/img/other.png | Bin 41526 -> 0 bytes docs/installationprocedure/img/plugin_install.png | Bin 17431 -> 0 bytes docs/installationprocedure/img/plugins.png | Bin 52382 -> 0 bytes docs/installationprocedure/img/plugins_aarch64.png | Bin 59910 -> 0 bytes docs/installationprocedure/img/verifynet.png | Bin 33162 -> 0 bytes docs/installationprocedure/index.rst | 15 - .../installation.instruction.rst | 732 --------------------- docs/release/installation/img/addnodes.png | Bin 0 -> 24089 bytes docs/release/installation/img/compute.png | Bin 0 -> 25978 bytes docs/release/installation/img/computelist.png | Bin 0 -> 67975 bytes docs/release/installation/img/fuelconsole1.png | Bin 0 -> 8269 bytes docs/release/installation/img/fuelmenu1.png | Bin 0 -> 9276 bytes docs/release/installation/img/fuelmenu2.png | Bin 0 -> 9774 bytes docs/release/installation/img/fuelmenu2a.png | Bin 0 -> 11511 bytes docs/release/installation/img/fuelmenu3.png | Bin 0 -> 9783 bytes docs/release/installation/img/fuelmenu4.png | Bin 0 -> 8843 bytes docs/release/installation/img/fuelmenu5.png | Bin 0 -> 20442 bytes docs/release/installation/img/fuelmenu6.png | Bin 0 -> 10322 bytes docs/release/installation/img/fuelwsrepsst.png | Bin 0 -> 59206 bytes docs/release/installation/img/grub-1.png | Bin 0 -> 388991 bytes docs/release/installation/img/health.png | Bin 0 -> 51840 bytes docs/release/installation/img/interfaceconf.png | Bin 0 -> 25676 bytes docs/release/installation/img/interfaces.png | Bin 0 -> 58851 bytes docs/release/installation/img/network.png | Bin 0 -> 55423 bytes docs/release/installation/img/neutronl3.png | Bin 0 -> 40478 bytes docs/release/installation/img/newenv.png | Bin 0 -> 37483 bytes docs/release/installation/img/nodes.png | Bin 0 -> 9155 bytes docs/release/installation/img/offloadingmodes.png | Bin 0 -> 23017 bytes docs/release/installation/img/other.png | Bin 0 -> 41526 bytes docs/release/installation/img/plugin_install.png | Bin 0 -> 17431 bytes docs/release/installation/img/plugins.png | Bin 0 -> 52382 bytes docs/release/installation/img/plugins_aarch64.png | Bin 0 -> 59910 bytes docs/release/installation/img/verifynet.png | Bin 0 -> 33162 bytes docs/release/installation/index.rst | 15 + .../installation/installation.instruction.rst | 732 +++++++++++++++++++++ docs/release/release-notes/index.rst | 16 + docs/release/release-notes/release-notes.rst | 263 ++++++++ docs/releasenotes/index.rst | 16 - docs/releasenotes/release-notes.rst | 263 -------- 64 files changed, 1384 insertions(+), 1384 deletions(-) delete mode 100644 docs/buildprocedure/build.instruction.rst delete mode 100644 docs/buildprocedure/index.rst create mode 100644 docs/development/buildprocedure/build.instruction.rst create mode 100644 docs/development/buildprocedure/index.rst delete mode 100644 docs/installationprocedure/img/addnodes.png delete mode 100644 docs/installationprocedure/img/compute.png delete mode 100644 docs/installationprocedure/img/computelist.png delete mode 100644 docs/installationprocedure/img/fuelconsole1.png delete mode 100644 docs/installationprocedure/img/fuelmenu1.png delete mode 100644 docs/installationprocedure/img/fuelmenu2.png delete mode 100644 docs/installationprocedure/img/fuelmenu2a.png delete mode 100644 docs/installationprocedure/img/fuelmenu3.png delete mode 100644 docs/installationprocedure/img/fuelmenu4.png delete mode 100644 docs/installationprocedure/img/fuelmenu5.png delete mode 100644 docs/installationprocedure/img/fuelmenu6.png delete mode 100644 docs/installationprocedure/img/fuelwsrepsst.png delete mode 100644 docs/installationprocedure/img/grub-1.png delete mode 100644 docs/installationprocedure/img/health.png delete mode 100644 docs/installationprocedure/img/interfaceconf.png delete mode 100644 docs/installationprocedure/img/interfaces.png delete mode 100644 docs/installationprocedure/img/network.png delete mode 100644 docs/installationprocedure/img/neutronl3.png delete mode 100644 docs/installationprocedure/img/newenv.png delete mode 100644 docs/installationprocedure/img/nodes.png delete mode 100644 docs/installationprocedure/img/offloadingmodes.png delete mode 100644 docs/installationprocedure/img/other.png delete mode 100644 docs/installationprocedure/img/plugin_install.png delete mode 100644 docs/installationprocedure/img/plugins.png delete mode 100644 docs/installationprocedure/img/plugins_aarch64.png delete mode 100644 docs/installationprocedure/img/verifynet.png delete mode 100644 docs/installationprocedure/index.rst delete mode 100644 docs/installationprocedure/installation.instruction.rst create mode 100644 docs/release/installation/img/addnodes.png create mode 100644 docs/release/installation/img/compute.png create mode 100644 docs/release/installation/img/computelist.png create mode 100644 docs/release/installation/img/fuelconsole1.png create mode 100644 docs/release/installation/img/fuelmenu1.png create mode 100644 docs/release/installation/img/fuelmenu2.png create mode 100644 docs/release/installation/img/fuelmenu2a.png create mode 100644 docs/release/installation/img/fuelmenu3.png create mode 100644 docs/release/installation/img/fuelmenu4.png create mode 100644 docs/release/installation/img/fuelmenu5.png create mode 100644 docs/release/installation/img/fuelmenu6.png create mode 100644 docs/release/installation/img/fuelwsrepsst.png create mode 100644 docs/release/installation/img/grub-1.png create mode 100644 docs/release/installation/img/health.png create mode 100644 docs/release/installation/img/interfaceconf.png create mode 100644 docs/release/installation/img/interfaces.png create mode 100644 docs/release/installation/img/network.png create mode 100644 docs/release/installation/img/neutronl3.png create mode 100644 docs/release/installation/img/newenv.png create mode 100644 docs/release/installation/img/nodes.png create mode 100644 docs/release/installation/img/offloadingmodes.png create mode 100644 docs/release/installation/img/other.png create mode 100644 docs/release/installation/img/plugin_install.png create mode 100644 docs/release/installation/img/plugins.png create mode 100644 docs/release/installation/img/plugins_aarch64.png create mode 100644 docs/release/installation/img/verifynet.png create mode 100644 docs/release/installation/index.rst create mode 100644 docs/release/installation/installation.instruction.rst create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst delete mode 100644 docs/releasenotes/index.rst delete mode 100644 docs/releasenotes/release-notes.rst diff --git a/docs/buildprocedure/build.instruction.rst b/docs/buildprocedure/build.instruction.rst deleted file mode 100644 index 405a0e70..00000000 --- a/docs/buildprocedure/build.instruction.rst +++ /dev/null @@ -1,342 +0,0 @@ -.. This document is protected/licensed under the following conditions -.. (c) Jonas Bjurel (Ericsson AB) -.. Licensed under a Creative Commons Attribution 4.0 International License. -.. You should have received a copy of the license along with this work. -.. If not, see . - -======== -Abstract -======== - -This document describes how to build the Fuel deployment tool for the -AArch64 Colorado release of OPNFV build system, dependencies and -required system resources. - -============ -Introduction -============ - -This document describes the build system used to build the Fuel -deployment tool for the AArch64 Colorado release of OPNFV, required -dependencies and minimum requirements on the host to be used for the -build system. - -The Fuel build system is designed around Docker containers such that -dependencies outside of the build system can be kept to a minimum. It -also shields the host from any potential dangerous operations -performed by the build system. - -The audience of this document is assumed to have good knowledge in -network and Unix/Linux administration. - -Due to early docker and nodejs support on AArch64, we will still use an -x86_64 Fuel Master to build and deploy an AArch64 target pool, as well -as an x86_64 build machine for building the OPNFV ISO. - -============ -Requirements -============ - -Minimum Hardware Requirements -============================= - -- ~50 GB available disc - -- 4 GB RAM - -Minimum Software Requirements -============================= - -The build host should run Ubuntu 14.04 or 16.04 (x86_64) operating system. - -On the host, the following packages must be installed: - -- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed - - - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported - - A kernel equal- or later than 3.19 (Vivid), simply available through - -.. code-block:: bash - - $ sudo apt-get install linux-generic-lts-vivid - -- docker - see https://docs.docker.com/installation/ubuntulinux/ for - installation notes for Ubuntu 14.04. Note: use the latest version from - Docker (docker-engine) and not the one in Ubuntu 14.04. - -- git - -- make - -- curl - -Apart from docker, all other package requirements listed above are -simply available through: - -.. code-block:: bash - - $ sudo apt-get install git make curl - - -============ -Preparations -============ - -Setting up the Docker build container -===================================== - -After having installed Docker, add yourself to the docker group: - -.. code-block:: bash - - $ sudo usermod -a -G docker [userid] - -Also make sure to define relevant DNS servers part of the global -DNS chain in your configuration file. -Uncomment, and modify the values appropriately. - -For example: - -.. code-block:: bash - - DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" - -Then restart docker: - -.. code-block:: bash - - $ sudo service docker restart - -Setting up OPNFV Gerrit in order to being able to clone the code ----------------------------------------------------------------- - -- Start setting up OPNFV gerrit by creating a SSH key (unless you - don't already have one), create one with ssh-keygen - -- Add your generated public key in OPNFV Gerrit (https://gerrit.opnfv.org/) - (this requires a Linux foundation account, create one if you do not - already have one) - -- Select "SSH Public Keys" to the left and then "Add Key" and paste - your public key in. - -Clone the armband@OPNFV code Git repository with your SSH key -------------------------------------------------------------- - -Now it is time to clone the code repository: - -.. code-block:: bash - - $ git clone ssh://@gerrit.opnfv.org:29418/armband - -Now you should have the OPNFV armband repository with its -directories stored locally on your build host. - -Check out the Colorado release: - -.. code-block:: bash - - $ cd armband - $ git checkout colorado.3.0.1 - -Clone the armband@OPNFV code Git repository without a SSH key -------------------------------------------------------------- - -You can also opt to clone the code repository without a SSH key: - -.. code-block:: bash - - $ git clone https://gerrit.opnfv.org/gerrit/armband - -Make sure to checkout the release tag as described above. - -Support for building behind a http/https/rsync proxy -==================================================== - -The build system is able to make use of a web proxy setup if the -http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or -RSYNC_CONNECT_PROG environment variables have been set before invoking make. - -The proxy setup must permit port 80 (http) and 443 (https). -Rsync protocol is currently not used during build process. - -Important note about the host Docker daemon settings ----------------------------------------------------- - -The Docker daemon on the host must be configured to use the http proxy -for it to be able to pull the base Ubuntu 14.04 image from the Docker -registry before invoking make! In Ubuntu this is done by adding a line -like: - -.. code-block:: bash - - export http_proxy="http://10.0.0.1:8888/" - -to and restarting the Docker daemon. - -Setting proxy environment variables prior to build --------------------------------------------------- - -The build system will make use the following environment variables -that needs to be exported to subshells by using export (bash) or -setenv (csh/tcsh). - -.. code-block:: bash - - http_proxy (or HTTP_PROXY) - https_proxy (or HTTP_PROXY) - no_proxy (or NO_PROXY) - RSYNC_PROXY - RSYNC_CONNECT_PROG - -As an example, these are the settings that were put in the user's -.bashrc when verifying the proxy build functionality: - -.. code-block:: bash - - export RSYNC_PROXY=10.0.0.1:8888 - export http_proxy=http://10.0.0.1:8888 - export https_proxy=http://10.0.0.1:8888 - export no_proxy=localhost,127.0.0.1,.consultron.com,.sock - -Using a ssh proxy for the rsync connection ------------------------------------------- - -If the proxy setup is not allowing the rsync protocol, an alternative -solution is to use a SSH tunnel to a machine capable of accessing the -outbound port 873. Set the RSYNC_CONNECT_PROG according to the rsync -manual page (for example to "ssh @ nc %H 873") -to enable this. Also note that netcat needs to be installed on the -remote system! - -Make sure that the ssh command also refers to the user on the remote -system, as the command itself will be run from the Docker build container -as the root user (but with the invoking user's SSH keys). - - -Note! Armband build system uses git submodules to track fuel and -other upstream repos, so in order to apply the above change, one -should first initialize the submodules and apply armband patches -(only needed once): - -.. code-block:: bash - - $ make patches-import - - -Configure your build environment -================================ - -** Configuring the build environment should not be performed if building -standard Colorado release ** - -Select the versions of the components you want to build by editing the - and - files. - -Note! The same observation as above, before altering Makefile, run: - -.. code-block:: bash - - $ make patches-import - - -Non official build: Selecting which plugins to build -==================================================== - -In order to cut the build time for unofficial builds (made by an -individual developer locally), the selection if which Fuel plugins to -build (if any) can be done by environment variable -"BUILD_FUEL_PLUGINS" prior to building. - -Only the plugin targets from that -are specified in the environment variable will then be built. In order -to completely disable the building of plugins, the environment variable -is set to " ". When using this functionality, the resulting iso file -will be prepended with the prefix "unofficial-" to clearly indicate -that this is not a full build. - -This method of plugin selection is not meant to be used from within -Gerrit! - -Note! So far, only ODL, OVS, BGPVPN and Tacker plugins were ported to AArch64. - -======== -Building -======== - -There are two methods available for building Fuel: - -- A low level method using Make - -- An abstracted method using build.sh - -Low level build method using make -================================= - -The low level method is based on Make: - -From the directory, invoke - -Following targets exist: - -- release - this will do the same as: - - - make submodules-clean patches-import build - -- none/all/build - this will: - - - Initialize the docker build environment - - - Build Fuel from upstream (as defined by fuel-build/config-spec) - - - Build the OPNFV defined plugins/features from upstream - - - Build the defined additions to fuel (as defined by the structure - of this framework) - - - Apply changes and patches to fuel (as defined by the structure of - this framework) - - - Reconstruct a fuel .iso image - -- clean - this will remove all artifacts from earlier builds. - -- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso" - -If the build is successful, you will find the generated ISO file in -the subdirectory! - -Abstracted build method using build.sh -====================================== - -The abstracted build method uses the script which -allows you to: - -- Create and use a build cache - significantly speeding up the - build time if upstream repositories have not changed. - -- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) - -For more info type . - -========= -Artifacts -========= - -The artifacts produced are: - -- - Which represents the bootable Fuel for AArch64 image, - XXXX is replaced with the build identity provided to the build system - -- - Which holds version metadata. - -========== -References -========== - -1) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html - -2) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html - -3) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst deleted file mode 100644 index 49f64c31..00000000 --- a/docs/buildprocedure/index.rst +++ /dev/null @@ -1,16 +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 . - -******************************************** -Build instruction for Fuel\@OPNFV on AArch64 -******************************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - build.instruction.rst - diff --git a/docs/development/buildprocedure/build.instruction.rst b/docs/development/buildprocedure/build.instruction.rst new file mode 100644 index 00000000..405a0e70 --- /dev/null +++ b/docs/development/buildprocedure/build.instruction.rst @@ -0,0 +1,342 @@ +.. This document is protected/licensed under the following conditions +.. (c) Jonas Bjurel (Ericsson AB) +.. Licensed under a Creative Commons Attribution 4.0 International License. +.. You should have received a copy of the license along with this work. +.. If not, see . + +======== +Abstract +======== + +This document describes how to build the Fuel deployment tool for the +AArch64 Colorado release of OPNFV build system, dependencies and +required system resources. + +============ +Introduction +============ + +This document describes the build system used to build the Fuel +deployment tool for the AArch64 Colorado release of OPNFV, required +dependencies and minimum requirements on the host to be used for the +build system. + +The Fuel build system is designed around Docker containers such that +dependencies outside of the build system can be kept to a minimum. It +also shields the host from any potential dangerous operations +performed by the build system. + +The audience of this document is assumed to have good knowledge in +network and Unix/Linux administration. + +Due to early docker and nodejs support on AArch64, we will still use an +x86_64 Fuel Master to build and deploy an AArch64 target pool, as well +as an x86_64 build machine for building the OPNFV ISO. + +============ +Requirements +============ + +Minimum Hardware Requirements +============================= + +- ~50 GB available disc + +- 4 GB RAM + +Minimum Software Requirements +============================= + +The build host should run Ubuntu 14.04 or 16.04 (x86_64) operating system. + +On the host, the following packages must be installed: + +- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed + + - **Note:** Builds on Wily (Ubuntu 15.x) are currently not supported + - A kernel equal- or later than 3.19 (Vivid), simply available through + +.. code-block:: bash + + $ sudo apt-get install linux-generic-lts-vivid + +- docker - see https://docs.docker.com/installation/ubuntulinux/ for + installation notes for Ubuntu 14.04. Note: use the latest version from + Docker (docker-engine) and not the one in Ubuntu 14.04. + +- git + +- make + +- curl + +Apart from docker, all other package requirements listed above are +simply available through: + +.. code-block:: bash + + $ sudo apt-get install git make curl + + +============ +Preparations +============ + +Setting up the Docker build container +===================================== + +After having installed Docker, add yourself to the docker group: + +.. code-block:: bash + + $ sudo usermod -a -G docker [userid] + +Also make sure to define relevant DNS servers part of the global +DNS chain in your configuration file. +Uncomment, and modify the values appropriately. + +For example: + +.. code-block:: bash + + DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" + +Then restart docker: + +.. code-block:: bash + + $ sudo service docker restart + +Setting up OPNFV Gerrit in order to being able to clone the code +---------------------------------------------------------------- + +- Start setting up OPNFV gerrit by creating a SSH key (unless you + don't already have one), create one with ssh-keygen + +- Add your generated public key in OPNFV Gerrit (https://gerrit.opnfv.org/) + (this requires a Linux foundation account, create one if you do not + already have one) + +- Select "SSH Public Keys" to the left and then "Add Key" and paste + your public key in. + +Clone the armband@OPNFV code Git repository with your SSH key +------------------------------------------------------------- + +Now it is time to clone the code repository: + +.. code-block:: bash + + $ git clone ssh://@gerrit.opnfv.org:29418/armband + +Now you should have the OPNFV armband repository with its +directories stored locally on your build host. + +Check out the Colorado release: + +.. code-block:: bash + + $ cd armband + $ git checkout colorado.3.0.1 + +Clone the armband@OPNFV code Git repository without a SSH key +------------------------------------------------------------- + +You can also opt to clone the code repository without a SSH key: + +.. code-block:: bash + + $ git clone https://gerrit.opnfv.org/gerrit/armband + +Make sure to checkout the release tag as described above. + +Support for building behind a http/https/rsync proxy +==================================================== + +The build system is able to make use of a web proxy setup if the +http_proxy, https_proxy, no_proxy (if needed) and RSYNC_PROXY or +RSYNC_CONNECT_PROG environment variables have been set before invoking make. + +The proxy setup must permit port 80 (http) and 443 (https). +Rsync protocol is currently not used during build process. + +Important note about the host Docker daemon settings +---------------------------------------------------- + +The Docker daemon on the host must be configured to use the http proxy +for it to be able to pull the base Ubuntu 14.04 image from the Docker +registry before invoking make! In Ubuntu this is done by adding a line +like: + +.. code-block:: bash + + export http_proxy="http://10.0.0.1:8888/" + +to and restarting the Docker daemon. + +Setting proxy environment variables prior to build +-------------------------------------------------- + +The build system will make use the following environment variables +that needs to be exported to subshells by using export (bash) or +setenv (csh/tcsh). + +.. code-block:: bash + + http_proxy (or HTTP_PROXY) + https_proxy (or HTTP_PROXY) + no_proxy (or NO_PROXY) + RSYNC_PROXY + RSYNC_CONNECT_PROG + +As an example, these are the settings that were put in the user's +.bashrc when verifying the proxy build functionality: + +.. code-block:: bash + + export RSYNC_PROXY=10.0.0.1:8888 + export http_proxy=http://10.0.0.1:8888 + export https_proxy=http://10.0.0.1:8888 + export no_proxy=localhost,127.0.0.1,.consultron.com,.sock + +Using a ssh proxy for the rsync connection +------------------------------------------ + +If the proxy setup is not allowing the rsync protocol, an alternative +solution is to use a SSH tunnel to a machine capable of accessing the +outbound port 873. Set the RSYNC_CONNECT_PROG according to the rsync +manual page (for example to "ssh @ nc %H 873") +to enable this. Also note that netcat needs to be installed on the +remote system! + +Make sure that the ssh command also refers to the user on the remote +system, as the command itself will be run from the Docker build container +as the root user (but with the invoking user's SSH keys). + + +Note! Armband build system uses git submodules to track fuel and +other upstream repos, so in order to apply the above change, one +should first initialize the submodules and apply armband patches +(only needed once): + +.. code-block:: bash + + $ make patches-import + + +Configure your build environment +================================ + +** Configuring the build environment should not be performed if building +standard Colorado release ** + +Select the versions of the components you want to build by editing the + and + files. + +Note! The same observation as above, before altering Makefile, run: + +.. code-block:: bash + + $ make patches-import + + +Non official build: Selecting which plugins to build +==================================================== + +In order to cut the build time for unofficial builds (made by an +individual developer locally), the selection if which Fuel plugins to +build (if any) can be done by environment variable +"BUILD_FUEL_PLUGINS" prior to building. + +Only the plugin targets from that +are specified in the environment variable will then be built. In order +to completely disable the building of plugins, the environment variable +is set to " ". When using this functionality, the resulting iso file +will be prepended with the prefix "unofficial-" to clearly indicate +that this is not a full build. + +This method of plugin selection is not meant to be used from within +Gerrit! + +Note! So far, only ODL, OVS, BGPVPN and Tacker plugins were ported to AArch64. + +======== +Building +======== + +There are two methods available for building Fuel: + +- A low level method using Make + +- An abstracted method using build.sh + +Low level build method using make +================================= + +The low level method is based on Make: + +From the directory, invoke + +Following targets exist: + +- release - this will do the same as: + + - make submodules-clean patches-import build + +- none/all/build - this will: + + - Initialize the docker build environment + + - Build Fuel from upstream (as defined by fuel-build/config-spec) + + - Build the OPNFV defined plugins/features from upstream + + - Build the defined additions to fuel (as defined by the structure + of this framework) + + - Apply changes and patches to fuel (as defined by the structure of + this framework) + + - Reconstruct a fuel .iso image + +- clean - this will remove all artifacts from earlier builds. + +- debug - this will simply enter the build container without starting a build, from here you can start a build by enter "make iso" + +If the build is successful, you will find the generated ISO file in +the subdirectory! + +Abstracted build method using build.sh +====================================== + +The abstracted build method uses the script which +allows you to: + +- Create and use a build cache - significantly speeding up the + build time if upstream repositories have not changed. + +- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) + +For more info type . + +========= +Artifacts +========= + +The artifacts produced are: + +- - Which represents the bootable Fuel for AArch64 image, + XXXX is replaced with the build identity provided to the build system + +- - Which holds version metadata. + +========== +References +========== + +1) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html + +2) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html + +3) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html diff --git a/docs/development/buildprocedure/index.rst b/docs/development/buildprocedure/index.rst new file mode 100644 index 00000000..49f64c31 --- /dev/null +++ b/docs/development/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 on AArch64 +******************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + build.instruction.rst + diff --git a/docs/installationprocedure/img/addnodes.png b/docs/installationprocedure/img/addnodes.png deleted file mode 100644 index b6240569..00000000 Binary files a/docs/installationprocedure/img/addnodes.png and /dev/null differ diff --git a/docs/installationprocedure/img/compute.png b/docs/installationprocedure/img/compute.png deleted file mode 100644 index fc1cf0f2..00000000 Binary files a/docs/installationprocedure/img/compute.png and /dev/null differ diff --git a/docs/installationprocedure/img/computelist.png b/docs/installationprocedure/img/computelist.png deleted file mode 100644 index 47419653..00000000 Binary files a/docs/installationprocedure/img/computelist.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelconsole1.png b/docs/installationprocedure/img/fuelconsole1.png deleted file mode 100644 index 61703cab..00000000 Binary files a/docs/installationprocedure/img/fuelconsole1.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu1.png b/docs/installationprocedure/img/fuelmenu1.png deleted file mode 100644 index ee7a0edb..00000000 Binary files a/docs/installationprocedure/img/fuelmenu1.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu2.png b/docs/installationprocedure/img/fuelmenu2.png deleted file mode 100644 index 4dcbb6e6..00000000 Binary files a/docs/installationprocedure/img/fuelmenu2.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu2a.png b/docs/installationprocedure/img/fuelmenu2a.png deleted file mode 100644 index 396c1237..00000000 Binary files a/docs/installationprocedure/img/fuelmenu2a.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu3.png b/docs/installationprocedure/img/fuelmenu3.png deleted file mode 100644 index 23e61975..00000000 Binary files a/docs/installationprocedure/img/fuelmenu3.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu4.png b/docs/installationprocedure/img/fuelmenu4.png deleted file mode 100644 index 3be29cd6..00000000 Binary files a/docs/installationprocedure/img/fuelmenu4.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu5.png b/docs/installationprocedure/img/fuelmenu5.png deleted file mode 100644 index e3d21545..00000000 Binary files a/docs/installationprocedure/img/fuelmenu5.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelmenu6.png b/docs/installationprocedure/img/fuelmenu6.png deleted file mode 100644 index cafbcddf..00000000 Binary files a/docs/installationprocedure/img/fuelmenu6.png and /dev/null differ diff --git a/docs/installationprocedure/img/fuelwsrepsst.png b/docs/installationprocedure/img/fuelwsrepsst.png deleted file mode 100644 index 90ded440..00000000 Binary files a/docs/installationprocedure/img/fuelwsrepsst.png and /dev/null differ diff --git a/docs/installationprocedure/img/grub-1.png b/docs/installationprocedure/img/grub-1.png deleted file mode 100644 index e64b7937..00000000 Binary files a/docs/installationprocedure/img/grub-1.png and /dev/null differ diff --git a/docs/installationprocedure/img/health.png b/docs/installationprocedure/img/health.png deleted file mode 100644 index 57bd8cf7..00000000 Binary files a/docs/installationprocedure/img/health.png and /dev/null differ diff --git a/docs/installationprocedure/img/interfaceconf.png b/docs/installationprocedure/img/interfaceconf.png deleted file mode 100644 index e00b03f0..00000000 Binary files a/docs/installationprocedure/img/interfaceconf.png and /dev/null differ diff --git a/docs/installationprocedure/img/interfaces.png b/docs/installationprocedure/img/interfaces.png deleted file mode 100644 index 291e434f..00000000 Binary files a/docs/installationprocedure/img/interfaces.png and /dev/null differ diff --git a/docs/installationprocedure/img/network.png b/docs/installationprocedure/img/network.png deleted file mode 100644 index 7bef0506..00000000 Binary files a/docs/installationprocedure/img/network.png and /dev/null differ diff --git a/docs/installationprocedure/img/neutronl3.png b/docs/installationprocedure/img/neutronl3.png deleted file mode 100644 index 36291ef8..00000000 Binary files a/docs/installationprocedure/img/neutronl3.png and /dev/null differ diff --git a/docs/installationprocedure/img/newenv.png b/docs/installationprocedure/img/newenv.png deleted file mode 100644 index d6bc2827..00000000 Binary files a/docs/installationprocedure/img/newenv.png and /dev/null differ diff --git a/docs/installationprocedure/img/nodes.png b/docs/installationprocedure/img/nodes.png deleted file mode 100644 index 771e4813..00000000 Binary files a/docs/installationprocedure/img/nodes.png and /dev/null differ diff --git a/docs/installationprocedure/img/offloadingmodes.png b/docs/installationprocedure/img/offloadingmodes.png deleted file mode 100644 index 5b3cb17b..00000000 Binary files a/docs/installationprocedure/img/offloadingmodes.png and /dev/null differ diff --git a/docs/installationprocedure/img/other.png b/docs/installationprocedure/img/other.png deleted file mode 100644 index c088488d..00000000 Binary files a/docs/installationprocedure/img/other.png and /dev/null differ diff --git a/docs/installationprocedure/img/plugin_install.png b/docs/installationprocedure/img/plugin_install.png deleted file mode 100644 index ff50633e..00000000 Binary files a/docs/installationprocedure/img/plugin_install.png and /dev/null differ diff --git a/docs/installationprocedure/img/plugins.png b/docs/installationprocedure/img/plugins.png deleted file mode 100644 index 8f7ea596..00000000 Binary files a/docs/installationprocedure/img/plugins.png and /dev/null differ diff --git a/docs/installationprocedure/img/plugins_aarch64.png b/docs/installationprocedure/img/plugins_aarch64.png deleted file mode 100644 index 8bd58d12..00000000 Binary files a/docs/installationprocedure/img/plugins_aarch64.png and /dev/null differ diff --git a/docs/installationprocedure/img/verifynet.png b/docs/installationprocedure/img/verifynet.png deleted file mode 100644 index e675562c..00000000 Binary files a/docs/installationprocedure/img/verifynet.png and /dev/null differ diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index ed4db110..00000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,15 +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 . - -*************************************************** -Installation instruction for Fuel\@OPNFV on AArch64 -*************************************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - installation.instruction.rst diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst deleted file mode 100644 index ec55d3eb..00000000 --- a/docs/installationprocedure/installation.instruction.rst +++ /dev/null @@ -1,732 +0,0 @@ -.. This document is protected/licensed under the following conditions -.. (c) Jonas Bjurel (Ericsson AB) -.. Licensed under a Creative Commons Attribution 4.0 International License. -.. You should have received a copy of the license along with this work. -.. If not, see . - -======== -Abstract -======== - -This document describes how to install the Colorado release of -OPNFV when using Fuel as a deployment tool, with an AArch64 (only) -target node pool. It covers its usage, limitations, dependencies -and required system resources. - -============ -Introduction -============ - -This document provides guidelines on how to install and -configure the Colorado release of OPNFV when using Fuel as a -deployment tool, with an AArch64 (only) target node pool, -including required software and hardware configurations. - -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 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 Armband Fuel .iso from source by cloning -the opnfv/armband git repository. To retrieve the repository for the AArch64 -Colorado release use the following command: - -.. 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.3.0.1 - -Go to the armband directory and build the .iso: - -.. code-block:: bash - - $ cd armband; make all - -For more information on how to build, please see *Reference: 14* - -Other preparations -================== - -Next, familiarize yourself with Fuel by reading the following documents: - -- Fuel Installation Guide, please see *Reference: 8* - -- Fuel QuickStart, please see *Reference: 9* - -- Fuel Developer 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, etc.). - -#. 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 using Fuel: - -+--------------------+------------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+====================+======================================================+ -| **AArch64 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 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 Armband 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 the Fuel setup screen is shown (Note: This can take up to 30 minutes). - -#. In the "Fuel User" section - Confirm/change the default password (See figure below) - - - 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 in your corporate/lab network (see figure below). - -- **NOTE**: Configuration of ETH1 interface for connectivity into your corporate/lab - network is optional - - .. 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 - - - The installation will now start, wait until the login screen is shown. - -Boot the Node Servers -===================== - -After the Fuel Master node has rebooted from the above steps and is at -the login prompt, you should boot the Node Servers (Your -Compute/Control/Storage blades, nested or real) with a PXE booting -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. - - .. figure:: img/plugin_install.png - - **NOTE**: AArch64 Colorado 1.0 ships only with ODL, OVS, BGPVPN and Tacker - plugins, see *Reference 15*. - -Create an OpenStack Environment -=============================== - -#. 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 and Aodh" 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 - Set Local Mirror Repos -================================= - -The following steps must be executed if you are in an environment with -no connection to the Internet. The Fuel server delivers a local repo -that can be used for installation / deployment of openstack. - -#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane. - - - Replace the URI values for the "Name" values outlined below: - - - "ubuntu" URI="deb http://:8080/mirrors/ubuntu/ trusty main" - - - "mos" URI="deb http://::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted" - - - "Auxiliary" URI="deb http://:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted" - - - Click at the bottom to Save your changes - -Target specific configuration -============================= - -#. [AArch64 specific] Configure MySQL WSREP SST provider - - **NOTE**: This option is only available for ArmbandFuel@OPNFV, since it - currently only affects AArch64 targets (see *Reference 15*). - - When using some AArch64 platforms as controller nodes, WSREP SST - synchronisation using default backend provider (xtrabackup-v2) used to fail, - so a mechanism that allows selecting a different WSREP SST provider - has been introduced. - - In the FUEL UI of your Environment, click the tab, click - on the left side pane (see figure below), then - select one of the following options: - - - xtrabackup-v2 (default provider, AArch64 stability issues); - - - rsync (AArch64 validated, better or comparable speed to xtrabackup, - takes the donor node offline during state transfer); - - - mysqldump (untested); - - .. figure:: img/fuelwsrepsst.png - -#. Set up targets for provisioning with non-default "Offloading Modes" - - Some target nodes may require additional configuration after they are - 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 -======================= - -#. 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 + + - Check *Reference 15* for known issues / limitations on AArch64 + + .. 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 QuickStart Guide `_: https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html + +10) `Fuel Developer Guide `_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html + +11) `Fuel Plugin Developers Guide `_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html + +12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List `_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list + +Fuel in OPNFV +============= + +13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html + +14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html + +15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 00000000..91fedf23 --- /dev/null +++ b/docs/release/release-notes/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 on AArch64 +**************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + release-notes.rst + diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 00000000..b4e8bc81 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,263 @@ +.. 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 3.0 release of +OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target +node pool. + +=============== +Important notes +=============== + +These notes provides release information for the use of Fuel as deployment +tool for the AArch64 Colorado 3.0 release of OPNFV. + +The goal of the AArch64 Colorado release and this Fuel-based deployment process +is to establish a lab ready platform accelerating further development +of the OPNFV on AArch64 infrastructure. + +Due to early docker and nodejs support on AArch64, we will still use an +x86_64 Fuel Master to build and deploy an AArch64 target pool. + +Although not currently supported, mixing x86_64 and AArch64 architectures +inside the target pool will be possible later. + +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 "Boron" [1]_ - 'http://www.opendaylight.org/software' + +- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' + +- `BGPVPN `_ 'http://docs.openstack.org/developer/networking-bgpvpn/' + +- Tacker `_ 'https://wiki.openstack.org/wiki/Tacker' + +The following OPNFV plugins are not yet ported for AArch64: + +- `ONOS `_ version "Drake" - 'http://onosproject.org/' + +- `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' + +- `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 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** | armband | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | colorado.3.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Colorado 3.0 follow-up release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | December 05 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Colorado alignment to Released | +| | Fuel 9.0 baseline + Bug-fixes for | +| | the following feaures/scenarios: | +| | - Open vSwitch for NFV | +| | - OpenDaylight | +| | - Tacker | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +============== + +Module version changes +---------------------- +This is the Colorado 3.0 follow-up release. +It is based on following upstream versions: + +- Fuel 9.0 Base release + +- OpenStack Mitaka release + +- OpenDaylight Boron release [1]_ + + +Document changes +---------------- +This is the Colorado 3.0 follow-up release. +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=11404' + +(Also See respective Integrated feature project's bug tracking) + +Deliverables +============ + +Software deliverables +--------------------- + +AArch64 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 + +- **Fuel master arch:** x86_64 + +- **Target node arch:** aarch64 + +Known issues +============ + +**JIRA TICKETS:** + +`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11405' + +(Also See respective Integrated feature project's bug tracking) + +Workarounds +=========== + +**JIRA TICKETS:** + +- + +(Also See respective Integrated feature project's bug tracking) + +============ +Test results +============ +The Colorado 3.0 release with the Fuel deployment tool has undergone QA test +runs, see separate test results. + +========== +References +========== +For more information on the OPNFV Colorado 3.0 release, please see: + +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 AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html' + +14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html' + +15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html' + +.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst deleted file mode 100644 index 91fedf23..00000000 --- a/docs/releasenotes/index.rst +++ /dev/null @@ -1,16 +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 . - -**************************************** -Release notes for Fuel\@OPNFV on AArch64 -**************************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - release-notes.rst - diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst deleted file mode 100644 index b4e8bc81..00000000 --- a/docs/releasenotes/release-notes.rst +++ /dev/null @@ -1,263 +0,0 @@ -.. This document is protected/licensed under the following conditions -.. (c) Jonas Bjurel (Ericsson AB) -.. Licensed under a Creative Commons Attribution 4.0 International License. -.. You should have received a copy of the license along with this work. -.. If not, see . - -======== -Abstract -======== - -This document compiles the release notes for the Colorado 3.0 release of -OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target -node pool. - -=============== -Important notes -=============== - -These notes provides release information for the use of Fuel as deployment -tool for the AArch64 Colorado 3.0 release of OPNFV. - -The goal of the AArch64 Colorado release and this Fuel-based deployment process -is to establish a lab ready platform accelerating further development -of the OPNFV on AArch64 infrastructure. - -Due to early docker and nodejs support on AArch64, we will still use an -x86_64 Fuel Master to build and deploy an AArch64 target pool. - -Although not currently supported, mixing x86_64 and AArch64 architectures -inside the target pool will be possible later. - -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 "Boron" [1]_ - 'http://www.opendaylight.org/software' - -- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' - -- `BGPVPN `_ 'http://docs.openstack.org/developer/networking-bgpvpn/' - -- Tacker `_ 'https://wiki.openstack.org/wiki/Tacker' - -The following OPNFV plugins are not yet ported for AArch64: - -- `ONOS `_ version "Drake" - 'http://onosproject.org/' - -- `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' - -- `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 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** | armband | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | colorado.3.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 3.0 follow-up release | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | December 05 2016 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado alignment to Released | -| | Fuel 9.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | -| | - Open vSwitch for NFV | -| | - OpenDaylight | -| | - Tacker | -| | | -+--------------------------------------+--------------------------------------+ - -Version change -============== - -Module version changes ----------------------- -This is the Colorado 3.0 follow-up release. -It is based on following upstream versions: - -- Fuel 9.0 Base release - -- OpenStack Mitaka release - -- OpenDaylight Boron release [1]_ - - -Document changes ----------------- -This is the Colorado 3.0 follow-up release. -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=11404' - -(Also See respective Integrated feature project's bug tracking) - -Deliverables -============ - -Software deliverables ---------------------- - -AArch64 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 - -- **Fuel master arch:** x86_64 - -- **Target node arch:** aarch64 - -Known issues -============ - -**JIRA TICKETS:** - -`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11405' - -(Also See respective Integrated feature project's bug tracking) - -Workarounds -=========== - -**JIRA TICKETS:** - -- - -(Also See respective Integrated feature project's bug tracking) - -============ -Test results -============ -The Colorado 3.0 release with the Fuel deployment tool has undergone QA test -runs, see separate test results. - -========== -References -========== -For more information on the OPNFV Colorado 3.0 release, please see: - -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 AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html' - -14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html' - -15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html' - -.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. -- cgit 1.2.3-korg