diff options
author | Miruna Paun <mrpa@enea.se> | 2020-04-21 11:21:45 +0200 |
---|---|---|
committer | Gerrit Code Review <gerrit2@sestogerrit02> | 2020-04-21 11:21:45 +0200 |
commit | 531ec2b2c9f05b3c5b908c70843868bc5e5fe117 (patch) | |
tree | 64d35ba78f2ae486df171d554365b4dd9a584be3 | |
parent | 36ca4fb58d1a1d93ba1567cc9134e4fffeae9583 (diff) | |
parent | 3a771d2bbea41011f5615eb3d94e6840ff0a49ec (diff) | |
download | nfv-access-documentation-531ec2b2c9f05b3c5b908c70843868bc5e5fe117.tar.gz |
Merge "Edited the AFTH User Guide Example Use Cases Appendix E (5) Getting Started Manual, including adding 2 new pictures, Removing 3." into rocko
-rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | 645 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml | 192 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 666 | ||||
-rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png | bin | 13067 -> 37721 bytes | |||
-rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png | bin | 0 -> 55326 bytes |
5 files changed, 741 insertions, 762 deletions
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index b7de1af..cdf024c 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -11,13 +11,25 @@ | |||
11 | 11 | ||
12 | <para>The <literal>/device</literal> folder contains Python scripts for | 12 | <para>The <literal>/device</literal> folder contains Python scripts for |
13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE | 13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE |
14 | device, and waiting for a uCPE device to connect to the uCPE | 14 | device, waiting for a uCPE device to connect to the uCPE Manager, as well |
15 | Manager.</para> | 15 | as scripts for adding and removing an offline configuration store.</para> |
16 | 16 | ||
17 | <para>The <literal>/network</literal> folder contains Python scripts for | 17 | <para>The <literal>/network</literal> folder contains Python scripts for |
18 | binding or unbinding a network interface to/from a uCPE device (DPDK or | 18 | binding or unbinding a network interface to and from a uCPE device (DPDK or |
19 | SR-IOV), creating or deleting an OVS network bridge, or dumping network | 19 | SR-IOV), creating or deleting an OVS network bridge, or dumping network |
20 | interface information about the available interfaces.</para> | 20 | interface information about the available interfaces. Three of the scripts |
21 | mentioned here (binding, creating, deleting) are also applicable for an | ||
22 | Offline Configuration Store.</para> | ||
23 | |||
24 | <note> | ||
25 | <para>Commands within the network folder that include the option | ||
26 | <emphasis role="bold">-o</emphasis> allow the user to perform the action | ||
27 | in an offline configuration store alternative available for use at a | ||
28 | later setup time. All options contain either <emphasis | ||
29 | role="bold">-n</emphasis>, <emphasis role="bold">-o</emphasis> or both. | ||
30 | One of them must always be provided, if both are provided, -o has | ||
31 | priority, and -n is thus ignored.</para> | ||
32 | </note> | ||
21 | 33 | ||
22 | <para>The <literal>/unittestSuite</literal> folder contains Python | 34 | <para>The <literal>/unittestSuite</literal> folder contains Python |
23 | unit-test class and loader scripts for generating specific test cases for | 35 | unit-test class and loader scripts for generating specific test cases for |
@@ -65,22 +77,24 @@ Usage: unittestSuite.py [options] | |||
65 | Run selected unit-test suite against Enea uCPE Manager. | 77 | Run selected unit-test suite against Enea uCPE Manager. |
66 | 78 | ||
67 | Options: | 79 | Options: |
68 | --version show program's version number and exit | 80 | --version show program's version number and exit |
69 | -h, --help show this help message and exit | 81 | -h, --help show this help message and exit |
70 | -u USERNAME, --username=USERNAME | 82 | -u USERNAME, --username=USERNAME |
71 | Enea uCPE Manager login username | 83 | Enea uCPE Manager login username |
72 | -p PASSWORD, --password=PASSWORD | 84 | -p PASSWORD, --password=PASSWORD |
73 | Enea uCPE Manager login password | 85 | Enea uCPE Manager login password |
74 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 86 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
75 | -n DEVICENAME, --deviceName=DEVICENAME | 87 | -n DEVICENAME, --deviceName=DEVICENAME |
76 | Name of vCPE device (Virtual Infrastructure Manager) | 88 | Name of vCPE device (Virtual Infrastructure Manager) |
77 | -s SUITEFILE, --suite=SUITEFILE | 89 | -s SUITEFILE, --suite=SUITEFILE |
78 | Test suite configuration file in JSON format | 90 | Test suite configuration file in JSON format |
79 | -d DESCRIPTION, --description=DESCRIPTION | 91 | -d DESCRIPTION, --description=DESCRIPTION |
80 | Test suite description | 92 | Test suite description |
93 | -o OFFLINE, --offline=OFFLINE | ||
94 | Offline Configuration(ZTP) | ||
81 | 95 | ||
82 | Mandatory options: | 96 | Mandatory options: |
83 | -H/--host, -n/--deviceName, -s/--suiteFile, -d/--description</programlisting> | 97 | -H/--host, -n/--deviceName, -s/--suiteFile, -d/--description</programlisting> |
84 | </section> | 98 | </section> |
85 | 99 | ||
86 | <section id="config_ut_json"> | 100 | <section id="config_ut_json"> |
@@ -319,188 +333,183 @@ NOTSET 0</programlisting></para> | |||
319 | scenario:</para> | 333 | scenario:</para> |
320 | 334 | ||
321 | <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s | 335 | <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s |
322 | fortigateDeploy.json -d "Fortigate deployment scenario" | 336 | fortigateDeploy.json -d "Fortigate deployment scenario"</programlisting> |
323 | </programlisting> | ||
324 | 337 | ||
325 | <para>Setting the console logging level to DEBUG:</para> | 338 | <para>Setting the console logging level to DEBUG:</para> |
326 | 339 | ||
327 | <para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting> | 340 | <para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting> |
328 | <emphasis role="bold">Expected Output:</emphasis> <programlisting>2019-03-07 18:03:20,791 - DEBUG: Started logging | 341 | <emphasis role="bold">Expected Output:</emphasis></para> |
342 | |||
343 | <programlisting>2020-04-15 07:58:40,668 - DEBUG: Started logging | ||
329 | 344 | ||
330 | Running Fortigate deployment scenario... | 345 | Running Fortigate deployment scenario... |
331 | 346 | ||
332 | test 001: Add VCPE Agent device (__main__.UnittestSuite) ... | 347 | test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ... |
333 | 2019-03-07 18:03:20,795 - INFO: Add uCPE device | 348 | 2020-04-15 07:58:40,681 - INFO: Wait uCPE device |
334 | 2019-03-07 18:03:20,924 - DEBUG: Login successful on host 'localhost' | 349 | 2020-04-15 07:58:40,722 - DEBUG: Login successful on host 'localhost' |
335 | 2019-03-07 18:03:20,925 - DEBUG: Session token is: 876160c3-40f2-11e9-a81f525400d08e1d | 350 | 2020-04-15 07:58:40,723 - DEBUG: Session token is: 280028c0-7ede-11ea-a9a8-02429dc76bdd |
336 | 2019-03-07 18:03:20,949 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host | 351 | 2020-04-15 07:58:40,746 - DEBUG: Found device with name 'intelc3850-2' |
337 | 2019-03-07 18:03:21,100 - INFO: Done | 352 | 2020-04-15 07:58:40,747 - DEBUG: Wait for device 'intelc3850-2' to connect |
338 | 2019-03-07 18:03:21,133 - DEBUG: Logging out and exiting... | 353 | 2020-04-15 07:58:41,769 - DEBUG: HACK: sleep 30s more |
339 | ok | 354 | 2020-04-15 07:59:11,791 - DEBUG: HACK: continue |
340 | test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ... | 355 | 2020-04-15 07:59:11,792 - INFO: Status: Connected |
341 | 2019-03-07 18:03:21,133 - INFO: Wait uCPE device | 356 | 2020-04-15 07:59:11,793 - INFO: Done |
342 | 2019-03-07 18:03:21,149 - DEBUG: Login successful on host 'localhost' | 357 | 2020-04-15 07:59:11,827 - DEBUG: Logging out and exiting... |
343 | 2019-03-07 18:03:21,149 - DEBUG: Session token is: 8785b1a0-40f2-11e9-a81f525400d08e1d | ||
344 | 2019-03-07 18:03:21,157 - DEBUG: Found device with name 'intelc3850-2' | ||
345 | 2019-03-07 18:03:21,157 - DEBUG: Wait for device 'intelc3850-2' to connect | ||
346 | 2019-03-07 18:03:29,356 - DEBUG: Status: Connected | ||
347 | 2019-03-07 18:03:29,356 - INFO: Done | ||
348 | 2019-03-07 18:03:29,365 - DEBUG: Logging out and exiting... | ||
349 | ok | 358 | ok |
350 | test 003: Bind lan NIC to DPDK (__main__.UnittestSuite) ... | 359 | test 002: Bind lan NIC to DPDK (__main__.UnittestSuite) ... |
351 | 2019-03-07 18:03:29,366 - INFO: Bind NIC | 360 | 2020-04-15 07:59:11,832 - INFO: Bind NIC |
352 | 2019-03-07 18:03:29,406 - DEBUG: Login successful on host 'localhost' | 361 | 2020-04-15 07:59:11,868 - DEBUG: Login successful on host 'localhost' |
353 | 2019-03-07 18:03:29,406 - DEBUG: Session token is: 8c719cb0-40f2-11e9-a81f525400d08e1d | 362 | 2020-04-15 07:59:11,870 - DEBUG: Session token is: 3a90a960-7ede-11ea-a9a8-02429dc76bdd |
354 | 2019-03-07 18:03:29,415 - DEBUG: Found device with name 'intelc3850-2' | 363 | 2020-04-15 07:59:11,897 - DEBUG: Found device with name 'intelc3850-2' |
355 | 2019-03-07 18:03:29,415 - DEBUG: Bind NIC '0000:01:00.1' | 364 | 2020-04-15 07:59:11,898 - DEBUG: Bind NIC 'eno6' to dpdk |
356 | 2019-03-07 18:03:30,030 - INFO: Done | 365 | 2020-04-15 07:59:12,952 - INFO: Done |
357 | 2019-03-07 18:03:30,067 - DEBUG: Logging out and exiting... | 366 | 2020-04-15 07:59:12,983 - DEBUG: Logging out and exiting... |
358 | ok | 367 | ok |
359 | test 004: Bind wan NIC to DPDK (__main__.UnittestSuite) ... | 368 | test 003: Bind wan NIC to DPDK (__main__.UnittestSuite) ... |
360 | 2019-03-07 18:03:30,068 - INFO: Bind NIC | 369 | 2020-04-15 07:59:12,986 - INFO: Bind NIC |
361 | 2019-03-07 18:03:30,086 - DEBUG: Login successful on host 'localhost' | 370 | 2020-04-15 07:59:13,023 - DEBUG: Login successful on host 'localhost' |
362 | 2019-03-07 18:03:30,087 - DEBUG: Session token is: 8cd95f32-40f2-11e9-a81f525400d08e1d | 371 | 2020-04-15 07:59:13,025 - DEBUG: Session token is: 3b410da0-7ede-11ea-a9a8-02429dc76bdd |
363 | 2019-03-07 18:03:30,095 - DEBUG: Found device with name 'intelc3850-2' | 372 | 2020-04-15 07:59:13,048 - DEBUG: Found device with name 'intelc3850-2' |
364 | 2019-03-07 18:03:30,096 - DEBUG: Bind NIC 'enp4s0f1' | 373 | 2020-04-15 07:59:13,050 - DEBUG: Bind NIC 'eno8' to dpdk |
365 | 2019-03-07 18:03:30,729 - INFO: Done | 374 | 2020-04-15 07:59:14,365 - INFO: Done |
366 | 2019-03-07 18:03:30,767 - DEBUG: Logging out and exiting... | 375 | 2020-04-15 07:59:14,392 - DEBUG: Logging out and exiting... |
367 | ok | 376 | ok |
368 | test 005: Creating network bridge LAN (__main__.UnittestSuite) ... | 377 | test 004: Creating network bridge LAN (__main__.UnittestSuite) ... |
369 | 2019-03-07 18:03:30,768 - INFO: New OVS network bridge | 378 | 2020-04-15 07:59:14,395 - INFO: New OVS network bridge |
370 | 2019-03-07 18:03:30,801 - DEBUG: Login successful on host 'localhost' | 379 | 2020-04-15 07:59:14,428 - DEBUG: Login successful on host 'localhost' |
371 | 2019-03-07 18:03:30,801 - DEBUG: Session token is: 8d454061-40f2-11e9-a81f525400d08e1d | 380 | 2020-04-15 07:59:14,429 - DEBUG: Session token is: 3c174961-7ede-11ea-a9a8-02429dc76bdd |
372 | 2019-03-07 18:03:30,811 - DEBUG: Found device with name 'intelc3850-2' | 381 | 2020-04-15 07:59:14,452 - DEBUG: Found device with name 'intelc3850-2' |
373 | 2019-03-07 18:03:30,812 - DEBUG: Create new OVS network bridge 'lan_br' | 382 | 2020-04-15 07:59:14,453 - DEBUG: Create new OVS network bridge 'lan_br' |
374 | 2019-03-07 18:03:37,358 - INFO: Done | 383 | 2020-04-15 07:59:14,454 - DEBUG: Attaching interface 'eno6' to bridge 'lan_br' |
375 | 2019-03-07 18:03:37,402 - DEBUG: Logging out and exiting... | 384 | 2020-04-15 07:59:21,751 - INFO: Done |
385 | 2020-04-15 07:59:21,779 - DEBUG: Logging out and exiting... | ||
376 | ok | 386 | ok |
377 | test 006: Creating network bridge WAN (__main__.UnittestSuite) ... | 387 | test 005: Creating network bridge WAN (__main__.UnittestSuite) ... |
378 | 2019-03-07 18:03:37,402 - INFO: New OVS network bridge | 388 | 2020-04-15 07:59:21,782 - INFO: New OVS network bridge |
379 | 2019-03-07 18:03:37,461 - DEBUG: Login successful on host 'localhost' | 389 | 2020-04-15 07:59:21,818 - DEBUG: Login successful on host 'localhost' |
380 | 2019-03-07 18:03:37,461 - DEBUG: Session token is: 913c4420-40f2-11e9-a81f525400d08e1d | 390 | 2020-04-15 07:59:21,819 - DEBUG: Session token is: 407ec231-7ede-11ea-a9a8-02429dc76bdd |
381 | 2019-03-07 18:03:37,485 - DEBUG: Found device with name 'intelc3850-2' | 391 | 2020-04-15 07:59:21,845 - DEBUG: Found device with name 'intelc3850-2' |
382 | 2019-03-07 18:03:37,485 - DEBUG: Create new OVS network bridge 'wan_br' | 392 | 2020-04-15 07:59:21,846 - DEBUG: Create new OVS network bridge 'wan_br' |
383 | 2019-03-07 18:03:37,755 - INFO: Done | 393 | 2020-04-15 07:59:21,847 - DEBUG: Attaching interface 'eno8' to bridge 'wan_br' |
384 | 2019-03-07 18:03:37,792 - DEBUG: Logging out and exiting... | 394 | 2020-04-15 07:59:22,813 - INFO: Done |
395 | 2020-04-15 07:59:22,845 - DEBUG: Logging out and exiting... | ||
385 | ok | 396 | ok |
386 | test 007: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... | 397 | test 006: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... |
387 | 2019-03-07 18:03:37,792 - INFO: Onboard wizard | 398 | 2020-04-15 07:59:22,849 - INFO: Onboard wizard |
388 | 2019-03-07 18:03:37,859 - DEBUG: Login successful on host 'localhost' | 399 | 2020-04-15 07:59:22,885 - DEBUG: Login successful on host 'localhost' |
389 | 2019-03-07 18:03:37,859 - DEBUG: Session token is: 91770330-40f2-11e9-a81f525400d08e1d | 400 | 2020-04-15 07:59:22,886 - DEBUG: Session token is: 4121b8f1-7ede-11ea-a9a8-02429dc76bdd |
390 | 2019-03-07 18:03:37,860 - DEBUG: FTP file '../../vnf_bundles/fortios.qcow2' on host | 401 | 2020-04-15 07:59:22,890 - DEBUG: FTP file '../../vnf_image/fortios.qcow2' on host \ |
391 | 'localhost', port '2021' | 402 | 'localhost', port '2021' |
392 | 2019-03-07 18:03:38,027 - DEBUG: Onboard VNF raw: fortios.qcow2 | 403 | 2020-04-15 07:59:23,127 - DEBUG: Onboard VNF raw: fortios.qcow2 |
393 | 2019-03-07 18:03:41,701 - INFO: Done | 404 | 2020-04-15 07:59:27,107 - INFO: Done |
394 | 2019-03-07 18:03:41,748 - DEBUG: Logging out and exiting... | 405 | 2020-04-15 07:59:27,140 - DEBUG: Logging out and exiting... |
395 | ok | 406 | ok |
396 | test 008: Instantiate Fortigate VNF (__main__.UnittestSuite) ... | 407 | test 007: Instantiate Fortigate VNF (__main__.UnittestSuite) ... |
397 | 2019-03-07 18:03:41,778 - INFO: Instantiate VNF | 408 | 2020-04-15 07:59:27,144 - INFO: Instantiate VNF |
398 | 2019-03-07 18:03:41,813 - DEBUG: Login successful on host 'localhost' | 409 | 2020-04-15 07:59:27,182 - DEBUG: Login successful on host 'localhost' |
399 | 2019-03-07 18:03:41,815 - DEBUG: Session token is: 93d69e10-40f2-11e9-a81f525400d08e1d | 410 | 2020-04-15 07:59:27,184 - DEBUG: Session token is: 43b16480-7ede-11ea-a9a8-02429dc76bdd |
400 | 2019-03-07 18:03:41,834 - DEBUG: Found device with name 'intelc3850-2' | 411 | 2020-04-15 07:59:27,207 - DEBUG: Found device with name 'intelc3850-2' |
401 | 2019-03-07 18:03:41,878 - DEBUG: Found VNF descriptor with name 'fortigateImage' | 412 | 2020-04-15 07:59:27,281 - DEBUG: Found VNF descriptor with name 'fortigateImage' |
402 | 2019-03-07 18:03:41,888 - DEBUG: Encrypt string content: | 413 | 2020-04-15 07:59:27,286 - DEBUG: Reading file content as text: \ |
403 | cloudInit("vnf_config/fortigateImage/fortigateFW.conf") | 414 | vnf_config/fortigateImage/fortigateFW.conf |
404 | 2019-03-07 18:03:41,889 - DEBUG: Encrypt string content: | 415 | 2020-04-15 07:59:27,359 - DEBUG: Encrypt file content: \ |
405 | License("vnf_config/fortigateImage/fortigateLicense.lic") | 416 | vnf_config/fortigateImage/fortigateFW.conf |
406 | 2019-03-07 18:03:41,889 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2' | 417 | 2020-04-15 07:59:27,364 - DEBUG: Reading file content as text: \ |
407 | 2019-03-07 18:03:49,887 - INFO: Done | 418 | vnf_config/fortigateImage/fortigateLicense.lic |
408 | 2019-03-07 18:03:49,921 - DEBUG: Logging out and exiting... | 419 | 2020-04-15 07:59:27,407 - DEBUG: Encrypt file content: \ |
420 | vnf_config/fortigateImage/fortigateLicense.lic | ||
421 | 2020-04-15 07:59:27,409 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2' | ||
422 | 2020-04-15 07:59:32,720 - INFO: Done | ||
423 | 2020-04-15 07:59:32,747 - DEBUG: Logging out and exiting... | ||
409 | ok | 424 | ok |
410 | test 009: Pause Fortigate VNF instance (__main__.UnittestSuite) ... | 425 | test 008: Pause Fortigate VNF instance (__main__.UnittestSuite) ... |
411 | 2019-03-07 18:03:49,923 - INFO: Control VNF | 426 | 2020-04-15 07:59:32,840 - INFO: Control VNF |
412 | 2019-03-07 18:03:49,982 - DEBUG: Login successful on host 'localhost' | 427 | 2020-04-15 07:59:32,877 - DEBUG: Login successful on host 'localhost' |
413 | 2019-03-07 18:03:49,983 - DEBUG: Session token is: 98b17220-40f2-11e9-a81f525400d08e1d | 428 | 2020-04-15 07:59:32,880 - DEBUG: Session token is: 47166170-7ede-11ea-a9a8-02429dc76bdd |
414 | 2019-03-07 18:03:49,991 - DEBUG: Found device with name 'intelc3850-2' | 429 | 2020-04-15 07:59:32,904 - DEBUG: Found device with name 'intelc3850-2' |
415 | 2019-03-07 18:03:50,031 - DEBUG: Found VNF instance with name 'fortigateFWInstance' | 430 | 2020-04-15 07:59:32,954 - DEBUG: Found VNF instance with name 'fortigateFWInstance' |
416 | 2019-03-07 18:03:50,031 - DEBUG: Control VNF instance 'intelc3850-2', command: | 431 | 2020-04-15 07:59:32,955 - DEBUG: Control VNF instance 'intelc3850-2', command: pause |
417 | pause | 432 | 2020-04-15 07:59:33,114 - INFO: Done |
418 | 2019-03-07 18:03:50,914 - INFO: Done | 433 | 2020-04-15 07:59:33,138 - DEBUG: Logging out and exiting... |
419 | 2019-03-07 18:03:50,933 - DEBUG: Logging out and exiting... | ||
420 | ok | 434 | ok |
421 | test 010: Resume Fortigate VNF instance (__main__.UnittestSuite) ... | 435 | test 009: Resume Fortigate VNF instance (__main__.UnittestSuite) ... |
422 | 2019-03-07 18:03:50,933 - INFO: Control VNF | 436 | 2020-04-15 07:59:33,142 - INFO: Control VNF |
423 | 2019-03-07 18:03:50,992 - DEBUG: Login successful on host 'localhost' | 437 | 2020-04-15 07:59:33,174 - DEBUG: Login successful on host 'localhost' |
424 | 2019-03-07 18:03:50,992 - DEBUG: Session token is: 994c0473-40f2-11e9-a81f525400d08e1d | 438 | 2020-04-15 07:59:33,177 - DEBUG: Session token is: 4743b300-7ede-11ea-a9a8-02429dc76bdd |
425 | 2019-03-07 18:03:51,005 - DEBUG: Found device with name 'intelc3850-2' | 439 | 2020-04-15 07:59:33,209 - DEBUG: Found device with name 'intelc3850-2' |
426 | 2019-03-07 18:03:51,023 - DEBUG: Found VNF instance with name 'fortigateFWInstance' | 440 | 2020-04-15 07:59:33,257 - DEBUG: Found VNF instance with name 'fortigateFWInstance' |
427 | 2019-03-07 18:03:51,024 - DEBUG: Control VNF instance 'intelc3850-2', command: | 441 | 2020-04-15 07:59:33,258 - DEBUG: Control VNF instance 'intelc3850-2', command: resume |
428 | resume | 442 | 2020-04-15 07:59:33,365 - INFO: Done |
429 | 2019-03-07 18:03:51,963 - INFO: Done | 443 | 2020-04-15 07:59:33,389 - DEBUG: Logging out and exiting... |
430 | 2019-03-07 18:03:51,991 - DEBUG: Logging out and exiting... | ||
431 | ok | 444 | ok |
432 | test 011: Stop Fortigate VNF instance (__main__.UnittestSuite) ... | 445 | test 010: Stop Fortigate VNF instance (__main__.UnittestSuite) ... |
433 | 2019-03-07 18:03:51,992 - INFO: Control VNF | 446 | 2020-04-15 07:59:33,393 - INFO: Control VNF |
434 | 2019-03-07 18:03:52,031 - DEBUG: Login successful on host 'localhost' | 447 | 2020-04-15 07:59:33,436 - DEBUG: Login successful on host 'localhost' |
435 | 2019-03-07 18:03:52,031 - DEBUG: Session token is: 99ed9ba3-40f2-11e9-a81f525400d08e1d | 448 | 2020-04-15 07:59:33,438 - DEBUG: Session token is: 476aea10-7ede-11ea-a9a8-02429dc76bdd |
436 | 2019-03-07 18:03:52,046 - DEBUG: Found device with name 'intelc3850-2' | 449 | 2020-04-15 07:59:33,467 - DEBUG: Found device with name 'intelc3850-2' |
437 | 2019-03-07 18:03:52,073 - DEBUG: Found VNF instance with name 'fortigateFWInstance' | 450 | 2020-04-15 07:59:33,511 - DEBUG: Found VNF instance with name 'fortigateFWInstance' |
438 | 2019-03-07 18:03:52,073 - DEBUG: Control VNF instance 'intelc3850-2', command: stop | 451 | 2020-04-15 07:59:33,513 - DEBUG: Control VNF instance 'intelc3850-2', command: stop |
439 | 2019-03-07 18:03:53,011 - INFO: Done | 452 | 2020-04-15 07:59:33,865 - INFO: Done |
440 | 2019-03-07 18:03:53,047 - DEBUG: Logging out and exiting... | 453 | 2020-04-15 07:59:33,891 - DEBUG: Logging out and exiting... |
441 | ok | 454 | ok |
442 | test 012: Start Fortigate VNF instance (__main__.UnittestSuite) ... | 455 | test 011: Start Fortigate VNF instance (__main__.UnittestSuite) ... |
443 | 2019-03-07 18:03:53,048 - INFO: Control VNF | 456 | 2020-04-15 07:59:33,895 - INFO: Control VNF |
444 | 2019-03-07 18:03:53,080 - DEBUG: Login successful on host 'localhost' | 457 | 2020-04-15 07:59:33,931 - DEBUG: Login successful on host 'localhost' |
445 | 2019-03-07 18:03:53,080 - DEBUG: Session token is: 9a8d8523-40f2-11e9-a81f525400d08e1d | 458 | 2020-04-15 07:59:33,932 - DEBUG: Session token is: 47b70e41-7ede-11ea-a9a8-02429dc76bdd |
446 | 2019-03-07 18:03:53,109 - DEBUG: Found device with name 'intelc3850-2' | 459 | 2020-04-15 07:59:33,956 - DEBUG: Found device with name 'intelc3850-2' |
447 | 2019-03-07 18:03:53,140 - DEBUG: Found VNF instance with name 'fortigateFWInstance' | 460 | 2020-04-15 07:59:34,013 - DEBUG: Found VNF instance with name 'fortigateFWInstance' |
448 | 2019-03-07 18:03:53,141 - DEBUG: Control VNF instance 'intelc3850-2', command: | 461 | 2020-04-15 07:59:34,015 - DEBUG: Control VNF instance 'intelc3850-2', command: start |
449 | start | 462 | 2020-04-15 07:59:36,599 - INFO: Done |
450 | 2019-03-07 18:03:54,087 - INFO: Done | 463 | 2020-04-15 07:59:36,623 - DEBUG: Logging out and exiting... |
451 | 2019-03-07 18:03:54,123 - DEBUG: Logging out and exiting... | ||
452 | ok | 464 | ok |
453 | 465 | ||
454 | ---------------------------------------------------------------------- | 466 | ---------------------------------------------------------------------- |
455 | Ran 12 tests in 33.328s | 467 | Ran 11 tests in 55.946s |
456 | 468 | ||
457 | OK</programlisting></para> | 469 | OK</programlisting> |
458 | 470 | ||
459 | <para>Below you'll find sample unit-test command line options for | 471 | <para>Below you'll find sample unit-test command line options for |
460 | running the Fortigate <emphasis role="bold">cleanup</emphasis> | 472 | running the Fortigate <emphasis role="bold">cleanup</emphasis> |
461 | scenario:</para> | 473 | scenario:</para> |
462 | 474 | ||
463 | <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s | 475 | <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s |
464 | fortigateCleanup.json -d "Fortigate cleanup scenario" | 476 | fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting> |
465 | </programlisting> | ||
466 | 477 | ||
467 | <para>Setting the console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para> | 478 | <para>Setting the console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para> |
468 | 479 | ||
469 | <para><emphasis role="bold">Expected | 480 | <para><emphasis role="bold">Expected Output:</emphasis></para> |
470 | Output:</emphasis><programlisting>Running Fortigate cleanup scenario... | 481 | |
482 | <programlisting>Running Fortigate cleanup scenario... | ||
483 | |||
471 | test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... | 484 | test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... |
472 | 2019-03-07 18:04:55,997 - INFO: Destroy VNF | 485 | 2020-04-15 08:03:40,756 - INFO: Destroy VNF |
473 | 2019-03-07 18:04:56,668 - INFO: Done | 486 | 2020-04-15 08:03:41,358 - INFO: Done |
474 | ok | 487 | ok |
475 | test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... | 488 | test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... |
476 | 2019-03-07 18:04:56,739 - INFO: Delete OVS network bridge | 489 | 2020-04-15 08:03:41,494 - INFO: Delete OVS network bridge |
477 | 2019-03-07 18:04:57,908 - INFO: Done | 490 | 2020-04-15 08:03:41,731 - INFO: Done |
478 | ok | 491 | ok |
479 | test 003: Deleting network bridge WAN (__main__.UnittestSuite) ... | 492 | test 003: Deleting network bridge WAN (__main__.UnittestSuite) ... |
480 | 2019-03-07 18:04:57,931 - INFO: Delete OVS network bridge | 493 | 2020-04-15 08:03:41,766 - INFO: Delete OVS network bridge |
481 | 2019-03-07 18:04:59,464 - INFO: Done | 494 | 2020-04-15 08:03:43,270 - INFO: Done |
482 | ok | 495 | ok |
483 | test 004: Unbind lan NIC from DPDK uCPE device (__main__.UnittestSuite) ... | 496 | test 004: Unbind lan NIC from DPDK (__main__.UnittestSuite) ... |
484 | 2019-03-07 18:04:59,477 - INFO: Unbind NIC | 497 | 2020-04-15 08:03:43,375 - INFO: Unbind NIC |
485 | 2019-03-07 18:05:00,639 - INFO: Done | 498 | 2020-04-15 08:03:45,405 - INFO: Done |
486 | ok | 499 | ok |
487 | test 005: Unbind wan NIC from DPDK uCPE device (__main__.UnittestSuite) ... | 500 | test 005: Unbind wan NIC from DPDK (__main__.UnittestSuite) ... |
488 | 2019-03-07 18:05:00,658 - INFO: Unbind NIC | 501 | 2020-04-15 08:03:45,434 - INFO: Unbind NIC |
489 | 2019-03-07 18:05:01,533 - INFO: Done | 502 | 2020-04-15 08:03:47,633 - INFO: Done |
490 | ok | 503 | ok |
491 | test 006: Offboarding Fortigate VNF (__main__.UnittestSuite) ... | 504 | test 006: Offboarding Fortigate VNF (__main__.UnittestSuite) ... |
492 | 2019-03-07 18:05:01,566 - INFO: Offboard VNF | 505 | 2020-04-15 08:03:47,701 - INFO: Offboard VNF |
493 | 2019-03-07 18:05:01,814 - INFO: Done | 506 | 2020-04-15 08:03:47,919 - INFO: Done |
494 | ok | ||
495 | test 007: Remove VCPE Agent device (__main__.UnittestSuite) ... | ||
496 | 2019-03-07 18:05:01,853 - INFO: Remove uCPE device | ||
497 | 2019-03-07 18:05:02,184 - INFO: Done | ||
498 | ok | 507 | ok |
499 | 508 | ||
500 | ---------------------------------------------------------------------- | 509 | ---------------------------------------------------------------------- |
501 | Ran 7 tests in 6.198s | 510 | Ran 6 tests in 7.192s |
502 | 511 | ||
503 | OK</programlisting></para> | 512 | OK</programlisting> |
504 | </section> | 513 | </section> |
505 | </section> | 514 | </section> |
506 | 515 | ||
@@ -826,16 +835,22 @@ Usage: configDPDK.py [options] | |||
826 | Configure DPDK | 835 | Configure DPDK |
827 | 836 | ||
828 | Options: | 837 | Options: |
829 | --version show program's version number and exit | 838 | --version show program's version number and exit |
830 | -h, --help show this help message and exit | 839 | -h, --help show this help message and exit |
831 | -u USERNAME, --username=USERNAME Enea uCPE Manager login username | 840 | -u USERNAME, --username=USERNAME |
832 | -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password | 841 | Enea uCPE Manager login username |
833 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 842 | -p PASSWORD, --password=PASSWORD |
834 | -s STATE, --state=STATE Enable/Disable | 843 | Enea uCPE Manager login password |
835 | -n DEVICENAME, --device-name=DEVICENAME Name of the device | 844 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
845 | -s STATE, --state=STATE | ||
846 | Enable/Disable | ||
847 | -n DEVICENAME, --device-name=DEVICENAME | ||
848 | Name of the device | ||
849 | -o STORENAME, --store-name=STORENAME | ||
850 | Name of the store | ||
836 | 851 | ||
837 | Mandatory options: | 852 | Mandatory options: |
838 | -H/--host, -s/--state</programlisting> | 853 | -H/--host, -s/--state, -n/--device-name or -o/--store-name</programlisting> |
839 | </section> | 854 | </section> |
840 | 855 | ||
841 | <section id="run_pydpdk"> | 856 | <section id="run_pydpdk"> |
@@ -884,24 +899,26 @@ Mandatory options: | |||
884 | <programlisting>$ python bindNetworkInterface.py -h | 899 | <programlisting>$ python bindNetworkInterface.py -h |
885 | Usage: bindNetworkInterface.py [options] | 900 | Usage: bindNetworkInterface.py [options] |
886 | 901 | ||
887 | Binds a physical network interface to a DPDK, standard or SR-IOV. | 902 | Binds a physical network interface to a DPDK or SR-IOV. |
888 | 903 | ||
889 | Options: | 904 | Options: |
890 | --version show program's version number and exit | 905 | --version show program's version number and exit |
891 | -h, --help show this help message and exit | 906 | -h, --help show this help message and exit |
892 | -u USERNAME, --username=USERNAME | 907 | -u USERNAME, --username=USERNAME |
893 | Enea uCPE Manager login username | 908 | Enea uCPE Manager login username |
894 | -p PASSWORD, --password=PASSWORD | 909 | -p PASSWORD, --password=PASSWORD |
895 | Enea uCPE Manager login password | 910 | Enea uCPE Manager login password |
896 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 911 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
897 | -f NICFILE, --file=NICFILE | 912 | -f NICFILE, --file=NICFILE |
898 | File containing network interface Information in JSON | 913 | File containing network interface Information in JSON |
899 | format | 914 | format |
900 | -n DEVICENAME, --device-name=DEVICENAME | 915 | -n DEVICENAME, --device-name=DEVICENAME |
901 | Name of the device | 916 | Name of the device |
917 | -o STORENAME, --store-name=STORENAME | ||
918 | Name of the store | ||
902 | 919 | ||
903 | Mandatory options: | 920 | Mandatory options: |
904 | -H/--host, -f/--file, -n/--device-name</programlisting> | 921 | -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting> |
905 | </section> | 922 | </section> |
906 | 923 | ||
907 | <section id="bind_config"> | 924 | <section id="bind_config"> |
@@ -1164,20 +1181,22 @@ Usage: newNetworkBridge.py [options] | |||
1164 | Create an OVS Bridge on a device. | 1181 | Create an OVS Bridge on a device. |
1165 | 1182 | ||
1166 | Options: | 1183 | Options: |
1167 | --version show program's version number and exit | 1184 | --version show program's version number and exit |
1168 | -h, --help show this help message and exit | 1185 | -h, --help show this help message and exit |
1169 | -u USERNAME, --username=USERNAME | 1186 | -u USERNAME, --username=USERNAME |
1170 | Enea uCPE Manager login username | 1187 | Enea uCPE Manager login username |
1171 | -p PASSWORD, --password=PASSWORD | 1188 | -p PASSWORD, --password=PASSWORD |
1172 | Enea uCPE Manager login password | 1189 | Enea uCPE Manager login password |
1173 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1190 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1174 | -f OVSFILE, --file=OVSFILE | 1191 | -f OVSFILE, --file=OVSFILE |
1175 | File containing OVS bridge Information in JSON format | 1192 | File containing OVS bridge Information in JSON format |
1176 | -n DEVICENAME, --device-name=DEVICENAME | 1193 | -n DEVICENAME, --device-name=DEVICENAME |
1177 | Name of the device | 1194 | Name of the device |
1195 | -o STORENAME, --store-name=STORENAME | ||
1196 | Name of the store | ||
1178 | 1197 | ||
1179 | Mandatory options: | 1198 | Mandatory options: |
1180 | -H/--host, -f/--file, -n/--device-name</programlisting> | 1199 | -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting> |
1181 | </section> | 1200 | </section> |
1182 | 1201 | ||
1183 | <section id="json_creovs"> | 1202 | <section id="json_creovs"> |
@@ -1253,20 +1272,22 @@ Usage: delNetworkBridge.py [options] | |||
1253 | Delete an OVS Bridge from a device. | 1272 | Delete an OVS Bridge from a device. |
1254 | 1273 | ||
1255 | Options: | 1274 | Options: |
1256 | --version show program's version number and exit | 1275 | --version show program's version number and exit |
1257 | -h, --help show this help message and exit | 1276 | -h, --help show this help message and exit |
1258 | -u USERNAME, --username=USERNAME | 1277 | -u USERNAME, --username=USERNAME |
1259 | Enea uCPE Manager login username | 1278 | Enea uCPE Manager login username |
1260 | -p PASSWORD, --password=PASSWORD | 1279 | -p PASSWORD, --password=PASSWORD |
1261 | Enea uCPE Manager login password | 1280 | Enea uCPE Manager login password |
1262 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1281 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1263 | -f OVSFILE, --file=OVSFILE | 1282 | -f OVSFILE, --file=OVSFILE |
1264 | File containing OVS bridge Information in JSON format | 1283 | File containing OVS bridge Information in JSON format |
1265 | -n DEVICENAME, --device-name=DEVICENAME | 1284 | -n DEVICENAME, --device-name=DEVICENAME |
1266 | Name of the device | 1285 | Name of the device |
1286 | -o STORENAME, --store-name=STORENAME | ||
1287 | Name of the store | ||
1267 | 1288 | ||
1268 | Mandatory options: | 1289 | Mandatory options: |
1269 | -H/--host, -f/--file, -n/--device-name</programlisting> | 1290 | -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting> |
1270 | </section> | 1291 | </section> |
1271 | 1292 | ||
1272 | <section id="json_delovs"> | 1293 | <section id="json_delovs"> |
@@ -1412,26 +1433,26 @@ Usage: onboardVNFRaw.py [options] | |||
1412 | Onboard a VNF in Enea uCPE Manager based upon its raw constituents. | 1433 | Onboard a VNF in Enea uCPE Manager based upon its raw constituents. |
1413 | 1434 | ||
1414 | Options: | 1435 | Options: |
1415 | --version show program's version number and exit | 1436 | --version show program's version number and exit |
1416 | -h, --help show this help message and exit | 1437 | -h, --help show this help message and exit |
1417 | -u USERNAME, --username=USERNAME | 1438 | -u USERNAME, --username=USERNAME |
1418 | Enea uCPE Manager login username | 1439 | Enea uCPE Manager login username |
1419 | -p PASSWORD, --password=PASSWORD | 1440 | -p PASSWORD, --password=PASSWORD |
1420 | Enea uCPE Manager login password | 1441 | Enea uCPE Manager login password |
1421 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1442 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1422 | -f FTPUSERNAME, --ftpUsername=FTPUSERNAME | 1443 | -f FTPUSERNAME, --ftpUsername=FTPUSERNAME |
1423 | Username for FTP | 1444 | Username for FTP |
1424 | -w FTPPASSWORD, --ftpPassword=FTPPASSWORD | 1445 | -w FTPPASSWORD, --ftpPassword=FTPPASSWORD |
1425 | FTP password | 1446 | FTP password |
1426 | -P FTPPORT, --ftpPort=FTPPORT | 1447 | -P FTPPORT, --ftpPort=FTPPORT |
1427 | FTP port | 1448 | FTP port |
1428 | -i IMAGEPATH, --imagePath=IMAGEPATH | 1449 | -i IMAGEPATH, --imagePath=IMAGEPATH |
1429 | VNF bundle image path | 1450 | VNF image path |
1430 | -b BUNDLEINFO, --bundleInfo=BUNDLEINFO | 1451 | -b IMAGEINFO, --imageInfo=IMAGEINFO |
1431 | File name of VNF bundle information in JSON format | 1452 | File name of VNF image information in JSON format |
1432 | 1453 | ||
1433 | Mandatory options: | 1454 | Mandatory options: |
1434 | -H/--host, -b/--bundleInfo, -i/--imagePath</programlisting> | 1455 | -H/--host, -b/--imageInfo, -i/--imagePath</programlisting> |
1435 | </section> | 1456 | </section> |
1436 | 1457 | ||
1437 | <section id="json_image"> | 1458 | <section id="json_image"> |
@@ -1594,22 +1615,22 @@ Usage: instantiateVNFI.py [options] | |||
1594 | Instantiate a VNF via Enea uCPE Manager. | 1615 | Instantiate a VNF via Enea uCPE Manager. |
1595 | 1616 | ||
1596 | Options: | 1617 | Options: |
1597 | --version show program's version number and exit | 1618 | --version show program's version number and exit |
1598 | -h, --help show this help message and exit | 1619 | -h, --help show this help message and exit |
1599 | -u USERNAME, --username=USERNAME | 1620 | -u USERNAME, --username=USERNAME |
1600 | Enea uCPE Manager login username | 1621 | Enea uCPE Manager login username |
1601 | -p PASSWORD, --password=PASSWORD | 1622 | -p PASSWORD, --password=PASSWORD |
1602 | Enea uCPE Manager login password | 1623 | Enea uCPE Manager login password |
1603 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1624 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1604 | -t VNFTYPE, --vnfType=VNFTYPE | 1625 | -t VNFTYPE, --vnfType=VNFTYPE |
1605 | VNF Type (Name of VNF descriptor) | 1626 | VNF Type (Name of VNF descriptor) |
1606 | -n DEVICENAME, --device-name=DEVICENAME | 1627 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
1607 | Name of the device | 1628 | Name of the device |
1608 | -f PROPSFILE, --file=PROPSFILE | 1629 | -f PROPSFILE, --file=PROPSFILE |
1609 | File containing VNF instance properties in JSON format | 1630 | File containing VNF instance properties in JSON format |
1610 | 1631 | ||
1611 | Mandatory options: | 1632 | Mandatory options: |
1612 | -H/--host, -t/--vnfType, -n/--device-name, -f/--file</programlisting> | 1633 | -H/--host, -t/--vnfType, -n/--device-name, -f/--file</programlisting> |
1613 | </section> | 1634 | </section> |
1614 | 1635 | ||
1615 | <section id="json_inst"> | 1636 | <section id="json_inst"> |
@@ -1674,22 +1695,22 @@ Usage: controlVNFI.py [options] | |||
1674 | Controls a VNF instance from Enea uCPE Manager. | 1695 | Controls a VNF instance from Enea uCPE Manager. |
1675 | 1696 | ||
1676 | Options: | 1697 | Options: |
1677 | --version show program's version number and exit | 1698 | --version show program's version number and exit |
1678 | -h, --help show this help message and exit | 1699 | -h, --help show this help message and exit |
1679 | -u USERNAME, --username=USERNAME | 1700 | -u USERNAME, --username=USERNAME |
1680 | Enea uCPE Manager login username | 1701 | Enea uCPE Manager login username |
1681 | -p PASSWORD, --password=PASSWORD | 1702 | -p PASSWORD, --password=PASSWORD |
1682 | Enea uCPE Manager login password | 1703 | Enea uCPE Manager login password |
1683 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1704 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1684 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME | 1705 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME |
1685 | Name of VNF instance | 1706 | Name of VNF instance |
1686 | -n DEVICENAME, --device-name=DEVICENAME | 1707 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
1687 | Name of the device | 1708 | Name of the device |
1688 | -c COMMAND, --command=COMMAND | 1709 | -c COMMAND, --command=COMMAND |
1689 | Control command (stop, start, pause or resume) | 1710 | Control command (stop, start, pause or resume) |
1690 | 1711 | ||
1691 | Mandatory options: | 1712 | Mandatory options: |
1692 | -H/--host, -i/--vnfInstanceName, -n/--device-name, -c/--command</programlisting> | 1713 | -H/--host, -i/--vnfInstanceName, -n/--device-name, -c/--command</programlisting> |
1693 | </section> | 1714 | </section> |
1694 | 1715 | ||
1695 | <section id="json_control"> | 1716 | <section id="json_control"> |
@@ -1758,20 +1779,20 @@ Usage: destroyVNFI.py [options] | |||
1758 | Destroys a VNF instance from Enea uCPE Manager. | 1779 | Destroys a VNF instance from Enea uCPE Manager. |
1759 | 1780 | ||
1760 | Options: | 1781 | Options: |
1761 | --version show program's version number and exit | 1782 | --version show program's version number and exit |
1762 | -h, --help show this help message and exit | 1783 | -h, --help show this help message and exit |
1763 | -u USERNAME, --username=USERNAME | 1784 | -u USERNAME, --username=USERNAME |
1764 | Enea uCPE Manager login username | 1785 | Enea uCPE Manager login username |
1765 | -p PASSWORD, --password=PASSWORD | 1786 | -p PASSWORD, --password=PASSWORD |
1766 | Enea uCPE Manager login password | 1787 | Enea uCPE Manager login password |
1767 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1788 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address |
1768 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME | 1789 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME |
1769 | Name of VNF instance | 1790 | Name of VNF instance |
1770 | -n DEVICENAME, --device-name=DEVICENAME | 1791 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
1771 | Name of the device | 1792 | Name of the device |
1772 | 1793 | ||
1773 | Mandatory options: | 1794 | Mandatory options: |
1774 | -H/--host, -i/--vnfInstanceName, -n/--device-name</programlisting> | 1795 | -H/--host, -i/--vnfInstanceName, -n/--device-name</programlisting> |
1775 | </section> | 1796 | </section> |
1776 | 1797 | ||
1777 | <section id="json_destroy"> | 1798 | <section id="json_destroy"> |
@@ -2423,6 +2444,92 @@ phase always-after-startup from inteld1521-6 | |||
2423 | 2020-04-14 14:33:52,391 - DEBUG: Logging out and exiting...</programlisting> | 2444 | 2020-04-14 14:33:52,391 - DEBUG: Logging out and exiting...</programlisting> |
2424 | </section> | 2445 | </section> |
2425 | </section> | 2446 | </section> |
2447 | |||
2448 | <section id="offline_config_store"> | ||
2449 | <title>Setting up an Offline Configuration Store</title> | ||
2450 | |||
2451 | <para>Steps and options on how to add and remove a Config Store in the | ||
2452 | Enea uCPE Manager are described below.</para> | ||
2453 | |||
2454 | <section id="script_opts_config_store"> | ||
2455 | <title>Script Options</title> | ||
2456 | |||
2457 | <para>To add a config store in the Enea uCPE Manager use the | ||
2458 | <filename>addConfigStore.py</filename> script detailed below. Bear in | ||
2459 | mind a <filename>CONFIGSTORE</filename> json file is needed to | ||
2460 | successfully run the script in order to add an offline configuration | ||
2461 | store.</para> | ||
2462 | |||
2463 | <para>Example of a <filename>CONFIGSTORE</filename> json file:</para> | ||
2464 | |||
2465 | <programlisting>{ | ||
2466 | "descr": "intelc3850-2", | ||
2467 | "version": "2.2.2", | ||
2468 | "deviceGroupingTags": "", | ||
2469 | "deviceId": "intelc3850-2", | ||
2470 | "name": "intelc3850-2" | ||
2471 | }</programlisting> | ||
2472 | |||
2473 | <para>Adding an offline config store in the Enea uCPE Manager using | ||
2474 | the command line:</para> | ||
2475 | |||
2476 | <programlisting>$ python addConfigStore.py -h | ||
2477 | Usage: addConfigStore.py [options] | ||
2478 | |||
2479 | Add a config store in Enea uCPE Manager. | ||
2480 | |||
2481 | Options: | ||
2482 | --version show program's version number and exit | ||
2483 | -h, --help show this help message and exit | ||
2484 | -u USERNAME, --username=USERNAME | ||
2485 | Enea uCPE Manager login username | ||
2486 | -p PASSWORD, --password=PASSWORD | ||
2487 | Enea uCPE Manager login password | ||
2488 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | ||
2489 | -f CONFIGSTOREFILE, --file=CONFIGSTOREFILE | ||
2490 | File containing Store Information in JSON format | ||
2491 | |||
2492 | Mandatory options: | ||
2493 | -H/--host, -f/--file</programlisting> | ||
2494 | |||
2495 | <para>Removing a config store in the Enea uCPE Manager using the | ||
2496 | command line:</para> | ||
2497 | |||
2498 | <programlisting>python removeConfigStore.py -h | ||
2499 | Usage: removeConfigStore.py [options] | ||
2500 | |||
2501 | Remove a config store from Enea uCPE Manager. | ||
2502 | |||
2503 | Options: | ||
2504 | --version show program's version number and exit | ||
2505 | -h, --help show this help message and exit | ||
2506 | -u USERNAME, --username=USERNAME | ||
2507 | Enea uCPE Manager login username | ||
2508 | -p PASSWORD, --password=PASSWORD | ||
2509 | Enea uCPE Manager login password | ||
2510 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | ||
2511 | -o STORENAME, --store-name=STORENAME | ||
2512 | Name of the Offline Config Store | ||
2513 | |||
2514 | Mandatory options: | ||
2515 | -H/--host, -o/--store-name</programlisting> | ||
2516 | |||
2517 | <para>Modifications of an Offline Configurations Store are not possible | ||
2518 | post deployment in the uCPE Manager, as there is no option for | ||
2519 | changing script states (e.g. changing the DPDK state in the | ||
2520 | <filename>configDPDK.py</filename> python script or unbinding interfaces). | ||
2521 | The offline store must be deleted and the new state(s)/changes added in, | ||
2522 | before being deployed anew. This was not deemed necessary | ||
2523 | for the current ZTP functionality.</para> | ||
2524 | |||
2525 | <para>An action on a device is applied immediately, while | ||
2526 | a configuration in an offline configuration store is something | ||
2527 | prepared for the future (when the device is added to the | ||
2528 | uCPE Manager and the configuration is sent to it). The | ||
2529 | configuration is ideally created with the needed modifications from | ||
2530 | the start.</para> | ||
2531 | </section> | ||
2532 | </section> | ||
2426 | </section> | 2533 | </section> |
2427 | 2534 | ||
2428 | <section id="test_harness"> | 2535 | <section id="test_harness"> |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml b/doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml index 6e30d4e..bdffa2f 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml | |||
@@ -10,42 +10,39 @@ Use Case1 - 128T | |||
10 | 10 | ||
11 | Running 128T Deployment... | 11 | Running 128T Deployment... |
12 | 12 | ||
13 | test 001: Add VCPE Agent from trgt-1 device (__main__.UnittestSuite) ... | 13 | test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ... |
14 | 2019-08-13 12:49:58,091 - INFO: Add uCPE device | 14 | 2020-04-15 19:04:58,037 - INFO: Wait uCPE device |
15 | 2019-08-13 12:49:58,342 - INFO: Done | 15 | 2020-04-15 19:05:29,128 - INFO: Status: Connected |
16 | 2020-04-15 19:05:29,128 - INFO: Done | ||
16 | ok | 17 | ok |
17 | test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ... | 18 | test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... |
18 | 2019-08-13 12:49:58,358 - INFO: Wait uCPE device | 19 | 2020-04-15 19:05:29,154 - INFO: Bind NIC |
19 | 2019-08-13 12:50:03,470 - INFO: Done | 20 | 2020-04-15 19:05:30,280 - INFO: Done |
20 | ok | 21 | ok |
21 | test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... | 22 | test 003: Creating ibm bridge (__main__.UnittestSuite) ... |
22 | 2019-08-13 12:50:03,486 - INFO: Bind NIC | 23 | 2020-04-15 19:05:30,302 - INFO: New OVS network bridge |
23 | 2019-08-13 12:50:03,901 - INFO: Done | 24 | 2020-04-15 19:05:50,687 - INFO: Done |
24 | ok | 25 | ok |
25 | test 004: Creating ibm bridge (__main__.UnittestSuite) ... | 26 | test 004: Creating VNF Management bridge (__main__.UnittestSuite) ... |
26 | 2019-08-13 12:50:03,920 - INFO: New OVS network bridge | 27 | 2020-04-15 19:05:50,706 - INFO: New OVS network bridge |
27 | 2019-08-13 12:50:17,465 - INFO: Done | 28 | 2020-04-15 19:05:50,982 - INFO: Done |
28 | ok | 29 | ok |
29 | test 005: Creating VNF Management bridge (__main__.UnittestSuite) ... | 30 | test 005: Creating LAN bridge and attaching lan interface to the bridge \ |
30 | 2019-08-13 12:50:17,481 - INFO: New OVS network bridge | 31 | (__main__.UnittestSuite) ... |
31 | 2019-08-13 12:50:17,626 - INFO: Done | 32 | 2020-04-15 19:05:51,001 - INFO: New OVS network bridge |
32 | ok | 33 | 2020-04-15 19:05:51,682 - INFO: Done |
33 | test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \ | ||
34 | (__main__.UnittestSuite) ... | ||
35 | 2019-08-13 12:50:17,643 - INFO: New OVS network bridge | ||
36 | 2019-08-13 12:50:18,313 - INFO: Done | ||
37 | ok | 34 | ok |
38 | test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... | 35 | test 006: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... |
39 | 2019-08-13 12:50:18,332 - INFO: Onboard wizard | 36 | 2020-04-15 19:05:51,704 - INFO: Onboard wizard |
40 | 2019-08-13 12:52:52,909 - INFO: Done | 37 | 2020-04-15 19:08:43,978 - INFO: Done |
41 | ok | 38 | ok |
42 | test 008: Instantiate 128T VNF (__main__.UnittestSuite) ... | 39 | test 007: Instantiate 128T VNF (__main__.UnittestSuite) ... |
43 | 2019-08-13 12:52:52,924 - INFO: Instantiate VNF | 40 | 2020-04-15 19:08:44,000 - INFO: Instantiate VNF |
44 | 2019-08-13 12:54:06,219 - INFO: Done | 41 | 2020-04-15 19:09:37,385 - INFO: Done |
45 | ok | 42 | ok |
46 | 43 | ||
47 | ---------------------------------------------------------------------- | 44 | ---------------------------------------------------------------------- |
48 | Ran 8 tests in 248.144s | 45 | Ran 7 tests in 279.366s |
49 | 46 | ||
50 | OK | 47 | OK |
51 | 48 | ||
@@ -57,36 +54,32 @@ Clean-up use-case1 | |||
57 | Running 128T Clean-up... | 54 | Running 128T Clean-up... |
58 | 55 | ||
59 | test 001: Destroying 128T VNF (__main__.UnittestSuite) ... | 56 | test 001: Destroying 128T VNF (__main__.UnittestSuite) ... |
60 | 2019-08-13 13:03:02,704 - INFO: Destroy VNF | 57 | 2020-04-15 19:10:41,926 - INFO: Destroy VNF |
61 | 2019-08-13 13:03:03,619 - INFO: Done | 58 | 2020-04-15 19:10:42,813 - INFO: Done |
62 | ok | 59 | ok |
63 | test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... | 60 | test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... |
64 | 2019-08-13 13:03:03,635 - INFO: Delete OVS network bridge | 61 | 2020-04-15 19:10:42,831 - INFO: Delete OVS network bridge |
65 | 2019-08-13 13:03:13,857 - INFO: Done | 62 | 2020-04-15 19:10:43,231 - INFO: Done |
66 | ok | 63 | ok |
67 | test 003: Deleting VNF management bridge (__main__.UnittestSuite) ... | 64 | test 003: Deleting VNF management bridge (__main__.UnittestSuite) ... |
68 | 2019-08-13 13:03:13,877 - INFO: Delete OVS network bridge | 65 | 2020-04-15 19:10:43,248 - INFO: Delete OVS network bridge |
69 | 2019-08-13 13:03:24,027 - INFO: Done | 66 | 2020-04-15 19:10:43,366 - INFO: Done |
70 | ok | 67 | ok |
71 | test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... | 68 | test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... |
72 | 2019-08-13 13:03:24,049 - INFO: Delete OVS network bridge | 69 | 2020-04-15 19:10:43,383 - INFO: Delete OVS network bridge |
73 | 2019-08-13 13:03:48,815 - INFO: Done | 70 | 2020-04-15 19:10:58,638 - INFO: Done |
74 | ok | 71 | ok |
75 | test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... | 72 | test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... |
76 | 2019-08-13 13:03:48,835 - INFO: Unbind NIC | 73 | 2020-04-15 19:10:58,687 - INFO: Unbind NIC |
77 | 2019-08-13 13:03:50,274 - INFO: Done | 74 | 2020-04-15 19:11:00,490 - INFO: Done |
78 | ok | 75 | ok |
79 | test 006: Offboarding 128t VNF (__main__.UnittestSuite) ... | 76 | test 006: Offboarding 128t VNF (__main__.UnittestSuite) ... |
80 | 2019-08-13 13:03:50,294 - INFO: Offboard VNF | 77 | 2020-04-15 19:11:00,509 - INFO: Offboard VNF |
81 | 2019-08-13 13:03:50,844 - INFO: Done | 78 | 2020-04-15 19:11:01,416 - INFO: Done |
82 | ok | ||
83 | test 007: Remove VCPE Agent trgt-1 device (__main__.UnittestSuite) ... | ||
84 | 2019-08-13 13:03:50,858 - INFO: Remove uCPE device | ||
85 | 2019-08-13 13:03:50,998 - INFO: Done | ||
86 | ok | 79 | ok |
87 | 80 | ||
88 | ---------------------------------------------------------------------- | 81 | ---------------------------------------------------------------------- |
89 | Ran 7 tests in 48.308s | 82 | Ran 6 tests in 19.507s |
90 | 83 | ||
91 | OK | 84 | OK |
92 | 85 | ||
@@ -94,59 +87,58 @@ OK | |||
94 | Use-case2 | 87 | Use-case2 |
95 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \ | 88 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \ |
96 | -s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" | 89 | -s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" |
90 | |||
97 | Running 128T - Fortigate SFC Deployment... | 91 | Running 128T - Fortigate SFC Deployment... |
98 | 92 | ||
99 | test 001: Add VCPE Agent from trgt-1 device (__main__.UnittestSuite) ... | 93 | test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ... |
100 | 2019-08-13 13:09:16,146 - INFO: Add uCPE device | 94 | 2020-04-15 19:12:31,906 - INFO: Wait uCPE device |
101 | 2019-08-13 13:09:16,272 - INFO: Done | 95 | 2020-04-15 19:13:02,972 - INFO: Status: Connected |
96 | 2020-04-15 19:13:02,973 - INFO: Done | ||
102 | ok | 97 | ok |
103 | test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ... | 98 | test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... |
104 | 2019-08-13 13:09:16,287 - INFO: Wait uCPE device | 99 | 2020-04-15 19:13:02,994 - INFO: Bind NIC |
105 | 2019-08-13 13:09:23,421 - INFO: Done | 100 | 2020-04-15 19:13:04,105 - INFO: Done |
106 | ok | 101 | ok |
107 | test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... | 102 | test 003: Creating ibm bridge (__main__.UnittestSuite) ... |
108 | 2019-08-13 13:09:23,445 - INFO: Bind NIC | 103 | 2020-04-15 19:13:04,122 - INFO: New OVS network bridge |
109 | 2019-08-13 13:09:24,226 - INFO: Done | 104 | 2020-04-15 19:13:10,939 - INFO: Done |
110 | ok | 105 | ok |
111 | test 004: Creating ibm bridge (__main__.UnittestSuite) ... | 106 | test 004: Creating VNF Management bridge (__main__.UnittestSuite) ... |
112 | 2019-08-13 13:09:24,245 - INFO: New OVS network bridge | 107 | 2020-04-15 19:13:10,957 - INFO: New OVS network bridge |
113 | 2019-08-13 13:09:34,720 - INFO: Done | 108 | 2020-04-15 19:13:11,246 - INFO: Done |
114 | ok | 109 | ok |
115 | test 005: Creating VNF Management bridge (__main__.UnittestSuite) ... | 110 | test 005: Creating LAN bridge and attaching lan interface to the bridge \ |
116 | 2019-08-13 13:09:34,741 - INFO: New OVS network bridge | ||
117 | 2019-08-13 13:09:34,885 - INFO: Done | ||
118 | ok | ||
119 | test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \ | ||
120 | (__main__.UnittestSuite) ... | 111 | (__main__.UnittestSuite) ... |
121 | 2019-08-13 13:09:34,903 - INFO: New OVS network bridge | 112 | 2020-04-15 19:13:11,264 - INFO: New OVS network bridge |
122 | 2019-08-13 13:09:35,566 - INFO: Done | 113 | 2020-04-15 19:13:12,010 - INFO: Done |
123 | ok | 114 | ok |
124 | test 007: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ... | 115 | test 006: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ... |
125 | 2019-08-13 13:09:35,587 - INFO: New OVS network bridge | 116 | 2020-04-15 19:13:12,026 - INFO: New OVS network bridge |
126 | 2019-08-13 13:09:35,667 - INFO: Done | 117 | 2020-04-15 19:13:12,104 - INFO: Done |
127 | ok | 118 | ok |
128 | test 008: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... | 119 | test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... |
129 | 2019-08-13 13:09:35,684 - INFO: Onboard wizard | 120 | 2020-04-15 19:13:12,118 - INFO: Onboard wizard |
130 | 2019-08-13 13:12:11,845 - INFO: Done | 121 | 2020-04-15 19:15:48,993 - INFO: Done |
131 | ok | 122 | ok |
132 | test 009: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... | 123 | test 008: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... |
133 | 2019-08-13 13:12:11,861 - INFO: Onboard wizard | 124 | 2020-04-15 19:15:49,012 - INFO: Onboard wizard |
134 | 2019-08-13 13:12:16,157 - INFO: Done | 125 | 2020-04-15 19:15:53,805 - INFO: Done |
135 | ok | 126 | ok |
136 | test 010: Instantiate 128T VNF (__main__.UnittestSuite) ... | 127 | test 009: Instantiate 128T VNF (__main__.UnittestSuite) ... |
137 | 2019-08-13 13:12:16,175 - INFO: Instantiate VNF | 128 | 2020-04-15 19:15:53,880 - INFO: Instantiate VNF |
138 | 2019-08-13 13:13:31,681 - INFO: Done | 129 | 2020-04-15 19:16:53,272 - INFO: Done |
139 | ok | 130 | ok |
140 | test 011: Instantiate Fortigate VNF (__main__.UnittestSuite) ... | 131 | test 010: Instantiate Fortigate VNF (__main__.UnittestSuite) ... |
141 | 2019-08-13 13:13:31,738 - INFO: Instantiate VNF | 132 | 2020-04-15 19:16:53,289 - INFO: Instantiate VNF |
142 | 2019-08-13 13:13:35,985 - INFO: Done | 133 | 2020-04-15 19:16:57,428 - INFO: Done |
143 | ok | 134 | ok |
144 | 135 | ||
145 | ---------------------------------------------------------------------- | 136 | ---------------------------------------------------------------------- |
146 | Ran 11 tests in 259.854s | 137 | Ran 10 tests in 265.536s |
147 | 138 | ||
148 | OK | 139 | OK |
149 | 140 | ||
141 | |||
150 | # Access 128T management interface | 142 | # Access 128T management interface |
151 | https://172.24.12.154:60001 | 143 | https://172.24.12.154:60001 |
152 | user: admin | 144 | user: admin |
@@ -166,48 +158,44 @@ Use case2 clean-up | |||
166 | Running 128T - Fortigate SFC CleanUp... | 158 | Running 128T - Fortigate SFC CleanUp... |
167 | 159 | ||
168 | test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... | 160 | test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... |
169 | 2019-08-13 13:51:30,204 - INFO: Destroy VNF | 161 | 2020-04-15 19:31:37,255 - INFO: Destroy VNF |
170 | 2019-08-13 13:51:31,781 - INFO: Done | 162 | 2020-04-15 19:31:38,941 - INFO: Done |
171 | ok | 163 | ok |
172 | test 002: Destroying 128T VNF (__main__.UnittestSuite) ... | 164 | test 002: Destroying 128T VNF (__main__.UnittestSuite) ... |
173 | 2019-08-13 13:51:31,822 - INFO: Destroy VNF | 165 | 2020-04-15 19:31:38,960 - INFO: Destroy VNF |
174 | 2019-08-13 13:51:32,729 - INFO: Done | 166 | 2020-04-15 19:31:39,878 - INFO: Done |
175 | ok | 167 | ok |
176 | test 003: Deleting network bridge SFC (__main__.UnittestSuite) ... | 168 | test 003: Deleting network bridge SFC (__main__.UnittestSuite) ... |
177 | 2019-08-13 13:51:32,756 - INFO: Delete OVS network bridge | 169 | 2020-04-15 19:31:39,908 - INFO: Delete OVS network bridge |
178 | 2019-08-13 13:51:42,863 - INFO: Done | 170 | 2020-04-15 19:31:40,086 - INFO: Done |
179 | ok | 171 | ok |
180 | test 004: Deleting network bridge LAN (__main__.UnittestSuite) ... | 172 | test 004: Deleting network bridge LAN (__main__.UnittestSuite) ... |
181 | 2019-08-13 13:51:42,878 - INFO: Delete OVS network bridge | 173 | 2020-04-15 19:31:40,102 - INFO: Delete OVS network bridge |
182 | 2019-08-13 13:51:53,087 - INFO: Done | 174 | 2020-04-15 19:31:40,388 - INFO: Done |
183 | ok | 175 | ok |
184 | test 005: Deleting VNF management bridge (__main__.UnittestSuite) ... | 176 | test 005: Deleting VNF management bridge (__main__.UnittestSuite) ... |
185 | 2019-08-13 13:51:53,103 - INFO: Delete OVS network bridge | 177 | 2020-04-15 19:31:40,427 - INFO: Delete OVS network bridge |
186 | 2019-08-13 13:52:03,251 - INFO: Done | 178 | 2020-04-15 19:31:40,678 - INFO: Done |
187 | ok | 179 | ok |
188 | test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... | 180 | test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... |
189 | 2019-08-13 13:52:03,269 - INFO: Delete OVS network bridge | 181 | 2020-04-15 19:31:40,701 - INFO: Delete OVS network bridge |
190 | 2019-08-13 13:52:29,868 - INFO: Done | 182 | 2020-04-15 19:31:46,894 - INFO: Done |
191 | ok | 183 | ok |
192 | test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... | 184 | test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... |
193 | 2019-08-13 13:52:29,885 - INFO: Unbind NIC | 185 | 2020-04-15 19:31:46,945 - INFO: Unbind NIC |
194 | 2019-08-13 13:52:31,415 - INFO: Done | 186 | 2020-04-15 19:31:48,792 - INFO: Done |
195 | ok | 187 | ok |
196 | test 008: Offboarding 128t VNF (__main__.UnittestSuite) ... | 188 | test 008: Offboarding 128t VNF (__main__.UnittestSuite) ... |
197 | 2019-08-13 13:52:31,435 - INFO: Offboard VNF | 189 | 2020-04-15 19:31:48,808 - INFO: Offboard VNF |
198 | 2019-08-13 13:52:32,009 - INFO: Done | 190 | 2020-04-15 19:31:49,554 - INFO: Done |
199 | ok | 191 | ok |
200 | test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ... | 192 | test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ... |
201 | 2019-08-13 13:52:32,023 - INFO: Offboard VNF | 193 | 2020-04-15 19:31:49,572 - INFO: Offboard VNF |
202 | 2019-08-13 13:52:32,157 - INFO: Done | 194 | 2020-04-15 19:31:49,837 - INFO: Done |
203 | ok | ||
204 | test 010: Remove VCPE Agent trgt-1 device (__main__.UnittestSuite) ... | ||
205 | 2019-08-13 13:52:32,170 - INFO: Remove uCPE device | ||
206 | 2019-08-13 13:52:32,294 - INFO: Done | ||
207 | ok | 195 | ok |
208 | 196 | ||
209 | ---------------------------------------------------------------------- | 197 | ---------------------------------------------------------------------- |
210 | Ran 10 tests in 62.104s | 198 | Ran 9 tests in 12.600s |
211 | 199 | ||
212 | OK</programlisting> | 200 | OK</programlisting> |
213 | </appendix> \ No newline at end of file | 201 | </appendix> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 1940eb1..fc349ac 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
@@ -254,12 +254,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
254 | 254 | ||
255 | <note> | 255 | <note> |
256 | <para>The service will be automatically started when the computer | 256 | <para>The service will be automatically started when the computer |
257 | boots up. The user may enable the firewall in order to allow access | 257 | boots up. The user may enable the firewall in order to allow access to |
258 | to these specific ports: 80 (TCP), 443 (TCP), 54327 (UDP) and | 258 | these specific ports: 80 (TCP), 443 (TCP), 54327 (UDP) and 5701:5708 |
259 | 5701:5708 (TCP). If callhome is used access to the following ports | 259 | (TCP). If callhome is used access to the following ports must also be |
260 | must also be allowed: 4334 (TCP) and 2021:2040 (TCP). Otherwise, | 260 | allowed: 4334 (TCP) and 2021:2040 (TCP). Otherwise, the user should |
261 | the user should check that the CentOS machine where the uCPE Manager is | 261 | check that the CentOS machine where the uCPE Manager is installed has |
262 | installed has the firewall disabled.</para> | 262 | the firewall disabled.</para> |
263 | </note> | 263 | </note> |
264 | 264 | ||
265 | <para>Verify that the installation has succeeded by:</para> | 265 | <para>Verify that the installation has succeeded by:</para> |
@@ -535,50 +535,32 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
535 | <para>Type. The type of device to be added, i.e <literal>Enea | 535 | <para>Type. The type of device to be added, i.e <literal>Enea |
536 | universal CPE</literal>.</para> | 536 | universal CPE</literal>.</para> |
537 | </listitem> | 537 | </listitem> |
538 | </itemizedlist> | 538 | |
539 | 539 | <listitem> | |
540 | <itemizedlist> | ||
541 | <listitem> | ||
542 | <para>Name. The name by which the device is referred to in the | 540 | <para>Name. The name by which the device is referred to in the |
543 | uCPE Manager.</para> | 541 | uCPE Manager.</para> |
544 | </listitem> | 542 | </listitem> |
545 | </itemizedlist> | 543 | |
546 | |||
547 | <itemizedlist> | ||
548 | <listitem> | ||
549 | <para>IP Address. IP address of the uCPE device.</para> | ||
550 | </listitem> | ||
551 | </itemizedlist> | ||
552 | |||
553 | <itemizedlist> | ||
554 | <listitem> | 544 | <listitem> |
555 | <para>SSH Port. The NETCONF Port used for communications. Default | 545 | <para>SSH Port. The NETCONF Port used for communications. Default |
556 | is set to 830.</para> | 546 | is set to 830.</para> |
557 | </listitem> | 547 | </listitem> |
558 | </itemizedlist> | ||
559 | 548 | ||
560 | <itemizedlist> | ||
561 | <listitem> | 549 | <listitem> |
562 | <para>SSH User Name. The user name for SSH connectivity. Default | 550 | <para>SSH User Name. The user name for SSH connectivity. Default |
563 | user is root.</para> | 551 | user is root.</para> |
564 | </listitem> | 552 | </listitem> |
565 | </itemizedlist> | ||
566 | 553 | ||
567 | <itemizedlist> | ||
568 | <listitem> | 554 | <listitem> |
569 | <para>SSH Password. Leave this blank.</para> | 555 | <para>SSH Password. Leave this blank.</para> |
570 | </listitem> | 556 | </listitem> |
571 | </itemizedlist> | ||
572 | 557 | ||
573 | <itemizedlist> | ||
574 | <listitem> | 558 | <listitem> |
575 | <para>Device Calls Home. This checkbox indicates the direction of | 559 | <para>Device Calls Home. This checkbox indicates the direction of |
576 | device communications. For Direct Connection, leave this flag | 560 | device communications. For Direct Connection, leave this flag |
577 | unchecked.</para> | 561 | unchecked.</para> |
578 | </listitem> | 562 | </listitem> |
579 | </itemizedlist> | ||
580 | 563 | ||
581 | <itemizedlist> | ||
582 | <listitem> | 564 | <listitem> |
583 | <para>Device ID. The unique identifier of the uCPE device.</para> | 565 | <para>Device ID. The unique identifier of the uCPE device.</para> |
584 | </listitem> | 566 | </listitem> |
@@ -590,13 +572,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
590 | 572 | ||
591 | <para>Follow the same steps as described in the previous section, | 573 | <para>Follow the same steps as described in the previous section, |
592 | making sure that the <literal>Device Calls Home</literal> checkbox is | 574 | making sure that the <literal>Device Calls Home</literal> checkbox is |
593 | selected this time. The <literal>IP Address</literal> of the uCPE device | 575 | selected this time.</para> |
594 | is not required.</para> | ||
595 | 576 | ||
596 | <para>When using this mechanism, the device will initiate a connection | 577 | <para>When using this mechanism, the device will initiate a connection |
597 | to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE | 578 | to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE |
598 | Manager waits for a device connection. For more information please | 579 | Manager waits for a device connection. For more information please see |
599 | see section <link linkend="install_ena_stick">Installing Enea NFV | 580 | section <link linkend="install_ena_stick">Installing Enea NFV |
600 | Access</link> for more details.</para> | 581 | Access</link> for more details.</para> |
601 | </section> | 582 | </section> |
602 | </section> | 583 | </section> |
@@ -611,295 +592,189 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
611 | 592 | ||
612 | <para>Available network interfaces can be added to the management | 593 | <para>Available network interfaces can be added to the management |
613 | system, for use by the networking virtualization infrastructure.</para> | 594 | system, for use by the networking virtualization infrastructure.</para> |
595 | |||
596 | <para>In order to make physical network interfaces available to the | ||
597 | virtualization infrastructure and VNFs, they must be configured into | ||
598 | the management system.</para> | ||
614 | 599 | ||
615 | <section id="man_configuration"> | 600 | <para>To add an interface into the uCPE Manager, select the uCPE |
616 | <title>Manual Configuration</title> | 601 | device, then from the top toolbar select <literal>Configuration |
602 | -> External Interfaces -> Configuration -> Add</literal>. The available | ||
603 | Interface types are detailed below.</para> | ||
617 | 604 | ||
618 | <para>For Manual Configuration of uCPE networking, select the uCPE | 605 | <section id="dpdk_interface_type"> |
619 | device first and then <literal>Configuration</literal> -> | 606 | <title>DPDK Interface Type</title> |
620 | <literal>External Interfaces</literal>, where one can find a list of | ||
621 | available network interfaces and their capabilities.</para> | ||
622 | 607 | ||
623 | <section id="configure_interfaces"> | 608 | <para>Configuring a physical interface in DPDK mode will require a |
624 | <title>Configuring Interfaces</title> | 609 | DPDK-based application (e.g. OVS-DPDK) in order to access and use |
610 | the interface. An interface set as the DPDK can be attached to an | ||
611 | OVS-DPDK bridge.</para> | ||
625 | 612 | ||
626 | <para>After networking interfaces have been added to the uCPE | 613 | <note> |
627 | Manager, the user can change the interface type (DPDK, SR-IOV, | 614 | <para>Make sure the <literal>Enable DPDK</literal> checkbox is |
628 | Standard, wan).</para> | 615 | selected in <literal>Device -> Configuration -> |
616 | DPDK</literal>, otherwise no interface can be assigned to the | ||
617 | DPDK.</para> | ||
618 | </note> | ||
629 | 619 | ||
630 | <para><emphasis role="bold">How to Edit the Configuration of an | 620 | <para>To add a DPDK interface under the management system, set |
631 | Interface</emphasis></para> | 621 | appropriate values for the following fields:</para> |
632 | 622 | ||
633 | <orderedlist> | 623 | <itemizedlist> |
634 | <listitem> | 624 | <listitem> |
635 | <figure> | 625 | <para>Source: name of the physical interface.</para> |
636 | <title>Configuration of External Interfaces</title> | 626 | </listitem> |
637 | 627 | ||
638 | <mediaobject> | 628 | <listitem> |
639 | <imageobject> | 629 | <para>Type: dpdk</para> |
640 | <imagedata align="center" contentwidth="500" | 630 | </listitem> |
641 | fileref="images/edit_inter_config.png" /> | ||
642 | </imageobject> | ||
643 | </mediaobject> | ||
644 | </figure> | ||
645 | 631 | ||
646 | <para>To edit an interface configuration type from the uCPE | 632 | <listitem> |
647 | Manager, select the uCPE device, then from the top toolbar | 633 | <para>Networking-type: dpdk</para> |
648 | select the <literal>Configuration</literal> menu then | 634 | </listitem> |
649 | <literal>External Interfaces -> Configuration</literal>. The | ||
650 | already configured interfaces are displayed here, as can be seen | ||
651 | in the figure above.</para> | ||
652 | </listitem> | ||
653 | 635 | ||
654 | <listitem> | 636 | <listitem> |
655 | <para>In order to edit an already configured interface, double | 637 | <para>Dpdk-type: the kernel module that allows user space |
656 | click on the desired one and a popup will appear as shown in the | 638 | access to the physical interface. The <literal>vfio-pci</literal> |
657 | figure below. From the Host Interface window, a user can change | 639 | driver is used.</para> |
658 | the networking type and the IP address assignment:</para> | 640 | </listitem> |
641 | </itemizedlist> | ||
642 | </section> | ||
659 | 643 | ||
660 | <figure> | 644 | <section id="sriov_interface_type"> |
661 | <title>Editing an Interface</title> | 645 | <title>SR-IOV Interface Type</title> |
662 | 646 | ||
663 | <mediaobject> | 647 | <para>SR-IOV technology allows for the creation of a number of |
664 | <imageobject> | 648 | virtual functions on the host interface, which can be used by VNFs |
665 | <imagedata align="center" contentwidth="500" | 649 | running on the uCPE device.</para> |
666 | fileref="images/edit_inter.png" /> | ||
667 | </imageobject> | ||
668 | </mediaobject> | ||
669 | </figure> | ||
670 | </listitem> | ||
671 | </orderedlist> | ||
672 | 650 | ||
673 | <para><emphasis role="bold">Set the IP address assignment of the | 651 | <para>For SR-IOV mode configuration, the user must set values for |
674 | Management Interface to static</emphasis></para> | 652 | the following fields:</para> |
675 | 653 | ||
676 | <orderedlist> | 654 | <itemizedlist> |
677 | <listitem> | 655 | <listitem> |
678 | <para>To change an interface type from the uCPE Manager, select | 656 | <para>Source: name of the physical interface.</para> |
679 | the uCPE device, then from the top toolbar select | 657 | </listitem> |
680 | <literal>Configuration</literal> and then <literal>External | ||
681 | Interfaces -> Configuration</literal>. The already configured | ||
682 | interfaces are displayed here.</para> | ||
683 | </listitem> | ||
684 | 658 | ||
685 | <listitem> | 659 | <listitem> |
686 | <para>From the interfaces' list, edit the interface which has | 660 | <para>Type: sr-iov</para> |
687 | the "Management" flag set to "true", by double clicking on it, | 661 | </listitem> |
688 | triggering a popup window:</para> | ||
689 | 662 | ||
690 | <figure> | 663 | <listitem> |
691 | <title>Editing the Management Interface</title> | 664 | <para>Networking-type: srIov</para> |
665 | </listitem> | ||
692 | 666 | ||
693 | <mediaobject> | 667 | <listitem> |
694 | <imageobject> | 668 | <para>sriov-mode: adapter-pool</para> |
695 | <imagedata align="center" contentwidth="500" | 669 | </listitem> |
696 | fileref="images/edit_mg_inter.png" /> | ||
697 | </imageobject> | ||
698 | </mediaobject> | ||
699 | </figure> | ||
700 | </listitem> | ||
701 | 670 | ||
702 | <listitem> | 671 | <listitem> |
703 | <para>From the Host Interface window, change the <literal>IP | 672 | <para>sriov-num-vfs: the number of virtual functions to |
704 | address-assignment</literal> to "static". After the address | 673 | create.</para> |
705 | assignment is set, the user needs to set the <literal>IP | 674 | </listitem> |
706 | address</literal>, <literal>netmask</literal> and the | 675 | </itemizedlist> |
707 | <literal>gateway</literal> of the interface. The user can use | 676 | </section> |
708 | the dropdown list to set the type of the IP version: | ||
709 | <literal>IPv4</literal> or <literal>IPv6</literal> | ||
710 | address:</para> | ||
711 | 677 | ||
712 | <figure> | 678 | <section id="standard_interface_type"> |
713 | <title>Setting the IP version</title> | 679 | <title>Standard Interface Type</title> |
714 | 680 | ||
715 | <mediaobject> | 681 | <para>Some of the physical network interfaces available on a uCPE |
716 | <imageobject> | 682 | device, including Ethernet interfaces, do not have DPDK or SR-IOV |
717 | <imagedata align="center" contentwidth="500" | 683 | support. Instead, the Linux kernel driver has to be used. Wi-Fi |
718 | fileref="images/setting_ip_version.png" /> | 684 | and 4G/LTE modems can also be configured and used for |
719 | </imageobject> | 685 | virtualization infrastructure and VNFs.</para> |
720 | </mediaobject> | ||
721 | </figure> | ||
722 | </listitem> | ||
723 | </orderedlist> | ||
724 | 686 | ||
725 | <para><emphasis role="bold">Set the IP address assignment of the | 687 | <para>To add Standard interfaces under the management system, the |
726 | Management Interface to DHCP</emphasis></para> | 688 | user must set values for the following fields:</para> |
727 | 689 | ||
728 | <orderedlist> | 690 | <itemizedlist> |
729 | <listitem> | 691 | <listitem> |
730 | <para>To change an interface type from the uCPE Manager, select | 692 | <para>Source: the name of physical interface.</para> |
731 | the uCPE device, then from the top toolbar select | 693 | </listitem> |
732 | <literal>Configuration</literal> and then <literal>External | ||
733 | Interfaces -> Configuration</literal>. The already configured | ||
734 | interfaces are displayed here.</para> | ||
735 | </listitem> | ||
736 | 694 | ||
737 | <listitem> | 695 | <listitem> |
738 | <para>From the interfaces' list, edit the interface which has | 696 | <para>Networking-type: standard</para> |
739 | the "Management" flag set to "true", by double clicking on it, | 697 | </listitem> |
740 | triggering a popup window. Within the Host Interface window | 698 | </itemizedlist> |
741 | change the <literal>IP address assignment</literal> to | 699 | </section> |
742 | "dhcp".</para> | ||
743 | 700 | ||
744 | <figure> | 701 | <section condition="hidden" id="pci_passthrough_interface_type"> |
745 | <title>Editing the Management Interface to DHCP</title> | 702 | <title>PCI Passthrough Interface Type</title> |
703 | |||
704 | <para>For the PCI Passthrough a user does not have to configure a | ||
705 | physical interface, instead simply select the PCI address and | ||
706 | connect it to a virtual port when the VNF instantiation step is | ||
707 | reached.</para> | ||
708 | </section> | ||
709 | |||
710 | <section id="man_configuration"> | ||
711 | <title>Manual Configuration</title> | ||
712 | |||
713 | <para>For Manual Configuration of uCPE networking, select the uCPE | ||
714 | device first and then <literal>Configuration</literal> -> | ||
715 | <literal>External Interfaces</literal>, where one can find a list of | ||
716 | available network interfaces and their capabilities.</para> | ||
717 | |||
718 | <section id="configure_interfaces"> | ||
719 | <title>Configuring Interfaces</title> | ||
720 | |||
721 | <para>After networking interfaces have been added to the uCPE | ||
722 | Manager, the user can change the interface type (DPDK, SR-IOV, | ||
723 | Standard, WAN).</para> | ||
724 | |||
725 | <note><para>WAN interfaces, which are configured during the | ||
726 | installation of the device, do not need to be added, they will | ||
727 | be automatically listed as such in the uCPE manager when the | ||
728 | device connects.</para></note> | ||
729 | |||
730 | <figure> | ||
731 | <title>Configuration of External Interfaces</title> | ||
746 | 732 | ||
747 | <mediaobject> | 733 | <mediaobject> |
748 | <imageobject> | 734 | <imageobject> |
749 | <imagedata align="center" contentwidth="500" | 735 | <imagedata align="center" contentwidth="600" |
750 | fileref="images/setting_ip_version_dhcp.png" /> | 736 | fileref="images/edit_inter_config.png" /> |
751 | </imageobject> | 737 | </imageobject> |
752 | </mediaobject> | 738 | </mediaobject> |
753 | </figure> | 739 | </figure> |
754 | </listitem> | ||
755 | </orderedlist> | ||
756 | 740 | ||
757 | <para><emphasis role="bold">Changing the static IP of the Management | 741 | <para><emphasis role="bold">How to Edit the Configuration of an |
758 | Interface</emphasis></para> | 742 | Interface</emphasis></para> |
759 | 743 | ||
760 | <orderedlist> | 744 | <orderedlist> |
761 | <listitem> | 745 | <listitem> |
762 | <para>To change an interface type from the uCPE Manager, select | 746 | <para>To edit an interface configuration type from the uCPE |
763 | the uCPE device, then from the top toolbar select | 747 | Manager, select the uCPE device, then from the top toolbar |
764 | <literal>Configuration</literal> and then <literal>External | 748 | select the <literal>Configuration</literal> menu then |
765 | Interfaces -> Configuration</literal>. The already configured | 749 | <literal>External Interfaces -> Configuration</literal>. The |
766 | interfaces are displayed here.</para> | 750 | already configured interfaces are displayed here, as can be seen |
751 | in the figure above.</para> | ||
767 | </listitem> | 752 | </listitem> |
768 | 753 | ||
769 | <listitem> | 754 | <listitem> |
770 | <para>From the interfaces' list, edit the interface which has | 755 | <para>In order to edit an already configured interface, (as in |
771 | the "Management" flag set to "true", by double clicking on it, | 756 | the example popup shown below, a WAN interface) double click |
772 | triggering a popup window. Within the Host Interface window | 757 | on the desired one and a popup will appear. A different popup |
773 | change the "static" <literal>IP address</literal> as well as the | 758 | appears for each type of interface. From the Host Interface window, a user can |
774 | <literal>netmask</literal> and the | 759 | change the networking type and the IP address assignment:</para> |
775 | <literal>gateway</literal>.</para> | ||
776 | 760 | ||
777 | <figure> | 761 | <figure> |
778 | <title>Changing the Static, Netmask and Gateway IPs</title> | 762 | <title>Editing an Interface</title> |
779 | 763 | ||
780 | <mediaobject> | 764 | <mediaobject> |
781 | <imageobject> | 765 | <imageobject> |
782 | <imagedata align="center" contentwidth="500" | 766 | <imagedata align="center" contentwidth="500" |
783 | fileref="images/changing_ips.png" /> | 767 | fileref="images/edit_inter.png" /> |
784 | </imageobject> | 768 | </imageobject> |
785 | </mediaobject> | 769 | </mediaobject> |
786 | </figure> | 770 | </figure> |
787 | |||
788 | <note> | ||
789 | <para>The user can use the dropdown list to set the type of | ||
790 | the IP version: <literal>IPv4</literal> or | ||
791 | <literal>IPv6</literal> address.</para> | ||
792 | </note> | ||
793 | </listitem> | 771 | </listitem> |
794 | </orderedlist> | 772 | </orderedlist> |
795 | 773 | ||
796 | <para>In order to make physical network interfaces available to the | ||
797 | virtualization infrastructure and VNFs, they must be configured into | ||
798 | the management system.</para> | ||
799 | |||
800 | <para>To add an interface into the uCPE Manager, select the uCPE | ||
801 | device, then from the top toolbar select <literal>Configuration | ||
802 | -> OpenVSwitch -> Host Interfaces</literal>. The available | ||
803 | Interface types are detailed below.</para> | ||
804 | |||
805 | <para><emphasis role="bold">DPDK Interface Type</emphasis></para> | ||
806 | |||
807 | <para>Configuring a physical interface in DPDK mode will require a | ||
808 | DPDK-based application (e.g. OVS-DPDK) in order to access and use | ||
809 | the interface. An interface set as the DPDK can be attached to an | ||
810 | OVS-DPDK bridge.</para> | ||
811 | |||
812 | <note> | 774 | <note> |
813 | <para>Make sure the <literal>Enable DPDK</literal> checkbox is | 775 | <para>The IP address assignment of an interface can be set as |
814 | selected in <literal>Device -> Configuration -> | 776 | static or dynamic for each type of interface.</para> |
815 | DPDK</literal>, otherwise no interface can be assigned to the | ||
816 | DPDK.</para> | ||
817 | </note> | 777 | </note> |
818 | |||
819 | <para>To add a DPDK interface under the management system, set | ||
820 | appropriate values for the following fields:</para> | ||
821 | |||
822 | <itemizedlist> | ||
823 | <listitem> | ||
824 | <para>Source: name of the physical interface.</para> | ||
825 | </listitem> | ||
826 | |||
827 | <listitem> | ||
828 | <para>Type: dpdk</para> | ||
829 | </listitem> | ||
830 | |||
831 | <listitem> | ||
832 | <para>Networking-type: dpdk</para> | ||
833 | </listitem> | ||
834 | |||
835 | <listitem> | ||
836 | <para>Dpdk-type: the kernel module that allows user space access | ||
837 | to the physical interface. Enea recommends using the | ||
838 | <literal>vfio-pci</literal> driver.</para> | ||
839 | </listitem> | ||
840 | </itemizedlist> | ||
841 | |||
842 | <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para> | ||
843 | |||
844 | <para>SR-IOV technology allows for the creation of a number of | ||
845 | virtual functions on the host interface, which can be used by VNFs | ||
846 | running on the uCPE device.</para> | ||
847 | |||
848 | <para>For SR-IOV mode configuration, the user must set values for | ||
849 | the following fields:</para> | ||
850 | |||
851 | <itemizedlist> | ||
852 | <listitem> | ||
853 | <para>Source: name of the physical interface.</para> | ||
854 | </listitem> | ||
855 | |||
856 | <listitem> | ||
857 | <para>Type: sr-iov</para> | ||
858 | </listitem> | ||
859 | |||
860 | <listitem> | ||
861 | <para>Networking-type: srIov</para> | ||
862 | </listitem> | ||
863 | |||
864 | <listitem> | ||
865 | <para>sriov-mode: adapter-pool</para> | ||
866 | </listitem> | ||
867 | |||
868 | <listitem> | ||
869 | <para>sriov-num-vfs: the number of virtual functions to | ||
870 | create.</para> | ||
871 | </listitem> | ||
872 | </itemizedlist> | ||
873 | |||
874 | <para><emphasis role="bold">Standard Interface | ||
875 | Type</emphasis></para> | ||
876 | |||
877 | <para>Some of the physical network interfaces available on a uCPE | ||
878 | device, including Ethernet interfaces, do not have DPDK or SR-IOV | ||
879 | support. Instead, the Linux kernel driver has to be used. Wi-Fi and | ||
880 | 4G/LTE modems can also be configured and used for virtualization | ||
881 | infrastructure and VNFs.</para> | ||
882 | |||
883 | <para>To add Standard interfaces under the management system, the | ||
884 | user must set values for the following fields:</para> | ||
885 | |||
886 | <itemizedlist> | ||
887 | <listitem> | ||
888 | <para>Source: the name of physical interface.</para> | ||
889 | </listitem> | ||
890 | |||
891 | <listitem> | ||
892 | <para>Networking-type: standard</para> | ||
893 | </listitem> | ||
894 | </itemizedlist> | ||
895 | |||
896 | <para condition="hidden"><emphasis role="bold">PCI Passthrough | ||
897 | Interface Type</emphasis></para> | ||
898 | |||
899 | <para condition="hidden">For the PCI Passthrough a user does not | ||
900 | have to configure a physical interface, instead simply select the | ||
901 | PCI address and connect it to a virtual port when the VNF | ||
902 | instantiation step is reached.</para> | ||
903 | </section> | 778 | </section> |
904 | 779 | ||
905 | <section id="configure_bridges"> | 780 | <section id="configure_bridges"> |
@@ -908,6 +783,17 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
908 | <para>After networking interfaces have been added to the uCPE | 783 | <para>After networking interfaces have been added to the uCPE |
909 | Manager, the user can create the necessary OVS bridges.</para> | 784 | Manager, the user can create the necessary OVS bridges.</para> |
910 | 785 | ||
786 | <figure> | ||
787 | <title>OVS Bridges</title> | ||
788 | |||
789 | <mediaobject> | ||
790 | <imageobject> | ||
791 | <imagedata align="center" contentwidth="600" | ||
792 | fileref="images/ovs_bridges_tab.png" /> | ||
793 | </imageobject> | ||
794 | </mediaobject> | ||
795 | </figure> | ||
796 | |||
911 | <para><emphasis role="bold">How to add OVS bridges in the uCPE | 797 | <para><emphasis role="bold">How to add OVS bridges in the uCPE |
912 | Manager</emphasis></para> | 798 | Manager</emphasis></para> |
913 | 799 | ||
@@ -936,145 +822,139 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
936 | </note> | 822 | </note> |
937 | 823 | ||
938 | <para>There are three types of bridges which can be created, each | 824 | <para>There are three types of bridges which can be created, each |
939 | one fulfiling a different role:</para> | 825 | one fulfiling a different role.</para> |
940 | 826 | ||
941 | <para><emphasis role="bold">uCPE In-band Management | 827 | <section id="inband_mg_bridge"> |
942 | bridge</emphasis></para> | 828 | <title>uCPE In-band Management bridge</title> |
943 | 829 | ||
944 | <para>In-band Management refers to a model where both the data plane | 830 | <para>In-band Management refers to a model where both the data |
945 | and control plane flow over the same network path. In some | 831 | plane and control plane flow over the same network path. In some |
946 | situations (e.g. the uCPE device has only one routable IP address), | 832 | situations (e.g. the uCPE device has only one routable IP |
947 | this is the only option available to both control and configure the | 833 | address), this is the only option available to both control and |
948 | uCPE device, while also allowing for data-path traffic to pass over | 834 | configure the uCPE device, while also allowing for data-path |
949 | the same physical interface.</para> | 835 | traffic to pass over the same physical interface.</para> |
950 | 836 | ||
951 | <para>The solution provided by Enea for in-band management is based | 837 | <para>The solution provided by Enea for in-band management is |
952 | upon an OpenvSwitch bridge fielding all traffic passing through the | 838 | based upon an OpenvSwitch bridge fielding all traffic passing |
953 | WAN physical port. As a prerequisite, the WAN physical port has to | 839 | through the WAN physical port. Any standard |
954 | be configured to get its IP through DHCP. Any standard or | 840 | or DPDK-assigned network interface can be used for the In-Band |
955 | DPDK-assigned network interface can be used for the In-Band | 841 | management bridge.</para> |
956 | management bridge.</para> | ||
957 | 842 | ||
958 | <note> | 843 | <note> |
959 | <para>The In-Band Management bridge must be recreated each time | 844 | <para>The In-Band Management bridge must be recreated each time |
960 | the uCPE Manager IP address is changed.</para> | 845 | the uCPE Manager IP address is changed.</para> |
961 | </note> | 846 | </note> |
962 | 847 | ||
963 | <para>To create the In-Band Management bridge, the user must set | 848 | <para>To create the In-Band Management bridge, the user must set |
964 | values for the following fields:</para> | 849 | values for the following fields:</para> |
965 | 850 | ||
966 | <itemizedlist> | 851 | <itemizedlist> |
967 | <listitem> | 852 | <listitem> |
968 | <para>name: name of the bridge.</para> | 853 | <para>name: name of the bridge.</para> |
969 | </listitem> | 854 | </listitem> |
970 | |||
971 | <listitem> | ||
972 | <para>ovs-bridge-type: inbandMgmt</para> | ||
973 | </listitem> | ||
974 | 855 | ||
975 | <listitem> | 856 | <listitem> |
976 | <para>mgmt-address: select IPv4 as the type and fill in the IP | 857 | <para>ovs-bridge-type: inbandMgmt</para> |
977 | address of the uCPE Manager.</para> | 858 | </listitem> |
978 | </listitem> | 859 | </itemizedlist> |
979 | 860 | ||
980 | <listitem> | 861 | <note> |
981 | <para>mgmt-port: the NETCONF management port. Enea recommeneds | 862 | <para>The first VNF instantiated on the uCPE device must be |
982 | leaving this field unchanged.</para> | 863 | connected to the In-Band Management bridge and its WAN interface |
983 | </listitem> | 864 | must be configured as the DHCP client.</para> |
984 | </itemizedlist> | 865 | </note> |
866 | </section> | ||
985 | 867 | ||
986 | <note> | 868 | <section id="inband_mg_br_vnfs"> |
987 | <para>The first VNF instantiated on the uCPE device must be | 869 | <title>In-band Management bridge for VNFs</title> |
988 | connected to the In-Band Management bridge and its WAN interface | ||
989 | must be configured as the DHCP client.</para> | ||
990 | </note> | ||
991 | 870 | ||
992 | <para><emphasis role="bold">In-band Management bridge for | 871 | <para>If VNF management can be done over a dedicated virtual |
993 | VNFs</emphasis></para> | 872 | interface, its possible to extend the networking infrastructure |
873 | configuration to also access the VNF's management interface over | ||
874 | the WAN port.</para> | ||
994 | 875 | ||
995 | <para>If VNF management can be done over a dedicated virtual | 876 | <para>For this setup, three types of traffic will pass over the |
996 | interface, its possible to extend the networking infrastructure | 877 | WAN physical interface:</para> |
997 | configuration to also access the VNF's management interface over the | ||
998 | WAN port.</para> | ||
999 | 878 | ||
1000 | <para>For this setup, three types of traffic will pass over the WAN | 879 | <itemizedlist> |
1001 | physical interface:</para> | 880 | <listitem> |
881 | <para>Device management. Part of the device configuration done | ||
882 | by the uCPE Manager.</para> | ||
883 | </listitem> | ||
1002 | 884 | ||
1003 | <itemizedlist> | 885 | <listitem> |
1004 | <listitem> | 886 | <para>VNF(s) management. Enabling or disabling features of a |
1005 | <para>Device management. Part of the device configuration done | 887 | VNF. E.g. enabling/disabling the firewall or VPN setup.</para> |
1006 | by the uCPE Manager.</para> | 888 | </listitem> |
1007 | </listitem> | ||
1008 | 889 | ||
1009 | <listitem> | 890 | <listitem> |
1010 | <para>VNF(s) management. Enabling or disabling features of a | 891 | <para>Data-path. All other traffic that is not used in the |
1011 | VNF. E.g. enabling/disabling the firewall or VPN setup.</para> | 892 | control plane and needs to reach a LAN network.</para> |
1012 | </listitem> | 893 | </listitem> |
894 | </itemizedlist> | ||
1013 | 895 | ||
1014 | <listitem> | 896 | <para>To create a VNF In-Band Management bridge, the user must set |
1015 | <para>Data-path. All other traffic that is not used in the | 897 | values for the following fields:</para> |
1016 | control plane and needs to reach a LAN network.</para> | ||
1017 | </listitem> | ||
1018 | </itemizedlist> | ||
1019 | 898 | ||
1020 | <para>To create a VNF In-Band Management bridge, the user must set | 899 | <itemizedlist> |
1021 | values for the following fields:</para> | 900 | <listitem> |
901 | <para>name: name of the bridge.</para> | ||
902 | </listitem> | ||
1022 | 903 | ||
1023 | <itemizedlist> | 904 | <listitem> |
1024 | <listitem> | 905 | <para>ovs-bridge-type: vnfMgmt</para> |
1025 | <para>name: name of the bridge.</para> | 906 | </listitem> |
1026 | </listitem> | ||
1027 | 907 | ||
1028 | <listitem> | 908 | <listitem> |
1029 | <para>ovs-bridge-type: vnfMgmt</para> | 909 | <para>vnf-mgmt-address: select IPv4 as the type and fill in |
1030 | </listitem> | 910 | the IP address for management network, e.g 10.0.0.1.</para> |
911 | </listitem> | ||
912 | </itemizedlist> | ||
1031 | 913 | ||
1032 | <listitem> | 914 | <note> |
1033 | <para>vnf-mgmt-address: select IPv4 as the type and fill in the | 915 | <para>VNF management interfaces must be configured in same |
1034 | IP address for management network, e.g 10.0.0.1.</para> | 916 | network as the <literal>vnf-mgmt-address</literal> of the |
1035 | </listitem> | 917 | bridge. For more information, please see 4.4 <link |
1036 | </itemizedlist> | 918 | linkend="vnf_management">VNF Management</link>.</para> |
919 | </note> | ||
920 | </section> | ||
1037 | 921 | ||
1038 | <note> | 922 | <section id="dataplane_bridge"> |
1039 | <para>VNF management interfaces must be configured in same network | 923 | <title>Data-plane Bridge</title> |
1040 | as the <literal>vnf-mgmt-address</literal> of the bridge. For more | ||
1041 | information, please see 4.4 <link linkend="vnf_management">VNF | ||
1042 | Management</link>.</para> | ||
1043 | </note> | ||
1044 | 924 | ||
1045 | <para><emphasis role="bold">Data-plane Bridge</emphasis> Data-plane | 925 | <para>Data-plane bridges are generic bridges used for the VNF |
1046 | bridges are generic bridges used for the VNF data-plane. There are | 926 | data-plane. There are two supported sub-types:</para> |
1047 | two supported sub-types:</para> | ||
1048 | 927 | ||
1049 | <itemizedlist> | 928 | <itemizedlist> |
1050 | <listitem> | 929 | <listitem> |
1051 | <para>communication: allows for VNF communication towards | 930 | <para>communication: allows for VNF communication towards |
1052 | LAN/WAN networks. This bridge type has at least one physical | 931 | LAN/WAN networks. This bridge type has at least one physical |
1053 | port attached to it.</para> | 932 | port attached to it.</para> |
1054 | </listitem> | 933 | </listitem> |
1055 | 934 | ||
1056 | <listitem> | 935 | <listitem> |
1057 | <para>integration: allows for VNF-to-VNF communication (usually | 936 | <para>integration: allows for VNF-to-VNF communication |
1058 | for service function chaining). This bridge type does not have | 937 | (usually for service function chaining). This bridge type does |
1059 | any physical port attached.</para> | 938 | not have any physical port attached.</para> |
1060 | </listitem> | 939 | </listitem> |
1061 | </itemizedlist> | 940 | </itemizedlist> |
1062 | 941 | ||
1063 | <para>To create a Data-plane bridge, the user must set values for | 942 | <para>To create a Data-plane bridge, the user must set values for |
1064 | the following fields:</para> | 943 | the following fields:</para> |
1065 | 944 | ||
1066 | <itemizedlist> | 945 | <itemizedlist> |
1067 | <listitem> | 946 | <listitem> |
1068 | <para>name: name of the bridge.</para> | 947 | <para>name: name of the bridge.</para> |
1069 | </listitem> | 948 | </listitem> |
1070 | 949 | ||
1071 | <listitem> | 950 | <listitem> |
1072 | <para>ovs-bridge-type: select <literal>communication</literal> | 951 | <para>ovs-bridge-type: select <literal>communication</literal> |
1073 | or <literal>integration</literal>, depending on intended usage. | 952 | or <literal>integration</literal>, depending on intended |
1074 | For communication bridges, physical interfaces can be added to | 953 | usage. For communication bridges, physical interfaces can be |
1075 | the bridge.</para> | 954 | added to the bridge.</para> |
1076 | </listitem> | 955 | </listitem> |
1077 | </itemizedlist> | 956 | </itemizedlist> |
957 | </section> | ||
1078 | </section> | 958 | </section> |
1079 | </section> | 959 | </section> |
1080 | 960 | ||
@@ -1138,7 +1018,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
1138 | </listitem> | 1018 | </listitem> |
1139 | 1019 | ||
1140 | <listitem> | 1020 | <listitem> |
1141 | <para>Device Grouping Tags: a tag to group devices.</para> | 1021 | <para>Device Grouping Tags: a tag to group devices. These tags match |
1022 | the customer tags provided during the installation of the device.</para> | ||
1142 | </listitem> | 1023 | </listitem> |
1143 | </itemizedlist> | 1024 | </itemizedlist> |
1144 | 1025 | ||
@@ -1413,9 +1294,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
1413 | 1294 | ||
1414 | <listitem> | 1295 | <listitem> |
1415 | <para>Click on <literal>Choose File</literal> to provide the path | 1296 | <para>Click on <literal>Choose File</literal> to provide the path |
1416 | to the image file (must be of type <literal>rootfs.ostree.tar.bz2</literal>). | 1297 | to the image file (must be of type |
1417 | Select the target hardware platform corresponding to the image | 1298 | <literal>rootfs.ostree.tar.bz2</literal>). Select the target |
1418 | being uploaded (xeon-d or atomc-3000).</para> | 1299 | hardware platform corresponding to the image being uploaded |
1300 | (xeon-d or atomc-3000).</para> | ||
1419 | </listitem> | 1301 | </listitem> |
1420 | 1302 | ||
1421 | <listitem> | 1303 | <listitem> |
@@ -1481,7 +1363,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
1481 | minute for when to run the upgrade.</para> | 1363 | minute for when to run the upgrade.</para> |
1482 | 1364 | ||
1483 | <note> | 1365 | <note> |
1484 | <para>The hour represents the local uCPE Manager server hour.</para> | 1366 | <para>The hour represents the local uCPE Manager server |
1367 | hour.</para> | ||
1485 | </note> | 1368 | </note> |
1486 | </listitem> | 1369 | </listitem> |
1487 | 1370 | ||
@@ -1888,8 +1771,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
1888 | Manager.</para> | 1771 | Manager.</para> |
1889 | 1772 | ||
1890 | <note> | 1773 | <note> |
1891 | <para>CAUTION: The user MUST conserve the same order for the | 1774 | <para>CAUTION: The user MUST conserve the same order for the virtual |
1892 | virtual interfaces during both onboarding and instantiation phases.</para> | 1775 | interfaces during both onboarding and instantiation phases.</para> |
1893 | </note> | 1776 | </note> |
1894 | 1777 | ||
1895 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 1778 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
@@ -2046,7 +1929,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
2046 | </listitem> | 1929 | </listitem> |
2047 | 1930 | ||
2048 | <listitem> | 1931 | <listitem> |
2049 | <para>uCPE Device: the uCPE device to instantiate the VNF on.</para> | 1932 | <para>uCPE Device: the uCPE device to instantiate the VNF |
1933 | on.</para> | ||
2050 | </listitem> | 1934 | </listitem> |
2051 | 1935 | ||
2052 | <listitem> | 1936 | <listitem> |
@@ -2125,4 +2009,4 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | |||
2125 | </orderedlist> | 2009 | </orderedlist> |
2126 | </section> | 2010 | </section> |
2127 | </section> | 2011 | </section> |
2128 | </chapter> | 2012 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png index 211984c..f9ab8aa 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png b/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png new file mode 100755 index 0000000..0b3ec54 --- /dev/null +++ b/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png | |||
Binary files differ | |||