summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-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/getting_started.xml4
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml51
-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/forti_vnf_examples.xml39
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml75
-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.xml27
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml192
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml23
-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.xml7
-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
14 files changed, 386 insertions, 305 deletions
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index 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/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
index 18e7048..68e6f12 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
@@ -159,8 +159,8 @@
159 <orderedlist> 159 <orderedlist>
160 <listitem> 160 <listitem>
161 <para>Unzip the 161 <para>Unzip the
162 <filename>nfvaccess&lt;version&gt;_af-th.zip</filename> archive file, 162 <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> 163 archive file, provided by Enea, on a supported host machine.</para>
164 164
165 <para>The directory in which the archive has been unpacked will be 165 <para>The directory in which the archive has been unpacked will be
166 denoted as <literal>&lt;AF-TH-installdir&gt;</literal>.</para> 166 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..d58f101 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,38 @@
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. Please check <olink
43 targetdoc="book_enea_nfv_access_example_usecases"
44 targetptr="appendix_one_cust">Appendix A: How to create a 128T
45 cloud-init iso image (day-0 configuration) in the <xi:include
46 href="../../s_docbuild/olinkdb/pardoc-names.xml"
47 xmlns:xi="http://www.w3.org/2001/XInclude"
48 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
49 Manual for more details.</para>
50 </listitem>
51 </itemizedlist>
52
53 <note>
54 <para>For data path validation, it may be required to generate a new
55 cloud-init image to match your network configuration. Please check
56 <olink targetdoc="book_enea_nfv_access_example_usecases"
57 targetptr="appendix_one_cust">Appendix A: How to create 128T cloud-init
58 iso image (day-0 configuration) in the <xi:include
59 href="../../s_docbuild/olinkdb/pardoc-names.xml"
60 xmlns:xi="http://www.w3.org/2001/XInclude"
61 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
62 Manual for more details.</para>
63 </note>
32 </section> 64 </section>
33 65
34 <section id="vnf_router_cust"> 66 <section id="vnf_router_cust">
@@ -50,11 +82,6 @@
50 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 82 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
51 devices:</emphasis><orderedlist> 83 devices:</emphasis><orderedlist>
52 <listitem> 84 <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: 85 <para>Add the trgt uCPE device into the uCPE Manager:
59 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para> 86 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para>
60 87
@@ -375,8 +402,8 @@
375 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para> 402 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
376 403
377 <para>Onboard the VM Image through <literal>VNF -&gt; Descriptors -&gt; 404 <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 405 On-board</literal>, and fill in the required fields with the following
379 the following values:</para> 406 values:</para>
380 407
381 <table> 408 <table>
382 <title>VM Image Details</title> 409 <title>VM Image Details</title>
@@ -637,6 +664,11 @@
637 </tbody> 664 </tbody>
638 </tgroup> 665 </tgroup>
639 </table> 666 </table>
667
668 <note>
669 <para>To procure the VNF image files and their licenses, please
670 contact each respective VNF provider.</para>
671 </note>
640 </section> 672 </section>
641 673
642 <section id="uc_test_cust_router"> 674 <section id="uc_test_cust_router">
@@ -661,10 +693,7 @@
661 <para>In order to validate the data path, connect a test machine to the 693 <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 694 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 695&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 696&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> 697 </section>
669 698
670 <section id="cleanup_custone"> 699 <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/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/service_chaining_128t_fortigate.xml b/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml
index 4719399..43c3fce 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,36 @@
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. Please check <olink
61 targetdoc="book_enea_nfv_access_example_usecases"
62 targetptr="appendix_one_cust">Appendix A: How to create a 128T
63 cloud-init iso image (day-0 configuration) in the <xi:include
64 href="../../s_docbuild/olinkdb/pardoc-names.xml"
65 xmlns:xi="http://www.w3.org/2001/XInclude"
66 xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
67 Manual for more details.</para>
68 </listitem>
69 </itemizedlist>
70
71 <note>
72 <para>To procure the VNF image files and their licenses, please contact
73 each respective VNF provider.</para>
74 </note>
48 </section> 75 </section>
49 76
50 <section id="ser_chain_uc"> 77 <section id="ser_chain_uc">
@@ -66,11 +93,6 @@
66 <para><emphasis role="bold">Configuring Network Interfaces on uCPE 93 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
67 devices:</emphasis><orderedlist> 94 devices:</emphasis><orderedlist>
68 <listitem> 95 <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: 96 <para>Add the trgt uCPE device into the uCPE Manager:
75 <literal>Devices -&gt; Manage -&gt; Add</literal>, and fill in the 97 <literal>Devices -&gt; Manage -&gt; Add</literal>, and fill in the
76 required fields with the following data:</para> 98 required fields with the following data:</para>
@@ -225,10 +247,8 @@
225 247
226 <para>Add the OVS bridges by selecting the trgt device then: 248 <para>Add the OVS bridges by selecting the trgt device then:
227 <literal>Configuration -&gt; OpenVSwitch -&gt; Bridges -&gt; 249 <literal>Configuration -&gt; OpenVSwitch -&gt; Bridges -&gt;
228 Add</literal>.</para> 250 Add</literal>. Fill in the required fields for each bridge with
229 251 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 252
233 <table> 253 <table>
234 <title>ibm_br Bridge Details</title> 254 <title>ibm_br Bridge Details</title>
@@ -276,6 +296,8 @@
276 </tgroup> 296 </tgroup>
277 </table> 297 </table>
278 298
299 <para></para>
300
279 <table> 301 <table>
280 <title>vnf_mgmt_br Bridge Details</title> 302 <title>vnf_mgmt_br Bridge Details</title>
281 303
@@ -443,8 +465,8 @@
443 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para> 465 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
444 466
445 <para>Onboard the 128T VNF VM Image through <literal>VNF -&gt; 467 <para>Onboard the 128T VNF VM Image through <literal>VNF -&gt;
446 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the 468 Descriptors -&gt; On-board</literal>, and fill in the required fields
447 required fields with the following values:</para> 469 with the following values:</para>
448 470
449 <table> 471 <table>
450 <title>128T VM Image Details</title> 472 <title>128T VM Image Details</title>
@@ -600,8 +622,8 @@
600 </note> 622 </note>
601 623
602 <para>Onboard the Fortigate VNF VM Image through <literal>VNF -&gt; 624 <para>Onboard the Fortigate VNF VM Image through <literal>VNF -&gt;
603 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the 625 Descriptors -&gt; On-board</literal>, and fill in the required fields
604 required fields with the following values:</para> 626 with the following values:</para>
605 627
606 <table> 628 <table>
607 <title>Fortigate VM Image Details</title> 629 <title>Fortigate VM Image Details</title>
@@ -626,7 +648,7 @@
626 <entry>VM image file</entry> 648 <entry>VM image file</entry>
627 649
628 <entry><literal>fortios.qcow2</literal>. Please make sure to 650 <entry><literal>fortios.qcow2</literal>. Please make sure to
629 contact Fortigate for an official Fortigate KVM image.</entry> 651 contact Fortinet for an official FortiGate KVM image.</entry>
630 </row> 652 </row>
631 653
632 <row> 654 <row>
@@ -822,10 +844,7 @@
822 <row> 844 <row>
823 <entry>Cloud Init File</entry> 845 <entry>Cloud Init File</entry>
824 846
825 <entry><literal>centos_128t_internet_ci.iso</literal>. Example 847 <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> 848 </row>
830 849
831 <row> 850 <row>
@@ -873,6 +892,11 @@
873 </tgroup> 892 </tgroup>
874 </table> 893 </table>
875 894
895 <note>
896 <para>To procure the VNF image files and their licenses, please
897 contact each respective VNF provider.</para>
898 </note>
899
876 <para>Instantiate the Fortigate VNF by selecting the trgt device, then 900 <para>Instantiate the Fortigate VNF by selecting the trgt device, then
877 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para> 901 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>
878 902
@@ -936,8 +960,7 @@
936 <row> 960 <row>
937 <entry>License File</entry> 961 <entry>License File</entry>
938 962
939 <entry><literal>FGVM08TM00001.lic</literal>. Please make sure to 963 <entry>The FortiGate license file provided by Fortinet.</entry>
940 use a valid license file (.lic) received from Fortinet.</entry>
941 </row> 964 </row>
942 965
943 <row> 966 <row>
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 47c4ea4..649a80d 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
@@ -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,9 +311,10 @@ 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
307 using <literal>gzip</literal> and copy the resulting 315 device architecture using <literal>gzip</literal> and copy the
308 <literal>hddimg.gz</literal> file to the HTTP server.</para> 316 resulting <literal>hddimg.gz</literal> file to the HTTP
317 server.</para>
309 </listitem> 318 </listitem>
310 </orderedlist> 319 </orderedlist>
311 320
@@ -348,14 +357,12 @@ node0.1048576kB = 3 </programlisting>
348 357
349 <para>Installation Configuration File Example:</para> 358 <para>Installation Configuration File Example:</para>
350 359
351 <programlisting> 360 <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 361install_drive = /dev/sda</programlisting>
353 install_drive = /dev/sda
354 362
355</programlisting> 363 <note>
356 <note> 364 <para>The installation configuration file needs to use the Linux
357 <para>The installation configuration file needs to use the Linux end-of-line 365 end-of-line format (\n), not the Windows format (\r\n).</para>
358 format (\n), not the Windows format (\r\n).</para>
359 </note> 366 </note>
360 </section> 367 </section>
361 368
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..d46b4c7 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,24 @@
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 <xref linkend="bare_meta_prov">
27 5.3, Bare Metal Provisioning"
28 </xref>.</para>
21 29
22 <section id="prereq"> 30 <section id="prereq">
23 <title>Prerequisites</title> 31 <title>Prerequisites</title>
@@ -202,149 +210,167 @@ rootfs_destination=</programlisting></para>
202 <section id="auto_installer"> 210 <section id="auto_installer">
203 <title>Creating a bootable USB stick</title> 211 <title>Creating a bootable USB stick</title>
204 212
205 <para>In order to install the Enea NFV Access Run Time Platform, you must 213 <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 214 must first create a bootable USB stick with the image you intend to
207 install. Follow the example below to proceed.</para> 215 install. Follow the example below to proceed.</para>
208 216
217 <note>
218 <para>The <literal>.hddimg</literal> image is available in the
219 Enea_NFV_Access_Run_Time_Platform_
220 &lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz file you
221 downloaded with your release.</para>
222 </note>
223
209 <para><emphasis role="bold">Create a bootable USB stick 224 <para><emphasis role="bold">Create a bootable USB stick
210 image</emphasis></para> 225 image</emphasis></para>
211 226
212 <orderedlist> 227 <orderedlist>
213 <listitem> 228 <listitem>
214 <para>Copy the HDDIMG image file provided by Enea, onto a 229 <para>Copy the <literal>.hddimg</literal> image file provided by
215 development machine.</para> 230 Enea, onto a development machine.</para>
216 </listitem> 231 </listitem>
217 232
218 <listitem> 233 <listitem>
219 <para>Connect the USB stick to the development machine and identify 234 <para>Connect the USB stick to the development machine and identify
220 the device name given by the system with 235 the device name given by the system with <command>lsblk</command>:
221 <command>lsblk</command>: 236 <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 237sda 8:0 1 28.7G 0 disk
224sdb 8:0 0 111.8G 0 disk 238sdb 8:0 0 111.8G 0 disk
225|-sdb1 8:1 0 111.8G 0 part</programlisting></para> 239|-sdb1 8:1 0 111.8G 0 part</programlisting></para>
226 </listitem> 240 </listitem>
227 241
228 <listitem> 242 <listitem>
229 <para>Copy the HDDIMG image onto the USB stick, e.g: 243 <para>Copy the <literal>.hddimg</literal> image onto the USB stick,
230 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \ 244 e.g: <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
231of=/dev/sdb bs=4M conv=fsync</programlisting></para> 245of=/dev/sdb bs=4M conv=fsync</programlisting></para>
232 </listitem> 246 </listitem>
233 </orderedlist> 247 </orderedlist>
234 248
235 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg 249 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg
236 </filename>is the <literal>.hddimg</literal> file and <literal>sdb</literal> is the 250 </filename>is the <literal>.hddimg</literal> file and
237 assigned USB device name.</para> 251 <literal>sdb</literal> is the assigned USB device name.</para>
238 </section> 252 </section>
239 253
240 <section id="install_ena_stick"> 254 <section id="install_ena_stick">
241 <title>Installing Enea NFV Access</title> 255 <title>Installing Enea NFV Access</title>
242 256
243 <para><emphasis role="bold">How to install the Enea NFV Access Run Time 257 <para><emphasis role="bold">How to install the Enea NFV Access Run Time
244 Platform using a bootable USB stick image</emphasis></para> 258 Platform using a bootable USB stick image</emphasis></para>
245 259
246 <orderedlist> 260 <orderedlist>
247 <listitem> 261 <listitem>
248 <para>Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will 262 <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> 263 directly into one of the ports that will not later be chosen as a
264 WAN port. No other ports should be connected.</para>
250 </listitem> 265 </listitem>
251 266
252 <listitem> 267 <listitem>
253 <para>Power up the uCPE device and boot the USB stick. Verify that the 268 <para>Power up the uCPE device and boot the USB stick. Verify that
254 USB stick is selected from the BIOS boot menu.</para> 269 the USB stick is selected from the BIOS boot menu.</para>
255 </listitem> 270 </listitem>
256 271
257 <listitem> 272 <listitem>
258 <para>Once the USB stick is properly booted, the Web-installer application starts 273 <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). 274 application starts automatically and can be accessed in a web
260 </para> 275 browser at <literal>http://172.16.1.1</literal> (port 80).</para>
261 276
262 <para>On the first page of the Web-installer, the user should fill in:</para> 277 <para>On the first page of the Web-installer, the user should fill
278 in:</para>
263 279
264 <itemizedlist> 280 <itemizedlist>
265 <listitem> 281 <listitem>
266 <para><emphasis role="bold">The uCPE Manager IP Address</emphasis>.</para> 282 <para><emphasis role="bold">The uCPE Manager IP
283 Address</emphasis>.</para>
267 </listitem> 284 </listitem>
268 285
269 <listitem> 286 <listitem>
270 <para><emphasis role="bold">The Device ID</emphasis>. The unique identifier of the 287 <para><emphasis role="bold">The Device ID</emphasis>. The unique
271 uCPE device.</para> 288 identifier of the uCPE device.</para>
272
273 </listitem> 289 </listitem>
274 290
275 <listitem> 291 <listitem>
276 <para><emphasis role="bold">Customer Tags</emphasis>. They are used for 292 <para><emphasis role="bold">Customer Tags</emphasis>. They are
277 <link linkend="zero_touch_prov">Zero Touch Provisining (ZTP)</link> and can be left 293 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 294 (ZTP)</link> and can be left empty. What can be entered here (as
279 creating an offline configuration in the uCPE Manager.</para> 295 needed), are the tag(s) specified when creating an offline
296 configuration in the uCPE Manager.</para>
280 </listitem> 297 </listitem>
281 </itemizedlist> 298 </itemizedlist>
282 299
283 <para>On the second page of the Web-installer, the user should fill in:</para> 300 <para>On the second page of the Web-installer, the user should fill
301 in:</para>
284 302
285 <itemizedlist> 303 <itemizedlist>
286 <listitem> 304 <listitem>
287 <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. 305 <para><emphasis role="bold">The Layer 3 configuration of WAN
288 Static or Dynamic IP must be specified.</para> 306 Interface(s)</emphasis>. Static or Dynamic IP must be
289 307 specified.</para>
290 <para>During network configuration, WAN cables will be plugged into the device 308
291 in order to identify ports and make them available for configuration. Each 309 <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 310 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 311 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 312 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 313 be configured (DHCP is the default setting). The user needs to
296 after being configured.</para> 314 connect the same quantity of cables as the number of WAN ports
297 315 that he wishes to configure. No LAN ports should be connected
298 <note> 316 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 317 removed after being configured.</para>
300 and cannot be configured.</para></note> 318
319 <note>
320 <para>The LAN port used to access the Web-installer from the
321 laptop will not be shown and cannot be configured.</para>
322 </note>
301 </listitem> 323 </listitem>
302 324
303 <listitem> 325 <listitem>
304 <para><emphasis role="bold">The Management Interface</emphasis>. The interface that 326 <para><emphasis role="bold">The Management Interface</emphasis>.
305 will be used by the uCPE Manager to communicate with the device.</para> 327 The interface that will be used by the uCPE Manager to
306 328 communicate with the device.</para>
307 </listitem> 329 </listitem>
308 </itemizedlist> 330 </itemizedlist>
309 </listitem> 331 </listitem>
310 332
311 <listitem> 333 <listitem>
312 <para>When the user has completed the configuration steps in the Web-installer, NFV Access 334 <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 335 Web-installer, NFV Access is installed on the hard drive. The
314 installation.</para> 336 largest drive found on the device will be used for
337 installation.</para>
315 </listitem> 338 </listitem>
316
317 </orderedlist> 339 </orderedlist>
318 </section> 340 </section>
319 341
320 <section id="boot_ena"> 342 <section id="boot_ena">
321 <title>Booting NFV Access</title> 343 <title>Booting NFV Access</title>
322 344
323 <para>When the installation has finished successfully, the user should remove the USB stick 345 <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 346 remove the USB stick before confirming the reboot of the device in
325 to boot from the hard drive.</para> 347 Web-installer and ensure that BIOS is configured to boot from the hard
348 drive.</para>
349
350 <para>When configured with the Web-installer GUI, the uCPE device
351 start-up sequence will configure the interfaces accordingly and try to
352 register the device in the uCPE manager. If connectivity is established
353 with the uCPE manager server and a device with a matching Device ID is
354 found, the configuration is successful, and the connection is
355 established.</para>
326 356
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> 357 <note>
333 <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at 358 <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 359 Web-installer will launch at start-up expecting the user to provide
335 be launched on port 80 for post-installation configuration: <literal> 360 the post-installation configuration. The Web-installer will be
361 launched on port 80 for post-installation configuration: <literal>
336 http://172.16.1.1</literal>.</para> 362 http://172.16.1.1</literal>.</para>
337 </note> 363 </note>
338 364
339 <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot 365 <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>. 366 re-attach the laptop, reboot the device and then access the
341 </para> 367 Web-installer on <literal>http://172.16.1.1</literal>.</para>
342 368
343 <note> 369 <note>
344 <para>After having established a successful connection with the uCPE Manager, the user will 370 <para>After having established a successful connection with the uCPE
345 connect any LAN cable(s) that should be connected to the device. 371 Manager, the user will connect any LAN cable(s) that should be
346 </para> 372 connected to the device.</para>
347 </note> 373 </note>
348 </section> 374 </section>
349 375
350 <section condition="hidden" id="examples"> 376 <section condition="hidden" id="examples">
@@ -684,4 +710,4 @@ ssh root@&lt;target_ip&gt; "cd /mnt/sda6; tar -zxf -"</programlisting>
684 </note> 710 </note>
685 </section> 711 </section>
686 </section> 712 </section>
687</chapter> 713</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 818bd52..dda71bb 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
@@ -228,11 +228,11 @@ userdel postgres</programlisting>
228 </listitem> 228 </listitem>
229 229
230 <listitem> 230 <listitem>
231 <para><literal>configureHA.sh</literal></para> 231 <para><filename>configureHA.sh</filename></para>
232 </listitem> 232 </listitem>
233 233
234 <listitem> 234 <listitem>
235 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 235 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
236 </listitem> 236 </listitem>
237 237
238 <listitem> 238 <listitem>
@@ -244,7 +244,8 @@ userdel postgres</programlisting>
244 <listitem> 244 <listitem>
245 <para>Run the following command:</para> 245 <para>Run the following command:</para>
246 246
247 <programlisting>./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 247 <programlisting>./install.sh /opt/ems \
248 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
248 </listitem> 249 </listitem>
249 </orderedlist> 250 </orderedlist>
250 251
@@ -321,7 +322,7 @@ userdel postgres</programlisting>
321 additional argument as shown below:</para> 322 additional argument as shown below:</para>
322 323
323 <programlisting>./install.sh \ 324 <programlisting>./install.sh \
324 /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz \ 325 /opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
325 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> 326 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
326 327
327 <para>The other steps are exactly the same as specified in the 328 <para>The other steps are exactly the same as specified in the
@@ -350,7 +351,7 @@ userdel postgres</programlisting>
350 </listitem> 351 </listitem>
351 352
352 <listitem> 353 <listitem>
353 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 354 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
354 </listitem> 355 </listitem>
355 </itemizedlist> 356 </itemizedlist>
356 </listitem> 357 </listitem>
@@ -358,7 +359,8 @@ userdel postgres</programlisting>
358 <listitem> 359 <listitem>
359 <para>Run the following command:</para> 360 <para>Run the following command:</para>
360 361
361 <programlisting>./upgrade.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 362 <programlisting>./upgrade.sh /opt/ems \
363 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
362 </listitem> 364 </listitem>
363 </orderedlist> 365 </orderedlist>
364 366
@@ -1298,6 +1300,13 @@ userdel postgres</programlisting>
1298 Uploaded Successfully</literal> appears on the File Upload 1300 Uploaded Successfully</literal> appears on the File Upload
1299 Screen.</para> 1301 Screen.</para>
1300 1302
1303 <note>
1304 <para>The image file of type <literal>rootfs.ostree.tar.bz2</literal>
1305 is available in the
1306 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
1307 file you downloaded with your release.</para>
1308 </note>
1309
1301 <section id="upload_image"> 1310 <section id="upload_image">
1302 <title>Image Library</title> 1311 <title>Image Library</title>
1303 1312
@@ -1320,7 +1329,7 @@ userdel postgres</programlisting>
1320 to the image file (must be of type 1329 to the image file (must be of type
1321 <literal>rootfs.ostree.tar.bz2</literal>). Select the target 1330 <literal>rootfs.ostree.tar.bz2</literal>). Select the target
1322 hardware platform corresponding to the image being uploaded 1331 hardware platform corresponding to the image being uploaded
1323 (xeon-d or atomc-3000).</para> 1332 (xeon-d or atom-c3000).</para>
1324 </listitem> 1333 </listitem>
1325 1334
1326 <listitem> 1335 <listitem>
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..c1d7de5 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 XeonD architecture because the domain XML file cannot be modified
92 prior to creating a Virtual Machine. This impacts all Examples Use Cases
93 and AF&amp;TH Tests 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>
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 21:52:13 +0000