Updated armband
[armband.git] / docs / installation-instruction.rst
index 287e568..356f411 100644 (file)
@@ -1,5 +1,5 @@
 ====================================================================================================================
-OPNFV Installation instruction for the AArch64 Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool
+OPNFV Installation instruction for the AArch64 Colorado 1.0 release of OPNFV when using Fuel as a deployment tool
 ====================================================================================================================
 
 License
@@ -12,7 +12,7 @@ License. .. http://creativecommons.org/licenses/by/4.0 ..
 Abstract
 ========
 
-This document describes how to install the Brahmaputra 3.0 release of
+This document describes how to install the Colorado 1.0 release of
 OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
 node pool.
 
@@ -20,7 +20,7 @@ Introduction
 ============
 
 This document provides guidelines on how to install and
-configure the Brahmaputra 3.0 release of OPNFV when using Fuel as a
+configure the Colorado 1.0 release of OPNFV when using Fuel as a
 deployment tool, with an AArch64 (only) target node pool,
 including required software and hardware configurations.
 
@@ -28,7 +28,7 @@ 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 Brahmaputra compliant
+step-by-step guide that results in an OPNFV Colorado compliant
 deployment.
 
 The audience of this document is assumed to have good knowledge in
@@ -36,7 +36,7 @@ networking and Unix/Linux administration.
 
 Preface
 =======
-Before starting the installation of the AArch64 Brahmaputra 3.0 release of
+Before starting the installation of the AArch64 Colorado 1.0 release of
 OPNFV, using Fuel as a deployment tool, some planning must be
 done.
 
@@ -44,7 +44,7 @@ Retrieving the ISO image
 ------------------------
 
 First of all, the Fuel deployment ISO image needs to be retrieved, the
-ArmbandFuel .iso image of the AArch64 Brahmaputra release can be found
+ArmbandFuel .iso image of the AArch64 Colorado release can be found
 at *Reference: 2*
 
 Building the ISO image
@@ -52,18 +52,18 @@ Building the ISO image
 
 Alternatively, you may build the ArmbandFuel .iso from source by cloning the
 opnfv/armband git repository. To retrieve the repository for the AArch64
-Brahmaputra 3.0 release use the following command:
+Colorado 1.0 release use the following command:
 
 .. code-block:: bash
 
     $ git clone https://gerrit.opnfv.org/gerrit/armband
 
-Check-out the Brahmaputra release tag to set the branch to the
-baseline required to replicate the Brahmaputra release:
+Check-out the Colorado release tag to set the HEAD to the
+baseline required to replicate the Colorado release:
 
 .. code-block:: bash
 
-    $ git checkout brahmaputra.3.0
+    $ git checkout colorado.1.0
 
 Go to the armband directory and build the .iso:
 
@@ -113,7 +113,7 @@ Hardware requirements
 =====================
 
 The following minimum hardware requirements must be met for the
-installation of AArch64 Brahmaputra 3.0 using Fuel:
+installation of AArch64 Colorado 1.0 using Fuel:
 
 +--------------------+------------------------------------------------------+
 | **HW Aspect**      | **Requirement**                                      |
@@ -136,6 +136,8 @@ installation of AArch64 Brahmaputra 3.0 using Fuel:
 | **Disk**           | Minimum 256GB 10kRPM spinning disks                  |
 |                    |                                                      |
 +--------------------+------------------------------------------------------+
+| **Firmware**       | UEFI compatible (e.g. EDK2) with PXE support         |
++--------------------+------------------------------------------------------+
 | **Networks**       | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE)      |
 |                    |                                                      |
 |                    | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network        |
@@ -184,9 +186,9 @@ the Fuel OPNFV reference platform. All the networks involved in the OPNFV
 infrastructure as well as the provider networks and the private tenant
 VLANs needs to be manually configured.
 
-Manual configuration of the Brahmaputra hardware platform should
+Manual configuration of the Colorado hardware platform should
 be carried out according to the OPNFV Pharos specification:
-<https://wiki.opnfv.org/pharos/pharos_specification>
+<https://wiki.opnfv.org/display/pharos/Pharos+Specification>
 
 OPNFV Software installation and deployment
 ==========================================
@@ -197,7 +199,7 @@ reference platform stack across a server cluster.
 
 Install Fuel master
 -------------------
-#. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
+#. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server.
 
 #. Reboot the jump host to establish the Fuel server.
 
@@ -223,7 +225,7 @@ Install Fuel master
 
 #. In the "Network Setup" section - Configure DHCP/Static IP information for your FUEL node - For example, ETH0 is 10.20.0.2/24 for FUEL booting and ETH1 is DHCP/Static in your corporate/lab network (see figure below).
 
