1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Open Platform for NFV Project, Inc. and its contributors
9 This document describes how to install the Danube release of
10 OPNFV when using Fuel as a deployment tool, covering its usage,
11 limitations, dependencies and required system resources.
17 This document provides guidelines on how to install and
18 configure the Danube release of OPNFV when using Fuel as a
19 deployment tool, including required software and hardware configurations.
21 Although the available installation options give a high degree of
22 freedom in how the system is set-up, including architecture, services
23 and features, etc., said permutations may not provide an OPNFV
24 compliant reference architecture. This instruction provides a
25 step-by-step guide that results in an OPNFV Danube compliant
28 The audience of this document is assumed to have good knowledge in
29 networking and Unix/Linux administration.
35 Before starting the installation of the Danube release of
36 OPNFV, using Fuel as a deployment tool, some planning must be
39 Retrieving the ISO image
40 ========================
42 First of all, the Fuel deployment ISO image needs to be retrieved, the
43 Fuel .iso image of the Danube release can be found at `OPNFV Downloads <https://www.opnfv.org/software/download>`_.
45 Building the ISO image
46 ======================
48 Alternatively, you may build the Fuel .iso from source by cloning the
49 opnfv/fuel git repository. To retrieve the repository for the Danube
50 release use the following command:
54 $ git clone https://gerrit.opnfv.org/gerrit/fuel
56 Check-out the Danube release tag to set the HEAD to the
57 baseline required to replicate the Danube release:
61 $ git checkout danube.2.0
63 Go to the fuel directory and build the .iso:
67 $ cd fuel/build; make all
69 For more information on how to build, please see :ref:`Build instruction for Fuel\@OPNFV <fuel-development-overview-build-label>`
74 Next, familiarize yourself with Fuel by reading the following documents:
76 - `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
78 - `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
80 - `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
82 - `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
84 Prior to installation, a number of deployment specific parameters must be collected, those are:
86 #. Provider sub-net and gateway information
88 #. Provider VLAN information
90 #. Provider DNS addresses
92 #. Provider NTP addresses
94 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
96 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
98 #. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
100 #. Other options not covered in the document are available in the links above
103 This information will be needed for the configuration procedures
104 provided in this document.
106 =====================
107 Hardware requirements
108 =====================
110 The following minimum hardware requirements must be met for the
111 installation of Danube using Fuel:
113 +--------------------+------------------------------------------------------+
114 | **HW Aspect** | **Requirement** |
116 +====================+======================================================+
117 | **# of nodes** | Minimum 5 (3 for non redundant deployment): |
119 | | - 1 Fuel deployment master (may be virtualized) |
121 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
122 | | role, 2 Ceph-OSD roles) |
124 | | - 1 Compute (1 co-located Ceph-OSD role) |
126 +--------------------+------------------------------------------------------+
127 | **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
129 +--------------------+------------------------------------------------------+
130 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
132 +--------------------+------------------------------------------------------+
133 | **Disk** | Minimum 256GB 10kRPM spinning disks |
135 +--------------------+------------------------------------------------------+
136 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
138 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
140 | | Note: These can be allocated to a single NIC - |
141 | | or spread out over multiple NICs as your hardware |
143 +--------------------+------------------------------------------------------+
145 ===============================
146 Help with Hardware Requirements
147 ===============================
149 Calculate hardware requirements:
151 For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_.
153 When choosing the hardware on which you will deploy your OpenStack
154 environment, you should think about:
156 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
158 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
160 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
162 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
164 ================================================
165 Top of the rack (TOR) Configuration requirements
166 ================================================
168 The switching infrastructure provides connectivity for the OPNFV
169 infrastructure operations, tenant networks (East/West) and provider
170 connectivity (North/South); it also provides needed connectivity for
171 the Storage Area Network (SAN).
172 To avoid traffic congestion, it is strongly suggested that three
173 physically separated networks are used, that is: 1 physical network
174 for administration and control, one physical network for tenant private
175 and public networks, and one physical network for SAN.
176 The switching connectivity can (but does not need to) be fully redundant,
177 in such case it comprises a redundant 10GE switch pair for each of the
178 three physically separated networks.
180 The physical TOR switches are **not** automatically configured from
181 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
182 infrastructure as well as the provider networks and the private tenant
183 VLANs needs to be manually configured.
185 Manual configuration of the Danube hardware platform should
186 be carried out according to the `OPNFV Pharos Specification
187 <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
189 ==========================================
190 OPNFV Software installation and deployment
191 ==========================================
193 This section describes the installation of the OPNFV installation
194 server (Fuel master) as well as the deployment of the full OPNFV
195 reference platform stack across a server cluster.
200 #. Mount the Danube 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 the Fuel setup screen 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 in your corporate/lab network (see figure below).
226 - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
228 .. figure:: img/fuelmenu2.png
230 #. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
232 - DHCP Pool Start 10.20.0.4
234 - DHCP Pool End 10.20.0.254
236 - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
238 .. figure:: img/fuelmenu3.png
240 #. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
250 - Hostname to test DNS
252 - Select <Check> and press [Enter]
254 .. figure:: img/fuelmenu4.png
257 #. 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)
259 - Navigate to "HTTP proxy" and enter your http proxy address
261 - Select <Check> and press [Enter]
263 .. figure:: img/fuelmenu5.png
265 #. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
267 - NTP Server 1 <Customer NTP server 1>
269 - NTP Server 2 <Customer NTP server 2>
271 - NTP Server 3 <Customer NTP server 3>
273 .. figure:: img/fuelmenu6.png
275 #. Start the installation.
277 - Select Quit Setup and press Save and Quit.
279 - The installation will now start, wait until the login screen is shown.
281 Boot the Node Servers
282 =====================
284 After the Fuel Master node has rebooted from the above steps and is at
285 the login prompt, you should boot the Node Servers (Your
286 Compute/Control/Storage blades, nested or real) with a PXE booting
287 scheme so that the FUEL Master can pick them up for control.
289 #. Enable PXE booting
291 - 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.
293 #. Reboot all the control and compute blades.
295 #. Wait for the availability of nodes showing up in the Fuel GUI.
297 - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
299 - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
301 .. figure:: img/nodes.png
303 Install additional Plugins/Features on the FUEL node
304 ====================================================
306 #. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
308 #. Select wanted plugins/features from the /opt/opnfv/ directory.
310 #. Install the wanted plugin with the command
314 $ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
316 Expected output (see figure below):
320 Plugin ....... was successfully installed.
322 .. figure:: img/plugin_install.png
324 Create an OpenStack Environment
325 ===============================
327 #. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin)
329 #. Create and name a new OpenStack environment, to be installed.
331 .. figure:: img/newenv.png
333 #. Select "<Mitaka on Ubuntu 14.04>" and press <Next>
335 #. Select "compute virtulization method".
337 - Select "QEMU-KVM as hypervisor" and press <Next>
339 #. Select "network mode".
341 - Select "Neutron with ML2 plugin"
343 - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
347 #. Select "Storage Back-ends".
349 - Select "Ceph for block storage" and press <Next>
351 #. Select "additional services" you wish to install.
353 - Check option "Install Ceilometer and Aodh" and press <Next>
355 #. Create the new environment.
357 - Click <Create> Button
359 Configure the network environment
360 =================================
362 #. Open the environment you previously created.
364 #. Open the networks tab and select the "default" Node Networks group to on the left pane (see figure below).
366 .. figure:: img/network.png
368 #. Update the Public network configuration and change the following fields to appropriate values:
370 - CIDR to <CIDR for Public IP Addresses>
372 - IP Range Start to <Public IP Address start>
374 - IP Range End to <Public IP Address end>
376 - Gateway to <Gateway for Public IP Addresses>
378 - Check <VLAN tagging>.
380 - Set appropriate VLAN id.
382 #. Update the Storage Network Configuration
384 - Set CIDR to appropriate value (default 192.168.1.0/24)
386 - Set IP Range Start to appropriate value (default 192.168.1.1)
388 - Set IP Range End to appropriate value (default 192.168.1.254)
390 - Set vlan to appropriate value (default 102)
392 #. Update the Management network configuration.
394 - Set CIDR to appropriate value (default 192.168.0.0/24)
396 - Set IP Range Start to appropriate value (default 192.168.0.1)
398 - Set IP Range End to appropriate value (default 192.168.0.254)
400 - Check <VLAN tagging>.
402 - Set appropriate VLAN id. (default 101)
404 #. Update the Private Network Information
406 - Set CIDR to appropriate value (default 192.168.2.0/24
408 - Set IP Range Start to appropriate value (default 192.168.2.1)
410 - Set IP Range End to appropriate value (default 192.168.2.254)
412 - Check <VLAN tagging>.
414 - Set appropriate VLAN tag (default 103)
416 #. Select the "Neutron L3" Node Networks group on the left pane.
418 .. figure:: img/neutronl3.png
420 #. Update the Floating Network configuration.
422 - Set the Floating IP range start (default 172.16.0.130)
424 - Set the Floating IP range end (default 172.16.0.254)
426 - Set the Floating network name (default admin_floating_net)
428 #. Update the Internal Network configuration.
430 - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
432 - Set Internal network gateway to an appropriate value
434 - Set the Internal network name (default admin_internal_net)
436 #. Update the Guest OS DNS servers.
438 - Set Guest OS DNS Server values appropriately
442 #. Select the "Other" Node Networks group on the left pane (see figure below).
444 .. figure:: img/other.png
446 #. Update the Public network assignment.
448 - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
450 #. Update Host OS DNS Servers.
452 - Provide the DNS server settings
454 #. Update Host OS NTP Servers.
456 - Provide the NTP server settings
458 Select Hypervisor type
459 ======================
461 #. In the FUEL UI of your Environment, click the "Settings" Tab
463 #. Select "Compute" on the left side pane (see figure below)
465 - Check the KVM box and press "Save settings"
467 .. figure:: img/compute.png
472 #. In the FUEL UI of your Environment, click the "Settings" Tab
474 #. Select Other on the left side pane (see figure below)
476 - Enable and configure the plugins of your choice
478 .. figure:: img/plugins.png
480 Allocate nodes to environment and assign functional roles
481 =========================================================
483 #. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
485 .. figure:: img/addnodes.png
487 #. Assign roles (see figure below).
489 - Click on the <+Add Nodes> button
491 - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the "Assign Roles" Section.
493 - Check one node which you want to act as a Controller from the bottom half of the screen
495 - Click <Apply Changes>.
497 - Click on the <+Add Nodes> button
499 - Check the <Controller> and <Storage - Ceph OSD> roles.
501 - Check the two next nodes you want to act as Controllers from the bottom half of the screen
503 - Click <Apply Changes>
505 - Click on <+Add Nodes> button
507 - Check the <Compute> and <Storage - Ceph OSD> roles.
509 - Check the Nodes you want to act as Computes from the bottom half of the screen
511 - Click <Apply Changes>.
513 .. figure:: img/computelist.png
515 #. Configure interfaces (see figure below).
517 - Check Select <All> to select all allocated nodes
519 - Click <Configure Interfaces>
521 - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
525 .. figure:: img/interfaceconf.png
528 Target specific configuration
529 =============================
531 #. Set up targets for provisioning with non-default "Offloading Modes"
533 Some target nodes may require additional configuration after they are
534 PXE booted (bootstrapped); the most frequent changes are in defaults
535 for ethernet devices' "Offloading Modes" settings (e.g. some targets'
536 ethernet drivers may strip VLAN traffic by default).
538 If your target ethernet drivers have wrong "Offloading Modes" defaults,
539 in "Configure interfaces" page (described above), expand affected
540 interface's "Offloading Modes" and [un]check the relevant settings
543 .. figure:: img/offloadingmodes.png
545 #. Set up targets for "Verify Networks" with non-default "Offloading Modes"
547 **NOTE**: Check *Reference 15* for an updated and comprehensive list of
548 known issues and/or limitations, including "Offloading Modes" not being
549 applied during "Verify Networks" step.
551 Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
552 during provisiong and **not** during "Verify Networks", so if your targets
553 need this change, you have to apply "Offloading Modes" settings by hand
554 to bootstrapped nodes.
556 **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
557 the Openstack interface(s) "eth1", preventing VLAN traffic from passing
558 during "Verify Networks".
560 - From Fuel master console identify target nodes admin IPs (see figure below):
566 .. figure:: img/fuelconsole1.png
568 - SSH into each of the target nodes and disable "rx-vlan-filter" on the
569 affected physical interface(s) allocated for OpenStack traffic (eth1):
573 $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
575 - Repeat the step above for all affected nodes/interfaces in the POD.
580 It is important that the Verify Networks action is performed as it will verify
581 that communicate works for the networks you have setup, as well as check that
582 packages needed for a successful deployment can be fetched.
584 #. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
586 - Select <Verify Networks>
588 - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
590 .. figure:: img/verifynet.png
592 Deploy Your Environment
593 =======================
595 #. Deploy the environment.
597 - In the Fuel GUI, click on the "Dashboard" Tab.
599 - Click on <Deploy Changes> in the "Ready to Deploy?" section
601 - Examine any information notice that pops up and click <Deploy>
603 Wait for your deployment to complete, you can view the "Dashboard"
604 Tab to see the progress and status of your deployment.
606 =========================
607 Installation health-check
608 =========================
610 #. Perform system health-check (see figure below)
612 - Click the "Health Check" tab inside your Environment in the FUEL Web UI
614 - Check <Select All> and Click <Run Tests>
616 - Allow tests to run and investigate results where appropriate
618 .. figure:: img/health.png
625 Please refer to the :ref:`Release Notes <fuel-release-notes-label>` article.
633 3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
634 4) `OpenStack Documentation <http://docs.openstack.org>`_
638 5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
642 6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
643 7) `Fuel Documentation Overview <http://docs.openstack.org/developer/fuel-docs>`_
644 8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
645 9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
646 10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
647 11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
648 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_