summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Borg <martin.borg@enea.com>2019-08-26 15:02:02 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2019-09-04 18:11:48 +0200
commitbcf37fdb8872b5073aa8ad919daca93090a48e61 (patch)
tree96ce0cb66df0e3b829b234b68594349bff1fbe99
parentfd686f0cb191e2711b9aedae3dcfeeed474f98f4 (diff)
downloadel_releases-nfv-access-bcf37fdb8872b5073aa8ad919daca93090a48e61.tar.gz
Example Use-cases: Update Fortigate example
- Replace bundles with VNF images and update onboarding instructions - Remove screenshots of uCPE manager GUI - Cleanup of unnecessary information Change-Id I36ec799b5843be80c44c7606e6e7b8bc6b5979e6 Signed-off-by: Martin Borg <martin.borg@enea.com> Change-Id: I6f1f81443ca6d1c6764228cf1097ede8129c7c22
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml684
1 files changed, 229 insertions, 455 deletions
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
index 48f2995..6205ced 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
@@ -7,23 +7,10 @@
7 appliances. The virtual appliances can be integrated in Firewall or SD-WAN 7 appliances. The virtual appliances can be integrated in Firewall or SD-WAN
8 solution development.</para> 8 solution development.</para>
9 9
10 <para>Enea provides a prepared VNF bundle for usage with Enea NFV Access.
11 The bundle includes the FortiGate VNF image as well as a VNF Descriptor and
12 other onboarding related configuration files.</para>
13
14 <para>The VNF Descriptor represents one specific setup, suitable for usage
15 with the Firewall and SD-WAN VPN instructions in this guide. Alternative VNF
16 Descriptor configurations may be needed to support other setups desired by
17 the customer.</para>
18
19 <para>Enea can offer assistance and provide alternative VNF Descriptor
20 configurations.</para>
21
22 <section id="forti_firewall_prereq"> 10 <section id="forti_firewall_prereq">
23 <title>Prerequisites</title> 11 <title>Prerequisites</title>
24 12
25 <para>The following hardware and software resources are needed for this 13 <para>System requirements for the uCPE device:</para>
26 example use case:</para>
27 14
28 <itemizedlist> 15 <itemizedlist>
29 <listitem> 16 <listitem>
@@ -37,6 +24,15 @@
37 <listitem> 24 <listitem>
38 <para>1 GB of RAM memory</para> 25 <para>1 GB of RAM memory</para>
39 </listitem> 26 </listitem>
27 </itemizedlist>
28
29 <para>The following files are needed for this example use case:</para>
30
31 <itemizedlist>
32 <listitem>
33 <para>FortiGate VNF image. This file is provided by the local Fortinet
34 sales representatives in your region.</para>
35 </listitem>
40 36
41 <listitem> 37 <listitem>
42 <para>FortiGate VNF license file. This file is provided by the local 38 <para>FortiGate VNF license file. This file is provided by the local
@@ -44,8 +40,13 @@
44 </listitem> 40 </listitem>
45 41
46 <listitem> 42 <listitem>
47 <para>FortiGate specific documentation. These files are provided by 43 <para>FortiGate specific documentation. This is provided by the local
48 the local Fortinet sales representatives in your region.</para> 44 Fortinet sales representatives in your region.</para>
45 </listitem>
46
47 <listitem>
48 <para>FortiGate configuration example files. These files are provided
49 with your Enea NFV Access release.</para>
49 </listitem> 50 </listitem>
50 </itemizedlist> 51 </itemizedlist>
51 </section> 52 </section>
@@ -53,13 +54,6 @@
53 <section id="fortigate_firewall_uc_1"> 54 <section id="fortigate_firewall_uc_1">
54 <title>FortiGate VNF as a Firewall</title> 55 <title>FortiGate VNF as a Firewall</title>
55 56
56 <para>FortiGate Next Generation Firewall utilizes purpose-built security
57 processors and threat intelligence security services to deliver top-rated
58 protection and high performance, including encrypted traffic. FortiGate
59 reduces complexity with automated visibility into applications, users and
60 networks, and provides security ratings to adopt security best
61 practices.</para>
62
63 <para>Enea provides an example of a simple base firewall configuration for 57 <para>Enea provides an example of a simple base firewall configuration for
64 the FortiGate VNF.</para> 58 the FortiGate VNF.</para>
65 59
@@ -67,7 +61,9 @@
67 <title>FortiGate VNF Example Configuration</title> 61 <title>FortiGate VNF Example Configuration</title>
68 62
69 <tgroup cols="2"> 63 <tgroup cols="2">
70 <colspec align="center" /> 64 <colspec align="center" colwidth="1*" />
65
66 <colspec align="center" colwidth="4*" />
71 67
72 <thead> 68 <thead>
73 <row> 69 <row>
@@ -110,11 +106,11 @@
110 </table> 106 </table>
111 107
112 <para><superscript>1</superscript>FortiGate In-Band Management is a 108 <para><superscript>1</superscript>FortiGate In-Band Management is a
113 feature for running FortiGate Management traffic over WAN.</para> 109 feature used for running FortiGate Management traffic over WAN.</para>
114 110
115 <para>Instructions on how to alter the default configuration are provided, 111 <para>Instructions on how to alter the default configuration are provided in section
116 <olink targetdoc="book_enea_nfv_access_example_usecases" 112 <olink targetdoc="book_enea_nfv_access_example_usecases"
117 targetptr="fortigate_webmg">FortiGate VNF Management in <xi:include 113 targetptr="fortigate_webmg">FortiGate VNF Web Management in <xi:include
118 href="../../s_docbuild/olinkdb/pardoc-names.xml" 114 href="../../s_docbuild/olinkdb/pardoc-names.xml"
119 xmlns:xi="http://www.w3.org/2001/XInclude" 115 xmlns:xi="http://www.w3.org/2001/XInclude"
120 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>.</para> 116 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>.</para>
@@ -123,8 +119,8 @@
123 <title>Lab Setup</title> 119 <title>Lab Setup</title>
124 120
125 <para>Before starting the configuration of the FortiGate Firewall, a lab 121 <para>Before starting the configuration of the FortiGate Firewall, a lab
126 setup of hardware and software configurations has to be built. The 122 setup concerning hardware and software components has to be created. The
127 following table illustrates the requirements.</para> 123 following table illustrates the requirements for this setup.</para>
128 124
129 <table> 125 <table>
130 <title>Lab Setup Prerequisites</title> 126 <title>Lab Setup Prerequisites</title>
@@ -147,11 +143,11 @@
147 <entrytbl cols="1"> 143 <entrytbl cols="1">
148 <tbody> 144 <tbody>
149 <row> 145 <row>
150 <entry>DHCP enabled Lab Network</entry> 146 <entry>DHCP enabled Lab Network.</entry>
151 </row> 147 </row>
152 148
153 <row> 149 <row>
154 <entry>Internet Connectivity</entry> 150 <entry>Internet Connectivity.</entry>
155 </row> 151 </row>
156 </tbody> 152 </tbody>
157 </entrytbl> 153 </entrytbl>
@@ -164,32 +160,32 @@
164 <entrytbl cols="1"> 160 <entrytbl cols="1">
165 <tbody> 161 <tbody>
166 <row> 162 <row>
167 <entry>Minimum 4 Physical Network Devices</entry> 163 <entry>Minimum 4 Physical Network Devices.</entry>
168 </row> 164 </row>
169 165
170 <row> 166 <row>
171 <entry>4 GB RAM and 4 cores (C3000 or Xeon D)</entry> 167 <entry>4 GB RAM and 4 cores (C3000 or Xeon D).</entry>
172 </row> 168 </row>
173 169
174 <row> 170 <row>
175 <entry>Enea NFV Access Installed</entry> 171 <entry>Enea NFV Access Installed.</entry>
176 </row> 172 </row>
177 173
178 <row> 174 <row>
179 <entry>WAN Connected to Lab Network</entry> 175 <entry>WAN Connected to the Lab Network.</entry>
180 </row> 176 </row>
181 177
182 <row> 178 <row>
183 <entry>LAN1 Connected to Test Machine</entry> 179 <entry>LAN1 Connected to the Test Machine.</entry>
184 </row> 180 </row>
185 181
186 <row> 182 <row>
187 <entry>LAN2 Unconnected</entry> 183 <entry>LAN2 Unconnected.</entry>
188 </row> 184 </row>
189 185
190 <row> 186 <row>
191 <entry>ETH0 connected to the Lab Network (for Enea uCPE 187 <entry>ETH0 connected to the Lab Network (for Enea uCPE
192 Manager communications)</entry> 188 Manager communications).</entry>
193 </row> 189 </row>
194 </tbody> 190 </tbody>
195 </entrytbl> 191 </entrytbl>
@@ -201,15 +197,15 @@
201 <entrytbl cols="1"> 197 <entrytbl cols="1">
202 <tbody> 198 <tbody>
203 <row> 199 <row>
204 <entry>Connected to Lab Network</entry> 200 <entry>Connected to the Lab Network.</entry>
205 </row> 201 </row>
206 202
207 <row> 203 <row>
208 <entry>Running either Windows or CentOS</entry> 204 <entry>Running either Windows or CentOS.</entry>
209 </row> 205 </row>
210 206
211 <row> 207 <row>
212 <entry>Enea uCPE Manager installed</entry> 208 <entry>The Enea uCPE Manager installed.</entry>
213 </row> 209 </row>
214 </tbody> 210 </tbody>
215 </entrytbl> 211 </entrytbl>
@@ -221,45 +217,15 @@
221 <entrytbl cols="1"> 217 <entrytbl cols="1">
222 <tbody> 218 <tbody>
223 <row> 219 <row>
224 <entry>Connected to Whitebox LAN</entry> 220 <entry>Connected to Whitebox LAN.</entry>
225 </row>
226
227 <row>
228 <entry>Internet Connectivity via LAN</entry>
229 </row> 221 </row>
230 222
231 <row> 223 <row>
232 <entry>Configured as DHCP client on LAN</entry> 224 <entry>Internet Connectivity via LAN.</entry>
233 </row>
234 </tbody>
235 </entrytbl>
236 </row>
237
238 <row>
239 <entry align="left">FortiGate VNF</entry>
240
241 <entrytbl cols="1">
242 <tbody>
243 <row>
244 <entry>Copy the FortiGate VNF Bundle provided by Enea to
245 the Lab Machine file system.</entry>
246 </row>
247
248 <row>
249 <entry>Copy the FortiGate configuration examples from Enea
250 to the Lab Machine file system. Unpack the configuration
251 examples onto the Lab Machine.</entry>
252 </row>
253
254 <row>
255 <entry>Retrieve the FortiGate VNF license file from
256 Fortinet and store it on the Lab Machine file system. See
257 FortiGate VNF for details.</entry>
258 </row> 225 </row>
259 226
260 <row> 227 <row>
261 <entry>Optionally, retrieve FortiGate VNF documentation 228 <entry>Configured as the DHCP client on LAN.</entry>
262 from Fortinet. See FortiGate VNF for details.</entry>
263 </row> 229 </row>
264 </tbody> 230 </tbody>
265 </entrytbl> 231 </entrytbl>
@@ -274,7 +240,7 @@
274 <mediaobject> 240 <mediaobject>
275 <imageobject> 241 <imageobject>
276 <imagedata align="center" fileref="images/intel_whitebox.png" 242 <imagedata align="center" fileref="images/intel_whitebox.png"
277 scale="45" /> 243 contentwidth="600" />
278 </imageobject> 244 </imageobject>
279 </mediaobject> 245 </mediaobject>
280 </figure> 246 </figure>
@@ -283,93 +249,43 @@
283 <section id="exam_setup_fortifirewall"> 249 <section id="exam_setup_fortifirewall">
284 <title>Use-case Setup</title> 250 <title>Use-case Setup</title>
285 251
286 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 252 <para><emphasis role="bold">Network Configuration:</emphasis></para>
287 devices</emphasis></para>
288
289 <para>Before deploying the FortiGate Firewall, the Enea NFV Access
290 platform has to be configured to the specific networking setup.</para>
291 253
292 <para>Since the firewall uses three External Network Interfaces, three 254 <para>Since the firewall uses three External Network Interfaces, three
293 bridges need to be configured. Each bridge provides the ability to 255 bridges need to be configured. Each bridge provides the ability to
294 connect a physical network interface to the virtual machines' virtual 256 connect a physical network interface to the virtual machines' virtual
295 network interface. Each physical to virtual network interface connection 257 network interface.</para>
296 is setup in two steps:</para>
297
298 <itemizedlist>
299 <listitem>
300 <para>Bind the physical network interfaces with a DPDK
301 driver.</para>
302 </listitem>
303
304 <listitem>
305 <para>Create a named bridge for each physical network
306 interface.</para>
307 </listitem>
308 </itemizedlist>
309 258
310 <orderedlist> 259 <orderedlist>
311 <listitem> 260 <listitem>
312 <para>Start the setup by preparing each interface for attachment to 261 <para>Select the uCPE device, access
313 a bridge. Bind the physical network interfaces to the DPDK by 262 <literal>Configuration</literal> and bind the three physical network
314 selecting the uCPE device, then accessing: 263 interfaces to DPDK.</para>
315 <literal>Configuration</literal> -&gt;
316 <literal>OpenVSwitch</literal> -&gt; <literal>Host Interfaces
317 </literal>-&gt; <literal>Add</literal>.</para>
318
319 <para>The result of binding these three physical network interfaces
320 should look like the following:</para>
321
322 <figure>
323 <title>Successful Binding</title>
324
325 <mediaobject>
326 <imageobject>
327 <imagedata align="center"
328 fileref="images/result_of_binding.png" scale="65" />
329 </imageobject>
330 </mediaobject>
331 </figure>
332 </listitem>
333
334 <listitem>
335 <para>Create one Open vSwitch bridge for each firewall network
336 connection (WAN, LAN1 and LAN2), by selecting:
337 <literal>Configuration</literal> -&gt;
338 <literal>OpenVSwitch</literal> -&gt; <literal>Bridges</literal>
339 -&gt; <literal>Add</literal>.</para>
340 </listitem> 264 </listitem>
341 265
342 <listitem> 266 <listitem>
343 <para>Repeat this step for each type of connection until all are 267 <para>Create three OVS bridges, one for each DPDK network interface
344 bridges are configured.</para> 268 (WAN, LAN1 and LAN2).</para>
345
346 <figure>
347 <title>Configured Bridges per Connection Type</title>
348
349 <mediaobject>
350 <imageobject>
351 <imagedata align="center"
352 fileref="images/configured_bridges.png" scale="68" />
353 </imageobject>
354 </mediaobject>
355 </figure>
356 </listitem> 269 </listitem>
357 </orderedlist> 270 </orderedlist>
358 271
359 <para>Alternatively, the firewall can be setup to use bridges as 272 <para>Alternatively, the firewall can be setup to use bridges as
360 connection points for the Fortigate VNF, by replacing the OVS-DPDK 273 connection points for the FortiGate VNF, by replacing the OVS-DPDK
361 bridges with SR-IOV connection points.</para> 274 bridges with SR-IOV connection points.</para>
362 275
363 <para>It was previously assumed that three physical interfaces are 276 <para>Please note that while previously three physical interfaces were
364 available for VNF connection. In the case of a firewall setup only two 277 presumed necessary for VNF connection, in the case of a firewall setup
365 physical interfaces are needed for the data path (one for WAN and one 278 only two physical interfaces are required for the data path
366 for LAN). Only two interfaces will be configured as DPDK, with two 279 (one for WAN and one for LAN).</para>
367 bridges created, one for each type of connection.</para> 280
281 <para>Only two interfaces will be configured as DPDK, with two bridges
282 created, one for each type of connection.</para>
368 283
369 <para>Please note that at VNF instantiation instead of assigning 284 <note><para>At VNF instantiation instead of assigning distinct bridges for
370 distinct bridges for each LAN interface, only one will be used for both 285 each LAN interface, only one will be used for both LAN1 and LAN2,
371 LAN1 and LAN2, with no changes in WAN interface configuration. Please 286 with no changes in WAN interface configuration.</para></note>
372 see the picture below for the final setup:</para> 287
288 <para>See the picture below for the final setup:</para>
373 289
374 <figure> 290 <figure>
375 <title>Two-Interface Configuration</title> 291 <title>Two-Interface Configuration</title>
@@ -377,123 +293,138 @@
377 <mediaobject> 293 <mediaobject>
378 <imageobject> 294 <imageobject>
379 <imagedata align="center" fileref="images/two_inst_firewall.png" 295 <imagedata align="center" fileref="images/two_inst_firewall.png"
380 scale="65" /> 296 contentwidth="600" />
381 </imageobject> 297 </imageobject>
382 </mediaobject> 298 </mediaobject>
383 </figure> 299 </figure>
384 300
385 <para><emphasis role="bold">Onboarding the FortiGate 301 <para><emphasis role="bold">Onboarding the VNF:</emphasis></para>
386 VNF:</emphasis></para>
387 302
388 <orderedlist> 303 <para>Onboard the FortiGate VNF by filling the required fields with the
304 following values:</para>
305
306 <itemizedlist spacing="compact">
389 <listitem> 307 <listitem>
390 <para>To onboard the Fortigate VNF select from the top toolbar 308 <para><emphasis role="bold">VM Image File</emphasis>: Provide the
391 <literal>VNF</literal> -&gt; <literal>Descriptors</literal> -&gt; 309 path to the FortiGate VNF qcow2 image.</para>
392 <literal>On-board.</literal></para>
393 </listitem> 310 </listitem>
394 311
395 <listitem> 312 <listitem>
396 <para>Click <literal>Browse</literal> to view selections, and choose 313 <para><emphasis role="bold">Memory in MB</emphasis>: 1024</para>
397 the <literal>Fortigate.zip</literal> file, before clicking
398 <literal>Send</literal>.</para>
399 </listitem> 314 </listitem>
400 </orderedlist>
401 315
402 <para><emphasis role="bold">Instantiating the FortiGate 316 <listitem>
403 VNF</emphasis></para> 317 <para><emphasis role="bold">Num of CPUs</emphasis>: 1</para>
318 </listitem>
404 319
405 <orderedlist>
406 <listitem> 320 <listitem>
407 <para>Fortigate VNF instantiation requires the following 321 <para><emphasis role="bold">Storage in GB</emphasis>: 20</para>
408 settings:</para> 322 </listitem>
409 323
410 <table> 324 <listitem>
411 <title>Instantiation Requirements</title> 325 <para><emphasis role="bold">Interfaces</emphasis>: Add 3
326 interfaces.</para>
327 </listitem>
412 328
413 <tgroup cols="2"> 329 <listitem>
414 <colspec align="center" colwidth="1*" /> 330 <para><emphasis role="bold">Cloud-init Datasource</emphasis>:
331 ConfigDrive</para>
332 </listitem>
415 333
416 <colspec align="center" colwidth="4*" /> 334 <listitem>
335 <para><emphasis role="bold">Cloud-init Disk Type</emphasis>:
336 cdrom</para>
337 </listitem>
417 338
418 <thead> 339 <listitem>
419 <row> 340 <para><emphasis role="bold">Cloud-init content file</emphasis>: Add
420 <entry align="center">Component</entry> 341 a license file entry.</para>
342 </listitem>
343 </itemizedlist>
421 344
422 <entry align="center">Description</entry> 345 <para><emphasis role="bold">Instantiating the VNF:</emphasis></para>
423 </row>
424 </thead>
425 346
426 <tbody> 347 <para>Instantiate the FortiGate VNF by filling the required fields with
427 <row> 348 the following values:</para>
428 <entry align="left">Name</entry>
429 349
430 <entry align="left">Name of the VM which will be created on 350 <table>
431 the uCPE device.</entry> 351 <title>Instantiation Requirements</title>
432 </row>
433 352
434 <row> 353 <tgroup cols="2">
435 <entry align="left">VNF Type</entry> 354 <colspec align="center" colwidth="1*" />
436 355
437 <entry align="left">Name of the onboarded VNF 356 <colspec align="center" colwidth="4*" />
438 bundle.</entry>
439 </row>
440 357
441 <row> 358 <thead>
442 <entry align="left">VIM</entry> 359 <row>
360 <entry align="center">Field</entry>
443 361
444 <entry align="left">Name and IP address of the device where 362 <entry align="center">Description</entry>
445 the VNF will be instantiated.</entry> 363 </row>
446 </row> 364 </thead>
447 365
448 <row> 366 <tbody>
449 <entry align="left">License file</entry> 367 <row>
368 <entry align="left">Name</entry>
450 369
451 <entry align="left">FortiGate license file provided by 370 <entry align="left">Name of the VM which will be created on the
452 Fortinet.</entry> 371 uCPE device.</entry>
453 </row> 372 </row>
454 373
455 <row> 374 <row>
456 <entry align="left">Configuration file</entry> 375 <entry align="left">VNF Type</entry>
457 376
458 <entry align="left">Firewall example configuration file 377 <entry align="left">Name of the onboarded VNF.</entry>
459 provided by Enea 378 </row>
460 (<filename>FGVM080000136187_20180828_0353_basic_fw.conf</filename>).</entry>
461 </row>
462 379
463 <row> 380 <row>
464 <entry align="left">Port1 - WAN</entry> 381 <entry align="left">uCPE Device</entry>
465 382
466 <entry align="left">Set the External Interface type to Dpdk 383 <entry align="left">Select the uCPE device where the VNF will be
467 and connect it to the <literal>wanmgrbr</literal> ovs 384 instantiated.</entry>
468 bridge.</entry> 385 </row>
469 </row>
470 386
471 <row> 387 <row>
472 <entry align="left">Port2 - LAN1</entry> 388 <entry align="left">License file</entry>
473 389
474 <entry align="left">Set the Incoming Interface type to Dpdk 390 <entry align="left">The FortiGate license file provided by
475 and connect it to the <literal>lan1</literal> ovs 391 Fortinet.</entry>
476 bridge.</entry> 392 </row>
477 </row>
478 393
479 <row> 394 <row>
480 <entry align="left">Port3 - LAN2</entry> 395 <entry align="left">Configuration file</entry>
481 396
482 <entry align="left">Set the Outgoing Interface type to Dpdk 397 <entry align="left">The Firewall example configuration file provided
483 and connect it to the <literal>lan2</literal> ovs 398 by Enea
484 bridge.</entry> 399 (<filename>FGVM080000136187_20180828_0353_basic_fw.conf</filename>).</entry>
485 </row> 400 </row>
486 </tbody>
487 </tgroup>
488 </table>
489 </listitem>
490 401
491 <listitem> 402 <row>
492 <para>Select the uCPE device, then from the top toolbar select 403 <entry align="left">Port1 - WAN</entry>
493 <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt; 404
494 <literal>Add</literal>.</para> 405 <entry align="left">Set the <literal>External Interface</literal> type to
495 </listitem> 406 <literal>DPDK</literal> and connect it to the <literal>wanmgrbr</literal> ovs
496 </orderedlist> 407 bridge.</entry>
408 </row>
409
410 <row>
411 <entry align="left">Port2 - LAN1</entry>
412
413 <entry align="left">Set the <literal>Incoming Interface</literal> type to
414 <literal>DPDK</literal> and connect it to the <literal>lan1</literal> ovs
415 bridge.</entry>
416 </row>
417
418 <row>
419 <entry align="left">Port3 - LAN2</entry>
420
421 <entry align="left">Set the <literal>Outgoing Interface</literal> type to
422 <literal>DPDK</literal> and connect it to the <literal>lan2</literal> ovs
423 bridge.</entry>
424 </row>
425 </tbody>
426 </tgroup>
427 </table>
497 </section> 428 </section>
498 429
499 <section id="testing_fortigate_uc_1"> 430 <section id="testing_fortigate_uc_1">
@@ -513,9 +444,9 @@
513 444
514 <para>The FortiGate VNF management interface is accessible through the 445 <para>The FortiGate VNF management interface is accessible through the
515 WAN interface. The WAN IP address can be used from a web browser on the 446 WAN interface. The WAN IP address can be used from a web browser on the
516 Lab Machine to access the Fortigate VNF Management Web UI. Please check 447 Lab Machine to access the FortiGate VNF Management Web UI. Please check
517 <olink targetdoc="book_enea_nfv_access_example_usecases" 448 <olink targetdoc="book_enea_nfv_access_example_usecases"
518 targetptr="fortigate_webmg">Fortigate VNF web management<xi:include 449 targetptr="fortigate_webmg">FortiGate VNF web management<xi:include
519 href="../../s_docbuild/olinkdb/pardoc-names.xml" 450 href="../../s_docbuild/olinkdb/pardoc-names.xml"
520 xmlns:xi="http://www.w3.org/2001/XInclude" 451 xmlns:xi="http://www.w3.org/2001/XInclude"
521 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink> 452 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
@@ -526,19 +457,12 @@
526 <section id="fortigate_sdwan_vpn"> 457 <section id="fortigate_sdwan_vpn">
527 <title>FortiGate VNF as an SD-WAN VPN</title> 458 <title>FortiGate VNF as an SD-WAN VPN</title>
528 459
529 <para>The Software-Defined Wide-Area Network (SD-WAN or SDWAN) is a
530 specific application of software-defined networking (SDN) technology
531 applied to WAN connections. It connects enterprise networks, including
532 branch offices and data centers, over large geographic distances.</para>
533
534 <para>SD-WAN decouples the network from the management plane, detaching 460 <para>SD-WAN decouples the network from the management plane, detaching
535 traffic management and monitoring functions from hardware. Most forms of 461 traffic management and monitoring functions from hardware. Most forms of
536 SD-WAN technology create a virtual overlay that is transport-agnostic, 462 SD-WAN technology create a virtual overlay that is transport-agnostic,
537 i.e. it abstracts underlying private or public WAN connections. With an 463 i.e. it abstracts underlying private or public WAN connections.</para>
538 overlay SD-WAN, a vendor provides an edge device to the customer that
539 contains the software necessary to run the SD-WAN technology. </para>
540 464
541 <para>For deployment, the customer plugs in WAN links into the device, 465 <para>For deployment, the user plugs in WAN links into the device,
542 which automatically configures itself with the network.</para> 466 which automatically configures itself with the network.</para>
543 467
544 <para>Example SD-WAN configurations for the FortiGate VNF are provided by 468 <para>Example SD-WAN configurations for the FortiGate VNF are provided by
@@ -547,7 +471,7 @@
547 <section id="prereq_forti_sdwan_vpn"> 471 <section id="prereq_forti_sdwan_vpn">
548 <title>Prerequisites</title> 472 <title>Prerequisites</title>
549 473
550 <para>The following table illustrates the use-case prerequisites of the 474 <para>The following table illustrates the use-case prerequisites for the
551 setup:</para> 475 setup:</para>
552 476
553 <table> 477 <table>
@@ -599,21 +523,21 @@
599 </row> 523 </row>
600 524
601 <row> 525 <row>
602 <entry>VNFMgr Connected to Lab Network for VNF management 526 <entry>VNFMgr connected to the Lab Network for VNF management
603 access.</entry> 527 access.</entry>
604 </row> 528 </row>
605 529
606 <row> 530 <row>
607 <entry>WAN interfaces directly connected through Ethernet 531 <entry>WAN interfaces directly connected through the Ethernet
608 cable.</entry> 532 cable.</entry>
609 </row> 533 </row>
610 534
611 <row> 535 <row>
612 <entry>LAN Connected to Test Machine.</entry> 536 <entry>LAN connected to the Test Machine.</entry>
613 </row> 537 </row>
614 538
615 <row> 539 <row>
616 <entry>ETH0 connected to Lab Network (for Enea uCPE 540 <entry>ETH0 connected to the Lab Network (for Enea uCPE
617 Manager communications).</entry> 541 Manager communications).</entry>
618 </row> 542 </row>
619 </tbody> 543 </tbody>
@@ -626,7 +550,7 @@
626 <entrytbl cols="1"> 550 <entrytbl cols="1">
627 <tbody> 551 <tbody>
628 <row> 552 <row>
629 <entry>Connected to Lab Network.</entry> 553 <entry>Connected to the Lab Network.</entry>
630 </row> 554 </row>
631 555
632 <row> 556 <row>
@@ -634,7 +558,7 @@
634 </row> 558 </row>
635 559
636 <row> 560 <row>
637 <entry>Enea uCPE Manager installed.</entry> 561 <entry>The Enea uCPE Manager installed.</entry>
638 </row> 562 </row>
639 </tbody> 563 </tbody>
640 </entrytbl> 564 </entrytbl>
@@ -654,36 +578,7 @@
654 </row> 578 </row>
655 579
656 <row> 580 <row>
657 <entry>Configured as DHCP client on LAN.</entry> 581 <entry>Configured as the DHCP client on LAN.</entry>
658 </row>
659 </tbody>
660 </entrytbl>
661 </row>
662
663 <row>
664 <entry align="left">FortiGate VNF</entry>
665
666 <entrytbl cols="1">
667 <tbody>
668 <row>
669 <entry>FortiGate VNF Bundle copied from Enea to the Lab
670 Machine file system.</entry>
671 </row>
672
673 <row>
674 <entry>FortiGate configuration examples from Enea, copied
675 to the Lab Machine file system. Unpack the configuration
676 examples specific for SD-WAN onto the Lab Machine.</entry>
677 </row>
678
679 <row>
680 <entry>Retrieve the FortiGate VNF license from Fortinet
681 and store it on the Lab Machine file system.</entry>
682 </row>
683
684 <row>
685 <entry>Optionally, retrieve FortiGate VNF documentation
686 from Fortinet.</entry>
687 </row> 582 </row>
688 </tbody> 583 </tbody>
689 </entrytbl> 584 </entrytbl>
@@ -810,17 +705,13 @@
810 </tgroup> 705 </tgroup>
811 </table> 706 </table>
812 707
813 <para>Download locally the valid license files for the Fortigate VNF
814 from Fortinet and the configuration file provided by Enea as
815 examples.</para>
816
817 <figure> 708 <figure>
818 <title>SD-WAN: VPN Configuration</title> 709 <title>SD-WAN: VPN Configuration</title>
819 710
820 <mediaobject> 711 <mediaobject>
821 <imageobject> 712 <imageobject>
822 <imagedata align="center" 713 <imagedata align="center"
823 fileref="images/sdwan_vpn_overview_1.png" scale="55" /> 714 fileref="images/sdwan_vpn_overview_1.png" contentwidth="600" />
824 </imageobject> 715 </imageobject>
825 </mediaobject> 716 </mediaobject>
826 </figure> 717 </figure>
@@ -829,130 +720,52 @@
829 <section id="forti_examsetup_uc2"> 720 <section id="forti_examsetup_uc2">
830 <title>Use-case Setup</title> 721 <title>Use-case Setup</title>
831 722
832 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 723 <para><emphasis role="bold">Network Configuration:</emphasis></para>
833 devices</emphasis></para>
834
835 <para>Before deploying the FortiGate SD-WAN, the Enea NFV Access
836 platform has to be configured to the specific networking setup.</para>
837 724
838 <para>Since the SD-WAN VNF uses three External Network Interfaces, three 725 <para>Since the SD-WAN VNF uses three External Network Interfaces, three
839 bridges need to be configured. Each bridge provides the ability to 726 bridges need to be configured. Each bridge provides the ability to
840 connect a physical network interface to the VM's virtual network 727 connect a physical network interface to the VM's virtual network
841 interface. Each physical to virtual network interface connection is 728 interface.</para>
842 setup in two steps:</para> 729
843 730 <para>Each VNF instance will have a virtual interface for VNF
844 <itemizedlist> 731 management, for the WAN network and for LAN communication.</para>
845 <listitem>
846 <para>Bind the physical network interfaces with a DPDK
847 driver.</para>
848 </listitem>
849
850 <listitem>
851 <para>Create a named bridge for each physical network
852 interface.</para>
853 </listitem>
854 </itemizedlist>
855
856 <para>Start the setup by preparing each physical interface for
857 attachment to a bridge. Each VNF instance will have a virtual interface
858 for VNF management, for the WAN network and for LAN
859 communication.</para>
860 732
861 <orderedlist> 733 <orderedlist>
862 <listitem> 734 <listitem>
863 <para>Bind a physical interface to the DPDK by selecting uCPE device 735 <para>Select uCPE Device 1, access <literal>Configuration</literal>
864 1 first, then: <literal>Configuration</literal> -&gt; 736 and bind the three physical network interfaces to the DPDK.</para>
865 <literal>OpenVSwitch</literal> -&gt; <literal>Host
866 Interfaces</literal> -&gt; <literal>Add</literal>.</para>
867
868 <para>Repeat this step for the other two interfaces. The result of a
869 successful binding should look like the following:</para>
870
871 <figure>
872 <title>Results of Binding</title>
873
874 <mediaobject>
875 <imageobject>
876 <imagedata align="center" fileref="images/binding_results.png"
877 scale="70" />
878 </imageobject>
879 </mediaobject>
880 </figure>
881 </listitem> 737 </listitem>
882 738
883 <listitem> 739 <listitem>
884 <para>Create an Open vSwitch bridge for each SD-WAN network 740 <para>Create three OVS bridges, one for each DPDK network interface
885 connection (VNF management, WAN and LAN) by selecting the uCPE 741 (VNF management, WAN and LAN).</para>
886 device then: <literal>Configuration</literal> -&gt;
887 <literal>OpenvSwitch</literal> -&gt; <literal>Bridges</literal>
888 -&gt; <literal>Add</literal>.</para>
889 </listitem> 742 </listitem>
890 743
891 <listitem> 744 <listitem>
892 <para>Repeat this step for all network connections. Three bridges 745 <para>Repeat the steps above for uCPE device 2.</para>
893 will be created:</para>
894
895 <figure>
896 <title>OVS Bridges</title>
897
898 <mediaobject>
899 <imageobject>
900 <imagedata align="center" fileref="images/created_bridges.png"
901 scale="70" />
902 </imageobject>
903 </mediaobject>
904 </figure>
905 </listitem> 746 </listitem>
906 </orderedlist> 747 </orderedlist>
907 748
908 <para><emphasis role="bold">Onboarding the FortiGate 749 <para><emphasis role="bold">Onboarding the FortiGate VNF</emphasis></para>
909 VNF</emphasis></para>
910
911 <orderedlist>
912 <listitem>
913 <para>To onboard a VNF, select a uCPE device on the map and click
914 the <literal>VNF</literal> button in the top toolbar. Then, click
915 the <literal>Descriptors</literal> -&gt; <literal>On-board</literal>
916 -&gt; <literal>Browse</literal> options, and select the
917 <filename>Fortigate.zip</filename> file, before pressing
918 <literal>Send</literal>:</para>
919
920 <figure>
921 <title>Onboarding FortiGate VNF</title>
922
923 <mediaobject>
924 <imageobject>
925 <imagedata align="center" fileref="images/onboard.png"
926 scale="45" />
927 </imageobject>
928 </mediaobject>
929 </figure>
930 </listitem>
931 750
932 <listitem> 751 <para>See the onboarding parameters detailed in the previous use-case above.</para>
933 <para>Wait for the <literal>Onboarding Status</literal> popup to
934 display the confirmation message and select
935 <literal>OK</literal>.</para>
936 </listitem>
937 </orderedlist>
938 752
939 <para><emphasis role="bold">Instantiating the FortiGate 753 <para><emphasis role="bold">Instantiating the FortiGate VNF</emphasis></para>
940 VNF</emphasis></para>
941 754
942 <para>FortiGate VNF instantiation requires the following 755 <para>Instantiate the FortiGate VNF by filling the required fields with
943 settings:</para> 756 the following values:</para>
944 757
945 <table> 758 <table>
946 <title>FortiGate VNF Instantiation Requirements</title> 759 <title>Instantiation Requirements</title>
947 760
948 <tgroup cols="2"> 761 <tgroup cols="2">
949 <colspec align="left" colwidth="2*" /> 762 <colspec align="center" colwidth="1*" />
950 763
951 <colspec align="left" colwidth="4*" /> 764 <colspec align="center" colwidth="4*" />
952 765
953 <thead> 766 <thead>
954 <row> 767 <row>
955 <entry align="center">Component</entry> 768 <entry align="center">Field</entry>
956 769
957 <entry align="center">Description</entry> 770 <entry align="center">Description</entry>
958 </row> 771 </row>
@@ -960,57 +773,59 @@
960 773
961 <tbody> 774 <tbody>
962 <row> 775 <row>
963 <entry>Name</entry> 776 <entry align="left">Name</entry>
964 777
965 <entry>The name of the VM which will be created on the uCPE 778 <entry align="left">Name of the VM which will be created on the
966 device.</entry> 779 uCPE device.</entry>
967 </row> 780 </row>
968 781
969 <row> 782 <row>
970 <entry>VNF Type</entry> 783 <entry align="left">VNF Type</entry>
971 784
972 <entry>The name of the onboarded VNF bundle.</entry> 785 <entry align="left">Name of the onboarded VNF.</entry>
973 </row> 786 </row>
974 787
975 <row> 788 <row>
976 <entry>VIM</entry> 789 <entry align="left">uCPE Device</entry>
977 790
978 <entry>Name and IP address of the device where the VNF will be 791 <entry align="left">Select the uCPE device where the VNF will be
979 instantiated.</entry> 792 instantiated.</entry>
980 </row> 793 </row>
981 794
982 <row> 795 <row>
983 <entry>License file</entry> 796 <entry align="left">License file</entry>
984 797
985 <entry>The FortiGate license file provided by Fortinet.</entry> 798 <entry align="left">The FortiGate license file provided by
799 Fortinet.</entry>
986 </row> 800 </row>
987 801
988 <row> 802 <row>
989 <entry>Configuration file(s)</entry> 803 <entry align="left">Configuration files</entry>
990 804
991 <entry>SD-WAN example configuration files provided by Enea: 805 <entry align="left">The SD-WAN example configuration files provided
806 by Enea:
992 <literal>FGVM080000136187_20180215_0708_sdwan1.conf</literal> 807 <literal>FGVM080000136187_20180215_0708_sdwan1.conf</literal>
993 <literal>FGVM080000136188_20180215_0708_sdwan2.conf</literal></entry> 808 <literal>FGVM080000136188_20180215_0708_sdwan2.conf</literal></entry>
994 </row> 809 </row>
995 810
996 <row> 811 <row>
997 <entry>Port1 - VNFMgr</entry> 812 <entry align="left">Port1 - VNFMgr</entry>
998 813
999 <entry>Set as Dpdk type and connect it to the 814 <entry align="left">Set the type to <literal>DPDK</literal> and connect it to the
1000 <literal>vnfmgrbr</literal> bridge.</entry> 815 <literal>vnfmgrbr</literal> bridge.</entry>
1001 </row> 816 </row>
1002 817
1003 <row> 818 <row>
1004 <entry>Port2 - WAN</entry> 819 <entry align="left">Port2 - WAN</entry>
1005 820
1006 <entry>Set as Dpdk type and connect it to the 821 <entry align="left">Set the type to <literal>DPDK</literal> and connect it to the
1007 <literal>wanbr</literal> bridge.</entry> 822 <literal>wanbr</literal> bridge.</entry>
1008 </row> 823 </row>
1009 824
1010 <row> 825 <row>
1011 <entry>Port3 - LAN</entry> 826 <entry align="left">Port3 - LAN</entry>
1012 827
1013 <entry>Set as Dpdk type and connect it to the 828 <entry align="left">Set the type to <literal>DPDK</literal> and connect it to the
1014 <literal>lanbr</literal> bridge.</entry> 829 <literal>lanbr</literal> bridge.</entry>
1015 </row> 830 </row>
1016 </tbody> 831 </tbody>
@@ -1019,33 +834,15 @@
1019 834
1020 <orderedlist> 835 <orderedlist>
1021 <listitem> 836 <listitem>
1022 <para>Select a uCPE device on the map, then from the top toolbar 837 <para>Instantiate the FortiGate VNF on uCPE device 1 using the
1023 click <literal>VNF</literal> -&gt; <literal>Instances</literal> 838 <literal>sdwan1</literal> example configuration file.</para>
1024 -&gt; <literal>Add</literal>.</para>
1025 </listitem> 839 </listitem>
1026 840
1027 <listitem> 841 <listitem>
1028 <para>Use the <literal>sdwan1</literal> example configuration file 842 <para>To complete the branch-to-branch setup, configure <literal>uCPE device
1029 for uCPE device 1:</para> 843 2</literal> in the same way as <literal>uCPE device 1</literal>. Make sure to
1030 844 use the <literal>sdwan2</literal> configuration file for the second VNF
1031 <figure> 845 instantiation.</para>
1032 <title>Configuring uCPE device 1</title>
1033
1034 <mediaobject>
1035 <imageobject>
1036 <imagedata align="center"
1037 fileref="images/sdwan1_eg_config.png" scale="70" />
1038 </imageobject>
1039 </mediaobject>
1040 </figure>
1041 </listitem>
1042
1043 <listitem>
1044 <para>To complete the branch-to-branch setup, configure the peer
1045 uCPE device in the same way as <literal>uCPE device 1</literal>.
1046 Make sure to use the
1047 <filename>FGVM080000136188_20180215_0708_sdwan2.conf</filename>
1048 configuration file for the second VNF instantiation.</para>
1049 </listitem> 846 </listitem>
1050 </orderedlist> 847 </orderedlist>
1051 </section> 848 </section>
@@ -1080,7 +877,7 @@
1080 877
1081 <note> 878 <note>
1082 <para>In this SD-WAN VPN setup example, bridges were used as 879 <para>In this SD-WAN VPN setup example, bridges were used as
1083 connection points for the Fortigate VNF. It is possible to replace 880 connection points for the FortiGate VNF. It is possible to replace
1084 OVS-DPDK bridges with SR-IOV connection points.</para> 881 OVS-DPDK bridges with SR-IOV connection points.</para>
1085 </note> 882 </note>
1086 </section> 883 </section>
@@ -1089,74 +886,51 @@
1089 <section id="fortigate_webmg"> 886 <section id="fortigate_webmg">
1090 <title>FortiGate VNF Web Management</title> 887 <title>FortiGate VNF Web Management</title>
1091 888
1092 <para>In order to check the IP address assigned to the Fortigate VNF you 889 <para>In order to check the IP address assigned to the FortiGate VNF you
1093 need to connect to the Fortigate CLI.</para> 890 need to connect to the FortiGate CLI.</para>
1094
1095 <para><emphasis role="bold">Connecting to the Fortigate
1096 CLI</emphasis></para>
1097 891
1098 <orderedlist> 892 <orderedlist>
1099 <listitem> 893 <listitem>
1100 <para>Connect to the Fortigate VNF by using: <literal>SSH</literal> 894 <para>SSH to the uCPE Device (Username: root) and connect to the
1101 -&gt; <literal>user</literal> (root) and attach to the VNF's console 895 FortiGate VNF console:</para>
1102 using the <literal>virsh console</literal> command shown below:</para>
1103
1104 <figure>
1105 <title>Attaching to the VNF Console</title>
1106 896
1107 <mediaobject> 897 <programlisting>virsh list
1108 <imageobject> 898virsh console &lt;id of FortiGate VNF&gt;</programlisting>
1109 <imagedata align="center" fileref="images/virsh_console.png"
1110 scale="80" />
1111 </imageobject>
1112 </mediaobject>
1113 </figure>
1114 </listitem> 899 </listitem>
1115 900
1116 <listitem> 901 <listitem>
1117 <para>To access Fortigate CLI, use <literal>admin</literal> as the 902 <para>To access the FortiGate CLI, use <literal>admin</literal> as the
1118 user, leaving the password blank/empty, and press enter.</para> 903 user, leaving the password blank/empty, and press enter.</para>
1119 904
1120 <para>Use the CLI command <literal>get system interface</literal> to 905 <para>Use the CLI command <literal>get system interface</literal> to
1121 get the dynamic interfaces configuration.</para> 906 get the dynamic interfaces configuration.</para>
1122
1123 <figure>
1124 <title>Accessing and configuring Fortigate CLI</title>
1125
1126 <mediaobject>
1127 <imageobject>
1128 <imagedata align="center"
1129 fileref="images/access_fortigate_cli.png" scale="58" />
1130 </imageobject>
1131 </mediaobject>
1132 </figure>
1133 </listitem> 907 </listitem>
1134 908
1135 <listitem> 909 <listitem>
1136 <para>Use the IP address assigned for the management interface in the 910 <para>Use the IP address assigned for the management interface in the
1137 web browser (<literal>https://&lt;IP&gt;</literal>), to access the 911 web browser (<literal>https://&lt;IP&gt;</literal>), to access the
1138 Fortinet VNF web management interface. Use the same credentials as 912 FortiGate VNF Web Management Interface. Use the same credentials as
1139 before to login.</para> 913 before to login.</para>
1140 </listitem> 914 </listitem>
1141 915
1142 <listitem> 916 <listitem>
1143 <para>You can browse through the configuration and perform changes 917 <para>Browse through the configuration and perform changes
1144 according to your setup:</para> 918 according to your setup:</para>
1145 919
1146 <figure> 920 <figure>
1147 <title>The Fortinet Web Interface</title> 921 <title>The FortiGate VNF Web Management Interface</title>
1148 922
1149 <mediaobject> 923 <mediaobject>
1150 <imageobject> 924 <imageobject>
1151 <imagedata align="center" 925 <imagedata align="center"
1152 fileref="images/fortinet_interface.png" scale="33" /> 926 fileref="images/fortinet_interface.png" contentwidth="600" />
1153 </imageobject> 927 </imageobject>
1154 </mediaobject> 928 </mediaobject>
1155 </figure> 929 </figure>
1156 </listitem> 930 </listitem>
1157 931
1158 <listitem> 932 <listitem>
1159 <para>Optionally, alter the default Fortinet example configuration 933 <para>Optionally, alter the default FortiGate example configuration
1160 provided by Enea, through the following steps:</para> 934 provided by Enea, through the following steps:</para>
1161 935
1162 <orderedlist> 936 <orderedlist>
@@ -1188,4 +962,4 @@
1188 </listitem> 962 </listitem>
1189 </orderedlist> 963 </orderedlist>
1190 </section> 964 </section>
1191</chapter> \ No newline at end of file 965</chapter>