-   - **Note**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
+   - **NOTE**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
      image building, due to missing arm64 (AArch64) packages in the partial
      local Ubuntu mirror (consequence of ports.ubuntu.com mirror architecture).
 
@@ -260,12 +262,14 @@ Install Fuel master
 
    .. figure:: img/fuelmenu4.png
 
+#. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below).
 
-#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section (see figure below), edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support)
-
-   - 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
 
@@ -281,7 +285,7 @@ Install Fuel master
 
 #. Start the installation.
 
-   - Select Quit Setup and press Save and Quit.
+   - Press <F8> or select Quit Setup and press Save and Quit.
 
    - Installation starts, wait until the login screen is shown.
 
@@ -294,9 +298,15 @@ 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 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.
 
@@ -309,25 +319,6 @@ scheme so that the FUEL Master can pick them up for control.
    .. figure:: img/nodes.png
 
 
-Target specific configuration
------------------------------
-
-#. AMD Softiron
-
-   For these targets, "rx-vlan-filter" offloading has to be turned off on the interface destined for OpenStack traffic (not the interface used for PXE boot).
-   For now this setting cannot be toggled from Fuel GUI, so it has to be done form the console.
-
-   - From Fuel master console identify target nodes admin IPs (see figure below).
-
-     .. figure:: img/fuelconsole1.png
-
-   - SSH into each of the target nodes and disable rx-vlan-filter on the physical interface allocated for OpenStack traffic  (see figure below).
-
-     .. figure:: img/softiron1.png
-
-   - Repeat the step above for all AMD Softiron nodes in the POD.
-
-
 Install additional Plugins/Features on the FUEL node
 ----------------------------------------------------
 
@@ -347,7 +338,7 @@ Install additional Plugins/Features on the FUEL node
 
         Plugin ....... was successfully installed.
 
-    **NOTE**: AArch64 Brahmaputra 3.0 ships only with Opendaylight plugin,
+    **NOTE**: Not all plugins are ported to AArch64 Colorado 1.0
     see *Reference 15*.
 
    .. figure:: img/plugin_install.png
@@ -361,7 +352,7 @@ Create an OpenStack Environment
 
    .. figure:: img/newenv.png
 
-#. Select "<Liberty on Ubuntu 14.04 (aarch64)>" and press <Next>
+#. Select "<Mitaka on Ubuntu 14.04 (aarch64)>" and press <Next>
 
 #. Select "compute virtulization method".
 
@@ -506,7 +497,7 @@ Enable Plugins
 
    - 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
 ---------------------------------------------------------
@@ -556,11 +547,10 @@ Allocate nodes to environment and assign functional roles
 
     .. figure:: img/interfaceconf.png
 
-
 OPTIONAL - UNTESTED - Set Local Mirror Repos
 ---------------------------------
 
-**NOTE**: AArch64 Brahmaputra 3.0 does not fully support local Ubuntu mirrors,
+**NOTE**: AArch64 Colorado 1.0 does not fully support local Ubuntu mirrors,
 or at least does not ship with arm64 packages in local repos by default.
 In order to use local (partial) Ubuntu mirrors, one should add arm64 packages
 by hand to the existing amd64 mirrors and re-generate repo metadata.
@@ -583,12 +573,84 @@ that can be used for installation / deployment of openstack.
 
    - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
 
-   - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
+   - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-8.0/ubuntu/x86_64 mos8.0 main restricted"
 
-   - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
+   - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-8.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) might fail,
+   so a mechanism that allows selecting a different WSREP SST provider
+   has been introduced.
+
+   In the FUEL UI of your Environment, click the <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
+   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
 ---------------
 
@@ -648,7 +710,7 @@ OPNFV
 OpenStack
 ---------
 
-3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
 
 4) `OpenStack documentation <http://docs.openstack.org>`_
 
@@ -661,13 +723,13 @@ Fuel
 ----
 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
 
-7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
+7) `Fuel documentation overview <https://docs.mirantis.com/openstack/fuel/fuel-9.0>`_
 
-8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
+8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
 
-9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
 
-10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
+10) `Fuel user guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
 
 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
 
@@ -676,8 +738,8 @@ Fuel
 Fuel in OPNFV
 -------------
 
-13) `OPNFV Installation instruction for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/installation-instruction.html>`_
+13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/installation-instruction.html>`_
 
-14) `OPNFV Build instruction for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/build-instruction.html>`_
+14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/build-instruction.html>`_
 
-15) `OPNFV Release Note for the AArch64 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/brahmaputra/docs/release-notes.html>`_
+15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release-notes.html>`_