1 ====================================================================================================================
2 OPNFV Installation instruction for the AArch64 Colorado 1.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 Colorado 1.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 Colorado 1.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 Colorado 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 Colorado 1.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 Colorado 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 Colorado 1.0 release use the following command:
59 $ git clone https://gerrit.opnfv.org/gerrit/armband
61 Check-out the Colorado release tag to set the HEAD to the
62 baseline required to replicate the Colorado release:
66 $ git checkout colorado.1.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 Colorado 1.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 | **Firmware** | UEFI compatible (e.g. EDK2) with PXE support |
140 +--------------------+------------------------------------------------------+
141 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
143 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
145 | | Note: These can be allocated to a single NIC - |
146 | | or spread out over multiple NICs as your hardware |
148 +--------------------+------------------------------------------------------+
149 | **1 x86_64 node** | - 1 Fuel deployment master, x86 (may be virtualized) |
150 +--------------------+------------------------------------------------------+
152 Help with Hardware Requirements
153 ===============================
155 Calculate hardware requirements:
157 When choosing the hardware on which you will deploy your OpenStack
158 environment, you should think about:
160 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
162 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
164 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
166 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
169 Top of the rack (TOR) Configuration requirements
170 ================================================
172 The switching infrastructure provides connectivity for the OPNFV
173 infrastructure operations, tenant networks (East/West) and provider
174 connectivity (North/South); it also provides needed connectivity for
175 the Storage Area Network (SAN).
176 To avoid traffic congestion, it is strongly suggested that three
177 physically separated networks are used, that is: 1 physical network
178 for administration and control, one physical network for tenant private
179 and public networks, and one physical network for SAN.
180 The switching connectivity can (but does not need to) be fully redundant,
181 in such case it comprises a redundant 10GE switch pair for each of the
182 three physically separated networks.
184 The physical TOR switches are **not** automatically configured from
185 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
186 infrastructure as well as the provider networks and the private tenant
187 VLANs needs to be manually configured.
189 Manual configuration of the Colorado hardware platform should
190 be carried out according to the OPNFV Pharos specification:
191 <https://wiki.opnfv.org/pharos/pharos_specification>
193 OPNFV Software installation and deployment
194 ==========================================
196 This section describes the installation of the OPNFV installation
197 server (Fuel master) as well as the deployment of the full OPNFV
198 reference platform stack across a server cluster.
202 #. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server.
204 #. Reboot the jump host to establish the Fuel server.
206 - The system now boots from the ISO image.
208 - Select "Fuel Install (Static IP)" (See figure below)
212 .. figure:: img/grub-1.png
214 #. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
216 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
218 - Enter "admin" in the Fuel password input
220 - Enter "admin" in the Confirm password input
222 - Select "Check" and press [Enter]
224 .. figure:: img/fuelmenu1.png
226 #. 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).
228 - **NOTE**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
229 image building, due to missing arm64 (AArch64) packages in the partial
230 local Ubuntu mirror (consequence of ports.ubuntu.com mirror architecture).
232 - Configuration of ETH1 interface for connectivity into your corporate/lab
233 network is mandatory, as internet connection is required during deployment.
235 .. figure:: img/fuelmenu2.png
237 .. figure:: img/fuelmenu2a.png
239 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
241 - DHCP Pool Start 10.20.0.3
243 - DHCP Pool End 10.20.0.254
245 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
247 .. figure:: img/fuelmenu3.png
249 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
259 - Hostname to test DNS
261 - Select <Check> and press [Enter]
263 .. figure:: img/fuelmenu4.png
265 #. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below).
267 In ArmbandFuel@OPNFV, this data is **NOT** actually used for bootstrap
268 image building. Any change here will replace the configuration from
269 the OPNFV bootstrap build scripts and will lead to a failed bootstrap
272 **NOTE:** Cannot be used in tandem with local repository support.
274 .. figure:: img/fuelmenu5.png
276 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
278 - NTP Server 1 <Customer NTP server 1>
280 - NTP Server 2 <Customer NTP server 2>
282 - NTP Server 3 <Customer NTP server 3>
284 .. figure:: img/fuelmenu6.png
286 #. Start the installation.
288 - Press <F8> or select Quit Setup and press Save and Quit.
290 - Installation starts, wait until the login screen is shown.
293 Boot the Node Servers
294 ---------------------
296 After the Fuel Master node has rebooted from the above steps and is at
297 the login prompt, you should boot the Node Servers (Your
298 Compute/Control/Storage blades (nested or real) with a PXE booting
299 scheme so that the FUEL Master can pick them up for control.
301 **NOTE**: AArch64 target nodes are expected to support PXE booting an
302 EFI binary, i.e. an EFI-stubbed GRUB2 bootloader.
304 **NOTE**: UEFI (EDK2) firmware is **highly** recommended, becoming
305 the **de facto** standard for ARMv8 nodes.
307 #. Enable PXE booting
309 - 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.
311 #. Reboot all the control and compute blades.
313 #. Wait for the availability of nodes showing up in the Fuel GUI.
315 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
317 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
319 .. figure:: img/nodes.png
322 Install additional Plugins/Features on the FUEL node
323 ----------------------------------------------------
325 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
327 #. Select wanted plugins/features from the /opt/opnfv/ directory.
329 #. Install the wanted plugin with the command:
333 $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
335 Expected output (see figure below):
339 Plugin ....... was successfully installed.
341 **NOTE**: Not all plugins are ported to AArch64 Colorado 1.0
344 .. figure:: img/plugin_install.png
346 Create an OpenStack Environment
347 -------------------------------
349 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
351 #. Create and name a new OpenStack environment, to be installed.
353 .. figure:: img/newenv.png
355 #. Select "<Mitaka on Ubuntu 14.04 (aarch64)>" and press <Next>
357 #. Select "compute virtulization method".
359 - Select "QEMU-KVM as hypervisor" and press <Next>
361 #. Select "network mode".
363 - Select "Neutron with ML2 plugin"
365 - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
369 #. Select "Storage Back-ends".
371 - Select "Ceph for block storage" and press <Next>
373 #. Select "additional services" you wish to install.
375 - Check option "Install Ceilometer (OpenStack Telemetry)" and press <Next>
377 #. Create the new environment.
379 - Click <Create> Button
381 Configure the network environment
382 ---------------------------------
384 #. Open the environment you previously created.
386 #. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
388 .. figure:: img/network.png
390 #. Update the Public network configuration and change the following fields to appropriate values:
392 - CIDR to <CIDR for Public IP Addresses>
394 - IP Range Start to <Public IP Address start>
396 - IP Range End to <Public IP Address end>
398 - Gateway to <Gateway for Public IP Addresses>
400 - Check <VLAN tagging>.
402 - Set appropriate VLAN id.
404 #. Update the Storage Network Configuration
406 - Set CIDR to appropriate value (default 192.168.1.0/24)
408 - Set IP Range Start to appropriate value (default 192.168.1.1)
410 - Set IP Range End to appropriate value (default 192.168.1.254)
412 - Set vlan to appropriate value (default 102)
414 #. Update the Management network configuration.
416 - Set CIDR to appropriate value (default 192.168.0.0/24)
418 - Set IP Range Start to appropriate value (default 192.168.0.1)
420 - Set IP Range End to appropriate value (default 192.168.0.254)
422 - Check <VLAN tagging>.
424 - Set appropriate VLAN id. (default 101)
426 #. Update the Private Network Information
428 - Set CIDR to appropriate value (default 192.168.2.0/24
430 - Set IP Range Start to appropriate value (default 192.168.2.1)
432 - Set IP Range End to appropriate value (default 192.168.2.254)
434 - Check <VLAN tagging>.
436 - Set appropriate VLAN tag (default 103)
438 #. Select the "Neutron L3 Node Networks group" on the left pane.
440 .. figure:: img/neutronl3.png
442 #. Update the Floating Network configuration.
444 - Set the Floating IP range start (default 172.16.0.130)
446 - Set the Floating IP range end (default 172.16.0.254)
448 - Set the Floating network name (default admin_floating_net)
450 #. Update the Internal Network configuration.
452 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
454 - Set Internal network gateway to an appropriate value
456 - Set the Internal network name (default admin_internal_net)
458 #. Update the Guest OS DNS servers.
460 - Set Guest OS DNS Server values appropriately
464 #. Select the "Other Node Networks group" on the left pane(see figure below).
466 .. figure:: img/other.png
468 #. Update the Public network assignment.
470 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
472 #. Update Host OS DNS Servers.
474 - Provide the DNS server settings
476 #. Update Host OS NTP Servers.
478 - Provide the NTP server settings
480 Select Hypervisor type
481 ----------------------
483 #. In the FUEL UI of your Environment, click the "Settings" Tab
485 #. Select Compute on the left side pane (see figure below)
487 - Check the KVM box and press "Save settings"
489 .. figure:: img/compute.png
494 #. In the FUEL UI of your Environment, click the "Settings" Tab
496 #. Select Other on the left side pane (see figure below)
498 - Enable and configure the plugins of your choice
500 .. figure:: img/plugins_aarch64.png
502 Allocate nodes to environment and assign functional roles
503 ---------------------------------------------------------
505 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
507 .. figure:: img/addnodes.png
509 #. Assign roles (see figure below).
511 - Click on the <+Add Nodes> button
513 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller) in the Assign Roles Section.
515 - Check one node which you want to act as a Controller from the bottom half of the screen
517 - Click <Apply Changes>.
519 - Click on the <+Add Nodes> button
521 - Check the <Controller> and <Storage - Ceph OSD> roles.
523 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
525 - Click <Apply Changes>
527 - Click on <+Add Nodes> button
529 - Check the <Compute> and <Storage - Ceph OSD> roles.
531 - Check the Nodes you want to act as Computes from the bottom half of the screen
533 - Click <Apply Changes>.
535 .. figure:: img/computelist.png
537 #. Configure interfaces (see figure below).
539 - Check Select <All> to select all allocated nodes
541 - Click <Configure Interfaces>
543 - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
548 .. figure:: img/interfaceconf.png
550 OPTIONAL - UNTESTED - Set Local Mirror Repos
551 ---------------------------------
553 **NOTE**: AArch64 Colorado 1.0 does not fully support local Ubuntu mirrors,
554 or at least does not ship with arm64 packages in local repos by default.
555 In order to use local (partial) Ubuntu mirrors, one should add arm64 packages
556 by hand to the existing amd64 mirrors and re-generate repo metadata.
557 Local MOS/Auxiliary repos contain packages for both amd64 and arm64.
559 **NOTE**: Below instruction assume you already added (by hand) arm64
560 Ubuntu necessary packages to the local repository!
562 The following steps can be executed if you are in an environment with
563 no connection to the Internet. The Fuel server delivers a local repo
564 that can be used for installation / deployment of openstack.
566 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
568 - Replace the URI values for the "Name" values outlined below:
570 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
572 - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main"
574 - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
576 - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-8.0/ubuntu/x86_64 mos8.0 main restricted"
578 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-8.0/ubuntu/auxiliary auxiliary main restricted"
580 - Click <Save Settings> at the bottom to Save your changes
582 Target specific configuration
583 -----------------------------
585 #. [AArch64 specific] Configure MySQL WSREP SST provider
587 **NOTE**: This option is only available for ArmbandFuel@OPNFV, since it
588 currently only affects AArch64 targets (see *Reference 15*).
590 When using some AArch64 platforms as controller nodes, WSREP SST
591 synchronisation using default backend provider (xtrabackup-v2) might fail,
592 so a mechanism that allows selecting a different WSREP SST provider
595 In the FUEL UI of your Environment, click the <Settings> tab, click
596 <OpenStack Services> on the left side pane (see figure below), then
597 select one of the following options:
599 - xtrabackup-v2 (default provider, AArch64 stability issues);
601 - rsync (AArch64 validated, better or comparable speed to xtrabackup,
602 takes the donor node offline during state transfer);
604 - mysqldump (untested);
606 .. figure:: img/fuelwsrepsst.png
608 #. Set up targets for provisioning with non-default "Offloading Modes"
610 Some target nodes may require additional configuration after they are
611 PXE booted (bootstrapped); the most frequent changes are in defaults
612 for ethernet devices' "Offloading Modes" settings (e.g. some targets'
613 ethernet drivers may strip VLAN traffic by default).
615 If your target ethernet drivers have wrong "Offloading Modes" defaults,
616 in "Configure interfaces" page (described above), expand affected
617 interface's "Offloading Modes" and [un]check the relevant settings
620 .. figure:: img/offloadingmodes.png
622 #. Set up targets for "Verify Networks" with non-default "Offloading Modes"
624 **NOTE**: Check *Reference 15* for an updated and comprehensive list of
625 known issues and/or limitations, including "Offloading Modes" not being
626 applied during "Verify Networks" step.
628 Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
629 during provisiong and **not** during "Verify Networks", so if your targets
630 need this change, you have to apply "Offloading Modes" settings by hand
631 to bootstrapped nodes.
633 **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
634 the Openstack interface(s) "eth1", preventing VLAN traffic from passing
635 during "Verify Networks".
637 - From Fuel master console identify target nodes admin IPs (see figure below):
643 .. figure:: img/fuelconsole1.png
645 - SSH into each of the target nodes and disable "rx-vlan-filter" on the
646 affected physical interface(s) allocated for OpenStack traffic (eth1):
650 $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
652 - Repeat the step above for all affected nodes/interfaces in the POD.
657 It is important that the Verify Networks action is performed as it will verify
658 that communicate works for the networks you have setup, as well as check that
659 packages needed for a successful deployment can be fetched.
661 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
663 - Select <Verify Networks>
665 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
667 .. figure:: img/verifynet.png
670 Deploy Your Environment
671 -----------------------
673 38. Deploy the environment.
675 - In the Fuel GUI, click on the "Dashboard" Tab.
677 - Click on <Deploy Changes> in the "Ready to Deploy?" section
679 - Examine any information notice that pops up and click <Deploy>
681 Wait for your deployment to complete, you can view the "Dashboard"
682 Tab to see the progress and status of your deployment.
684 Installation health-check
685 =========================
687 #. Perform system health-check (see figure below)
689 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
691 - Check <Select All> and Click <Run Tests>
693 - Allow tests to run and investigate results where appropriate
695 - Check *Reference 15* for known issues / limitations on AArch64, like
696 unsupported migration tests when using a GICv3 interrupt controller
698 .. figure:: img/health.png
706 1) `OPNFV Home Page <http://www.opnfv.org>`_
708 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
713 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
715 4) `OpenStack documentation <http://docs.openstack.org>`_
720 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
724 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
726 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_
728 8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_
730 9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_
732 10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html>`_
734 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
736 12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
741 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>`_
743 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>`_
745 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>`_