1 ========================================================================================================
2 OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
3 ========================================================================================================
5 .. contents:: Table of Contents
11 This work is licensed under a Creative Commons Attribution 4.0 International
12 License. .. http://creativecommons.org/licenses/by/4.0 ..
13 (c) Jonas Bjurel (Ericsson AB) and others
18 This document describes how to install the Brahmaputra release of
19 OPNFV when using Fuel as a deployment tool, covering it's usage,
20 limitations, dependencies and required system resources.
25 This document provides guidelines on how to install and
26 configure the Brahmaputra release of OPNFV when using Fuel as a
27 deployment tool, including required software and hardware configurations.
29 Although the available installation options give a high degree of
30 freedom in how the system is set-up, including architecture, services
31 and features, etc., said permutations may not provide an OPNFV
32 compliant reference architecture. This instruction provides a
33 step-by-step guide that results in an OPNFV Brahmaputra compliant
36 The audience of this document is assumed to have good knowledge in
37 networking and Unix/Linux administration.
41 Before starting the installation of the Brahmaputra release of
42 OPNFV, using Fuel as a deployment tool, some planning must be
45 Retrieving the ISO image
46 ------------------------
48 First of all, the Fuel deployment ISO image needs to be retrieved, the
49 Fuel .iso image of the Brahmaputra release can be found at *Reference: 2*
51 Building the ISO image
52 ----------------------
54 Alternatively, you may build the Fuel .iso from source by cloning the
55 opnfv/fuel git repository. To retrieve the repository for the Brahmaputra release use the following command:
57 $git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel
59 Check-out the Brahmaputra release tag to set the branch to the
60 baseline required to replicate the Brahmaputra release:
62 $ git checkout brahmaputra.1.0
64 Go to the fuel directory and build the .iso:
66 $ cd fuel/build; make all
68 For more information on how to build, please see *Reference: 14*
73 Next, familiarize yourself with Fuel by reading the following documents:
75 - Fuel planning guide, please see *Reference: 8*
77 - Fuel user guide, please see *Reference: 9*
79 - Fuel operations guide, please see *Reference: 10*
81 - Fuel Plugin Developers Guide, please see *Reference: 11*
83 Prior to installation, a number of deployment specific parameters must be collected, those are:
85 #. Provider sub-net and gateway information
87 #. Provider VLAN information
89 #. Provider DNS addresses
91 #. Provider NTP addresses
93 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
95 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
97 #. Monitoring options you want to deploy (Ceilometer, Syslog, erc.).
99 #. Other options not covered in the document are available in the links above
102 This information will be needed for the configuration procedures
103 provided in this document.
105 Hardware requirements
106 =====================
108 The following minimum hardware requirements must be met for the
109 installation of Brahmaputra using Fuel:
111 +--------------------+------------------------------------------------------+
112 | **HW Aspect** | **Requirement** |
114 +--------------------+------------------------------------------------------+
115 | **# of nodes** | Minimum 5 (3 for non redundant deployment): |
117 | | - 1 Fuel deployment master (may be virtualized) |
119 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
120 | | role, 2 Ceph-OSD roles) |
122 | | - 1 Compute (1 co-located Ceph-OSD role) |
124 +--------------------+------------------------------------------------------+
125 | **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
127 +--------------------+------------------------------------------------------+
128 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
130 +--------------------+------------------------------------------------------+
131 | **Disk** | Minimum 256GB 10kRPM spinning disks |
133 +--------------------+------------------------------------------------------+
134 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
136 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
138 | | Note: These can be allocated to a single NIC - |
139 | | or spread out over multiple NICs as your hardware |
141 +--------------------+------------------------------------------------------+
143 Help with Hardware Requirements
144 ===============================
146 Calculate hardware requirements:
148 For information on compatible hardware types available for use, please see *Reference: 11*.
150 When choosing the hardware on which you will deploy your OpenStack
151 environment, you should think about:
153 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
155 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
157 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
159 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
162 Top of the rack (TOR) Configuration requirements
163 ================================================
165 The switching infrastructure provides connectivity for the OPNFV
166 infrastructure operations, tenant networks (East/West) and provider
167 connectivity (North/South); it also provides needed connectivity for
168 the Storage Area Network (SAN).
169 To avoid traffic congestion, it is strongly suggested that three
170 physically separated networks are used, that is: 1 physical network
171 for administration and control, one physical network for tenant private
172 and public networks, and one physical network for SAN.
173 The switching connectivity can (but does not need to) be fully redundant,
174 in such case it comprises a redundant 10GE switch pair for each of the
175 three physically separated networks.
177 The physical TOR switches are **not** automatically configured from
178 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
179 infrastructure as well as the provider networks and the private tenant
180 VLANs needs to be manually configured.
182 Manual configuration of the Brahmaputra hardware platform should
183 be carried out according to the OPNFV Pharos specification:
184 <https://wiki.opnfv.org/pharos/pharos_specification>
186 OPNFV Software installation and deployment
187 ==========================================
189 This section describes the installation of the OPNFV installation
190 server (Fuel master) as well as the deployment of the full OPNFV
191 reference platform stack across a server cluster.
195 #. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
197 #. Reboot the jump host to establish the Fuel server.
199 - The system now boots from the ISO image.
201 - Select "Fuel Install (Static IP)" (See figure below)
205 .. figure:: img/grub-1.png
207 #. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
209 #. In the "Fuel User" section - Confirm/change the default password (See figure below)
211 - Enter "admin" in the Fuel password input
213 - Enter "admin" in the Confirm password input
215 - Select "Check" and press [Enter]
217 .. figure:: img/fuelmenu1.png
219 #. 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).
221 - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
223 .. figure:: img/fuelmenu2.png
225 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
227 - DHCP Pool Start 10.20.0.3
229 - DHCP Pool End 10.20.0.254
231 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
233 .. figure:: img/fuelmenu3.png
235 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
245 - Hostname to test DNS
247 - Select <Check> and press [Enter]
249 .. figure:: img/fuelmenu4.png
252 #. 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)
254 - Navigate to "HTTP proxy" and enter your http proxy address
256 - Select <Check> and press [Enter]
258 .. figure:: img/fuelmenu5.png
260 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
262 - NTP Server 1 <Customer NTP server 1>
264 - NTP Server 2 <Customer NTP server 2>
266 - NTP Server 3 <Customer NTP server 3>
268 .. figure:: img/fuelmenu6.png
270 #. Start the installation.
272 - Select Quit Setup and press Save and Quit.
274 - Installation starts, wait until the login screen is shown.
277 Boot the Node Servers
278 ---------------------
280 After the Fuel Master node has rebooted from the above steps and is at
281 the login prompt, you should boot the Node Servers (Your
282 Compute/Control/Storage blades (nested or real) with a PXE booting
283 scheme so that the FUEL Master can pick them up for control.
285 #. Enable PXE booting
287 - 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.
289 #. Reboot all the control and compute blades.
291 #. Wait for the availability of nodes showing up in the Fuel GUI.
293 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
295 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
297 .. figure:: img/nodes.png
300 Install additional Plugins/Features on the FUEL node
301 ----------------------------------------------------
303 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
305 #. Select wanted plugins/features from the /opt/opnfv/ directory.
307 #. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm"
308 Expected output: "Plugin ....... was successfully installed." (see figure below)
310 .. figure:: img/plugin_install.png
312 Create an OpenStack Environment
313 -------------------------------
315 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
317 #. Create and name a new OpenStack environment, to be installed.
319 .. figure:: img/newenv.png
321 #. Select "<Liberty on Ubuntu 14.04>" and press <Next>
323 #. Select "compute virtulization method".
325 - Select "QEMU-KVM as hypervisor" and press <Next>
327 #. Select "network mode".
329 - Select "Neutron with ML2 plugin"
331 - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
335 #. Select "Storage Back-ends".
337 - Select "Ceph for block storage" and press <Next>
339 #. Select "additional services" you wish to install.
341 - Check option "Install Celiometer (OpenStack Telemetry)" and press <Next>
343 #. Create the new environment.
345 - Click <Create> Button
347 Configure the network environment
348 ---------------------------------
350 #. Open the environment you previously created.
352 #. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
354 .. figure:: img/network.png
356 #. Update the Public network configuration and change the following fields to appropriate values:
358 - CIDR to <CIDR for Public IP Addresses>
360 - IP Range Start to <Public IP Address start>
362 - IP Range End to <Public IP Address end>
364 - Gateway to <Gateway for Public IP Addresses>
366 - Check <VLAN tagging>.
368 - Set appropriate VLAN id.
370 #. Update the Storage Network Configuration
372 - Set CIDR to appropriate value (default 192.168.1.0/24)
374 - Set IP Range Start to appropriate value (default 192.168.1.1)
376 - Set IP Range End to appropriate value (default 192.168.1.254)
378 - Set vlan to appropriate value (default 102)
380 #. Update the Management network configuration.
382 - Set CIDR to appropriate value (default 192.168.0.0/24)
384 - Set IP Range Start to appropriate value (default 192.168.0.1)
386 - Set IP Range End to appropriate value (default 192.168.0.254)
388 - Check <VLAN tagging>.
390 - Set appropriate VLAN id. (default 101)
392 #. Update the Private Network Information
394 - Set CIDR to appropriate value (default 192.168.2.0/24
396 - Set IP Range Start to appropriate value (default 192.168.2.1)
398 - Set IP Range End to appropriate value (default 192.168.2.254)
400 - Check <VLAN tagging>.
402 - Set appropriate VLAN tag (default 103)
404 #. Select the "Neutron L3 Node Networks group" on the left pane.
406 .. figure:: img/neutronl3.png
408 #. Update the Floating Network configuration.
410 - Set the Floating IP range start (default 172.16.0.130)
412 - Set the Floating IP range end (default 172.16.0.254)
414 - Set the Floating network name (default admin_floating_net)
416 #. Update the Internal Network configuration.
418 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
420 - Set Internal network gateway to an appropriate value
422 - Set the Internal network name (default admin_internal_net)
424 #. Update the Guest OS DNS servers.
426 - Set Guest OS DNS Server values appropriately
430 #. Select the "Other Node Networks group" on the left pane(see figure below).
432 .. figure:: img/other.png
434 #. Update the Public network assignment.
436 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
438 #. Update Host OS DNS Servers.
440 - Provide the DNS server settings
442 #. Update Host OS NTP Servers.
444 - Provide the NTP server settings
446 Select Hypervisor type
447 ----------------------
449 #. In the FUEL UI of your Environment, click the "Settings" Tab
451 #. Select Compute on the left side pane (see figure below)
453 - Check the KVM box and press "Save settings"
455 .. figure:: img/compute.png
460 #. In the FUEL UI of your Environment, click the "Settings" Tab
462 #. Select Other on the left side pane (see figure below)
464 - Enable and configure the plugins of your choice
466 .. figure:: img/plugins.png
468 Allocate nodes to environment and assign functional roles
469 ---------------------------------------------------------
471 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
473 .. figure:: img/addnodes.png
475 #. Assign roles (see figure below).
477 - Click on the <+Add Nodes> button
479 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the Assign Roles Section.
481 - Check one node which you want to act as a Controller from the bottom half of the screen
483 - Click <Apply Changes>.
485 - Click on the <+Add Nodes> button
487 - Check the <Controller> and <Storage - Ceph OSD> roles.
489 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
491 - Click <Apply Changes>
493 - Click on <+Add Nodes> button
495 - Check the <Compute> and <Storage - Ceph OSD> roles.
497 - Check the Nodes you want to act as Computes from the bottom half of the screen
499 - Click <Apply Changes>.
501 .. figure:: img/computelist.png
503 #. Configure interfaces (see figure below).
505 - Check Select <All> to select all allocated nodes
507 - Click <Configure Interfaces>
509 - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
514 .. figure:: img/interfaceconf.png
517 OPTIONAL - Set Local Mirror Repos
518 ---------------------------------
520 The following steps can be executed if you are in an environment with
521 no connection to the Internet. The Fuel server delivers a local repo
522 that can be used for installation / deployment of openstack.
524 #. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
526 - Replace the URI values for the "Name" values outlined below:
528 - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main"
530 - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main"
532 - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main"
534 - "mos" URI="deb http://<ip-of-fuel-server>::8080/liberty-8.0/ubuntu/x86_64 mos8.0 main restricted"
536 - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/liberty-8.0/ubuntu/auxiliary auxiliary main restricted"
538 - Click <Save Settings> at the bottom to Save your changes
543 It is important that the Verify Networks action is performed as it will verify
544 that communicate works for the networks you have setup, as well as check that
545 packages needed for a successful deployment can be fetched.
547 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
549 - Select <Verify Networks>
551 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
553 .. figure:: img/verifynet.png
556 Deploy Your Environment
557 -----------------------
559 38. Deploy the environment.
561 - In the Fuel GUI, click on the "Dashboard" Tab.
563 - Click on <Deploy Changes> in the "Ready to Deploy?" section
565 - Examine any information notice that pops up and click <Deploy>
567 Wait for your deployment to complete, you can view the "Dashboard"
568 Tab to see the progress and status of your deployment.
570 Installation health-check
571 =========================
573 #. Perform system health-check (see figure below)
575 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
577 - Check <Select All> and Click <Run Tests>
579 - Allow tests to run and investigate results where appropriate
581 .. figure:: img/health.png
589 1) `OPNFV Home Page <www.opnfv.org>`_
591 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
596 3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
598 4) `OpenStack documentation <http://docs.openstack.org>`_
603 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
608 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
610 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
612 8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
614 9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
616 10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
618 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
620 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
625 13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
627 14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
629 15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool