1 ====================================================================================================================
2 OPNFV Installation instruction for the AArch64 Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool
3 ====================================================================================================================
8 This work is licensed under a Creative Commons Attribution 4.0 International
9 License. .. http://creativecommons.org/licenses/by/4.0 ..
10 (c) Jonas Bjurel (Ericsson AB) and others
15 This document describes how to install the Brahmaputra 3.0 release of
16 OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target
22 This document provides guidelines on how to install and
23 configure the Brahmaputra 3.0 release of OPNFV when using Fuel as a
24 deployment tool, with an AArch64 (only) target node pool,
25 including required software and hardware configurations.
27 Although the available installation options give a high degree of
28 freedom in how the system is set-up, including architecture, services
29 and features, etc., said permutations may not provide an OPNFV
30 compliant reference architecture. This instruction provides a
31 step-by-step guide that results in an OPNFV Brahmaputra compliant
34 The audience of this document is assumed to have good knowledge in
35 networking and Unix/Linux administration.
39 Before starting the installation of the AArch64 Brahmaputra 3.0 release of
40 OPNFV, using Fuel as a deployment tool, some planning must be
43 Retrieving the ISO image
44 ------------------------
46 First of all, the Fuel deployment ISO image needs to be retrieved, the
47 ArmbandFuel .iso image of the AArch64 Brahmaputra release can be found
50 Building the ISO image
51 ----------------------
53 Alternatively, you may build the ArmbandFuel .iso from source by cloning the
54 opnfv/armband git repository. To retrieve the repository for the AArch64
55 Brahmaputra 3.0 release use the following command:
59 $ git clone https://gerrit.opnfv.org/gerrit/armband
61 Check-out the Brahmaputra release tag to set the HEAD to the
62 baseline required to replicate the Brahmaputra release:
66 $ git checkout brahmaputra.3.0
68 Go to the armband directory and build the .iso:
75 For more information on how to build, please see *Reference: 14*
80 Next, familiarize yourself with Fuel by reading the following documents:
82 - Fuel planning guide, please see *Reference: 8*
84 - Fuel user guide, please see *Reference: 9*
86 - Fuel operations guide, please see *Reference: 10*
88 - Fuel Plugin Developers Guide, please see *Reference: 11*
90 Prior to installation, a number of deployment specific parameters must be collected, those are:
92 #. Provider sub-net and gateway information
94 #. Provider VLAN information
96 #. Provider DNS addresses
98 #. Provider NTP addresses
100 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
102 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
104 #. Monitoring options you want to deploy (Ceilometer, Syslog, erc.).
106 #. Other options not covered in the document are available in the links above
109 This information will be needed for the configuration procedures
110 provided in this document.
112 Hardware requirements
113 =====================
115 The following minimum hardware requirements must be met for the
116 installation of AArch64 Brahmaputra 3.0 using Fuel:
118 +--------------------+------------------------------------------------------+
119 | **HW Aspect** | **Requirement** |
121 +====================+======================================================+
122 | **AArch64 nodes** | Minimum 5 (3 for non redundant deployment): |
124 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
125 | | role, 2 Ceph-OSD roles) |
127 | | - 1 Compute (1 co-located Ceph-OSD role) |
129 +--------------------+------------------------------------------------------+
130 | **CPU** | Minimum 1 socket AArch64 (ARMv8) with Virtualization |
132 +--------------------+------------------------------------------------------+
133 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
135 +--------------------+------------------------------------------------------+
136 | **Disk** | Minimum 256GB 10kRPM spinning disks |
138 +--------------------+------------------------------------------------------+
139 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
141 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
143 | | Note: These can be allocated to a single NIC - |
144 | | or spread out over multiple NICs as your hardware |
146 +--------------------+------------------------------------------------------+
147 | **1 x86_64 node** | - 1 Fuel deployment master, x86 (may be virtualized) |
148 +--------------------+------------------------------------------------------+
150 Help with Hardware Requirements
151 ===============================
153 Calculate hardware requirements:
155 When choosing the hardware on which you will deploy your OpenStack
156 environment, you should think about:
158 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
160 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
162 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
164 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
167 Top of the rack (TOR) Configuration requirements
168 ================================================
170 The switching infrastructure provides connectivity for the OPNFV
171 infrastructure operations, tenant networks (East/West) and provider
172 connectivity (North/South); it also provides needed connectivity for
173 the Storage Area Network (SAN).
174 To avoid traffic congestion, it is strongly suggested that three
175 physically separated networks are used, that is: 1 physical network
176 for administration and control, one physical network for tenant private
177 and public networks, and one physical network for SAN.
178 The switching connectivity can (but does not need to) be fully redundant,
179 in such case it comprises a redundant 10GE switch pair for each of the
180 three physically separated networks.
182 The physical TOR switches are **not** automatically configured from
183 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
184 infrastructure as well as the provider networks and the private tenant
185 VLANs needs to be manually configured.
187 Manual configuration of the Brahmaputra hardware platform should
188 be carried out according to the OPNFV Pharos specification:
189 <https://wiki.opnfv.org/pharos/pharos_specification>
191 OPNFV Software installation and deployment
192 ==========================================
194 This section describes the installation of the OPNFV installation
195 server (Fuel master) as well as the deployment of the full OPNFV
196 reference platform stack across a server cluster.
200 #. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
202 #. Reboot the jump host to establish the Fuel server.
204 - The system now boots from the ISO image.
206 - Select "Fuel Install (Static IP)" (See figure below)
210 .. figure:: img/grub-1.png
212 #. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
214 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
216 - Enter "admin" in the Fuel password input
218 - Enter "admin" in the Confirm password input
220 - Select "Check" and press [Enter]
222 .. figure:: img/fuelmenu1.png
224 #. 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).
226 - **NOTE**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
227 image building, due to missing arm64 (AArch64) packages in the partial
228 local Ubuntu mirror (consequence of ports.ubuntu.com mirror architecture).
230 - Configuration of ETH1 interface for connectivity into your corporate/lab
231 network is mandatory, as internet connection is required during deployment.
233 .. figure:: img/fuelmenu2.png
235 .. figure:: img/fuelmenu2a.png
237 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
239 - DHCP Pool Start 10.20.0.3
241 - DHCP Pool End 10.20.0.254
243 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
245 .. figure:: img/fuelmenu3.png
247 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
257 - Hostname to test DNS
259 - Select <Check> and press [Enter]
261 .. figure:: img/fuelmenu4.png
264 #. 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)
266 - Navigate to "HTTP proxy" and enter your http proxy address
268 - Select <Check> and press [Enter]
270 .. figure:: img/fuelmenu5.png
272 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
274 - NTP Server 1 <Customer NTP server 1>
276 - NTP Server 2 <Customer NTP server 2>
278 - NTP Server 3 <Customer NTP server 3>
280 .. figure:: img/fuelmenu6.png
282 #. Start the installation.
284 - Select Quit Setup and press Save and Quit.
286 - Installation starts, wait until the login screen is shown.
289 Boot the Node Servers
290 ---------------------
292 After the Fuel Master node has rebooted from the above steps and is at
293 the login prompt, you should boot the Node Servers (Your
294 Compute/Control/Storage blades (nested or real) with a PXE booting
295 scheme so that the FUEL Master can pick them up for control.
297 #. Enable PXE booting
299 - 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.
301 #. Reboot all the control and compute blades.
303 #. Wait for the availability of nodes showing up in the Fuel GUI.
305 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
307 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
309 .. figure:: img/nodes.png
312 Install additional Plugins/Features on the FUEL node
313 ----------------------------------------------------
315 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
317 #. Select wanted plugins/features from the /opt/opnfv/ directory.
319 #. Install the wanted plugin with the command:
323 $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
325 Expected output (see figure below):
329 Plugin ....... was successfully installed.
331 **NOTE**: AArch64 Brahmaputra 3.0 ships only with Opendaylight plugin,
334 .. figure:: img/plugin_install.png
336 Create an OpenStack Environment
337 -------------------------------
339 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
341 #. Create and name a new OpenStack environment, to be installed.
343 .. figure:: img/newenv.png
345 #. Select "<Liberty on Ubuntu 14.04 (aarch64)>" and press <Next>
347 #. Select "compute virtulization method".
349 - Select "QEMU-KVM as hypervisor" and press <Next>
351 #. Select "network mode".
353 - Select "Neutron with ML2 plugin"
355 - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
359 #. Select "Storage Back-ends".
361 - Select "Ceph for block storage" and press <Next>
363 #. Select "additional services" you wish to install.
365 - Check option "Install Ceilometer (OpenStack Telemetry)" and press <Next>
367 #. Create the new environment.
369 - Click <Create> Button
371 Configure the network environment
372 ---------------------------------
374 #. Open the environment you previously created.
376 #. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
378 .. figure:: img/network.png
380 #. Update the Public network configuration and change the following fields to appropriate values:
382 - CIDR to <CIDR for Public IP Addresses>
384 - IP Range Start to <Public IP Address start>
386 - IP Range End to <Public IP Address end>
388 - Gateway to <Gateway for Public IP Addresses>
390 - Check <VLAN tagging>.
392 - Set appropriate VLAN id.
394 #. Update the Storage Network Configuration
396 - Set CIDR to appropriate value (default 192.168.1.0/24)
398 - Set IP Range Start to appropriate value (default 192.168.1.1)
400 - Set IP Range End to appropriate value (default 192.168.1.254)
402 - Set vlan to appropriate value (default 102)
404 #. Update the Management network configuration.
406 - Set CIDR to appropriate value (default 192.168.0.0/24)
408 - Set IP Range Start to appropriate value (default 192.168.0.1)
410 - Set IP Range End to appropriate value (default 192.168.0.254)
412 - Check <VLAN tagging>.
414 - Set appropriate VLAN id. (default 101)
416 #. Update the Private Network Information
418 - Set CIDR to appropriate value (default 192.168.2.0/24
420 - Set IP Range Start to appropriate value (default 192.168.2.1)
422 - Set IP Range End to appropriate value (default 192.168.2.254)
424 - Check <VLAN tagging>.
426 - Set appropriate VLAN tag (default 103)
428 #. Select the "Neutron L3 Node Networks group" on the left pane.
430 .. figure:: img/neutronl3.png
432 #. Update the Floating Network configuration.
434 - Set the Floating IP range start (default 172.16.0.130)
436 - Set the Floating IP range end (default 172.16.0.254)
438 - Set the Floating network name (default admin_floating_net)
440 #. Update the Internal Network configuration.
442 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
444 - Set Internal network gateway to an appropriate value
446 - Set the Internal network name (default admin_internal_net)
448 #. Update the Guest OS DNS servers.
450 - Set Guest OS DNS Server values appropriately
454 #. Select the "Other Node Networks group" on the left pane(see figure below).
456 .. figure:: img/other.png
458 #. Update the Public network assignment.
460 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
462 #. Update Host OS DNS Servers.
464 - Provide the DNS server settings
466 #. Update Host OS NTP Servers.
468 - Provide the NTP server settings
470 Select Hypervisor type
471 ----------------------
473 #. In the FUEL UI of your Environment, click the "Settings" Tab
475 #. Select Compute on the left side pane (see figure below)
477 - Check the KVM box and press "Save settings"
479 .. figure:: img/compute.png
484 #. In the FUEL UI of your Environment, click the "Settings" Tab
486 #. Select Other on the left side pane (see figure below)
488 - Enable and configure the plugins of your choice
490 .. figure:: img/plugins.png
492 Allocate nodes to environment and assign functional roles
493 ---------------------------------------------------------
495 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
497 .. figure:: img/addnodes.png
499 #. Assign roles (see figure below).
501 - Click on the <+Add Nodes> button
503 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller) in the Assign Roles Section.
505 - Check one node which you want to act as a Controller from the bottom half of the screen
507 - Click <Apply Changes>.
509 - Click on the <+Add Nodes> button
511 - Check the <Controller> and <Storage - Ceph OSD> roles.
513 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
515 - Click <Apply Changes>
517 - Click on <+Add Nodes> button
519 - Check the <Compute> and <Storage - Ceph OSD> roles.
521 - Check the Nodes you want to act as Computes from the bottom half of the screen
523 - Click <Apply Changes>.
525 .. figure:: img/computelist.png
527 #. Configure interfaces (see figure below).
529 - Check Select <All> to select all allocated nodes
531 - Click <Configure Interfaces>
533 - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
538 .. figure:: img/interfaceconf.png
540 OPTIONAL - UNTESTED - Set Local Mirror Repos
541 ---------------------------------
543 **NOTE**: AArch64 Brahmaputra 3.0 does not fully support local Ubuntu mirrors,
544 or at least does not ship with arm64 packages in local repos by default.
545 In order to use local (partial) Ubuntu mirrors, one should add arm64 packages
546 by hand to the existing amd64 mirrors and re-generate repo metadata.
547 Local MOS/Auxiliary repos contain packages for both amd64 and arm64.
549 **NOTE**: Below instruction assume you already added (by hand) arm64
550 Ubuntu necessary packages to the local repository!
552 The following steps can be executed if you are in an environment with
553 no connection to the Internet. The Fuel server delivers a local repo
554 that can be used for installation / deployment of openstack.
556 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
558 - Replace the URI values for the "Name" values outlined below:
560 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
562 - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main"
564 - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
566 - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
568 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
570 - Click <Save Settings> at the bottom to Save your changes
572 Target specific configuration
573 -----------------------------
575 #. Set up targets for provisioning with non-default "Offloading Modes"
577 Some target nodes may require additional configuration after they are
578 PXE booted (bootstrapped); the most frequent changes are in defaults
579 for ethernet devices' "Offloading Modes" settings (e.g. some targets'
580 ethernet drivers may strip VLAN traffic by default).
582 If your target ethernet drivers have wrong "Offloading Modes" defaults,
583 in "Configure interfaces" page (described above), expand affected
584 interface's "Offloading Modes" and [un]check the relevant settings
587 .. figure:: img/offloadingmodes.png
589 #. Set up targets for "Verify Networks" with non-default "Offloading Modes"
591 **NOTE**: Check *Reference 15* for an updated and comprehensive list of
592 known issues and/or limitations, including "Offloading Modes" not being
593 applied during "Verify Networks" step.
595 Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
596 during provisiong and **not** during "Verify Networks", so if your targets
597 need this change, you have to apply "Offloading Modes" settings by hand
598 to bootstrapped nodes.
600 **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
601 the Openstack interface(s) "eth1", preventing VLAN traffic from passing
602 during "Verify Networks".
604 - From Fuel master console identify target nodes admin IPs (see figure below):
610 .. figure:: img/fuelconsole1.png
612 - SSH into each of the target nodes and disable "rx-vlan-filter" on the
613 affected physical interface(s) allocated for OpenStack traffic (eth1):
617 $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
619 - Repeat the step above for all affected nodes/interfaces in the POD.
624 It is important that the Verify Networks action is performed as it will verify
625 that communicate works for the networks you have setup, as well as check that
626 packages needed for a successful deployment can be fetched.
628 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
630 - Select <Verify Networks>
632 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
634 .. figure:: img/verifynet.png
637 Deploy Your Environment
638 -----------------------
640 38. Deploy the environment.
642 - In the Fuel GUI, click on the "Dashboard" Tab.
644 - Click on <Deploy Changes> in the "Ready to Deploy?" section
646 - Examine any information notice that pops up and click <Deploy>
648 Wait for your deployment to complete, you can view the "Dashboard"
649 Tab to see the progress and status of your deployment.
651 Installation health-check
652 =========================
654 #. Perform system health-check (see figure below)
656 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
658 - Check <Select All> and Click <Run Tests>
660 - Allow tests to run and investigate results where appropriate
662 - Check *Reference 15* for known issues / limitations on AArch64, like
663 unsupported migration tests when using a GICv3 interrupt controller
665 .. figure:: img/health.png
673 1) `OPNFV Home Page <http://www.opnfv.org>`_
675 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
680 3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
682 4) `OpenStack documentation <http://docs.openstack.org>`_
687 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
691 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
693 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
695 8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
697 9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
699 10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
701 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
703 12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
708 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>`_
710 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>`_
712 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>`_