summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAliss Dragomir <Aliss.Dragomir@enea.com>2020-09-07 13:09:19 +0200
committerAliss Dragomir <Aliss.Dragomir@enea.com>2020-09-07 13:09:19 +0200
commit8ce388b7d8fe6a62d287fbf40824d11775dbe732 (patch)
tree1e891843bfab75f2ce73c85d40d3d39fc48e7806
parent07600a0dd130e2dff03044c61eb82dd204e04d06 (diff)
parentbe8b60bdf80d705dd196553fe39bca13443ec51f (diff)
downloadnfv-access-documentation-8ce388b7d8fe6a62d287fbf40824d11775dbe732.tar.gz
Merge tag 'Enea_NFV_Access_2.2.3_RC8'Enea_NFV_Access_2.2.3
Updated by Jenkins build: http://eltf-jenkins03:8080/job/nfva-release-packaging/115/ Change-Id: I9464354ad149bc6c1b3f8694d50d01000c8a18d4
Diffstat
-rw-r--r--.gitreview4
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml166
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml18
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml21
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml37
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml4
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml69
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/appendix_5.xml238
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/book.xml9
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml39
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/introduction.xml30
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml71
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml38
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml54
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml14
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml201
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml73
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/introduction.xml8
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml8
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml47
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/main_changes.xml8
-rw-r--r--doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml49
22 files changed, 701 insertions, 505 deletions
diff --git a/.gitreview b/.gitreview
index 30e070b..ef53a12 100644
--- a/.gitreview
+++ b/.gitreview
@@ -1,5 +1,5 @@
1[gerrit] 1[gerrit]
2host=gerrit.enea.se 2host=gerrit.enea.se
3port=29418 3port=29418
4project=linux/el_releases-nfv-access 4project=linux/nfv-access-documentation
5defaultbranch=rocko 5defaultbranch=develop
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 4f94422..2a4cc8a 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
@@ -12,7 +12,14 @@
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, waiting for a uCPE device to connect to the uCPE Manager, as well 14 device, waiting for a uCPE device to connect to the uCPE Manager, as well
15 as scripts for adding and removing an offline configuration store.</para> 15 as scripts for adding and removing an offline configuration store. This
16 folder also contains scripts for uploading and removing an NFVA image into
17 the uCPE Manager, and for installing and activating a NFVA image on a uCPE
18 Device.</para>
19
20 <para>The <literal>/customScripts</literal> folder contains Python scripts
21 for uploading custom scripts onto the uCPE Manager and uCPE device(s), for
22 removing custom scripts from the uCPE Manager and uCPE device(s).</para>
16 23
17 <para>The <literal>/network</literal> folder contains Python scripts for 24 <para>The <literal>/network</literal> folder contains Python scripts for
18 binding or unbinding a network interface to and from a uCPE device (DPDK 25 binding or unbinding a network interface to and from a uCPE device (DPDK
@@ -25,16 +32,19 @@
25 <para>Commands within the network folder that include the option 32 <para>Commands within the network folder that include the option
26 <emphasis role="bold">-o</emphasis> allow the user to perform the action 33 <emphasis role="bold">-o</emphasis> allow the user to perform the action
27 in an offline configuration store alternative available for use at a 34 in an offline configuration store alternative available for use at a
28 later setup time. All options contain either <emphasis 35 later setup time. Commands that include the <emphasis
29 role="bold">-n</emphasis>, <emphasis role="bold">-o</emphasis> or both. 36 role="bold">-n</emphasis> option refer to a uCPE device, with the
30 One of them must always be provided, if both are provided, -o has 37 operation being performed on uCPE device. All options contain either
31 priority, and -n is thus ignored.</para> 38 <emphasis role="bold">-n</emphasis>, <emphasis role="bold">-o</emphasis>
39 or both. One of them must always be provided, if both are provided, -o
40 has priority, and -n is thus ignored.</para>
32 </note> 41 </note>
33 42
34 <para>The <literal>/unittestSuite</literal> folder contains Python 43 <para>The <literal>/unittestSuite</literal> folder contains JSON files for
35 unit-test class and loader scripts for generating specific test cases for 44 complex scenarios (multiple operations), as well as Python unit-test class
36 the available Python scripts. The generated test cases are injected into 45 and loader scripts for generating specific test cases for the available
37 the Python unit-test suite class to be run using the Python unit-test 46 Python scripts. The generated test cases are injected into the Python
47 unit-test suite class to be run using the Python unit-test
38 framework.</para> 48 framework.</para>
39 49
40 <para>The <literal>/unittestSuite/config</literal> folder contains 50 <para>The <literal>/unittestSuite/config</literal> folder contains
@@ -43,6 +53,10 @@
43 that must contain the test case name and arguments to be passed to the 53 that must contain the test case name and arguments to be passed to the
44 Python script for running the test case.</para> 54 Python script for running the test case.</para>
45 55
56 <para>The <literal>/unittestSuite/vnf_config</literal> directory contains
57 symlinks for the Fortigate license file and for the
58 <literal>/vnf_config/fortigateImage</literal> folder. </para>
59
46 <para>The <literal>/vnf</literal> folder contains Python scripts for 60 <para>The <literal>/vnf</literal> folder contains Python scripts for
47 onboarding and offboarding a VNF image, instantiating a VNF, controlling a 61 onboarding and offboarding a VNF image, instantiating a VNF, controlling a
48 VNF instance or destroying an existing one.</para> 62 VNF instance or destroying an existing one.</para>
@@ -107,7 +121,8 @@ Options:
107 121
108 <para>Below is a sample unit-test configuration file, describing the 122 <para>Below is a sample unit-test configuration file, describing the
109 Fortigate <emphasis role="bold">deployment</emphasis> scenario 123 Fortigate <emphasis role="bold">deployment</emphasis> scenario
110 <filename>fortigateDeploy.json</filename>:</para> 124 <filename>fortigateDeploy.json</filename>, found in
125 <literal>&lt;AF-TH-install-dir&gt;/automation_framework/unittestSuite</literal>:</para>
111 126
112 <para><programlisting>[ 127 <para><programlisting>[
113 { 128 {
@@ -1346,78 +1361,6 @@ Options:
1346 </section> 1361 </section>
1347 </section> 1362 </section>
1348 1363
1349 <section id="onboard_vnf_bundle">
1350 <title>Onboarding a VNF Image</title>
1351
1352 <para>The specifics of how to Onboard a VNF image onto the Enea uCPE
1353 Manager is detailed below.</para>
1354
1355 <section id="script_opts_onbvnf">
1356 <title>Script Options</title>
1357
1358 <programlisting>$ python onboardVNF.py -h
1359Usage: onboardVNF.py [options]
1360
1361Onboard a VNF to Enea uCPE Manager.
1362
1363Options:
1364 --version show program's version number and exit
1365 -h, --help show this help message and exit
1366 -u USERNAME, --username=USERNAME
1367 Enea uCPE Manager login username
1368 -p PASSWORD, --password=PASSWORD
1369 Enea uCPE Manager login password
1370 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1371 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
1372 Username for FTP
1373 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
1374 FTP password
1375 -P FTPPORT, --ftpPort=FTPPORT
1376 FTP port
1377 -b VNFBUNDLE, --bundle=VNFBUNDLE
1378 File name of VNF bundle in ZIP format
1379
1380 Mandatory options:
1381 -H/--host, -b/--bundle</programlisting>
1382 </section>
1383
1384 <section id="json_onbvnf">
1385 <title>Configuring the JSON File</title>
1386
1387 <para>The JSON configuration file needed to onboard a VNF image should
1388 contain a list of dictionaries. Each dictionary indicates the test
1389 case name and the test case arguments passed to the
1390 <filename>onboardVNF</filename> Python module.</para>
1391
1392 <para><emphasis role="bold">Sample unit-test JSON file
1393 format:</emphasis><programlisting>[
1394 {
1395 "name": "Onboarding Fortigate VNF ",
1396 "args": "-b ../../vnf_images/Fortigate.zip"
1397 }
1398]</programlisting></para>
1399 </section>
1400
1401 <section id="pymod_onbvnf">
1402 <title>Running the Python Module</title>
1403
1404 <para>The <filename>onboardVNF</filename> Python module can be
1405 executed individually by running the following command line:</para>
1406
1407 <programlisting>$ python onboardVNF.py -u admin -p admin -f ftp -w ftp -H localhost -b
1408../../vnf_images/Fortigate.zip
14092019-02-25 16:00:53,890 - DEBUG: Started logging
14102019-02-25 16:00:53,890 - INFO: Onboard VNF
14112019-02-25 16:00:53,985 - DEBUG: Login successful on host 'localhost'
14122019-02-25 16:00:53,985 - DEBUG: Session token is: c421cd03-3905-11e9-a81f525400d08e1d
14132019-02-25 16:00:53,994 - DEBUG: FTP file '../../vnf_images/Fortigate.zip' on host
1414'localhost', port '2021'
14152019-02-25 16:00:54,229 - DEBUG: Onboard VNF: Fortigate
14162019-02-25 16:00:56,836 - INFO: Done
14172019-02-25 16:00:56,861 - DEBUG: Logging out and exiting...</programlisting>
1418 </section>
1419 </section>
1420
1421 <section id="onboard_vnf_image"> 1364 <section id="onboard_vnf_image">
1422 <title>Onboarding a VNF Image Raw</title> 1365 <title>Onboarding a VNF Image Raw</title>
1423 1366
@@ -2562,34 +2505,41 @@ Options:
2562 <para>The <filename>setup_env.sh</filename> script sets up the 2505 <para>The <filename>setup_env.sh</filename> script sets up the
2563 <literal>testHarness</literal> test environment by creating 2506 <literal>testHarness</literal> test environment by creating
2564 <literal>testHarness-venv python virtualenv</literal>, executing requests 2507 <literal>testHarness-venv python virtualenv</literal>, executing requests
2565 needed by Automation Framework python modules and installing Ansible. The 2508 needed by Automation Framework python modules and installing
2566 playbooks directory contains all the implemented Ansible Playbooks. For 2509 Ansible.</para>
2567 more details please refer to chapter "Sample Test Cases" from the Enea NFV 2510
2568 Access System Test Specification document <remark>need an olink to that 2511 <para>The <literal>/playbooks</literal> directory contains all the
2569 chapter here.</remark>.</para> 2512 implemented Ansible Playbooks. For more details please refer to the <olink
2570 2513 targetdoc="book_enea_nfv_access_system_test_specification"
2571 <para>The <literal>uCPEM_config</literal> directory stores JSON 2514 targetptr="sample_testcases">Sample Test Cases Chapter in the <xi:include
2515 href="../../s_docbuild/olinkdb/pardoc-names.xml"
2516 xmlns:xi="http://www.w3.org/2001/XInclude"
2517 xpointer="element(book_enea_nfv_access_system_test_specification/1)" /></olink>
2518 Manual.</para>
2519
2520 <para>The /<literal>uCPEM_config</literal> directory stores JSON
2572 configuration files needed for the setup of the uCPE Manager used by TH. 2521 configuration files needed for the setup of the uCPE Manager used by TH.
2573 One configuration file is needed per uCPE Manager installation, to be used 2522 One configuration file is needed per uCPE Manager installation, to be used
2574 in the TH. The <literal>vnf_image</literal> directory stores the VNF 2523 in the TH.</para>
2575 Images needed by the Ansible Playbooks (i.e. the sample test 2524
2576 cases).</para> 2525 <para>The <literal>/vnf_image</literal> directory stores the VNF Images
2577 2526 needed by the Ansible Playbooks (i.e. the sample test cases).</para>
2578 <para>The <literal>lab_config</literal> directory stores the JSON 2527
2579 configuration files related to a device (devices<remark>clarify this 2528 <para>The <literal>/lab_config</literal> directory stores the JSON
2580 please, what devices do you mean?</remark>, NICs and bridges). Each 2529 configuration files related to a device (devices, NICs and bridges) as
2581 subfolder should be named exactly like the device name and should contain 2530 well as sample custom scripts. Each subfolder should be named exactly like
2582 all the related configuration files needed for the test cases to be run on 2531 the device name and should contain all the related configuration files
2583 it.</para> 2532 needed for the test cases to be run on it.</para>
2584 2533
2585 <para>The <literal>vnf_config</literal> directory stores the configuration 2534 <para>The <literal>/vnf_config</literal> directory stores the
2586 files related to a VNF Descriptor. Typically these include a VNF Image 2535 configuration files related to a VNF Descriptor and VNF instances.
2587 JSON, VNF Instance JSON, VNF license and any other files required by the 2536 Typically these include a VNF Image JSON, VNF Instance JSON, VNF license
2588 type of the VNF. Each subfolder should be named exactly like the name of 2537 and any other files required by the type of the VNF. Each subfolder should
2589 the VNF Descriptor and should contain all the related configuration files 2538 be named exactly like the name of the VNF Descriptor and should contain
2590 needed for test cases to be run using this VNF.</para> 2539 all the related configuration files needed for test cases to be run using
2591 2540 this VNF.</para>
2592 <para>The log directory is created when the 2541
2542 <para>The <literal>/log</literal> directory is created when the
2593 <literal>setup_env.sh</literal> is run. When test cases are run, the 2543 <literal>setup_env.sh</literal> is run. When test cases are run, the
2594 Ansible and the Python logs are stored in the 2544 Ansible and the Python logs are stored in the
2595 <filename>ansible.log</filename> and <filename>debug.log</filename> files, 2545 <filename>ansible.log</filename> and <filename>debug.log</filename> files,
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
index 2917b1a..3439a64 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
@@ -46,10 +46,12 @@
46 <para>One or more uCPE devices running the Enea NFV Access Run Time 46 <para>One or more uCPE devices running the Enea NFV Access Run Time
47 Platform are required as hosts to run the VNF(s). The uCPE device is 47 Platform are required as hosts to run the VNF(s). The uCPE device is
48 known to the uCPE Manager as the "VcpeAgent" device module.</para> 48 known to the uCPE Manager as the "VcpeAgent" device module.</para>
49 49
50 <note><para>Before running any use case with the Automation Framework or 50 <note>
51 the Test Harness, make sure the uCPE device(s) have been added to 51 <para>Before running any use case with the Automation Framework or the
52 the uCPE Manager.</para></note> 52 Test Harness, make sure the uCPE device(s) have been added to the uCPE
53 Manager.</para>
54 </note>
53 55
54 <para>Adding a VcpeAgent device can be done via two methods:</para> 56 <para>Adding a VcpeAgent device can be done via two methods:</para>
55 57
@@ -124,12 +126,10 @@
124 126
125 <para>For details about the test suites or test cases please refer to 127 <para>For details about the test suites or test cases please refer to
126 chapter <olink targetdoc="book_enea_nfv_access_system_test_specification" 128 chapter <olink targetdoc="book_enea_nfv_access_system_test_specification"
127 targetptr="sample_testcases">Sample Test Cases in <xi:include 129 targetptr="sample_testcases">Sample Test Cases in the<xi:include
128 href="../../s_docbuild/olinkdb/pardoc-names.xml" 130 href="../../s_docbuild/olinkdb/pardoc-names.xml"
129 xmlns:xi="http://www.w3.org/2001/XInclude" 131 xmlns:xi="http://www.w3.org/2001/XInclude"
130 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para> 132 xpointer="element(book_enea_nfv_access_system_test_specification/1)" /></olink>
131 133 Manual.</para>
132 <remark>this olink needs to be fixed it points to getting started not the
133 test spec manual, an olinkdb update is needed to know why.</remark>
134 </section> 134 </section>
135</chapter> \ No newline at end of file 135</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
index 18e7048..8a62b3b 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
@@ -30,9 +30,12 @@
30 <note> 30 <note>
31 <para>The Automation Framework and Test Harness installation may be done 31 <para>The Automation Framework and Test Harness installation may be done
32 on the same machine used for uCPE Manager installation, although this is 32 on the same machine used for uCPE Manager installation, although this is
33 not encouraged. For more details see <link linkend="automation">chapter 33 not encouraged. For more details see section <olink
34 3.2</link>.<remark>what chapter of what book is this link refering 34 targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
35 to?</remark></para> 35 targetptr="automation">Automation Framework in the <xi:include
36 href="../../s_docbuild/olinkdb/pardoc-names.xml"
37 xmlns:xi="http://www.w3.org/2001/XInclude"
38 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>.</para>
36 </note> 39 </note>
37 </section> 40 </section>
38 41
@@ -49,9 +52,11 @@
49 </imageobject> 52 </imageobject>
50 </mediaobject> 53 </mediaobject>
51 </figure>The following enviroment setup is needed for running all tests 54 </figure>The following enviroment setup is needed for running all tests
52 defined in the Enea NFV Access System Test Specification manual:</para> 55 defined in the <xi:include
53 56 href="../../s_docbuild/olinkdb/pardoc-common.xml"
54 <remark>olink to the book needed here.</remark> 57 xmlns:xi="http://www.w3.org/2001/XInclude"
58 xpointer="element(book_enea_nfv_access_system_test_specification/1)" />
59 manual:</para>
55 60
56 <para><emphasis role="bold">Lab Network 61 <para><emphasis role="bold">Lab Network
57 Requirements</emphasis><itemizedlist spacing="compact"> 62 Requirements</emphasis><itemizedlist spacing="compact">
@@ -159,8 +164,8 @@
159 <orderedlist> 164 <orderedlist>
160 <listitem> 165 <listitem>
161 <para>Unzip the 166 <para>Unzip the
162 <filename>nfvaccess&lt;version&gt;_af-th.zip</filename> archive file, 167 <filename>Enea_NFV_Access_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip</filename>
163 provided by Enea, on a supported host machine.</para> 168 archive file, provided by Enea, on a supported host machine.</para>
164 169
165 <para>The directory in which the archive has been unpacked will be 170 <para>The directory in which the archive has been unpacked will be
166 denoted as <literal>&lt;AF-TH-installdir&gt;</literal>.</para> 171 denoted as <literal>&lt;AF-TH-installdir&gt;</literal>.</para>
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml
index 9b63248..7ba8a7b 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml
@@ -29,6 +29,24 @@
29 <para>1 LAN interface for 128T.</para> 29 <para>1 LAN interface for 128T.</para>
30 </listitem> 30 </listitem>
31 </itemizedlist> 31 </itemizedlist>
32
33 <para>The following files are needed for this example use-case:</para>
34
35 <itemizedlist>
36 <listitem>
37 <para>128T router VNF image. Please contact 128 Technology to get a
38 VNF image and its license file.</para>
39 </listitem>
40
41 <listitem>
42 <para>cloud-init iso image.</para>
43 </listitem>
44 </itemizedlist>
45
46 <note>
47 <para>For data path validation, it may be required to generate a new
48 cloud-init image to match your network configuration.</para>
49 </note>
32 </section> 50 </section>
33 51
34 <section id="vnf_router_cust"> 52 <section id="vnf_router_cust">
@@ -50,11 +68,6 @@
50 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 68 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
51 devices:</emphasis><orderedlist> 69 devices:</emphasis><orderedlist>
52 <listitem> 70 <listitem>
53 <para>Log into the uCPE Manager with both username and password
54 values: <literal>admin</literal>.</para>
55 </listitem>
56
57 <listitem>
58 <para>Add the trgt uCPE device into the uCPE Manager: 71 <para>Add the trgt uCPE device into the uCPE Manager:
59 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para> 72 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para>
60 73
@@ -375,8 +388,8 @@
375 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para> 388 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
376 389
377 <para>Onboard the VM Image through <literal>VNF -&gt; Descriptors -&gt; 390 <para>Onboard the VM Image through <literal>VNF -&gt; Descriptors -&gt;
378 On-board -&gt; VM Image</literal>, and fill in the required fields with 391 On-board</literal>, and fill in the required fields with the following
379 the following values:</para> 392 values:</para>
380 393
381 <table> 394 <table>
382 <title>VM Image Details</title> 395 <title>VM Image Details</title>
@@ -637,6 +650,11 @@
637 </tbody> 650 </tbody>
638 </tgroup> 651 </tgroup>
639 </table> 652 </table>
653
654 <note>
655 <para>To procure the VNF image files and their licenses, please
656 contact each respective VNF provider.</para>
657 </note>
640 </section> 658 </section>
641 659
642 <section id="uc_test_cust_router"> 660 <section id="uc_test_cust_router">
@@ -661,10 +679,7 @@
661 <para>In order to validate the data path, connect a test machine to the 679 <para>In order to validate the data path, connect a test machine to the
662 LAN physical port, assign the static IP and a route:<programlisting>&gt; ifconfig eth3 192.168.64.3 netmask 255.255.255.0 680 LAN physical port, assign the static IP and a route:<programlisting>&gt; ifconfig eth3 192.168.64.3 netmask 255.255.255.0
663&gt; ip route add default via 192.168.64.1 dev eth3 681&gt; ip route add default via 192.168.64.1 dev eth3
664&gt; ping 8.8.8.8</programlisting>For data path validation, it may be required 682&gt; ping 8.8.8.8</programlisting></para>
665 to generate a new cloud-init image to match your network configuration.
666 Please check Appendix A: How to create 128T cloud-init iso image (day-0
667 configuration), for more details.</para>
668 </section> 683 </section>
669 684
670 <section id="cleanup_custone"> 685 <section id="cleanup_custone">
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml b/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml
index b0a90b2..2458d99 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml
@@ -6,8 +6,8 @@
6 used as the VNF image on NFV Access.</para> 6 used as the VNF image on NFV Access.</para>
7 7
8 <note> 8 <note>
9 <para>Follow the <filename>128tISO-Install.pdf</filename> document and 9 <para>Keep in mind a Virtual Machine was used instead of a physical
10 keep in mind a Virtual Machine was used instead of a physical host.</para> 10 host.</para>
11 </note> 11 </note>
12 12
13 <para><emphasis role="bold">Prerequisites:</emphasis><itemizedlist> 13 <para><emphasis role="bold">Prerequisites:</emphasis><itemizedlist>
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml b/doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml
index 42e6a5e..9fe1b2b 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml
@@ -2,8 +2,14 @@
2<appendix id="appendix_four_cust"> 2<appendix id="appendix_four_cust">
3 <title>Running Enea Automation Framework tests</title> 3 <title>Running Enea Automation Framework tests</title>
4 4
5 <para>For more detailed information regarding the Automation Framework and
6 Test Harness please see the <xi:include
7 href="../../s_docbuild/olinkdb/pardoc-common.xml"
8 xmlns:xi="http://www.w3.org/2001/XInclude"
9 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />.</para>
10
5 <para>The most relevant information from the Automation Framework and Test 11 <para>The most relevant information from the Automation Framework and Test
6 Harness structure:</para> 12 Harness structure is presented below:</para>
7 13
8 <programlisting>|---automation_framework 14 <programlisting>|---automation_framework
9| |---unittestSuite 15| |---unittestSuite
@@ -18,14 +24,14 @@
18| | |---unittestSuite.py 24| | |---unittestSuite.py
19|---lab_config 25|---lab_config
20| |---trgt-1 26| |---trgt-1
21| | |---enp4s0f0_0000_04_00_0.json
22| | |---enp4s0f1_0000_04_00_1.json
23| | |---ibm_br.json - In-band management definition. 27| | |---ibm_br.json - In-band management definition.
24| | |---lan_br_enp4s0f1.json - Lan bridge definition. 28| | |---lan_br.json - Lan bridge definition.
25| | |---trgt-1.json 29| | |---target.json
26 - Target definition - make sure to update the "address". 30 - Target definition - the "address", "deviceId", "name" and \
31 "version" must be updated.
27| | |---sfc_br.json - Service chain bridge definition. 32| | |---sfc_br.json - Service chain bridge definition.
28| | |---vnf_mgmt_br.json - VNF management bridge definition. 33| | |---vnf_mgmt_br.json - VNF management bridge definition.
34| | |---lan_nic.json - NIC definition.
29|---vnf_config 35|---vnf_config
30| |---128t 36| |---128t
31| | |---128tInstance.json - 128T instantiation - used in use case 1. 37| | |---128tInstance.json - 128T instantiation - used in use case 1.
@@ -37,16 +43,53 @@
37| | |---fortigateInstance.json - Fortigate instantiantion. 43| | |---fortigateInstance.json - Fortigate instantiantion.
38| | |---fortigate.json - Fortigate onboarding. 44| | |---fortigate.json - Fortigate onboarding.
39| | |---fortigateLicense.lic 45| | |---fortigateLicense.lic
40 - Fortigate license - replace it with a valid License file. 46 - Fortigate license - contact Fortinet to get a VNF image and license file.
41|---vnf_image 47|---vnf_image
42| |---centos_128t_with_ci.qcow2 - 128T qcow2 image. 48| |---centos_128t_with_ci.qcow2 - Contact 128 Technology to get a \
43| |---fortios.qcow2 - Fortigate qcow2 image.</programlisting> 49 VNF image and its license file.
50| |---fortios.qcow2 - Contact Fortinet to get a VNF image \
51 and its license file.</programlisting>
44 52
45 <para>Make sure to update the relevant configuration file for your setup. 53 <para>Make sure to update the relevant configuration file for your setup.
46 The essential files to consider are the target configuration 54 The essential files to consider are the uCPE Device configuration
47 (<filename>trgt-1.json</filename>), the license for the Fortigate VNF, and 55 (<filename>target.json</filename>), the license for the Fortigate VNF, and
48 the 128T cloud-init iso image matching your network.</para> 56 the 128T cloud-init iso image matching your network.</para>
49 57
50 <para>To run a test:<programlisting>&gt; cd automation_and_systemtest/automation_framework/unittestSuite 58 <para>For uCPE Device configuration (<filename>target.json</filename>)
51&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 -s</programlisting></para> 59 please change the following information, if needed, in the JSON file:</para>
60
61 <itemizedlist spacing="compact">
62 <listitem>
63 <para><literal>address</literal> - The IP address of uCPE Device.</para>
64 </listitem>
65
66 <listitem>
67 <para><literal>version</literal> - The NFVA version.</para>
68 </listitem>
69
70 <listitem>
71 <para><literal>deviceId</literal> - The device ID of uCPE Device.</para>
72 </listitem>
73
74 <listitem>
75 <para><literal>name</literal> - The name of uCPE Device.</para>
76 </listitem>
77 </itemizedlist>
78
79 <note>
80 <para>Before starting the two usecases detailed in the following appendix,
81 the uCPE Device needs to be added into the uCPE Manager.</para>
82 </note>
83
84 <para>To run a test:</para>
85
86 <programlisting>&gt; cd automation_framework/unittestSuite/
87&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPEManager IP address&gt; -n \
88&lt;uCPE Device name&gt; -s &lt;Test suite&gt; -d &lt;description&gt;</programlisting>
89
90 <para>The <literal>Test suite</literal> must be one from any of the
91 following: <filename>128tDeploy.json</filename>,
92 <filename>128tCleanup.json</filename>,
93 <filename>128t_FG_SFCDeploy.json</filename>, or
94 <filename>128t_FG_SFCCleanup.json</filename>.</para>
52</appendix> \ No newline at end of file 95</appendix> \ No newline at end of file
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 bdffa2f..ea99e4f 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
@@ -2,200 +2,240 @@
2<appendix id="appendix_five_cust"> 2<appendix id="appendix_five_cust">
3 <title>Example Tests Results using the Automation Framework</title> 3 <title>Example Tests Results using the Automation Framework</title>
4 4
5 <programlisting>Test Host: 5 <para>In order to run the following example usecases, certain configuration
6Use Case1 - 128T 6 file entries need to be modified according to the network setup that it will
7&gt; cd automation_and_systemtest/automation_framework/unittestSuite 7 be used, for more details see the previous appendix:</para>
8&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \ 8
9 <itemizedlist spacing="compact">
10 <listitem>
11 <para>uCPE Device name: inteld1521-17</para>
12 </listitem>
13
14 <listitem>
15 <para>address: 172.24.8.62</para>
16 </listitem>
17
18 <listitem>
19 <para>version: 2.2.3</para>
20 </listitem>
21
22 <listitem>
23 <para>deviceId: inteld1521-17</para>
24 </listitem>
25 </itemizedlist>
26
27 <para><programlisting>&gt; cat lab_config/trgt-1/target.json
28{
29 "name": "inteld1521-17",
30 "description": "trgt",
31 "address": "172.24.8.62",
32 "port": "830",
33 "username": "root",
34 "password": "",
35 "certificate": null,
36 "passphrase": null,
37 "maintMode": "false",
38 "version": "2.2.3",
39 "deviceId": "inteld1521-17"
40}</programlisting>The IP address of the uCPE Manager that will be used in
41 these examples is <literal>172.24.3.92</literal>.</para>
42
43 <para>The FortiGate and 128T VNF images need to be copied into the
44 <literal>vnf_image</literal> directory. The names should be the same as
45 those described in the previous appendix.</para>
46
47 <para>The FortiGate valid license file needs to be copied into the
48 <literal>vnf_config/fortigate/</literal> directory. The name should be the
49 same as that described in the previous appendix.</para>
50
51 <para>The cloud init files that match the network, need to be copied into
52 the <literal>vnf_config/fortigate/</literal> and the
53 <literal>vnf_config/128t/</literal> directories respectively. The names
54 should be the same as those described in the previous appendix.</para>
55
56 <section id="ap_d_uc1">
57 <title>Use-case 1: 128T VNF Router Example Use-case</title>
58
59 <programlisting>&gt; cd automation_framework/unittestSuite/
60&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \
9-s 128tDeploy.json -d "128T Deployment" 61-s 128tDeploy.json -d "128T Deployment"
10 62
11Running 128T Deployment... 63Running 128T Deployment...
12 64
13test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ... 65test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
142020-04-15 19:04:58,037 - INFO: Wait uCPE device 662020-08-26 10:10:05,517 - INFO: Wait uCPE device
152020-04-15 19:05:29,128 - INFO: Status: Connected 672020-08-26 10:10:36,650 - INFO: Status: Connected
162020-04-15 19:05:29,128 - INFO: Done 682020-08-26 10:10:36,651 - INFO: Done
17ok 69ok
18test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... 70test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ...
192020-04-15 19:05:29,154 - INFO: Bind NIC 712020-08-26 10:10:36,686 - INFO: Bind NIC
202020-04-15 19:05:30,280 - INFO: Done 722020-08-26 10:10:37,788 - INFO: Done
21ok 73ok
22test 003: Creating ibm bridge (__main__.UnittestSuite) ... 74test 003: Creating ibm bridge (__main__.UnittestSuite) ...
232020-04-15 19:05:30,302 - INFO: New OVS network bridge 752020-08-26 10:10:37,818 - INFO: New OVS network bridge
242020-04-15 19:05:50,687 - INFO: Done 762020-08-26 10:10:58,762 - INFO: Done
25ok 77ok
26test 004: Creating VNF Management bridge (__main__.UnittestSuite) ... 78test 004: Creating VNF Management bridge (__main__.UnittestSuite) ...
272020-04-15 19:05:50,706 - INFO: New OVS network bridge 792020-08-26 10:10:58,794 - INFO: New OVS network bridge
282020-04-15 19:05:50,982 - INFO: Done 802020-08-26 10:10:58,977 - INFO: Done
29ok 81ok
30test 005: Creating LAN bridge and attaching lan interface to the bridge \ 82test 005: Creating LAN bridge and attaching lan interface to the bridge \
31(__main__.UnittestSuite) ... 83(__main__.UnittestSuite) ...
322020-04-15 19:05:51,001 - INFO: New OVS network bridge 842020-08-26 10:10:59,003 - INFO: New OVS network bridge
332020-04-15 19:05:51,682 - INFO: Done 852020-08-26 10:10:59,334 - INFO: Done
34ok 86ok
35test 006: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... 87test 006: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ...
362020-04-15 19:05:51,704 - INFO: Onboard wizard 882020-08-26 10:10:59,370 - INFO: Onboard wizard
372020-04-15 19:08:43,978 - INFO: Done 892020-08-26 10:13:55,775 - INFO: Done
38ok 90ok
39test 007: Instantiate 128T VNF (__main__.UnittestSuite) ... 91test 007: Instantiate 128T VNF (__main__.UnittestSuite) ...
402020-04-15 19:08:44,000 - INFO: Instantiate VNF 922020-08-26 10:13:55,813 - INFO: Instantiate VNF
412020-04-15 19:09:37,385 - INFO: Done 932020-08-26 10:14:56,583 - INFO: Done
42ok 94ok
43 95
44---------------------------------------------------------------------- 96----------------------------------------------------------------------
45Ran 7 tests in 279.366s 97Ran 7 tests in 291.103s
46 98
47OK 99OK
48 100
101&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \
102-s 128tCleanup.json -d "128T Cleanup"
49 103
50Clean-up use-case1 104Running 128T Cleanup...
51&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \
52-s 128tCleanup.json -d "128T Clean-up"
53
54Running 128T Clean-up...
55 105
56test 001: Destroying 128T VNF (__main__.UnittestSuite) ... 106test 001: Destroying 128T VNF (__main__.UnittestSuite) ...
572020-04-15 19:10:41,926 - INFO: Destroy VNF 1072020-08-26 10:15:28,395 - INFO: Destroy VNF
582020-04-15 19:10:42,813 - INFO: Done 1082020-08-26 10:15:29,452 - INFO: Done
59ok 109ok
60test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... 110test 002: Deleting network bridge LAN (__main__.UnittestSuite) ...
612020-04-15 19:10:42,831 - INFO: Delete OVS network bridge 1112020-08-26 10:15:29,493 - INFO: Delete OVS network bridge
622020-04-15 19:10:43,231 - INFO: Done 1122020-08-26 10:15:29,734 - INFO: Done
63ok 113ok
64test 003: Deleting VNF management bridge (__main__.UnittestSuite) ... 114test 003: Deleting VNF management bridge (__main__.UnittestSuite) ...
652020-04-15 19:10:43,248 - INFO: Delete OVS network bridge 1152020-08-26 10:15:29,765 - INFO: Delete OVS network bridge
662020-04-15 19:10:43,366 - INFO: Done 1162020-08-26 10:15:30,080 - INFO: Done
67ok 117ok
68test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... 118test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ...
692020-04-15 19:10:43,383 - INFO: Delete OVS network bridge 1192020-08-26 10:15:30,110 - INFO: Delete OVS network bridge
702020-04-15 19:10:58,638 - INFO: Done 1202020-08-26 10:15:46,907 - INFO: Done
71ok 121ok
72test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... 122test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ...
732020-04-15 19:10:58,687 - INFO: Unbind NIC 1232020-08-26 10:15:46,967 - INFO: Unbind NIC
742020-04-15 19:11:00,490 - INFO: Done 1242020-08-26 10:15:48,489 - INFO: Done
75ok 125ok
76test 006: Offboarding 128t VNF (__main__.UnittestSuite) ... 126test 006: Offboarding 128t VNF (__main__.UnittestSuite) ...
772020-04-15 19:11:00,509 - INFO: Offboard VNF 1272020-08-26 10:15:48,531 - INFO: Offboard VNF
782020-04-15 19:11:01,416 - INFO: Done 1282020-08-26 10:15:49,171 - INFO: Done
79ok 129ok
80 130
81---------------------------------------------------------------------- 131----------------------------------------------------------------------
82Ran 6 tests in 19.507s 132Ran 6 tests in 20.808s
83 133
84OK 134OK</programlisting>
135 </section>
85 136
137 <section id="ap_d_uc2">
138 <title>Use-case 2: Service Chaining 128T - Fortigate Example
139 Usecase</title>
86 140
87Use-case2 141 <programlisting>&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \
88&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \
89-s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" 142-s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment"
90 143
91Running 128T - Fortigate SFC Deployment... 144Running 128T - Fortigate SFC Deployment...
92 145
93test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ... 146test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
942020-04-15 19:12:31,906 - INFO: Wait uCPE device 1472020-08-26 10:17:29,361 - INFO: Wait uCPE device
952020-04-15 19:13:02,972 - INFO: Status: Connected 1482020-08-26 10:18:00,473 - INFO: Status: Connected
962020-04-15 19:13:02,973 - INFO: Done 1492020-08-26 10:18:00,474 - INFO: Done
97ok 150ok
98test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... 151test 002: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ...
992020-04-15 19:13:02,994 - INFO: Bind NIC 1522020-08-26 10:18:00,634 - INFO: Bind NIC
1002020-04-15 19:13:04,105 - INFO: Done 1532020-08-26 10:18:01,805 - INFO: Done
101ok 154ok
102test 003: Creating ibm bridge (__main__.UnittestSuite) ... 155test 003: Creating ibm bridge (__main__.UnittestSuite) ...
1032020-04-15 19:13:04,122 - INFO: New OVS network bridge 1562020-08-26 10:18:01,863 - INFO: New OVS network bridge
1042020-04-15 19:13:10,939 - INFO: Done 1572020-08-26 10:18:30,640 - INFO: Done
105ok 158ok
106test 004: Creating VNF Management bridge (__main__.UnittestSuite) ... 159test 004: Creating VNF Management bridge (__main__.UnittestSuite) ...
1072020-04-15 19:13:10,957 - INFO: New OVS network bridge 1602020-08-26 10:18:30,670 - INFO: New OVS network bridge
1082020-04-15 19:13:11,246 - INFO: Done 1612020-08-26 10:18:30,876 - INFO: Done
109ok 162ok
110test 005: Creating LAN bridge and attaching lan interface to the bridge \ 163test 005: Creating LAN bridge and attaching lan interface to the bridge \
111(__main__.UnittestSuite) ... 164(__main__.UnittestSuite) ...
1122020-04-15 19:13:11,264 - INFO: New OVS network bridge 1652020-08-26 10:18:30,908 - INFO: New OVS network bridge
1132020-04-15 19:13:12,010 - INFO: Done 1662020-08-26 10:18:31,243 - INFO: Done
114ok 167ok
115test 006: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ... 168test 006: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ...
1162020-04-15 19:13:12,026 - INFO: New OVS network bridge 1692020-08-26 10:18:31,273 - INFO: New OVS network bridge
1172020-04-15 19:13:12,104 - INFO: Done 1702020-08-26 10:18:31,416 - INFO: Done
118ok 171ok
119test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... 172test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ...
1202020-04-15 19:13:12,118 - INFO: Onboard wizard 1732020-08-26 10:18:31,448 - INFO: Onboard wizard
1212020-04-15 19:15:48,993 - INFO: Done 1742020-08-26 10:21:21,569 - INFO: Done
122ok 175ok
123test 008: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... 176test 008: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ...
1242020-04-15 19:15:49,012 - INFO: Onboard wizard 1772020-08-26 10:21:21,608 - INFO: Onboard wizard
1252020-04-15 19:15:53,805 - INFO: Done 1782020-08-26 10:21:27,199 - INFO: Done
126ok 179ok
127test 009: Instantiate 128T VNF (__main__.UnittestSuite) ... 180test 009: Instantiate 128T VNF (__main__.UnittestSuite) ...
1282020-04-15 19:15:53,880 - INFO: Instantiate VNF 1812020-08-26 10:21:27,226 - INFO: Instantiate VNF
1292020-04-15 19:16:53,272 - INFO: Done 1822020-08-26 10:22:27,067 - INFO: Done
130ok 183ok
131test 010: Instantiate Fortigate VNF (__main__.UnittestSuite) ... 184test 010: Instantiate Fortigate VNF (__main__.UnittestSuite) ...
1322020-04-15 19:16:53,289 - INFO: Instantiate VNF 1852020-08-26 10:22:27,121 - INFO: Instantiate VNF
1332020-04-15 19:16:57,428 - INFO: Done 1862020-08-26 10:22:31,310 - INFO: Done
134ok 187ok
135 188
136---------------------------------------------------------------------- 189----------------------------------------------------------------------
137Ran 10 tests in 265.536s 190Ran 10 tests in 301.989s
138 191
139OK 192OK
140 193
194&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \
195-s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC Cleanup"
141 196
142# Access 128T management interface 197Running 128T - Fortigate SFC Cleanup...
143https://172.24.12.154:60001
144user: admin
145password: 128Tadmin
146
147# Access Fortigate management interface
148https://172.24.12.154:60002
149user: admin
150password:
151
152
153
154Use case2 clean-up
155&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n trgt-1 \
156-s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC CleanUp"
157
158Running 128T - Fortigate SFC CleanUp...
159 198
160test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... 199test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ...
1612020-04-15 19:31:37,255 - INFO: Destroy VNF 2002020-08-26 10:23:29,308 - INFO: Destroy VNF
1622020-04-15 19:31:38,941 - INFO: Done 2012020-08-26 10:23:30,026 - INFO: Done
163ok 202ok
164test 002: Destroying 128T VNF (__main__.UnittestSuite) ... 203test 002: Destroying 128T VNF (__main__.UnittestSuite) ...
1652020-04-15 19:31:38,960 - INFO: Destroy VNF 2042020-08-26 10:23:30,065 - INFO: Destroy VNF
1662020-04-15 19:31:39,878 - INFO: Done 2052020-08-26 10:23:30,917 - INFO: Done
167ok 206ok
168test 003: Deleting network bridge SFC (__main__.UnittestSuite) ... 207test 003: Deleting network bridge SFC (__main__.UnittestSuite) ...
1692020-04-15 19:31:39,908 - INFO: Delete OVS network bridge 2082020-08-26 10:23:30,960 - INFO: Delete OVS network bridge
1702020-04-15 19:31:40,086 - INFO: Done 2092020-08-26 10:23:31,123 - INFO: Done
171ok 210ok
172test 004: Deleting network bridge LAN (__main__.UnittestSuite) ... 211test 004: Deleting network bridge LAN (__main__.UnittestSuite) ...
1732020-04-15 19:31:40,102 - INFO: Delete OVS network bridge 2122020-08-26 10:23:31,156 - INFO: Delete OVS network bridge
1742020-04-15 19:31:40,388 - INFO: Done 2132020-08-26 10:23:31,381 - INFO: Done
175ok 214ok
176test 005: Deleting VNF management bridge (__main__.UnittestSuite) ... 215test 005: Deleting VNF management bridge (__main__.UnittestSuite) ...
1772020-04-15 19:31:40,427 - INFO: Delete OVS network bridge 2162020-08-26 10:23:31,412 - INFO: Delete OVS network bridge
1782020-04-15 19:31:40,678 - INFO: Done 2172020-08-26 10:23:31,596 - INFO: Done
179ok 218ok
180test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... 219test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ...
1812020-04-15 19:31:40,701 - INFO: Delete OVS network bridge 2202020-08-26 10:23:31,621 - INFO: Delete OVS network bridge
1822020-04-15 19:31:46,894 - INFO: Done 2212020-08-26 10:23:47,980 - INFO: Done
183ok 222ok
184test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... 223test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ...
1852020-04-15 19:31:46,945 - INFO: Unbind NIC 2242020-08-26 10:23:48,019 - INFO: Unbind NIC
1862020-04-15 19:31:48,792 - INFO: Done 2252020-08-26 10:23:49,547 - INFO: Done
187ok 226ok
188test 008: Offboarding 128t VNF (__main__.UnittestSuite) ... 227test 008: Offboarding 128t VNF (__main__.UnittestSuite) ...
1892020-04-15 19:31:48,808 - INFO: Offboard VNF 2282020-08-26 10:23:49,575 - INFO: Offboard VNF
1902020-04-15 19:31:49,554 - INFO: Done 2292020-08-26 10:23:50,252 - INFO: Done
191ok 230ok
192test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ... 231test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ...
1932020-04-15 19:31:49,572 - INFO: Offboard VNF 2322020-08-26 10:23:50,295 - INFO: Offboard VNF
1942020-04-15 19:31:49,837 - INFO: Done 2332020-08-26 10:23:50,589 - INFO: Done
195ok 234ok
196 235
197---------------------------------------------------------------------- 236----------------------------------------------------------------------
198Ran 9 tests in 12.600s 237Ran 9 tests in 21.326s
199 238
200OK</programlisting> 239OK</programlisting>
240 </section>
201</appendix> \ No newline at end of file 241</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/book.xml b/doc/book-enea-nfv-access-example-usecases/doc/book.xml
index 05fd522..eb8b0c8 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/book.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/book.xml
@@ -36,15 +36,6 @@
36 <xi:include href="service_chaining_128t_fortigate.xml" 36 <xi:include href="service_chaining_128t_fortigate.xml"
37 xmlns:xi="http://www.w3.org/2001/XInclude" /> 37 xmlns:xi="http://www.w3.org/2001/XInclude" />
38 38
39 <xi:include href="appendix_1.xml"
40 xmlns:xi="http://www.w3.org/2001/XInclude" />
41
42 <xi:include href="appendix_2.xml"
43 xmlns:xi="http://www.w3.org/2001/XInclude" />
44
45 <xi:include href="appendix_3.xml"
46 xmlns:xi="http://www.w3.org/2001/XInclude" />
47
48 <xi:include href="appendix_4.xml" 39 <xi:include href="appendix_4.xml"
49 xmlns:xi="http://www.w3.org/2001/XInclude" /> 40 xmlns:xi="http://www.w3.org/2001/XInclude" />
50 41
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
index b5e7803..36c7114 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
@@ -166,7 +166,7 @@
166 166
167 <listitem> 167 <listitem>
168 <para><emphasis role="bold">Cloud-init content file</emphasis>: Add 168 <para><emphasis role="bold">Cloud-init content file</emphasis>: Add
169 a license file entry.</para> 169 a file entry where Path: license.</para>
170 </listitem> 170 </listitem>
171 </itemizedlist> 171 </itemizedlist>
172 172
@@ -249,13 +249,13 @@
249 249
250 <para>The FortiGate VNF management interface is accessible through the 250 <para>The FortiGate VNF management interface is accessible through the
251 WAN interface. The WAN IP address can be used from a web browser on the 251 WAN interface. The WAN IP address can be used from a web browser on the
252 Lab Machine to access the FortiGate VNF Management Web UI. Please check 252 Lab Machine to access the FortiGate VNF Management Web UI. See section
253 <olink targetdoc="book_enea_nfv_access_example_usecases" 253 <olink targetdoc="book_enea_nfv_access_example_usecases"
254 targetptr="fortigate_webmg">FortiGate VNF web management<xi:include 254 targetptr="fortigate_webmg">FortiGate VNF web management in the
255 href="../../s_docbuild/olinkdb/pardoc-names.xml" 255 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
256 xmlns:xi="http://www.w3.org/2001/XInclude" 256 xmlns:xi="http://www.w3.org/2001/XInclude"
257 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink> 257 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
258 for more information.</para> 258 Manual for more information.</para>
259 </section> 259 </section>
260 </section> 260 </section>
261 261
@@ -343,13 +343,13 @@
343 343
344 <orderedlist> 344 <orderedlist>
345 <listitem> 345 <listitem>
346 <para>Connect the <literal>VNFMgr</literal> interfaces to the Lab 346 <para>Connect the <literal>VNF Management</literal> interfaces to
347 Network for VNF management access.</para> 347 the Lab Network for VNF management access.</para>
348 </listitem> 348 </listitem>
349 349
350 <listitem> 350 <listitem>
351 <para>Directly connect the <literal>WAN</literal> interfaces back to 351 <para>Connect the <literal>WAN</literal> interfaces back to back or
352 back (using a cable) or connected via VPN.</para> 352 via VPN.</para>
353 </listitem> 353 </listitem>
354 354
355 <listitem> 355 <listitem>
@@ -434,7 +434,7 @@
434 434
435 <listitem> 435 <listitem>
436 <para><emphasis role="bold">Cloud-init content file</emphasis>: Add 436 <para><emphasis role="bold">Cloud-init content file</emphasis>: Add
437 a license file entry.</para> 437 a file entry where Path: license.</para>
438 </listitem> 438 </listitem>
439 </itemizedlist> 439 </itemizedlist>
440 440
@@ -502,9 +502,8 @@
502 <literal>sdwan1</literal> example configuration file.</para> 502 <literal>sdwan1</literal> example configuration file.</para>
503 503
504 <para>To complete the branch-to-branch setup, configure <literal>uCPE 504 <para>To complete the branch-to-branch setup, configure <literal>uCPE
505 device 2</literal> in the same way as <literal>uCPE device 1</literal>. 505 device 2</literal> in the same way as <literal>uCPE device
506 Make sure to use the <literal>sdwan2</literal> configuration file for 506 1</literal>.</para>
507 the second VNF instantiation.</para>
508 507
509 <note> 508 <note>
510 <para>The names of the ports used during instantiation need to be the 509 <para>The names of the ports used during instantiation need to be the
@@ -520,15 +519,13 @@
520 be established between the two uCPE devices. The Test Machines can be 519 be established between the two uCPE devices. The Test Machines can be
521 connected to the LAN interface on each uCPE device.</para> 520 connected to the LAN interface on each uCPE device.</para>
522 521
523 <para>The connected Test Machine can be a laptop or a uCPE device that
524 has one interface configured to get a dynamic IP from a DHCP server. The
525 <command>dhclient &lt;interface&gt;</command> command can be used to
526 request an IP address.</para>
527
528 <note> 522 <note>
529 <para>The received IP must be in the 172.16.1.2 - 172.16.1.255 range 523 <para>The connected Test Machine can be a laptop or a uCPE device that
530 for Test Machine-1 and in the 172.16.2.2 - 172.16.2.255 range for Test 524 has one interface configured to get a dynamic IP from a DHCP server.
531 Machine-2.</para> 525 The <command>dhclient &lt;interface&gt;</command> command can be used
526 to request an IP address.The received IP must be in the 172.16.1.2 -
527 172.16.1.255 range for Test Machine-1 and in the 172.16.2.2 -
528 172.16.2.255 range for Test Machine-2.</para>
532 </note> 529 </note>
533 530
534 <para>The Test Machine connected to <literal>uCPE device 1</literal> 531 <para>The Test Machine connected to <literal>uCPE device 1</literal>
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml b/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml
index 456ab50..fc3559b 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml
@@ -6,20 +6,22 @@
6 configuration, onboarding and instantiation of certain VNFs, VNF chaining, 6 configuration, onboarding and instantiation of certain VNFs, VNF chaining,
7 etc.</para> 7 etc.</para>
8 8
9 <para>Before running any example use case make sure the uCPE device(s) have
10 been added to the uCPE Manager and placed on the map. For detailed
11 information on how to add a device to the uCPE Manager, how to configure the
12 network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, or VNF
13 configuration, please refer to the <xi:include
14 href="../../s_docbuild/olinkdb/pardoc-common.xml"
15 xmlns:xi="http://www.w3.org/2001/XInclude"
16 xpointer="element(book_enea_nfv_access_getting_started/1)" /> Manual.</para>
17
9 <note> 18 <note>
10 <para>Before running any example use case make sure the uCPE device(s) have been 19 <para>Examples presented in this document use 3rd-party VNFs, which are
11 added to the uCPE Manager and placed on the map.</para> 20 not provided by Enea. To procure and use these VNF image files and license
21 files, please contact the VNF provider. </para>
12 22
13 <para>For detailed information on how to add a device to the uCPE Manager, 23 <para>Request the VNF prerequisites from the VNF vendors, or alternatively
14 how to configure the network interfaces to use DPDK, PCI-passthrough or 24 obtain the prerequisites based on instructions from each VNF vendor
15 SR-IOV drivers, or VNF configuration, please refer to the <xi:include 25 respectively.</para>
16 href="../../s_docbuild/olinkdb/pardoc-common.xml"
17 xmlns:xi="http://www.w3.org/2001/XInclude"
18 xpointer="element(book_enea_nfv_access_getting_started/1)" />
19 Manual.</para>
20 </note> 26 </note>
21 27</chapter> \ No newline at end of file
22 <para>Examples presented in this document use 3rd-party VNFs, which
23 are not provided by Enea. To procure and use these VNF image files and license files,
24 where applicable, please contact the VNF provider.</para>
25</chapter>
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml
index 4719399..1f3a6ce 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml
@@ -2,12 +2,9 @@
2<chapter id="service_chaining_128t_fortigate"> 2<chapter id="service_chaining_128t_fortigate">
3 <title>Service Chaining 128T - Fortigate Example Use-case</title> 3 <title>Service Chaining 128T - Fortigate Example Use-case</title>
4 4
5 <para>The term service chaining or service function chaining (SFC) is used 5 <para>The following is an example of how to setup and configure a service
6 to describe the definition and instantiation of an ordered list of instances 6 chain on top of the Enea NFV Access virtualization platform, using the
7 of such service functions and the subsequent "steering" of traffic flows 7 following commercial VNFs: 128T router and FortiGate.</para>
8 through those service functions. The set of enabled service function chains
9 reflects operator service offerings and is designed in conjunction with
10 application delivery and service and network policy.</para>
11 8
12 <section id="prereq_serv_chain_cust"> 9 <section id="prereq_serv_chain_cust">
13 <title>Prerequisites</title> 10 <title>Prerequisites</title>
@@ -45,6 +42,29 @@
45 Firewall and vRouter.</para> 42 Firewall and vRouter.</para>
46 </listitem> 43 </listitem>
47 </itemizedlist> 44 </itemizedlist>
45
46 <para>The following files are needed for this example use-case:</para>
47
48 <itemizedlist spacing="compact">
49 <listitem>
50 <para>FortiGate VNF image. Please contact Fortinet to get a VNF image
51 and its license file.</para>
52 </listitem>
53
54 <listitem>
55 <para>128T router VNF image. Please contact 128 Technology to get a
56 VNF image and its license file.</para>
57 </listitem>
58
59 <listitem>
60 <para>Cloud-init iso image.</para>
61 </listitem>
62 </itemizedlist>
63
64 <note>
65 <para>To procure the VNF image files and their licenses, please contact
66 each respective VNF provider.</para>
67 </note>
48 </section> 68 </section>
49 69
50 <section id="ser_chain_uc"> 70 <section id="ser_chain_uc">
@@ -66,11 +86,6 @@
66 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 86 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
67 devices:</emphasis><orderedlist> 87 devices:</emphasis><orderedlist>
68 <listitem> 88 <listitem>
69 <para>Log into the uCPE Manager with both username and password
70 values: <literal>admin</literal>.</para>
71 </listitem>
72
73 <listitem>
74 <para>Add the trgt uCPE device into the uCPE Manager: 89 <para>Add the trgt uCPE device into the uCPE Manager:
75 <literal>Devices -&gt; Manage -&gt; Add</literal>, and fill in the 90 <literal>Devices -&gt; Manage -&gt; Add</literal>, and fill in the
76 required fields with the following data:</para> 91 required fields with the following data:</para>
@@ -225,10 +240,8 @@
225 240
226 <para>Add the OVS bridges by selecting the trgt device then: 241 <para>Add the OVS bridges by selecting the trgt device then:
227 <literal>Configuration -&gt; OpenVSwitch -&gt; Bridges -&gt; 242 <literal>Configuration -&gt; OpenVSwitch -&gt; Bridges -&gt;
228 Add</literal>.</para> 243 Add</literal>. Fill in the required fields for each bridge with
229 244 the following data from each table:</para>
230 <para>Fill in the required fields for each bridge with the
231 following data from each table:</para>
232 245
233 <table> 246 <table>
234 <title>ibm_br Bridge Details</title> 247 <title>ibm_br Bridge Details</title>
@@ -276,6 +289,8 @@
276 </tgroup> 289 </tgroup>
277 </table> 290 </table>
278 291
292 <para></para>
293
279 <table> 294 <table>
280 <title>vnf_mgmt_br Bridge Details</title> 295 <title>vnf_mgmt_br Bridge Details</title>
281 296
@@ -443,8 +458,8 @@
443 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para> 458 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
444 459
445 <para>Onboard the 128T VNF VM Image through <literal>VNF -&gt; 460 <para>Onboard the 128T VNF VM Image through <literal>VNF -&gt;
446 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the 461 Descriptors -&gt; On-board</literal>, and fill in the required fields
447 required fields with the following values:</para> 462 with the following values:</para>
448 463
449 <table> 464 <table>
450 <title>128T VM Image Details</title> 465 <title>128T VM Image Details</title>
@@ -600,8 +615,8 @@
600 </note> 615 </note>
601 616
602 <para>Onboard the Fortigate VNF VM Image through <literal>VNF -&gt; 617 <para>Onboard the Fortigate VNF VM Image through <literal>VNF -&gt;
603 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the 618 Descriptors -&gt; On-board</literal>, and fill in the required fields
604 required fields with the following values:</para> 619 with the following values:</para>
605 620
606 <table> 621 <table>
607 <title>Fortigate VM Image Details</title> 622 <title>Fortigate VM Image Details</title>
@@ -626,7 +641,7 @@
626 <entry>VM image file</entry> 641 <entry>VM image file</entry>
627 642
628 <entry><literal>fortios.qcow2</literal>. Please make sure to 643 <entry><literal>fortios.qcow2</literal>. Please make sure to
629 contact Fortigate for an official Fortigate KVM image.</entry> 644 contact Fortinet for an official FortiGate KVM image.</entry>
630 </row> 645 </row>
631 646
632 <row> 647 <row>
@@ -822,10 +837,7 @@
822 <row> 837 <row>
823 <entry>Cloud Init File</entry> 838 <entry>Cloud Init File</entry>
824 839
825 <entry><literal>centos_128t_internet_ci.iso</literal>. Example 840 <entry><literal>centos_128t_internet_ci.iso</literal>.</entry>
826 image provided. Please see Appendix A for details on how to
827 change the configuration and create a new cloud-init iso
828 image.</entry>
829 </row> 841 </row>
830 842
831 <row> 843 <row>
@@ -873,6 +885,11 @@
873 </tgroup> 885 </tgroup>
874 </table> 886 </table>
875 887
888 <note>
889 <para>To procure the VNF image files and their licenses, please
890 contact each respective VNF provider.</para>
891 </note>
892
876 <para>Instantiate the Fortigate VNF by selecting the trgt device, then 893 <para>Instantiate the Fortigate VNF by selecting the trgt device, then
877 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para> 894 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>
878 895
@@ -936,8 +953,7 @@
936 <row> 953 <row>
937 <entry>License File</entry> 954 <entry>License File</entry>
938 955
939 <entry><literal>FGVM08TM00001.lic</literal>. Please make sure to 956 <entry>The FortiGate license file provided by Fortinet.</entry>
940 use a valid license file (.lic) received from Fortinet.</entry>
941 </row> 957 </row>
942 958
943 <row> 959 <row>
@@ -1012,8 +1028,7 @@
1012 interface is configured with a DHCP server):<programlisting>&gt; dhclient eth1 1028 interface is configured with a DHCP server):<programlisting>&gt; dhclient eth1
1013&gt; ping 8.8.8.8</programlisting>For data path validation, a new cloud-init 1029&gt; ping 8.8.8.8</programlisting>For data path validation, a new cloud-init
1014 image may need to be generated for the 128T VNF to match your network 1030 image may need to be generated for the 128T VNF to match your network
1015 configuration. Please check Appendix A "How to create 128T cloud-init 1031 configuration.</para>
1016 iso image (day-0 configuration)" for details.</para>
1017 </section> 1032 </section>
1018 1033
1019 <section> 1034 <section>
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml
index b8b0d5e..8b82337 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml
@@ -2,6 +2,13 @@
2<chapter id="vnf_chaining"> 2<chapter id="vnf_chaining">
3 <title>VNF Chaining Example Use-case</title> 3 <title>VNF Chaining Example Use-case</title>
4 4
5 <para>The term service chaining or service function chaining (SFC) is used
6 to describe the definition and instantiation of an ordered list of instances
7 of such service functions and the subsequent "steering" of traffic flows
8 through those service functions. The set of enabled service function chains
9 reflects operator service offerings and is designed in conjunction with
10 application delivery and service and network policy.</para>
11
5 <para>The following is an example of how to setup and configure a 12 <para>The following is an example of how to setup and configure a
6 branch-to-branch service comprised on two commercial VNFs (SD-WAN + 13 branch-to-branch service comprised on two commercial VNFs (SD-WAN +
7 Firewall). This service will run in a service chain on top of the Enea NFV 14 Firewall). This service will run in a service chain on top of the Enea NFV
@@ -40,11 +47,6 @@
40 47
41 <para>The following files are needed for this example use-case:</para> 48 <para>The following files are needed for this example use-case:</para>
42 49
43 <note>
44 <para>To procure the VNF image files and their licenses, please
45 contact each respective VNF provider.</para>
46 </note>
47
48 <itemizedlist> 50 <itemizedlist>
49 <listitem> 51 <listitem>
50 <para>Fortigate VNF image file.</para> 52 <para>Fortigate VNF image file.</para>
@@ -55,6 +57,10 @@
55 </listitem> 57 </listitem>
56 58
57 <listitem> 59 <listitem>
60 <para>vSRX-Site&lt;x&gt;.iso Cloud-init files.</para>
61 </listitem>
62
63 <listitem>
58 <para>VNF Configuration files, provided with your Enea NFV Access 64 <para>VNF Configuration files, provided with your Enea NFV Access
59 Release:</para> 65 Release:</para>
60 66
@@ -64,15 +70,18 @@
64 </listitem> 70 </listitem>
65 71
66 <listitem> 72 <listitem>
67 <para><filename>vSRX-Site&lt;x&gt;.iso</filename>.</para>
68 </listitem>
69
70 <listitem>
71 <para><filename>FortiFW-Site&lt;x&gt;.conf</filename>.</para> 73 <para><filename>FortiFW-Site&lt;x&gt;.conf</filename>.</para>
72 </listitem> 74 </listitem>
73 </itemizedlist> 75 </itemizedlist>
74 </listitem> 76 </listitem>
75 </itemizedlist> 77 </itemizedlist>
78
79 <note>
80 <para>To procure the VNF image files and their licenses, please
81 contact each respective VNF provider. To create the
82 vSRX-Site&lt;x&gt;.iso file, please follow the documentation provided
83 by Juniper.</para>
84 </note>
76 </section> 85 </section>
77 86
78 <section id="exam_setup_chain"> 87 <section id="exam_setup_chain">
@@ -205,8 +214,8 @@
205 </listitem> 214 </listitem>
206 215
207 <listitem> 216 <listitem>
208 <para>Add <literal>license</literal> as the Cloud-Init content 217 <para>In the Cloud-init content files field add an entry where
209 in the Cloud-Init tab files.</para> 218 <literal>Path: license</literal>.</para>
210 </listitem> 219 </listitem>
211 </itemizedlist> 220 </itemizedlist>
212 </listitem> 221 </listitem>
@@ -222,11 +231,6 @@
222 <listitem> 231 <listitem>
223 <para>Use <filename>vSRX-Site1.iso</filename> as the Cloud-Init 232 <para>Use <filename>vSRX-Site1.iso</filename> as the Cloud-Init
224 file.</para> 233 file.</para>
225
226 <note>
227 <para>Please follow Juniper's documentation to create the
228 <filename>vSRX-Site1.iso</filename> file.</para>
229 </note>
230 </listitem> 234 </listitem>
231 235
232 <listitem> 236 <listitem>
@@ -239,7 +243,7 @@
239 <listitem> 243 <listitem>
240 <para>Add virtual interfaces:</para> 244 <para>Add virtual interfaces:</para>
241 245
242 <itemizedlist> 246 <itemizedlist spacing="compact">
243 <listitem> 247 <listitem>
244 <para>Management interface added to 248 <para>Management interface added to
245 <literal>vnf_mgmt_br</literal>.</para> 249 <literal>vnf_mgmt_br</literal>.</para>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index afcdec6..9c60ebb 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -146,9 +146,9 @@
146node0.1048576kB = 3 </programlisting> 146node0.1048576kB = 3 </programlisting>
147 147
148 <note> 148 <note>
149 <para>Make sure there are no hugepages reserved in the kernel boot 149 <para>Make sure there are no hugepages reserved in the kernel boot
150 command line, these will override any manual configuration done 150 command line, these will override any manual configuration done in the
151 in the service.</para> 151 service.</para>
152 </note> 152 </note>
153 </section> 153 </section>
154 </section> 154 </section>
@@ -221,8 +221,8 @@ node0.1048576kB = 3 </programlisting>
221 drive) under <literal>/uefi_sb_keys</literal>.</para> 221 drive) under <literal>/uefi_sb_keys</literal>.</para>
222 222
223 <para>These certificates need to be manually enrolled in BIOS. The 223 <para>These certificates need to be manually enrolled in BIOS. The
224 exact details on how to proceed may vary depending the version of the 224 exact details on how to proceed may vary depending the version of the
225 UEFI firmware.</para> 225 UEFI firmware.</para>
226 </section> 226 </section>
227 227
228 <section id="enable_secure_boot"> 228 <section id="enable_secure_boot">
@@ -253,6 +253,14 @@ node0.1048576kB = 3 </programlisting>
253 root filesystem. When the installation is complete, the uCPE device is 253 root filesystem. When the installation is complete, the uCPE device is
254 automatically rebooted into Enea NFV Access Run Time Platform.</para> 254 automatically rebooted into Enea NFV Access Run Time Platform.</para>
255 255
256 <note>
257 <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and
258 <literal>bzImage</literal> files are available in the
259 Enea_NFV_Access_Run_Time_Platform_
260 &lt;processor&gt;_&lt;version&gt;-&lt;build_number&gt;.tar.gz file you
261 downloaded with your release.</para>
262 </note>
263
256 <section id="bare_meta_prov_prereq"> 264 <section id="bare_meta_prov_prereq">
257 <title>Prerequisites</title> 265 <title>Prerequisites</title>
258 266
@@ -303,7 +311,7 @@ node0.1048576kB = 3 </programlisting>
303 311
304 <listitem> 312 <listitem>
305 <para>Compress the Enea NFV Access Run Time Platform 313 <para>Compress the Enea NFV Access Run Time Platform
306 <literal>hddimg</literal> image for the uCPE device architecture 314 <literal>.hddimg</literal> image for the uCPE device architecture
307 using <literal>gzip</literal> and copy the resulting 315 using <literal>gzip</literal> and copy the resulting
308 <literal>hddimg.gz</literal> file to the HTTP server.</para> 316 <literal>hddimg.gz</literal> file to the HTTP server.</para>
309 </listitem> 317 </listitem>
@@ -348,11 +356,13 @@ node0.1048576kB = 3 </programlisting>
348 356
349 <para>Installation Configuration File Example:</para> 357 <para>Installation Configuration File Example:</para>
350 358
351 <programlisting> 359 <programlisting>image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
352 image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz 360install_drive = /dev/sda</programlisting>
353 install_drive = /dev/sda
354 361
355</programlisting> 362 <note>
363 <para>The installation configuration file needs to use the Linux
364 end-of-line format (\n), not the Windows format (\r\n).</para>
365 </note>
356 </section> 366 </section>
357 367
358 <section id="bare_meta_prov_pxe"> 368 <section id="bare_meta_prov_pxe">
@@ -363,14 +373,14 @@ node0.1048576kB = 3 </programlisting>
363 (e.g <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The 373 (e.g <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The
364 PXE entry should have the following settings:</para> 374 PXE entry should have the following settings:</para>
365 375
366 <programlisting> 376 <programlisting>default nfv_access
367 default nfv_access 377label nfv_access
368 label nfv_access 378menu label ^NFV_ACCESS_INSTALLER
369 menu label ^NFV_ACCESS_INSTALLER 379kernel &lt;Path to kernel&gt;
370 kernel &lt;Path to kernel&gt; 380append root=/dev/ram0 initrd=&lt;Path to initramfs&gt; LABEL=pxe-installer \
371 append root=/dev/ram0 initrd=&lt;Path to initramfs&gt; LABEL=pxe-installer \ 381 INSTALL_CFG=http://&lt;Server IP&gt;/&lt;Path to install config file&gt; \
372 INSTALL_CFG=http://&lt;Server IP&gt;/&lt;Path to install config file&gt; 382 console=ttyS0,115200 earlyprintk=ttyS0,115200
373 ipappend 2 383ipappend 2
374 </programlisting> 384 </programlisting>
375 </section> 385 </section>
376 </section> 386 </section>
@@ -385,14 +395,12 @@ node0.1048576kB = 3 </programlisting>
385 395
386 <para>Example initiation using <literal>ipmitool</literal>:</para> 396 <para>Example initiation using <literal>ipmitool</literal>:</para>
387 397
388 <programlisting> 398 <programlisting>ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; chassis bootdev pxe
389 ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; chassis bootdev pxe 399ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; power reset </programlisting>
390 ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; power reset
391 </programlisting>
392 400
393 <para>The uCPE devices should be configured in BIOS to boot from the 401 <para>The uCPE devices should be configured in BIOS to boot from the
394 installation drive first in order to automatically start the Enea NFV 402 installation drive first in order to automatically start the Enea NFV
395 Access Run Time Platform when the installation is finished.</para> 403 Access Run Time Platform when the installation is finished.</para>
396 </section> 404 </section>
397 </section> 405 </section>
398</chapter> 406</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml
index 8851aed..e5f81fc 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml
@@ -78,6 +78,13 @@
78 </row> 78 </row>
79 79
80 <row> 80 <row>
81 <entry>FCAPS</entry>
82
83 <entry>Fault-management, Configuration, Accounting, Performance
84 and Security.</entry>
85 </row>
86
87 <row>
81 <entry>NETCONF</entry> 88 <entry>NETCONF</entry>
82 89
83 <entry>Network Configuration Protocol.</entry> 90 <entry>Network Configuration Protocol.</entry>
@@ -116,10 +123,9 @@
116 <row> 123 <row>
117 <entry>PCI Passthrough</entry> 124 <entry>PCI Passthrough</entry>
118 125
119 <entry>PCI Passthrough allows for use of a physical PCI device, 126 <entry>PCI Passthrough allows for use of a physical PCI device,
120 e.g. a network card inside a VM. 127 e.g. a network card inside a VM. If you "PCI passthrough" a
121 If you "PCI passthrough" a device, the device is not available to 128 device, the device is not available to the host anymore.</entry>
122 the host anymore.</entry>
123 </row> 129 </row>
124 130
125 <row> 131 <row>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
index bb7b525..932f0cc 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
@@ -8,16 +8,27 @@
8 <title>Enea NFV Access Run Time Platform Installer</title> 8 <title>Enea NFV Access Run Time Platform Installer</title>
9 9
10 <para>The current release supports two methods of installation:</para> 10 <para>The current release supports two methods of installation:</para>
11 11
12 <itemizedlist> 12 <itemizedlist>
13 <listitem><para>Manual installation from a USB stick using the Enea NFV Access Web-installer, 13 <listitem>
14 which guarantees a clean installation of NFV Access on a uCPE device.</para></listitem> 14 <para>Manual installation from a USB stick using the Enea NFV Access
15 <listitem><para>Mass installation and automated deployment using 15 Web-installer, which guarantees a clean installation of NFV Access on
16 Bare Metal Provisioning.</para></listitem> 16 a uCPE device.</para>
17 </listitem>
18
19 <listitem>
20 <para>Mass installation and automated deployment using Bare Metal
21 Provisioning.</para>
22 </listitem>
17 </itemizedlist> 23 </itemizedlist>
18 24
19 <para>For more information about Bare Metal Provisioning please refer 25 <para>For more information about Bare Metal Provisioning please refer to
20 to <xref linkend="bare_meta_prov">5.3, Bare Metal Provisioning"</xref>.</para> 26 section <olink targetdoc="book_enea_nfv_access_getting_started"
27 targetptr="bare_meta_prov">Bare Metal Provisioning in <xi:include
28 href="../../s_docbuild/olinkdb/pardoc-names.xml"
29 xmlns:xi="http://www.w3.org/2001/XInclude"
30 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
31 Manual.</para>
21 32
22 <section id="prereq"> 33 <section id="prereq">
23 <title>Prerequisites</title> 34 <title>Prerequisites</title>
@@ -102,10 +113,8 @@ q or quit - exits the script</programlisting></para>
102 113
103 <note> 114 <note>
104 <para>When using the installer for the first time, make sure to 115 <para>When using the installer for the first time, make sure to
105 set ALL parameters in order to be able to run all steps. See <xref 116 set ALL parameters in order to be able to run all steps. See
106 linkend="examples"> 117 Example 2 for details.</para>
107 Example 2
108 </xref> for details.</para>
109 </note> 118 </note>
110 119
111 <para><programlisting># set &lt;parameter_name&gt;=&lt;parameter_value&gt;</programlisting></para> 120 <para><programlisting># set &lt;parameter_name&gt;=&lt;parameter_value&gt;</programlisting></para>
@@ -202,149 +211,167 @@ rootfs_destination=</programlisting></para>
202 <section id="auto_installer"> 211 <section id="auto_installer">
203 <title>Creating a bootable USB stick</title> 212 <title>Creating a bootable USB stick</title>
204 213
205 <para>In order to install the Enea NFV Access Run Time Platform, you must 214 <para>In order to install the Enea NFV Access Run Time Platform, you
206 first create a bootable USB stick with the image you intend to 215 must first create a bootable USB stick with the image you intend to
207 install. Follow the example below to proceed.</para> 216 install. Follow the example below to proceed.</para>
208 217
218 <note>
219 <para>The <literal>.hddimg</literal> image is available in the
220 Enea_NFV_Access_Run_Time_Platform_
221 &lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
222 file you downloaded with your release.</para>
223 </note>
224
209 <para><emphasis role="bold">Create a bootable USB stick 225 <para><emphasis role="bold">Create a bootable USB stick
210 image</emphasis></para> 226 image</emphasis></para>
211 227
212 <orderedlist> 228 <orderedlist>
213 <listitem> 229 <listitem>
214 <para>Copy the HDDIMG image file provided by Enea, onto a 230 <para>Copy the <literal>.hddimg</literal> image file provided by
215 development machine.</para> 231 Enea, onto a development machine.</para>
216 </listitem> 232 </listitem>
217 233
218 <listitem> 234 <listitem>
219 <para>Connect the USB stick to the development machine and identify 235 <para>Connect the USB stick to the development machine and identify
220 the device name given by the system with 236 the device name given by the system with <command>lsblk</command>:
221 <command>lsblk</command>: 237 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
222 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
223sda 8:0 1 28.7G 0 disk 238sda 8:0 1 28.7G 0 disk
224sdb 8:0 0 111.8G 0 disk 239sdb 8:0 0 111.8G 0 disk
225|-sdb1 8:1 0 111.8G 0 part</programlisting></para> 240|-sdb1 8:1 0 111.8G 0 part</programlisting></para>
226 </listitem> 241 </listitem>
227 242
228 <listitem> 243 <listitem>
229 <para>Copy the HDDIMG image onto the USB stick, e.g: 244 <para>Copy the <literal>.hddimg</literal> image onto the USB stick,
230 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \ 245 e.g: <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
231of=/dev/sdb bs=4M conv=fsync</programlisting></para> 246of=/dev/sdb bs=4M conv=fsync</programlisting></para>
232 </listitem> 247 </listitem>
233 </orderedlist> 248 </orderedlist>
234 249
235 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg 250 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg
236 </filename>is the <literal>.hddimg</literal> file and <literal>sdb</literal> is the 251 </filename>is the <literal>.hddimg</literal> file and
237 assigned USB device name.</para> 252 <literal>sdb</literal> is the assigned USB device name.</para>
238 </section> 253 </section>
239 254
240 <section id="install_ena_stick"> 255 <section id="install_ena_stick">
241 <title>Installing Enea NFV Access</title> 256 <title>Installing Enea NFV Access</title>
242 257
243 <para><emphasis role="bold">How to install the Enea NFV Access Run Time 258 <para><emphasis role="bold">How to install the Enea NFV Access Run Time
244 Platform using a bootable USB stick image</emphasis></para> 259 Platform using a bootable USB stick image</emphasis></para>
245 260
246 <orderedlist> 261 <orderedlist>
247 <listitem> 262 <listitem>
248 <para>Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will 263 <para>Plug the USB stick into the uCPE device. Connect a laptop
249 not later be chosen as a WAN port. No other ports should be connected.</para> 264 directly into one of the ports that will not later be chosen as a
265 WAN port. No other ports should be connected.</para>
250 </listitem> 266 </listitem>
251 267
252 <listitem> 268 <listitem>
253 <para>Power up the uCPE device and boot the USB stick. Verify that the 269 <para>Power up the uCPE device and boot the USB stick. Verify that
254 USB stick is selected from the BIOS boot menu.</para> 270 the USB stick is selected from the BIOS boot menu.</para>
255 </listitem> 271 </listitem>
256 272
257 <listitem> 273 <listitem>
258 <para>Once the USB stick is properly booted, the Web-installer application starts 274 <para>Once the USB stick is properly booted, the Web-installer
259 automatically and can be accessed in a web browser at <literal>http://172.16.1.1</literal> (port 80). 275 application starts automatically and can be accessed in a web
260 </para> 276 browser at <literal>http://172.16.1.1</literal> (port 80).</para>
261 277
262 <para>On the first page of the Web-installer, the user should fill in:</para> 278 <para>On the first page of the Web-installer, the user should fill
279 in:</para>
263 280
264 <itemizedlist> 281 <itemizedlist>
265 <listitem> 282 <listitem>
266 <para><emphasis role="bold">The uCPE Manager IP Address</emphasis>.</para> 283 <para><emphasis role="bold">The uCPE Manager IP
284 Address</emphasis>.</para>
267 </listitem> 285 </listitem>
268 286
269 <listitem> 287 <listitem>
270 <para><emphasis role="bold">The Device ID</emphasis>. The unique identifier of the 288 <para><emphasis role="bold">The Device ID</emphasis>. The unique
271 uCPE device.</para> 289 identifier of the uCPE device.</para>
272
273 </listitem> 290 </listitem>
274 291
275 <listitem> 292 <listitem>
276 <para><emphasis role="bold">Customer Tags</emphasis>. They are used for 293 <para><emphasis role="bold">Customer Tags</emphasis>. They are
277 <link linkend="zero_touch_prov">Zero Touch Provisining (ZTP)</link> and can be left 294 used for <link linkend="zero_touch_prov">Zero Touch Provisining
278 empty. What can be entered here (as needed), are the tag(s) specified when 295 (ZTP)</link> and can be left empty. What can be entered here (as
279 creating an offline configuration in the uCPE Manager.</para> 296 needed), are the tag(s) specified when creating an offline
297 configuration in the uCPE Manager.</para>
280 </listitem> 298 </listitem>
281 </itemizedlist> 299 </itemizedlist>
282 300
283 <para>On the second page of the Web-installer, the user should fill in:</para> 301 <para>On the second page of the Web-installer, the user should fill
302 in:</para>
284 303
285 <itemizedlist> 304 <itemizedlist>
286 <listitem> 305 <listitem>
287 <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. 306 <para><emphasis role="bold">The Layer 3 configuration of WAN
288 Static or Dynamic IP must be specified.</para> 307 Interface(s)</emphasis>. Static or Dynamic IP must be
289 308 specified.</para>
290 <para>During network configuration, WAN cables will be plugged into the device 309
291 in order to identify ports and make them available for configuration. Each 310 <para>During network configuration, WAN cables will be plugged
292 port with a physically connected cable will be automatically set as a WAN port and must be 311 into the device in order to identify ports and make them
293 configured (DHCP is the default setting). The user needs to connect the same quantity of 312 available for configuration. Each port with a physically
294 cables as the number of WAN ports that he wishes to configure. No LAN ports should be 313 connected cable will be automatically set as a WAN port and must
295 connected nor configured at this time. The configured WAN cables cannot be removed 314 be configured (DHCP is the default setting). The user needs to
296 after being configured.</para> 315 connect the same quantity of cables as the number of WAN ports
297 316 that he wishes to configure. No LAN ports should be connected
298 <note> 317 nor configured at this time. The configured WAN cables cannot be
299 <para>The LAN port used to access the Web-installer from the laptop will not be shown 318 removed after being configured.</para>
300 and cannot be configured.</para></note> 319
320 <note>
321 <para>The LAN port used to access the Web-installer from the
322 laptop will not be shown and cannot be configured.</para>
323 </note>
301 </listitem> 324 </listitem>
302 325
303 <listitem> 326 <listitem>
304 <para><emphasis role="bold">The Management Interface</emphasis>. The interface that 327 <para><emphasis role="bold">The Management Interface</emphasis>.
305 will be used by the uCPE Manager to communicate with the device.</para> 328 The interface that will be used by the uCPE Manager to
306 329 communicate with the device.</para>
307 </listitem> 330 </listitem>
308 </itemizedlist> 331 </itemizedlist>
309 </listitem> 332 </listitem>
310 333
311 <listitem> 334 <listitem>
312 <para>When the user has completed the configuration steps in the Web-installer, NFV Access 335 <para>When the user has completed the configuration steps in the
313 is installed on the hard drive. The largest drive found on the device will be used for 336 Web-installer, NFV Access is installed on the hard drive. The
314 installation.</para> 337 largest drive found on the device will be used for
338 installation.</para>
315 </listitem> 339 </listitem>
316
317 </orderedlist> 340 </orderedlist>
318 </section> 341 </section>
319 342
320 <section id="boot_ena"> 343 <section id="boot_ena">
321 <title>Booting NFV Access</title> 344 <title>Booting NFV Access</title>
322 345
323 <para>When the installation has finished successfully, the user should remove the USB stick 346 <para>When the installation has finished successfully, the user should
324 before confirming the reboot of the device in Web-installer and ensure that BIOS is configured 347 remove the USB stick before confirming the reboot of the device in
325 to boot from the hard drive.</para> 348 Web-installer and ensure that BIOS is configured to boot from the hard
349 drive.</para>
350
351 <para>When configured with the Web-installer GUI, the uCPE device
352 start-up sequence will configure the interfaces accordingly and try to
353 register the device in the uCPE manager. If connectivity is established
354 with the uCPE manager server and a device with a matching Device ID is
355 found, the configuration is successful, and the connection is
356 established.</para>
326 357
327 <para>When configured with the Web-installer GUI, the uCPE device start-up sequence will
328 configure the interfaces accordingly and try to register the device in the uCPE manager.
329 If connectivity is established with the uCPE manager server and a device with a matching
330 Device ID is found, the configuration is successful, and the connection is established.</para>
331
332 <note> 358 <note>
333 <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at 359 <para>If NFV Access was installed by Bare Metal Provisioning, the
334 start-up expecting the user to provide the post-installation configuration. The Web-installer will 360 Web-installer will launch at start-up expecting the user to provide
335 be launched on port 80 for post-installation configuration: <literal> 361 the post-installation configuration. The Web-installer will be
362 launched on port 80 for post-installation configuration: <literal>
336 http://172.16.1.1</literal>.</para> 363 http://172.16.1.1</literal>.</para>
337 </note> 364 </note>
338 365
339 <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot 366 <para>In case of failure, the user should remove all WAN cables,
340 the device and then access the Web-installer on <literal>http://172.16.1.1</literal>. 367 re-attach the laptop, reboot the device and then access the
341 </para> 368 Web-installer on <literal>http://172.16.1.1</literal>.</para>
342 369
343 <note> 370 <note>
344 <para>After having established a successful connection with the uCPE Manager, the user will 371 <para>After having established a successful connection with the uCPE
345 connect any LAN cable(s) that should be connected to the device. 372 Manager, the user will connect any LAN cable(s) that should be
346 </para> 373 connected to the device.</para>
347 </note> 374 </note>
348 </section> 375 </section>
349 376
350 <section condition="hidden" id="examples"> 377 <section condition="hidden" id="examples">
@@ -684,4 +711,4 @@ ssh root@&lt;target_ip&gt; "cd /mnt/sda6; tar -zxf -"</programlisting>
684 </note> 711 </note>
685 </section> 712 </section>
686 </section> 713 </section>
687</chapter> 714</chapter> \ 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 85ee5a3..2acc009 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
@@ -117,8 +117,7 @@ OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</program
117 117
118 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac))))) 118 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac)))))
119export PATH=$PATH:$JAVA_HOME/bin 119export PATH=$PATH:$JAVA_HOME/bin
120export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar 120export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting>
121</programlisting>
122 </listitem> 121 </listitem>
123 </orderedlist> 122 </orderedlist>
124 123
@@ -137,6 +136,28 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
137 </listitem> 136 </listitem>
138 137
139 <listitem> 138 <listitem>
139 <para>If you plan to use the PostgreSQL server bundled with the uCPE
140 Manager, verify that there is no existing installation of the
141 Postgres database. Execute the following command to check if you
142 have a currently running PostgreSQL database server:</para>
143
144 <programlisting>ps -ef | grep post</programlisting>
145
146 <para>To remove a currently installed PostgreSQL server (including
147 the existing postgres user), run the following commands:</para>
148
149 <programlisting>yum remove postgres\*
150rm -f /var/lib/pgsql
151rm -f /etc/postgres-reg.ini
152userdel postgres</programlisting>
153
154 <note>
155 <para>This step is not necessary if the uCPE Manager will be using
156 an external database (like MariaDB).</para>
157 </note>
158 </listitem>
159
160 <listitem>
140 <para>Choose the target installation folder, e.g. 161 <para>Choose the target installation folder, e.g.
141 <literal>/opt/ems</literal>. Everything will be installed under a 162 <literal>/opt/ems</literal>. Everything will be installed under a
142 folder called <literal>ucpemanager</literal> within the target 163 folder called <literal>ucpemanager</literal> within the target
@@ -209,11 +230,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
209 </listitem> 230 </listitem>
210 231
211 <listitem> 232 <listitem>
212 <para><literal>configureHA.sh</literal></para> 233 <para><filename>configureHA.sh</filename></para>
213 </listitem> 234 </listitem>
214 235
215 <listitem> 236 <listitem>
216 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 237 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
217 </listitem> 238 </listitem>
218 239
219 <listitem> 240 <listitem>
@@ -225,7 +246,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
225 <listitem> 246 <listitem>
226 <para>Run the following command:</para> 247 <para>Run the following command:</para>
227 248
228 <programlisting>./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 249 <programlisting>./install.sh /opt/ems \
250 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
229 </listitem> 251 </listitem>
230 </orderedlist> 252 </orderedlist>
231 253
@@ -302,7 +324,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
302 additional argument as shown below:</para> 324 additional argument as shown below:</para>
303 325
304 <programlisting>./install.sh \ 326 <programlisting>./install.sh \
305 /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz \ 327 /opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
306 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> 328 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
307 329
308 <para>The other steps are exactly the same as specified in the 330 <para>The other steps are exactly the same as specified in the
@@ -331,7 +353,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
331 </listitem> 353 </listitem>
332 354
333 <listitem> 355 <listitem>
334 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 356 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
335 </listitem> 357 </listitem>
336 </itemizedlist> 358 </itemizedlist>
337 </listitem> 359 </listitem>
@@ -339,7 +361,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
339 <listitem> 361 <listitem>
340 <para>Run the following command:</para> 362 <para>Run the following command:</para>
341 363
342 <programlisting>./upgrade.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 364 <programlisting>./upgrade.sh /opt/ems \
365 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
343 </listitem> 366 </listitem>
344 </orderedlist> 367 </orderedlist>
345 368
@@ -577,8 +600,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
577 <para>When using this mechanism, the device will initiate a connection 600 <para>When using this mechanism, the device will initiate a connection
578 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE 601 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
579 Manager waits for a device connection. For more information please see 602 Manager waits for a device connection. For more information please see
580 section <link linkend="install_ena_stick">Installing Enea NFV 603 section <olink targetdoc="book_enea_nfv_access_getting_started"
581 Access</link> for more details.</para> 604 targetptr="auto_installer">Creating a bootable USB stick in the
605 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
606 xmlns:xi="http://www.w3.org/2001/XInclude"
607 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
608 Manual for more details.</para>
582 </section> 609 </section>
583 </section> 610 </section>
584 611
@@ -607,13 +634,13 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
607 634
608 <para>Configuring a physical interface in DPDK mode will require a 635 <para>Configuring a physical interface in DPDK mode will require a
609 DPDK-based application (e.g. OVS-DPDK) in order to access and use the 636 DPDK-based application (e.g. OVS-DPDK) in order to access and use the
610 interface. An interface set as the DPDK can be attached to an OVS-DPDK 637 interface. An interface set as DPDK can be attached to an OVS-DPDK
611 bridge.</para> 638 bridge.</para>
612 639
613 <note> 640 <note>
614 <para>Make sure the <literal>Enable DPDK</literal> checkbox is 641 <para>Make sure the <literal>Enable DPDK</literal> checkbox is
615 selected in <literal>Device -&gt; Configuration -&gt; 642 selected in <literal>Device -&gt; Configuration -&gt;
616 DPDK</literal>, otherwise no interface can be assigned to the 643 DPDK</literal>, otherwise no interface can be assigned as
617 DPDK.</para> 644 DPDK.</para>
618 </note> 645 </note>
619 646
@@ -635,8 +662,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
635 662
636 <listitem> 663 <listitem>
637 <para>Dpdk-type: the kernel module that allows user space access 664 <para>Dpdk-type: the kernel module that allows user space access
638 to the physical interface. The <literal>vfio-pci</literal> driver 665 to the physical interface. Either the <literal>vfio-pci</literal>
639 is used.</para> 666 or the <literal>igb_uio</literal> driver can be used.</para>
640 </listitem> 667 </listitem>
641 </itemizedlist> 668 </itemizedlist>
642 </section> 669 </section>
@@ -917,8 +944,13 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
917 <note> 944 <note>
918 <para>VNF management interfaces must be configured in same 945 <para>VNF management interfaces must be configured in same
919 network as the <literal>vnf-mgmt-address</literal> of the 946 network as the <literal>vnf-mgmt-address</literal> of the
920 bridge. For more information, please see 4.4 <link 947 bridge. For more information, please see section <olink
921 linkend="vnf_management">VNF Management</link>.</para> 948 targetdoc="book_enea_nfv_access_getting_started"
949 targetptr="vnf_management">VNF Management in the <xi:include
950 href="../../s_docbuild/olinkdb/pardoc-names.xml"
951 xmlns:xi="http://www.w3.org/2001/XInclude"
952 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
953 Manual.</para>
922 </note> 954 </note>
923 </section> 955 </section>
924 956
@@ -1279,6 +1311,13 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1279 Uploaded Successfully</literal> appears on the File Upload 1311 Uploaded Successfully</literal> appears on the File Upload
1280 Screen.</para> 1312 Screen.</para>
1281 1313
1314 <note>
1315 <para>The image file of type <literal>rootfs.ostree.tar.bz2</literal>
1316 is available in the
1317 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
1318 file you downloaded with your release.</para>
1319 </note>
1320
1282 <section id="upload_image"> 1321 <section id="upload_image">
1283 <title>Image Library</title> 1322 <title>Image Library</title>
1284 1323
@@ -1301,7 +1340,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1301 to the image file (must be of type 1340 to the image file (must be of type
1302 <literal>rootfs.ostree.tar.bz2</literal>). Select the target 1341 <literal>rootfs.ostree.tar.bz2</literal>). Select the target
1303 hardware platform corresponding to the image being uploaded 1342 hardware platform corresponding to the image being uploaded
1304 (xeon-d or atomc-3000).</para> 1343 (xeon-d or atom-c3000).</para>
1305 </listitem> 1344 </listitem>
1306 1345
1307 <listitem> 1346 <listitem>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
index c6a4f04..96c3172 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
@@ -64,9 +64,9 @@
64 64
65 <para>Enea uCPE Manager is a control center application providing a full 65 <para>Enea uCPE Manager is a control center application providing a full
66 FCAPS and VNF management experience through a GUI and REST API. It can be 66 FCAPS and VNF management experience through a GUI and REST API. It can be
67 deployed on a host or a virtual machine. CentOS and Windows are supported 67 deployed on a host or a virtual machine running 64-bit CentOS on an x86
68 host platforms by default. The uCPE Manager uses a southbound EdgeLink 68 platform. The uCPE Manager uses a southbound EdgeLink NETCONF protocol to
69 NETCONF protocol to connect and manage uCPE devices.</para> 69 connect and manage uCPE devices.</para>
70 70
71 <para>Enea uCPE Manager provides the following key features:</para> 71 <para>Enea uCPE Manager provides the following key features:</para>
72 72
@@ -92,4 +92,4 @@
92 </listitem> 92 </listitem>
93 </itemizedlist> 93 </itemizedlist>
94 </section> 94 </section>
95</chapter> \ No newline at end of file 95</chapter>
diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
index ed7394c..ef46843 100644
--- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
@@ -20,19 +20,19 @@
20 20
21 <itemizedlist> 21 <itemizedlist>
22 <listitem> 22 <listitem>
23 <para>Enea_NFV_Access_Run_Time_Platform_XeonD_2.2.3.tar.gz</para> 23 <para>Enea_NFV_Access_Run_Time_Platform_C3000_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
24 </listitem> 24 </listitem>
25 25
26 <listitem> 26 <listitem>
27 <para>Enea_NFV_Access_Run_Time_Platform_C3000_2.2.3.tar.gz</para> 27 <para>Enea_NFV_Access_Run_Time_Platform_XeonD_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
28 </listitem> 28 </listitem>
29 29
30 <listitem> 30 <listitem>
31 <para>ucpeManager_2.2.3_b1-CentOS.tar.gz</para> 31 <para>Enea_NFV_Access_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip</para>
32 </listitem> 32 </listitem>
33 33
34 <listitem> 34 <listitem>
35 <para>nfvaccess2.2.3_af-th.zip (Automation and Test Harness)</para> 35 <para>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
36 </listitem> 36 </listitem>
37 37
38 <listitem> 38 <listitem>
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
index 007c150..ec2c584 100644
--- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
@@ -87,6 +87,13 @@
87 </listitem> 87 </listitem>
88 88
89 <listitem> 89 <listitem>
90 <para><remark>ELCCR-847</remark>The Juniper VNF cannot be instantiated
91 on the Xeon-D architectures due to missing CPU features in the VNF's
92 domain XML. This impacts all Examples Use Cases and AF&amp;TH Tests
93 where Juniper VNF is used.</para>
94 </listitem>
95
96 <listitem>
90 <para><remark>LXCR-????</remark>The Call Home functionality does not 97 <para><remark>LXCR-????</remark>The Call Home functionality does not
91 support having multiple interfaces/routes that go from the device to the 98 support having multiple interfaces/routes that go from the device to the
92 uCPE Manager.</para> 99 uCPE Manager.</para>
@@ -106,17 +113,35 @@
106 </listitem> 113 </listitem>
107 114
108 <listitem> 115 <listitem>
109 <para><remark>LXCR-9992</remark>Due to the way VFIO works, there are 116 <para><remark>LXCR-9992</remark>Depending on how PCI devices are split
110 certain limitations regarding which devices can be used with VFIO. 117 among IOMMU groups, there are certain limitations regarding how the
111 Mainly, it comes down to how IOMMU groups work. Any Virtual Function 118 <literal>vfio-pci</literal> driver can be used. For PCI devices
112 device can be used with VFIO on its own, however, physical devices will 119 belonging to the same IOMMU group, it is required that all are managed
113 require either all ports to be bound to VFIO, or only some of them bound 120 within same security domain (e.g. host system or VNF). Therefore it is
114 while others not bound to anything at all.</para> 121 not possible to bind only some of them to the
122 <literal>vfio-pci</literal> driver, while the rest are managed by other
123 drivers. In this case the <literal>igb_uio</literal> driver shall be used
124 instead for the entire IOMMU group.</para>
125
126 <para>Driver selection for DPDK-assigned interfaces is a system-wide
127 configuration, therefore selecting <literal>igb_uio</literal>
128 or <literal>vfio-pci</literal> when adding a DPDK interface will not
129 influence the actual driver used. In this release, NFV Access runtime
130 software is using <literal>vfio-pci</literal> driver by default, but
131 <literal>igb_uio</literal> can be used instead by providing custom
132 scripting. Please contact Enea for further details.</para>
133 <para>Using both <literal>igb_uio</literal> driver for DPDK interfaces
134 and <literal>vfio-pci</literal> for SR-IOV/PCI-Passthrough is possible,
135 but not recomended, as it might not be supported by some hardware
136 configurations.</para>
115 137
116 <para>If UEFI secure boot is enabled, the Linux kernel may disallow the 138 <para>When an in-band management bridge uses the
117 use of UIO on the system. Therefore, devices intended for use by the 139 <literal>igb_uio</literal> driver and the VM connected to the bridge has
118 DPDK should be bound to the <literal>vfio-pci</literal> kernel module 140 other interfaces that use the <literal>vfio-pci</literal> driver (e.g.
119 rather than the <literal>igb_uio</literal>.</para> 141 SR-IOV/PCI-Passthrough), then the VM must be stopped before restarting
142 the vCPE service on the device
143 (<command>systemctl restart vcpe</command>). Rebooting the device does
144 not have this restriction.</para>
120 </listitem> 145 </listitem>
121 146
122 <listitem> 147 <listitem>
@@ -149,4 +174,4 @@
149 174
150 <!-- <xi:include href="jiraissues_generated.xml" 175 <!-- <xi:include href="jiraissues_generated.xml"
151 xmlns:xi="http://www.w3.org/2001/XInclude" /> --> 176 xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
152</chapter> \ No newline at end of file 177</chapter>
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
index c373d39..a9a360c 100644
--- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
@@ -12,7 +12,13 @@
12 <section id="relinfo-changes-other"> 12 <section id="relinfo-changes-other">
13 <title>New Features</title> 13 <title>New Features</title>
14 14
15 <para>No new features were added in this release.</para> 15 <itemizedlist>
16 <listitem><para>Added support for running the uCPE Manager behind a NAT.</para></listitem>
17 <listitem><para>The Domain Upgrade Script supplied during VNF instantiation is now executed
18 after the virsh define command, in order to perform additional system configurations.</para></listitem>
19 <listitem><para>Corrections and improvements towards the content of previous NFV Access
20 release.</para></listitem>
21 </itemizedlist>
16 </section> 22 </section>
17 23
18 <section id="open_source"> 24 <section id="open_source">
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
index 3443883..b55b9bc 100644
--- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
+++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
@@ -304,8 +304,13 @@ Duplicate entry - Release already installed</programlisting></para>
304 </listitem> 304 </listitem>
305 305
306 <listitem> 306 <listitem>
307 <para>The playbook imports the previously described 307 <para>The playbook imports the previously described playbooks:</para>
308 playbooks:<itemizedlist spacing="compact"> 308
309 <itemizedlist spacing="compact">
310 <listitem>
311 <para><filename>playbooks/waitDeviceUp.yml</filename></para>
312 </listitem>
313
309 <listitem> 314 <listitem>
310 <para><filename>playbook/uploadImage.yml</filename></para> 315 <para><filename>playbook/uploadImage.yml</filename></para>
311 </listitem> 316 </listitem>
@@ -321,7 +326,7 @@ Duplicate entry - Release already installed</programlisting></para>
321 <listitem> 326 <listitem>
322 <para><filename>playbook/clearCompletedUpgradesInfo.yml</filename></para> 327 <para><filename>playbook/clearCompletedUpgradesInfo.yml</filename></para>
323 </listitem> 328 </listitem>
324 </itemizedlist></para> 329 </itemizedlist>
325 </listitem> 330 </listitem>
326 </itemizedlist> 331 </itemizedlist>
327 332
@@ -334,8 +339,8 @@ Duplicate entry - Release already installed</programlisting></para>
334 </listitem> 339 </listitem>
335 340
336 <listitem> 341 <listitem>
337 <para>A device JSON configuration file must be created: 342 <para>A device JSON configuration file must be created:</para>
338 <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</programlisting></para> 343 <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</programlisting>
339 </listitem> 344 </listitem>
340 </itemizedlist> 345 </itemizedlist>
341 346
@@ -344,7 +349,9 @@ Duplicate entry - Release already installed</programlisting></para>
344 <literal>&lt;Image-path&gt;</literal>, 349 <literal>&lt;Image-path&gt;</literal>,
345 <literal>&lt;Image-name&gt;</literal>, 350 <literal>&lt;Image-name&gt;</literal>,
346 <literal>&lt;Upgrade-type&gt;</literal>, and the 351 <literal>&lt;Upgrade-type&gt;</literal>, and the
347 <literal>&lt;Device-name&gt;</literal> as extra-vars:<programlisting>ansible-playbook playbooks/installNFVAImage.yml -e \ 352 <literal>&lt;Device-name&gt;</literal> as extra-vars:
353
354 <programlisting>ansible-playbook playbooks/installNFVAImage.yml -e \
348device="&lt;Device-name&gt;" -e image_path="&lt;Image-path&gt;" -e \ 355device="&lt;Device-name&gt;" -e image_path="&lt;Image-path&gt;" -e \
349image_name="&lt;Image-name&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programlisting></para> 356image_name="&lt;Image-name&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programlisting></para>
350 357
@@ -832,10 +839,17 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"<
832 </listitem> 839 </listitem>
833 </itemizedlist> 840 </itemizedlist>
834 841
835 <para><emphasis role="bold">Precondition:</emphasis></para> 842 <para><emphasis role="bold">Precondition:</emphasis><itemizedlist>
843 <listitem>
844 <para>The Offline Configuration Store should not already exist on
845 the uCPE Manager. If it exists, the test will report a
846 duplicate.</para>
847 </listitem>
836 848
837 <para>The Offline Configuration Store should not already exist on the 849 <listitem>
838 uCPE Manager. If it exists, the test will report a duplicate.</para> 850 <para>A store JSON file needs to exist: <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;device-name&gt;/store.json</programlisting></para>
851 </listitem>
852 </itemizedlist></para>
839 853
840 <para><emphasis role="bold">Action:</emphasis> Run the 854 <para><emphasis role="bold">Action:</emphasis> Run the
841 <filename>addConfigStore.yml</filename> Ansible Playbook with the 855 <filename>addConfigStore.yml</filename> Ansible Playbook with the
@@ -909,8 +923,17 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"<
909 923
910 <para><emphasis role="bold">Precondition:</emphasis></para> 924 <para><emphasis role="bold">Precondition:</emphasis></para>
911 925
912 <para>The Offline Configuration Store should exist in the uCPE Manager. 926 <itemizedlist>
913 If it does not, the test will say so.</para> 927 <listitem>
928 <para>The Offline Configuration Store should exist in the uCPE
929 Manager. If it does not, the test will say so.</para>
930 </listitem>
931
932 <listitem>
933 <para>A Bridge JSON configuration file needs to exist:
934 <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;device-name&gt;/&lt;bridge-name&gt;.json</programlisting></para>
935 </listitem>
936 </itemizedlist>
914 937
915 <para><emphasis role="bold">Action:</emphasis> Run the 938 <para><emphasis role="bold">Action:</emphasis> Run the
916 <filename>addOfflineBridge.yml</filename> Ansible Playbook with the 939 <filename>addOfflineBridge.yml</filename> Ansible Playbook with the
@@ -1115,8 +1138,8 @@ vnfi=&lt;VNFI-name&gt;"</programlisting><emphasis
1115 <para>This test case was implemented in two different ways to exemplify 1138 <para>This test case was implemented in two different ways to exemplify
1116 both methods supported by the AF and TH to deploy such services.</para> 1139 both methods supported by the AF and TH to deploy such services.</para>
1117 1140
1118 <para>Prerequisites needed in order to deploy the FortiGate VNF as a 1141 <para><emphasis role="bold">How to deploy the FortiGate VNF as a
1119 Firewall:</para> 1142 Firewall:</emphasis></para>
1120 1143
1121 <orderedlist> 1144 <orderedlist>
1122 <listitem> 1145 <listitem>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-14 00:39:52 +0000