1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
|
.. This document is protected/licensed under the following conditions
.. (c) Jonas Bjurel (Ericsson AB)
.. Licensed under a Creative Commons Attribution 4.0 International License.
.. You should have received a copy of the license along with this work.
.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
========
Abstract
========
This document describes how to install the Colorado release of
OPNFV when using Fuel as a deployment tool, covering its usage,
limitations, dependencies and required system resources.
============
Introduction
============
This document provides guidelines on how to install and
configure the Colorado release of OPNFV when using Fuel as a
deployment tool, including required software and hardware configurations.
Although the available installation options give a high degree of
freedom in how the system is set-up, including architecture, services
and features, etc., said permutations may not provide an OPNFV
compliant reference architecture. This instruction provides a
step-by-step guide that results in an OPNFV Colorado compliant
deployment.
The audience of this document is assumed to have good knowledge in
networking and Unix/Linux administration.
=======
Preface
=======
Before starting the installation of the Colorado release of
OPNFV, using Fuel as a deployment tool, some planning must be
done.
Retrieving the ISO image
========================
First of all, the Fuel deployment ISO image needs to be retrieved, the
Fuel .iso image of the Colorado release can be found at *Reference: 2*
Building the ISO image
======================
Alternatively, you may build the Fuel .iso from source by cloning the
opnfv/fuel git repository. To retrieve the repository for the Colorado
release use the following command:
.. code-block:: bash
$ git clone https://gerrit.opnfv.org/gerrit/fuel
Check-out the Colorado release tag to set the HEAD to the
baseline required to replicate the Colorado release:
.. code-block:: bash
$ git checkout colorado.1.0
Go to the fuel directory and build the .iso:
.. code-block:: bash
$ cd fuel/build; make all
For more information on how to build, please see *Reference: 14*
Other preparations
==================
Next, familiarize yourself with Fuel by reading the following documents:
- Fuel Installation Guide, please see *Reference: 8*
- Fuel User Guide, please see *Reference: 9*
- Fuel Developer Guide, please see *Reference: 10*
- Fuel Plugin Developers Guide, please see *Reference: 11*
Prior to installation, a number of deployment specific parameters must be collected, those are:
#. Provider sub-net and gateway information
#. Provider VLAN information
#. Provider DNS addresses
#. Provider NTP addresses
#. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
#. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
#. Other options not covered in the document are available in the links above
This information will be needed for the configuration procedures
provided in this document.
=====================
Hardware requirements
=====================
The following minimum hardware requirements must be met for the
installation of Colorado using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+====================+======================================================+
| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
| | |
| | - 1 Fuel deployment master (may be virtualized) |
| | |
| | - 3(1) Controllers (1 colocated mongo/ceilometer |
| | role, 2 Ceph-OSD roles) |
| | |
| | - 1 Compute (1 co-located Ceph-OSD role) |
| | |
+--------------------+------------------------------------------------------+
| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
| | support |
+--------------------+------------------------------------------------------+
| **RAM** | Minimum 16GB/server (Depending on VNF work load) |
| | |
+--------------------+------------------------------------------------------+
| **Disk** | Minimum 256GB 10kRPM spinning disks |
| | |
+--------------------+------------------------------------------------------+
| **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
| | |
| | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
| | |
| | Note: These can be allocated to a single NIC - |
| | or spread out over multiple NICs as your hardware |
| | supports. |
+--------------------+------------------------------------------------------+
===============================
Help with Hardware Requirements
===============================
Calculate hardware requirements:
For information on compatible hardware types available for use, please see *Reference: 11*.
When choosing the hardware on which you will deploy your OpenStack
environment, you should think about:
- CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPU per virtual machine.
- Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
- Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
- Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
================================================
Top of the rack (TOR) Configuration requirements
================================================
The switching infrastructure provides connectivity for the OPNFV
infrastructure operations, tenant networks (East/West) and provider
connectivity (North/South); it also provides needed connectivity for
the Storage Area Network (SAN).
To avoid traffic congestion, it is strongly suggested that three
physically separated networks are used, that is: 1 physical network
for administration and control, one physical network for tenant private
and public networks, and one physical network for SAN.
The switching connectivity can (but does not need to) be fully redundant,
in such case it comprises a redundant 10GE switch pair for each of the
three physically separated networks.
The physical TOR switches are **not** automatically configured from
the Fuel OPNFV reference platform. All the networks involved in the OPNFV
infrastructure as well as the provider networks and the private tenant
VLANs needs to be manually configured.
Manual configuration of the Colorado hardware platform should
be carried out according to the OPNFV Pharos specification:
<https://wiki.opnfv.org/pharos/pharos_specification>
==========================================
OPNFV Software installation and deployment
==========================================
This section describes the installation of the OPNFV installation
server (Fuel master) as well as the deployment of the full OPNFV
reference platform stack across a server cluster.
Install Fuel master
===================
#. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server.
#. Reboot the jump host to establish the Fuel server.
- The system now boots from the ISO image.
- Select "Fuel Install (Static IP)" (See figure below)
- Press [Enter].
.. figure:: img/grub-1.png
#. Wait until the Fuel setup screen is shown (Note: This can take up to 30 minutes).
#. In the "Fuel User" section - Confirm/change the default password (See figure below)
- Enter "admin" in the Fuel password input
- Enter "admin" in the Confirm password input
- Select "Check" and press [Enter]
.. figure:: img/fuelmenu1.png
#. 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).
- Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
.. figure:: img/fuelmenu2.png
#. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
- DHCP Pool Start 10.20.0.3
- DHCP Pool End 10.20.0.254
- DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
.. figure:: img/fuelmenu3.png
#. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
- Hostname
- Domain
- Search Domain
- External DNS
- Hostname to test DNS
- Select <Check> and press [Enter]
.. figure:: img/fuelmenu4.png
#. 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)
- Navigate to "HTTP proxy" and enter your http proxy address
- Select <Check> and press [Enter]
.. figure:: img/fuelmenu5.png
#. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
- NTP Server 1 <Customer NTP server 1>
- NTP Server 2 <Customer NTP server 2>
- NTP Server 3 <Customer NTP server 3>
.. figure:: img/fuelmenu6.png
#. Start the installation.
- Select Quit Setup and press Save and Quit.
- The installation will now start, wait until the login screen is shown.
Boot the Node Servers
=====================
After the Fuel Master node has rebooted from the above steps and is at
the login prompt, you should boot the Node Servers (Your
Compute/Control/Storage blades, nested or real) with a PXE booting
scheme so that the FUEL Master can pick them up for control.
#. Enable PXE booting
- 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.
#. Reboot all the control and compute blades.
#. Wait for the availability of nodes showing up in the Fuel GUI.
- Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
- Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
.. figure:: img/nodes.png
Install additional Plugins/Features on the FUEL node
====================================================
#. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
#. Select wanted plugins/features from the /opt/opnfv/ directory.
#. Install the wanted plugin with the command
.. code-block:: bash
$ fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm
Expected output (see figure below):
.. code-block:: bash
Plugin ....... was successfully installed.
.. figure:: img/plugin_install.png
Create an OpenStack Environment
===============================
#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login: admin/admin)
#. Create and name a new OpenStack environment, to be installed.
.. figure:: img/newenv.png
#. Select "<Mitaka on Ubuntu 14.04>" and press <Next>
#. Select "compute virtulization method".
- Select "QEMU-KVM as hypervisor" and press <Next>
#. Select "network mode".
- Select "Neutron with ML2 plugin"
- Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
- Press <Next>
#. Select "Storage Back-ends".
- Select "Ceph for block storage" and press <Next>
#. Select "additional services" you wish to install.
- Check option "Install Ceilometer and Aodh" and press <Next>
#. Create the new environment.
- Click <Create> Button
Configure the network environment
=================================
#. Open the environment you previously created.
#. Open the networks tab and select the "default" Node Networks group to on the left pane (see figure below).
.. figure:: img/network.png
#. Update the Public network configuration and change the following fields to appropriate values:
- CIDR to <CIDR for Public IP Addresses>
- IP Range Start to <Public IP Address start>
- IP Range End to <Public IP Address end>
- Gateway to <Gateway for Public IP Addresses>
- Check <VLAN tagging>.
- Set appropriate VLAN id.
#. Update the Storage Network Configuration
- Set CIDR to appropriate value (default 192.168.1.0/24)
- Set IP Range Start to appropriate value (default 192.168.1.1)
- Set IP Range End to appropriate value (default 192.168.1.254)
- Set vlan to appropriate value (default 102)
#. Update the Management network configuration.
- Set CIDR to appropriate value (default 192.168.0.0/24)
- Set IP Range Start to appropriate value (default 192.168.0.1)
- Set IP Range End to appropriate value (default 192.168.0.254)
- Check <VLAN tagging>.
- Set appropriate VLAN id. (default 101)
#. Update the Private Network Information
- Set CIDR to appropriate value (default 192.168.2.0/24
- Set IP Range Start to appropriate value (default 192.168.2.1)
- Set IP Range End to appropriate value (default 192.168.2.254)
- Check <VLAN tagging>.
- Set appropriate VLAN tag (default 103)
#. Select the "Neutron L3" Node Networks group on the left pane.
.. figure:: img/neutronl3.png
#. Update the Floating Network configuration.
- Set the Floating IP range start (default 172.16.0.130)
- Set the Floating IP range end (default 172.16.0.254)
- Set the Floating network name (default admin_floating_net)
#. Update the Internal Network configuration.
- Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
- Set Internal network gateway to an appropriate value
- Set the Internal network name (default admin_internal_net)
#. Update the Guest OS DNS servers.
- Set Guest OS DNS Server values appropriately
#. Save Settings.
#. Select the "Other" Node Networks group on the left pane (see figure below).
.. figure:: img/other.png
#. Update the Public network assignment.
- Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
#. Update Host OS DNS Servers.
- Provide the DNS server settings
#. Update Host OS NTP Servers.
- Provide the NTP server settings
Select Hypervisor type
======================
#. In the FUEL UI of your Environment, click the "Settings" Tab
#. Select "Compute" on the left side pane (see figure below)
- Check the KVM box and press "Save settings"
.. figure:: img/compute.png
Enable Plugins
==============
#. In the FUEL UI of your Environment, click the "Settings" Tab
#. Select Other on the left side pane (see figure below)
- Enable and configure the plugins of your choice
.. figure:: img/plugins.png
Allocate nodes to environment and assign functional roles
=========================================================
#. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
.. figure:: img/addnodes.png
#. Assign roles (see figure below).
- Click on the <+Add Nodes> button
- Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the "Assign Roles" Section.
- Check one node which you want to act as a Controller from the bottom half of the screen
- Click <Apply Changes>.
- Click on the <+Add Nodes> button
- Check the <Controller> and <Storage - Ceph OSD> roles.
- Check the two next nodes you want to act as Controllers from the bottom half of the screen
- Click <Apply Changes>
- Click on <+Add Nodes> button
- Check the <Compute> and <Storage - Ceph OSD> roles.
- Check the Nodes you want to act as Computes from the bottom half of the screen
- Click <Apply Changes>.
.. figure:: img/computelist.png
#. Configure interfaces (see figure below).
- Check Select <All> to select all allocated nodes
- Click <Configure Interfaces>
- Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
- Click <Apply>
.. figure:: img/interfaceconf.png
OPTIONAL - Set Local Mirror Repos
=================================
The following steps must be executed if you are in an environment with
no connection to the Internet. The Fuel server delivers a local repo
that can be used for installation / deployment of openstack.
#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
- Replace the URI values for the "Name" values outlined below:
- "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main universe multiverse"
- "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main universe multiverse"
- "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main universe multiverse"
- "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted"
- "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted"
- Click <Save Settings> at the bottom to Save your changes
Target specific configuration
=============================
#. Set up targets for provisioning with non-default "Offloading Modes"
Some target nodes may require additional configuration after they are
PXE booted (bootstrapped); the most frequent changes are in defaults
for ethernet devices' "Offloading Modes" settings (e.g. some targets'
ethernet drivers may strip VLAN traffic by default).
If your target ethernet drivers have wrong "Offloading Modes" defaults,
in "Configure interfaces" page (described above), expand affected
interface's "Offloading Modes" and [un]check the relevant settings
(see figure below):
.. figure:: img/offloadingmodes.png
#. Set up targets for "Verify Networks" with non-default "Offloading Modes"
**NOTE**: Check *Reference 15* for an updated and comprehensive list of
known issues and/or limitations, including "Offloading Modes" not being
applied during "Verify Networks" step.
Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
during provisiong and **not** during "Verify Networks", so if your targets
need this change, you have to apply "Offloading Modes" settings by hand
to bootstrapped nodes.
**E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
the Openstack interface(s) "eth1", preventing VLAN traffic from passing
during "Verify Networks".
- From Fuel master console identify target nodes admin IPs (see figure below):
.. code-block:: bash
$ fuel nodes
.. figure:: img/fuelconsole1.png
- SSH into each of the target nodes and disable "rx-vlan-filter" on the
affected physical interface(s) allocated for OpenStack traffic (eth1):
.. code-block:: bash
$ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
- Repeat the step above for all affected nodes/interfaces in the POD.
Verify Networks
===============
It is important that the Verify Networks action is performed as it will verify
that communicate works for the networks you have setup, as well as check that
packages needed for a successful deployment can be fetched.
#. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
- Select <Verify Networks>
- Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
.. figure:: img/verifynet.png
Deploy Your Environment
=======================
#. Deploy the environment.
- In the Fuel GUI, click on the "Dashboard" Tab.
- Click on <Deploy Changes> in the "Ready to Deploy?" section
- Examine any information notice that pops up and click <Deploy>
Wait for your deployment to complete, you can view the "Dashboard"
Tab to see the progress and status of your deployment.
=========================
Installation health-check
=========================
#. Perform system health-check (see figure below)
- Click the "Health Check" tab inside your Environment in the FUEL Web UI
- Check <Select All> and Click <Run Tests>
- Allow tests to run and investigate results where appropriate
.. figure:: img/health.png
==========
References
==========
OPNFV
=====
1) `OPNFV Home Page <http://www.opnfv.org>`_: http://www.opnfv.org
2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_: https://www.opnfv.org/software/download
OpenStack
=========
3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_: http://www.openstack.org/software/mitaka
4) `OpenStack documentation <http://docs.openstack.org>`_: http://docs.openstack.org
OpenDaylight
============
5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_: http://www.opendaylight.org/software/downloads
Fuel
====
6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
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
9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
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
12) `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
Fuel in OPNFV
=============
13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html
14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/buildprocedure/index.html
15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html
|
