1 .. This document is protected/licensed under the following conditions
2 .. (c) Jonas Bjurel (Ericsson AB)
3 .. Licensed under a Creative Commons Attribution 4.0 International License.
4 .. You should have received a copy of the license along with this work.
5 .. If not, see <http://creativecommons.org/licenses/by/4.0/>.
11 This document describes how to install the Colorado release of
12 OPNFV when using Fuel as a deployment tool, with an AArch64 (only)
13 target node pool. It covers its usage, limitations, dependencies
14 and required system resources.
20 This document provides guidelines on how to install and
21 configure the Colorado release of OPNFV when using Fuel as a
22 deployment tool, with an AArch64 (only) target node pool,
23 including required software and hardware configurations.
25 Although the available installation options give a high degree of
26 freedom in how the system is set-up, including architecture, services
27 and features, etc., said permutations may not provide an OPNFV
28 compliant reference architecture. This instruction provides a
29 step-by-step guide that results in an OPNFV Colorado compliant
32 The audience of this document is assumed to have good knowledge in
33 networking and Unix/Linux administration.
39 Before starting the installation of the AArch64 Colorado 1.0 release
40 of 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 Armband Fuel .iso from source by cloning
54 the 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.3.0
68 Go to the armband directory and build the .iso:
72 $ cd armband; make all
74 For more information on how to build, please see *Reference: 14*
79 Next, familiarize yourself with Fuel by reading the following documents:
81 - Fuel Installation Guide, please see *Reference: 8*
83 - Fuel QuickStart, please see *Reference: 9*
85 - Fuel Developer Guide, please see *Reference: 10*
87 - Fuel Plugin Developers Guide, please see *Reference: 11*
89 Prior to installation, a number of deployment specific parameters must be collected, those are:
91 #. Provider sub-net and gateway information
93 #. Provider VLAN information
95 #. Provider DNS addresses
97 #. Provider NTP addresses
99 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
101 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
103 #. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
105 #. Other options not covered in the document are available in the links above
108 This information will be needed for the configuration procedures
109 provided in this document.
111 =====================
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 | | - 1 Fuel deployment master (may be virtualized) |
126 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
127 | | role, 2 Ceph-OSD roles) |
129 | | - 1 Compute (1 co-located Ceph-OSD role) |
131 +--------------------+------------------------------------------------------+
132 | **CPU** | Minimum 1 socket AArch64 (ARMv8) with Virtualization |
134 +--------------------+------------------------------------------------------+
135 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
137 +--------------------+------------------------------------------------------+
138 | **Disk** | Minimum 256GB 10kRPM spinning disks |
140 +--------------------+------------------------------------------------------+
141 | **Firmware** | UEFI compatible (e.g. EDK2) with PXE support |
142 +--------------------+------------------------------------------------------+
143 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
145 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
147 | | Note: These can be allocated to a single NIC - |
148 | | or spread out over multiple NICs as your hardware |
150 +--------------------+------------------------------------------------------+
151 | **1 x86_64 node** | - 1 Fuel deployment master, x86 (may be virtualized) |
152 +--------------------+------------------------------------------------------+
154 ===============================
155 Help with Hardware Requirements
156 ===============================
158 Calculate hardware requirements:
160 When choosing the hardware on which you will deploy your OpenStack
161 environment, you should think about:
163 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
165 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
167 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
169 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
171 ================================================
172 Top of the rack (TOR) Configuration requirements
173 ================================================
175 The switching infrastructure provides connectivity for the OPNFV
176 infrastructure operations, tenant networks (East/West) and provider
177 connectivity (North/South); it also provides needed connectivity for
178 the Storage Area Network (SAN).
179 To avoid traffic congestion, it is strongly suggested that three
180 physically separated networks are used, that is: 1 physical network
181 for administration and control, one physical network for tenant private
182 and public networks, and one physical network for SAN.
183 The switching connectivity can (but does not need to) be fully redundant,
184 in such case it comprises a redundant 10GE switch pair for each of the
185 three physically separated networks.
187 The physical TOR switches are **not** automatically configured from
188 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
189 infrastructure as well as the provider networks and the private tenant
190 VLANs needs to be manually configured.
192 Manual configuration of the Colorado hardware platform should
193 be carried out according to the OPNFV Pharos specification:
194 <https://wiki.opnfv.org/display/pharos/Pharos+Specification>
196 ==========================================
197 OPNFV Software installation and deployment
198 ==========================================
200 This section describes the installation of the OPNFV installation
201 server (Fuel master) as well as the deployment of the full OPNFV
202 reference platform stack across a server cluster.
207 #. Mount the Colorado Armband Fuel ISO file/media as a boot device to the jump host server.
209 #. Reboot the jump host to establish the Fuel server.
211 - The system now boots from the ISO image.
213 - Select "Fuel Install (Static IP)" (See figure below)
217 .. figure:: img/grub-1.png
219 #. Wait until the Fuel setup screen is shown (Note: This can take up to 30 minutes).
221 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
223 - Enter "admin" in the Fuel password input
225 - Enter "admin" in the Confirm password input
227 - Select "Check" and press [Enter]
229 .. figure:: img/fuelmenu1.png
231 #. 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).
233 - **NOTE**: ArmbandFuel@OPNFV requires internet connectivity during bootstrap
234 image building, due to missing arm64 (AArch64) packages in the partial
235 local Ubuntu mirror (consequence of ports.ubuntu.com mirror architecture).
237 - Configuration of ETH1 interface for connectivity into your corporate/lab
238 network is mandatory, as internet connection is required during deployment.
240 .. figure:: img/fuelmenu2.png
242 .. figure:: img/fuelmenu2a.png
244 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
246 - DHCP Pool Start 10.20.0.3
248 - DHCP Pool End 10.20.0.254
250 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
252 .. figure:: img/fuelmenu3.png
254 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
264 - Hostname to test DNS
266 - Select <Check> and press [Enter]
268 .. figure:: img/fuelmenu4.png
271 #. **DO NOT CHANGE** anything in "Bootstrap Image" section (see figure below).
273 In ArmbandFuel@OPNFV, this data is **NOT** actually used for bootstrap
274 image building. Any change here will replace the configuration from
275 the OPNFV bootstrap build scripts and will lead to a failed bootstrap
278 **NOTE:** Cannot be used in tandem with local repository support.
280 .. figure:: img/fuelmenu5.png
282 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
284 - NTP Server 1 <Customer NTP server 1>
286 - NTP Server 2 <Customer NTP server 2>
288 - NTP Server 3 <Customer NTP server 3>
290 .. figure:: img/fuelmenu6.png
292 #. Start the installation.
296 - The installation will now start, wait until the login screen is shown.
298 Boot the Node Servers
299 =====================
301 After the Fuel Master node has rebooted from the above steps and is at
302 the login prompt, you should boot the Node Servers (Your
303 Compute/Control/Storage blades, nested or real) with a PXE booting
304 scheme so that the FUEL Master can pick them up for control.
306 **NOTE**: AArch64 target nodes are expected to support PXE booting an
307 EFI binary, i.e. an EFI-stubbed GRUB2 bootloader.
309 **NOTE**: UEFI (EDK2) firmware is **highly** recommended, becoming
310 the **de facto** standard for ARMv8 nodes.
312 #. Enable PXE booting
314 - 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.
316 #. Reboot all the control and compute blades.
318 #. Wait for the availability of nodes showing up in the Fuel GUI.
320 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
322 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
324 .. figure:: img/nodes.png
326 Install additional Plugins/Features on the FUEL node
327 ====================================================
329 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
331 #. Select wanted plugins/features from the /opt/opnfv/ directory.
333 #. Install the wanted plugin with the command
337 $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
339 Expected output (see figure below):
343 Plugin ....... was successfully installed.
345 .. figure:: img/plugin_install.png
347 **NOTE**: AArch64 Colorado 1.0 ships only with ODL, OVS and BGPVPN plugins,
350 Create an OpenStack Environment
351 ===============================
353 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin)
355 #. Create and name a new OpenStack environment, to be installed.
357 .. figure:: img/newenv.png
359 #. Select "<Mitaka on Ubuntu 14.04 (aarch64)>" and press <Next>
361 #. Select "compute virtulization method".
363 - Select "QEMU-KVM as hypervisor" and press <Next>
365 #. Select "network mode".
367 - Select "Neutron with ML2 plugin"
369 - Select "Neutron with tunneling segmentation" (Required when using the ODL plugin)
373 #. Select "Storage Back-ends".
375 - Select "Ceph for block storage" and press <Next>
377 #. Select "additional services" you wish to install.
379 - Check option "Install Ceilometer and Aodh" and press <Next>
381 #. Create the new environment.
383 - Click <Create> Button
385 Configure the network environment
386 =================================
388 #. Open the environment you previously created.
390 #. Open the networks tab and select the "default" Node Networks group to on the left pane (see figure below).
392 .. figure:: img/network.png
394 #. Update the Public network configuration and change the following fields to appropriate values:
396 - CIDR to <CIDR for Public IP Addresses>
398 - IP Range Start to <Public IP Address start>
400 - IP Range End to <Public IP Address end>
402 - Gateway to <Gateway for Public IP Addresses>
404 - Check <VLAN tagging>.
406 - Set appropriate VLAN id.
408 #. Update the Storage Network Configuration
410 - Set CIDR to appropriate value (default 192.168.1.0/24)
412 - Set IP Range Start to appropriate value (default 192.168.1.1)
414 - Set IP Range End to appropriate value (default 192.168.1.254)
416 - Set vlan to appropriate value (default 102)
418 #. Update the Management network configuration.
420 - Set CIDR to appropriate value (default 192.168.0.0/24)
422 - Set IP Range Start to appropriate value (default 192.168.0.1)
424 - Set IP Range End to appropriate value (default 192.168.0.254)
426 - Check <VLAN tagging>.
428 - Set appropriate VLAN id. (default 101)
430 #. Update the Private Network Information
432 - Set CIDR to appropriate value (default 192.168.2.0/24
434 - Set IP Range Start to appropriate value (default 192.168.2.1)
436 - Set IP Range End to appropriate value (default 192.168.2.254)
438 - Check <VLAN tagging>.
440 - Set appropriate VLAN tag (default 103)
442 #. Select the "Neutron L3" Node Networks group on the left pane.
444 .. figure:: img/neutronl3.png
446 #. Update the Floating Network configuration.
448 - Set the Floating IP range start (default 172.16.0.130)
450 - Set the Floating IP range end (default 172.16.0.254)
452 - Set the Floating network name (default admin_floating_net)
454 #. Update the Internal Network configuration.
456 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
458 - Set Internal network gateway to an appropriate value
460 - Set the Internal network name (default admin_internal_net)
462 #. Update the Guest OS DNS servers.
464 - Set Guest OS DNS Server values appropriately
468 #. Select the "Other" Node Networks group on the left pane (see figure below).
470 .. figure:: img/other.png
472 #. Update the Public network assignment.
474 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
476 #. Update Host OS DNS Servers.
478 - Provide the DNS server settings
480 #. Update Host OS NTP Servers.
482 - Provide the NTP server settings
484 Select Hypervisor type
485 ======================
487 #. In the FUEL UI of your Environment, click the "Settings" Tab
489 #. Select "Compute" on the left side pane (see figure below)
491 - Check the KVM box and press "Save settings"
493 .. figure:: img/compute.png
498 #. In the FUEL UI of your Environment, click the "Settings" Tab
500 #. Select Other on the left side pane (see figure below)
502 - Enable and configure the plugins of your choice
504 .. figure:: img/plugins_aarch64.png
506 Allocate nodes to environment and assign functional roles
507 =========================================================
509 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
511 .. figure:: img/addnodes.png
513 #. Assign roles (see figure below).
515 - Click on the <+Add Nodes> button
517 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller) in the "Assign Roles" Section.
519 - Check one node which you want to act as a Controller from the bottom half of the screen
521 - Click <Apply Changes>.
523 - Click on the <+Add Nodes> button
525 - Check the <Controller> and <Storage - Ceph OSD> roles.
527 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
529 - Click <Apply Changes>
531 - Click on <+Add Nodes> button
533 - Check the <Compute> and <Storage - Ceph OSD> roles.
535 - Check the Nodes you want to act as Computes from the bottom half of the screen
537 - Click <Apply Changes>.
539 .. figure:: img/computelist.png
541 #. Configure interfaces (see figure below).
543 - Check Select <All> to select all allocated nodes
545 - Click <Configure Interfaces>
547 - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
551 .. figure:: img/interfaceconf.png
553 OPTIONAL - Set Local Mirror Repos
554 ===========================================
556 **NOTE**: Below instruction assume you already added (by hand) arm64
557 Ubuntu necessary packages to the local repository!
559 The following steps must be executed if you are in an environment with
560 no connection to the Internet. The Fuel server delivers a local repo
561 that can be used for installation / deployment of openstack.
563 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
565 - Replace the URI values for the "Name" values outlined below:
567 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
569 - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted"
571 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted"
573 - Click <Save Settings> at the bottom to Save your changes
575 Target specific configuration
576 =============================
578 #. [AArch64 specific] Configure MySQL WSREP SST provider
580 **NOTE**: This option is only available for ArmbandFuel@OPNFV, since it
581 currently only affects AArch64 targets (see *Reference 15*).
583 When using some AArch64 platforms as controller nodes, WSREP SST
584 synchronisation using default backend provider (xtrabackup-v2) might fail,
585 so a mechanism that allows selecting a different WSREP SST provider
588 In the FUEL UI of your Environment, click the <Settings> tab, click
589 <OpenStack Services> on the left side pane (see figure below), then
590 select one of the following options:
592 - xtrabackup-v2 (default provider, AArch64 stability issues);
594 - rsync (AArch64 validated, better or comparable speed to xtrabackup,
595 takes the donor node offline during state transfer);
597 - mysqldump (untested);
599 .. figure:: img/fuelwsrepsst.png
601 #. Set up targets for provisioning with non-default "Offloading Modes"
603 Some target nodes may require additional configuration after they are
604 PXE booted (bootstrapped); the most frequent changes are in defaults
605 for ethernet devices' "Offloading Modes" settings (e.g. some targets'
606 ethernet drivers may strip VLAN traffic by default).
608 If your target ethernet drivers have wrong "Offloading Modes" defaults,
609 in "Configure interfaces" page (described above), expand affected
610 interface's "Offloading Modes" and [un]check the relevant settings
613 .. figure:: img/offloadingmodes.png
615 #. Set up targets for "Verify Networks" with non-default "Offloading Modes"
617 **NOTE**: Check *Reference 15* for an updated and comprehensive list of
618 known issues and/or limitations, including "Offloading Modes" not being
619 applied during "Verify Networks" step.
621 Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
622 during provisiong and **not** during "Verify Networks", so if your targets
623 need this change, you have to apply "Offloading Modes" settings by hand
624 to bootstrapped nodes.
626 **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
627 the Openstack interface(s) "eth1", preventing VLAN traffic from passing
628 during "Verify Networks".
630 - From Fuel master console identify target nodes admin IPs (see figure below):
636 .. figure:: img/fuelconsole1.png
638 - SSH into each of the target nodes and disable "rx-vlan-filter" on the
639 affected physical interface(s) allocated for OpenStack traffic (eth1):
643 $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
645 - Repeat the step above for all affected nodes/interfaces in the POD.
650 It is important that the Verify Networks action is performed as it will verify
651 that communicate works for the networks you have setup, as well as check that
652 packages needed for a successful deployment can be fetched.
654 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
656 - Select <Verify Networks>
658 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
660 .. figure:: img/verifynet.png
662 Deploy Your Environment
663 =======================
665 #. Deploy the environment.
667 - In the Fuel GUI, click on the "Dashboard" Tab.
669 - Click on <Deploy Changes> in the "Ready to Deploy?" section
671 - Examine any information notice that pops up and click <Deploy>
673 Wait for your deployment to complete, you can view the "Dashboard"
674 Tab to see the progress and status of your deployment.
676 =========================
677 Installation health-check
678 =========================
680 #. Perform system health-check (see figure below)
682 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
684 - Check <Select All> and Click <Run Tests>
686 - Allow tests to run and investigate results where appropriate
688 - Check *Reference 15* for known issues / limitations on AArch64
690 .. figure:: img/health.png
699 1) `OPNFV Home Page <http://www.opnfv.org>`_: http://www.opnfv.org
701 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_: https://www.opnfv.org/software/download
706 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_: http://www.openstack.org/software/mitaka
708 4) `OpenStack documentation <http://docs.openstack.org>`_: http://docs.openstack.org
713 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_: http://www.opendaylight.org/software/downloads
718 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
720 7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
722 8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
724 9) `Fuel QuickStart Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_: https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html
726 10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
728 11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
730 12) `(N/A on AArch64) Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
735 13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html
737 14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html
739 15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html