1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Open Platform for NFV Project, Inc. and its contributors
9 This document describes how to install the Danube release of
10 OPNFV when using Fuel as a deployment tool, with an AArch64 (only)
11 target node pool. It covers its usage, limitations, dependencies
12 and required system resources.
18 This document provides guidelines on how to install and
19 configure the Danube release of OPNFV when using Fuel as a
20 deployment tool, with an AArch64 (only) target node pool,
21 including required software and hardware configurations.
23 Although the available installation options give a high degree of
24 freedom in how the system is set-up, including architecture, services
25 and features, etc., said permutations may not provide an OPNFV
26 compliant reference architecture. This instruction provides a
27 step-by-step guide that results in an OPNFV Danube compliant
30 The audience of this document is assumed to have good knowledge in
31 networking and Unix/Linux administration.
37 Before starting the installation of the AArch64 Danube release
38 of OPNFV, using Fuel as a deployment tool, some planning must be
41 Retrieving the ISO image
42 ========================
44 First of all, the Fuel deployment ISO image needs to be retrieved, the
45 ArmbandFuel .iso image of the AArch64 Danube release can be found at `OPNFV Downloads <https://www.opnfv.org/software/download>`_.
47 Building the ISO image
48 ======================
50 Alternatively, you may build the Armband Fuel .iso from source by cloning
51 the opnfv/armband git repository. To retrieve the repository for the AArch64
52 Danube release use the following command:
56 $ git clone https://gerrit.opnfv.org/gerrit/armband
58 Check-out the Danube release tag to set the HEAD to the
59 baseline required to replicate the Danube release:
63 $ git checkout danube.2.0
65 Go to the armband directory and build the .iso:
69 $ cd armband; make all
71 For more information on how to build, please see :ref:`Build instruction for Fuel\@OPNFV <armband-development-overview-build-label>`
76 Next, familiarize yourself with Fuel by reading the following documents:
78 - `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
80 - `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
82 - `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
84 - `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
86 Prior to installation, a number of deployment specific parameters must be collected, those are:
88 #. Provider sub-net and gateway information
90 #. Provider VLAN information
92 #. Provider DNS addresses
94 #. Provider NTP addresses
96 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
98 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
100 #. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
102 #. Other options not covered in the document are available in the links above
105 This information will be needed for the configuration procedures
106 provided in this document.
108 =====================
109 Hardware requirements
110 =====================
112 The following minimum hardware requirements must be met for the
113 installation of AArch64 Danube using Fuel:
115 +----------------------------+------------------------------------------------------+
116 | **HW Aspect** | **Requirement** |
118 +============================+======================================================+
119 | **# of AArch64 nodes** | Minimum 5 (3 for non redundant deployment): |
121 | | - 1 Fuel deployment master (may be virtualized) |
123 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
124 | | role, 2 Ceph-OSD roles) |
126 | | - 1 Compute (1 co-located Ceph-OSD role) |
128 +----------------------------+------------------------------------------------------+
129 | **CPU** | Minimum 1 socket AArch64 (ARMv8) with Virtualization |
131 +----------------------------+------------------------------------------------------+
132 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
134 +----------------------------+------------------------------------------------------+
135 | **Firmware** | UEFI compatible (e.g. EDK2) with PXE support |
136 +----------------------------+------------------------------------------------------+
137 | **Disk** | Minimum 256GB 10kRPM spinning disks |
139 +----------------------------+------------------------------------------------------+
140 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
142 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
144 | | Note: These can be allocated to a single NIC - |
145 | | or spread out over multiple NICs as your hardware |
147 +----------------------------+------------------------------------------------------+
148 | **1 x86_64 node** | - 1 Fuel deployment master, x86 (may be virtualized) |
149 +----------------------------+------------------------------------------------------+
151 ===============================
152 Help with Hardware Requirements
153 ===============================
155 Calculate hardware requirements:
157 For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_.
159 When choosing the hardware on which you will deploy your OpenStack
160 environment, you should think about:
162 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
164 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
166 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
168 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
170 ================================================
171 Top of the rack (TOR) Configuration requirements
172 ================================================
174 The switching infrastructure provides connectivity for the OPNFV
175 infrastructure operations, tenant networks (East/West) and provider
176 connectivity (North/South); it also provides needed connectivity for
177 the Storage Area Network (SAN).
178 To avoid traffic congestion, it is strongly suggested that three
179 physically separated networks are used, that is: 1 physical network
180 for administration and control, one physical network for tenant private
181 and public networks, and one physical network for SAN.
182 The switching connectivity can (but does not need to) be fully redundant,
183 in such case it comprises a redundant 10GE switch pair for each of the
184 three physically separated networks.
186 The physical TOR switches are **not** automatically configured from
187 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
188 infrastructure as well as the provider networks and the private tenant
189 VLANs needs to be manually configured.
191 Manual configuration of the Danube hardware platform should
192 be carried out according to the `OPNFV Pharos Specification
193 <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
195 ==========================================
196 OPNFV Software installation and deployment
197 ==========================================
199 This section describes the installation of the OPNFV installation
200 server (Fuel master) as well as the deployment of the full OPNFV
201 reference platform stack across a server cluster.
206 #. Mount the Danube Armband Fuel ISO file/media as a boot device to the jump host server.
208 #. Reboot the jump host to establish the Fuel server.
210 - The system now boots from the ISO image.
212 - Select "Fuel Install (Static IP)" (See figure below)
216 .. figure:: img/grub-1.png
218 #. Wait until the Fuel setup screen is shown (Note: This can take up to 30 minutes).
220 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
222 - Enter "admin" in the Fuel password input
224 - Enter "admin" in the Confirm password input
226 - Select "Check" and press [Enter]
228 .. figure:: img/fuelmenu1.png
230 #. 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).
232 - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
234 .. figure:: img/fuelmenu2.png
236 .. figure:: img/fuelmenu2a.png
238 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
240 - DHCP Pool Start 10.20.0.4
242 - DHCP Pool End 10.20.0.254
244 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
246 .. figure:: img/fuelmenu3.png
248 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
258 - Hostname to test DNS
260 - Select <Check> and press [Enter]
262 .. figure:: img/fuelmenu4.png
265 #. 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)
267 - Navigate to "HTTP proxy" and enter your http proxy address
269 - Select <Check> and press [Enter]
271 .. figure:: img/fuelmenu5.png
273 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
275 - NTP Server 1 <Customer NTP server 1>
277 - NTP Server 2 <Customer NTP server 2>
279 - NTP Server 3 <Customer NTP server 3>
281 .. figure:: img/fuelmenu6.png
283 #. In the "Feature groups" section - Enable "Experimental features" if you plan on using Ceilometer and/or MongoDB.
285 **NOTE**: Ceilometer and MongoDB are experimental features starting with Danube.1.0.
287 #. Start the installation.
289 **NOTE**: Saving each section and hitting <F8> does not apply all settings!
291 - Select Quit Setup and press Save and Quit.
293 - The installation will now start, wait until the login screen is shown.
295 Boot the Node Servers
296 =====================
298 After the Fuel Master node has rebooted from the above steps and is at
299 the login prompt, you should boot the Node Servers (Your
300 Compute/Control/Storage blades, nested or real) with a PXE booting
301 scheme so that the FUEL Master can pick them up for control.
303 **NOTE**: AArch64 target nodes are expected to support PXE booting an
304 EFI binary, i.e. an EFI-stubbed GRUB2 bootloader.
306 **NOTE**: UEFI (EDK2) firmware is **highly** recommended, becoming
307 the **de facto** standard for ARMv8 nodes.
309 #. Enable PXE booting
311 - 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.
313 #. Reboot all the control and compute blades.
315 #. Wait for the availability of nodes showing up in the Fuel GUI.
317 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
319 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
321 .. figure:: img/nodes.png
323 Install additional Plugins/Features on the FUEL node
324 ====================================================
326 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
328 #. Select wanted plugins/features from the /opt/opnfv/ directory.
330 #. Install the wanted plugin with the command
334 $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
336 Expected output (see figure below):
340 Plugin ....... was successfully installed.
342 .. figure:: img/plugin_install.png
344 **NOTE**: AArch64 Danube 2.0 ships only with ODL, OVS, BGPVPN, SFC and Tacker
345 plugins, see *Reference 15*.
347 Create an OpenStack Environment
348 ===============================
350 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin)
352 #. Create and name a new OpenStack environment, to be installed.
354 .. figure:: img/newenv.png
356 #. Select "<Newton on Ubuntu 16.04 (aarch64)>" and press <Next>
358 #. Select "compute virtulization method".
360 - Select "QEMU-KVM as hypervisor" and press <Next>
362 #. Select "network mode".
364 - Select "Neutron with ML2 plugin"
366 - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
370 #. Select "Storage Back-ends".
372 - Select "Ceph for block storage" and press <Next>
374 #. Select "additional services" you wish to install.
376 - Check option "Install Ceilometer and Aodh" and press <Next>
378 #. Create the new environment.
380 - Click <Create> Button
382 Configure the network environment
383 =================================
385 #. Open the environment you previously created.
387 #. Open the networks tab and select the "default" Node Networks group to on the left pane (see figure below).
389 .. figure:: img/network.png
391 #. Update the Public network configuration and change the following fields to appropriate values:
393 - CIDR to <CIDR for Public IP Addresses>
395 - IP Range Start to <Public IP Address start>
397 - IP Range End to <Public IP Address end>
399 - Gateway to <Gateway for Public IP Addresses>
401 - Check <VLAN tagging>.
403 - Set appropriate VLAN id.
405 #. Update the Storage Network Configuration
407 - Set CIDR to appropriate value (default 192.168.1.0/24)
409 - Set IP Range Start to appropriate value (default 192.168.1.1)
411 - Set IP Range End to appropriate value (default 192.168.1.254)
413 - Set vlan to appropriate value (default 102)
415 #. Update the Management network configuration.
417 - Set CIDR to appropriate value (default 192.168.0.0/24)
419 - Set IP Range Start to appropriate value (default 192.168.0.1)
421 - Set IP Range End to appropriate value (default 192.168.0.254)
423 - Check <VLAN tagging>.
425 - Set appropriate VLAN id. (default 101)
427 #. Update the Private Network Information
429 - Set CIDR to appropriate value (default 192.168.2.0/24
431 - Set IP Range Start to appropriate value (default 192.168.2.1)
433 - Set IP Range End to appropriate value (default 192.168.2.254)
435 - Check <VLAN tagging>.
437 - Set appropriate VLAN tag (default 103)
439 #. Select the "Neutron L3" Node Networks group on the left pane.
441 .. figure:: img/neutronl3.png
443 #. Update the Floating Network configuration.
445 - Set the Floating IP range start (default 172.16.0.130)
447 - Set the Floating IP range end (default 172.16.0.254)
449 - Set the Floating network name (default admin_floating_net)
451 #. Update the Internal Network configuration.
453 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
455 - Set Internal network gateway to an appropriate value
457 - Set the Internal network name (default admin_internal_net)
459 #. Update the Guest OS DNS servers.
461 - Set Guest OS DNS Server values appropriately
465 #. Select the "Other" Node Networks group on the left pane (see figure below).
467 .. figure:: img/other.png
469 #. Update the Public network assignment.
471 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
473 #. Update Host OS DNS Servers.
475 - Provide the DNS server settings
477 #. Update Host OS NTP Servers.
479 - Provide the NTP server settings
481 Select Hypervisor type
482 ======================
484 #. In the FUEL UI of your Environment, click the "Settings" Tab
486 #. Select "Compute" on the left side pane (see figure below)
488 - Check the KVM box and press "Save settings"
490 .. figure:: img/compute.png
495 #. In the FUEL UI of your Environment, click the "Settings" Tab
497 #. Select Other on the left side pane (see figure below)
499 - Enable and configure the plugins of your choice
501 .. figure:: img/plugins_aarch64.png
503 Allocate nodes to environment and assign functional roles
504 =========================================================
506 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
508 .. figure:: img/addnodes.png
510 #. Assign roles (see figure below).
512 - Click on the <+Add Nodes> button
514 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller) in the "Assign Roles" Section.
516 - Check one node which you want to act as a Controller from the bottom half of the screen
518 - Click <Apply Changes>.
520 - Click on the <+Add Nodes> button
522 - Check the <Controller> and <Storage - Ceph OSD> roles.
524 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
526 - Click <Apply Changes>
528 - Click on <+Add Nodes> button
530 - Check the <Compute> and <Storage - Ceph OSD> roles.
532 - Check the Nodes you want to act as Computes from the bottom half of the screen
534 - Click <Apply Changes>.
536 .. figure:: img/computelist.png
538 #. Configure interfaces (see figure below).
540 - Check Select <All> to select all allocated nodes
542 - Click <Configure Interfaces>
544 - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
548 .. figure:: img/interfaceconf.png
550 OPTIONAL - Set Local Mirror Repos
551 =================================
553 **NOTE**: Support for local mirrors is incomplete in Danube 2.0.
554 You may opt in for it to fetch less packages from internet during deployment,
555 but an internet connection is still required.
557 The following steps must be executed if you are in an environment with
558 no connection to the Internet. The Fuel server delivers a local repo
559 that can be used for installation / deployment of openstack.
561 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
563 - Replace the URI values for the "Name" values outlined below:
565 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ xenial main"
567 - "mos" URI="deb http://<ip-of-fuel-server>::8080/newton-10.0/ubuntu/x86_64 mos10.0 main restricted"
569 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/newton-10.0/ubuntu/auxiliary auxiliary main restricted"
571 - Click <Save Settings> at the bottom to Save your changes
573 Target specific configuration
574 =============================
576 #. [AArch64 specific] Configure MySQL WSREP SST provider
578 **NOTE**: This option is only available for ArmbandFuel@OPNFV, since it
579 currently only affects AArch64 targets (see *Reference 15*).
581 When using some AArch64 platforms as controller nodes, WSREP SST
582 synchronisation using default backend provider (xtrabackup-v2) used to fail,
583 so a mechanism that allows selecting a different WSREP SST provider
586 In the FUEL UI of your Environment, click the <Settings> tab, click
587 <OpenStack Services> on the left side pane (see figure below), then
588 select one of the following options:
590 - xtrabackup-v2 (default provider, AArch64 stability issues);
592 - rsync (AArch64 validated, better or comparable speed to xtrabackup,
593 takes the donor node offline during state transfer);
595 - mysqldump (untested);
597 .. figure:: img/fuelwsrepsst.png
599 #. [AArch64 specific] Using a different kernel
601 **NOTE**: By default, a 4.8 based kernel is used, for enabling experimental
602 GICv3 features (e.g. live migration) and SFC support (required by OVS-NSH).
604 To use Ubuntu Xenial LTS generic kernel (also available in offline mirror),
605 in the FUEL UI of your Environment, click the <Settings> tab, click
606 <General> on the left side pane, then at the bottom of the page, in the
607 <Provision> subsection, amend the package list:
609 - add <linux-headers-generic-lts-xenial>;
611 - add <linux-image-generic-lts-xenial>;
613 - add <linux-image-extra-lts-xenial> (optional);
615 - remove <linux-image-4.8.0-9944-generic>;
617 - remove <linux-headers-4.8.0-9944-generic>;
619 - remove <linux-image-extra-4.8.0-9944-generic>;
621 #. Set up targets for provisioning with non-default "Offloading Modes"
623 Some target nodes may require additional configuration after they are
624 PXE booted (bootstrapped); the most frequent changes are in defaults
625 for ethernet devices' "Offloading Modes" settings (e.g. some targets'
626 ethernet drivers may strip VLAN traffic by default).
628 If your target ethernet drivers have wrong "Offloading Modes" defaults,
629 in "Configure interfaces" page (described above), expand affected
630 interface's "Offloading Modes" and [un]check the relevant settings
633 .. figure:: img/offloadingmodes.png
635 #. Set up targets for "Verify Networks" with non-default "Offloading Modes"
637 **NOTE**: Check *Reference 15* for an updated and comprehensive list of
638 known issues and/or limitations, including "Offloading Modes" not being
639 applied during "Verify Networks" step.
641 Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
642 during provisiong and **not** during "Verify Networks", so if your targets
643 need this change, you have to apply "Offloading Modes" settings by hand
644 to bootstrapped nodes.
646 **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
647 the Openstack interface(s) "eth1", preventing VLAN traffic from passing
648 during "Verify Networks".
650 - From Fuel master console identify target nodes admin IPs (see figure below):
656 .. figure:: img/fuelconsole1.png
658 - SSH into each of the target nodes and disable "rx-vlan-filter" on the
659 affected physical interface(s) allocated for OpenStack traffic (eth1):
663 $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
665 - Repeat the step above for all affected nodes/interfaces in the POD.
670 It is important that the Verify Networks action is performed as it will verify
671 that communicate works for the networks you have setup, as well as check that
672 packages needed for a successful deployment can be fetched.
674 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
676 - Select <Verify Networks>
678 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
680 .. figure:: img/verifynet.png
682 Deploy Your Environment
683 =======================
685 #. Deploy the environment.
687 - In the Fuel GUI, click on the "Dashboard" Tab.
689 - Click on <Deploy Changes> in the "Ready to Deploy?" section
691 - Examine any information notice that pops up and click <Deploy>
693 Wait for your deployment to complete, you can view the "Dashboard"
694 Tab to see the progress and status of your deployment.
696 =========================
697 Installation health-check
698 =========================
700 #. Perform system health-check (see figure below)
702 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
704 - Check <Select All> and Click <Run Tests>
706 - Allow tests to run and investigate results where appropriate
708 - Check *Reference 15* for known issues / limitations on AArch64
710 .. figure:: img/health.png
717 Please refer to the :ref:`Release Notes <armband-releasenotes>` article.
725 1) `OPNFV Home Page <http://www.opnfv.org>`_
726 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
730 3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
731 4) `OpenStack Documentation <http://docs.openstack.org>`_
735 5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
739 6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
740 7) `Fuel Documentation Overview <http://docs.openstack.org/developer/fuel-docs>`_
741 8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
742 9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
743 10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
744 11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
745 12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_
747 Armband Fuel in OPNFV
749 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>`_
751 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>`_
753 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>`_