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 node pool.
21 This document provides guidelines on how to install and
22 configure the Brahmaputra 3.0 release of OPNFV when using Fuel as a
23 deployment tool, with an AArch64 (only) target node pool,
24 including required software and hardware configurations.
26 Although the available installation options give a high degree of
27 freedom in how the system is set-up, including architecture, services
28 and features, etc., said permutations may not provide an OPNFV
29 compliant reference architecture. This instruction provides a
30 step-by-step guide that results in an OPNFV Brahmaputra compliant
33 The audience of this document is assumed to have good knowledge in
34 networking and Unix/Linux administration.
38 Before starting the installation of the AArch64 Brahmaputra 3.0 release of
39 OPNFV, using Fuel as a deployment tool, some planning must be
42 Retrieving the ISO image
43 ------------------------
45 First of all, the Fuel deployment ISO image needs to be retrieved, the
46 Fuel .iso image of the AArch64 Brahmaputra release can be found at *Reference: 2*
48 Building the ISO image
49 ----------------------
51 Alternatively, you may build the .iso from source by cloning the
52 opnfv/armband git repository. To retrieve the repository for the AArch64 Brahmaputra 3.0 release use the following command:
54 $git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/armband
56 Check-out the Brahmaputra stable branch to set the branch to the
57 baseline required to replicate the Brahmaputra release:
59 $ git checkout stable/brahmaputra
61 Go to the armband directory and build the .iso:
63 $ cd armband; make release
65 For more information on how to build, please see *Reference: 14*
71 Next, familiarize yourself with Fuel by reading the following documents:
73 - Fuel planning guide, please see *Reference: 8*
75 - Fuel user guide, please see *Reference: 9*
77 - Fuel operations guide, please see *Reference: 10*
79 - Fuel Plugin Developers Guide, please see *Reference: 11*
81 Prior to installation, a number of deployment specific parameters must be collected, those are:
83 #. Provider sub-net and gateway information
85 #. Provider VLAN information
87 #. Provider DNS addresses
89 #. Provider NTP addresses
91 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
93 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
95 #. Monitoring options you want to deploy (Ceilometer, Syslog, erc.).
97 #. Other options not covered in the document are available in the links above
100 This information will be needed for the configuration procedures
101 provided in this document.
103 Hardware requirements
104 =====================
106 The following minimum hardware requirements must be met for the
107 installation of Brahmaputra using Fuel:
109 +--------------------+------------------------------------------------------+
110 | **HW Aspect** | **Requirement** |
112 +====================+======================================================+
113 | **# of nodes** | Minimum 5 (3 for non redundant deployment): |
115 | | - 1 Fuel deployment master (may be virtualized) |
117 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
118 | | role, 2 Ceph-OSD roles) |
120 | | - 1 Compute (1 co-located Ceph-OSD role) |
122 +--------------------+------------------------------------------------------+
123 | **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
125 +--------------------+------------------------------------------------------+
126 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
128 +--------------------+------------------------------------------------------+
129 | **Disk** | Minimum 256GB 10kRPM spinning disks |
131 +--------------------+------------------------------------------------------+
132 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
134 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
136 | | Note: These can be allocated to a single NIC - |
137 | | or spread out over multiple NICs as your hardware |
139 +--------------------+------------------------------------------------------+
141 Help with Hardware Requirements
142 ===============================
144 Calculate hardware requirements:
146 For information on compatible hardware types available for use, please see *Reference: 11*.
148 When choosing the hardware on which you will deploy your OpenStack
149 environment, you should think about:
151 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
153 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
155 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
157 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
160 Top of the rack (TOR) Configuration requirements
161 ================================================
163 The switching infrastructure provides connectivity for the OPNFV
164 infrastructure operations, tenant networks (East/West) and provider
165 connectivity (North/South); it also provides needed connectivity for
166 the Storage Area Network (SAN).
167 To avoid traffic congestion, it is strongly suggested that three
168 physically separated networks are used, that is: 1 physical network
169 for administration and control, one physical network for tenant private
170 and public networks, and one physical network for SAN.
171 The switching connectivity can (but does not need to) be fully redundant,
172 in such case it comprises a redundant 10GE switch pair for each of the
173 three physically separated networks.
175 The physical TOR switches are **not** automatically configured from
176 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
177 infrastructure as well as the provider networks and the private tenant
178 VLANs needs to be manually configured.
180 Manual configuration of the Brahmaputra hardware platform should
181 be carried out according to the OPNFV Pharos specification:
182 <https://wiki.opnfv.org/pharos/pharos_specification>
184 OPNFV Software installation and deployment
185 ==========================================
187 This section describes the installation of the OPNFV installation
188 server (Fuel master) as well as the deployment of the full OPNFV
189 reference platform stack across a server cluster.
193 #. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
195 #. Reboot the jump host to establish the Fuel server.
197 - The system now boots from the ISO image.
199 - Select "Fuel Install (Static IP)" (See figure below)
203 .. figure:: img/grub-1.png
205 #. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
207 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
209 - Enter "admin" in the Fuel password input
211 - Enter "admin" in the Confirm password input
213 - Select "Check" and press [Enter]
215 .. figure:: img/fuelmenu1.png
217 #. 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).
219 - Configuration of ETH1 interface for connectivity into your corporate/lab network is mandatory. You need to have internet access over this interface.
220 Due to the architecture of ports.ubuntu.com mirror, currently Fuel cannot create a full local mirror of all required AArch64 packages. Internet access is needed to deploy with Fuel on AArch64 nodes.
222 .. figure:: img/fuelmenu2.png
224 .. figure:: img/fuelmenu2a.png
226 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
228 - DHCP Pool Start 10.20.0.3
230 - DHCP Pool End 10.20.0.254
232 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
234 .. figure:: img/fuelmenu3.png
236 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
246 - Hostname to test DNS
248 - Select <Check> and press [Enter]
250 .. figure:: img/fuelmenu4.png
253 #. 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)
255 - Navigate to "HTTP proxy" and enter your http proxy address
257 - Select <Check> and press [Enter]
259 .. figure:: img/fuelmenu5.png
261 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
263 - NTP Server 1 <Customer NTP server 1>
265 - NTP Server 2 <Customer NTP server 2>
267 - NTP Server 3 <Customer NTP server 3>
269 .. figure:: img/fuelmenu6.png
271 #. Start the installation.
273 - Select Quit Setup and press Save and Quit.
275 - Installation starts, wait until the login screen is shown.
278 Boot the Node Servers
279 ---------------------
281 After the Fuel Master node has rebooted from the above steps and is at
282 the login prompt, you should boot the Node Servers (Your
283 Compute/Control/Storage blades (nested or real) with a PXE booting
284 scheme so that the FUEL Master can pick them up for control.
286 #. Enable PXE booting
288 - 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.
290 #. Reboot all the control and compute blades.
292 #. Wait for the availability of nodes showing up in the Fuel GUI.
294 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
296 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
298 .. figure:: img/nodes.png
301 Target specific configuration
302 -----------------------------
306 For these targets, "rx-vlan-filter" offloading has to be turned off on the interface destined for OpenStack traffic (not the interface used for PXE boot).
307 For now this setting cannot be toggled from Fuel GUI, so it has to be done form the console.
309 - From Fuel master console identify target nodes admin IPs (see figure below).
311 .. figure:: img/fuelconsole1.png
313 - SSH into each of the target nodes and disable rx-vlan-filter on the physical interface allocated for OpenStack traffic (see figure below).
315 .. figure:: img/softiron1.png
317 - Repeat the step above for all AMD Softiron nodes in the POD.
320 Install additional Plugins/Features on the FUEL node
321 ----------------------------------------------------
323 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
325 #. Select wanted plugins/features from the /opt/opnfv/ directory.
327 #. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm"
328 Expected output: "Plugin ....... was successfully installed." (see figure below)
330 .. figure:: img/plugin_install.png
332 Create an OpenStack Environment
333 -------------------------------
335 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
337 #. Create and name a new OpenStack environment, to be installed.
339 .. figure:: img/newenv.png
341 #. Select "<Liberty on Ubuntu 14.04 (aarch64)>" and press <Next>
343 #. Select "compute virtulization method".
345 - Select "QEMU-KVM as hypervisor" and press <Next>
347 #. Select "network mode".
349 - Select "Neutron with ML2 plugin"
351 - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
355 #. Select "Storage Back-ends".
357 - Select "Ceph for block storage" and press <Next>
359 #. Select "additional services" you wish to install.
361 - Check option "Install Celiometer (OpenStack Telemetry)" and press <Next>
363 #. Create the new environment.
365 - Click <Create> Button
367 Configure the network environment
368 ---------------------------------
370 #. Open the environment you previously created.
372 #. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
374 .. figure:: img/network.png
376 #. Update the Public network configuration and change the following fields to appropriate values:
378 - CIDR to <CIDR for Public IP Addresses>
380 - IP Range Start to <Public IP Address start>
382 - IP Range End to <Public IP Address end>
384 - Gateway to <Gateway for Public IP Addresses>
386 - Check <VLAN tagging>.
388 - Set appropriate VLAN id.
390 #. Update the Storage Network Configuration
392 - Set CIDR to appropriate value (default 192.168.1.0/24)
394 - Set IP Range Start to appropriate value (default 192.168.1.1)
396 - Set IP Range End to appropriate value (default 192.168.1.254)
398 - Set vlan to appropriate value (default 102)
400 #. Update the Management network configuration.
402 - Set CIDR to appropriate value (default 192.168.0.0/24)
404 - Set IP Range Start to appropriate value (default 192.168.0.1)
406 - Set IP Range End to appropriate value (default 192.168.0.254)
408 - Check <VLAN tagging>.
410 - Set appropriate VLAN id. (default 101)
412 #. Update the Private Network Information
414 - Set CIDR to appropriate value (default 192.168.2.0/24
416 - Set IP Range Start to appropriate value (default 192.168.2.1)
418 - Set IP Range End to appropriate value (default 192.168.2.254)
420 - Check <VLAN tagging>.
422 - Set appropriate VLAN tag (default 103)
424 #. Select the "Neutron L3 Node Networks group" on the left pane.
426 .. figure:: img/neutronl3.png
428 #. Update the Floating Network configuration.
430 - Set the Floating IP range start (default 172.16.0.130)
432 - Set the Floating IP range end (default 172.16.0.254)
434 - Set the Floating network name (default admin_floating_net)
436 #. Update the Internal Network configuration.
438 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
440 - Set Internal network gateway to an appropriate value
442 - Set the Internal network name (default admin_internal_net)
444 #. Update the Guest OS DNS servers.
446 - Set Guest OS DNS Server values appropriately
450 #. Select the "Other Node Networks group" on the left pane(see figure below).
452 .. figure:: img/other.png
454 #. Update the Public network assignment.
456 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
458 #. Update Host OS DNS Servers.
460 - Provide the DNS server settings
462 #. Update Host OS NTP Servers.
464 - Provide the NTP server settings
466 Select Hypervisor type
467 ----------------------
469 #. In the FUEL UI of your Environment, click the "Settings" Tab
471 #. Select Compute on the left side pane (see figure below)
473 - Check the KVM box and press "Save settings"
475 .. figure:: img/compute.png
480 #. In the FUEL UI of your Environment, click the "Settings" Tab
482 #. Select Other on the left side pane (see figure below)
484 - Enable and configure the plugins of your choice
486 .. figure:: img/plugins.png
488 Allocate nodes to environment and assign functional roles
489 ---------------------------------------------------------
491 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
493 .. figure:: img/addnodes.png
495 #. Assign roles (see figure below).
497 - Click on the <+Add Nodes> button
499 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the Assign Roles Section.
501 - Check one node which you want to act as a Controller from the bottom half of the screen
503 - Click <Apply Changes>.
505 - Click on the <+Add Nodes> button
507 - Check the <Controller> and <Storage - Ceph OSD> roles.
509 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
511 - Click <Apply Changes>
513 - Click on <+Add Nodes> button
515 - Check the <Compute> and <Storage - Ceph OSD> roles.
517 - Check the Nodes you want to act as Computes from the bottom half of the screen
519 - Click <Apply Changes>.
521 .. figure:: img/computelist.png
523 #. Configure interfaces (see figure below).
525 - Check Select <All> to select all allocated nodes
527 - Click <Configure Interfaces>
529 - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
534 .. figure:: img/interfaceconf.png
537 OPTIONAL - Set Local Mirror Repos
538 ---------------------------------
540 The following steps can be executed if you are in an environment with
541 no connection to the Internet. The Fuel server delivers a local repo
542 that can be used for installation / deployment of openstack.
544 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
546 - Replace the URI values for the "Name" values outlined below:
548 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
550 - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main"
552 - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
554 - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
556 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
558 - Click <Save Settings> at the bottom to Save your changes
563 It is important that the Verify Networks action is performed as it will verify
564 that communicate works for the networks you have setup, as well as check that
565 packages needed for a successful deployment can be fetched.
567 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
569 - Select <Verify Networks>
571 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
573 .. figure:: img/verifynet.png
576 Deploy Your Environment
577 -----------------------
579 38. Deploy the environment.
581 - In the Fuel GUI, click on the "Dashboard" Tab.
583 - Click on <Deploy Changes> in the "Ready to Deploy?" section
585 - Examine any information notice that pops up and click <Deploy>
587 Wait for your deployment to complete, you can view the "Dashboard"
588 Tab to see the progress and status of your deployment.
590 Installation health-check
591 =========================
593 #. Perform system health-check (see figure below)
595 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
597 - Check <Select All> and Click <Run Tests>
599 - Allow tests to run and investigate results where appropriate
601 .. figure:: img/health.png
609 1) `OPNFV Home Page <www.opnfv.org>`_
611 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
616 3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
618 4) `OpenStack documentation <http://docs.openstack.org>`_
623 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
627 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
629 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
631 8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
633 9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
635 10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
637 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
639 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
644 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>`_
646 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>`_
648 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>`_