summaryrefslogtreecommitdiffstats
path: root/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
diff options
context:
space:
mode:
Diffstat (limited to 'book-enea-nfv-core-installation-guide/doc/installation_instructions.xml')
-rw-r--r--book-enea-nfv-core-installation-guide/doc/installation_instructions.xml1259
1 files changed, 1259 insertions, 0 deletions
diff --git a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
new file mode 100644
index 0000000..0e539de
--- /dev/null
+++ b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
@@ -0,0 +1,1259 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="install_instructions">
5 <title>Installation Instructions</title>
6
7 <para>ENEA NFV Core 1.0 leverages the work in the OPNFV Project, delivering
8 selected Installer DVD images together with instructions on how to setup the
9 Installers and deploy OPNFV releases on a Pharos compliant test lab. These
10 images can be accessed on the OPNFV Downloads page.</para>
11
12 <para>ENEA NFV Core uses the Fuel@OPNFV Installer as a deployment facility,
13 hereafter referred to as <emphasis role="bold">Fuel</emphasis>. Fuel is an
14 automated deployment tool capable of automatically provisioning and
15 deploying OpenStack on a cluster of servers. ENEA NFV Core 1.0 is based on
16 the OPNFV release <emphasis role="bold">Danube</emphasis>, which is also
17 available for aarch64 servers through the OPNFV Armband project that is
18 driven by ENEA, which also uses the Fuel Installer. The Armband project is
19 out of the scope of this document but there are information available online
20 on the OPNFV wiki. The OPNFV download page provides general instructions for
21 building and installing the Fuel Installer iso and also on how to deploy
22 OPNFV Danube using Fuel on a Pharos compliant test lab . Through the
23 remainder of this document there will be references to this Installation
24 Guide, sometimes referred simply as &rdquor;the guide&rdquo; or &rdquor;the
25 installation guide&rdquo; or the &rdquor;Fuel Installation Guide&rdquo;. The
26 next sections of this chapter will explain in detail the procedure for
27 configuring and installing the Fuel Master followed by configuration and
28 deployment of the ENEA NFV Core 1.0 on the test lab.</para>
29
30 <note>
31 <para>Covering chapters 1-6 of the Fuel Installation Guide is not
32 mandatory but useful for better understanding the hardware requirements
33 and how the deployment process works. Also note that since and ISO is
34 provided, it is not necessary to build an ISO image from scratch.</para>
35 </note>
36
37 <note>
38 <para>the following sections will refer to a specific sub-chapter in the
39 installation guide, which is indicated at the end of the title in round
40 parenthesis. Chapter of the installation guide which are not mentioned can
41 be safely skipped.</para>
42 </note>
43
44 <para>Before starting the installation of this release of ENFV Core, certain
45 preparations must be done to ensure optimal performance.</para>
46
47 <section id="retrieve-ISO-image">
48 <title>Retrieving the ISO image</title>
49
50 <para>First, the Fuel deployment ISO image needs to be retrieved. The .iso
51 image download link for this release can be found in <ulink
52 url="https://www.opnfv.org/software/download">OPNFV documentation and
53 software downloads </ulink></para>
54
55 <remark>Update this url link as appropriate</remark>
56
57 <para>This refers to chapter 3.1 in the installation guide. In this case
58 the ENEA provided ISO image is to be used, which should have been made
59 available.</para>
60 </section>
61
62 <section id="other-preparations">
63 <title>Other Preparations</title>
64
65 <para>Chapter 3.3 of the installation guide provides link to further
66 documentation which is useful but not mandatory.</para>
67
68 <para>Next, familiarize yourself with Fuel by reading the following
69 documents:</para>
70
71 <remark>Should any of these 4 documents be included/referenced as part of
72 our guide or should we include something else ?</remark>
73
74 <itemizedlist>
75 <listitem>
76 <para><ulink
77 url="http://docs.openstack.org/developer/fueldocs/userdocs/fuel-install-guide.html">Fuel
78 Installation Guide</ulink></para>
79 </listitem>
80
81 <listitem>
82 <para><ulink
83 url="http://docs.openstack.org/developer/fuel-docs/userdocs/fueluser-guide.html">Fuel
84 User Guide</ulink></para>
85 </listitem>
86
87 <listitem>
88 <para><ulink
89 url="http://docs.openstack.org/developer/fueldocs/devdocs/develop.html">Fuel
90 Developer Guide</ulink></para>
91 </listitem>
92
93 <listitem>
94 <para><ulink
95 url="http://docs.openstack.org/developer/fueldocs/plugindocs/fuel-plugin-sdk-guide.html">Fuel
96 Plugin Developers Guide</ulink></para>
97 </listitem>
98 </itemizedlist>
99
100 <para>Prior to installation, a number of deployment specific parameters
101 must be collected, such as:</para>
102
103 <remark>Change the following parameters as appropriate</remark>
104
105 <itemizedlist>
106 <listitem>
107 <para>Provider sub-net and gateway information</para>
108 </listitem>
109
110 <listitem>
111 <para>Provider VLAN information</para>
112 </listitem>
113
114 <listitem>
115 <para>Provider DNS addresses</para>
116 </listitem>
117
118 <listitem>
119 <para>Provider NTP addresses</para>
120 </listitem>
121
122 <listitem>
123 <para>Network overlay you plan to deploy (VLAN, VXLAN, FLAT)</para>
124 </listitem>
125
126 <listitem>
127 <para>How many nodes and what roles you want to deploy (Controllers,
128 Storage, Computes)</para>
129 </listitem>
130
131 <listitem>
132 <para>Monitoring options you want to deploy (Ceilometer, Syslog,
133 etc.).</para>
134 </listitem>
135
136 <listitem>
137 <para>Other options not covered in the document are available in the
138 links above.</para>
139
140 <para>This information will be needed for the configuration procedures
141 provided in this document.</para>
142 </listitem>
143 </itemizedlist>
144 </section>
145
146 <section id="hw_req">
147 <title>Hardware Requirements</title>
148
149 <para>The following minimum hardware requirements must be met for the
150 installation of ENFV Core using Fuel, to be successful:</para>
151
152 <informaltable>
153 <tgroup cols="2">
154 <tbody>
155 <row>
156 <entry align="center" colname="HW Aspect"><emphasis
157 role="bold">Hardware Aspect</emphasis></entry>
158
159 <entry align="center" colname="Requirement"><emphasis
160 role="bold">Requirement</emphasis></entry>
161 </row>
162
163 <row>
164 <entry align="left">Nr. of nodes</entry>
165
166 <entry>Minimum 6 (3 for non-redundant deployment):<itemizedlist>
167 <listitem>
168 <para>1 Fuel deployment master (may be virtualized)</para>
169 </listitem>
170
171 <listitem>
172 <para>3 Controllers (1 co-located mongo/ceilometer role, 2
173 Ceph-OSD roles)</para>
174 </listitem>
175
176 <listitem>
177 <para>1 Compute (1 co-located Ceph-OSD role)</para>
178 </listitem>
179 </itemizedlist></entry>
180 </row>
181
182 <row>
183 <entry>CPU</entry>
184
185 <entry>Minimum 1 socket x86_AMD64 with Virtualization
186 support</entry>
187 </row>
188
189 <row>
190 <entry>RAM</entry>
191
192 <entry>Minimum 16GB/server (depending on VNF work load)</entry>
193 </row>
194
195 <row>
196 <entry>Disk</entry>
197
198 <entry>Minimum 256GB 10kRPM spinning disks</entry>
199 </row>
200
201 <row>
202 <entry>Networks</entry>
203
204 <entry><itemizedlist>
205 <listitem>
206 <para>4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE)</para>
207 </listitem>
208
209 <listitem>
210 <para>1 Un-Tagged VLAN for PXE Boot - ADMIN Network</para>
211 </listitem>
212 </itemizedlist><para>Note: These can be allocated to a single
213 NIC - or spread out over multiple NICs as supported by your
214 hardware.</para></entry>
215 </row>
216 </tbody>
217 </tgroup>
218 </informaltable>
219
220 <para>6 physical nodes 1 x Fuel deployment master (which was virtualized),
221 x86 based 3 x Cavium ThunderX 1U 48 cores R120-T30
222 (https://www.avantek.co.uk/arm-server-r120-t30/) as Controller nodes (for
223 an HA configuration, 1 collocated mongo/ceilometer role, 1 Ceph-OSD role,
224 1 Vitrage Controller role) 2 x Cavium ThunderX 2U 96 cores R270-T60
225 (https://www.avantek.co.uk/arm-server-r270-t60/) as Compute nodes (with
226 collocated Ceph-OSD roles) RAM &ndash; 128 GB on the Controller nodes, 256
227 GB on the Compute nodes Disk &ndash; 1 x 120GB SSD and 1 x 2TB SATA 5400
228 rpm Networks &ndash; Appart from the integrated NICs also installed was
229 one Intel &reg; 82574L PCIe card used for Fuel Admin on each server</para>
230 </section>
231
232 <section id="install_fuel_master">
233 <title>Install Fuel Master</title>
234
235 <para>This section describes the installation of the ENFV Core
236 installation server (Fuel master) as well as the deployment of the full
237 ENFV Core reference platform stack across a server cluster. It is
238 recommended to install the Fuel Master on a VM using virt-manager with a
239 minimum of 8GB of RAM, 4 CPUs and at least 100GB disk.</para>
240
241 <orderedlist>
242 <listitem>
243 <para>Mount the ENEA NFV Core 1.0 ISO file/media as a boot device to
244 the Fuel Master VM.</para>
245 </listitem>
246
247 <listitem>
248 <para>Reboot the VM and make sure it boots from the ISO:</para>
249
250 <itemizedlist>
251 <listitem>
252 <para>The system now boots from the ISO image</para>
253 </listitem>
254
255 <listitem>
256 <para>Select <literal>Fuel Install (Static IP)</literal> (See
257 figure below)</para>
258 </listitem>
259
260 <listitem>
261 <para>Press [Enter]</para>
262
263 <mediaobject>
264 <imageobject role="fo">
265 <imagedata contentwidth="600"
266 fileref="images/fuel_install_static_ip.svg"
267 format="SVG" />
268 </imageobject>
269 </mediaobject>
270 </listitem>
271 </itemizedlist>
272 </listitem>
273
274 <listitem>
275 <para>Wait until the Fuel setup screen is shown, this can take up to
276 30 minutes.</para>
277 </listitem>
278
279 <listitem>
280 <para>In the <literal>Fuel User</literal> section, confirm/change the
281 default password (see figure below).</para>
282
283 <itemizedlist>
284 <listitem>
285 <para>Enter &rdquor;admin&rdquo; in the Fuel password input</para>
286 </listitem>
287
288 <listitem>
289 <para>Enter &rdquor;admin&rdquo; in the Confirm password
290 input</para>
291 </listitem>
292
293 <listitem>
294 <para>Select &rdquor;Check&rdquo; and press [Enter]</para>
295 </listitem>
296 </itemizedlist>
297
298 <mediaobject>
299 <imageobject role="fo">
300 <imagedata contentwidth="600" fileref="images/fuel_user.svg"
301 format="SVG" />
302 </imageobject>
303 </mediaobject>
304 </listitem>
305
306 <listitem>
307 <para>In the &rdquor;Network Setup&rdquo; section, configure
308 DHCP/Static IP information for your FUEL node.</para>
309
310 <para>E.g.: ETH0 is 10.20.0.2/24 for FUEL booting and ETH1 is DHCP in
311 your corporate/lab network (see figure below) .</para>
312
313 <itemizedlist>
314 <listitem>
315 <para>Configure eth1 here, it should be the interface to the
316 outside world. In this example ETH1 is configured with
317 10.0.6.10/24 and the default gateway is 10.0.6.254</para>
318 </listitem>
319 </itemizedlist>
320
321 <mediaobject>
322 <imageobject>
323 <imagedata contentwidth="600" fileref="images/net_setup_1.svg" />
324 </imageobject>
325 </mediaobject>
326
327 <mediaobject>
328 <imageobject>
329 <imagedata contentwidth="600" fileref="images/net_setup_2.svg" />
330 </imageobject>
331 </mediaobject>
332 </listitem>
333
334 <listitem>
335 <para>In the PXE setup menu, the default values can be left
336 unchanged.</para>
337 </listitem>
338
339 <listitem>
340 <para>In the <literal>DNS &amp; Hostname</literal> section the
341 recommended values are as presented in the figure below:</para>
342
343 <mediaobject>
344 <imageobject>
345 <imagedata contentwidth="600" fileref="images/DNS_Hostname.svg" />
346 </imageobject>
347 </mediaobject>
348 </listitem>
349
350 <listitem>
351 <para>The Bootstrap Image section should be skipped, the ISO will be
352 configured in advance to use the proper repositories.</para>
353 </listitem>
354
355 <listitem>
356 <para>In the <literal>Time Sync</literal> section (see figure below) -
357 Change the following fields to appropriate values. It is strongly
358 advised to avoid using <literal>fuel.pool.ntp.org</literal> values and
359 instead set them to <literal>pool.ntp.org:</literal></para>
360
361 <mediaobject>
362 <imageobject>
363 <imagedata contentwidth="600" fileref="images/time_sync.svg" />
364 </imageobject>
365 </mediaobject>
366 </listitem>
367
368 <listitem>
369 <para>Enable experimental and advanced features</para>
370
371 <itemizedlist>
372 <listitem>
373 <para>In the &rdquor;Features groups&rdquo; section (see figure
374 below) &ndash; enable the checkboxes for Experimental and Advanced
375 features</para>
376 </listitem>
377
378 <listitem>
379 <para>Move to the &lt;Apply&gt; button and press
380 &lt;Enter&gt;</para>
381 </listitem>
382 </itemizedlist>
383
384 <mediaobject>
385 <imageobject>
386 <imagedata contentwidth="600" fileref="images/features_groups.svg" />
387 </imageobject>
388 </mediaobject>
389 </listitem>
390
391 <listitem>
392 <para>Start the installation</para>
393
394 <itemizedlist>
395 <listitem>
396 <para>Select "Quit Setup" and press [Save and Quit].</para>
397 </listitem>
398
399 <listitem>
400 <para>The installation will now start. Wait until the login screen
401 is shown.</para>
402 </listitem>
403 </itemizedlist>
404 </listitem>
405 </orderedlist>
406 </section>
407
408 <section id="boot_the_servers">
409 <title>Boot the Servers</title>
410
411 <para>Follow the same steps as indicated in the installation guide. Wait
412 until the Fuel Master installation is complete, which should be indicated
413 by the VM restarting and prompting for user login.</para>
414
415 <para>After the Fuel Master node has rebooted from the above steps and is
416 at the login prompt, you should boot the Node Servers (Your
417 Compute/Control/Storage blades, nested or real) with a PXE booting scheme
418 so that the FUEL Master can pick them up for control.</para>
419
420 <orderedlist>
421 <listitem>
422 <para>Enable PXE booting</para>
423
424 <para>For every controller and compute server: enable PXE Booting as
425 the first boot device in the UEFI (EDK2) boot order menu, and hard
426 disk as the second boot device in the same menu.</para>
427 </listitem>
428
429 <listitem>
430 <para>Reboot all the control and compute blades.</para>
431 </listitem>
432
433 <listitem>
434 <para>Wait for the availability of nodes showing up in the Fuel
435 GUI.</para>
436
437 <itemizedlist>
438 <listitem>
439 <para>Connect to the FUEL UI via the URL provided in the Console
440 (default: https://10.20.0.2:8443)</para>
441 </listitem>
442
443 <listitem>
444 <para>Wait until all nodes are displayed in top right corner of
445 the Fuel GUI: Total nodes and Unallocated nodes (see figure
446 below).</para>
447 </listitem>
448 </itemizedlist>
449
450 <mediaobject>
451 <imageobject role="fo">
452 <imagedata align="center" fileref="images/nodes.svg" />
453 </imageobject>
454 </mediaobject>
455 </listitem>
456 </orderedlist>
457 </section>
458
459 <section id="add_feat_fuel">
460 <title>Installing additional Plugins/Features on FUEL</title>
461
462 <para>In order to obtain the set of extra features used by ENEA NFV Core
463 1.0 a few extra Fuel plugins have to be installed at this stage. Further
464 configuration steps will also need to be performed after the installation
465 is complete, details about these later on.</para>
466
467 <para>The following extra plugins need to be installed:</para>
468
469 <itemizedlist>
470 <listitem>
471 <para>Fuel Vitrage Plugin</para>
472 </listitem>
473
474 <listitem>
475 <para>Zabbix for Fuel</para>
476 </listitem>
477
478 <listitem>
479 <para>Tacker VNF Manager</para>
480 </listitem>
481 </itemizedlist>
482
483 <para>Login to the Fuel master via ssh using the default credentials (e.g.
484 root@10.20.0.2 pwd: r00tme) and install the additional plugins:</para>
485
486 <programlisting>$ fuel plugins --install /opt/opnfv/vitrage-1.0-1.0.4-1.noarch.rpm
487$ fuel plugins --install zabbix_monitoring-2.5-2.5.3-1.noarch.rpm
488$ fuel plugins --install tacker-1.0-1.0.0-1.noarch.rpm</programlisting>
489
490 <para>Expected output: <programlisting>Plugin ....... was successfully installed.</programlisting></para>
491 </section>
492
493 <section id="create_opstack_env">
494 <title>Create an OpenStack Environment</title>
495
496 <para>Follow the procedure below to create an OpenStack
497 environment:</para>
498
499 <orderedlist>
500 <listitem>
501 <para>Connect to Fuel WEB UI with a browser (default:
502 https://10.20.0.2:8443) (login: admin/admin)</para>
503 </listitem>
504
505 <listitem>
506 <para>Create and name a new OpenStack environment that you want to
507 install.</para>
508 </listitem>
509
510 <listitem>
511 <para>Select &rdquor;&lt;Newton on Debian 9&gt; (aarch64)&rdquo; and
512 press &lt;Next&gt;</para>
513
514 <mediaobject>
515 <imageobject>
516 <imagedata contentwidth="600" fileref="images/newton_debian.svg" />
517 </imageobject>
518 </mediaobject>
519 </listitem>
520
521 <listitem>
522 <para>Select &rdquor;compute virtualization method&rdquo;, then select
523 &rdquor;QEMU-KVM as hypervisor&rdquo; and press [Next].</para>
524 </listitem>
525
526 <listitem>
527 <para>Select &rdquor;network mode&rdquo;</para>
528
529 <itemizedlist>
530 <listitem>
531 <para>Select &rdquor;Neutron with ML2 plugin&rdquo;</para>
532 </listitem>
533
534 <listitem>
535 <para>Select &rdquor;Neutron with VLAN segmentation&rdquo;
536 (recommended when enabling DPDK).</para>
537 </listitem>
538
539 <listitem>
540 <para>Press [Next]</para>
541 </listitem>
542 </itemizedlist>
543
544 <mediaobject>
545 <imageobject>
546 <imagedata contentwidth="600" fileref="images/neutron_vlan.svg" />
547 </imageobject>
548 </mediaobject>
549 </listitem>
550
551 <listitem>
552 <para>Select &rdquor;Storage Back-ends&rdquo;, then &rdquor;Ceph for
553 block storage&rdquo; and press [Next]</para>
554
555 <mediaobject>
556 <imageobject>
557 <imagedata contentwidth="600"
558 fileref="images/storage_backends.svg" />
559 </imageobject>
560 </mediaobject>
561 </listitem>
562
563 <listitem>
564 <para>In the Additional Services select &rdquor;Install
565 Vitrage&rdquo;:</para>
566
567 <mediaobject>
568 <imageobject>
569 <imagedata contentwidth="600"
570 fileref="images/additional_services.svg" />
571 </imageobject>
572 </mediaobject>
573 </listitem>
574
575 <listitem>
576 <para>Create the new environment by clicking the [Create]
577 Button.</para>
578 </listitem>
579 </orderedlist>
580 </section>
581
582 <section id="config_net_env">
583 <title>Configure the Network Environment</title>
584
585 <para>To configure the network environment specifically to a DPDK based
586 scenario, please follow these steps:</para>
587
588 <orderedlist>
589 <listitem>
590 <para>Open the environment you previously created.</para>
591 </listitem>
592
593 <listitem>
594 <para>Open the networks tab and select the &rdquor;default&rdquo; Node
595 Networks group to on the left pane (see figure below).</para>
596
597 <mediaobject>
598 <imageobject>
599 <imagedata contentwidth="600" fileref="images/networks_tab.svg" />
600 </imageobject>
601 </mediaobject>
602 </listitem>
603
604 <listitem>
605 <para>Update the Public network configuration and change the following
606 fields to appropriate values:</para>
607
608 <itemizedlist>
609 <listitem>
610 <para>CIDR to &lt;CIDR for Public IP Addresses&gt;</para>
611 </listitem>
612
613 <listitem>
614 <para>IP Range Start to &lt;Public IP Address start&gt;
615 (recommended to start with x.x.x.41)</para>
616 </listitem>
617
618 <listitem>
619 <para>IP Range End to &lt;Public IP Address end&gt; (recommended
620 to end with x.x.x.100)</para>
621 </listitem>
622
623 <listitem>
624 <para>Gateway to &lt;Gateway for Public IP Addresses&gt;</para>
625 </listitem>
626
627 <listitem>
628 <para>Check &lt;Use VLAN tagging&gt; if needed. For simplicity
629 it&rsquo;s recommended to use the public network in untagged
630 mode.</para>
631 </listitem>
632
633 <listitem>
634 <para>Set appropriate VLAN ID</para>
635 </listitem>
636 </itemizedlist>
637 </listitem>
638
639 <listitem>
640 <para>Update the Storage Network Configuration:</para>
641
642 <itemizedlist>
643 <listitem>
644 <para>It&rsquo;s recommended to keep the default CIDR</para>
645 </listitem>
646
647 <listitem>
648 <para>Set IP Range Start to an appropriate value (default
649 192.168.1.1)</para>
650 </listitem>
651
652 <listitem>
653 <para>Set IP Range End to an appropriate value (default
654 192.168.1.254)</para>
655 </listitem>
656
657 <listitem>
658 <para>Set VLAN tagging as needed</para>
659 </listitem>
660 </itemizedlist>
661 </listitem>
662
663 <listitem>
664 <para>Update the Management Network configuration:</para>
665
666 <itemizedlist>
667 <listitem>
668 <para>It&rsquo;s recommended to keep the default CIDR</para>
669 </listitem>
670
671 <listitem>
672 <para>Set IP Range Start to an appropriate value (default
673 192.168.0.1)</para>
674 </listitem>
675
676 <listitem>
677 <para>Set IP Range End to an appropriate value (default
678 192.168.0.254)</para>
679 </listitem>
680
681 <listitem>
682 <para>Check &lt;VLAN tagging&gt;</para>
683 </listitem>
684
685 <listitem>
686 <para>Set appropriate VLAN ID (default 101)</para>
687 </listitem>
688 </itemizedlist>
689 </listitem>
690
691 <listitem>
692 <para>Update the Private Network information:</para>
693
694 <itemizedlist>
695 <listitem>
696 <para>It&rsquo;s recommended to keep the default CIDR</para>
697 </listitem>
698
699 <listitem>
700 <para>Set IP Range Start to an appropriate value (default
701 192.168.2.1)</para>
702 </listitem>
703
704 <listitem>
705 <para>Set IP Range End to an appropriate value (default
706 192.168.2.254)</para>
707 </listitem>
708
709 <listitem>
710 <para>Check &lt;VLAN tagging&gt;</para>
711 </listitem>
712
713 <listitem>
714 <para>Set appropriate VLAN tag (default 103)</para>
715 </listitem>
716 </itemizedlist>
717 </listitem>
718
719 <listitem>
720 <para>Select the &rdquor;Neutron L3&rdquo; Node Networks group on the
721 left pane</para>
722
723 <mediaobject>
724 <imageobject>
725 <imagedata contentwidth="600" fileref="images/neutron_L3.svg" />
726 </imageobject>
727 </mediaobject>
728 </listitem>
729
730 <listitem>
731 <para>Update the Floating Network configuration:</para>
732
733 <itemizedlist>
734 <listitem>
735 <para>Set the Floating IP range start (recommended to start with
736 x.x.x.101)</para>
737 </listitem>
738
739 <listitem>
740 <para>Set the Floating IP range end (recommended to end with
741 x.x.x.200)</para>
742 </listitem>
743 </itemizedlist>
744 </listitem>
745
746 <listitem>
747 <para>Update the Internal Network configuration:</para>
748
749 <itemizedlist>
750 <listitem>
751 <para>It&rsquo;s recommended to keep the default CIDR and
752 mask</para>
753 </listitem>
754
755 <listitem>
756 <para>Set Internal network gateway to an appropriate value</para>
757 </listitem>
758 </itemizedlist>
759 </listitem>
760
761 <listitem>
762 <para>Update the Guest OS DNS servers with appropriate values.</para>
763 </listitem>
764
765 <listitem>
766 <para>Save Settings</para>
767 </listitem>
768
769 <listitem>
770 <para>Select the &rdquor;Other&rdquo; Node Networks group on the left
771 pane (see figure below).</para>
772
773 <mediaobject>
774 <imageobject>
775 <imagedata contentwidth="600" fileref="images/other_networks.svg" />
776 </imageobject>
777 </mediaobject>
778 </listitem>
779
780 <listitem>
781 <para>Make sure the &rdquor;Public Gateway is Available&rdquo; and
782 &rdquor;Assign public networks to all nodes&rdquo; are checked.</para>
783 </listitem>
784
785 <listitem>
786 <para>Update Host OS DNS Servers settings</para>
787 </listitem>
788
789 <listitem>
790 <para>Update Host OS NTP Servers settings</para>
791 </listitem>
792 </orderedlist>
793 </section>
794
795 <section id="hypervisor_type">
796 <title>Select Hypervisor type</title>
797
798 <para>Select the Hypervisor type in the following way:</para>
799
800 <orderedlist>
801 <listitem>
802 <para>In the FUEL UI of your Environment, click the
803 &rdquor;Settings&rdquo; Tab</para>
804 </listitem>
805
806 <listitem>
807 <para>Select &rdquor;Compute&rdquo; on the left side pane, check the
808 KVM box and press [Save settings]:</para>
809
810 <mediaobject>
811 <imageobject>
812 <imagedata contentwidth="600" fileref="images/compute_kvm.svg" />
813 </imageobject>
814 </mediaobject>
815 </listitem>
816 </orderedlist>
817 </section>
818
819 <section id="add_rm_repos">
820 <title>Add/Remove Repositories</title>
821
822 <para>By default OPNFV Fuel uses a set of repositories as package sources.
823 These hold both OpenStack components as well as other needed
824 packages.</para>
825
826 <para>In order to speed up the deployment process, Fuel will create its
827 own local mirror which can be reachable on the Admin interface (e.g.
828 10.20.0.2:8080/newton-10.0/ubuntu/x86-64). However, more repositories are
829 added that need external connection.</para>
830
831 <para>It is possible to avoid using external repositories and make the
832 entire process completely offline. This way only the most basic packages
833 will be installed, but the process will be quicker and not depend on an
834 Internet connection. To do this, just make sure that the Repositories list
835 contain only ubuntu-local, mos and Auxilliary.</para>
836
837 <itemizedlist>
838 <listitem>
839 <para>In the FUEL UI of you Environment, click the
840 &rdquor;Settings&rdquo; Tab</para>
841 </listitem>
842
843 <listitem>
844 <para>Select &rdquor;General&rdquo; and scroll down to the
845 Repositories list (see figure below).</para>
846
847 <para>Remove any extra repositories that point to external
848 repositories by clicking the delete button on the right of the
849 repository entry.</para>
850
851 <mediaobject>
852 <imageobject>
853 <imagedata contentwidth="600"
854 fileref="images/general_settings.svg" />
855 </imageobject>
856 </mediaobject>
857 </listitem>
858 </itemizedlist>
859 </section>
860
861 <section id="plugins">
862 <title>Enable Plugins</title>
863
864 <para>In the FUEL UI of your Environment, click the
865 &rdquor;Settings&rdquo; Tab and select OpenStack Services on the left side
866 pane. Enable the Tacker VNF manager plugin:</para>
867
868 <mediaobject>
869 <imageobject>
870 <imagedata contentwidth="600" fileref="images/openstack_services.svg" />
871 </imageobject>
872 </mediaobject>
873
874 <para>Select "Other" on the left pane and do the following:</para>
875
876 <itemizedlist>
877 <listitem>
878 <para>Enable and configure Zabbix for Fuel</para>
879 </listitem>
880
881 <listitem>
882 <para>Enable and configure Fuel Vitrage Plugin</para>
883 </listitem>
884
885 <listitem>
886 <para>Check &rdquor;Use Zabbix Datasource in Vitrage&rdquo;</para>
887 </listitem>
888 </itemizedlist>
889
890 <mediaobject>
891 <imageobject>
892 <imagedata contentwidth="600" fileref="images/other.svg" />
893 </imageobject>
894 </mediaobject>
895 </section>
896
897 <section id="allocate_nodes_assign_roles">
898 <title>Allocate Nodes and assign Functional Roles</title>
899
900 <para>This is accomplished in the following way:</para>
901
902 <orderedlist>
903 <listitem>
904 <para>Click on the &rdquor;Nodes&rdquo; Tab in the FUEL WEB UI (see
905 figure below):</para>
906
907 <mediaobject>
908 <imageobject>
909 <imagedata contentwidth="600" fileref="images/allocate_nodes.svg" />
910 </imageobject>
911 </mediaobject>
912 </listitem>
913
914 <listitem>
915 <para>Assign roles (see figure below):</para>
916
917 <itemizedlist>
918 <listitem>
919 <para>Click on the &lt;+Add Nodes&gt; button</para>
920 </listitem>
921
922 <listitem>
923 <para>Check &lt;Controller&gt;, &lt;Telemetry - MongoDB&gt;</para>
924 </listitem>
925
926 <listitem>
927 <para>Check one node which you want to act as a Controller from
928 the bottom half of the screen.</para>
929 </listitem>
930
931 <listitem>
932 <para>Click [Apply Changes]</para>
933 </listitem>
934
935 <listitem>
936 <para>Click on the &lt;+Add Nodes&gt; button</para>
937 </listitem>
938
939 <listitem>
940 <para>Check the &lt;Controller&gt; and &lt;Storage - Ceph OSD&gt;
941 roles.</para>
942 </listitem>
943
944 <listitem>
945 <para>Check one node to assign these roles</para>
946 </listitem>
947
948 <listitem>
949 <para>Click &lt;Apply Changes&gt;</para>
950 </listitem>
951
952 <listitem>
953 <para>Click on &lt;+Add Nodes&gt; button</para>
954 </listitem>
955
956 <listitem>
957 <para>Check &lt;Controller&gt;</para>
958 </listitem>
959
960 <listitem>
961 <para>Check one node to assign as a Controller</para>
962 </listitem>
963
964 <listitem>
965 <para>Click &lt;Apply Changes&gt;</para>
966 </listitem>
967
968 <listitem>
969 <para>Check the &lt;Compute&gt; and &lt;Storage - Ceph OSD&gt;
970 roles.</para>
971 </listitem>
972
973 <listitem>
974 <para>Check the Nodes you want to act as Computes from the bottom
975 half of the screen.</para>
976 </listitem>
977
978 <listitem>
979 <para>Click &lt;Apply Changes&gt;</para>
980
981 <mediaobject>
982 <imageobject>
983 <imagedata contentwidth="600"
984 fileref="images/assign_roles.svg" />
985 </imageobject>
986 </mediaobject>
987 </listitem>
988 </itemizedlist>
989
990 <note>
991 <para>Internally, for testing, the Controller nodes had different
992 network configuration compare to the Compute nodes, but that is not
993 mandatory. The 5 nodes in the cluster can have the exact same
994 configuration</para>
995 </note>
996 </listitem>
997
998 <listitem>
999 <para>Configure interfaces for Controller nodes (see figure
1000 below).</para>
1001
1002 <itemizedlist>
1003 <listitem>
1004 <para>Select all allocated nodes</para>
1005 </listitem>
1006
1007 <listitem>
1008 <para>Click [Configure Interfaces]</para>
1009 </listitem>
1010
1011 <listitem>
1012 <para>Assign interfaces (in this case Public, Storage and
1013 Management were set on the first 10GbE Port and Private on the
1014 second 10GbE port, with Admin on a 1Gb port), and click [Apply]
1015 <mediaobject>
1016 <imageobject>
1017 <imagedata contentwidth="600"
1018 fileref="images/config_nodes.svg" />
1019 </imageobject>
1020 </mediaobject></para>
1021 </listitem>
1022 </itemizedlist>
1023 </listitem>
1024
1025 <listitem>
1026 <para>Configure Compute nodes interfaces:</para>
1027
1028 <itemizedlist>
1029 <listitem>
1030 <para>Select the Compute nodes</para>
1031 </listitem>
1032
1033 <listitem>
1034 <para>Click &lt;Configure Interfaces&gt;</para>
1035 </listitem>
1036
1037 <listitem>
1038 <para>Assign interfaces (in this case Public, Storage and
1039 Management were set on the first 10GbE Port and Private on the
1040 second 10GbE port; Admin is on a 1Gb port)</para>
1041 </listitem>
1042
1043 <listitem>
1044 <para>For the Private network enable DPDK</para>
1045 </listitem>
1046
1047 <listitem>
1048 <para>Click Apply</para>
1049
1050 <mediaobject>
1051 <imageobject>
1052 <imagedata contentwidth="600"
1053 fileref="images/config_nodes_2.svg" />
1054 </imageobject>
1055 </mediaobject>
1056 </listitem>
1057 </itemizedlist>
1058 </listitem>
1059 </orderedlist>
1060 </section>
1061
1062 <section id="config_hugepages">
1063 <title>Configure hugepages</title>
1064
1065 <para>This step is needed for the DPDK based scenarios and it's not
1066 covered in the installation guide.</para>
1067
1068 <remark>does the comment made above still apply and if so, should this
1069 section be removed?</remark>
1070
1071 <orderedlist>
1072 <listitem>
1073 <para>Click on the gear on the right of a Compute node</para>
1074
1075 <itemizedlist>
1076 <listitem>
1077 <para>In the menu that shows up click on Node Attributes</para>
1078 </listitem>
1079
1080 <listitem>
1081 <para>Set Huge Pages for Nova and DPDK to appropriate values (see
1082 figure below); it&rsquo;s recommended to use at least 2048 pages
1083 of 2MB for each of Nova and DPDK</para>
1084 </listitem>
1085
1086 <listitem>
1087 <para>Click &lt;Save Settings&gt;</para>
1088
1089 <mediaobject>
1090 <imageobject>
1091 <imagedata contentwidth="600" fileref="images/hugepages.svg" />
1092 </imageobject>
1093 </mediaobject>
1094 </listitem>
1095 </itemizedlist>
1096 </listitem>
1097
1098 <listitem>
1099 <para>Perform the same configuration for the other Compute
1100 nodes</para>
1101 </listitem>
1102 </orderedlist>
1103 </section>
1104
1105 <section id="target_config">
1106 <title>Target Specific Configuration</title>
1107
1108 <para>Follow the guide for setting custom target configuration, as needed.
1109 Skip this step if no specific configurations are required.</para>
1110
1111 <orderedlist>
1112 <listitem>
1113 <para>Set up targets for provisioning with non-default
1114 &rdquor;Offloading Modes&rdquo;.</para>
1115
1116 <para>Some target nodes may require additional configuration after
1117 they are PXE booted (bootstrapped). The most frequent changes occur in
1118 the defaults of ethernet device &rdquor;Offloading Modes&rdquo;
1119 settings (e.g. certain target ethernet drivers may strip VLAN traffic
1120 by default).</para>
1121
1122 <para>If your target ethernet drivers have incorrect
1123 &rdquor;Offloading Modes&rdquo; defaults, in the &rdquor;Configure
1124 interfaces&rdquo; page (described above), expand the affected
1125 interface&rsquo;s &rdquor;Offloading Modes&rdquo; and (un)check the
1126 settings you need (see figure below): <remark>Insert the appropriate
1127 figure/screenshot</remark></para>
1128 </listitem>
1129
1130 <listitem>
1131 <para>Set up targets for &rdquor;Verify Networks&rdquo; with
1132 non-default &rdquor;Offloading Modes&rdquo;.</para>
1133
1134 <para>Please check the <ulink
1135 url="http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html">Release
1136 Notes for the 1.0 release of ENFV Core when using Fuel as a deployment
1137 tool</ulink>, <remark>Change this to an Olink to the Release notes
1138 once the ID has been created for that book. Add the ID to
1139 pardoc-names.xml and pardoc-common if needed, then updated the
1140 OlinkDB</remark>for an updated and comprehensive list of known issues
1141 and limitations, including the &rdquor;Offloading Modes&rdquo; not
1142 being applied during the &rdquor;Verify Networks&rdquo; step.</para>
1143
1144 <para>Setting custom &rdquor;Offloading Modes&rdquo; in Fuel GUI will
1145 only apply during provisioning and not during &rdquor;Verify
1146 Networks&rdquo;. If your targets need this change, you have to apply
1147 &rdquor;Offloading Modes&rdquo; settings manually to bootstrapped
1148 nodes. E.g.: Our driver has the &rdquor;rx-vlan-filter&rdquo; default
1149 &rdquor;on&rdquo; (expected &rdquor;off&rdquo;) on the OpenStack
1150 interface &rdquor;eth1&rdquo;, preventing VLAN traffic from passing
1151 during &rdquor;Verify Networks&rdquo;.</para>
1152
1153 <itemizedlist>
1154 <listitem>
1155 <para>From Fuel master console identify target nodes' admin IPs
1156 (see figure below):</para>
1157
1158 <programlisting>$ fuel nodes</programlisting>
1159
1160 <remark>Insert the appropriate figure/screenshot</remark>
1161 </listitem>
1162
1163 <listitem>
1164 <para>SSH into each of the target nodes and disable the
1165 &rdquor;rx-vlan-filter&rdquo; on the affected physical
1166 interface(s) allocated for OpenStack traffic (eth1):</para>
1167
1168 <programlisting>$ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off</programlisting>
1169 </listitem>
1170
1171 <listitem>
1172 <para>Repeat the step above for all affected nodes/interfaces in
1173 the POD</para>
1174 </listitem>
1175 </itemizedlist>
1176 </listitem>
1177 </orderedlist>
1178 </section>
1179
1180 <section id="verify_net">
1181 <title>Verify Networks</title>
1182
1183 <para>It is important that the Verify Networks action is performed as it
1184 will verify that Communicate <remark>what is Communicate and does this
1185 apply to our settings</remark> works for the networks you have setup.
1186 Also, check that packages needed for a successful deployment can be
1187 fetched:</para>
1188
1189 <orderedlist>
1190 <listitem>
1191 <para>From the FUEL UI in your environment, select the Networks Tab,
1192 then select &rdquor;Connectivity check&rdquo; on the left pane.</para>
1193 </listitem>
1194
1195 <listitem>
1196 <para>Select [Verify Networks]</para>
1197 </listitem>
1198
1199 <listitem>
1200 <para>Continue to fix your topology (physical switch, etc) until the
1201 &rdquor;Verification Succeeded&rdquo; and &rdquor;Your network is
1202 configured correctly&rdquo; messages are shown.</para>
1203 </listitem>
1204 </orderedlist>
1205 </section>
1206
1207 <section id="deploy_env">
1208 <title>Deploy your Environment</title>
1209
1210 <para>As instructed in the installation guide, after the configuration is
1211 complete and the network connectivity checked, it&rsquo;s time to deploy.
1212 From the Dashboard tab click on Deploy. The process should take around 2
1213 hours the first time after a fresh Fuel Master installation. Part of the
1214 deploy process is to build the target image, which can take around between
1215 30 and 60 minutes.</para>
1216
1217 <para>The entire deploy process goes through two phases:</para>
1218
1219 <itemizedlist>
1220 <listitem>
1221 <para>Provisioning &ndash; at this stage the nodes have been booted
1222 from PXE and are running a small bootstrap image in ramdisk. The
1223 provisioning process will write the target image on the disk and make
1224 other preparations for running it after reboot</para>
1225 </listitem>
1226
1227 <listitem>
1228 <para>OpenStack installation &ndash; at this stage the nodes have been
1229 rebooted on the newly written target image and the OpenStack
1230 components are installed and configured</para>
1231 </listitem>
1232 </itemizedlist>
1233 </section>
1234
1235 <section id="health_check">
1236 <title>Installation Health-Check</title>
1237
1238 <para>Once the deploy process is complete, it is recommended to run a
1239 health check from the Fuel menu, as described in the installation guide.
1240 To ensure apt performance, the system health-check must be performed. This
1241 is done in the following way:</para>
1242
1243 <orderedlist>
1244 <listitem>
1245 <para>Click the &rdquor;Health Check&rdquo; tab inside your
1246 Environment in the FUEL Web UI</para>
1247 </listitem>
1248
1249 <listitem>
1250 <para>Check the [Select All] option, then click [Run Tests]</para>
1251 </listitem>
1252
1253 <listitem>
1254 <para>Allow tests to run and investigate results where
1255 appropriate</para>
1256 </listitem>
1257 </orderedlist>
1258 </section>
1259</chapter> \ No newline at end of file