========
This document describes how to build the Fuel deployment tool for the
-Danube release of OPNFV build system, dependencies and required
+AArch64 Danube release of OPNFV build system, dependencies and required
system resources.
============
============
This document describes the build system used to build the Fuel
-deployment tool for the Danube release of OPNFV, required
+deployment tool for the AArch64 Danube release of OPNFV, required
dependencies and minimum requirements on the host to be used for 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
=============================
-- ~30 GB available disc
+- ~50 GB available disc
- 4 GB RAM
Minimum Software Requirements
=============================
-The build host should run Ubuntu 14.04 or 16.04 operating system.
+The build host should run Ubuntu 14.04 or 16.04 (x86_64) operating system.
On the host, the following packages must be installed:
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)
+- git
+
+- make
+
+- curl
+
+Apart from docker, all other package requirements listed above are
+simply available through:
+
+.. code-block:: bash
-- make (simply available through $ sudo apt-get install make)
+ $ sudo apt-get install git make curl
-- curl (simply available through $ sudo apt-get install curl)
============
Preparations
- Start setting up OPNFV gerrit by creating a SSH key (unless you
don't already have one), create one with ssh-keygen
-- Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
+- Add your generated public key in OPNFV Gerrit (https://gerrit.opnfv.org/)
(this requires a Linux foundation account, create one if you do not
already have one)
- Select "SSH Public Keys" to the left and then "Add Key" and paste
your public key in.
-Clone the OPNFV code Git repository with your SSH key
------------------------------------------------------
+Clone the armband@OPNFV code Git repository with your SSH key
+-------------------------------------------------------------
Now it is time to clone the code repository:
$ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
-Now you should have the OPNFV fuel repository with the Fuel
+Now you should have the OPNFV armband repository with its
directories stored locally on your build host.
Check out the Danube release:
.. code-block:: bash
- $ cd fuel
+ $ cd armband
$ git checkout danube.1.0
-Clone the OPNFV code Git repository without a SSH key
------------------------------------------------------
+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/fuel
+ $ git clone https://gerrit.opnfv.org/gerrit/armband
Make sure to checkout the release tag as described above.
export http_proxy="http://10.0.0.1:8888/"
-to /etc/default/docker and restarting the Docker daemon.
+to </etc/default/docker> and restarting the Docker daemon.
Setting proxy environment variables prior to build
--------------------------------------------------
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
================================
standard Danube release **
Select the versions of the components you want to build by editing the
-fuel/build/config.mk file.
+<armband/upstream/fuel/build/config.mk> and
+<armband/upstream/fuel/build/armband.mk> 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
====================================================
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
+Only the plugin targets from <armband/upstream/fuel/build/armband.mk> 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
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
========
The low level method is based on Make:
-From the <fuel/build> directory, invoke <make [target]>
+From the <armband> directory, invoke <make [target]>
Following targets exist:
-- none/all - this will:
+- release - this will do the same as:
+
+ - make submodules-clean patches-import build
+
+- none/all/build - this will:
- Initialize the docker build environment
- 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 <fuel/build/release> subdirectory!
+the <armband/upstream/fuel/build/release> subdirectory!
Abstracted build method using build.sh
======================================
- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:)
-For more info type <fuel/ci/build.sh -h>.
+For more info type <armband/ci/build.sh -h>.
=========
Artifacts
The artifacts produced are:
-- <OPNFV_XXXX.iso> - Which represents the bootable Fuel image, XXXX is
- replaced with the build identity provided to the build system
+- <OPNFV_XXXX.iso> - Which represents the bootable Fuel for AArch64 image,
+ XXXX is replaced with the build identity provided to the build system
- <OPNFV_XXXX.iso.txt> - Which holds version metadata.
========
This document describes how to install the Danube release of
-OPNFV when using Fuel as a deployment tool, covering its usage,
-limitations, dependencies and required system resources.
+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 Danube release of OPNFV when using Fuel as a
-deployment tool, including required software and hardware configurations.
+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
Preface
=======
-Before starting the installation of the Danube release of
-OPNFV, using Fuel as a deployment tool, some planning must be
+Before starting the installation of the AArch64 Danube release
+of OPNFV, using Fuel as a deployment tool, some planning must be
done.
Retrieving the ISO image
========================
First of all, the Fuel deployment ISO image needs to be retrieved, the
-Fuel .iso image of the Danube release can be found at `OPNFV Downloads <https://www.opnfv.org/software/download>`_.
+ArmbandFuel .iso image of the AArch64 Danube release can be found at `OPNFV Downloads <https://www.opnfv.org/software/download>`_.
Building the ISO image
======================
-Alternatively, you may build the Fuel .iso from source by cloning the
-opnfv/fuel git repository. To retrieve the repository for the Danube
-release use the following command:
+Alternatively, you may build the Armband Fuel .iso from source by cloning
+the opnfv/armband git repository. To retrieve the repository for the AArch64
+Danube release use the following command:
.. code-block:: bash
- $ git clone https://gerrit.opnfv.org/gerrit/fuel
+ $ git clone https://gerrit.opnfv.org/gerrit/armband
Check-out the Danube release tag to set the HEAD to the
baseline required to replicate the Danube release:
$ git checkout danube.1.0
-Go to the fuel directory and build the .iso:
+Go to the armband directory and build the .iso:
.. code-block:: bash
- $ cd fuel/build; make all
+ $ cd armband; make all
For more information on how to build, please see :ref:`Build instruction for Fuel\@OPNFV <armband-development-overview-build-label>`
=====================
The following minimum hardware requirements must be met for the
-installation of Danube using Fuel:
-
-+--------------------+------------------------------------------------------+
-| **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 allocated to a single NIC - |
-| | or spread out over multiple NICs as your hardware |
-| | supports. |
-+--------------------+------------------------------------------------------+
+installation of AArch64 Danube using Fuel:
+
++----------------------------+------------------------------------------------------+
+| **HW Aspect** | **Requirement** |
+| | |
++============================+======================================================+
+| **# of 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) |
+| | |
++----------------------------+------------------------------------------------------+
+| **Firmware** | UEFI compatible (e.g. EDK2) with PXE support |
++----------------------------+------------------------------------------------------+
+| **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 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
Install Fuel master
===================
-#. Mount the Danube Fuel ISO file/media as a boot device to the jump host server.
+#. Mount the Danube Armband Fuel ISO file/media as a boot device to the jump host server.
#. Reboot the jump host to establish the Fuel server.
.. figure:: img/fuelmenu2.png
+ .. figure:: img/fuelmenu2a.png
+
#. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
- DHCP Pool Start 10.20.0.4
.. figure:: img/fuelmenu4.png
-#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section (see figure below), edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support)
+#. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below).
- - Navigate to "HTTP proxy" and enter your http proxy address
+ 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.
- - Select <Check> and press [Enter]
+ **NOTE:** Cannot be used in tandem with local repository support.
.. figure:: img/fuelmenu5.png
#. Start the installation.
- - Select Quit Setup and press Save and Quit.
+ - Press <F8>
- The installation will now start, wait until the login screen is shown.
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 BIOS boot order menu, and hard disk as the second boot device in the same menu.
+ - For every controller and compute server: enable PXE Booting as the first boot device in the UEFI (EDK2) boot order menu, and hard disk as the second boot device in the same menu.
#. Reboot all the control and compute blades.
.. 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
===============================
.. figure:: img/newenv.png
-#. Select "<Mitaka on Ubuntu 14.04>" and press <Next>
+#. Select "<Mitaka on Ubuntu 14.04 (aarch64)>" and press <Next>
#. Select "compute virtulization method".
- Select "Neutron with ML2 plugin"
- - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
+ - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
- Press <Next>
- Enable and configure the plugins of your choice
- .. figure:: img/plugins.png
+ .. figure:: img/plugins_aarch64.png
Allocate nodes to environment and assign functional roles
=========================================================
- Click on the <+Add Nodes> button
- - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the "Assign Roles" Section.
+ - Check <Controller>, <Telemetry - MongoDB> 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
.. 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://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
+
+ - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted"
+
+ - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted"
+
+ - Click <Save Settings> at the bottom to Save your changes
Target specific configuration
=============================
+#. [AArch64 specific] Configure MySQL WSREP SST provider
+
+ **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 <Settings> tab, click
+ <OpenStack Services> 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
- Allow tests to run and investigate results where appropriate
+ - Check *Reference 15* for known issues / limitations on AArch64
+
.. figure:: img/health.png
Release Notes
=============
-Please refer to the :ref:`Release Notes <armband-release-notes-label>` article.
+Please refer to the :ref:`Release Notes <armband-releasenotes>` article.
==========
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 Newton Release Artifacts <http://www.openstack.org/software/newton>`_
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/software/hardware-compatibility/>`_
+12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_
+
+Fuel in OPNFV
+
+13) `OPNFV Installation instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_installation/index.html>`_
+
+14) `OPNFV Build instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/development_overview_build/index.html>`_
+
+15) `OPNFV Release Note for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_release-notes/index.html>`_
========
This document compiles the release notes for the Danube release of
-OPNFV when using Fuel as a deployment tool.
+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 Danube release of OPNFV.
+tool for the AArch64 Danube release of OPNFV.
-The goal of the Danube release and this Fuel-based deployment process is
-to establish a lab ready platform accelerating further development
-of the OPNFV infrastructure.
+The goal of the AArch64 Danube 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 Danube, the typical use of Fuel as an OpenStack installer is
+For AArch64 Danube, the typical use of Fuel as an OpenStack installer is
supplemented with OPNFV unique components such as:
- `OpenDaylight <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:
+
- `Service Function Chaining <https://wiki.opnfv.org/service_function_chaining>`_
- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
-- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
- `Promise <https://wiki.opnfv.org/display/promise>`_
- `Parser <https://wiki.opnfv.org/display/parser>`_
- build-instructions
-- The Danube Fuel installer image (.iso) built by Jenkins
+- The Danube Fuel installer image AArch64 (.iso) built by Jenkins
- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM)
============
+--------------------------------------+--------------------------------------+
-| **Project** | fuel |
+| **Project** | armband |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/tag** | danube.1.0 |
| | Fuel 10.0 baseline + features and |
| | bug-fixes for the following |
| | feaures: |
-| | - NFV Hypervisors-KVM |
| | - Open vSwitch for NFV |
| | - OpenDaylight |
-| | - SDN distributed routing and VPN |
-| | - Service function chaining |
-| | - Promise |
-| | - Parser |
-| | - Doctor |
| | - Tacker |
+--------------------------------------+--------------------------------------+
**JIRA TICKETS:**
-`Danube 1.0 bug fixes <https://jira.opnfv.org/issues/?filter=11406>`_
+`Danube 1.0 bug fixes <https://jira.opnfv.org/issues/?filter=11615>`_
(Also See respective Integrated feature project's bug tracking)
Software Deliverables
---------------------
-Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
+AArch64 Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
Documentation Deliverables
--------------------------
- **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=11407>`_
+`Known issues <https://jira.opnfv.org/issues/?filter=11614>`_
(Also See respective Integrated feature project's bug tracking)
**JIRA TICKETS:**
-`Workarounds <https://jira.opnfv.org/issues/?filter=11408>`_
+-
(Also See respective Integrated feature project's bug tracking)
6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
7) `Fuel Documentation <http://docs.openstack.org/developer/fuel-docs>`_
+Fuel in OPNFV
+=============
+
+13) `OPNFV Installation instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_installation/index.html>`_
+
+14) `OPNFV Build instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/development_overview_build/index.html>`_
+
+15) `OPNFV Release Note for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_release-notes/index.html>`_
+
+.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.
Code Review / armband.git / commitdiff
