diff options
55 files changed, 1002 insertions, 1000 deletions
diff --git a/doc/Makefile b/doc/Makefile index a0956d4..1a415b3 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -26,8 +26,8 @@ include init.mk | |||
26 | #BUILDBOOT_XML := book-enea-nfv-access-release-info/doc/build_boot_generated.xml | 26 | #BUILDBOOT_XML := book-enea-nfv-access-release-info/doc/build_boot_generated.xml |
27 | #BUILDBOOT_TEMPLATE := book-enea-nfv-access-release-info/doc/build_boot_template.xml | 27 | #BUILDBOOT_TEMPLATE := book-enea-nfv-access-release-info/doc/build_boot_template.xml |
28 | 28 | ||
29 | PKGDIFF_GEN_XML := book-enea-nfv-access-release-info/doc/pkgdiff_generated.xml | 29 | #PKGDIFF_GEN_XML := book-enea-nfv-access-release-info/doc/pkgdiff_generated.xml |
30 | JIRA_ISSUES_GEN_XML := book-enea-nfv-access-release-info/doc/jiraissues_generated.xml | 30 | #JIRA_ISSUES_GEN_XML := book-enea-nfv-access-release-info/doc/jiraissues_generated.xml |
31 | 31 | ||
32 | MACHINE_LIST_XML := book-enea-nfv-access-release-info/doc/machine_list_generated.xml | 32 | MACHINE_LIST_XML := book-enea-nfv-access-release-info/doc/machine_list_generated.xml |
33 | 33 | ||
@@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes | |||
50 | DOCBOOK_CLEANTMP ?= yes | 50 | DOCBOOK_CLEANTMP ?= yes |
51 | 51 | ||
52 | #Components (books) in this subsystem. Now use all books found here | 52 | #Components (books) in this subsystem. Now use all books found here |
53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-getting-started book-enea-nfv-access-ucpem-open-source book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit | 53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-ucpem-open-source book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit book-enea-nfv-access-auto-fw-open-source book-enea-nfv-access-auto-fw-user-guide |
54 | 54 | ||
55 | 55 | ||
56 | # -------------------------------------------------------------- | 56 | # -------------------------------------------------------------- |
@@ -184,7 +184,7 @@ endif | |||
184 | books: init | 184 | books: init |
185 | # BOOKPACKAGES is defined in all book-*/swcomp.mk | 185 | # BOOKPACKAGES is defined in all book-*/swcomp.mk |
186 | $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | 186 | $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ |
187 | BOOKVER="Enea NFV Access-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ | 187 | BOOKVER="Enea Edge-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ |
188 | for book in $(BOOKPACKAGES); do \ | 188 | for book in $(BOOKPACKAGES); do \ |
189 | for format in $(FORMAT); do \ | 189 | for format in $(FORMAT); do \ |
190 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ | 190 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/about.xml b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/about.xml index dbf06e3..4dc19aa 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/about.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/about.xml | |||
@@ -6,7 +6,7 @@ | |||
6 | 6 | ||
7 | <para>This document contains the open source and license information | 7 | <para>This document contains the open source and license information |
8 | pertaining to the Automation Framework and Test Harness provided with | 8 | pertaining to the Automation Framework and Test Harness provided with |
9 | Enea NFV Access <xi:include | 9 | Enea Edge <xi:include |
10 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 10 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
11 | xmlns:xi="http://www.w3.org/2001/XInclude" | 11 | xmlns:xi="http://www.w3.org/2001/XInclude" |
12 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> | 12 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/book.xml b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/book.xml index 3305873..f849ad4 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/book.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_auto_fw_th_open_source"> | 6 | <book id="book_enea_nfv_access_auto_fw_th_open_source"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness Open Source Report</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Automation Framework and Test Harness Open Source Report</title> |
8 | 8 | ||
9 | <subtitle>Release Version | 9 | <subtitle>Release Version |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/licenses.xml b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/licenses.xml index 31e8edb..76a34e2 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/licenses.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-open-source/doc/licenses.xml | |||
@@ -40,7 +40,7 @@ | |||
40 | xmlns:xi="http://www.w3.org/2001/XInclude" | 40 | xmlns:xi="http://www.w3.org/2001/XInclude" |
41 | xpointer="element(EneaLinux_REL_VER/1)" /></entry> | 41 | xpointer="element(EneaLinux_REL_VER/1)" /></entry> |
42 | 42 | ||
43 | <entry>Configuration and Automation Framework for the uCPE Manager | 43 | <entry>Configuration and Automation Framework for the Edge Manager |
44 | GUI.</entry> | 44 | GUI.</entry> |
45 | 45 | ||
46 | <entry>ENEA-SRC-R2</entry> | 46 | <entry>ENEA-SRC-R2</entry> |
@@ -54,7 +54,7 @@ | |||
54 | xmlns:xi="http://www.w3.org/2001/XInclude" | 54 | xmlns:xi="http://www.w3.org/2001/XInclude" |
55 | xpointer="element(EneaLinux_REL_VER/1)" /></entry> | 55 | xpointer="element(EneaLinux_REL_VER/1)" /></entry> |
56 | 56 | ||
57 | <entry>Configuration and Automation Framework for the uCPE Manager | 57 | <entry>Configuration and Automation Framework for the Edge Manager |
58 | GUI.</entry> | 58 | GUI.</entry> |
59 | 59 | ||
60 | <entry>ENEA-EXAMPLE-R2</entry> | 60 | <entry>ENEA-EXAMPLE-R2</entry> |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-open-source/swcomp.mk b/doc/book-enea-nfv-access-auto-fw-th-open-source/swcomp.mk index 2f2e677..702e86f 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-open-source/swcomp.mk +++ b/doc/book-enea-nfv-access-auto-fw-th-open-source/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-open-source | 8 | BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-open-source |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) AF&TH Open Source Report" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) AF&TH Open Source Report" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/book-enea-nfv-access-auto-fw-th-user-guide.pdf b/doc/book-enea-nfv-access-auto-fw-th-user-guide/book-enea-nfv-access-auto-fw-th-user-guide.pdf new file mode 100644 index 0000000..5d601c1 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/book-enea-nfv-access-auto-fw-th-user-guide.pdf | |||
Binary files differ | |||
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 5e6ba24..a569d59 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -11,15 +11,15 @@ | |||
11 | 11 | ||
12 | <para>The <literal>/device</literal> folder contains Python scripts for | 12 | <para>The <literal>/device</literal> folder contains Python scripts for |
13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE | 13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE |
14 | device, waiting for a uCPE device to connect to the uCPE Manager, as well | 14 | device, waiting for a uCPE device to connect to the Enea Edge Management, as well |
15 | as scripts for adding and removing an offline configuration store. This | 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 | 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 | 17 | the Enea Edge Management, and for installing and activating a NFVA image on a uCPE |
18 | Device.</para> | 18 | Device.</para> |
19 | 19 | ||
20 | <para>The <literal>/customScripts</literal> folder contains Python scripts | 20 | <para>The <literal>/customScripts</literal> folder contains Python scripts |
21 | for uploading custom scripts onto the uCPE Manager and uCPE device(s), for | 21 | for uploading custom scripts onto the Enea Edge Management and uCPE device(s), for |
22 | removing custom scripts from the uCPE Manager and uCPE device(s).</para> | 22 | removing custom scripts from the Enea Edge Management and uCPE device(s).</para> |
23 | 23 | ||
24 | <para>The <literal>/network</literal> folder contains Python scripts for | 24 | <para>The <literal>/network</literal> folder contains Python scripts for |
25 | 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 |
@@ -79,7 +79,7 @@ | |||
79 | the path to the file describing the test cases to be performed against | 79 | the path to the file describing the test cases to be performed against |
80 | the designated script.</para> | 80 | the designated script.</para> |
81 | 81 | ||
82 | <para>Steps for running the Python unit-test suite on the uCPE Manager | 82 | <para>Steps for running the Python unit-test suite on the Enea Edge Management |
83 | are provided below.</para> | 83 | are provided below.</para> |
84 | 84 | ||
85 | <section id="script_opts"> | 85 | <section id="script_opts"> |
@@ -88,16 +88,16 @@ | |||
88 | <programlisting>$ python unittestSuite.py -h | 88 | <programlisting>$ python unittestSuite.py -h |
89 | Usage: unittestSuite.py [options] | 89 | Usage: unittestSuite.py [options] |
90 | 90 | ||
91 | Run selected unit-test suite against Enea uCPE Manager. | 91 | Run selected unit-test suite against Enea Edge Management. |
92 | 92 | ||
93 | Options: | 93 | Options: |
94 | --version show program's version number and exit | 94 | --version show program's version number and exit |
95 | -h, --help show this help message and exit | 95 | -h, --help show this help message and exit |
96 | -u USERNAME, --username=USERNAME | 96 | -u USERNAME, --username=USERNAME |
97 | Enea uCPE Manager login username | 97 | Enea Edge Management login username |
98 | -p PASSWORD, --password=PASSWORD | 98 | -p PASSWORD, --password=PASSWORD |
99 | Enea uCPE Manager login password | 99 | Enea Edge Management login password |
100 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 100 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
101 | -n DEVICENAME, --deviceName=DEVICENAME | 101 | -n DEVICENAME, --deviceName=DEVICENAME |
102 | Name of vCPE device (Virtual Infrastructure Manager) | 102 | Name of vCPE device (Virtual Infrastructure Manager) |
103 | -s SUITEFILE, --suite=SUITEFILE | 103 | -s SUITEFILE, --suite=SUITEFILE |
@@ -234,8 +234,8 @@ consoleLoggingLevel = logging.INFO | |||
234 | <row> | 234 | <row> |
235 | <entry><literal>username</literal></entry> | 235 | <entry><literal>username</literal></entry> |
236 | 236 | ||
237 | <entry>The user authentication used to log into the uCPE | 237 | <entry>The user authentication used to log into the |
238 | Manager. This can be overwritten by setting the Python | 238 | Enea Edge Management. This can be overwritten by setting the Python |
239 | unit-test suite command line option | 239 | unit-test suite command line option |
240 | <literal>-u</literal>.</entry> | 240 | <literal>-u</literal>.</entry> |
241 | </row> | 241 | </row> |
@@ -243,7 +243,7 @@ consoleLoggingLevel = logging.INFO | |||
243 | <row> | 243 | <row> |
244 | <entry><literal>password</literal></entry> | 244 | <entry><literal>password</literal></entry> |
245 | 245 | ||
246 | <entry>The password used to log into the uCPE Manager. This | 246 | <entry>The password used to log into the Enea Edge Management. This |
247 | can be overwritten by setting the Python unit-test suite | 247 | can be overwritten by setting the Python unit-test suite |
248 | command line option <literal>-p</literal>.</entry> | 248 | command line option <literal>-p</literal>.</entry> |
249 | </row> | 249 | </row> |
@@ -251,7 +251,7 @@ consoleLoggingLevel = logging.INFO | |||
251 | <row> | 251 | <row> |
252 | <entry><literal>host</literal></entry> | 252 | <entry><literal>host</literal></entry> |
253 | 253 | ||
254 | <entry>The IP address of the uCPE Manager host. This can be | 254 | <entry>The IP address of the Enea Edge Management host. This can be |
255 | overwritten by setting the Python unit-test suite command line | 255 | overwritten by setting the Python unit-test suite command line |
256 | option <literal>-H</literal>.</entry> | 256 | option <literal>-H</literal>.</entry> |
257 | </row> | 257 | </row> |
@@ -540,7 +540,7 @@ OK</programlisting> | |||
540 | <title>Adding a uCPE Device</title> | 540 | <title>Adding a uCPE Device</title> |
541 | 541 | ||
542 | <para>Steps for adding, configuring and running a uCPE device onto the | 542 | <para>Steps for adding, configuring and running a uCPE device onto the |
543 | uCPE manager are described below .</para> | 543 | Enea Edge Management are described below .</para> |
544 | 544 | ||
545 | <section id="opts_add_device"> | 545 | <section id="opts_add_device"> |
546 | <title>Script Options</title> | 546 | <title>Script Options</title> |
@@ -548,16 +548,16 @@ OK</programlisting> | |||
548 | <programlisting>$ python addDevice.py -h | 548 | <programlisting>$ python addDevice.py -h |
549 | Usage: addDevice.py [options] | 549 | Usage: addDevice.py [options] |
550 | 550 | ||
551 | Add a uCPE device in Enea uCPE Manager. | 551 | Add a uCPE device in Enea Edge Management. |
552 | 552 | ||
553 | Options: | 553 | Options: |
554 | --version show program's version number and exit | 554 | --version show program's version number and exit |
555 | -h, --help show this help message and exit | 555 | -h, --help show this help message and exit |
556 | -u USERNAME, --username=USERNAME | 556 | -u USERNAME, --username=USERNAME |
557 | Enea uCPE Manager login username | 557 | Enea Edge Management login username |
558 | -p PASSWORD, --password=PASSWORD | 558 | -p PASSWORD, --password=PASSWORD |
559 | Enea uCPE Manager login password | 559 | Enea Edge Management login password |
560 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 560 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
561 | -f DEVICEFILE, --file=DEVICEFILE | 561 | -f DEVICEFILE, --file=DEVICEFILE |
562 | File containing uCPE Information in JSON format | 562 | File containing uCPE Information in JSON format |
563 | 563 | ||
@@ -615,7 +615,7 @@ Options: | |||
615 | 2019-03-07 17:33:10,756 - INFO: Add uCPE device | 615 | 2019-03-07 17:33:10,756 - INFO: Add uCPE device |
616 | 2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' | 616 | 2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' |
617 | 2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d | 617 | 2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d |
618 | 2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host | 618 | 2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to Enea Edge Management host |
619 | 2019-03-07 17:33:11,483 - INFO: Done | 619 | 2019-03-07 17:33:11,483 - INFO: Done |
620 | 2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting> | 620 | 2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting> |
621 | </section> | 621 | </section> |
@@ -624,7 +624,7 @@ Options: | |||
624 | <section id="remove_ucpe_device"> | 624 | <section id="remove_ucpe_device"> |
625 | <title>Removing a uCPE Device</title> | 625 | <title>Removing a uCPE Device</title> |
626 | 626 | ||
627 | <para>Steps for removing a uCPE device from the uCPE manager are | 627 | <para>Steps for removing a uCPE device from the Enea Edge Management are |
628 | described below.</para> | 628 | described below.</para> |
629 | 629 | ||
630 | <section id="rem_script_opts"> | 630 | <section id="rem_script_opts"> |
@@ -633,16 +633,16 @@ Options: | |||
633 | <programlisting>$ python removeDevice.py -h | 633 | <programlisting>$ python removeDevice.py -h |
634 | Usage: removeDevice.py [options] | 634 | Usage: removeDevice.py [options] |
635 | 635 | ||
636 | Remove a uCPE from Enea uCPE Manager. | 636 | Remove a uCPE from Enea Edge Management. |
637 | 637 | ||
638 | Options: | 638 | Options: |
639 | --version show program's version number and exit | 639 | --version show program's version number and exit |
640 | -h, --help show this help message and exit | 640 | -h, --help show this help message and exit |
641 | -u USERNAME, --username=USERNAME | 641 | -u USERNAME, --username=USERNAME |
642 | Enea uCPE Manager login username | 642 | Enea Edge Management login username |
643 | -p PASSWORD, --password=PASSWORD | 643 | -p PASSWORD, --password=PASSWORD |
644 | Enea uCPE Manager login password | 644 | Enea Edge Management login password |
645 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 645 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
646 | -f DEVICEFILE, --file=DEVICEFILE | 646 | -f DEVICEFILE, --file=DEVICEFILE |
647 | File containing uCPE Information in JSON format | 647 | File containing uCPE Information in JSON format |
648 | 648 | ||
@@ -689,7 +689,7 @@ Options: | |||
689 | 2019-03-07 17:33:56,835 - INFO: Remove uCPE device | 689 | 2019-03-07 17:33:56,835 - INFO: Remove uCPE device |
690 | 2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' | 690 | 2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' |
691 | 2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d | 691 | 2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d |
692 | 2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager | 692 | 2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from Enea Edge Management |
693 | host | 693 | host |
694 | 2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' | 694 | 2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' |
695 | 2019-03-07 17:33:57,159 - INFO: Done | 695 | 2019-03-07 17:33:57,159 - INFO: Done |
@@ -701,7 +701,7 @@ host | |||
701 | <title>Waiting a uCPE Device</title> | 701 | <title>Waiting a uCPE Device</title> |
702 | 702 | ||
703 | <para>Steps and details for how to Wait a uCPE device to connect to the | 703 | <para>Steps and details for how to Wait a uCPE device to connect to the |
704 | uCPE Manager after installation, are described below.</para> | 704 | Enea Edge Management after installation, are described below.</para> |
705 | 705 | ||
706 | <section id="wait_script_opts"> | 706 | <section id="wait_script_opts"> |
707 | <title>Script Options</title> | 707 | <title>Script Options</title> |
@@ -709,16 +709,16 @@ host | |||
709 | <programlisting>$ python waitDeviceUp.py -h | 709 | <programlisting>$ python waitDeviceUp.py -h |
710 | Usage: waitDeviceUp.py [options] | 710 | Usage: waitDeviceUp.py [options] |
711 | 711 | ||
712 | Wait for uCPE to connect to the Enea uCPE Manager after installation. | 712 | Wait for uCPE to connect to the Enea Edge Management after installation. |
713 | 713 | ||
714 | Options: | 714 | Options: |
715 | --version show program's version number and exit | 715 | --version show program's version number and exit |
716 | -h, --help show this help message and exit | 716 | -h, --help show this help message and exit |
717 | -u USERNAME, --username=USERNAME | 717 | -u USERNAME, --username=USERNAME |
718 | Enea uCPE Manager login username | 718 | Enea Edge Management login username |
719 | -p PASSWORD, --password=PASSWORD | 719 | -p PASSWORD, --password=PASSWORD |
720 | Enea uCPE Manager login password | 720 | Enea Edge Management login password |
721 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 721 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
722 | -f DEVICEFILE, --file=DEVICEFILE | 722 | -f DEVICEFILE, --file=DEVICEFILE |
723 | File containing uCPE Information in JSON format | 723 | File containing uCPE Information in JSON format |
724 | -t TIMEOUT, --timeout=TIMEOUT | 724 | -t TIMEOUT, --timeout=TIMEOUT |
@@ -779,7 +779,7 @@ Options: | |||
779 | <title>Printing the uCPE Device Log</title> | 779 | <title>Printing the uCPE Device Log</title> |
780 | 780 | ||
781 | <para>Steps and details on how to Print the events log for a specific | 781 | <para>Steps and details on how to Print the events log for a specific |
782 | uCPE device installed in the uCPE Manager, are explained below.</para> | 782 | uCPE device installed in the Enea Edge Management, are explained below.</para> |
783 | 783 | ||
784 | <section id="print_script_opts"> | 784 | <section id="print_script_opts"> |
785 | <title>Script Options</title> | 785 | <title>Script Options</title> |
@@ -787,14 +787,14 @@ Options: | |||
787 | <programlisting>$ python getEventsForUcpe.py -h | 787 | <programlisting>$ python getEventsForUcpe.py -h |
788 | Usage: getEventsForUcpe.py [options] | 788 | Usage: getEventsForUcpe.py [options] |
789 | 789 | ||
790 | Print the events log for a specific uCPE installed in Enea uCPE Manager. | 790 | Print the events log for a specific uCPE installed in Enea Edge Management. |
791 | 791 | ||
792 | Options: | 792 | Options: |
793 | --version show program's version number and exit | 793 | --version show program's version number and exit |
794 | -h, --help show this help message and exit | 794 | -h, --help show this help message and exit |
795 | -u USERNAME, --username=USERNAME Enea uCPE Manager login username | 795 | -u USERNAME, --username=USERNAME Enea Edge Management login username |
796 | -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password | 796 | -p PASSWORD, --password=PASSWORD Enea Edge Management login password |
797 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 797 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
798 | -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format | 798 | -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format |
799 | -s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor) | 799 | -s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor) |
800 | 800 | ||
@@ -869,10 +869,10 @@ Options: | |||
869 | --version show program's version number and exit | 869 | --version show program's version number and exit |
870 | -h, --help show this help message and exit | 870 | -h, --help show this help message and exit |
871 | -u USERNAME, --username=USERNAME | 871 | -u USERNAME, --username=USERNAME |
872 | Enea uCPE Manager login username | 872 | Enea Edge Management login username |
873 | -p PASSWORD, --password=PASSWORD | 873 | -p PASSWORD, --password=PASSWORD |
874 | Enea uCPE Manager login password | 874 | Enea Edge Management login password |
875 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 875 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
876 | -s STATE, --state=STATE | 876 | -s STATE, --state=STATE |
877 | Enable/Disable | 877 | Enable/Disable |
878 | -n DEVICENAME, --device-name=DEVICENAME | 878 | -n DEVICENAME, --device-name=DEVICENAME |
@@ -936,10 +936,10 @@ Options: | |||
936 | --version show program's version number and exit | 936 | --version show program's version number and exit |
937 | -h, --help show this help message and exit | 937 | -h, --help show this help message and exit |
938 | -u USERNAME, --username=USERNAME | 938 | -u USERNAME, --username=USERNAME |
939 | Enea uCPE Manager login username | 939 | Enea Edge Management login username |
940 | -p PASSWORD, --password=PASSWORD | 940 | -p PASSWORD, --password=PASSWORD |
941 | Enea uCPE Manager login password | 941 | Enea Edge Management login password |
942 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 942 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
943 | -f NICFILE, --file=NICFILE | 943 | -f NICFILE, --file=NICFILE |
944 | File containing network interface Information in JSON | 944 | File containing network interface Information in JSON |
945 | format | 945 | format |
@@ -1042,10 +1042,10 @@ Options: | |||
1042 | --version show program's version number and exit | 1042 | --version show program's version number and exit |
1043 | -h, --help show this help message and exit | 1043 | -h, --help show this help message and exit |
1044 | -u USERNAME, --username=USERNAME | 1044 | -u USERNAME, --username=USERNAME |
1045 | Enea uCPE Manager login username | 1045 | Enea Edge Management login username |
1046 | -p PASSWORD, --password=PASSWORD | 1046 | -p PASSWORD, --password=PASSWORD |
1047 | Enea uCPE Manager login password | 1047 | Enea Edge Management login password |
1048 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1048 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1049 | -f NICFILE, --file=NICFILE | 1049 | -f NICFILE, --file=NICFILE |
1050 | File containing network interface Information in JSON | 1050 | File containing network interface Information in JSON |
1051 | format | 1051 | format |
@@ -1131,9 +1131,9 @@ Usage: getNetworkInterfaces.py [options] | |||
1131 | Options: | 1131 | Options: |
1132 | --version show program's version number and exit | 1132 | --version show program's version number and exit |
1133 | -h, --help show this help message and exit | 1133 | -h, --help show this help message and exit |
1134 | -u USERNAME, --username=USERNAME Enea uCPE Manager login username | 1134 | -u USERNAME, --username=USERNAME Enea Edge Management login username |
1135 | -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password | 1135 | -p PASSWORD, --password=PASSWORD Enea Edge Management login password |
1136 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1136 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1137 | -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network / | 1137 | -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network / |
1138 | interfaces from | 1138 | interfaces from |
1139 | 1139 | ||
@@ -1215,10 +1215,10 @@ Options: | |||
1215 | --version show program's version number and exit | 1215 | --version show program's version number and exit |
1216 | -h, --help show this help message and exit | 1216 | -h, --help show this help message and exit |
1217 | -u USERNAME, --username=USERNAME | 1217 | -u USERNAME, --username=USERNAME |
1218 | Enea uCPE Manager login username | 1218 | Enea Edge Management login username |
1219 | -p PASSWORD, --password=PASSWORD | 1219 | -p PASSWORD, --password=PASSWORD |
1220 | Enea uCPE Manager login password | 1220 | Enea Edge Management login password |
1221 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1221 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1222 | -f OVSFILE, --file=OVSFILE | 1222 | -f OVSFILE, --file=OVSFILE |
1223 | File containing OVS bridge Information in JSON format | 1223 | File containing OVS bridge Information in JSON format |
1224 | -n DEVICENAME, --device-name=DEVICENAME | 1224 | -n DEVICENAME, --device-name=DEVICENAME |
@@ -1306,10 +1306,10 @@ Options: | |||
1306 | --version show program's version number and exit | 1306 | --version show program's version number and exit |
1307 | -h, --help show this help message and exit | 1307 | -h, --help show this help message and exit |
1308 | -u USERNAME, --username=USERNAME | 1308 | -u USERNAME, --username=USERNAME |
1309 | Enea uCPE Manager login username | 1309 | Enea Edge Management login username |
1310 | -p PASSWORD, --password=PASSWORD | 1310 | -p PASSWORD, --password=PASSWORD |
1311 | Enea uCPE Manager login password | 1311 | Enea Edge Management login password |
1312 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1312 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1313 | -f OVSFILE, --file=OVSFILE | 1313 | -f OVSFILE, --file=OVSFILE |
1314 | File containing OVS bridge Information in JSON format | 1314 | File containing OVS bridge Information in JSON format |
1315 | -n DEVICENAME, --device-name=DEVICENAME | 1315 | -n DEVICENAME, --device-name=DEVICENAME |
@@ -1380,7 +1380,7 @@ Options: | |||
1380 | <section id="onboard_vnf_image"> | 1380 | <section id="onboard_vnf_image"> |
1381 | <title>Onboarding a VNF Image Raw</title> | 1381 | <title>Onboarding a VNF Image Raw</title> |
1382 | 1382 | ||
1383 | <para>How to Onboard a VNF image in the uCPE Manager based upon its raw | 1383 | <para>How to Onboard a VNF image in the Enea Edge Management based upon its raw |
1384 | constituents, is detailed in depth below.</para> | 1384 | constituents, is detailed in depth below.</para> |
1385 | 1385 | ||
1386 | <section id="script_opts_image"> | 1386 | <section id="script_opts_image"> |
@@ -1389,16 +1389,16 @@ Options: | |||
1389 | <programlisting>$ python onboardVNFRaw.py -h | 1389 | <programlisting>$ python onboardVNFRaw.py -h |
1390 | Usage: onboardVNFRaw.py [options] | 1390 | Usage: onboardVNFRaw.py [options] |
1391 | 1391 | ||
1392 | Onboard a VNF in Enea uCPE Manager based upon its raw constituents. | 1392 | Onboard a VNF in Enea Edge Management based upon its raw constituents. |
1393 | 1393 | ||
1394 | Options: | 1394 | Options: |
1395 | --version show program's version number and exit | 1395 | --version show program's version number and exit |
1396 | -h, --help show this help message and exit | 1396 | -h, --help show this help message and exit |
1397 | -u USERNAME, --username=USERNAME | 1397 | -u USERNAME, --username=USERNAME |
1398 | Enea uCPE Manager login username | 1398 | Enea Edge Management login username |
1399 | -p PASSWORD, --password=PASSWORD | 1399 | -p PASSWORD, --password=PASSWORD |
1400 | Enea uCPE Manager login password | 1400 | Enea Edge Management login password |
1401 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1401 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1402 | -f FTPUSERNAME, --ftpUsername=FTPUSERNAME | 1402 | -f FTPUSERNAME, --ftpUsername=FTPUSERNAME |
1403 | Username for FTP | 1403 | Username for FTP |
1404 | -w FTPPASSWORD, --ftpPassword=FTPPASSWORD | 1404 | -w FTPPASSWORD, --ftpPassword=FTPPASSWORD |
@@ -1497,7 +1497,7 @@ Options: | |||
1497 | <section id="offboard_vnf"> | 1497 | <section id="offboard_vnf"> |
1498 | <title>Offboarding a VNF</title> | 1498 | <title>Offboarding a VNF</title> |
1499 | 1499 | ||
1500 | <para>Steps on how to Offboard a VNF from the uCPE Manager are detailed | 1500 | <para>Steps on how to Offboard a VNF from the Enea Edge Management are detailed |
1501 | below.</para> | 1501 | below.</para> |
1502 | 1502 | ||
1503 | <section id="script_opts_offimage"> | 1503 | <section id="script_opts_offimage"> |
@@ -1506,16 +1506,16 @@ Options: | |||
1506 | <programlisting>$ python offboardVNF.py -h | 1506 | <programlisting>$ python offboardVNF.py -h |
1507 | Usage: offboardVNF.py [options] | 1507 | Usage: offboardVNF.py [options] |
1508 | 1508 | ||
1509 | Offboard a VNF from Enea uCPE Manager. | 1509 | Offboard a VNF from Enea Edge Management. |
1510 | 1510 | ||
1511 | Options: | 1511 | Options: |
1512 | --version show program's version number and exit | 1512 | --version show program's version number and exit |
1513 | -h, --help show this help message and exit | 1513 | -h, --help show this help message and exit |
1514 | -u USERNAME, --username=USERNAME | 1514 | -u USERNAME, --username=USERNAME |
1515 | Enea uCPE Manager login username | 1515 | Enea Edge Management login username |
1516 | -p PASSWORD, --password=PASSWORD | 1516 | -p PASSWORD, --password=PASSWORD |
1517 | Enea uCPE Manager login password | 1517 | Enea Edge Management login password |
1518 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1518 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1519 | -n VNFDNAME, --vnfdName=VNFDNAME | 1519 | -n VNFDNAME, --vnfdName=VNFDNAME |
1520 | Name of VNF descriptor to offboard | 1520 | Name of VNF descriptor to offboard |
1521 | 1521 | ||
@@ -1563,7 +1563,7 @@ Options: | |||
1563 | <section id="instantiate_vnf"> | 1563 | <section id="instantiate_vnf"> |
1564 | <title>Instantiating a VNF</title> | 1564 | <title>Instantiating a VNF</title> |
1565 | 1565 | ||
1566 | <para>Instantiating a VNF via the uCPE Manager is detailed below.</para> | 1566 | <para>Instantiating a VNF via the Enea Edge Management is detailed below.</para> |
1567 | 1567 | ||
1568 | <section id="script_opts_inst"> | 1568 | <section id="script_opts_inst"> |
1569 | <title>Script Options</title> | 1569 | <title>Script Options</title> |
@@ -1571,16 +1571,16 @@ Options: | |||
1571 | <programlisting>$ python instantiateVNFI.py -h | 1571 | <programlisting>$ python instantiateVNFI.py -h |
1572 | Usage: instantiateVNFI.py [options] | 1572 | Usage: instantiateVNFI.py [options] |
1573 | 1573 | ||
1574 | Instantiate a VNF via Enea uCPE Manager. | 1574 | Instantiate a VNF via Enea Edge Management. |
1575 | 1575 | ||
1576 | Options: | 1576 | Options: |
1577 | --version show program's version number and exit | 1577 | --version show program's version number and exit |
1578 | -h, --help show this help message and exit | 1578 | -h, --help show this help message and exit |
1579 | -u USERNAME, --username=USERNAME | 1579 | -u USERNAME, --username=USERNAME |
1580 | Enea uCPE Manager login username | 1580 | Enea Edge Management login username |
1581 | -p PASSWORD, --password=PASSWORD | 1581 | -p PASSWORD, --password=PASSWORD |
1582 | Enea uCPE Manager login password | 1582 | Enea Edge Management login password |
1583 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1583 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1584 | -t VNFTYPE, --vnfType=VNFTYPE | 1584 | -t VNFTYPE, --vnfType=VNFTYPE |
1585 | VNF Type (Name of VNF descriptor) | 1585 | VNF Type (Name of VNF descriptor) |
1586 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME | 1586 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
@@ -1642,7 +1642,7 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") | |||
1642 | <section id="control_vnf_inst"> | 1642 | <section id="control_vnf_inst"> |
1643 | <title>Controlling a VNF Instance</title> | 1643 | <title>Controlling a VNF Instance</title> |
1644 | 1644 | ||
1645 | <para>How to Control a VNF instance from the Enea uCPE Manager is | 1645 | <para>How to Control a VNF instance from the Enea Edge Management is |
1646 | detailed below.</para> | 1646 | detailed below.</para> |
1647 | 1647 | ||
1648 | <note> | 1648 | <note> |
@@ -1651,7 +1651,7 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") | |||
1651 | become unresponsive. Depending on the actual VNF, the time required | 1651 | become unresponsive. Depending on the actual VNF, the time required |
1652 | between life-cycle operations may vary from several seconds to half a | 1652 | between life-cycle operations may vary from several seconds to half a |
1653 | minute or even more. If a VNF becomes unresponsive, the only possible | 1653 | minute or even more. If a VNF becomes unresponsive, the only possible |
1654 | action is to "Force Delete" the instance from the uCPE Manager.</para> | 1654 | action is to "Force Delete" the instance from the Enea Edge Management.</para> |
1655 | </note> | 1655 | </note> |
1656 | 1656 | ||
1657 | <section id="script_opts_control"> | 1657 | <section id="script_opts_control"> |
@@ -1660,16 +1660,16 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") | |||
1660 | <programlisting>$ python controlVNFI.py -h | 1660 | <programlisting>$ python controlVNFI.py -h |
1661 | Usage: controlVNFI.py [options] | 1661 | Usage: controlVNFI.py [options] |
1662 | 1662 | ||
1663 | Controls a VNF instance from Enea uCPE Manager. | 1663 | Controls a VNF instance from Enea Edge Management. |
1664 | 1664 | ||
1665 | Options: | 1665 | Options: |
1666 | --version show program's version number and exit | 1666 | --version show program's version number and exit |
1667 | -h, --help show this help message and exit | 1667 | -h, --help show this help message and exit |
1668 | -u USERNAME, --username=USERNAME | 1668 | -u USERNAME, --username=USERNAME |
1669 | Enea uCPE Manager login username | 1669 | Enea Edge Management login username |
1670 | -p PASSWORD, --password=PASSWORD | 1670 | -p PASSWORD, --password=PASSWORD |
1671 | Enea uCPE Manager login password | 1671 | Enea Edge Management login password |
1672 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1672 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1673 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME | 1673 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME |
1674 | Name of VNF instance | 1674 | Name of VNF instance |
1675 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME | 1675 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
@@ -1736,7 +1736,7 @@ fortigateFWInstance -c stop | |||
1736 | <title>Destroying a VNF Instance</title> | 1736 | <title>Destroying a VNF Instance</title> |
1737 | 1737 | ||
1738 | <para>Steps and options on how to Destroy a VNF instance from the Enea | 1738 | <para>Steps and options on how to Destroy a VNF instance from the Enea |
1739 | uCPE Manager are described below.</para> | 1739 | Edge Management are described below.</para> |
1740 | 1740 | ||
1741 | <section id="script_opts_destroy"> | 1741 | <section id="script_opts_destroy"> |
1742 | <title>Script Options</title> | 1742 | <title>Script Options</title> |
@@ -1744,16 +1744,16 @@ fortigateFWInstance -c stop | |||
1744 | <programlisting>$ python destroyVNFI.py -h | 1744 | <programlisting>$ python destroyVNFI.py -h |
1745 | Usage: destroyVNFI.py [options] | 1745 | Usage: destroyVNFI.py [options] |
1746 | 1746 | ||
1747 | Destroys a VNF instance from Enea uCPE Manager. | 1747 | Destroys a VNF instance from Enea Edge Management. |
1748 | 1748 | ||
1749 | Options: | 1749 | Options: |
1750 | --version show program's version number and exit | 1750 | --version show program's version number and exit |
1751 | -h, --help show this help message and exit | 1751 | -h, --help show this help message and exit |
1752 | -u USERNAME, --username=USERNAME | 1752 | -u USERNAME, --username=USERNAME |
1753 | Enea uCPE Manager login username | 1753 | Enea Edge Management login username |
1754 | -p PASSWORD, --password=PASSWORD | 1754 | -p PASSWORD, --password=PASSWORD |
1755 | Enea uCPE Manager login password | 1755 | Enea Edge Management login password |
1756 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1756 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1757 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME | 1757 | -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME |
1758 | Name of VNF instance | 1758 | Name of VNF instance |
1759 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME | 1759 | -n VIMDEVICENAME, --device-name=VIMDEVICENAME |
@@ -1801,28 +1801,28 @@ fortigateFWInstance | |||
1801 | </section> | 1801 | </section> |
1802 | 1802 | ||
1803 | <section id="upload_vnf_image"> | 1803 | <section id="upload_vnf_image"> |
1804 | <title>Uploading a NFV Access image onto the Enea uCPE Manager</title> | 1804 | <title>Uploading a Enea Edge image onto the Enea Edge Management</title> |
1805 | 1805 | ||
1806 | <para>Steps and options on how to Upload a NFV Access image onto the | 1806 | <para>Steps and options on how to Upload a Enea Edge image onto the |
1807 | Enea uCPE Manager are described below.</para> | 1807 | Enea Edge Management are described below.</para> |
1808 | 1808 | ||
1809 | <section id="script_opts_upload"> | 1809 | <section id="script_opts_upload"> |
1810 | <title>Script Options</title> | 1810 | <title>Script Options</title> |
1811 | 1811 | ||
1812 | <programlisting>$ python uploadImage.py -h | 1812 | <programlisting>$ python uploadImage.py -h |
1813 | Upload NFVA image on uCPE Manager | 1813 | Upload NFVA image on Enea Edge Management |
1814 | Usage: uploadImage.py [options] | 1814 | Usage: uploadImage.py [options] |
1815 | 1815 | ||
1816 | Upload NFVA image on uCPE Manager. | 1816 | Upload NFVA image on Enea Edge Management. |
1817 | 1817 | ||
1818 | Options: | 1818 | Options: |
1819 | --version show program's version number and exit | 1819 | --version show program's version number and exit |
1820 | -h, --help show this help message and exit | 1820 | -h, --help show this help message and exit |
1821 | -u USERNAME, --username=USERNAME | 1821 | -u USERNAME, --username=USERNAME |
1822 | Enea uCPE Manager login username | 1822 | Enea Edge Management login username |
1823 | -p PASSWORD, --password=PASSWORD | 1823 | -p PASSWORD, --password=PASSWORD |
1824 | Enea uCPE Manager login password | 1824 | Enea Edge Management login password |
1825 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1825 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1826 | -f FILENAME, --fileName=FILENAME | 1826 | -f FILENAME, --fileName=FILENAME |
1827 | Path to NFVA image file name | 1827 | Path to NFVA image file name |
1828 | -m MODULE, --module=MODULE | 1828 | -m MODULE, --module=MODULE |
@@ -1838,7 +1838,7 @@ Options: | |||
1838 | <section id="json_upload"> | 1838 | <section id="json_upload"> |
1839 | <title>Configuring the JSON File</title> | 1839 | <title>Configuring the JSON File</title> |
1840 | 1840 | ||
1841 | <para>The JSON configuration file needed to upload a NFV Access image | 1841 | <para>The JSON configuration file needed to upload a Enea Edge image |
1842 | should contain a list of dictionaries. Each dictionary indicates the | 1842 | should contain a list of dictionaries. Each dictionary indicates the |
1843 | test case name and the test case arguments passed to the | 1843 | test case name and the test case arguments passed to the |
1844 | <filename>uploadImage</filename> Python module.</para> | 1844 | <filename>uploadImage</filename> Python module.</para> |
@@ -1846,7 +1846,7 @@ Options: | |||
1846 | <para><emphasis role="bold">Sample unit-test JSON file | 1846 | <para><emphasis role="bold">Sample unit-test JSON file |
1847 | format:</emphasis><programlisting>[ | 1847 | format:</emphasis><programlisting>[ |
1848 | { | 1848 | { |
1849 | "name": "Upload NFVA image on uCPE Manager", | 1849 | "name": "Upload NFVA image on Enea Edge Management", |
1850 | "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d" | 1850 | "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d" |
1851 | } | 1851 | } |
1852 | ]</programlisting></para> | 1852 | ]</programlisting></para> |
@@ -1861,7 +1861,7 @@ Options: | |||
1861 | <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \ | 1861 | <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \ |
1862 | -f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d | 1862 | -f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d |
1863 | 2020-02-28 11:38:42,754 - DEBUG: Started logging | 1863 | 2020-02-28 11:38:42,754 - DEBUG: Started logging |
1864 | 2020-02-28 11:38:42,755 - INFO: Upload NFVA image on uCPE Manager | 1864 | 2020-02-28 11:38:42,755 - INFO: Upload NFVA image on Enea Edge Management |
1865 | 2020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost' | 1865 | 2020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost' |
1866 | 2020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30 | 1866 | 2020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30 |
1867 | 2020-02-28 11:41:29,148 - INFO: Verify image validation flag | 1867 | 2020-02-28 11:41:29,148 - INFO: Verify image validation flag |
@@ -1874,29 +1874,29 @@ Options: | |||
1874 | </section> | 1874 | </section> |
1875 | 1875 | ||
1876 | <section id="delete_vnf_image"> | 1876 | <section id="delete_vnf_image"> |
1877 | <title>Deleting a NFV Access image file from the Enea uCPE | 1877 | <title>Deleting a Enea Edge image file from the |
1878 | Manager</title> | 1878 | Enea Edge Management</title> |
1879 | 1879 | ||
1880 | <para>Steps and options on how to Delete a NFV Access image from the | 1880 | <para>Steps and options on how to Delete a Enea Edge image from the |
1881 | Enea uCPE Manager are described below.</para> | 1881 | Enea Edge Management are described below.</para> |
1882 | 1882 | ||
1883 | <section id="script_opts_deleteupload"> | 1883 | <section id="script_opts_deleteupload"> |
1884 | <title>Script Options</title> | 1884 | <title>Script Options</title> |
1885 | 1885 | ||
1886 | <programlisting>$ python deleteUpgradeFile.py -h | 1886 | <programlisting>$ python deleteUpgradeFile.py -h |
1887 | Delete NFVA image from uCPE Manager | 1887 | Delete NFVA image from Enea Edge Management |
1888 | Usage: deleteUpgradeFile.py [options] | 1888 | Usage: deleteUpgradeFile.py [options] |
1889 | 1889 | ||
1890 | Delete NFVA image from uCPE Manager. | 1890 | Delete NFVA image from Enea Edge Management. |
1891 | 1891 | ||
1892 | Options: | 1892 | Options: |
1893 | --version show program's version number and exit | 1893 | --version show program's version number and exit |
1894 | -h, --help show this help message and exit | 1894 | -h, --help show this help message and exit |
1895 | -u USERNAME, --username=USERNAME | 1895 | -u USERNAME, --username=USERNAME |
1896 | Enea uCPE Manager login username | 1896 | Enea Edge Management login username |
1897 | -p PASSWORD, --password=PASSWORD | 1897 | -p PASSWORD, --password=PASSWORD |
1898 | Enea uCPE Manager login password | 1898 | Enea Edge Management login password |
1899 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1899 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1900 | -i IMAGENAME, --imageName=IMAGENAME | 1900 | -i IMAGENAME, --imageName=IMAGENAME |
1901 | NFVA Image name | 1901 | NFVA Image name |
1902 | -m MODULE, --module=MODULE | 1902 | -m MODULE, --module=MODULE |
@@ -1909,7 +1909,7 @@ Options: | |||
1909 | <section id="json_delete_upload"> | 1909 | <section id="json_delete_upload"> |
1910 | <title>Configuring the JSON File</title> | 1910 | <title>Configuring the JSON File</title> |
1911 | 1911 | ||
1912 | <para>The JSON configuration file needed to delete a NFV Access image | 1912 | <para>The JSON configuration file needed to delete a Enea Edge image |
1913 | should contain a list of dictionaries. Each dictionary indicates the | 1913 | should contain a list of dictionaries. Each dictionary indicates the |
1914 | test case name and the test case arguments passed to the | 1914 | test case name and the test case arguments passed to the |
1915 | <filename>deleteUpgradeFile</filename> Python module.</para> | 1915 | <filename>deleteUpgradeFile</filename> Python module.</para> |
@@ -1917,7 +1917,7 @@ Options: | |||
1917 | <para><emphasis role="bold">Sample unit-test JSON file | 1917 | <para><emphasis role="bold">Sample unit-test JSON file |
1918 | format:</emphasis><programlisting>[ | 1918 | format:</emphasis><programlisting>[ |
1919 | { | 1919 | { |
1920 | "name": "Delete NFVA image on uCPE Manager", | 1920 | "name": "Delete NFVA image on Enea Edge Management", |
1921 | "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2" | 1921 | "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2" |
1922 | } | 1922 | } |
1923 | ]</programlisting></para> | 1923 | ]</programlisting></para> |
@@ -1932,7 +1932,7 @@ Options: | |||
1932 | <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \ | 1932 | <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \ |
1933 | enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 | 1933 | enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 |
1934 | 2020-02-28 12:06:20,111 - DEBUG: Started logging | 1934 | 2020-02-28 12:06:20,111 - DEBUG: Started logging |
1935 | 2020-02-28 12:06:20,112 - INFO: Delete NFVA image from uCPE Manager | 1935 | 2020-02-28 12:06:20,112 - INFO: Delete NFVA image from Enea Edge Management |
1936 | 2020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost' | 1936 | 2020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost' |
1937 | 2020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30 | 1937 | 2020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30 |
1938 | 2020-02-28 12:06:20,255 - INFO: The image \ | 1938 | 2020-02-28 12:06:20,255 - INFO: The image \ |
@@ -1948,30 +1948,30 @@ image was successfully removed | |||
1948 | </section> | 1948 | </section> |
1949 | 1949 | ||
1950 | <section id="install_activate_vnf_image"> | 1950 | <section id="install_activate_vnf_image"> |
1951 | <title>Installing and activating a NFV Access image on an uCPE device | 1951 | <title>Installing and activating a Enea Edge image on an uCPE device |
1952 | from the Enea uCPE Manager</title> | 1952 | from the Enea Edge Management</title> |
1953 | 1953 | ||
1954 | <para>Steps and options on how to Install and Activate a NFV Access | 1954 | <para>Steps and options on how to Install and Activate a Enea Edge |
1955 | image on an uCPE device from the Enea uCPE Manager are described | 1955 | image on an uCPE device from the Enea Edge Management are described |
1956 | below.</para> | 1956 | below.</para> |
1957 | 1957 | ||
1958 | <section id="script_opts_install_activate"> | 1958 | <section id="script_opts_install_activate"> |
1959 | <title>Script Options</title> | 1959 | <title>Script Options</title> |
1960 | 1960 | ||
1961 | <programlisting>$ python installAndActivate.py -h | 1961 | <programlisting>$ python installAndActivate.py -h |
1962 | Install and activate NFVA image from uCPE Manager | 1962 | Install and activate NFVA image from Enea Edge Management |
1963 | Usage: installAndActivate.py [options] | 1963 | Usage: installAndActivate.py [options] |
1964 | 1964 | ||
1965 | Install and activate NFVA image from uCPE Manager. | 1965 | Install and activate NFVA image from Enea Edge Management. |
1966 | 1966 | ||
1967 | Options: | 1967 | Options: |
1968 | --version show program's version number and exit | 1968 | --version show program's version number and exit |
1969 | -h, --help show this help message and exit | 1969 | -h, --help show this help message and exit |
1970 | -u USERNAME, --username=USERNAME | 1970 | -u USERNAME, --username=USERNAME |
1971 | Enea uCPE Manager login username | 1971 | Enea Edge Management login username |
1972 | -p PASSWORD, --password=PASSWORD | 1972 | -p PASSWORD, --password=PASSWORD |
1973 | Enea uCPE Manager login password | 1973 | Enea Edge Management login password |
1974 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 1974 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
1975 | -i IMAGENAME, --imageName=IMAGENAME | 1975 | -i IMAGENAME, --imageName=IMAGENAME |
1976 | Image name | 1976 | Image name |
1977 | -m MODULE, --module=MODULE | 1977 | -m MODULE, --module=MODULE |
@@ -1989,8 +1989,8 @@ Options: | |||
1989 | <section id="json_install_activate"> | 1989 | <section id="json_install_activate"> |
1990 | <title>Configuring the JSON File</title> | 1990 | <title>Configuring the JSON File</title> |
1991 | 1991 | ||
1992 | <para>The JSON configuration file needed to install and activate a NFV | 1992 | <para>The JSON configuration file needed to install and activate a Enea Edge |
1993 | Access image on a uCPE device from the Enea uCPE Manager should | 1993 | image on a uCPE device from the Enea Edge Management should |
1994 | contain a list of dictionaries. Each dictionary indicates the test | 1994 | contain a list of dictionaries. Each dictionary indicates the test |
1995 | case name and the test case arguments passed to the | 1995 | case name and the test case arguments passed to the |
1996 | <filename>installAndActivate</filename> Python module.</para> | 1996 | <filename>installAndActivate</filename> Python module.</para> |
@@ -2000,7 +2000,7 @@ Options: | |||
2000 | 2000 | ||
2001 | <programlisting>[ | 2001 | <programlisting>[ |
2002 | { | 2002 | { |
2003 | "name": "Install and activate NFVA image on uCPE device from uCPE Manager", | 2003 | "name": "Install and activate NFVA image on uCPE device from Enea Edge Management", |
2004 | "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16" | 2004 | "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16" |
2005 | } | 2005 | } |
2006 | ]</programlisting> | 2006 | ]</programlisting> |
@@ -2015,7 +2015,7 @@ Options: | |||
2015 | <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \ | 2015 | <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \ |
2016 | enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16 | 2016 | enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16 |
2017 | 2020-02-28 12:36:46,137 - DEBUG: Started logging | 2017 | 2020-02-28 12:36:46,137 - DEBUG: Started logging |
2018 | 2020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from uCPE Manager | 2018 | 2020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from Enea Edge Management |
2019 | 2020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost' | 2019 | 2020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost' |
2020 | 2020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30 | 2020 | 2020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30 |
2021 | 2020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16' | 2021 | 2020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16' |
@@ -2055,10 +2055,10 @@ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [20] | |||
2055 | 2055 | ||
2056 | <section id="clearing_info_upgrade"> | 2056 | <section id="clearing_info_upgrade"> |
2057 | <title>Clearing information about completed upgrades of uCPE devices | 2057 | <title>Clearing information about completed upgrades of uCPE devices |
2058 | from the Enea uCPE Manager</title> | 2058 | from the Enea Edge Management</title> |
2059 | 2059 | ||
2060 | <para>Steps and options on how to clear information about completed | 2060 | <para>Steps and options on how to clear information about completed |
2061 | upgrades of uCPE devices from the Enea uCPE Manager are described | 2061 | upgrades of uCPE devices from the Enea Edge Management are described |
2062 | below.</para> | 2062 | below.</para> |
2063 | 2063 | ||
2064 | <section id="script_opts_clearinfo"> | 2064 | <section id="script_opts_clearinfo"> |
@@ -2074,10 +2074,10 @@ Options: | |||
2074 | --version show program's version number and exit | 2074 | --version show program's version number and exit |
2075 | -h, --help show this help message and exit | 2075 | -h, --help show this help message and exit |
2076 | -u USERNAME, --username=USERNAME | 2076 | -u USERNAME, --username=USERNAME |
2077 | Enea uCPE Manager login username | 2077 | Enea Edge Management login username |
2078 | -p PASSWORD, --password=PASSWORD | 2078 | -p PASSWORD, --password=PASSWORD |
2079 | Enea uCPE Manager login password | 2079 | Enea Edge Management login password |
2080 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2080 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2081 | 2081 | ||
2082 | Mandatory options: | 2082 | Mandatory options: |
2083 | -H/--host </programlisting> | 2083 | -H/--host </programlisting> |
@@ -2087,7 +2087,7 @@ Options: | |||
2087 | <title>Configuring the JSON File</title> | 2087 | <title>Configuring the JSON File</title> |
2088 | 2088 | ||
2089 | <para>No JSON configuration file is needed to clear information about | 2089 | <para>No JSON configuration file is needed to clear information about |
2090 | completed upgrades of uCPE devices from the Enea uCPE Manager. The | 2090 | completed upgrades of uCPE devices from the Enea Edge Management. The |
2091 | <filename>clearCompletedUpgradesInfo</filename> Python module can be | 2091 | <filename>clearCompletedUpgradesInfo</filename> Python module can be |
2092 | run without a JSON file as a parameter.</para> | 2092 | run without a JSON file as a parameter.</para> |
2093 | </section> | 2093 | </section> |
@@ -2110,10 +2110,10 @@ Options: | |||
2110 | </section> | 2110 | </section> |
2111 | 2111 | ||
2112 | <section id="upload_custom_script"> | 2112 | <section id="upload_custom_script"> |
2113 | <title>Uploading a Custom Script to the uCPE Manager</title> | 2113 | <title>Uploading a Custom Script to the Enea Edge Management</title> |
2114 | 2114 | ||
2115 | <para>Steps and options on how to upload a custom script to the uCPE | 2115 | <para>Steps and options on how to upload a custom script to the |
2116 | Manager are described below.</para> | 2116 | Enea Edge Management are described below.</para> |
2117 | 2117 | ||
2118 | <section id="script_opts_upload_custom_script"> | 2118 | <section id="script_opts_upload_custom_script"> |
2119 | <title>Script Options</title> | 2119 | <title>Script Options</title> |
@@ -2122,16 +2122,16 @@ Options: | |||
2122 | 2020-04-14 10:26:23,582 - INFO: Upload Custom Script | 2122 | 2020-04-14 10:26:23,582 - INFO: Upload Custom Script |
2123 | Usage: upload.py [options] | 2123 | Usage: upload.py [options] |
2124 | 2124 | ||
2125 | Add a Custom Script to Enea uCPE Manager | 2125 | Add a Custom Script to Enea Edge Management |
2126 | 2126 | ||
2127 | Options: | 2127 | Options: |
2128 | --version show program's version number and exit | 2128 | --version show program's version number and exit |
2129 | -h, --help show this help message and exit | 2129 | -h, --help show this help message and exit |
2130 | -u USERNAME, --username=USERNAME | 2130 | -u USERNAME, --username=USERNAME |
2131 | Enea uCPE Manager login username | 2131 | Enea Edge Management login username |
2132 | -p PASSWORD, --password=PASSWORD | 2132 | -p PASSWORD, --password=PASSWORD |
2133 | Enea uCPE Manager login password | 2133 | Enea Edge Management login password |
2134 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2134 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2135 | -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT | 2135 | -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT |
2136 | Custom Script File | 2136 | Custom Script File |
2137 | -e PHASE, --phase=PHASE | 2137 | -e PHASE, --phase=PHASE |
@@ -2147,7 +2147,7 @@ Options: | |||
2147 | <title>Configuring the JSON File</title> | 2147 | <title>Configuring the JSON File</title> |
2148 | 2148 | ||
2149 | <para>The JSON configuration file needed to upload a Custom Script to | 2149 | <para>The JSON configuration file needed to upload a Custom Script to |
2150 | the uCPE Manager must contain a list of dictionaries. Each dictionary | 2150 | the Enea Edge Management must contain a list of dictionaries. Each dictionary |
2151 | indicates the test case name and the test case arguments passed to the | 2151 | indicates the test case name and the test case arguments passed to the |
2152 | <filename>customScripts/upload</filename> Python module.</para> | 2152 | <filename>customScripts/upload</filename> Python module.</para> |
2153 | 2153 | ||
@@ -2156,7 +2156,7 @@ Options: | |||
2156 | 2156 | ||
2157 | <programlisting>[ | 2157 | <programlisting>[ |
2158 | { | 2158 | { |
2159 | "name": "Uploading a Custom Script to the uCPE Manager", | 2159 | "name": "Uploading a Custom Script to the Enea Edge Management", |
2160 | "args": "-f ../../lab_config/customScripts/test_success_after_always \ | 2160 | "args": "-f ../../lab_config/customScripts/test_success_after_always \ |
2161 | -e always-after-startup" | 2161 | -e always-after-startup" |
2162 | } | 2162 | } |
@@ -2175,7 +2175,7 @@ Options: | |||
2175 | 2020-04-14 14:08:02,915 - INFO: Upload Custom Script | 2175 | 2020-04-14 14:08:02,915 - INFO: Upload Custom Script |
2176 | 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' | 2176 | 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' |
2177 | 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f | 2177 | 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f |
2178 | 2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ | 2178 | 2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \ |
2179 | Content: #!/bin/bash | 2179 | Content: #!/bin/bash |
2180 | echo test_success_after_always | 2180 | echo test_success_after_always |
2181 | 2020-04-14 14:08:03,138 - INFO: Done | 2181 | 2020-04-14 14:08:03,138 - INFO: Done |
@@ -2184,11 +2184,11 @@ echo test_success_after_always | |||
2184 | </section> | 2184 | </section> |
2185 | 2185 | ||
2186 | <section id="upload_custom_script_device"> | 2186 | <section id="upload_custom_script_device"> |
2187 | <title>Uploading a Custom Script from the uCPE Manager to a | 2187 | <title>Uploading a Custom Script from the Enea Edge Management to a |
2188 | Device</title> | 2188 | Device</title> |
2189 | 2189 | ||
2190 | <para>Steps and options on how to upload a custom script from the uCPE | 2190 | <para>Steps and options on how to upload a custom script from the |
2191 | Manager to a Device are described below.</para> | 2191 | Enea Edge Management to a Device are described below.</para> |
2192 | 2192 | ||
2193 | <section id="script_opts_upload_custom_script_device"> | 2193 | <section id="script_opts_upload_custom_script_device"> |
2194 | <title>Script Options</title> | 2194 | <title>Script Options</title> |
@@ -2203,12 +2203,12 @@ Options: | |||
2203 | --version show program's version number and exit | 2203 | --version show program's version number and exit |
2204 | -h, --help show this help message and exit | 2204 | -h, --help show this help message and exit |
2205 | -u USERNAME, --username=USERNAME | 2205 | -u USERNAME, --username=USERNAME |
2206 | Enea uCPE Manager login username | 2206 | Enea Edge Management login username |
2207 | -p PASSWORD, --password=PASSWORD | 2207 | -p PASSWORD, --password=PASSWORD |
2208 | Enea uCPE Manager login password | 2208 | Enea Edge Management login password |
2209 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2209 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2210 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME | 2210 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME |
2211 | Custom Script Name that resides on Enea uCPE Manager | 2211 | Custom Script Name that resides on Enea Edge Management |
2212 | -e PHASE, --phase=PHASE | 2212 | -e PHASE, --phase=PHASE |
2213 | Execution phase. Must be one of the following: once- | 2213 | Execution phase. Must be one of the following: once- |
2214 | before-startup | always-before-startup | once-after- | 2214 | before-startup | always-before-startup | once-after- |
@@ -2225,7 +2225,7 @@ Options: | |||
2225 | <title>Configuring the JSON File</title> | 2225 | <title>Configuring the JSON File</title> |
2226 | 2226 | ||
2227 | <para>The JSON configuration file needed to upload a Custom Script | 2227 | <para>The JSON configuration file needed to upload a Custom Script |
2228 | from the uCPE Manager to a Device must contain a list of dictionaries. | 2228 | from the Enea Edge Management to a Device must contain a list of dictionaries. |
2229 | Each dictionary indicates the test case name and the test case | 2229 | Each dictionary indicates the test case name and the test case |
2230 | arguments passed to the | 2230 | arguments passed to the |
2231 | <filename>customScripts/uploadOnDevice</filename> Python | 2231 | <filename>customScripts/uploadOnDevice</filename> Python |
@@ -2236,7 +2236,7 @@ Options: | |||
2236 | 2236 | ||
2237 | <programlisting>[ | 2237 | <programlisting>[ |
2238 | { | 2238 | { |
2239 | "name": "Uploading a Custom Script from uCPE Manager to device", | 2239 | "name": "Uploading a Custom Script from Enea Edge Management to device", |
2240 | "args": "-c test_success_after_always -e always-after-startup -n inteld1521-6" | 2240 | "args": "-c test_success_after_always -e always-after-startup -n inteld1521-6" |
2241 | } | 2241 | } |
2242 | ]</programlisting> | 2242 | ]</programlisting> |
@@ -2263,16 +2263,16 @@ test_success_after_always -e always-after-startup -n inteld1521-6 | |||
2263 | </section> | 2263 | </section> |
2264 | 2264 | ||
2265 | <section id="delete_custom_script"> | 2265 | <section id="delete_custom_script"> |
2266 | <title>Removing a Custom Script from the uCPE Manager</title> | 2266 | <title>Removing a Custom Script from the Enea Edge Management</title> |
2267 | 2267 | ||
2268 | <para>Steps and options on how to remove a custom script from the uCPE | 2268 | <para>Steps and options on how to remove a custom script from the |
2269 | Manager are described below.</para> | 2269 | Enea Edge Management are described below.</para> |
2270 | 2270 | ||
2271 | <section id="script_opts_delete_custom_script"> | 2271 | <section id="script_opts_delete_custom_script"> |
2272 | <title>Script Options</title> | 2272 | <title>Script Options</title> |
2273 | 2273 | ||
2274 | <programlisting>$ python customScripts/delete.py -h | 2274 | <programlisting>$ python customScripts/delete.py -h |
2275 | 2020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager | 2275 | 2020-04-14 14:36:52,010 - INFO: Delete Custom Script on Enea Edge Management |
2276 | Usage: delete.py [options] | 2276 | Usage: delete.py [options] |
2277 | 2277 | ||
2278 | Delete a Custom Script from a Device | 2278 | Delete a Custom Script from a Device |
@@ -2281,10 +2281,10 @@ Options: | |||
2281 | --version show program's version number and exit | 2281 | --version show program's version number and exit |
2282 | -h, --help show this help message and exit | 2282 | -h, --help show this help message and exit |
2283 | -u USERNAME, --username=USERNAME | 2283 | -u USERNAME, --username=USERNAME |
2284 | Enea uCPE Manager login username | 2284 | Enea Edge Management login username |
2285 | -p PASSWORD, --password=PASSWORD | 2285 | -p PASSWORD, --password=PASSWORD |
2286 | Enea uCPE Manager login password | 2286 | Enea Edge Management login password |
2287 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2287 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2288 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME | 2288 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME |
2289 | Custom Script Name that resides on a Device | 2289 | Custom Script Name that resides on a Device |
2290 | -e PHASE, --phase=PHASE | 2290 | -e PHASE, --phase=PHASE |
@@ -2300,8 +2300,8 @@ Options: | |||
2300 | <title>Configuring the JSON File</title> | 2300 | <title>Configuring the JSON File</title> |
2301 | 2301 | ||
2302 | <para>The JSON configuration file needed to remove a Custom Script | 2302 | <para>The JSON configuration file needed to remove a Custom Script |
2303 | from the uCPE Manager<remark>did you mean device or uCPE | 2303 | from the Enea Edge Management<remark>did you mean device or |
2304 | Manager?</remark> must contain a list of dictionaries. Each dictionary | 2304 | Enea Edge Management?</remark> must contain a list of dictionaries. Each dictionary |
2305 | indicates the test case name and the test case arguments passed to the | 2305 | indicates the test case name and the test case arguments passed to the |
2306 | <filename>customScripts/delete</filename> Python module.</para> | 2306 | <filename>customScripts/delete</filename> Python module.</para> |
2307 | 2307 | ||
@@ -2310,7 +2310,7 @@ Options: | |||
2310 | 2310 | ||
2311 | <programlisting>[ | 2311 | <programlisting>[ |
2312 | { | 2312 | { |
2313 | "name": "Removing a Custom Script from uCPE Manager", | 2313 | "name": "Removing a Custom Script from Enea Edge Management", |
2314 | "args": "-c test_success_after_always -e always-after-startup" | 2314 | "args": "-c test_success_after_always -e always-after-startup" |
2315 | } | 2315 | } |
2316 | ]</programlisting> | 2316 | ]</programlisting> |
@@ -2325,12 +2325,12 @@ Options: | |||
2325 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ | 2325 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ |
2326 | test_success_after_always -e always-after-startup | 2326 | test_success_after_always -e always-after-startup |
2327 | 2020-04-14 14:39:22,042 - DEBUG: Started logging | 2327 | 2020-04-14 14:39:22,042 - DEBUG: Started logging |
2328 | 2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager | 2328 | 2020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management |
2329 | 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' | 2329 | 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' |
2330 | 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f | 2330 | 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f |
2331 | 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' | 2331 | 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' |
2332 | 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ | 2332 | 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ |
2333 | phase always-after-startup from uCPE Manager | 2333 | phase always-after-startup from Enea Edge Management |
2334 | 2020-04-14 14:39:22,118 - INFO: Done | 2334 | 2020-04-14 14:39:22,118 - INFO: Done |
2335 | 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> | 2335 | 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> |
2336 | </section> | 2336 | </section> |
@@ -2355,10 +2355,10 @@ Options: | |||
2355 | --version show program's version number and exit | 2355 | --version show program's version number and exit |
2356 | -h, --help show this help message and exit | 2356 | -h, --help show this help message and exit |
2357 | -u USERNAME, --username=USERNAME | 2357 | -u USERNAME, --username=USERNAME |
2358 | Enea uCPE Manager login username | 2358 | Enea Edge Management login username |
2359 | -p PASSWORD, --password=PASSWORD | 2359 | -p PASSWORD, --password=PASSWORD |
2360 | Enea uCPE Manager login password | 2360 | Enea Edge Management login password |
2361 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2361 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2362 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME | 2362 | -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME |
2363 | Custom Script Name that resides on a Device | 2363 | Custom Script Name that resides on a Device |
2364 | -e PHASE, --phase=PHASE | 2364 | -e PHASE, --phase=PHASE |
@@ -2469,7 +2469,7 @@ phase always-after-startup from inteld1521-6 | |||
2469 | </note> | 2469 | </note> |
2470 | 2470 | ||
2471 | <section id="upload_customscrp_ucpemg"> | 2471 | <section id="upload_customscrp_ucpemg"> |
2472 | <title>Uploading a Custom Script to the uCPE Manager</title> | 2472 | <title>Uploading a Custom Script to the Enea Edge Management</title> |
2473 | 2473 | ||
2474 | <programlisting>$ python automation_framework/customScripts/upload.py \ | 2474 | <programlisting>$ python automation_framework/customScripts/upload.py \ |
2475 | -f lab_config/customScripts/test_success_after_always -e always-after-startup | 2475 | -f lab_config/customScripts/test_success_after_always -e always-after-startup |
@@ -2477,7 +2477,7 @@ phase always-after-startup from inteld1521-6 | |||
2477 | 2020-04-14 14:08:02,915 - INFO: Upload Custom Script | 2477 | 2020-04-14 14:08:02,915 - INFO: Upload Custom Script |
2478 | 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' | 2478 | 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' |
2479 | 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f | 2479 | 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f |
2480 | 2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ | 2480 | 2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \ |
2481 | Content: #!/bin/bash | 2481 | Content: #!/bin/bash |
2482 | echo test_success_after_always | 2482 | echo test_success_after_always |
2483 | 2020-04-14 14:08:03,138 - INFO: Done | 2483 | 2020-04-14 14:08:03,138 - INFO: Done |
@@ -2485,7 +2485,7 @@ echo test_success_after_always | |||
2485 | </section> | 2485 | </section> |
2486 | 2486 | ||
2487 | <section id="upload_customscrp_device"> | 2487 | <section id="upload_customscrp_device"> |
2488 | <title>Uploading a Custom Script from the uCPE Manager to a | 2488 | <title>Uploading a Custom Script from the Enea Edge Management to a |
2489 | Device</title> | 2489 | Device</title> |
2490 | 2490 | ||
2491 | <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \ | 2491 | <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \ |
@@ -2517,17 +2517,17 @@ phase always-after-startup from inteld1521-6 | |||
2517 | </section> | 2517 | </section> |
2518 | 2518 | ||
2519 | <section id="remove_customscrp_ucpemg"> | 2519 | <section id="remove_customscrp_ucpemg"> |
2520 | <title>Removing a Custom Script from the uCPE Manager</title> | 2520 | <title>Removing a Custom Script from the Enea Edge Management</title> |
2521 | 2521 | ||
2522 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ | 2522 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ |
2523 | test_success_after_always -e always-after-startup | 2523 | test_success_after_always -e always-after-startup |
2524 | 2020-04-14 14:39:22,042 - DEBUG: Started logging | 2524 | 2020-04-14 14:39:22,042 - DEBUG: Started logging |
2525 | 2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager | 2525 | 2020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management |
2526 | 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' | 2526 | 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' |
2527 | 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f | 2527 | 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f |
2528 | 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' | 2528 | 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' |
2529 | 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ | 2529 | 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ |
2530 | phase always-after-startup from uCPE Manager | 2530 | phase always-after-startup from Enea Edge Management |
2531 | 2020-04-14 14:39:22,118 - INFO: Done | 2531 | 2020-04-14 14:39:22,118 - INFO: Done |
2532 | 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> | 2532 | 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> |
2533 | </section> | 2533 | </section> |
@@ -2536,13 +2536,13 @@ phase always-after-startup from uCPE Manager | |||
2536 | <section id="add_offline_config_store"> | 2536 | <section id="add_offline_config_store"> |
2537 | <title>Adding an Offline Configuration Store</title> | 2537 | <title>Adding an Offline Configuration Store</title> |
2538 | 2538 | ||
2539 | <para>Steps and options on how to add a Config Store in the Enea uCPE | 2539 | <para>Steps and options on how to add a Config Store in the |
2540 | Manager are described below.</para> | 2540 | Enea Edge Management are described below.</para> |
2541 | 2541 | ||
2542 | <section id="script_opts_add_config_store"> | 2542 | <section id="script_opts_add_config_store"> |
2543 | <title>Script Options</title> | 2543 | <title>Script Options</title> |
2544 | 2544 | ||
2545 | <para>To add a config store in the Enea uCPE Manager use the | 2545 | <para>To add a config store in the Enea Edge Management use the |
2546 | <filename>addConfigStore.py</filename> script detailed below. Bear in | 2546 | <filename>addConfigStore.py</filename> script detailed below. Bear in |
2547 | mind a <filename>CONFIGSTORE</filename> json file is needed to | 2547 | mind a <filename>CONFIGSTORE</filename> json file is needed to |
2548 | successfully run the script in order to add an offline configuration | 2548 | successfully run the script in order to add an offline configuration |
@@ -2566,7 +2566,7 @@ phase always-after-startup from uCPE Manager | |||
2566 | <section id="runpy_add_config_store"> | 2566 | <section id="runpy_add_config_store"> |
2567 | <title>Running the Python Module</title> | 2567 | <title>Running the Python Module</title> |
2568 | 2568 | ||
2569 | <para>Adding an offline config store in the Enea uCPE Manager using | 2569 | <para>Adding an offline config store in the Enea Edge Management using |
2570 | the command line:</para> | 2570 | the command line:</para> |
2571 | 2571 | ||
2572 | <programlisting>python automation_framework/device/addConfigStore.py -f \ | 2572 | <programlisting>python automation_framework/device/addConfigStore.py -f \ |
@@ -2599,10 +2599,10 @@ Options: | |||
2599 | --version show program's version number and exit | 2599 | --version show program's version number and exit |
2600 | -h, --help show this help message and exit | 2600 | -h, --help show this help message and exit |
2601 | -u USERNAME, --username=USERNAME | 2601 | -u USERNAME, --username=USERNAME |
2602 | Enea uCPE Manager login username | 2602 | Enea Edge Management login username |
2603 | -p PASSWORD, --password=PASSWORD | 2603 | -p PASSWORD, --password=PASSWORD |
2604 | Enea uCPE Manager login password | 2604 | Enea Edge Management login password |
2605 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2605 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2606 | -s STORE, --store=STORE | 2606 | -s STORE, --store=STORE |
2607 | Offline config store name | 2607 | Offline config store name |
2608 | -d DEVICE, --device=DEVICE | 2608 | -d DEVICE, --device=DEVICE |
@@ -2645,10 +2645,10 @@ Options: | |||
2645 | --version show program's version number and exit | 2645 | --version show program's version number and exit |
2646 | -h, --help show this help message and exit | 2646 | -h, --help show this help message and exit |
2647 | -u USERNAME, --username=USERNAME | 2647 | -u USERNAME, --username=USERNAME |
2648 | Enea uCPE Manager login username | 2648 | Enea Edge Management login username |
2649 | -p PASSWORD, --password=PASSWORD | 2649 | -p PASSWORD, --password=PASSWORD |
2650 | Enea uCPE Manager login password | 2650 | Enea Edge Management login password |
2651 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2651 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2652 | -d DEVICE, --device=DEVICE | 2652 | -d DEVICE, --device=DEVICE |
2653 | Device Name | 2653 | Device Name |
2654 | 2654 | ||
@@ -2670,15 +2670,15 @@ Options: | |||
2670 | </section> | 2670 | </section> |
2671 | 2671 | ||
2672 | <section id="remove_offline_config_store"> | 2672 | <section id="remove_offline_config_store"> |
2673 | <title>Removing an Offline Configuration Store in the Enea uCPE | 2673 | <title>Removing an Offline Configuration Store in the |
2674 | Manager</title> | 2674 | Enea Edge Management</title> |
2675 | 2675 | ||
2676 | <para>Steps and options on how to remove an upload of a Config Store | 2676 | <para>Steps and options on how to remove an upload of a Config Store |
2677 | from the uCPE Manager are described below.</para> | 2677 | from the Enea Edge Management are described below.</para> |
2678 | 2678 | ||
2679 | <note> | 2679 | <note> |
2680 | <para>Modifications of an Offline Configurations Store are not | 2680 | <para>Modifications of an Offline Configurations Store are not |
2681 | possible post deployment in the uCPE Manager, as there is no option | 2681 | possible post deployment in the Enea Edge Management, as there is no option |
2682 | for changing script states (e.g. changing the DPDK state in the | 2682 | for changing script states (e.g. changing the DPDK state in the |
2683 | <filename>configDPDK.py</filename> python script or unbinding | 2683 | <filename>configDPDK.py</filename> python script or unbinding |
2684 | interfaces). The offline store must be deleted and the new | 2684 | interfaces). The offline store must be deleted and the new |
@@ -2689,23 +2689,23 @@ Options: | |||
2689 | <section id="script_opts_remove_config_store"> | 2689 | <section id="script_opts_remove_config_store"> |
2690 | <title>Script options</title> | 2690 | <title>Script options</title> |
2691 | 2691 | ||
2692 | <para>To remove a config store from the uCPE Manager use the | 2692 | <para>To remove a config store from the Enea Edge Management use the |
2693 | <filename>removeConfigStore.py</filename> script detailed | 2693 | <filename>removeConfigStore.py</filename> script detailed |
2694 | below.</para> | 2694 | below.</para> |
2695 | 2695 | ||
2696 | <programlisting>python removeConfigStore.py -h | 2696 | <programlisting>python removeConfigStore.py -h |
2697 | Usage: removeConfigStore.py [options] | 2697 | Usage: removeConfigStore.py [options] |
2698 | 2698 | ||
2699 | Remove a config store from Enea uCPE Manager. | 2699 | Remove a config store from Enea Edge Management. |
2700 | 2700 | ||
2701 | Options: | 2701 | Options: |
2702 | --version show program's version number and exit | 2702 | --version show program's version number and exit |
2703 | -h, --help show this help message and exit | 2703 | -h, --help show this help message and exit |
2704 | -u USERNAME, --username=USERNAME | 2704 | -u USERNAME, --username=USERNAME |
2705 | Enea uCPE Manager login username | 2705 | Enea Edge Management login username |
2706 | -p PASSWORD, --password=PASSWORD | 2706 | -p PASSWORD, --password=PASSWORD |
2707 | Enea uCPE Manager login password | 2707 | Enea Edge Management login password |
2708 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | 2708 | -H HOST, --host=HOST Enea Edge Management host name or IP address |
2709 | -o STORENAME, --store-name=STORENAME | 2709 | -o STORENAME, --store-name=STORENAME |
2710 | Name of the Offline Config Store | 2710 | Name of the Offline Config Store |
2711 | 2711 | ||
@@ -2770,8 +2770,8 @@ Options: | |||
2770 | Manual.</para> | 2770 | Manual.</para> |
2771 | 2771 | ||
2772 | <para>The /<literal>uCPEM_config</literal> directory stores JSON | 2772 | <para>The /<literal>uCPEM_config</literal> directory stores JSON |
2773 | configuration files needed for the setup of the uCPE Manager used by TH. | 2773 | configuration files needed for the setup of the Enea Edge Management used by TH. |
2774 | One configuration file is needed per uCPE Manager installation, to be used | 2774 | One configuration file is needed per Enea Edge Management installation, to be used |
2775 | in the TH.</para> | 2775 | in the TH.</para> |
2776 | 2776 | ||
2777 | <para>The <literal>/vnf_image</literal> directory stores the VNF Images | 2777 | <para>The <literal>/vnf_image</literal> directory stores the VNF Images |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml index 0b96de2..6398606 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_auto_fw_th_user_guide"> | 6 | <book id="book_enea_nfv_access_auto_fw_th_user_guide"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness User Guide</title> | 7 | <title><trademark class="registered">Enea</trademark> Enea Edge Automation Framework and Test Harness User Guide</title> |
8 | 8 | ||
9 | <subtitle>Release Version | 9 | <subtitle>Release Version |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
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 9b775a7..24a7a29 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 | |||
@@ -2,8 +2,8 @@ | |||
2 | <chapter id="components"> | 2 | <chapter id="components"> |
3 | <title>Components</title> | 3 | <title>Components</title> |
4 | 4 | ||
5 | <para>An overview of the Enea NFV Access Runtime Platform and the uCPE | 5 | <para>An overview of the Enea Edge Runtime and the Edge Management |
6 | Manager in cooperation with the Automation Framework and Test Harness, will | 6 | in cooperation with the Automation Framework and Test Harness, will |
7 | be presented in detail.</para> | 7 | be presented in detail.</para> |
8 | 8 | ||
9 | <figure> | 9 | <figure> |
@@ -18,23 +18,23 @@ | |||
18 | </figure> | 18 | </figure> |
19 | 19 | ||
20 | <section id="enfva_runtime_plt"> | 20 | <section id="enfva_runtime_plt"> |
21 | <title>Enea NFV Access</title> | 21 | <title>Enea Edge</title> |
22 | 22 | ||
23 | <para>Enea NFV Access is comprised of the Enea uCPE Manager and the Enea | 23 | <para>Enea Edge is comprised of the Enea Edge Management and the Enea |
24 | NFV Access Runtime Platform.</para> | 24 | Edge Runtime.</para> |
25 | 25 | ||
26 | <section id="eucpe_manager"> | 26 | <section id="eucpe_manager"> |
27 | <title>Enea uCPE Manager</title> | 27 | <title>Enea Edge Management</title> |
28 | 28 | ||
29 | <para>The Enea uCPE Manager application needs to be installed on a | 29 | <para>The Enea Edge Management application needs to be installed on a |
30 | supported platform. Upon installation, the system will be set up to | 30 | supported platform. Upon installation, the system will be set up to |
31 | manage Enea NFV Access "devices", these are the virtualized CPE devices | 31 | manage Enea Edge "devices", these are the virtualized CPE devices |
32 | used in testing.</para> | 32 | used in testing.</para> |
33 | 33 | ||
34 | <para>For more on Enea uCPE Manager installation instructions, please | 34 | <para>For more on Enea Edge Management installation instructions, please |
35 | refer to the section on how to <olink | 35 | refer to the section on how to <olink |
36 | targetdoc="book_enea_nfv_access_getting_started" | 36 | targetdoc="book_enea_nfv_access_getting_started" |
37 | targetptr="install_ucpe_mg">Installing the Enea uCPE Manager in the | 37 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in the |
38 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 38 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
39 | xmlns:xi="http://www.w3.org/2001/XInclude" | 39 | xmlns:xi="http://www.w3.org/2001/XInclude" |
40 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 40 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -42,38 +42,37 @@ | |||
42 | </section> | 42 | </section> |
43 | 43 | ||
44 | <section id="ena_plat"> | 44 | <section id="ena_plat"> |
45 | <title>Enea NFV Access Runtime Platform</title> | 45 | <title>Enea Edge Runtime</title> |
46 | 46 | ||
47 | <para>One or more uCPE devices running the Enea NFV Access Runtime | 47 | <para>One or more uCPE devices running the Enea Edge Runtime |
48 | Platform are required as hosts to run the VNF(s). The uCPE device is | 48 | are required as hosts to run the VNF(s). The uCPE device is |
49 | known to the uCPE Manager as the "VcpeAgent" device module.</para> | 49 | known to the Enea Edge Management as the "VcpeAgent" device module.</para> |
50 | 50 | ||
51 | <note> | 51 | <note> |
52 | <para>Before running any use case with the Automation Framework or the | 52 | <para>Before running any use case with the Automation Framework or the |
53 | Test Harness, make sure the uCPE device(s) have been added to the uCPE | 53 | Test Harness, make sure the uCPE device(s) have been added to the Edge Management.</para> |
54 | Manager.</para> | ||
55 | </note> | 54 | </note> |
56 | 55 | ||
57 | <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> |
58 | 57 | ||
59 | <itemizedlist> | 58 | <itemizedlist> |
60 | <listitem> | 59 | <listitem> |
61 | <para>Through the uCPE Manager GUI. Add the device using the | 60 | <para>Through the Enea Edge Management GUI. Add the device using the |
62 | appropriate parameters by launching the UI under | 61 | appropriate parameters by launching the UI under |
63 | <literal>Devices</literal> -> <literal>Manage</literal> in the | 62 | <literal>Devices</literal> -> <literal>Manage</literal> in the |
64 | main screen.</para> | 63 | main screen.</para> |
65 | </listitem> | 64 | </listitem> |
66 | 65 | ||
67 | <listitem> | 66 | <listitem> |
68 | <para>REST API. Invoke the uCPE Manager REST API to add a | 67 | <para>REST API. Invoke the Enea Edge Management REST API to add a |
69 | device.</para> | 68 | device.</para> |
70 | </listitem> | 69 | </listitem> |
71 | </itemizedlist> | 70 | </itemizedlist> |
72 | 71 | ||
73 | <para>For more on Enea NFV Access installation instructions, please | 72 | <para>For more on Enea Edge installation instructions, please |
74 | refer to chapter <olink targetdoc="book_enea_nfv_access_getting_started" | 73 | refer to chapter <olink targetdoc="book_enea_nfv_access_getting_started" |
75 | targetptr="prep_usb_ena">Preparing the USB stick for installation of the | 74 | targetptr="prep_usb_ena">Preparing the USB stick for installation of the |
76 | Enea NFV Access Runtime Platform in the <xi:include | 75 | Enea Edge Runtime in the <xi:include |
77 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 76 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
78 | xmlns:xi="http://www.w3.org/2001/XInclude" | 77 | xmlns:xi="http://www.w3.org/2001/XInclude" |
79 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 78 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -85,14 +84,14 @@ | |||
85 | <title>Automation Framework</title> | 84 | <title>Automation Framework</title> |
86 | 85 | ||
87 | <para>Testing can be performed by running the available Python scripts | 86 | <para>Testing can be performed by running the available Python scripts |
88 | against the uCPE Manager REST API (Python samples supplied). This can be | 87 | against the Enea Edge Management REST API (Python samples supplied). This can be |
89 | done by using the Python scripts individually or by using the Python | 88 | done by using the Python scripts individually or by using the Python |
90 | unit-test suite that is able to automatically run test-cases defined for | 89 | unit-test suite that is able to automatically run test-cases defined for |
91 | each available Python script.</para> | 90 | each available Python script.</para> |
92 | 91 | ||
93 | <para>In either case, it is desirable to use a different host (instead of | 92 | <para>In either case, it is desirable to use a different host (instead of |
94 | running the tests on the same system as the uCPE Manager) in order to | 93 | running the tests on the same system as the Enea Edge Management) in order to |
95 | ensure that the uCPE Manager is setup and installed correctly in terms of | 94 | ensure that the Enea Edge Management is setup and installed correctly in terms of |
96 | allowing external users to access it and use it effectively.</para> | 95 | allowing external users to access it and use it effectively.</para> |
97 | </section> | 96 | </section> |
98 | 97 | ||
@@ -102,7 +101,7 @@ | |||
102 | <para>The Test Harness (TH) provides a way for driving configuration with | 101 | <para>The Test Harness (TH) provides a way for driving configuration with |
103 | Ansible Playbooks, by running the python modules from the Automation | 102 | Ansible Playbooks, by running the python modules from the Automation |
104 | Framework (AF) and by direct connection over SSH to the boards that run | 103 | Framework (AF) and by direct connection over SSH to the boards that run |
105 | Enea NFV Access.</para> | 104 | Enea Edge.</para> |
106 | 105 | ||
107 | <para>The Test Harness includes an automated test suite that | 106 | <para>The Test Harness includes an automated test suite that |
108 | contains:</para> | 107 | contains:</para> |
@@ -110,14 +109,14 @@ | |||
110 | <itemizedlist> | 109 | <itemizedlist> |
111 | <listitem> | 110 | <listitem> |
112 | <para>VNF, Device and Network Smoke Test Cases. A sample test suite | 111 | <para>VNF, Device and Network Smoke Test Cases. A sample test suite |
113 | that acts as basic smoke tests for Enea NFV Access and also as a | 112 | that acts as basic smoke tests for Enea Edge and also as a |
114 | sanity-check test suite for the AF and TH.</para> | 113 | sanity-check test suite for the AF and TH.</para> |
115 | </listitem> | 114 | </listitem> |
116 | 115 | ||
117 | <listitem> | 116 | <listitem> |
118 | <para>VNF Deployment and Lifecycle. A sample test suite that verifies | 117 | <para>VNF Deployment and Lifecycle. A sample test suite that verifies |
119 | the instantiation, lifecycle control and destruction of a VNF for Enea | 118 | the instantiation, lifecycle control and destruction of a VNF for Enea |
120 | NFV Access.</para> | 119 | Edge.</para> |
121 | </listitem> | 120 | </listitem> |
122 | 121 | ||
123 | <listitem> | 122 | <listitem> |
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 eee6636..97666cf 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 | |||
@@ -29,7 +29,7 @@ | |||
29 | 29 | ||
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 Enea Edge Management installation, although this is |
33 | not encouraged. For more details see section <olink | 33 | not encouraged. For more details see section <olink |
34 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" | 34 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" |
35 | targetptr="automation">Automation Framework in the <xi:include | 35 | targetptr="automation">Automation Framework in the <xi:include |
@@ -69,7 +69,7 @@ | |||
69 | </listitem> | 69 | </listitem> |
70 | </itemizedlist></para> | 70 | </itemizedlist></para> |
71 | 71 | ||
72 | <para><emphasis role="bold">uCPE Manager Host | 72 | <para><emphasis role="bold">Enea Edge Management Host |
73 | Requirements</emphasis></para> | 73 | Requirements</emphasis></para> |
74 | 74 | ||
75 | <itemizedlist spacing="compact"> | 75 | <itemizedlist spacing="compact"> |
@@ -82,12 +82,12 @@ | |||
82 | </listitem> | 82 | </listitem> |
83 | 83 | ||
84 | <listitem> | 84 | <listitem> |
85 | <para>uCPE Manager installed.</para> | 85 | <para>Enea Edge Management installed.</para> |
86 | 86 | ||
87 | <note> | 87 | <note> |
88 | <para>For details on how to install the uCPE Manager, see <olink | 88 | <para>For details on how to install the Enea Edge Management, see <olink |
89 | targetdoc="book_enea_nfv_access_getting_started" | 89 | targetdoc="book_enea_nfv_access_getting_started" |
90 | targetptr="install_ucpe_mg">Installing the Enea uCPE Manager in the | 90 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in the |
91 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 91 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
92 | xmlns:xi="http://www.w3.org/2001/XInclude" | 92 | xmlns:xi="http://www.w3.org/2001/XInclude" |
93 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 93 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -111,13 +111,13 @@ | |||
111 | </listitem> | 111 | </listitem> |
112 | 112 | ||
113 | <listitem> | 113 | <listitem> |
114 | <para>Enea NFV Access Runtime Platform installed.</para> | 114 | <para>Enea Edge Runtime installed.</para> |
115 | 115 | ||
116 | <note> | 116 | <note> |
117 | <para>For information on how to install Enea NFV Access refer to | 117 | <para>For information on how to install Enea Edge refer to |
118 | <olink targetdoc="book_enea_nfv_access_getting_started" | 118 | <olink targetdoc="book_enea_nfv_access_getting_started" |
119 | targetptr="prep_usb_ena">Preparing the USB stick for installation | 119 | targetptr="prep_usb_ena">Preparing the USB stick for installation |
120 | of the Enea NFV Access Runtime Platform in the <xi:include | 120 | of the Enea Edge Runtime in the <xi:include |
121 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 121 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
122 | xmlns:xi="http://www.w3.org/2001/XInclude" | 122 | xmlns:xi="http://www.w3.org/2001/XInclude" |
123 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 123 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -155,7 +155,7 @@ | |||
155 | </listitem> | 155 | </listitem> |
156 | 156 | ||
157 | <listitem> | 157 | <listitem> |
158 | <para>Enea NFV Access Runtime Platform installed.</para> | 158 | <para>Enea Edge Runtime installed.</para> |
159 | </listitem> | 159 | </listitem> |
160 | </itemizedlist></para> | 160 | </itemizedlist></para> |
161 | </section> | 161 | </section> |
@@ -180,16 +180,16 @@ | |||
180 | </listitem> | 180 | </listitem> |
181 | 181 | ||
182 | <listitem> | 182 | <listitem> |
183 | <para>Set up the uCPE Manager which will be used by the TH:</para> | 183 | <para>Set up the Enea Edge Management which will be used by the TH:</para> |
184 | 184 | ||
185 | <orderedlist spacing="compact"> | 185 | <orderedlist spacing="compact"> |
186 | <listitem> | 186 | <listitem> |
187 | <para>Create the uCPE Manager JSON config file in the | 187 | <para>Create the Enea Edge Management JSON config file in the |
188 | <literal><AF-TH-install-dir>/uCPEM_config/</literal> | 188 | <literal><AF-TH-install-dir>/uCPEM_config/</literal> |
189 | directory:<programlisting>{ | 189 | directory:<programlisting>{ |
190 | "ucpe_usr":"uCPE Manager Username", | 190 | "ucpe_usr":"Enea Edge Management Username", |
191 | "ucpe_pass":"uCPE Manager Password", | 191 | "ucpe_pass":"Enea Edge Management Password", |
192 | "ucpe_host":"uCPE Manager IP/Hostname", | 192 | "ucpe_host":"Enea Edge Management IP/Hostname", |
193 | "ftp_usr":"FTP Username", | 193 | "ftp_usr":"FTP Username", |
194 | "ftp_pass":"FTP Password", | 194 | "ftp_pass":"FTP Password", |
195 | "ftp_port":"FTP Port" | 195 | "ftp_port":"FTP Port" |
@@ -225,10 +225,10 @@ | |||
225 | <literal>source | 225 | <literal>source |
226 | <AF-TH-install-dir>/testHarness-venv/bin/activate</literal>.</para> | 226 | <AF-TH-install-dir>/testHarness-venv/bin/activate</literal>.</para> |
227 | 227 | ||
228 | <para>Furthermore, if a user wants to use a new uCPE Manager instance for | 228 | <para>Furthermore, if a user wants to use a new Enea Edge Management instance for |
229 | a new session, the user also has to re-run the | 229 | a new session, the user also has to re-run the |
230 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding | 230 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding |
231 | JSON config for the new uCPE Manager instance.</para> | 231 | JSON config for the new Enea Edge Management instance.</para> |
232 | 232 | ||
233 | <note> | 233 | <note> |
234 | <para>Automation Framework and Test Harness History Information can be | 234 | <para>Automation Framework and Test Harness History Information can be |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml index eadc1d5..b2486a0 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml | |||
@@ -3,21 +3,20 @@ | |||
3 | <title>Overview</title> | 3 | <title>Overview</title> |
4 | 4 | ||
5 | <para>This document describes the Automation Framework and Test Harness for | 5 | <para>This document describes the Automation Framework and Test Harness for |
6 | Enea NFV Access, along with instructions regarding the necessary steps to | 6 | Enea Edge, along with instructions regarding the necessary steps to |
7 | run these software tools.</para> | 7 | run these software tools.</para> |
8 | 8 | ||
9 | <section id="descrip"> | 9 | <section id="descrip"> |
10 | <title>Description</title> | 10 | <title>Description</title> |
11 | 11 | ||
12 | <para>The Automation Framework provides a way for driving configuration | 12 | <para>The Automation Framework provides a way for driving configuration |
13 | with Python scripting. It complements the Enea uCPE Manager GUI and uses | 13 | with Python scripting. It complements the Enea Edge Management GUI and uses |
14 | the northbound REST APIs, given to provide full usability of the Enea uCPE | 14 | the northbound REST APIs, given to provide full usability of the Enea Management |
15 | Manager features.</para> | 15 | features.</para> |
16 | 16 | ||
17 | <para>The Test Harness is based on running Ansible Playbooks to complete | 17 | <para>The Test Harness is based on running Ansible Playbooks to complete |
18 | different test cases, which make use of the Automation Framework Python | 18 | different test cases, which make use of the Automation Framework Python |
19 | modules and/or direct commands on the uCPE devices running the Enea NFV | 19 | modules and/or direct commands on the uCPE devices running the Enea Edge Runtime.</para> |
20 | Access Runtime Platform.</para> | ||
21 | </section> | 20 | </section> |
22 | 21 | ||
23 | <section id="def_acro"> | 22 | <section id="def_acro"> |
@@ -39,10 +38,10 @@ | |||
39 | 38 | ||
40 | <tbody> | 39 | <tbody> |
41 | <row> | 40 | <row> |
42 | <entry>Enea NFV Access</entry> | 41 | <entry>Enea Edge</entry> |
43 | 42 | ||
44 | <entry>The Enea NFV Access (with ODM) Runtime Platform and the | 43 | <entry>The Enea Edge (with ODM) Runtime and the |
45 | Enea uCPE Manager.</entry> | 44 | Enea Edge Management.</entry> |
46 | </row> | 45 | </row> |
47 | </tbody> | 46 | </tbody> |
48 | </tgroup> | 47 | </tgroup> |
@@ -66,7 +65,7 @@ | |||
66 | <row> | 65 | <row> |
67 | <entry>AF</entry> | 66 | <entry>AF</entry> |
68 | 67 | ||
69 | <entry>Automation Framework for Enea NFV Access.</entry> | 68 | <entry>Automation Framework for Enea Edge.</entry> |
70 | </row> | 69 | </row> |
71 | 70 | ||
72 | <row> | 71 | <row> |
@@ -162,11 +161,11 @@ | |||
162 | <row> | 161 | <row> |
163 | <entry>TH</entry> | 162 | <entry>TH</entry> |
164 | 163 | ||
165 | <entry>Test Harness for Enea NFV Access.</entry> | 164 | <entry>Test Harness for Enea Edge.</entry> |
166 | </row> | 165 | </row> |
167 | 166 | ||
168 | <row> | 167 | <row> |
169 | <entry>uCPE Manager</entry> | 168 | <entry>Enea Edge Management</entry> |
170 | 169 | ||
171 | <entry>Enea Universal Customer Premises Equipment Manager.</entry> | 170 | <entry>Enea Universal Customer Premises Equipment Manager.</entry> |
172 | </row> | 171 | </row> |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml index f51fe11..a5cd664 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml | |||
@@ -21,11 +21,11 @@ | |||
21 | </listitem> | 21 | </listitem> |
22 | 22 | ||
23 | <listitem> | 23 | <listitem> |
24 | <para>When setting up the uCPE Manager to be used by the TH through the | 24 | <para>When setting up the Enea Edge Management to be used by the TH through the |
25 | <literal>setupuCPEManager.yml</literal> Playbook, if the uCPE | 25 | <literal>setupuCPEManager.yml</literal> Playbook, if the uCPE |
26 | username/password/host are incorrect or are missing, all the Sample test | 26 | username/password/host are incorrect or are missing, all the Sample test |
27 | cases will fail. If the FTP username/password/port are wrong or are | 27 | cases will fail. If the FTP username/password/port are wrong or are |
28 | missing, the tests that require file transfer to the uCPE Manager will | 28 | missing, the tests that require file transfer to the Enea Edge Management will |
29 | fail.</para> | 29 | fail.</para> |
30 | </listitem> | 30 | </listitem> |
31 | 31 | ||
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk b/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk index 9f0a075..6b65cff 100755 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-user-guide | 8 | BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-user-guide |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Automation Framework and Test Harness User Guide" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Enea Edge $(PROD_VER) Automation Framework and Test Harness User Guide" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
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 7ba8a7b..89692b0 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 | |||
@@ -68,7 +68,7 @@ | |||
68 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE | 68 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE |
69 | devices:</emphasis><orderedlist> | 69 | devices:</emphasis><orderedlist> |
70 | <listitem> | 70 | <listitem> |
71 | <para>Add the trgt uCPE device into the uCPE Manager: | 71 | <para>Add the trgt uCPE device into Enea Edge Management: |
72 | <literal>Devices -> Manage -> Add</literal>.</para> | 72 | <literal>Devices -> Manage -> Add</literal>.</para> |
73 | 73 | ||
74 | <para>Fill in the required fields with the following data:</para> | 74 | <para>Fill in the required fields with the following data:</para> |
@@ -266,8 +266,8 @@ | |||
266 | <entry>Create</entry> | 266 | <entry>Create</entry> |
267 | 267 | ||
268 | <entry><para>The system will automatically select the | 268 | <entry><para>The system will automatically select the |
269 | physical interface that has access to the uCPE | 269 | physical interface that has access to Enea Edge |
270 | Manager.</para></entry> | 270 | Management.</para></entry> |
271 | </row> | 271 | </row> |
272 | </tbody> | 272 | </tbody> |
273 | </tgroup> | 273 | </tgroup> |
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 45689e5..0e207ae 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 | |||
@@ -1,6 +1,6 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
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 and Test Harness</title> |
4 | 4 | ||
5 | <para>For more detailed information regarding the Automation Framework and | 5 | <para>For more detailed information regarding the Automation Framework and |
6 | Test Harness please see the <xi:include | 6 | Test Harness please see the <xi:include |
@@ -78,7 +78,7 @@ | |||
78 | 78 | ||
79 | <note> | 79 | <note> |
80 | <para>Before starting the two usecases detailed in the following appendix, | 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> | 81 | the uCPE Device needs to be added into Enea Edge Management.</para> |
82 | </note> | 82 | </note> |
83 | 83 | ||
84 | <para>To properly set up the Automation Framework and Test Harness please | 84 | <para>To properly set up the Automation Framework and Test Harness please |
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 71dee09..67f38e5 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 | |||
@@ -1,6 +1,6 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
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 and Test Harness</title> |
4 | 4 | ||
5 | <para>In order to run the following example usecases, certain configuration | 5 | <para>In order to run the following example usecases, certain configuration |
6 | file entries need to be modified according to the network setup that it will | 6 | file entries need to be modified according to the network setup that it will |
@@ -39,7 +39,7 @@ | |||
39 | "maintMode": "false", | 39 | "maintMode": "false", |
40 | "version": "2.2.3", | 40 | "version": "2.2.3", |
41 | "deviceId": "inteld1521-17" | 41 | "deviceId": "inteld1521-17" |
42 | }</programlisting>The IP address of the uCPE Manager that will be used in | 42 | }</programlisting>The IP address of Enea Edge Management that will be used in |
43 | these examples is <literal>172.24.3.92</literal>.</para> | 43 | these examples is <literal>172.24.3.92</literal>.</para> |
44 | 44 | ||
45 | <para>The FortiGate and 128T VNF images need to be copied into the | 45 | <para>The FortiGate and 128T VNF images need to be copied into the |
@@ -138,7 +138,7 @@ OK</programlisting> | |||
138 | 138 | ||
139 | <section id="ap_d_uc2"> | 139 | <section id="ap_d_uc2"> |
140 | <title>Use-case 2: Service Chaining 128T - Fortigate Example | 140 | <title>Use-case 2: Service Chaining 128T - Fortigate Example |
141 | Usecase</title> | 141 | Use-case</title> |
142 | 142 | ||
143 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \ | 143 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.92 -n inteld1521-17 \ |
144 | -s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" | 144 | -s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" |
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 eb8b0c8..9879c28 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/book.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_example_usecases"> | 6 | <book id="book_enea_nfv_access_example_usecases"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Example Use-cases</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Example Use-cases</title> |
8 | 8 | ||
9 | <subtitle>Release Version | 9 | <subtitle>Release Version |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml index 57c79b5..8895c23 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml | |||
@@ -42,7 +42,7 @@ | |||
42 | </listitem> | 42 | </listitem> |
43 | 43 | ||
44 | <listitem><para>VNF Configuration files. These files are provided with your Enea | 44 | <listitem><para>VNF Configuration files. These files are provided with your Enea |
45 | NFV Access release:</para> | 45 | Edge release:</para> |
46 | 46 | ||
47 | <itemizedlist spacing="compact"> | 47 | <itemizedlist spacing="compact"> |
48 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> | 48 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> |
@@ -333,7 +333,7 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting> | |||
333 | </listitem> | 333 | </listitem> |
334 | 334 | ||
335 | <listitem><para>VNF Configuration files. These files are provided with your Enea | 335 | <listitem><para>VNF Configuration files. These files are provided with your Enea |
336 | NFV Access release:</para> | 336 | Edge release:</para> |
337 | <itemizedlist spacing="compact"> | 337 | <itemizedlist spacing="compact"> |
338 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> | 338 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> |
339 | <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem> | 339 | <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem> |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml index 1f10dbf..bee5a63 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml | |||
@@ -17,7 +17,7 @@ | |||
17 | 17 | ||
18 | <itemizedlist> | 18 | <itemizedlist> |
19 | <listitem> | 19 | <listitem> |
20 | <para>2 Network Interfaces. One for the uCPE manager and one for data | 20 | <para>2 Network Interfaces. One for Enea Edge Management and one for data |
21 | traffic.</para> | 21 | traffic.</para> |
22 | </listitem> | 22 | </listitem> |
23 | 23 | ||
@@ -35,7 +35,7 @@ | |||
35 | </listitem> | 35 | </listitem> |
36 | 36 | ||
37 | <para>VNF Configuration files. These files are provided with your Enea | 37 | <para>VNF Configuration files. These files are provided with your Enea |
38 | NFV Access release:</para> | 38 | Edge release:</para> |
39 | 39 | ||
40 | <listitem> | 40 | <listitem> |
41 | <para><filename>enea-vnf-testpmd-fwd.conf</filename>.</para> | 41 | <para><filename>enea-vnf-testpmd-fwd.conf</filename>.</para> |
@@ -134,7 +134,7 @@ | |||
134 | 134 | ||
135 | <orderedlist> | 135 | <orderedlist> |
136 | <listitem> | 136 | <listitem> |
137 | <para>Instantiate the Enea NFV Access TestPMD forwarding VNF on uCPE | 137 | <para>Instantiate the Enea Edge TestPMD forwarding VNF on uCPE |
138 | Device 2 by filling the required fields with the following | 138 | Device 2 by filling the required fields with the following |
139 | values:</para> | 139 | values:</para> |
140 | 140 | ||
@@ -168,7 +168,7 @@ | |||
168 | </listitem> | 168 | </listitem> |
169 | 169 | ||
170 | <listitem> | 170 | <listitem> |
171 | <para>Instantiate the Enea NFV Access TestPMD termination VNF on | 171 | <para>Instantiate the Enea Edge TestPMD termination VNF on |
172 | uCPE Device 2 by filling the required fields with the following | 172 | uCPE Device 2 by filling the required fields with the following |
173 | values:</para> | 173 | values:</para> |
174 | 174 | ||
@@ -218,8 +218,8 @@ | |||
218 | <literal>testpmd_term</literal>.</para> | 218 | <literal>testpmd_term</literal>.</para> |
219 | 219 | ||
220 | <note> | 220 | <note> |
221 | <para>The flow rules can be described using either the uCPE | 221 | <para>The flow rules can be described using either the Enea Edge |
222 | manager interface or the configuration files.</para> | 222 | Management interface or the configuration files.</para> |
223 | </note> | 223 | </note> |
224 | </listitem> | 224 | </listitem> |
225 | </itemizedlist> | 225 | </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 36c7114..bb38140 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 | |||
@@ -50,7 +50,7 @@ | |||
50 | </listitem> | 50 | </listitem> |
51 | 51 | ||
52 | <listitem> | 52 | <listitem> |
53 | <para>VNF Configuration file(s), provided with your Enea NFV Access | 53 | <para>VNF Configuration file(s), provided with your Enea Edge |
54 | release: <filename>fortigate-basic-fw.conf</filename>.</para> | 54 | release: <filename>fortigate-basic-fw.conf</filename>.</para> |
55 | </listitem> | 55 | </listitem> |
56 | </itemizedlist> | 56 | </itemizedlist> |
@@ -93,7 +93,7 @@ | |||
93 | </listitem> | 93 | </listitem> |
94 | 94 | ||
95 | <listitem> | 95 | <listitem> |
96 | <para>Connect ETH0 to the Lab Network (for Enea uCPE Manager | 96 | <para>Connect ETH0 to the Lab Network (for Enea Edge Management |
97 | communications).</para> | 97 | communications).</para> |
98 | </listitem> | 98 | </listitem> |
99 | 99 | ||
@@ -302,7 +302,7 @@ | |||
302 | </listitem> | 302 | </listitem> |
303 | 303 | ||
304 | <listitem> | 304 | <listitem> |
305 | <para>VNF Configuration file(s), provided with your Enea NFV Access | 305 | <para>VNF Configuration file(s), provided with your Enea Edge |
306 | release: <filename>fortigate-sdwan<x>.conf</filename>.</para> | 306 | release: <filename>fortigate-sdwan<x>.conf</filename>.</para> |
307 | </listitem> | 307 | </listitem> |
308 | </itemizedlist> | 308 | </itemizedlist> |
@@ -359,7 +359,7 @@ | |||
359 | 359 | ||
360 | <listitem> | 360 | <listitem> |
361 | <para>Connect the <literal>ETH0</literal> interfaces to the Lab | 361 | <para>Connect the <literal>ETH0</literal> interfaces to the Lab |
362 | Network (for Enea uCPE Manager communications).</para> | 362 | Network (for Enea Edge Management communications).</para> |
363 | </listitem> | 363 | </listitem> |
364 | 364 | ||
365 | <listitem> | 365 | <listitem> |
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 fc3559b..b502e8b 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml | |||
@@ -7,8 +7,8 @@ | |||
7 | etc.</para> | 7 | etc.</para> |
8 | 8 | ||
9 | <para>Before running any example use case make sure the uCPE device(s) have | 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 | 10 | been added to Enea Edge Management and placed on the map. For detailed |
11 | information on how to add a device to the uCPE Manager, how to configure the | 11 | information on how to add a device to Enea Edge Management, how to configure the |
12 | network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, or VNF | 12 | network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, or VNF |
13 | configuration, please refer to the <xi:include | 13 | configuration, please refer to the <xi:include |
14 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 14 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
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 1f3a6ce..bb05905 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 | |||
@@ -3,7 +3,7 @@ | |||
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 following is an example of how to setup and configure a service | 5 | <para>The following is an example of how to setup and configure a service |
6 | chain on top of the Enea NFV Access virtualization platform, using the | 6 | chain on top of the Enea Edge Runtime, using the |
7 | following commercial VNFs: 128T router and FortiGate.</para> | 7 | following commercial VNFs: 128T router and FortiGate.</para> |
8 | 8 | ||
9 | <section id="prereq_serv_chain_cust"> | 9 | <section id="prereq_serv_chain_cust"> |
@@ -86,7 +86,7 @@ | |||
86 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE | 86 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE |
87 | devices:</emphasis><orderedlist> | 87 | devices:</emphasis><orderedlist> |
88 | <listitem> | 88 | <listitem> |
89 | <para>Add the trgt uCPE device into the uCPE Manager: | 89 | <para>Add the trgt uCPE device into Enea Edge Management: |
90 | <literal>Devices -> Manage -> Add</literal>, and fill in the | 90 | <literal>Devices -> Manage -> Add</literal>, and fill in the |
91 | required fields with the following data:</para> | 91 | required fields with the following data:</para> |
92 | 92 | ||
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 8b82337..24442af 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 | |||
@@ -11,9 +11,9 @@ | |||
11 | 11 | ||
12 | <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 |
13 | branch-to-branch service comprised on two commercial VNFs (SD-WAN + | 13 | branch-to-branch service comprised on two commercial VNFs (SD-WAN + |
14 | 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 |
15 | Access virtualization platform, deployed through the Enea uCPE | 15 | Edge Runtime, deployed through the Enea Edge |
16 | Manager.</para> | 16 | Management.</para> |
17 | 17 | ||
18 | <para>In the example setup the following commercial VNFs are used: Juniper | 18 | <para>In the example setup the following commercial VNFs are used: Juniper |
19 | vSRX as the SD-WAN VNF and Fortigate as the Router/Firewall.</para> | 19 | vSRX as the SD-WAN VNF and Fortigate as the Router/Firewall.</para> |
@@ -61,7 +61,7 @@ | |||
61 | </listitem> | 61 | </listitem> |
62 | 62 | ||
63 | <listitem> | 63 | <listitem> |
64 | <para>VNF Configuration files, provided with your Enea NFV Access | 64 | <para>VNF Configuration files, provided with your Enea Edge |
65 | Release:</para> | 65 | Release:</para> |
66 | 66 | ||
67 | <itemizedlist spacing="compact"> | 67 | <itemizedlist spacing="compact"> |
@@ -152,7 +152,7 @@ | |||
152 | <para>The networking setup (Steps 1-3) can be modeled using the | 152 | <para>The networking setup (Steps 1-3) can be modeled using the |
153 | Offline Configuration entry, so that it is automatically | 153 | Offline Configuration entry, so that it is automatically |
154 | provisioned on the uCPE device, once it gets enrolled into the | 154 | provisioned on the uCPE device, once it gets enrolled into the |
155 | management system (uCPE Manager).</para> | 155 | management system (Enea Edge Management).</para> |
156 | </note> | 156 | </note> |
157 | </listitem> | 157 | </listitem> |
158 | </orderedlist> | 158 | </orderedlist> |
diff --git a/doc/book-enea-nfv-access-example-usecases/swcomp.mk b/doc/book-enea-nfv-access-example-usecases/swcomp.mk index 972746a..5f5ab16 100755 --- a/doc/book-enea-nfv-access-example-usecases/swcomp.mk +++ b/doc/book-enea-nfv-access-example-usecases/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-example-usecases | 8 | BOOKPACKAGES := book-enea-nfv-access-example-usecases |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Example Use-cases" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Example Use-cases" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
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 cb0ae5b..70a9978 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 | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <chapter id="advanced_conf"> | 4 | <chapter id="advanced_conf"> |
@@ -12,26 +12,24 @@ | |||
12 | <title>Bare Metal Provisioning</title> | 12 | <title>Bare Metal Provisioning</title> |
13 | 13 | ||
14 | <para>Bare Metal Provisioning can be used for automated deployment of the | 14 | <para>Bare Metal Provisioning can be used for automated deployment of the |
15 | Enea NFV Access Runtime Platform on a large number of uCPE devices. The | 15 | Enea Edge Runtime on a large number of uCPE devices. The uCPE devices may |
16 | uCPE devices may have no previous operating system installed, or are | 16 | have no previous operating system installed, or are reinstalled without |
17 | reinstalled without preserving any existing data. Enea NFV Access Bare | 17 | preserving any existing data. Enea Edge Bare Metal Provisioning is based |
18 | Metal Provisioning is based on standardized Pre-Boot Execution environment | 18 | on standardized Pre-Boot Execution environment (PXE) booting.</para> |
19 | (PXE) booting.</para> | ||
20 | 19 | ||
21 | <para>The Bare Metal Provisioning process begins by PXE booting an Enea | 20 | <para>The Bare Metal Provisioning process begins by PXE booting an Enea |
22 | NFV Access installer <literal>initramfs</literal> image. The installer | 21 | Edge installer <literal>initramfs</literal> image. The installer downloads |
23 | downloads a configuration file, as well as the Enea NFV Access Runtime | 22 | a configuration file, as well as the Enea Edge Runtime image and then |
24 | Platform image and then proceeds to install the system by dividing the | 23 | proceeds to install the system by dividing the disk into 2 partitions: a |
25 | disk into 2 partitions: a GPT partition containing the GRUB boot loader | 24 | GPT partition containing the GRUB boot loader and a second partition |
26 | and a second partition containing the Enea NFV Access Runtime Platform | 25 | containing the Enea Edge Runtime root filesystem. When the installation is |
27 | root filesystem. When the installation is complete, the uCPE device is | 26 | complete, the uCPE device is automatically rebooted into Enea Edge |
28 | automatically rebooted into Enea NFV Access Runtime Platform.</para> | 27 | Runtime.</para> |
29 | 28 | ||
30 | <note> | 29 | <note> |
31 | <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and | 30 | <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and |
32 | <literal>bzImage</literal> files are available in the | 31 | <literal>bzImage</literal> files are available in the |
33 | <filename>Enea_NFV_Access_Run_Time_Platform_ | 32 | <filename>Enea_Edge_Runtime_<processor>_<version>-<build_number>.tar.gz</filename> |
34 | <processor>_<version>-<build_number>.tar.gz</filename> | ||
35 | file you downloaded with your release.</para> | 33 | file you downloaded with your release.</para> |
36 | </note> | 34 | </note> |
37 | 35 | ||
@@ -56,16 +54,15 @@ | |||
56 | 54 | ||
57 | <listitem> | 55 | <listitem> |
58 | <para>The uCPE devices are preconfigured in BIOS to boot from the | 56 | <para>The uCPE devices are preconfigured in BIOS to boot from the |
59 | hard drive where the Enea NFV Access Runtime Platform will be | 57 | hard drive where the Enea Edge Runtime will be installed.</para> |
60 | installed.</para> | ||
61 | </listitem> | 58 | </listitem> |
62 | 59 | ||
63 | <listitem> | 60 | <listitem> |
64 | <para>CSM support and Dual Boot must be enabled in BIOS (i.e. PXE | 61 | <para>CSM support and Dual Boot must be enabled in BIOS (i.e. PXE |
65 | booting in legacy mode), while the final Enea NFV Access image will | 62 | booting in legacy mode), while the final Enea Edge Runtime image |
66 | boot in UEFI mode. Doing a mass deployment using legacy PXE booting | 63 | will boot in UEFI mode. Doing a mass deployment using legacy PXE |
67 | usually means that Secure Boot is disabled, Secure Boot will need to | 64 | booting usually means that Secure Boot is disabled, Secure Boot will |
68 | be enabled afterwards.</para> | 65 | need to be enabled afterwards.</para> |
69 | </listitem> | 66 | </listitem> |
70 | 67 | ||
71 | <listitem> | 68 | <listitem> |
@@ -80,23 +77,22 @@ | |||
80 | <section id="bare_meta_prov_server"> | 77 | <section id="bare_meta_prov_server"> |
81 | <title>Server Configuration</title> | 78 | <title>Server Configuration</title> |
82 | 79 | ||
83 | <para>The following images provided with your Enea NFV Access release | 80 | <para>The following images provided with your Enea Edge release need to |
84 | need to be made available on the PXE and HTTP servers:</para> | 81 | be made available on the PXE and HTTP servers:</para> |
85 | 82 | ||
86 | <orderedlist> | 83 | <orderedlist> |
87 | <listitem> | 84 | <listitem> |
88 | <para>Copy the Enea NFV Access installer | 85 | <para>Copy the Enea Edge installer <literal>initramfs</literal> |
89 | <literal>initramfs</literal> image and kernel | 86 | image and kernel <literal>bzImage</literal> for your uCPE device |
90 | <literal>bzImage</literal> for your uCPE device architecture to the | 87 | architecture to the TFTP directory on the PXE server (e.g |
91 | TFTP directory on the PXE server (e.g | ||
92 | <literal>/var/lib/tftpboot</literal>).</para> | 88 | <literal>/var/lib/tftpboot</literal>).</para> |
93 | </listitem> | 89 | </listitem> |
94 | 90 | ||
95 | <listitem> | 91 | <listitem> |
96 | <para>Compress the Enea NFV Access Runtime Platform | 92 | <para>Compress the Enea Edge Runtime <literal>.hddimg</literal> |
97 | <literal>.hddimg</literal> image for the uCPE device architecture | 93 | image for the uCPE device architecture using <literal>gzip</literal> |
98 | using <literal>gzip</literal> and copy the resulting | 94 | and copy the resulting <literal>hddimg.gz</literal> file to the HTTP |
99 | <literal>hddimg.gz</literal> file to the HTTP server.</para> | 95 | server.</para> |
100 | </listitem> | 96 | </listitem> |
101 | </orderedlist> | 97 | </orderedlist> |
102 | 98 | ||
@@ -113,7 +109,7 @@ | |||
113 | <itemizedlist> | 109 | <itemizedlist> |
114 | <listitem> | 110 | <listitem> |
115 | <para><literal>image_url</literal>. The HTTP server URL used for | 111 | <para><literal>image_url</literal>. The HTTP server URL used for |
116 | downloading the Enea NFV Access Runtime Platform image.</para> | 112 | downloading the Enea Edge Runtime image.</para> |
117 | </listitem> | 113 | </listitem> |
118 | </itemizedlist> | 114 | </itemizedlist> |
119 | 115 | ||
@@ -122,7 +118,7 @@ | |||
122 | <itemizedlist> | 118 | <itemizedlist> |
123 | <listitem> | 119 | <listitem> |
124 | <para><literal>install_drive</literal>. The name of the drive | 120 | <para><literal>install_drive</literal>. The name of the drive |
125 | where the Enea NFV Access Runtime Platform will be installed (e.g | 121 | where the Enea Edge Runtime will be installed (e.g |
126 | <literal>/dev/sda</literal>). If not set, the installer will use | 122 | <literal>/dev/sda</literal>). If not set, the installer will use |
127 | the largest detected (non-USB) drive on the uCPE device.</para> | 123 | the largest detected (non-USB) drive on the uCPE device.</para> |
128 | </listitem> | 124 | </listitem> |
@@ -149,10 +145,10 @@ install_drive = /dev/sda</programlisting> | |||
149 | <section id="bare_meta_prov_pxe"> | 145 | <section id="bare_meta_prov_pxe"> |
150 | <title>PXE Configuration</title> | 146 | <title>PXE Configuration</title> |
151 | 147 | ||
152 | <para>A PXE entry for the Enea NFV Access installation needs to be | 148 | <para>A PXE entry for the Enea Edge installation needs to be added as |
153 | added as the default boot selection in the pxelinux configuration file | 149 | the default boot selection in the pxelinux configuration file (e.g |
154 | (e.g <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The | 150 | <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The PXE |
155 | PXE entry should have the following settings:</para> | 151 | entry should have the following settings:</para> |
156 | 152 | ||
157 | <programlisting>default nfv_access | 153 | <programlisting>default nfv_access |
158 | label nfv_access | 154 | label nfv_access |
@@ -179,8 +175,8 @@ ipappend 2</programlisting> | |||
179 | ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset </programlisting> | 175 | ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset </programlisting> |
180 | 176 | ||
181 | <para>The uCPE devices should be configured in BIOS to boot from the | 177 | <para>The uCPE devices should be configured in BIOS to boot from the |
182 | installation drive first in order to automatically start the Enea NFV | 178 | installation drive first in order to automatically start the Enea Edge |
183 | Access Runtime Platform when the installation is finished.</para> | 179 | Runtime when the installation is finished.</para> |
184 | </section> | 180 | </section> |
185 | </section> | 181 | </section> |
186 | 182 | ||
@@ -205,7 +201,7 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address& | |||
205 | <section id="secure_boot_keys"> | 201 | <section id="secure_boot_keys"> |
206 | <title>Enabling UEFI Secure Boot</title> | 202 | <title>Enabling UEFI Secure Boot</title> |
207 | 203 | ||
208 | <para>All Enea NFV Access image artifacts delivered with the release are | 204 | <para>All Enea Edge image artifacts delivered with the release are |
209 | signed using the Enea UEFI Secure boot private keys. These artifacts can | 205 | signed using the Enea UEFI Secure boot private keys. These artifacts can |
210 | be used on a uCPE device that doesn't have Secure Boot enabled. To use | 206 | be used on a uCPE device that doesn't have Secure Boot enabled. To use |
211 | the Secure Boot feature, however, the user must make the Enea UEFI | 207 | the Secure Boot feature, however, the user must make the Enea UEFI |
@@ -247,9 +243,9 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address& | |||
247 | </itemizedlist> | 243 | </itemizedlist> |
248 | 244 | ||
249 | <para>The Enea UEFI Secure Boot certificates are installed together | 245 | <para>The Enea UEFI Secure Boot certificates are installed together |
250 | with the Enea NFV Access Runtime Platform onto the hard drive. They | 246 | with the Enea Edge Runtime onto the hard drive. They can be found on |
251 | can be found on the EFI partition (usually the first partition of the | 247 | the EFI partition (usually the first partition of the drive) under |
252 | drive) under <literal>/uefi_sb_keys</literal>.</para> | 248 | <literal>/uefi_sb_keys</literal>.</para> |
253 | 249 | ||
254 | <para>These certificates need to be manually enrolled in BIOS. The | 250 | <para>These certificates need to be manually enrolled in BIOS. The |
255 | exact details on how to proceed may vary depending the version of the | 251 | exact details on how to proceed may vary depending the version of the |
@@ -278,12 +274,12 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address& | |||
278 | are contiguous blocks of memory that come in 2MB or 1GB sizes. By using | 274 | are contiguous blocks of memory that come in 2MB or 1GB sizes. By using |
279 | huge page allocations, less memory is used for page tables and the | 275 | huge page allocations, less memory is used for page tables and the |
280 | Translation Lookaside Buffer (TLB) miss rate is significantly reduced. | 276 | Translation Lookaside Buffer (TLB) miss rate is significantly reduced. |
281 | Enea NFV Access uses huge page backed memory in KVM guests in order to | 277 | Enea Edge Runtime uses huge page backed memory in KVM guests in order to |
282 | improve performance.</para> | 278 | improve performance.</para> |
283 | 279 | ||
284 | <para>Enea NFV Access implements an automatic hugepage allocation service | 280 | <para>Enea Edge Runtime implements an automatic hugepage allocation |
285 | that is triggered at each startup. The service is skipped if hugepages | 281 | service that is triggered at each startup. The service is skipped if |
286 | have been allocated in the kernel boot command line.</para> | 282 | hugepages have been allocated in the kernel boot command line.</para> |
287 | 283 | ||
288 | <para>There are two strategies outlined for hugepage allocation:</para> | 284 | <para>There are two strategies outlined for hugepage allocation:</para> |
289 | 285 | ||
@@ -422,11 +418,12 @@ node0.1048576kB = 3 </programlisting> | |||
422 | </section> | 418 | </section> |
423 | 419 | ||
424 | <section id="high_availability_ig"> | 420 | <section id="high_availability_ig"> |
425 | <title>Installing the Enea uCPE Manager in High Availability Mode</title> | 421 | <title>Installing the Enea Edge Management in High Availability |
422 | Mode</title> | ||
426 | 423 | ||
427 | <para>The following describes the setup needed for running the Enea uCPE | 424 | <para>The following describes the setup needed for running the Enea Edge |
428 | Manager in High Availabilty (HA) mode, with a MariaDB database cluster. A | 425 | Management in High Availabilty (HA) mode, with a MariaDB database cluster. |
429 | setup example is illustrated in the diagram below.</para> | 426 | A setup example is illustrated in the diagram below.</para> |
430 | 427 | ||
431 | <figure> | 428 | <figure> |
432 | <title>The High Availability setup</title> | 429 | <title>The High Availability setup</title> |
@@ -442,17 +439,17 @@ node0.1048576kB = 3 </programlisting> | |||
442 | <para>The setup consists of two sub-clusters, placed in different | 439 | <para>The setup consists of two sub-clusters, placed in different |
443 | geographical locations, each consisting of three MariaDB servers. In this | 440 | geographical locations, each consisting of three MariaDB servers. In this |
444 | example, two of the machines are running only MariaDB, while the rest are | 441 | example, two of the machines are running only MariaDB, while the rest are |
445 | hosting a MariaDB server and an Enea uCPE Manager instance. The entire | 442 | hosting a MariaDB server and an Enea Edge Management instance. The entire |
446 | network is hidden behind a firewall that performs NAT. While in protection | 443 | network is hidden behind a firewall that performs NAT. While in protection |
447 | (cluster) mode, the Enea uCPE Manager instances promote a Virtual IP (VIP) | 444 | (cluster) mode, the Enea Edge Management instances promote a Virtual IP |
448 | that represents the IP address of the entire cluster. The firewall in this | 445 | (VIP) that represents the IP address of the entire cluster. The firewall |
449 | case will allocate a public IP for the outside world that will be | 446 | in this case will allocate a public IP for the outside world that will be |
450 | translated into the VIP. Also in this example, the traffic towards the | 447 | translated into the VIP. Also in this example, the traffic towards the |
451 | cluster from outside the firewall is done through HTTPS, which will be | 448 | cluster from outside the firewall is done through HTTPS, which will be |
452 | translated to HTTP inside the private network.</para> | 449 | translated to HTTP inside the private network.</para> |
453 | 450 | ||
454 | <note> | 451 | <note> |
455 | <para>By default, communication to the Enea uCPE Manager is done with | 452 | <para>By default, communication to the Enea Edge Management is done with |
456 | HTTPS. To enable HTTP, go to <emphasis role="bold">System</emphasis>, | 453 | HTTPS. To enable HTTP, go to <emphasis role="bold">System</emphasis>, |
457 | <emphasis role="bold">Configuration</emphasis>, click on the <emphasis | 454 | <emphasis role="bold">Configuration</emphasis>, click on the <emphasis |
458 | role="bold">Web Access</emphasis> tab and check the <emphasis | 455 | role="bold">Web Access</emphasis> tab and check the <emphasis |
@@ -467,7 +464,7 @@ node0.1048576kB = 3 </programlisting> | |||
467 | 464 | ||
468 | <itemizedlist> | 465 | <itemizedlist> |
469 | <listitem> | 466 | <listitem> |
470 | <para>Machines running the Enea uCPE Manager and MariaDB:</para> | 467 | <para>Machines running the Enea Edge Management and MariaDB:</para> |
471 | 468 | ||
472 | <itemizedlist spacing="compact"> | 469 | <itemizedlist spacing="compact"> |
473 | <listitem> | 470 | <listitem> |
@@ -509,9 +506,9 @@ node0.1048576kB = 3 </programlisting> | |||
509 | 506 | ||
510 | <para>Please refer to <olink | 507 | <para>Please refer to <olink |
511 | targetdoc="book_enea_nfv_access_getting_started" | 508 | targetdoc="book_enea_nfv_access_getting_started" |
512 | targetptr="firewall_config">Firewall Configuration in the <ns:include | 509 | targetptr="firewall_config">Firewall Configuration in the <xi:include |
513 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 510 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
514 | xmlns:ns="http://www.w3.org/2001/XInclude" | 511 | xmlns:xi="http://www.w3.org/2001/XInclude" |
515 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 512 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
516 | Manual. In addition, the following configuration is needed:</para> | 513 | Manual. In addition, the following configuration is needed:</para> |
517 | 514 | ||
@@ -533,10 +530,10 @@ SELINUXTYPE=targeted</programlisting> | |||
533 | </orderedlist> | 530 | </orderedlist> |
534 | 531 | ||
535 | <para>The following ports should be opened in the local firewall (not | 532 | <para>The following ports should be opened in the local firewall (not |
536 | the one doing NAT), for each Enea uCPE Manager machine:</para> | 533 | the one doing NAT), for each Enea Edge Management machine:</para> |
537 | 534 | ||
538 | <table> | 535 | <table> |
539 | <title>Ports for Enea uCPE Manager Machines</title> | 536 | <title>Ports for Enea Edge Management Machines</title> |
540 | 537 | ||
541 | <tgroup cols="2"> | 538 | <tgroup cols="2"> |
542 | <colspec align="left" /> | 539 | <colspec align="left" /> |
@@ -590,7 +587,7 @@ SELINUXTYPE=targeted</programlisting> | |||
590 | </table> | 587 | </table> |
591 | 588 | ||
592 | <para>For MariaDB, the following ports must be opened (on each MariaDB | 589 | <para>For MariaDB, the following ports must be opened (on each MariaDB |
593 | server, including the ones hosting the Enea uCPE Manager):</para> | 590 | server, including the ones hosting the Enea Edge Management):</para> |
594 | 591 | ||
595 | <table> | 592 | <table> |
596 | <title>Ports for MariaDB Machines</title> | 593 | <title>Ports for MariaDB Machines</title> |
@@ -685,9 +682,9 @@ SELINUXTYPE=targeted</programlisting> | |||
685 | <section id="ha_installation"> | 682 | <section id="ha_installation"> |
686 | <title>Installing High Availability</title> | 683 | <title>Installing High Availability</title> |
687 | 684 | ||
688 | <para>The Enea uCPE Manager can be installed in High Availability mode | 685 | <para>The Enea Edge Management can be installed in High Availability |
689 | with a MariaDB database cluster by performing the following steps. The | 686 | mode with a MariaDB database cluster by performing the following steps. |
690 | mandatory Java configuration is also detailed.</para> | 687 | The mandatory Java configuration is also detailed.</para> |
691 | 688 | ||
692 | <section id="ha_mariadb"> | 689 | <section id="ha_mariadb"> |
693 | <title>Installing and configuring the MariaDB cluster</title> | 690 | <title>Installing and configuring the MariaDB cluster</title> |
@@ -825,20 +822,20 @@ Switch to unix_socket authentication [Y/n] <emphasis role="bold">Y</emphasis> | |||
825 | Enabled successfully! | 822 | Enabled successfully! |
826 | Reloading privilege tables.. | 823 | Reloading privilege tables.. |
827 | ... Success! | 824 | ... Success! |
828 | … | 825 | … |
829 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> | 826 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> |
830 | New password: | 827 | New password: |
831 | Re-enter new password: | 828 | Re-enter new password: |
832 | Password updated successfully! | 829 | Password updated successfully! |
833 | Reloading privilege tables.. | 830 | Reloading privilege tables.. |
834 | ... Success! | 831 | ... Success! |
835 | … | 832 | … |
836 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> | 833 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> |
837 | ... Success! | 834 | ... Success! |
838 | … | 835 | … |
839 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> | 836 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> |
840 | ... Success! | 837 | ... Success! |
841 | … | 838 | … |
842 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> | 839 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> |
843 | - Dropping test database... | 840 | - Dropping test database... |
844 | ... Success! | 841 | ... Success! |
@@ -875,9 +872,9 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
875 | <para>Please refer to <olink | 872 | <para>Please refer to <olink |
876 | targetdoc="book_enea_nfv_access_getting_started" | 873 | targetdoc="book_enea_nfv_access_getting_started" |
877 | targetptr="openjdk_postgresql_config">Configuring OpenJDK and | 874 | targetptr="openjdk_postgresql_config">Configuring OpenJDK and |
878 | PostgreSQL in the <ns:include | 875 | PostgreSQL in the <xi:include |
879 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 876 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
880 | xmlns:ns="http://www.w3.org/2001/XInclude" | 877 | xmlns:xi="http://www.w3.org/2001/XInclude" |
881 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 878 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
882 | Manual, for details on how to install and configure Java | 879 | Manual, for details on how to install and configure Java |
883 | OpenJDK.</para> | 880 | OpenJDK.</para> |
@@ -891,16 +888,16 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
891 | </section> | 888 | </section> |
892 | 889 | ||
893 | <section id="ha_ucpe_mg"> | 890 | <section id="ha_ucpe_mg"> |
894 | <title>Installing the Enea uCPE Manager in High Availabilty | 891 | <title>Installing the Enea Edge Management in High Availabilty |
895 | mode</title> | 892 | mode</title> |
896 | 893 | ||
897 | <para>These steps must be taken on each of the CentOS 7 machines that | 894 | <para>These steps must be taken on each of the CentOS 7 machines that |
898 | will host the Enea uCPE Manager. The Enea uCPE Manager will be | 895 | will host the Enea Edge Management. The Enea Edge Management will be |
899 | installed and the setup for the external database cluster will be | 896 | installed and the setup for the external database cluster will be |
900 | prepared.</para> | 897 | prepared.</para> |
901 | 898 | ||
902 | <para>As the root user, go to the distribution folder of the Enea uCPE | 899 | <para>As the root user, go to the distribution folder of the Enea Edge |
903 | Manager, and run:</para> | 900 | Management, and run:</para> |
904 | 901 | ||
905 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ | 902 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ |
906 | Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz | 903 | Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz |
@@ -911,7 +908,7 @@ External database selected, getting user information ... | |||
911 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ | 908 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ |
912 | for MySQL: <emphasis role="bold">2</emphasis> | 909 | for MySQL: <emphasis role="bold">2</emphasis> |
913 | Specify database server name(s) or IP Address(es): \ | 910 | Specify database server name(s) or IP Address(es): \ |
914 | <emphasis role="bold">192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)</emphasis> | 911 | <emphasis role="bold">192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)</emphasis> |
915 | Specify database ID (or name) [ucpemanager]: | 912 | Specify database ID (or name) [ucpemanager]: |
916 | Specify database server port [3306]: | 913 | Specify database server port [3306]: |
917 | Specify database user name [root]: enea | 914 | Specify database user name [root]: enea |
@@ -920,11 +917,11 @@ Specify database startup thread pool size [1]: | |||
920 | Creating database configuration file \ | 917 | Creating database configuration file \ |
921 | /opt//ucpemanager/application/config/databaseConfig.xml ... | 918 | /opt//ucpemanager/application/config/databaseConfig.xml ... |
922 | Done . | 919 | Done . |
923 | … | 920 | … |
924 | Installing ucpemanager service .. | 921 | Installing ucpemanager service .. |
925 | Specify service username [ucpemanager]: | 922 | Specify service username [ucpemanager]: |
926 | Specify service password [ucpemanager]: somepassword | 923 | Specify service password [ucpemanager]: somepassword |
927 | … | 924 | … |
928 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> | 925 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> |
929 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> | 926 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> |
930 | Specify the name of the cluster [ucpemanager]: | 927 | Specify the name of the cluster [ucpemanager]: |
@@ -934,9 +931,9 @@ HA Configuration files modified successfully. | |||
934 | Configuration complete.</programlisting> | 931 | Configuration complete.</programlisting> |
935 | 932 | ||
936 | <note> | 933 | <note> |
937 | <para>For each Enea uCPE Manager installation, place the local | 934 | <para>For each Enea Edge Management installation, place the local |
938 | interface IP first in the list of IPs. This will optimize database | 935 | interface IP first in the list of IPs. This will optimize database |
939 | communication, since the Enea uCPE Manager uses the list of IPs | 936 | communication, since the Enea Edge Management uses the list of IPs |
940 | sequentially, therefore using the internal loopback interface for | 937 | sequentially, therefore using the internal loopback interface for |
941 | communicating with the database.</para> | 938 | communicating with the database.</para> |
942 | </note> | 939 | </note> |
@@ -944,8 +941,8 @@ Configuration complete.</programlisting> | |||
944 | <para>Once the servers are up and running, log into the <emphasis | 941 | <para>Once the servers are up and running, log into the <emphasis |
945 | role="bold">Primary</emphasis> and go to <emphasis | 942 | role="bold">Primary</emphasis> and go to <emphasis |
946 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster | 943 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster |
947 | View</emphasis>. The list of Enea uCPE Managers should be displayed, | 944 | View</emphasis>. The list of Enea Edge Management servers should be |
948 | with one listed as Primary and the rest as Backup.</para> | 945 | displayed, with one listed as Primary and the rest as Backup.</para> |
949 | </section> | 946 | </section> |
950 | </section> | 947 | </section> |
951 | 948 | ||
@@ -977,7 +974,7 @@ Configuration complete.</programlisting> | |||
977 | <para>Run the upgrade process on <literal>ucpeManager-3</literal> | 974 | <para>Run the upgrade process on <literal>ucpeManager-3</literal> |
978 | and <literal>ucpeManager-4</literal>. This will upgrade the service | 975 | and <literal>ucpeManager-4</literal>. This will upgrade the service |
979 | to the current release. Once the upgrade process completes, shutdown | 976 | to the current release. Once the upgrade process completes, shutdown |
980 | the Enea uCPE Manager service on both machines.</para> | 977 | the Enea Edge Management service on both machines.</para> |
981 | </listitem> | 978 | </listitem> |
982 | 979 | ||
983 | <listitem> | 980 | <listitem> |
@@ -989,10 +986,11 @@ Configuration complete.</programlisting> | |||
989 | </listitem> | 986 | </listitem> |
990 | 987 | ||
991 | <listitem> | 988 | <listitem> |
992 | <para>Shutdown the MariaDB-2 process and run the Enea uCPE Manager | 989 | <para>Shutdown the MariaDB-2 process and run the Enea Edge |
993 | upgrade process on <literal>ucpeManager-2</literal>. This will | 990 | Management upgrade process on <literal>ucpeManager-2</literal>. This |
994 | upgrade the service to the current release. Once the upgrade process | 991 | will upgrade the service to the current release. Once the upgrade |
995 | completes, shutdown the uCPE Manager service on the machine.</para> | 992 | process completes, shutdown the Enea Edge Management service on the |
993 | machine.</para> | ||
996 | </listitem> | 994 | </listitem> |
997 | 995 | ||
998 | <listitem> | 996 | <listitem> |
@@ -1013,7 +1011,7 @@ Configuration complete.</programlisting> | |||
1013 | </listitem> | 1011 | </listitem> |
1014 | 1012 | ||
1015 | <listitem> | 1013 | <listitem> |
1016 | <para>Start the Enea uCPE Manager services on | 1014 | <para>Start the Enea Edge Management services on |
1017 | <literal>ucpeManager-2</literal>. This machine will come up as the | 1015 | <literal>ucpeManager-2</literal>. This machine will come up as the |
1018 | new "PRIMARY" with the upgraded software. As part of the startup | 1016 | new "PRIMARY" with the upgraded software. As part of the startup |
1019 | process, it will upgrade the database and perform any other | 1017 | process, it will upgrade the database and perform any other |
@@ -1026,14 +1024,14 @@ Configuration complete.</programlisting> | |||
1026 | </listitem> | 1024 | </listitem> |
1027 | 1025 | ||
1028 | <listitem> | 1026 | <listitem> |
1029 | <para>Start the Enea uCPE Manager services on | 1027 | <para>Start the Enea Edge Management services on |
1030 | <literal>ucpeManager-3</literal> and | 1028 | <literal>ucpeManager-3</literal> and |
1031 | <literal>ucpeManager-4</literal>. At this point, we are in | 1029 | <literal>ucpeManager-4</literal>. At this point, we are in |
1032 | highly-available mode.</para> | 1030 | highly-available mode.</para> |
1033 | </listitem> | 1031 | </listitem> |
1034 | 1032 | ||
1035 | <listitem> | 1033 | <listitem> |
1036 | <para>Upgrade the Enea uCPE Manager on | 1034 | <para>Upgrade the Enea Edge Management on |
1037 | <literal>ucpeManager-1</literal> (the one that has been shut down). | 1035 | <literal>ucpeManager-1</literal> (the one that has been shut down). |
1038 | Once that upgrade is complete and the service restarts, the entire | 1036 | Once that upgrade is complete and the service restarts, the entire |
1039 | setup has been upgraded to the new version.</para> | 1037 | setup has been upgraded to the new version.</para> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml index fa3fc4f..0704dd0 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_getting_started"> | 6 | <book id="book_enea_nfv_access_getting_started"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Getting Started</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Getting Started</title> |
8 | 8 | ||
9 | <subtitle>Release Version | 9 | <subtitle>Release Version |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml index 0da3855..9fc9a27 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml | |||
@@ -1,102 +1,103 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="grafana"> | 2 | <chapter id="grafana"> |
3 | <title>Using Grafana and InfluxDB</title> | 3 | <title>Using Grafana and InfluxDB</title> |
4 | 4 | ||
5 | <para>InfluxDB is essentially a time series database process that runs on a | 5 | <para>InfluxDB is essentially a time series database process that runs on a |
6 | server, while Grafana is a visualization tool for time series data. | 6 | server, while Grafana is a visualization tool for time series data. Grafana |
7 | Grafana is a very lightweight server-side application, and most of the | 7 | is a very lightweight server-side application, and most of the monitoring |
8 | monitoring runs in a browser.</para> | 8 | runs in a browser.</para> |
9 | 9 | ||
10 | <section id="telemetry_deployment"> | 10 | <section id="telemetry_deployment"> |
11 | <title>Deploying Grafana and InfluxDB</title> | 11 | <title>Deploying Grafana and InfluxDB</title> |
12 | 12 | ||
13 | <para>Grafana and InfluxDB can be deployed using images for Docker on linux. | 13 | <para>Grafana and InfluxDB can be deployed using images for Docker on |
14 | These images are provided by Enea along with a deploy script and | 14 | linux. These images are provided by Enea along with a deploy script and |
15 | predefined dashboards.</para> | 15 | predefined dashboards.</para> |
16 | 16 | ||
17 | <para>The Grafana and InfluxDB images can be deployed on the same machine | 17 | <para>The Grafana and InfluxDB images can be deployed on the same machine |
18 | or on separate machines.</para> | 18 | or on separate machines.</para> |
19 | 19 | ||
20 | <section id="prereq_deploy"> | 20 | <section id="prereq_deploy"> |
21 | <title>Prerequisites for Deploying an Image</title> | 21 | <title>Prerequisites for Deploying an Image</title> |
22 | 22 | ||
23 | <para>The following must be present in order to deploy an image:</para> | 23 | <para>The following must be present in order to deploy an image:</para> |
24 | 24 | ||
25 | <itemizedlist> | 25 | <itemizedlist> |
26 | <listitem> | 26 | <listitem> |
27 | <para>CentOS 7 Linux.</para> | 27 | <para>CentOS 7 Linux.</para> |
28 | </listitem> | 28 | </listitem> |
29 | 29 | ||
30 | <listitem> | 30 | <listitem> |
31 | <para>Docker for CentOS 7 installed on the machine and set to | 31 | <para>Docker for CentOS 7 installed on the machine and set to |
32 | <literal>autostart</literal> as a service.</para> | 32 | <literal>autostart</literal> as a service.</para> |
33 | </listitem> | 33 | </listitem> |
34 | 34 | ||
35 | <listitem> | 35 | <listitem> |
36 | <para>Superuser rights on the CentOS 7 machine.</para> | 36 | <para>Superuser rights on the CentOS 7 machine.</para> |
37 | </listitem> | 37 | </listitem> |
38 | </itemizedlist> | 38 | </itemizedlist> |
39 | </section> | 39 | </section> |
40 | 40 | ||
41 | <section id="deploy_steps"> | 41 | <section id="deploy_steps"> |
42 | <title>Deploying Grafana and InfluxDB</title> | 42 | <title>Deploying Grafana and InfluxDB</title> |
43 | 43 | ||
44 | <para>On the CentOS 7 server open a terminal, log into a bash shell | 44 | <para>On the CentOS 7 server open a terminal, log into a bash shell with |
45 | with the root account and perform the following:</para> | 45 | the root account and perform the following:</para> |
46 | 46 | ||
47 | <orderedlist> | 47 | <orderedlist> |
48 | <listitem> | 48 | <listitem> |
49 | <para>Extract | 49 | <para>Extract |
50 | <filename>Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> | 50 | <filename>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> |
51 | 51 | ||
52 | <para>The directory in which the archive will be unpacked will be | 52 | <para>The directory in which the archive will be unpacked will be |
53 | denoted as: <literal><Telemetry-installdir></literal>.</para> | 53 | denoted as: <literal><Telemetry-installdir></literal>.</para> |
54 | </listitem> | 54 | </listitem> |
55 | 55 | ||
56 | <listitem> | 56 | <listitem> |
57 | <para>Enter <literal><Telemetry-installdir></literal>.</para> | 57 | <para>Enter <literal><Telemetry-installdir></literal>.</para> |
58 | </listitem> | 58 | </listitem> |
59 | 59 | ||
60 | <listitem> | 60 | <listitem> |
61 | <para>Run the provided <filename>telemetry_deploy.sh</filename> script.</para> | 61 | <para>Run the provided <filename>telemetry_deploy.sh</filename> |
62 | </listitem> | 62 | script.</para> |
63 | 63 | </listitem> | |
64 | <listitem> | 64 | |
65 | <para>When prompted, select what images you want to deploy.</para> | 65 | <listitem> |
66 | 66 | <para>When prompted, select what images you want to deploy.</para> | |
67 | <para>If an image is already deployed, you will be prompted to replace it.</para> | 67 | |
68 | </listitem> | 68 | <para>If an image is already deployed, you will be prompted to |
69 | 69 | replace it.</para> | |
70 | <listitem> | 70 | </listitem> |
71 | <para>During the InfluxDB deployment, you will be prompted to provide | 71 | |
72 | a username and password. These must match the ones configured in the | 72 | <listitem> |
73 | Enea uCPE Manager for Telemetry. | 73 | <para>During the InfluxDB deployment, you will be prompted to |
74 | </para> | 74 | provide a username and password. These must match the ones |
75 | 75 | configured in the Enea Edge Management for Telemetry.</para> | |
76 | <note> | 76 | |
77 | <para>Changing the InfluxDB username and password requires redeploying | 77 | <note> |
78 | the InfluxDB image.</para> | 78 | <para>Changing the InfluxDB username and password requires |
79 | </note> | 79 | redeploying the InfluxDB image.</para> |
80 | </listitem> | 80 | </note> |
81 | 81 | </listitem> | |
82 | <listitem> | 82 | |
83 | <para>Verify the installation by running the command <literal>docker ps -a</literal>. | 83 | <listitem> |
84 | The Grafana and InfluxDB containers should be present and have | 84 | <para>Verify the installation by running the command <literal>docker |
85 | the status <literal>Up</literal>. | 85 | ps -a</literal>. The Grafana and InfluxDB containers should be |
86 | </para> | 86 | present and have the status <literal>Up</literal>.</para> |
87 | </listitem> | 87 | </listitem> |
88 | </orderedlist> | 88 | </orderedlist> |
89 | </section> | ||
90 | </section> | 89 | </section> |
90 | </section> | ||
91 | 91 | ||
92 | <section id="grafana_settings"> | 92 | <section id="grafana_settings"> |
93 | <title>Setting Grafana and InfluxDB parameters</title> | 93 | <title>Setting Grafana and InfluxDB parameters</title> |
94 | 94 | ||
95 | <para>Customizing InfluxDB and Grafana parameters can be done by selecting | 95 | <para>Customizing InfluxDB and Grafana parameters can be done by selecting |
96 | <emphasis role="bold">System</emphasis>, then the <emphasis role="bold">Configuration</emphasis> | 96 | <emphasis role="bold">System</emphasis>, then the <emphasis |
97 | menu, accessing the <emphasis role="bold">Properties</emphasis> tab, and clicking on the | 97 | role="bold">Configuration</emphasis> menu, accessing the <emphasis |
98 | <emphasis role="bold">Telemetry</emphasis> tab. The settings that can be changed | 98 | role="bold">Properties</emphasis> tab, and clicking on the <emphasis |
99 | are listed in the table below:</para> | 99 | role="bold">Telemetry</emphasis> tab. The settings that can be changed are |
100 | listed in the table below:</para> | ||
100 | 101 | ||
101 | <table> | 102 | <table> |
102 | <title>Telemetry settings</title> | 103 | <title>Telemetry settings</title> |
@@ -138,7 +139,7 @@ | |||
138 | <entry>Grafana Dashboard</entry> | 139 | <entry>Grafana Dashboard</entry> |
139 | 140 | ||
140 | <entry>The dashboard that should be used when opening Grafana | 141 | <entry>The dashboard that should be used when opening Grafana |
141 | using the Enea uCPE Manager.</entry> | 142 | using the Enea Edge Management.</entry> |
142 | 143 | ||
143 | <entry>host</entry> | 144 | <entry>host</entry> |
144 | </row> | 145 | </row> |
@@ -183,8 +184,8 @@ | |||
183 | </table> | 184 | </table> |
184 | 185 | ||
185 | <para>When changing any of the settings in the <emphasis | 186 | <para>When changing any of the settings in the <emphasis |
186 | role="bold">Telemetry</emphasis> tab, the Enea uCPE Manager will inform all | 187 | role="bold">Telemetry</emphasis> tab, the Enea Edge Management will inform |
187 | uCPE devices of the change if they have telemetry running.</para> | 188 | all uCPE devices of the change if they have telemetry running.</para> |
188 | 189 | ||
189 | <figure> | 190 | <figure> |
190 | <title>Telemetry Properties</title> | 191 | <title>Telemetry Properties</title> |
@@ -203,11 +204,11 @@ | |||
203 | 204 | ||
204 | <para>When a uCPE Device is selected, in the <emphasis | 205 | <para>When a uCPE Device is selected, in the <emphasis |
205 | role="bold">Operations</emphasis> menu, the <emphasis role="bold">Start | 206 | role="bold">Operations</emphasis> menu, the <emphasis role="bold">Start |
206 | Telemetry</emphasis> and <emphasis role="bold">Stop | 207 | Telemetry</emphasis> and <emphasis role="bold">Stop Telemetry</emphasis> |
207 | Telemetry</emphasis> options are available.</para> | 208 | options are available.</para> |
208 | 209 | ||
209 | <para>When starting Telemetry for a uCPE device, the Enea uCPE Manager sends | 210 | <para>When starting Telemetry for a uCPE device, the Enea Edge Management |
210 | the following information about the InfluxDB:</para> | 211 | sends the following information about the InfluxDB:</para> |
211 | 212 | ||
212 | <itemizedlist> | 213 | <itemizedlist> |
213 | <listitem> | 214 | <listitem> |
@@ -226,10 +227,10 @@ | |||
226 | </itemizedlist> | 227 | </itemizedlist> |
227 | 228 | ||
228 | <para>These fields are read-only and are populated with the values already | 229 | <para>These fields are read-only and are populated with the values already |
229 | set in the <emphasis role="bold">System Configuration</emphasis>. If one of the | 230 | set in the <emphasis role="bold">System Configuration</emphasis>. If one |
230 | fields is not set or if it does not have the desired value, modify it in the | 231 | of the fields is not set or if it does not have the desired value, modify |
231 | <emphasis role="bold">System Configuration</emphasis>. The password is sent | 232 | it in the <emphasis role="bold">System Configuration</emphasis>. The |
232 | encrypted using the Base64 scheme.</para> | 233 | password is sent encrypted using the Base64 scheme.</para> |
233 | 234 | ||
234 | <figure> | 235 | <figure> |
235 | <title>Telemetry Start Dialog</title> | 236 | <title>Telemetry Start Dialog</title> |
@@ -241,25 +242,25 @@ | |||
241 | </mediaobject> | 242 | </mediaobject> |
242 | </figure> | 243 | </figure> |
243 | 244 | ||
244 | <para>When the Telemetry status is changed on a uCPE device, a notification is | 245 | <para>When the Telemetry status is changed on a uCPE device, a |
245 | sent to the Enea uCPE Manager. These notifications can be inspected under | 246 | notification is sent to the Enea Edge Management. These notifications can |
246 | <emphasis role="bold">Fault</emphasis> found in the | 247 | be inspected under <emphasis role="bold">Fault</emphasis> found in the |
247 | <emphasis role="bold">Event</emphasis> menu.</para> | 248 | <emphasis role="bold">Event</emphasis> menu.</para> |
248 | </section> | 249 | </section> |
249 | 250 | ||
250 | <section id="grafana_launch"> | 251 | <section id="grafana_launch"> |
251 | <title>Launching Grafana</title> | 252 | <title>Launching Grafana</title> |
252 | 253 | ||
253 | <para>When a uCPE Device is selected, the <emphasis | 254 | <para>When a uCPE Device is selected, the <emphasis |
254 | role="bold">Telemetry</emphasis> button is available. Pressing this | 255 | role="bold">Telemetry</emphasis> button is available. Pressing this button |
255 | button will open a new window pointing to Grafana. The current uCPE device will | 256 | will open a new window pointing to Grafana. The current uCPE device will |
256 | be selected in Grafana.</para> | 257 | be selected in Grafana.</para> |
257 | 258 | ||
258 | <para>The hostname or IP Address and the port of the Grafana installation | 259 | <para>The hostname or IP Address and the port of the Grafana installation |
259 | can be customized by selecting <emphasis role="bold">System</emphasis>, then the | 260 | can be customized by selecting <emphasis role="bold">System</emphasis>, |
260 | <emphasis role="bold">Configuration</emphasis> menu, accessing the | 261 | then the <emphasis role="bold">Configuration</emphasis> menu, accessing |
261 | <emphasis role="bold">Properties</emphasis> tab, and clicking on the | 262 | the <emphasis role="bold">Properties</emphasis> tab, and clicking on the |
262 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard available when | 263 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard |
263 | launching Grafana can be customized as well.</para> | 264 | available when launching Grafana can be customized as well.</para> |
264 | </section> | 265 | </section> |
265 | </chapter> \ No newline at end of file | 266 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index be4342f..f8da56d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml | |||
@@ -1,7 +1,6 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="installation_guide"> | 2 | <chapter id="installation_guide"> |
3 | <title>Setting up and Installing the Enea NFV Access Base | 3 | <title>Setting up and Installing the Enea Edge Base Configuration</title> |
4 | Configuration</title> | ||
5 | 4 | ||
6 | <para>The setup and installation steps detailed below will deploy a base | 5 | <para>The setup and installation steps detailed below will deploy a base |
7 | configuration which will be used as a reference for more complex deployment | 6 | configuration which will be used as a reference for more complex deployment |
@@ -19,11 +18,11 @@ | |||
19 | 18 | ||
20 | <note> | 19 | <note> |
21 | <para>The CentOS 7 server must be updated to the latest revision | 20 | <para>The CentOS 7 server must be updated to the latest revision |
22 | before installing Enea NFV Access.</para> | 21 | before installing Enea Edge.</para> |
23 | </note> | 22 | </note> |
24 | 23 | ||
25 | <para>The following will detail CPU, RAM and storage requirements for | 24 | <para>The following will detail CPU, RAM and storage requirements for |
26 | the uCPE Manager.</para> | 25 | the Enea Edge Management.</para> |
27 | 26 | ||
28 | <itemizedlist> | 27 | <itemizedlist> |
29 | <listitem> | 28 | <listitem> |
@@ -81,31 +80,30 @@ | |||
81 | </listitem> | 80 | </listitem> |
82 | </itemizedlist> | 81 | </itemizedlist> |
83 | 82 | ||
84 | <para>The purpose of the CentOS 7 server is to host the Enea uCPE | 83 | <para>The purpose of the CentOS 7 server is to host the Enea Edge |
85 | Manager. Network access between the CentOS 7 server and the uCPE | 84 | Management. Network access between the CentOS 7 server and the uCPE |
86 | devices is required. The Enea uCPE Manager and the uCPE devices will | 85 | devices is required. The Enea Edge Management and the uCPE devices |
87 | be connected on separate subnets to avoid inconsistencies.</para> | 86 | will be connected on separate subnets to avoid inconsistencies.</para> |
88 | </listitem> | 87 | </listitem> |
89 | 88 | ||
90 | <listitem> | 89 | <listitem> |
91 | <para>One or more uCPE devices.</para> | 90 | <para>One or more uCPE devices.</para> |
92 | 91 | ||
93 | <para>Whitebox devices where the Enea NFV Access Runtime Platform will | 92 | <para>Whitebox devices where the Enea Edge Runtime will be installed, |
94 | be installed, containing a minimum of 2 cores and 4 GB RAM and at | 93 | containing a minimum of 2 cores and 4 GB RAM and at least two ethernet |
95 | least two ethernet ports that will be configured as WAN and LAN during | 94 | ports that will be configured as WAN and LAN during deployment.</para> |
96 | deployment.</para> | ||
97 | 95 | ||
98 | <para>When hosting an entire solution including one or several network | 96 | <para>When hosting an entire solution including one or several network |
99 | services, the hardware must also have the resources to host one or | 97 | services, the hardware must also have the resources to host one or |
100 | more VNFs. During a typical evaluation, a dual VNF service on the Enea | 98 | more VNFs. During a typical evaluation, a dual VNF service on the Enea |
101 | NFV Access Runtime Platform needs a CPU with 4-8 cores and at least 8 | 99 | Edge Runtime needs a CPU with 4-8 cores and at least 8 GB RAM. The |
102 | GB RAM. The supported Intel CPUs of Enea NFV Access are documented in | 100 | supported Intel CPUs of Enea Edge are documented in the <xi:include |
103 | the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 101 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
104 | xmlns:xi="http://www.w3.org/2001/XInclude" | 102 | xmlns:xi="http://www.w3.org/2001/XInclude" |
105 | xpointer="element(book_enea_nfv_access_release_info/1)" /> | 103 | xpointer="element(book_enea_nfv_access_release_info/1)" /> |
106 | manual.</para> | 104 | manual.</para> |
107 | 105 | ||
108 | <para>Enea NFV Access needs EFI support in BIOS to boot. When | 106 | <para>Enea Edge Runtime needs EFI support in BIOS to boot. When |
109 | configuring the uCPE device BIOS a serial connection is | 107 | configuring the uCPE device BIOS a serial connection is |
110 | required.</para> | 108 | required.</para> |
111 | </listitem> | 109 | </listitem> |
@@ -117,12 +115,11 @@ | |||
117 | 115 | ||
118 | <itemizedlist> | 116 | <itemizedlist> |
119 | <listitem> | 117 | <listitem> |
120 | <para>Installing the Enea NFV Access Runtime Platform on uCPE | 118 | <para>Installing the Enea Edge Runtime on uCPE Devices.</para> |
121 | Devices.</para> | ||
122 | </listitem> | 119 | </listitem> |
123 | 120 | ||
124 | <listitem> | 121 | <listitem> |
125 | <para>Connecting to the GUI of the Enea uCPE Manager for | 122 | <para>Connecting to the GUI of the Enea Edge Management for |
126 | management and configuration. Network access between the CentOS 7 | 123 | management and configuration. Network access between the CentOS 7 |
127 | server and the laptop is required. Please see the <xi:include | 124 | server and the laptop is required. Please see the <xi:include |
128 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 125 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
@@ -150,9 +147,9 @@ | |||
150 | 147 | ||
151 | <para>Any firewall running on the CentOS 7 server may block the | 148 | <para>Any firewall running on the CentOS 7 server may block the |
152 | management protocols required to communicate between the uCPE device and | 149 | management protocols required to communicate between the uCPE device and |
153 | the Enea uCPE Manager as well as between the Enea uCPE Manager and its | 150 | the Enea Edge Management as well as between the Enea Edge Management and |
154 | northbound clients. Quick handling of a blocking firewall would be to | 151 | its northbound clients. Quick handling of a blocking firewall would be |
155 | disable it, typical for a lab environment, through:</para> | 152 | to disable it, typical for a lab environment, through:</para> |
156 | 153 | ||
157 | <programlisting>sudo systemctl stop firewalld | 154 | <programlisting>sudo systemctl stop firewalld |
158 | sudo systemctl disable firewalld | 155 | sudo systemctl disable firewalld |
@@ -189,7 +186,7 @@ sudo systemctl mask now firewalld</programlisting> | |||
189 | 186 | ||
190 | <entry>UDP</entry> | 187 | <entry>UDP</entry> |
191 | 188 | ||
192 | <entry>Required for the Enea uCPE Manager High Availability | 189 | <entry>Required for the Enea Edge Management High Availability |
193 | Configuration.</entry> | 190 | Configuration.</entry> |
194 | </row> | 191 | </row> |
195 | 192 | ||
@@ -198,7 +195,7 @@ sudo systemctl mask now firewalld</programlisting> | |||
198 | 195 | ||
199 | <entry>TCP</entry> | 196 | <entry>TCP</entry> |
200 | 197 | ||
201 | <entry>Required for the Enea uCPE Manager High Availability | 198 | <entry>Required for the Enea Edge Management High Availability |
202 | Configuration.</entry> | 199 | Configuration.</entry> |
203 | </row> | 200 | </row> |
204 | 201 | ||
@@ -223,7 +220,7 @@ sudo systemctl mask now firewalld</programlisting> | |||
223 | </table> | 220 | </table> |
224 | 221 | ||
225 | <para>Use the following command sequence to enable the required ports | 222 | <para>Use the following command sequence to enable the required ports |
226 | for deployment of the Enea uCPE Manager:</para> | 223 | for deployment of the Enea Edge Management:</para> |
227 | 224 | ||
228 | <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp | 225 | <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp |
229 | sudo firewall-cmd --permanent --add-port=443/tcp | 226 | sudo firewall-cmd --permanent --add-port=443/tcp |
@@ -234,21 +231,21 @@ sudo firewall-cmd --permanent --add-port=2021-2040/tcp | |||
234 | sudo firewall-cmd --reload</programlisting> | 231 | sudo firewall-cmd --reload</programlisting> |
235 | 232 | ||
236 | <note> | 233 | <note> |
237 | <para>If the uCPE Manager host resides behind a corporate | 234 | <para>If the Enea Edge Management host resides behind a corporate |
238 | port-filtering firewall, then all the aforementioned ports need to | 235 | port-filtering firewall, then all the aforementioned ports need to |
239 | also be enabled on the respective firewall. As an additional | 236 | also be enabled on the respective firewall. As an additional |
240 | requirement, port 22/TCP also needs to be enabled for reverse SSH to | 237 | requirement, port 22/TCP also needs to be enabled for reverse SSH to |
241 | the Enea uCPE Manager.</para> | 238 | the Enea Edge Management.</para> |
242 | 239 | ||
243 | <para>No enabling and no forwarding rules are necessary for ports | 240 | <para>No enabling and no forwarding rules are necessary for ports |
244 | 2021-2040 if the version of Enea NFV Access is 2.4.0 or newer.</para> | 241 | 2021-2040 if using Enea Edge 2.4.0 or newer.</para> |
245 | </note> | 242 | </note> |
246 | </section> | 243 | </section> |
247 | 244 | ||
248 | <section id="openjdk_postgresql_config"> | 245 | <section id="openjdk_postgresql_config"> |
249 | <title>Configuring OpenJDK and PostgreSQL</title> | 246 | <title>Configuring OpenJDK and PostgreSQL</title> |
250 | 247 | ||
251 | <para>The Enea uCPE Manager requires a specific Java version (OpenJDK | 248 | <para>The Enea Edge Management requires a specific Java version (OpenJDK |
252 | 11) and a PostgreSQL version to operate correctly.</para> | 249 | 11) and a PostgreSQL version to operate correctly.</para> |
253 | 250 | ||
254 | <para><emphasis role="bold">Installing OpenJDK</emphasis></para> | 251 | <para><emphasis role="bold">Installing OpenJDK</emphasis></para> |
@@ -299,8 +296,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
299 | </listitem> | 296 | </listitem> |
300 | </orderedlist> | 297 | </orderedlist> |
301 | 298 | ||
302 | <para>The Enea uCPE Manager requires a specific PostgreeSQL version. | 299 | <para>The Enea Edge Management requires a specific PostgreeSQL version. |
303 | This is embedded in the Enea uCPE Manager installation. In order to | 300 | This is embedded in the Enea Edge Management installation. In order to |
304 | avoid conflicts, any existing PostgreeSQL installation needs to be | 301 | avoid conflicts, any existing PostgreeSQL installation needs to be |
305 | uninstalled.</para> | 302 | uninstalled.</para> |
306 | 303 | ||
@@ -324,8 +321,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
324 | postgres user):</para> | 321 | postgres user):</para> |
325 | 322 | ||
326 | <note> | 323 | <note> |
327 | <para>This step is not necessary if the Enea uCPE Manager will be | 324 | <para>This step is not necessary if the Enea Edge Management will |
328 | using an external database (like MariaDB).</para> | 325 | be using an external database (like MariaDB).</para> |
329 | </note> | 326 | </note> |
330 | 327 | ||
331 | <programlisting>yum remove postgres\* | 328 | <programlisting>yum remove postgres\* |
@@ -356,10 +353,10 @@ userdel postgres</programlisting> | |||
356 | </listitem> | 353 | </listitem> |
357 | 354 | ||
358 | <listitem> | 355 | <listitem> |
359 | <para>Follow the installation steps for the Enea uCPE Manager | 356 | <para>Follow the installation steps for the Enea Edge Management |
360 | available in <olink targetdoc="book_enea_nfv_access_getting_started" | 357 | available in <olink targetdoc="book_enea_nfv_access_getting_started" |
361 | targetptr="install_ucpe_mg">Installing the uCPE Manager in the | 358 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in |
362 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 359 | the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
363 | xmlns:xi="http://www.w3.org/2001/XInclude" | 360 | xmlns:xi="http://www.w3.org/2001/XInclude" |
364 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 361 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
365 | Manual.</para> | 362 | Manual.</para> |
@@ -377,7 +374,7 @@ userdel postgres</programlisting> | |||
377 | <para>A typical whitebox comes with multiple physical network ports, | 374 | <para>A typical whitebox comes with multiple physical network ports, |
378 | ready to be used. The user must determine the purpose and allocation of | 375 | ready to be used. The user must determine the purpose and allocation of |
379 | each port. The allocation is later aligned with the software | 376 | each port. The allocation is later aligned with the software |
380 | configuration within the Enea NFV Access installer.</para> | 377 | configuration within the Web-installer.</para> |
381 | 378 | ||
382 | <para>A common way is to allocate the left ports to WANs and the right | 379 | <para>A common way is to allocate the left ports to WANs and the right |
383 | ports to LANs. At least one port must be allocated to WAN and one to | 380 | ports to LANs. At least one port must be allocated to WAN and one to |
@@ -388,8 +385,8 @@ userdel postgres</programlisting> | |||
388 | <title>Determining the Device ID</title> | 385 | <title>Determining the Device ID</title> |
389 | 386 | ||
390 | <para>Each uCPE device needs a unique identifier. This identifier is | 387 | <para>Each uCPE device needs a unique identifier. This identifier is |
391 | used to match the registration in the Enea uCPE Manager and the offline | 388 | used to match the registration in the Enea Edge Management and the |
392 | configuration of the uCPE device during ZTP (Zero Touch | 389 | offline configuration of the uCPE device during ZTP (Zero Touch |
393 | Provisioning).</para> | 390 | Provisioning).</para> |
394 | 391 | ||
395 | <para>Select a text string to represent the uCPE device, e.g. | 392 | <para>Select a text string to represent the uCPE device, e.g. |
@@ -404,7 +401,7 @@ userdel postgres</programlisting> | |||
404 | <title>Configuring the BIOS</title> | 401 | <title>Configuring the BIOS</title> |
405 | 402 | ||
406 | <para>The factory configuration of the BIOS may not match the | 403 | <para>The factory configuration of the BIOS may not match the |
407 | requirements of Enea NFV Access. The BIOS configuration needs to be | 404 | requirements of Enea Edge Runtime. The BIOS configuration needs to be |
408 | reviewed and potentially reconfigured to prepare for a successful | 405 | reviewed and potentially reconfigured to prepare for a successful |
409 | installation.</para> | 406 | installation.</para> |
410 | 407 | ||
@@ -434,8 +431,8 @@ userdel postgres</programlisting> | |||
434 | </itemizedlist> | 431 | </itemizedlist> |
435 | 432 | ||
436 | <para>The boot order may also need to be modified to support | 433 | <para>The boot order may also need to be modified to support |
437 | installation and execution of the Enea NFV Access Runtime Platform on | 434 | installation and execution of the Enea Edge Runtime on the uCPE |
438 | the uCPE device.</para> | 435 | device.</para> |
439 | 436 | ||
440 | <para>The following boot order is recommended for a base | 437 | <para>The following boot order is recommended for a base |
441 | configuration:</para> | 438 | configuration:</para> |
@@ -459,14 +456,14 @@ userdel postgres</programlisting> | |||
459 | <title>Preparing the Deployment</title> | 456 | <title>Preparing the Deployment</title> |
460 | 457 | ||
461 | <section id="install_ucpe_mg"> | 458 | <section id="install_ucpe_mg"> |
462 | <title>Installing the Enea uCPE Manager</title> | 459 | <title>Installing the Enea Edge Management</title> |
463 | 460 | ||
464 | <para>The Enea uCPE Manager can be installed using a fresh (first-time) | 461 | <para>The Enea Edge Management can be installed using a fresh |
465 | configuration or using a backup file of a previous installation, created | 462 | (first-time) configuration or using a backup file of a previous |
466 | within the Enea uCPE Manager GUI.</para> | 463 | installation, created within the Enea Edge Management GUI.</para> |
467 | 464 | ||
468 | <section id="fresh_ucpemg_install"> | 465 | <section id="fresh_ucpemg_install"> |
469 | <title>Fresh Installation of the Enea uCPE Manager</title> | 466 | <title>Fresh Installation of the Enea Edge Management</title> |
470 | 467 | ||
471 | <para>On the CentOS 7 server open a terminal, log into a bash shell | 468 | <para>On the CentOS 7 server open a terminal, log into a bash shell |
472 | with the root account and perform the following:</para> | 469 | with the root account and perform the following:</para> |
@@ -474,7 +471,7 @@ userdel postgres</programlisting> | |||
474 | <orderedlist> | 471 | <orderedlist> |
475 | <listitem> | 472 | <listitem> |
476 | <para>Extract | 473 | <para>Extract |
477 | <literal>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</literal></para> | 474 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> |
478 | 475 | ||
479 | <para>The directory in which the archive has been unpacked will be | 476 | <para>The directory in which the archive has been unpacked will be |
480 | denoted as: <literal><uCPEM-installdir></literal>.</para> | 477 | denoted as: <literal><uCPEM-installdir></literal>.</para> |
@@ -510,8 +507,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
510 | 507 | ||
511 | <note> | 508 | <note> |
512 | <para>The same configuration values set now will need to be | 509 | <para>The same configuration values set now will need to be |
513 | provided when upgrading or uninstalling the Enea uCPE | 510 | provided when upgrading or uninstalling the Enea Edge |
514 | Manager.</para> | 511 | Management.</para> |
515 | </note> | 512 | </note> |
516 | 513 | ||
517 | <itemizedlist> | 514 | <itemizedlist> |
@@ -590,13 +587,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
590 | </listitem> | 587 | </listitem> |
591 | 588 | ||
592 | <listitem> | 589 | <listitem> |
593 | <para>Heap Configuration: <literal>Please enter the new Maximum Heap | 590 | <para>Heap Configuration: <literal>Please enter the new |
594 | Size [4g]</literal>:</para> | 591 | Maximum Heap Size [4g]</literal>:</para> |
595 | </listitem> | 592 | </listitem> |
596 | 593 | ||
597 | <listitem> | 594 | <listitem> |
598 | <para>Create the self-signed certificate: | 595 | <para>Create the self-signed certificate: <literal>Specify IP |
599 | <literal>Specify IP or domain name:</literal></para> | 596 | or domain name:</literal></para> |
600 | 597 | ||
601 | <note> | 598 | <note> |
602 | <para>The certificate can be generated again by running the | 599 | <para>The certificate can be generated again by running the |
@@ -619,8 +616,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
619 | </listitem> | 616 | </listitem> |
620 | 617 | ||
621 | <listitem> | 618 | <listitem> |
622 | <para>Install the Enea uCPE Manager as a service with the name | 619 | <para>Install the Enea Edge Management as a service with the |
623 | <literal>ucpemanager</literal>.</para> | 620 | name <literal>ucpemanager</literal>.</para> |
624 | </listitem> | 621 | </listitem> |
625 | 622 | ||
626 | <listitem> | 623 | <listitem> |
@@ -631,8 +628,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
631 | 628 | ||
632 | <listitem> | 629 | <listitem> |
633 | <para>Using the IPv4 address of the CentOS 7 Server in a web | 630 | <para>Using the IPv4 address of the CentOS 7 Server in a web |
634 | browser, running on the laptop, log into the Enea uCPE Manager GUI | 631 | browser, running on the laptop, log into the Enea Edge Management |
635 | using the default username and password: | 632 | GUI using the default username and password: |
636 | <literal>admin/admin</literal>.</para> | 633 | <literal>admin/admin</literal>.</para> |
637 | </listitem> | 634 | </listitem> |
638 | </orderedlist> | 635 | </orderedlist> |
@@ -645,47 +642,48 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
645 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 | 642 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 |
646 | address used will be the public IP of the NAT device and port | 643 | address used will be the public IP of the NAT device and port |
647 | forwarding rules must be created to ensure the uCPE device can | 644 | forwarding rules must be created to ensure the uCPE device can |
648 | access the Enea uCPE Manager. For more details, please see <link | 645 | access the Enea Edge Management. For more details, please see <link |
649 | linkend="firewall_config">Firewall Configuration</link>.</para> | 646 | linkend="firewall_config">Firewall Configuration</link>.</para> |
650 | </note> | 647 | </note> |
651 | </section> | 648 | </section> |
652 | 649 | ||
653 | <section id="install_ucpemg_from_backup"> | 650 | <section id="install_ucpemg_from_backup"> |
654 | <title>Installation of the Enea uCPE Manager using a System | 651 | <title>Installation of the Enea Edge Management using a System |
655 | Back-up</title> | 652 | Back-up</title> |
656 | 653 | ||
657 | <para>The Enea uCPE Manager can be restored if a backup file has been | 654 | <para>The Enea Edge Management can be restored if a backup file has |
658 | previously created.</para> | 655 | been previously created.</para> |
659 | 656 | ||
660 | <para>A backup file can be created by accessing the <emphasis | 657 | <para>A backup file can be created by accessing the <emphasis |
661 | role="bold">System</emphasis> menu, and clicking <emphasis | 658 | role="bold">System</emphasis> menu, and clicking <emphasis |
662 | role="bold">System Backup</emphasis>, from the Enea uCPE Manager GUI. | 659 | role="bold">System Backup</emphasis>, from the Enea Edge Management |
663 | The resulting zip archive will be located in the | 660 | GUI. The resulting zip archive will be located in the |
664 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder | 661 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder |
665 | and will be named | 662 | and will be named |
666 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g | 663 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g |
667 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another | 664 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another |
668 | location outside the Enea uCPE Manager installation folder for future | 665 | location outside the Enea Edge Management installation folder for |
669 | use.</para> | 666 | future use.</para> |
670 | 667 | ||
671 | <note> | 668 | <note> |
672 | <para>The System Back-up file obtained from the Enea uCPE Manager | 669 | <para>The System Back-up file obtained from the Enea Edge Management |
673 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is | 670 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is |
674 | different from the snapshot obtained during a Enea uCPE Manager | 671 | different from the snapshot obtained during a Enea Edge Management |
675 | Upgrade or Uninstall operation | 672 | Upgrade or Uninstall operation |
676 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | 673 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed |
677 | for recovery of the Enea uCPE Manager. For more details, see <olink | 674 | for recovery of the Enea Edge Management. For more details, see |
678 | targetdoc="book_enea_nfv_access_getting_started" | 675 | <olink targetdoc="book_enea_nfv_access_getting_started" |
679 | targetptr="restore_prev_ucpe_install">Restoring a previous uCPE | 676 | targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge |
680 | Manager installation in the <xi:include | 677 | Management installation in the <xi:include |
681 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 678 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
682 | xmlns:xi="http://www.w3.org/2001/XInclude" | 679 | xmlns:xi="http://www.w3.org/2001/XInclude" |
683 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 680 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
684 | Manual.</para> | 681 | Manual.</para> |
685 | </note> | 682 | </note> |
686 | 683 | ||
687 | <para>To install the Enea uCPE Manager with the restore option provide | 684 | <para>To install the Enea Edge Management with the restore option |
688 | an additional argument as shown below during installation:</para> | 685 | provide an additional argument as shown below during |
686 | installation:</para> | ||
689 | 687 | ||
690 | <programlisting>./install.sh \ | 688 | <programlisting>./install.sh \ |
691 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ | 689 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ |
@@ -694,11 +692,11 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | |||
694 | </section> | 692 | </section> |
695 | 693 | ||
696 | <section id="prep_usb_ena"> | 694 | <section id="prep_usb_ena"> |
697 | <title>Preparing the USB stick for installation of the Enea NFV Access | 695 | <title>Preparing the USB stick for installation of the Enea Edge |
698 | Runtime Platform</title> | 696 | Runtime</title> |
699 | 697 | ||
700 | <para>To install the Enea NFV Access Runtime Platform, create a bootable | 698 | <para>To install the Enea Edge Runtime, create a bootable USB stick with |
701 | USB stick with the image you intend to install.</para> | 699 | the image you intend to install.</para> |
702 | 700 | ||
703 | <para>In the example below, step by step instructions are provided for | 701 | <para>In the example below, step by step instructions are provided for |
704 | the CentOS 7 distribution. It's possible with the appropriate tools to | 702 | the CentOS 7 distribution. It's possible with the appropriate tools to |
@@ -706,7 +704,7 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | |||
706 | 704 | ||
707 | <note> | 705 | <note> |
708 | <para>The <filename>.hddimg</filename> image is available in the | 706 | <para>The <filename>.hddimg</filename> image is available in the |
709 | <filename>Enea_NFV_Access_Run_Time_Platform_ | 707 | <filename>Enea_Edge_Runtime_Platform_ |
710 | <processor>_<version>-build<build_number>.tar.gz</filename> | 708 | <processor>_<version>-build<build_number>.tar.gz</filename> |
711 | file you downloaded with your release.</para> | 709 | file you downloaded with your release.</para> |
712 | </note> | 710 | </note> |
@@ -760,16 +758,16 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
760 | </figure> | 758 | </figure> |
761 | 759 | ||
762 | <para>While the uCPE device is powered off, in order to install and | 760 | <para>While the uCPE device is powered off, in order to install and |
763 | configure the Enea NFV Access Runtime Platform (using the prepared USB | 761 | configure the Enea Edge Runtime (using the prepared USB stick), connect |
764 | stick), connect the laptop to a uCPE device LAN port. For this purpose, | 762 | the laptop to a uCPE device LAN port. For this purpose, a Layer 2 switch |
765 | a Layer 2 switch or direct cable connection can be used.</para> | 763 | or direct cable connection can be used.</para> |
766 | </section> | 764 | </section> |
767 | 765 | ||
768 | <section id="install_ena_device"> | 766 | <section id="install_ena_device"> |
769 | <title>Installing Enea NFV Access - uCPE Device Installation</title> | 767 | <title>Installing Enea Edge - uCPE Device Installation</title> |
770 | 768 | ||
771 | <para>To initiate the installation of the Enea NFV Access Runtime | 769 | <para>To initiate the installation of the Enea Edge Runtime do the |
772 | Platform do the following:</para> | 770 | following:</para> |
773 | 771 | ||
774 | <orderedlist> | 772 | <orderedlist> |
775 | <listitem> | 773 | <listitem> |
@@ -852,24 +850,24 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
852 | </listitem> | 850 | </listitem> |
853 | 851 | ||
854 | <listitem> | 852 | <listitem> |
855 | <para>On the Enea <emphasis role="bold">uCPE Manager | 853 | <para>On the Enea <emphasis role="bold">Edge Management |
856 | settings</emphasis> page of the Web-installer, the user must fill | 854 | settings</emphasis> page of the Web-installer, the user must fill |
857 | in:</para> | 855 | in:</para> |
858 | 856 | ||
859 | <itemizedlist> | 857 | <itemizedlist> |
860 | <listitem> | 858 | <listitem> |
861 | <para>The static Enea uCPE Manager IP Address. This can be | 859 | <para>The static Enea Edge Management IP Address. This can be |
862 | either:</para> | 860 | either:</para> |
863 | 861 | ||
864 | <itemizedlist spacing="compact"> | 862 | <itemizedlist spacing="compact"> |
865 | <listitem> | 863 | <listitem> |
866 | <para>The IP address of the Enea uCPE Manager host machine, | 864 | <para>The IP address of the Enea Edge Management host |
867 | if the device can directly access it.</para> | 865 | machine, if the device can directly access it.</para> |
868 | </listitem> | 866 | </listitem> |
869 | 867 | ||
870 | <listitem> | 868 | <listitem> |
871 | <para>The IP address of the NAT device, if the Enea uCPE | 869 | <para>The IP address of the NAT device, if the Enea Edge |
872 | Manager host is located behind a NAT. For more details, | 870 | Management host is located behind a NAT. For more details, |
873 | please see <link linkend="firewall_config">Firewall | 871 | please see <link linkend="firewall_config">Firewall |
874 | Configuration</link>.</para> | 872 | Configuration</link>.</para> |
875 | </listitem> | 873 | </listitem> |
@@ -885,7 +883,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
885 | <para>Customer Tags. They are used for Zero Touch Provisioning | 883 | <para>Customer Tags. They are used for Zero Touch Provisioning |
886 | (ZTP) and can be left empty for a base configuration. What can | 884 | (ZTP) and can be left empty for a base configuration. What can |
887 | be entered here (if needed), are the tag(s) specified when | 885 | be entered here (if needed), are the tag(s) specified when |
888 | creating an offline configuration in the Enea uCPE Manager. A | 886 | creating an offline configuration in the Enea Edge Management. A |
889 | later addition of customer tags can only be done by reinstalling | 887 | later addition of customer tags can only be done by reinstalling |
890 | the uCPE devices.</para> | 888 | the uCPE devices.</para> |
891 | </listitem> | 889 | </listitem> |
@@ -905,7 +903,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
905 | <itemizedlist> | 903 | <itemizedlist> |
906 | <listitem> | 904 | <listitem> |
907 | <para>Select a WAN interface to use as the management network | 905 | <para>Select a WAN interface to use as the management network |
908 | interface. This interface is used by the Enea uCPE Manager to | 906 | interface. This interface is used by the Enea Edge Management to |
909 | communicate with the uCPE device.</para> | 907 | communicate with the uCPE device.</para> |
910 | </listitem> | 908 | </listitem> |
911 | 909 | ||
@@ -918,10 +916,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
918 | </orderedlist> | 916 | </orderedlist> |
919 | 917 | ||
920 | <para>When the user has completed the configuration steps in the | 918 | <para>When the user has completed the configuration steps in the |
921 | Web-installer, Enea NFV Access is installed on the hard drive. At this | 919 | Web-installer, Enea Edge Runtime is installed on the hard drive. At this |
922 | stage, the user should remove the USB stick and the LAN cable, and | 920 | stage, the user should remove the USB stick and the LAN cable, and |
923 | shutdown the uCPE device. It will be started after necessary | 921 | shutdown the uCPE device. It will be started after necessary |
924 | configurations are done in the Enea uCPE Manager, as described | 922 | configurations are done in the Enea Edge Management, as described |
925 | below.</para> | 923 | below.</para> |
926 | 924 | ||
927 | <note> | 925 | <note> |
@@ -953,13 +951,13 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
953 | 951 | ||
954 | <itemizedlist> | 952 | <itemizedlist> |
955 | <listitem> | 953 | <listitem> |
956 | <para>Network connection between the server running the Enea uCPE | 954 | <para>Network connection between the server running the Enea Edge |
957 | Manager and the laptop.</para> | 955 | Management and the laptop.</para> |
958 | </listitem> | 956 | </listitem> |
959 | 957 | ||
960 | <listitem> | 958 | <listitem> |
961 | <para>Network connection between the server running the Enea uCPE | 959 | <para>Network connection between the server running the Enea Edge |
962 | Manager and the uCPE device.</para> | 960 | Management and the uCPE device.</para> |
963 | </listitem> | 961 | </listitem> |
964 | </itemizedlist> | 962 | </itemizedlist> |
965 | </section> | 963 | </section> |
@@ -969,14 +967,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
969 | <title>Management of uCPE Devices</title> | 967 | <title>Management of uCPE Devices</title> |
970 | 968 | ||
971 | <para>When the installation is complete the uCPE device can be managed in | 969 | <para>When the installation is complete the uCPE device can be managed in |
972 | the Enea uCPE Manager.</para> | 970 | the Enea Edge Management.</para> |
973 | 971 | ||
974 | <section id="add_offline_config"> | 972 | <section id="add_offline_config"> |
975 | <title>Add a default Offline Configuration</title> | 973 | <title>Add a default Offline Configuration</title> |
976 | 974 | ||
977 | <para>Zero Touch Provisioning is always turned on when a uCPE device | 975 | <para>Zero Touch Provisioning is always turned on when a uCPE device |
978 | connects to the Enea uCPE Manager. To enable it in the Enea uCPE | 976 | connects to the Enea Edge Management. To enable it in the Enea Edge |
979 | Manager, an offline configuration needs to be registered for Day-0 | 977 | Management, an offline configuration needs to be registered for Day-0 |
980 | configuration.</para> | 978 | configuration.</para> |
981 | 979 | ||
982 | <note> | 980 | <note> |
@@ -990,8 +988,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
990 | 988 | ||
991 | <para>The offline configuration consists of data and parameters that are | 989 | <para>The offline configuration consists of data and parameters that are |
992 | meant to be automatically set when a uCPE device connects to the Enea | 990 | meant to be automatically set when a uCPE device connects to the Enea |
993 | uCPE Manager for the first time. The configuration is typically focused | 991 | Edge Management for the first time. The configuration is typically |
994 | on setting up the network management of the uCPE device, e.g. | 992 | focused on setting up the network management of the uCPE device, e.g. |
995 | configuring network interfaces, WAN and LAN networking and service | 993 | configuring network interfaces, WAN and LAN networking and service |
996 | chains.</para> | 994 | chains.</para> |
997 | 995 | ||
@@ -1003,14 +1001,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1003 | <note> | 1001 | <note> |
1004 | <para>If the offline configuration is not configured, an alarm will be | 1002 | <para>If the offline configuration is not configured, an alarm will be |
1005 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device | 1003 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device |
1006 | tries to connect to the Enea uCPE Manager, informing the user that the | 1004 | tries to connect to the Enea Edge Management, informing the user that |
1007 | ZTP setup failed for the uCPE device.</para> | 1005 | the ZTP setup failed for the uCPE device.</para> |
1008 | </note> | 1006 | </note> |
1009 | 1007 | ||
1010 | <para><emphasis role="bold">To create an offline | 1008 | <para><emphasis role="bold">To create an offline |
1011 | configuration</emphasis><orderedlist> | 1009 | configuration</emphasis><orderedlist> |
1012 | <listitem> | 1010 | <listitem> |
1013 | <para>In a browser access the Enea uCPE Manager, open <emphasis | 1011 | <para>In a browser access the Enea Edge Management, open <emphasis |
1014 | role="bold">Applications</emphasis> and select <emphasis | 1012 | role="bold">Applications</emphasis> and select <emphasis |
1015 | role="bold">Offline Config</emphasis>.</para> | 1013 | role="bold">Offline Config</emphasis>.</para> |
1016 | </listitem> | 1014 | </listitem> |
@@ -1024,7 +1022,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1024 | 1022 | ||
1025 | <para>The name is user defined and can be set to any unique text | 1023 | <para>The name is user defined and can be set to any unique text |
1026 | string identifying the configuration. The | 1024 | string identifying the configuration. The |
1027 | <literal>deviceVersion</literal> must match the Enea NFV Access | 1025 | <literal>deviceVersion</literal> must match the Enea Edge Runtime |
1028 | version of the uCPE device and the <literal>deviceId</literal> | 1026 | version of the uCPE device and the <literal>deviceId</literal> |
1029 | must be the previously set identifier of the uCPE device | 1027 | must be the previously set identifier of the uCPE device |
1030 | (DeviceId).</para> | 1028 | (DeviceId).</para> |
@@ -1037,8 +1035,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1037 | 1035 | ||
1038 | <para>In order to enroll a uCPE device in the management system and | 1036 | <para>In order to enroll a uCPE device in the management system and |
1039 | establish a management connection, the user will add uCPE device | 1037 | establish a management connection, the user will add uCPE device |
1040 | information in the Enea uCPE Manager. This is accomplished by going to | 1038 | information in the Enea Edge Management. This is accomplished by going |
1041 | <emphasis role="bold">Devices</emphasis>, selecting <emphasis | 1039 | to <emphasis role="bold">Devices</emphasis>, selecting <emphasis |
1042 | role="bold">Manage</emphasis> and then clicking the <emphasis | 1040 | role="bold">Manage</emphasis> and then clicking the <emphasis |
1043 | role="bold">Add</emphasis> button.</para> | 1041 | role="bold">Add</emphasis> button.</para> |
1044 | 1042 | ||
@@ -1052,7 +1050,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1052 | 1050 | ||
1053 | <listitem> | 1051 | <listitem> |
1054 | <para><emphasis role="bold">Name.</emphasis> The name by which the | 1052 | <para><emphasis role="bold">Name.</emphasis> The name by which the |
1055 | uCPE device is referred to in the Enea uCPE Manager. | 1053 | uCPE device is referred to in the Enea Edge Management. |
1056 | (Mandatory).</para> | 1054 | (Mandatory).</para> |
1057 | </listitem> | 1055 | </listitem> |
1058 | 1056 | ||
@@ -1096,8 +1094,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1096 | <section id="boot_device_add_map"> | 1094 | <section id="boot_device_add_map"> |
1097 | <title>Booting the uCPE device and adding it to the Map</title> | 1095 | <title>Booting the uCPE device and adding it to the Map</title> |
1098 | 1096 | ||
1099 | <para>When connectivity is established with the Enea uCPE Manager and a | 1097 | <para>When connectivity is established with the Enea Edge Management and |
1100 | uCPE device is already registered with a matching <literal>Device | 1098 | a uCPE device is already registered with a matching <literal>Device |
1101 | ID</literal>, the installation is complete, and the connection is | 1099 | ID</literal>, the installation is complete, and the connection is |
1102 | established.</para> | 1100 | established.</para> |
1103 | 1101 | ||
@@ -1108,12 +1106,13 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1108 | 1106 | ||
1109 | <para>In case of management connection failure (e.g. due to a | 1107 | <para>In case of management connection failure (e.g. due to a |
1110 | misconfiguration), the uCPE device status will be seen as RED | 1108 | misconfiguration), the uCPE device status will be seen as RED |
1111 | (disconnected) in the Enea uCPE Manager. The uCPE device configuration | 1109 | (disconnected) in the Enea Edge Management. The uCPE device |
1112 | can be corrected by removing the WAN cable(s), reconnecting the laptop | 1110 | configuration can be corrected by removing the WAN cable(s), |
1113 | to the LAN interface of the uCPE device and rebooting it. At this point, | 1111 | reconnecting the laptop to the LAN interface of the uCPE device and |
1114 | the Web-installer can be accessed from the laptop as described in <olink | 1112 | rebooting it. At this point, the Web-installer can be accessed from the |
1113 | laptop as described in <olink | ||
1115 | targetdoc="book_enea_nfv_access_getting_started" | 1114 | targetdoc="book_enea_nfv_access_getting_started" |
1116 | targetptr="install_ena_device">Installing Enea NFV Access - uCPE Device | 1115 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
1117 | installation in the <xi:include | 1116 | installation in the <xi:include |
1118 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1117 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1119 | xmlns:xi="http://www.w3.org/2001/XInclude" | 1118 | xmlns:xi="http://www.w3.org/2001/XInclude" |
@@ -1125,14 +1124,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1125 | <section id="ucpe_monitor"> | 1124 | <section id="ucpe_monitor"> |
1126 | <title>uCPE Device Monitorization and Control</title> | 1125 | <title>uCPE Device Monitorization and Control</title> |
1127 | 1126 | ||
1128 | <para>Once the uCPE device is connected to the Enea uCPE Manager, it is | 1127 | <para>Once the uCPE device is connected to the Enea Edge Management, it is |
1129 | ready for central management. Two important functions available in the | 1128 | ready for central management. Two important functions available in the |
1130 | Enea uCPE Manager GUI are alarm checking and resource allocation.</para> | 1129 | Enea Edge Management GUI are alarm checking and resource |
1130 | allocation.</para> | ||
1131 | 1131 | ||
1132 | <section id="check_alarms"> | 1132 | <section id="check_alarms"> |
1133 | <title>Checking Alarms</title> | 1133 | <title>Checking Alarms</title> |
1134 | 1134 | ||
1135 | <para>The Enea uCPE Manager dashboard presents alarms in a specific | 1135 | <para>The Enea Edge Management dashboard presents alarms in a specific |
1136 | window on the front page.</para> | 1136 | window on the front page.</para> |
1137 | 1137 | ||
1138 | <para>An alarm can be easily triggered by disconnecting and reconnecting | 1138 | <para>An alarm can be easily triggered by disconnecting and reconnecting |
@@ -1141,15 +1141,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1141 | Disconnected::Critical</literal>.</para> | 1141 | Disconnected::Critical</literal>.</para> |
1142 | 1142 | ||
1143 | <para>A separate Alarm Management window can be accessed from the Enea | 1143 | <para>A separate Alarm Management window can be accessed from the Enea |
1144 | uCPE Manager menu for in-depth access and programming of Alarms and | 1144 | Edge Management menu for in-depth access and programming of Alarms and |
1145 | Events.</para> | 1145 | Events.</para> |
1146 | </section> | 1146 | </section> |
1147 | 1147 | ||
1148 | <section id="ck_resource_alloc"> | 1148 | <section id="ck_resource_alloc"> |
1149 | <title>Checking uCPE device Resource Allocation</title> | 1149 | <title>Checking uCPE device Resource Allocation</title> |
1150 | 1150 | ||
1151 | <para>When the uCPE device is connected to the Enea uCPE Manager it is | 1151 | <para>When the uCPE device is connected to the Enea Edge Management it |
1152 | of interest to check the amount of hardware resources in use.</para> | 1152 | is of interest to check the amount of hardware resources in use.</para> |
1153 | 1153 | ||
1154 | <para>To check CPU, RAM and disk utilization simply select the uCPE | 1154 | <para>To check CPU, RAM and disk utilization simply select the uCPE |
1155 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> | 1155 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> |
@@ -1167,9 +1167,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1167 | access. The default user and password are <literal>root</literal> and | 1167 | access. The default user and password are <literal>root</literal> and |
1168 | blank, respectively.</para> | 1168 | blank, respectively.</para> |
1169 | 1169 | ||
1170 | <para>The Enea NFV Access CLI is a pure Linux CLI providing access to | 1170 | <para>This is a pure Linux CLI providing access to standard Linux CLI |
1171 | standard Linux CLI commands. The CLI is a central feature for running | 1171 | commands. The CLI is a central feature for running custom |
1172 | custom scripting.</para> | 1172 | scripting.</para> |
1173 | 1173 | ||
1174 | <note> | 1174 | <note> |
1175 | <para>In case the uCPE device was installed behind a NAT device, the | 1175 | <para>In case the uCPE device was installed behind a NAT device, the |
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 5f8a5ad..4dec1e1 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml | |||
@@ -4,12 +4,12 @@ | |||
4 | <chapter id="intro_ucpe"> | 4 | <chapter id="intro_ucpe"> |
5 | <title>Overview</title> | 5 | <title>Overview</title> |
6 | 6 | ||
7 | <para>This document describes the Enea NFV Access and provides installation | 7 | <para>This document describes the Enea Edge and provides installation |
8 | steps for deploying a base configuration in order to create:</para> | 8 | steps for deploying a base configuration in order to create:</para> |
9 | 9 | ||
10 | <itemizedlist> | 10 | <itemizedlist> |
11 | <listitem> | 11 | <listitem> |
12 | <para>A functional uCPE Management installation ready to manage uCPE | 12 | <para>A functional Enea Edge Management installation ready to manage uCPE |
13 | devices.</para> | 13 | devices.</para> |
14 | </listitem> | 14 | </listitem> |
15 | 15 | ||
@@ -23,32 +23,32 @@ | |||
23 | following chapters.</para> | 23 | following chapters.</para> |
24 | 24 | ||
25 | <section id="ena_solution"> | 25 | <section id="ena_solution"> |
26 | <title>Enea NFV Access</title> | 26 | <title>Enea Edge</title> |
27 | 27 | ||
28 | <para>Enea NFV Access for universal Customer Premise Equipment (uCPE) is a | 28 | <para>Enea Edge for universal Customer Premise Equipment (uCPE) is a |
29 | virtualization and management platform, which allows end-users to onboard, | 29 | virtualization and management platform, which allows end-users to onboard, |
30 | instantiate, and run third-party VNFs onto their systems. It is comprised | 30 | instantiate, and run third-party VNFs onto their systems. It is comprised |
31 | of two major components working in close cooperation:</para> | 31 | of two major components working in close cooperation:</para> |
32 | 32 | ||
33 | <itemizedlist> | 33 | <itemizedlist> |
34 | <listitem> | 34 | <listitem> |
35 | <para>The Enea NFV Access Runtime Platform, which acts as the host | 35 | <para>The Enea Edge Runtime, which acts as the host |
36 | for Virtualized Network Functions (VNFs) and provides management over | 36 | for Virtualized Network Functions (VNFs) and provides management over |
37 | NETCONF.</para> | 37 | NETCONF.</para> |
38 | </listitem> | 38 | </listitem> |
39 | 39 | ||
40 | <listitem> | 40 | <listitem> |
41 | <para>The Enea uCPE Manager, a solution that runs on an external | 41 | <para>The Enea Edge Management, a solution that runs on an external |
42 | server, used for VNF Management and managing large numbers of uCPE | 42 | server, used for VNF Management and managing large numbers of uCPE |
43 | devices.</para> | 43 | devices.</para> |
44 | </listitem> | 44 | </listitem> |
45 | </itemizedlist> | 45 | </itemizedlist> |
46 | 46 | ||
47 | <para>In addition, Enea NFV Access also includes a software framework for | 47 | <para>In addition, Enea Edge includes a framework for |
48 | Automation and Testing (AFTH). More information can be found in | 48 | automation and testing. More information can be found in |
49 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 49 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
50 | xmlns:xi="http://www.w3.org/2001/XInclude" | 50 | xmlns:xi="http://www.w3.org/2001/XInclude" |
51 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />.</para> | 51 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />.</para> |
52 | 52 | ||
53 | <para>Details concerning release content, including documentation | 53 | <para>Details concerning release content, including documentation |
54 | structure, are provided in the <xi:include | 54 | structure, are provided in the <xi:include |
@@ -58,9 +58,9 @@ | |||
58 | with your release.</para> | 58 | with your release.</para> |
59 | 59 | ||
60 | <section id="nfv_access"> | 60 | <section id="nfv_access"> |
61 | <title>Enea NFV Access Runtime Platform</title> | 61 | <title>Enea Edge Runtime</title> |
62 | 62 | ||
63 | <para>Enea NFV Access Runtime Platform is a lightweight, | 63 | <para>Enea Edge Runtime is a lightweight, |
64 | multi-architecture virtualization platform built on de-facto standards | 64 | multi-architecture virtualization platform built on de-facto standards |
65 | in an SDN/NFV ecosystem. It is designed for a high networking | 65 | in an SDN/NFV ecosystem. It is designed for a high networking |
66 | performance with minimal hardware footprint, by only providing relevant | 66 | performance with minimal hardware footprint, by only providing relevant |
@@ -87,19 +87,19 @@ | |||
87 | </section> | 87 | </section> |
88 | 88 | ||
89 | <section id="ucpe_manager"> | 89 | <section id="ucpe_manager"> |
90 | <title>Enea uCPE Manager</title> | 90 | <title>Enea Edge Management</title> |
91 | 91 | ||
92 | <para>The Enea uCPE Manager is centralized control system providing | 92 | <para>The Enea Edge Management is centralized control system providing |
93 | uCPEs domain management capabilities through a GUI and REST API. It can | 93 | uCPEs domain management capabilities through a GUI and REST API. It can |
94 | be deployed on a host or a virtual machine running 64-bit CentOS 7 on an | 94 | be deployed on a host or a virtual machine running 64-bit CentOS 7 on an |
95 | x86 platform. The Enea uCPE Manager uses a southbound NETCONF protocol | 95 | x86 platform. The Enea Edge Management uses a southbound NETCONF protocol |
96 | to connect and manage uCPE devices.</para> | 96 | to connect and manage uCPE devices.</para> |
97 | 97 | ||
98 | <para>The Enea uCPE Manager provides the following key features:</para> | 98 | <para>The Enea Edge Management provides the following key features:</para> |
99 | 99 | ||
100 | <itemizedlist> | 100 | <itemizedlist> |
101 | <listitem> | 101 | <listitem> |
102 | <para>Enea NFV Access Runtime Platform Software Management</para> | 102 | <para>Enea Edge Runtime Software Management</para> |
103 | </listitem> | 103 | </listitem> |
104 | 104 | ||
105 | <listitem> | 105 | <listitem> |
@@ -141,21 +141,21 @@ | |||
141 | 141 | ||
142 | <tbody> | 142 | <tbody> |
143 | <row> | 143 | <row> |
144 | <entry>Enea NFV Access</entry> | 144 | <entry>Enea Edge</entry> |
145 | 145 | ||
146 | <entry>The Enea NFV Access Runtime Platform and the Enea uCPE | 146 | <entry>The Enea Edge Runtime and the Enea Edge |
147 | Manager.</entry> | 147 | Management.</entry> |
148 | </row> | 148 | </row> |
149 | 149 | ||
150 | <row> | 150 | <row> |
151 | <entry>Enea NFV Access Runtime Platform</entry> | 151 | <entry>Enea Edge Runtime</entry> |
152 | 152 | ||
153 | <entry>A lightweight, multi-architecture virtualization | 153 | <entry>A lightweight, multi-architecture virtualization |
154 | platform, supporting Virtual Machines.</entry> | 154 | platform, supporting Virtual Machines.</entry> |
155 | </row> | 155 | </row> |
156 | 156 | ||
157 | <row> | 157 | <row> |
158 | <entry>Enea uCPE Manager</entry> | 158 | <entry>Enea Edge Management</entry> |
159 | 159 | ||
160 | <entry>Enea Universal Customer Premises Equipment | 160 | <entry>Enea Universal Customer Premises Equipment |
161 | Manager.</entry> | 161 | Manager.</entry> |
@@ -164,8 +164,8 @@ | |||
164 | <row> | 164 | <row> |
165 | <entry>uCPE device</entry> | 165 | <entry>uCPE device</entry> |
166 | 166 | ||
167 | <entry>A whitebox running the Enea NFV Access Runtime | 167 | <entry>A whitebox running the Enea Edge |
168 | Platform.</entry> | 168 | Runtime.</entry> |
169 | </row> | 169 | </row> |
170 | </tbody> | 170 | </tbody> |
171 | </tgroup> | 171 | </tgroup> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml index 1b415a2..baa1340 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml | |||
@@ -4,13 +4,13 @@ | |||
4 | 4 | ||
5 | <para>Troubleshooting problems on the uCPE device require an analysis of a | 5 | <para>Troubleshooting problems on the uCPE device require an analysis of a |
6 | set of information i.e. logs collected from the uCPE device and/or the Enea | 6 | set of information i.e. logs collected from the uCPE device and/or the Enea |
7 | uCPE Manager. The following information describes how the log collection | 7 | Edge Management. The following information describes how the log collection |
8 | mechanism works.</para> | 8 | mechanism works.</para> |
9 | 9 | ||
10 | <section id="log_collect_ucpem"> | 10 | <section id="log_collect_ucpem"> |
11 | <title>Log collecting using the Enea uCPE Manager</title> | 11 | <title>Log collecting using the Enea Edge Management</title> |
12 | 12 | ||
13 | <para>The Enea uCPE Manager allows for collecting a set of logs and state | 13 | <para>The Enea Edge Management allows for collecting a set of logs and state |
14 | information from a uCPE device.</para> | 14 | information from a uCPE device.</para> |
15 | 15 | ||
16 | <section id="log_collect"> | 16 | <section id="log_collect"> |
@@ -53,7 +53,7 @@ | |||
53 | <note> | 53 | <note> |
54 | <para>It might take some time for the archive to be created. When the | 54 | <para>It might take some time for the archive to be created. When the |
55 | operation completes, a "CollectLogsComplete" notification is sent from | 55 | operation completes, a "CollectLogsComplete" notification is sent from |
56 | the uCPE device to the Enea uCPE Manager. This can be viewed in the | 56 | the uCPE device to the Enea Edge Management. This can be viewed in the |
57 | GUI in the <emphasis role="bold">Faults</emphasis> menu, after selecting | 57 | GUI in the <emphasis role="bold">Faults</emphasis> menu, after selecting |
58 | <emphasis role="bold">Events</emphasis>.</para> | 58 | <emphasis role="bold">Events</emphasis>.</para> |
59 | 59 | ||
@@ -110,7 +110,7 @@ | |||
110 | <title>Downloading Logs from the uCPE Device</title> | 110 | <title>Downloading Logs from the uCPE Device</title> |
111 | 111 | ||
112 | <para>This option transfers a debug file archive from the uCPE device to | 112 | <para>This option transfers a debug file archive from the uCPE device to |
113 | Enea uCPE Manager.</para> | 113 | Enea Edge Management.</para> |
114 | 114 | ||
115 | <orderedlist> | 115 | <orderedlist> |
116 | <listitem> | 116 | <listitem> |
@@ -124,8 +124,8 @@ | |||
124 | 124 | ||
125 | <listitem> | 125 | <listitem> |
126 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select | 126 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select |
127 | the archive you want to download from the uCPE device to Enea uCPE | 127 | the archive you want to download from the uCPE device to Enea Edge |
128 | Manager.</para> | 128 | Management.</para> |
129 | </listitem> | 129 | </listitem> |
130 | 130 | ||
131 | <listitem> | 131 | <listitem> |
@@ -133,7 +133,7 @@ | |||
133 | button.</para> | 133 | button.</para> |
134 | 134 | ||
135 | <para>The archive will be downloaded from the uCPE device and stored | 135 | <para>The archive will be downloaded from the uCPE device and stored |
136 | on the Enea uCPE Manager.</para> | 136 | on the Enea Edge Management.</para> |
137 | </listitem> | 137 | </listitem> |
138 | </orderedlist> | 138 | </orderedlist> |
139 | 139 | ||
@@ -146,9 +146,9 @@ | |||
146 | <section id="download_logs_locally"> | 146 | <section id="download_logs_locally"> |
147 | <title>Downloading collected Logs locally</title> | 147 | <title>Downloading collected Logs locally</title> |
148 | 148 | ||
149 | <para>This option downloads a logs archive from the Enea uCPE Manager to | 149 | <para>This option downloads a logs archive from the Enea Edge Management to |
150 | a local (user) machine for analysis. The archive must first be available | 150 | a local (user) machine for analysis. The archive must first be available |
151 | in the Enea uCPE Manager in order to be downloaded.</para> | 151 | in the Enea Edge Management in order to be downloaded.</para> |
152 | 152 | ||
153 | <orderedlist> | 153 | <orderedlist> |
154 | <listitem> | 154 | <listitem> |
@@ -236,10 +236,10 @@ select <emphasis role="bold">Delete Debug Log Archive</emphasis>.</para> | |||
236 | </section> | 236 | </section> |
237 | 237 | ||
238 | <section id="delete_archives_ucpem"> | 238 | <section id="delete_archives_ucpem"> |
239 | <title>Deleting a Logs Archive from the Enea uCPE Manager</title> | 239 | <title>Deleting a Logs Archive from the Enea Edge Management</title> |
240 | 240 | ||
241 | <para>This option deletes a logs archive from the Enea uCPE | 241 | <para>This option deletes a logs archive from the Enea Edge |
242 | Manager.</para> | 242 | Management.</para> |
243 | 243 | ||
244 | <orderedlist> | 244 | <orderedlist> |
245 | <listitem> | 245 | <listitem> |
@@ -259,13 +259,13 @@ table.</para> | |||
259 | <listitem> | 259 | <listitem> |
260 | <para>Click the <emphasis role="bold">Delete</emphasis> button.</para> | 260 | <para>Click the <emphasis role="bold">Delete</emphasis> button.</para> |
261 | 261 | ||
262 | <para>The file will be deleted from the Enea uCPE Manager and the | 262 | <para>The file will be deleted from the Enea Edge Management and the |
263 | table will be updated.</para> | 263 | table will be updated.</para> |
264 | </listitem> | 264 | </listitem> |
265 | </orderedlist> | 265 | </orderedlist> |
266 | 266 | ||
267 | <note> | 267 | <note> |
268 | <para>Deleting the logs file from the Enea uCPE Manager does not | 268 | <para>Deleting the logs file from the Enea Edge Management does not |
269 | affect the file located on the uCPE device.</para> | 269 | affect the file located on the uCPE device.</para> |
270 | </note> | 270 | </note> |
271 | </section> | 271 | </section> |
@@ -274,7 +274,7 @@ table.</para> | |||
274 | <title>Enabling/Disabling of the Log Collector via Permissions</title> | 274 | <title>Enabling/Disabling of the Log Collector via Permissions</title> |
275 | 275 | ||
276 | <para>To disable the ability to access/download the uCPE device's | 276 | <para>To disable the ability to access/download the uCPE device's |
277 | debug-log files from the Enea uCPE Manager, the appropriate permissions | 277 | debug-log files from the Enea Edge Management, the appropriate permissions |
278 | must be changed:</para> | 278 | must be changed:</para> |
279 | 279 | ||
280 | <orderedlist> | 280 | <orderedlist> |
@@ -320,19 +320,19 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
320 | </section> | 320 | </section> |
321 | 321 | ||
322 | <section id="download_ucpemg_logs"> | 322 | <section id="download_ucpemg_logs"> |
323 | <title>Downloading Enea uCPE Manager Logs</title> | 323 | <title>Downloading Enea Edge Management Logs</title> |
324 | 324 | ||
325 | <para>Often, sending the Enea uCPE Manager logs together with collected | 325 | <para>Often, sending the Enea Edge Management logs together with collected |
326 | uCPE device logs to the support team provides important information for | 326 | uCPE device logs to the support team provides important information for |
327 | troubleshooting (especially in cases of connectivity issues with the | 327 | troubleshooting (especially in cases of connectivity issues with the |
328 | uCPE device and error popups).</para> | 328 | uCPE device and error popups).</para> |
329 | 329 | ||
330 | <para>Enea uCPE Manager log files are located in | 330 | <para>Enea Edge Management log files are located in |
331 | <filename>application/logs/</filename> in the Enea uCPE Manager's | 331 | <filename>application/logs/</filename> in the Enea Edge Management's |
332 | installation folder | 332 | installation folder |
333 | (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They | 333 | (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They |
334 | can be copied from that location, or they can be downloaded using the | 334 | can be copied from that location, or they can be downloaded using the |
335 | Enea uCPE Manager GUI by performing the following:</para> | 335 | Enea Edge Management GUI by performing the following:</para> |
336 | 336 | ||
337 | <orderedlist> | 337 | <orderedlist> |
338 | <listitem> | 338 | <listitem> |
@@ -372,10 +372,10 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
372 | </section> | 372 | </section> |
373 | 373 | ||
374 | <section id="log_collect_no_ucpem"> | 374 | <section id="log_collect_no_ucpem"> |
375 | <title>Log collecting without using the Enea uCPE Manager</title> | 375 | <title>Log collecting without using the Enea Edge Management</title> |
376 | 376 | ||
377 | <para>Log collection from uCPE Devices can also be done when there is no | 377 | <para>Log collection from uCPE Devices can also be done when there is no |
378 | Enea uCPE Manager connection. A SSH connection to uCPE Device is needed | 378 | Enea Edge Management connection. A SSH connection to uCPE Device is needed |
379 | for use of the log collector script, which can be found in the uCPE Device | 379 | for use of the log collector script, which can be found in the uCPE Device |
380 | file system in <literal>/usr/local/enea/</literal>.</para> | 380 | file system in <literal>/usr/local/enea/</literal>.</para> |
381 | 381 | ||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml index f610651..65dfb2b 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml | |||
@@ -1,24 +1,24 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="net_config_operations"> | 2 | <chapter id="net_config_operations"> |
3 | <title>Network Configuration Options</title> | 3 | <title>Network Configuration Options</title> |
4 | 4 | ||
5 | <para>Various Advanced Network Configuration options can be done from Enea | 5 | <para>Various Advanced Network Configuration options can be done from Enea |
6 | uCPE Manager GUI.</para> | 6 | Edge Management GUI.</para> |
7 | 7 | ||
8 | <section id="device_callhome_nat"> | 8 | <section id="device_callhome_nat"> |
9 | <title>Device Call Home Connection for Deployment behind NAT</title> | 9 | <title>Device Call Home Connection for Deployment behind NAT</title> |
10 | 10 | ||
11 | <para>The Device Call Home option enables the initiation of the connection | 11 | <para>The Device Call Home option enables the initiation of the connection |
12 | between the uCPE Device and the Enea uCPE Manager, from the uCPE device. | 12 | between the uCPE Device and the Enea Edge Management, from the uCPE |
13 | The Device Call Home option is required when deploying a uCPE device | 13 | device. The Device Call Home option is required when deploying a uCPE |
14 | behind NAT since the IP address of the uCPE device is hidden for the Enea | 14 | device behind NAT since the IP address of the uCPE device is hidden for |
15 | uCPE Manager.</para> | 15 | the Enea Edge Management.</para> |
16 | 16 | ||
17 | <para>Enable Device Call Home by marking the Device Call Home checkbox | 17 | <para>Enable Device Call Home by marking the Device Call Home checkbox |
18 | when registering the uCPE device in Enea uCPE Manager. When using this | 18 | when registering the uCPE device in Enea Edge Management. When using this |
19 | mechanism, the device will initiate a connection to the Enea uCPE Manager | 19 | mechanism, the device will initiate a connection to the Enea Edge |
20 | for NETCONF traffic (over SSH), while the Enea uCPE Manager waits for a | 20 | Management for NETCONF traffic (over SSH), while the Enea Edge Management |
21 | device connection.</para> | 21 | waits for a device connection.</para> |
22 | </section> | 22 | </section> |
23 | 23 | ||
24 | <section id="device_net_config"> | 24 | <section id="device_net_config"> |
@@ -90,7 +90,7 @@ | |||
90 | virtualization infrastructure and VNFs, they must be configured into the | 90 | virtualization infrastructure and VNFs, they must be configured into the |
91 | management system.</para> | 91 | management system.</para> |
92 | 92 | ||
93 | <para>To add an interface into the Enea uCPE Manager, select the uCPE | 93 | <para>To add an interface into the Enea Edge Management, select the uCPE |
94 | device, then from the top toolbar select <emphasis | 94 | device, then from the top toolbar select <emphasis |
95 | role="bold">Configuration</emphasis>, then <emphasis | 95 | role="bold">Configuration</emphasis>, then <emphasis |
96 | role="bold">External Interfaces</emphasis>, <emphasis | 96 | role="bold">External Interfaces</emphasis>, <emphasis |
@@ -191,7 +191,7 @@ | |||
191 | <title>Wan Interface Type</title> | 191 | <title>Wan Interface Type</title> |
192 | 192 | ||
193 | <para>WAN interfaces configured during the installation of the uCPE | 193 | <para>WAN interfaces configured during the installation of the uCPE |
194 | device are automatically added in the Enea uCPE manager as type | 194 | device are automatically added in the Enea Edge Management as type |
195 | <literal>wan</literal>. The WAN interface used for management of the | 195 | <literal>wan</literal>. The WAN interface used for management of the |
196 | uCPE device is marked with the <literal>Management</literal> property | 196 | uCPE device is marked with the <literal>Management</literal> property |
197 | set to <literal>True</literal>.</para> | 197 | set to <literal>True</literal>.</para> |
@@ -207,12 +207,13 @@ | |||
207 | 207 | ||
208 | <orderedlist> | 208 | <orderedlist> |
209 | <listitem> | 209 | <listitem> |
210 | <para>To edit an interface configuration type from the Enea uCPE | 210 | <para>To edit an interface configuration type from the Enea Edge |
211 | Manager, select the uCPE device, then from the top toolbar select | 211 | Management, select the uCPE device, then from the top toolbar |
212 | the <emphasis role="bold">Configuration</emphasis> menu, then | 212 | select the <emphasis role="bold">Configuration</emphasis> menu, |
213 | <emphasis role="bold">External Interfaces</emphasis> and <emphasis | 213 | then <emphasis role="bold">External Interfaces</emphasis> and |
214 | role="bold">Configuration</emphasis>. The already configured | 214 | <emphasis role="bold">Configuration</emphasis>. The already |
215 | interfaces are displayed here, as seen in the figure above.</para> | 215 | configured interfaces are displayed here, as seen in the figure |
216 | above.</para> | ||
216 | </listitem> | 217 | </listitem> |
217 | 218 | ||
218 | <listitem> | 219 | <listitem> |
@@ -259,11 +260,11 @@ | |||
259 | 260 | ||
260 | <orderedlist> | 261 | <orderedlist> |
261 | <listitem> | 262 | <listitem> |
262 | <para>To edit an interface configuration from the Enea uCPE | 263 | <para>To edit an interface configuration from the Enea Edge |
263 | Manager, select the uCPE device, then from the top toolbar select | 264 | Management, select the uCPE device, then from the top toolbar |
264 | the <emphasis role="bold">Configuration</emphasis> menu then | 265 | select the <emphasis role="bold">Configuration</emphasis> menu |
265 | <emphasis role="bold">External Interfaces</emphasis> and select | 266 | then <emphasis role="bold">External Interfaces</emphasis> and |
266 | <emphasis role="bold">Configuration</emphasis>. The already | 267 | select <emphasis role="bold">Configuration</emphasis>. The already |
267 | configured interfaces will be displayed here.</para> | 268 | configured interfaces will be displayed here.</para> |
268 | </listitem> | 269 | </listitem> |
269 | 270 | ||
@@ -304,9 +305,9 @@ | |||
304 | <note> | 305 | <note> |
305 | <para>Correct <emphasis role="bold">Country Code</emphasis> | 306 | <para>Correct <emphasis role="bold">Country Code</emphasis> |
306 | selection is mandatory. All configuration options are available in | 307 | selection is mandatory. All configuration options are available in |
307 | the Enea uCPE Manager GUI but only the Radio Settings that conform | 308 | the Enea Edge Management GUI but only the Radio Settings that |
308 | with the selected country's official regulatory laws will be applied | 309 | conform with the selected country's official regulatory laws will be |
309 | when the Wireless AP is started on the uCPE Device.</para> | 310 | applied when the Wireless AP is started on the uCPE Device.</para> |
310 | </note> | 311 | </note> |
311 | </section> | 312 | </section> |
312 | 313 | ||
@@ -319,8 +320,8 @@ | |||
319 | role="bold">External Interfaces</emphasis>, where a list of available | 320 | role="bold">External Interfaces</emphasis>, where a list of available |
320 | network interfaces and their capabilities can be found.</para> | 321 | network interfaces and their capabilities can be found.</para> |
321 | 322 | ||
322 | <para>After networking interfaces have been added to the Enea uCPE | 323 | <para>After networking interfaces have been added to the Enea Edge |
323 | Manager, the user can change the interface type (DPDK, SR-IOV, | 324 | Management, the user can change the interface type (DPDK, SR-IOV, |
324 | Standard, WAN, WAP).</para> | 325 | Standard, WAN, WAP).</para> |
325 | 326 | ||
326 | <figure> | 327 | <figure> |
@@ -339,8 +340,8 @@ | |||
339 | <section id="configure_bridges"> | 340 | <section id="configure_bridges"> |
340 | <title>Configuring Bridges</title> | 341 | <title>Configuring Bridges</title> |
341 | 342 | ||
342 | <para>After networking interfaces have been added to the Enea uCPE | 343 | <para>After networking interfaces have been added to the Enea Edge |
343 | Manager, the user can create the necessary OVS bridges.</para> | 344 | Management, the user can create the necessary OVS bridges.</para> |
344 | 345 | ||
345 | <figure> | 346 | <figure> |
346 | <title>OVS Bridges</title> | 347 | <title>OVS Bridges</title> |
@@ -353,8 +354,8 @@ | |||
353 | </mediaobject> | 354 | </mediaobject> |
354 | </figure> | 355 | </figure> |
355 | 356 | ||
356 | <para><emphasis role="bold">How to add OVS bridges in the Enea uCPE | 357 | <para><emphasis role="bold">How to add OVS bridges in the Enea Edge |
357 | Manager</emphasis></para> | 358 | Management</emphasis></para> |
358 | 359 | ||
359 | <orderedlist> | 360 | <orderedlist> |
360 | <listitem> | 361 | <listitem> |
@@ -428,7 +429,7 @@ | |||
428 | <itemizedlist> | 429 | <itemizedlist> |
429 | <listitem> | 430 | <listitem> |
430 | <para><emphasis role="bold">Device management</emphasis>. Part of | 431 | <para><emphasis role="bold">Device management</emphasis>. Part of |
431 | the device configuration done by the Enea uCPE Manager.</para> | 432 | the device configuration done by the Enea Edge Management.</para> |
432 | </listitem> | 433 | </listitem> |
433 | 434 | ||
434 | <listitem> | 435 | <listitem> |
@@ -537,7 +538,7 @@ | |||
537 | physically present (initially) to manage the device.</para> | 538 | physically present (initially) to manage the device.</para> |
538 | 539 | ||
539 | <para>An offline configuration is usually prepared in advance for the Enea | 540 | <para>An offline configuration is usually prepared in advance for the Enea |
540 | uCPE Manager to setup the virtualization infrastructure on the uCPE | 541 | Edge Management to setup the virtualization infrastructure on the uCPE |
541 | device, as soon as a device enrolls into the management system.</para> | 542 | device, as soon as a device enrolls into the management system.</para> |
542 | 543 | ||
543 | <section id="offline_configuration"> | 544 | <section id="offline_configuration"> |
@@ -551,12 +552,12 @@ | |||
551 | 552 | ||
552 | <para>Alternatively, a wildcard can be used in the <literal>Device | 553 | <para>Alternatively, a wildcard can be used in the <literal>Device |
553 | ID</literal> field, which results in a configuration being pushed on all | 554 | ID</literal> field, which results in a configuration being pushed on all |
554 | uCPE devices upon their initial connection towards the Enea uCPE | 555 | uCPE devices upon their initial connection towards the Enea Edge |
555 | Manager.</para> | 556 | Management.</para> |
556 | 557 | ||
557 | <para>If the offline configuration is not configured for a uCPE device, | 558 | <para>If the offline configuration is not configured for a uCPE device, |
558 | an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>, | 559 | an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>, |
559 | which occurs when the uCPE device connects to the Enea uCPE Manager | 560 | which occurs when the uCPE device connects to the Enea Edge Management |
560 | informing that the ZTP setup failed for the specific uCPE device.</para> | 561 | informing that the ZTP setup failed for the specific uCPE device.</para> |
561 | 562 | ||
562 | <para>To create an offline configuration, select from the top toolbar | 563 | <para>To create an offline configuration, select from the top toolbar |
@@ -598,10 +599,10 @@ | |||
598 | 599 | ||
599 | <para>The Name is user defined and can be set to any unique text string | 600 | <para>The Name is user defined and can be set to any unique text string |
600 | identifying the configuration. The Device Version will match the Enea | 601 | identifying the configuration. The Device Version will match the Enea |
601 | NFV Access version of the uCPE device and the Device ID will be set to | 602 | Edge version of the uCPE device and the Device ID will be set to the |
602 | the previously set identifier of the uCPE device.</para> | 603 | previously set identifier of the uCPE device.</para> |
603 | 604 | ||
604 | <para>When a device connects to the Enea uCPE Manager for the first | 605 | <para>When a device connects to the Enea Edge Management for the first |
605 | time, it checks the device to see if it has been Zero Touch Provisioned | 606 | time, it checks the device to see if it has been Zero Touch Provisioned |
606 | (ZTP). If not, it looks for an offline configuration that matches these | 607 | (ZTP). If not, it looks for an offline configuration that matches these |
607 | values, in the following order:</para> | 608 | values, in the following order:</para> |
@@ -632,7 +633,7 @@ | |||
632 | 633 | ||
633 | <note> | 634 | <note> |
634 | <para>The ZTP will only be triggered the first time a uCPE device | 635 | <para>The ZTP will only be triggered the first time a uCPE device |
635 | connects to the Enea uCPE Manager. Just changing an offline | 636 | connects to the Enea Edge Management. Just changing an offline |
636 | configuration will not push the new changes to the device. If an | 637 | configuration will not push the new changes to the device. If an |
637 | offline configuration is changed after uCPE device registration, a | 638 | offline configuration is changed after uCPE device registration, a |
638 | factory reset can be executed to force a new ZTP to execute. Select | 639 | factory reset can be executed to force a new ZTP to execute. Select |
@@ -654,29 +655,29 @@ | |||
654 | <section id="upload_scripts"> | 655 | <section id="upload_scripts"> |
655 | <title>Uploading Scripts</title> | 656 | <title>Uploading Scripts</title> |
656 | 657 | ||
657 | <para>The scripts need to be uploaded to the Enea uCPE Manager prior to | 658 | <para>The scripts need to be uploaded to the Enea Edge Management prior |
658 | use. When uploading scripts to the Enea uCPE Manager make sure to select | 659 | to use. When uploading scripts to the Enea Edge Management make sure to |
659 | the right script type.</para> | 660 | select the right script type.</para> |
660 | 661 | ||
661 | <para>The following script types are supported:</para> | 662 | <para>The following script types are supported:</para> |
662 | 663 | ||
663 | <itemizedlist> | 664 | <itemizedlist> |
664 | <listitem> | 665 | <listitem> |
665 | <para><literal>Once-before-startup</literal>. This script will only | 666 | <para><literal>Once-before-startup</literal>. This script will only |
666 | execute once after the system has rebooted, prior to processing any | 667 | execute once after the system has rebooted, prior to processing any |
667 | device configuration.</para> | 668 | device configuration.</para> |
668 | </listitem> | 669 | </listitem> |
669 | 670 | ||
670 | <listitem> | 671 | <listitem> |
671 | <para><literal>Always-before-startup</literal>. This script will always | 672 | <para><literal>Always-before-startup</literal>. This script will |
672 | execute after the system has rebooted, prior to processing any device | 673 | always execute after the system has rebooted, prior to processing |
673 | configuration.</para> | 674 | any device configuration.</para> |
674 | </listitem> | 675 | </listitem> |
675 | 676 | ||
676 | <listitem> | 677 | <listitem> |
677 | <para><literal>Once-after-startup</literal>. The script will always | 678 | <para><literal>Once-after-startup</literal>. The script will always |
678 | execute after the system has rebooted, after all device configuration | 679 | execute after the system has rebooted, after all device |
679 | processes have completed.</para> | 680 | configuration processes have completed.</para> |
680 | </listitem> | 681 | </listitem> |
681 | 682 | ||
682 | <listitem> | 683 | <listitem> |
@@ -734,7 +735,7 @@ | |||
734 | <para>Select the script you want to delete from the <emphasis | 735 | <para>Select the script you want to delete from the <emphasis |
735 | role="bold">Uploaded Scripts</emphasis> tab and then click <emphasis | 736 | role="bold">Uploaded Scripts</emphasis> tab and then click <emphasis |
736 | role="bold">Delete</emphasis>, which will remove the script | 737 | role="bold">Delete</emphasis>, which will remove the script |
737 | immediately from the Enea uCPE Manager.</para> | 738 | immediately from the Enea Edge Management.</para> |
738 | </listitem> | 739 | </listitem> |
739 | </orderedlist> | 740 | </orderedlist> |
740 | </section> | 741 | </section> |
@@ -742,8 +743,8 @@ | |||
742 | <section id="configure_scripts"> | 743 | <section id="configure_scripts"> |
743 | <title>Configuring Script Location</title> | 744 | <title>Configuring Script Location</title> |
744 | 745 | ||
745 | <para>The location where the scripts are staged in the Enea uCPE Manager | 746 | <para>The location where the scripts are staged in the Enea Edge |
746 | can be chanaged as described below:</para> | 747 | Management can be chanaged as described below:</para> |
747 | 748 | ||
748 | <orderedlist> | 749 | <orderedlist> |
749 | <listitem> | 750 | <listitem> |
@@ -754,7 +755,7 @@ | |||
754 | 755 | ||
755 | <listitem> | 756 | <listitem> |
756 | <para>Select the <emphasis role="bold">Configuration</emphasis> tab | 757 | <para>Select the <emphasis role="bold">Configuration</emphasis> tab |
757 | and specify a new loacation to store the scripts.</para> | 758 | and specify a new location to store the scripts.</para> |
758 | 759 | ||
759 | <note> | 760 | <note> |
760 | <para>Change the script storage location only if you have many | 761 | <para>Change the script storage location only if you have many |
@@ -815,12 +816,12 @@ | |||
815 | </section> | 816 | </section> |
816 | </section> | 817 | </section> |
817 | 818 | ||
818 | <section> | 819 | <section id="wireless_access_point"> |
819 | <title>Wireless Access Point</title> | 820 | <title>Wireless Access Point</title> |
820 | 821 | ||
821 | <para>The Wireless AP Screen from the Enea uCPE Manager Configuration menu | 822 | <para>The Wireless AP Screen from the Enea Edge Management Configuration |
822 | allows users to configure a <literal>Wireless Access Point</literal>. A | 823 | menu allows users to configure a <literal>Wireless Access Point</literal>. |
823 | <literal>wap-capable</literal> interface and a LAN bridge must be added | 824 | A <literal>wap-capable</literal> interface and a LAN bridge must be added |
824 | before doing the Wireless AP configuration. For more details see sections | 825 | before doing the Wireless AP configuration. For more details see sections |
825 | <link linkend="wap_interface_type">Wap interface Type</link> and <link | 826 | <link linkend="wap_interface_type">Wap interface Type</link> and <link |
826 | linkend="dataplane_bridge">Data-plane bridge</link>.</para> | 827 | linkend="dataplane_bridge">Data-plane bridge</link>.</para> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml index f416f8f..4984a35 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml | |||
@@ -2,19 +2,19 @@ | |||
2 | <chapter id="troubleshooting"> | 2 | <chapter id="troubleshooting"> |
3 | <title>Troubleshooting and Recovery</title> | 3 | <title>Troubleshooting and Recovery</title> |
4 | 4 | ||
5 | <para>In all scenarios where possible, collect the logs for | 5 | <para>In all scenarios where possible, collect the logs for debugging. More |
6 | debugging. More information on log collecting can be found in | 6 | information on log collecting can be found in <olink |
7 | <olink targetdoc="book_enea_nfv_access_getting_started" | 7 | targetdoc="book_enea_nfv_access_getting_started" |
8 | targetptr="log_collector">Using the Log Collector in the <xi:include | 8 | targetptr="log_collector">Using the Log Collector in the <xi:include |
9 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 9 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
11 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 11 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
12 | Manual.</para> | 12 | Manual.</para> |
13 | 13 | ||
14 | <para>The following is a small list of possible Enea NFV Access problems, | 14 | <para>The following is a small list of possible Enea Edge problems, and |
15 | and their solutions. If you encounter other issues or can't get Enea NFV Access to work | 15 | their solutions. If you encounter other issues or can't get Enea Edge to |
16 | successfully after consulting the information below, please use the <olink | 16 | work successfully after consulting the information below, please use the |
17 | targetdoc="book_enea_nfv_access_release_info" | 17 | <olink targetdoc="book_enea_nfv_access_release_info" |
18 | targetptr="contacting_enea_support">Enea Support Team Form, available in the | 18 | targetptr="contacting_enea_support">Enea Support Team Form, available in the |
19 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 19 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
20 | xmlns:xi="http://www.w3.org/2001/XInclude" | 20 | xmlns:xi="http://www.w3.org/2001/XInclude" |
@@ -29,7 +29,7 @@ | |||
29 | 29 | ||
30 | <thead> | 30 | <thead> |
31 | <row> | 31 | <row> |
32 | <entry align="center">Enea NFV Access Problem</entry> | 32 | <entry align="center">Enea Edge Problem</entry> |
33 | 33 | ||
34 | <entry align="center">Solution</entry> | 34 | <entry align="center">Solution</entry> |
35 | </row> | 35 | </row> |
@@ -37,11 +37,11 @@ | |||
37 | 37 | ||
38 | <tbody> | 38 | <tbody> |
39 | <row> | 39 | <row> |
40 | <entry>A uCPE device fails to connect to the Enea uCPE Manager after | 40 | <entry>A uCPE device fails to connect to the Enea Edge Management |
41 | installation.</entry> | 41 | after installation.</entry> |
42 | 42 | ||
43 | <entry>If the uCPE device is not able to connect to the Enea uCPE | 43 | <entry>If the uCPE device is not able to connect to the Enea Edge |
44 | Manager after an installation, the Web-installer application is | 44 | Management after an installation, the Web-installer application is |
45 | started automatically on the uCPE device to change the configuration | 45 | started automatically on the uCPE device to change the configuration |
46 | via a web browser. Please see <olink | 46 | via a web browser. Please see <olink |
47 | targetdoc="book_enea_nfv_access_getting_started" | 47 | targetdoc="book_enea_nfv_access_getting_started" |
@@ -59,7 +59,7 @@ | |||
59 | <entry><orderedlist> | 59 | <entry><orderedlist> |
60 | <listitem> | 60 | <listitem> |
61 | <para>Perform a hardware reboot of the uCPE Device and select | 61 | <para>Perform a hardware reboot of the uCPE Device and select |
62 | the previous Enea NFV Access image from the GRUB menu. This | 62 | the previous Enea Edge Runtime image from the GRUB menu. This |
63 | action assumes physical access to the uCPE device.</para> | 63 | action assumes physical access to the uCPE device.</para> |
64 | </listitem> | 64 | </listitem> |
65 | 65 | ||
@@ -77,14 +77,14 @@ | |||
77 | </row> | 77 | </row> |
78 | 78 | ||
79 | <row> | 79 | <row> |
80 | <entry>After a failed uCPE device upgrade the previous Enea NFV | 80 | <entry>After a failed uCPE device upgrade the previous Enea Edge |
81 | Access image (from the GRUB menu) does not boot.</entry> | 81 | image (from the GRUB menu) does not boot.</entry> |
82 | 82 | ||
83 | <entry>Reinstall Enea NFV Access on the uCPE device and redeploy the | 83 | <entry>Reinstall Enea Edge on the uCPE device and redeploy the |
84 | initial configuration and virtualized services, by following the | 84 | initial configuration and virtualized services, by following the |
85 | steps in <olink targetdoc="book_enea_nfv_access_getting_started" | 85 | steps in <olink targetdoc="book_enea_nfv_access_getting_started" |
86 | targetptr="install_ena_device">Installing Enea NFV Access - uCPE | 86 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
87 | Device installation in the <xi:include | 87 | installation in the <xi:include |
88 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 88 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
89 | xmlns:xi="http://www.w3.org/2001/XInclude" | 89 | xmlns:xi="http://www.w3.org/2001/XInclude" |
90 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 90 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -92,8 +92,8 @@ | |||
92 | </row> | 92 | </row> |
93 | 93 | ||
94 | <row> | 94 | <row> |
95 | <entry>The Enea uCPE Manager upgrade fails and a working snapshot is | 95 | <entry>The Enea Edge Management upgrade fails and a working snapshot |
96 | available.</entry> | 96 | is available.</entry> |
97 | 97 | ||
98 | <entry>If a working snapshot obtained during a previous Upgrade or | 98 | <entry>If a working snapshot obtained during a previous Upgrade or |
99 | Uninstall is available | 99 | Uninstall is available |
@@ -109,7 +109,7 @@ | |||
109 | <para>Restore the previous installation as described in <olink | 109 | <para>Restore the previous installation as described in <olink |
110 | targetdoc="book_enea_nfv_access_getting_started" | 110 | targetdoc="book_enea_nfv_access_getting_started" |
111 | targetptr="restore_prev_ucpe_install">Restoring a previous | 111 | targetptr="restore_prev_ucpe_install">Restoring a previous |
112 | uCPE Manager installation in the <xi:include | 112 | Enea Edge Management installation in the <xi:include |
113 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 113 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
114 | xmlns:xi="http://www.w3.org/2001/XInclude" | 114 | xmlns:xi="http://www.w3.org/2001/XInclude" |
115 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 115 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -119,8 +119,8 @@ | |||
119 | </row> | 119 | </row> |
120 | 120 | ||
121 | <row> | 121 | <row> |
122 | <entry>The Enea uCPE Manager upgrade fails and no working snapshot | 122 | <entry>The Enea Edge Management upgrade fails and no working |
123 | is available, but a System Back-up file exists.</entry> | 123 | snapshot is available, but a System Back-up file exists.</entry> |
124 | 124 | ||
125 | <entry><orderedlist> | 125 | <entry><orderedlist> |
126 | <listitem> | 126 | <listitem> |
@@ -131,10 +131,10 @@ | |||
131 | 131 | ||
132 | <listitem> | 132 | <listitem> |
133 | <para>Perform an installation with the restore option of a | 133 | <para>Perform an installation with the restore option of a |
134 | previous Enea uCPE Manager configuration as described in | 134 | previous Enea Edge Management configuration as described in |
135 | <olink targetdoc="book_enea_nfv_access_getting_started" | 135 | <olink targetdoc="book_enea_nfv_access_getting_started" |
136 | targetptr="install_ucpemg_from_backup">Installation of the | 136 | targetptr="install_ucpemg_from_backup">Installation of the |
137 | uCPE Manager using a System Back-up in the <xi:include | 137 | Enea Edge Management using a System Back-up in the <xi:include |
138 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 138 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
139 | xmlns:xi="http://www.w3.org/2001/XInclude" | 139 | xmlns:xi="http://www.w3.org/2001/XInclude" |
140 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 140 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -145,7 +145,7 @@ | |||
145 | 145 | ||
146 | <row> | 146 | <row> |
147 | <entry>The uCPE device is booted, the ssh connection is available | 147 | <entry>The uCPE device is booted, the ssh connection is available |
148 | but the device is not connected to the Enea uCPE Manager.</entry> | 148 | but the device is not connected to the Enea Edge Management.</entry> |
149 | 149 | ||
150 | <entry><orderedlist> | 150 | <entry><orderedlist> |
151 | <listitem> | 151 | <listitem> |
@@ -155,7 +155,7 @@ | |||
155 | 155 | ||
156 | <listitem> | 156 | <listitem> |
157 | <para>Use the <emphasis role="bold">Reconnect</emphasis> | 157 | <para>Use the <emphasis role="bold">Reconnect</emphasis> |
158 | button from the Enea uCPE Manager's GUI.</para> | 158 | button from the Enea Edge Management's GUI.</para> |
159 | </listitem> | 159 | </listitem> |
160 | 160 | ||
161 | <listitem> | 161 | <listitem> |
@@ -169,8 +169,8 @@ | |||
169 | <para>If the above actions do not work, reinstall and | 169 | <para>If the above actions do not work, reinstall and |
170 | reconfigure the device using the steps provided in <olink | 170 | reconfigure the device using the steps provided in <olink |
171 | targetdoc="book_enea_nfv_access_getting_started" | 171 | targetdoc="book_enea_nfv_access_getting_started" |
172 | targetptr="install_ena_device">Installing Enea NFV Access - | 172 | targetptr="install_ena_device">Installing Enea Edge - uCPE |
173 | uCPE Device installation in the <xi:include | 173 | Device installation in the <xi:include |
174 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 174 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
175 | xmlns:xi="http://www.w3.org/2001/XInclude" | 175 | xmlns:xi="http://www.w3.org/2001/XInclude" |
176 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 176 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -186,8 +186,8 @@ | |||
186 | <entry>Perform a hardware reboot on the uCPE device. If the problem | 186 | <entry>Perform a hardware reboot on the uCPE device. If the problem |
187 | is not fixed, reinstall and reconfigure the device using the steps | 187 | is not fixed, reinstall and reconfigure the device using the steps |
188 | provided in <olink targetdoc="book_enea_nfv_access_getting_started" | 188 | provided in <olink targetdoc="book_enea_nfv_access_getting_started" |
189 | targetptr="install_ena_device">Installing Enea NFV Access - uCPE | 189 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
190 | Device installation in the <xi:include | 190 | installation in the <xi:include |
191 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 191 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
192 | xmlns:xi="http://www.w3.org/2001/XInclude" | 192 | xmlns:xi="http://www.w3.org/2001/XInclude" |
193 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 193 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
@@ -207,16 +207,16 @@ | |||
207 | <listitem> | 207 | <listitem> |
208 | <para>Reboot the device by accessing <emphasis | 208 | <para>Reboot the device by accessing <emphasis |
209 | role="bold">Operations</emphasis> and then selecting <emphasis | 209 | role="bold">Operations</emphasis> and then selecting <emphasis |
210 | role="bold">Reboot</emphasis> from within the Enea uCPE | 210 | role="bold">Reboot</emphasis> from within the Enea Edge |
211 | Manager.</para> | 211 | Management.</para> |
212 | </listitem> | 212 | </listitem> |
213 | 213 | ||
214 | <listitem> | 214 | <listitem> |
215 | <para>If the above actions do not work, redeploy all services. | 215 | <para>If the above actions do not work, redeploy all services. |
216 | This is done by cleaning up the existing configuration by | 216 | This is done by cleaning up the existing configuration by |
217 | accessing <emphasis role="bold">Operations</emphasis>, then selecting | 217 | accessing <emphasis role="bold">Operations</emphasis>, then |
218 | <emphasis role="bold">Factory Reset</emphasis> for a specific device and | 218 | selecting <emphasis role="bold">Factory Reset</emphasis> for a |
219 | redeploying the VNF services.</para> | 219 | specific device and redeploying the VNF services.</para> |
220 | </listitem> | 220 | </listitem> |
221 | </orderedlist></entry> | 221 | </orderedlist></entry> |
222 | </row> | 222 | </row> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 1b714f2..e833c2d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | |||
@@ -1,26 +1,25 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="upgrade_ena"> | 2 | <chapter id="upgrade_ena"> |
3 | <title>Upgrading Enea NFV Access</title> | 3 | <title>Upgrading Enea Edge</title> |
4 | 4 | ||
5 | <para>Enea provides regular releases that will require the upgrading of Enea | 5 | <para>Enea provides regular releases that will require the upgrading of Enea |
6 | NFV Access components. The Enea uCPE Manager must be upgraded first, | 6 | Edge components. The Enea Edge Management must be upgraded first, followed |
7 | followed by upgrading the Enea NFV Access Runtime Platform on the uCPE | 7 | by upgrading the Enea Edge Runtime on the uCPE devices.</para> |
8 | devices.</para> | ||
9 | 8 | ||
10 | <section id="upgrade_mg"> | 9 | <section id="upgrade_mg"> |
11 | <title>Upgrading the Enea uCPE Manager</title> | 10 | <title>Upgrading the Enea Edge Management</title> |
12 | 11 | ||
13 | <note> | 12 | <note> |
14 | <para>It is recommended to create a system backup by accessing <emphasis | 13 | <para>It is recommended to create a system backup by accessing <emphasis |
15 | role="bold">System</emphasis> and selecting <emphasis role="bold">System | 14 | role="bold">System</emphasis> and selecting <emphasis role="bold">System |
16 | Backup</emphasis> from the Enea uCPE Manager GUI, for recovery in case | 15 | Backup</emphasis> from the Enea Edge Management GUI, for recovery in |
17 | of an upgrade failure.</para> | 16 | case of an upgrade failure.</para> |
18 | </note> | 17 | </note> |
19 | 18 | ||
20 | <orderedlist> | 19 | <orderedlist> |
21 | <listitem> | 20 | <listitem> |
22 | <para>Extract the | 21 | <para>Extract the |
23 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename> | 22 | <filename>Enea_Edge_Management_<version>-build<build_number>.tar.gz</filename> |
24 | folder.</para> | 23 | folder.</para> |
25 | 24 | ||
26 | <para>The directory in which the archive has been unpacked will be | 25 | <para>The directory in which the archive has been unpacked will be |
@@ -33,8 +32,8 @@ | |||
33 | 32 | ||
34 | <listitem> | 33 | <listitem> |
35 | <para>Run the following command with the root account and change | 34 | <para>Run the following command with the root account and change |
36 | <literal>/opt/ems</literal> to the correct location of the Enea uCPE | 35 | <literal>/opt/ems</literal> to the correct location of the Enea Edge |
37 | Manager installation:</para> | 36 | Management installation:</para> |
38 | 37 | ||
39 | <programlisting>./upgrade.sh /opt/ems \ | 38 | <programlisting>./upgrade.sh /opt/ems \ |
40 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 39 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> |
@@ -57,7 +56,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
57 | 56 | ||
58 | <note> | 57 | <note> |
59 | <para>The snapshot file created during the upgrade can be used for | 58 | <para>The snapshot file created during the upgrade can be used for |
60 | restoring the Enea uCPE Manager.</para> | 59 | restoring the Enea Edge Management.</para> |
61 | </note> | 60 | </note> |
62 | </listitem> | 61 | </listitem> |
63 | 62 | ||
@@ -71,24 +70,25 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
71 | </listitem> | 70 | </listitem> |
72 | </itemizedlist> | 71 | </itemizedlist> |
73 | 72 | ||
74 | <para>For an example on how to upgrade an Enea uCPE Manager installation in a | 73 | <para>For an example on how to upgrade an Enea Edge Management |
75 | High Availability setup, consult <olink | 74 | installation in a High Availability setup, consult <olink |
76 | targetdoc="book_enea_nfv_access_getting_started" | 75 | targetdoc="book_enea_nfv_access_getting_started" |
77 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the | 76 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the |
78 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 77 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
79 | xpointer="element(book_enea_nfv_access_getting_started/1)" | 78 | xmlns:xi="http://www.w3.org/2001/XInclude" |
80 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> | 79 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
80 | Manual.</para> | ||
81 | 81 | ||
82 | <section id="restore_prev_ucpe_install"> | 82 | <section id="restore_prev_ucpe_install"> |
83 | <title>Restoring a previous Enea uCPE Manager Installation</title> | 83 | <title>Restoring a previous Enea Edge Management Installation</title> |
84 | 84 | ||
85 | <para><emphasis role="bold">How to restore a previous Enea uCPE Manager | 85 | <para><emphasis role="bold">How to restore a previous Enea Edge |
86 | installation</emphasis></para> | 86 | Management installation</emphasis></para> |
87 | 87 | ||
88 | <orderedlist> | 88 | <orderedlist> |
89 | <listitem> | 89 | <listitem> |
90 | <para>Extract | 90 | <para>Extract |
91 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename></para> | 91 | <filename>Enea_Edge_Management_<version>-build<build_number>.tar.gz</filename></para> |
92 | </listitem> | 92 | </listitem> |
93 | 93 | ||
94 | <listitem> | 94 | <listitem> |
@@ -99,8 +99,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
99 | <listitem> | 99 | <listitem> |
100 | <para>Copy the snapshot file | 100 | <para>Copy the snapshot file |
101 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) | 101 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) |
102 | created during a previous Enea uCPE Manager Upgrade or Enea uCPE | 102 | created during a previous Enea Edge Management Upgrade or Enea Edge |
103 | Manager Uninstall Operation into the | 103 | Management Uninstall Operation into the |
104 | <literal><uCPEM-installdir></literal> directory.</para> | 104 | <literal><uCPEM-installdir></literal> directory.</para> |
105 | </listitem> | 105 | </listitem> |
106 | 106 | ||
@@ -110,8 +110,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
110 | 110 | ||
111 | <listitem> | 111 | <listitem> |
112 | <para>Run the following command with the root user and change | 112 | <para>Run the following command with the root user and change |
113 | <literal>/opt/ems</literal> to the correct location of the Enea uCPE | 113 | <literal>/opt/ems</literal> to the correct location of the Enea Edge |
114 | Manager installation:</para> | 114 | Management installation:</para> |
115 | 115 | ||
116 | <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> | 116 | <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> |
117 | </listitem> | 117 | </listitem> |
@@ -126,9 +126,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
126 | </listitem> | 126 | </listitem> |
127 | 127 | ||
128 | <listitem> | 128 | <listitem> |
129 | <para>Reinstall the Enea uCPE Manager application on the specified | 129 | <para>Reinstall the Enea Edge Management application on the |
130 | target location, restoring the data in the database and files in the | 130 | specified target location, restoring the data in the database and |
131 | process.</para> | 131 | files in the process.</para> |
132 | </listitem> | 132 | </listitem> |
133 | </itemizedlist> | 133 | </itemizedlist> |
134 | 134 | ||
@@ -137,21 +137,22 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
137 | </section> | 137 | </section> |
138 | 138 | ||
139 | <section id="uninstall_ucpem_install"> | 139 | <section id="uninstall_ucpem_install"> |
140 | <title>Uninstalling an existing Enea uCPE Manager Installation</title> | 140 | <title>Uninstalling an existing Enea Edge Management |
141 | Installation</title> | ||
141 | 142 | ||
142 | <para><emphasis role="bold">How to uninstall an existing Enea uCPE | 143 | <para><emphasis role="bold">How to uninstall an existing Enea Edge |
143 | Manager installation</emphasis></para> | 144 | Management installation</emphasis></para> |
144 | 145 | ||
145 | <orderedlist> | 146 | <orderedlist> |
146 | <listitem> | 147 | <listitem> |
147 | <para>Navigate to the folder where the Enea uCPE Manager is | 148 | <para>Navigate to the folder where the Enea Edge Management is |
148 | installed: <filename><uCPEM-installdir></filename>.</para> | 149 | installed: <filename><uCPEM-installdir></filename>.</para> |
149 | </listitem> | 150 | </listitem> |
150 | 151 | ||
151 | <listitem> | 152 | <listitem> |
152 | <para>Run the following command with the root user and change | 153 | <para>Run the following command with the root user and change |
153 | <literal>/opt/ems</literal> to the correct location of the Enea uCPE | 154 | <literal>/opt/ems</literal> to the correct location of the Enea Edge |
154 | Manager installation:</para> | 155 | Management installation:</para> |
155 | 156 | ||
156 | <programlisting>./uninstall.sh /opt/ems</programlisting> | 157 | <programlisting>./uninstall.sh /opt/ems</programlisting> |
157 | </listitem> | 158 | </listitem> |
@@ -174,7 +175,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
174 | 175 | ||
175 | <note> | 176 | <note> |
176 | <para>The snapshot file created during the uninstall can be used | 177 | <para>The snapshot file created during the uninstall can be used |
177 | for restoring the Enea uCPE Manager.</para> | 178 | for restoring Enea Edge Management.</para> |
178 | </note> | 179 | </note> |
179 | </listitem> | 180 | </listitem> |
180 | 181 | ||
@@ -193,7 +194,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
193 | </listitem> | 194 | </listitem> |
194 | </itemizedlist> | 195 | </itemizedlist> |
195 | 196 | ||
196 | <para>After these steps, the Enea uCPE Manager is completely removed | 197 | <para>After these steps, the Enea Edge Management is completely removed |
197 | from the system.</para> | 198 | from the system.</para> |
198 | </section> | 199 | </section> |
199 | </section> | 200 | </section> |
@@ -201,7 +202,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
201 | <section id="upgrade_devices"> | 202 | <section id="upgrade_devices"> |
202 | <title>uCPE device Upgrades</title> | 203 | <title>uCPE device Upgrades</title> |
203 | 204 | ||
204 | <para>A uCPE device can be upgraded using the Enea uCPE Manager | 205 | <para>A uCPE device can be upgraded using the Enea Edge Management |
205 | GUI.</para> | 206 | GUI.</para> |
206 | 207 | ||
207 | <section id="device_up_process"> | 208 | <section id="device_up_process"> |
@@ -266,7 +267,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
266 | <note> | 267 | <note> |
267 | <para>The uCPE Device upgrade is done with image files of the type | 268 | <para>The uCPE Device upgrade is done with image files of the type |
268 | <literal>rootfs.ostree.tar.bz2</literal>, which are available in the | 269 | <literal>rootfs.ostree.tar.bz2</literal>, which are available in the |
269 | <filename>Enea_NFV_Access_Run_Time_Platform_<processor>_<version>-build<build_number>.tar.gz</filename> | 270 | <filename>Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz</filename> |
270 | file you downloaded with your release.</para> | 271 | file you downloaded with your release.</para> |
271 | </note> | 272 | </note> |
272 | 273 | ||
@@ -362,7 +363,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
362 | when to run the upgrade.</para> | 363 | when to run the upgrade.</para> |
363 | 364 | ||
364 | <note> | 365 | <note> |
365 | <para>The hour represents the local Enea uCPE Manager server | 366 | <para>The hour represents the local Enea Edge Management server |
366 | hour.</para> | 367 | hour.</para> |
367 | </note> | 368 | </note> |
368 | </listitem> | 369 | </listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml index e8c65eb..fbf7091 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml | |||
@@ -2,17 +2,17 @@ | |||
2 | <chapter id="vnf_mg"> | 2 | <chapter id="vnf_mg"> |
3 | <title>VNF Management</title> | 3 | <title>VNF Management</title> |
4 | 4 | ||
5 | <para>The Enea uCPE Manager is responsible for onboarding, configuring (e.g. | 5 | <para>The Enea Edge Management is responsible for onboarding, configuring |
6 | CloudInit) and ensuring life cycle management of VNFs that are instantiated | 6 | (e.g. CloudInit) and ensuring life cycle management of VNFs that are |
7 | and run on the various uCPE devices.</para> | 7 | instantiated and run on the various uCPE devices.</para> |
8 | 8 | ||
9 | <section id="onboarding_a_vnf"> | 9 | <section id="onboarding_a_vnf"> |
10 | <title>Onboarding a VNF</title> | 10 | <title>Onboarding a VNF</title> |
11 | 11 | ||
12 | <para>The onboarding of a VNF means adding it to the Enea uCPE Manager VNF | 12 | <para>The onboarding of a VNF means adding it to the Enea Edge Management |
13 | Catalogue and preparing it for instantiation (deployment on connected uCPE | 13 | VNF Catalogue and preparing it for instantiation (deployment on connected |
14 | devices). This is accomplished using the Enea uCPE Manager Onboarding | 14 | uCPE devices). This is accomplished using the Enea Edge Management |
15 | graphical user interface.</para> | 15 | Onboarding graphical user interface.</para> |
16 | 16 | ||
17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF | 17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF |
18 | vendor, contains all necessary information needed to onboard a VNF.</para> | 18 | vendor, contains all necessary information needed to onboard a VNF.</para> |
@@ -35,8 +35,8 @@ | |||
35 | <note> | 35 | <note> |
36 | <para>There are no standard ways of managing VNF licenses, | 36 | <para>There are no standard ways of managing VNF licenses, |
37 | therefore no general guidelines can be provided. One example of | 37 | therefore no general guidelines can be provided. One example of |
38 | license handling that can be employed in the Enea uCPE Manager is | 38 | license handling that can be employed in the Enea Edge Management |
39 | the adding of a license during the Cloud-Init setup.</para> | 39 | is the adding of a license during the Cloud-Init setup.</para> |
40 | </note> | 40 | </note> |
41 | </listitem> | 41 | </listitem> |
42 | 42 | ||
@@ -109,32 +109,35 @@ | |||
109 | </section> | 109 | </section> |
110 | 110 | ||
111 | <section id="onboard_in_ucpemg"> | 111 | <section id="onboard_in_ucpemg"> |
112 | <title>Onboarding into the Enea uCPE Manager</title> | 112 | <title>Onboarding into the Enea Edge Management</title> |
113 | 113 | ||
114 | <para><emphasis role="bold">How to onboard a VNF into the Enea uCPE | 114 | <para><emphasis role="bold">How to onboard a VNF into the Enea Edge |
115 | Manager </emphasis></para> | 115 | Management </emphasis></para> |
116 | 116 | ||
117 | <orderedlist> | 117 | <orderedlist> |
118 | <listitem> | 118 | <listitem> |
119 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> | 119 | <para>Select from the top toolbar <emphasis |
120 | and then <emphasis role="bold">Descriptors</emphasis>.</para> | 120 | role="bold">VNF</emphasis> and then <emphasis |
121 | role="bold">Descriptors</emphasis>.</para> | ||
121 | </listitem> | 122 | </listitem> |
122 | 123 | ||
123 | <listitem> | 124 | <listitem> |
124 | <para>Click the <emphasis role="bold">On-board</emphasis> button.</para> | 125 | <para>Click the <emphasis role="bold">On-board</emphasis> |
126 | button.</para> | ||
125 | </listitem> | 127 | </listitem> |
126 | 128 | ||
127 | <listitem> | 129 | <listitem> |
128 | <para>When prompted by the UI, make sure the <emphasis role="bold">VM | 130 | <para>When prompted by the UI, make sure the <emphasis |
129 | Image</emphasis> radio button at the top of the onboarding screen is | 131 | role="bold">VM Image</emphasis> radio button at the top of the |
130 | selected, it will trigger a popup menu window.</para> | 132 | onboarding screen is selected, it will trigger a popup menu |
133 | window.</para> | ||
131 | </listitem> | 134 | </listitem> |
132 | </orderedlist> | 135 | </orderedlist> |
133 | 136 | ||
134 | <para>This window contains data fields where both necessary and optional | 137 | <para>This window contains data fields where both necessary and optional |
135 | information about the VNF can be supplied. After doing so, press the | 138 | information about the VNF can be supplied. After doing so, press the |
136 | Onboard button, the Enea uCPE Manager will create the VNF descriptor and | 139 | Onboard button, the Enea Edge Management will create the VNF descriptor |
137 | add it to its VNF Catalog.</para> | 140 | and add it to its VNF Catalog.</para> |
138 | 141 | ||
139 | <figure> | 142 | <figure> |
140 | <title>Onboard a VNF</title> | 143 | <title>Onboard a VNF</title> |
@@ -153,8 +156,8 @@ | |||
153 | <listitem> | 156 | <listitem> |
154 | <para><emphasis role="bold">VM Image File</emphasis>. This is the | 157 | <para><emphasis role="bold">VM Image File</emphasis>. This is the |
155 | Virtual Machine image file for the VNF. Typically, it is a QCOW | 158 | Virtual Machine image file for the VNF. Typically, it is a QCOW |
156 | image. Press <emphasis role="bold">Choose File</emphasis> and select the image you | 159 | image. Press <emphasis role="bold">Choose File</emphasis> and select |
157 | wish to upload.</para> | 160 | the image you wish to upload.</para> |
158 | </listitem> | 161 | </listitem> |
159 | 162 | ||
160 | <listitem> | 163 | <listitem> |
@@ -171,7 +174,7 @@ | |||
171 | <listitem> | 174 | <listitem> |
172 | <para><emphasis role="bold">Description</emphasis>. This field | 175 | <para><emphasis role="bold">Description</emphasis>. This field |
173 | contains any description provided and is only displayed in the GUI | 176 | contains any description provided and is only displayed in the GUI |
174 | tables in the Enea uCPE Manager.</para> | 177 | tables in the Enea Edge Management.</para> |
175 | </listitem> | 178 | </listitem> |
176 | 179 | ||
177 | <listitem> | 180 | <listitem> |
@@ -203,14 +206,14 @@ | |||
203 | 206 | ||
204 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> | 207 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> |
205 | 208 | ||
206 | <para>Click on the <emphasis role="bold">Interfaces</emphasis> tab to show the | 209 | <para>Click on the <emphasis role="bold">Interfaces</emphasis> tab to |
207 | Interfaces table.</para> | 210 | show the Interfaces table.</para> |
208 | 211 | ||
209 | <para>This table will contain the interfaces required by this VNF to be | 212 | <para>This table will contain the interfaces required by this VNF to be |
210 | configured, when creating an instance. Consult the VNF vendor to | 213 | configured, when creating an instance. Consult the VNF vendor to |
211 | determine which and how many are required. Each interface requires a | 214 | determine which and how many are required. Each interface requires a |
212 | name, and optionally a description, used only by the Enea uCPE | 215 | name, and optionally a description, used only by the Enea Edge |
213 | Manager.</para> | 216 | Management.</para> |
214 | 217 | ||
215 | <note> | 218 | <note> |
216 | <para>CAUTION: The user MUST conserve the same order for the virtual | 219 | <para>CAUTION: The user MUST conserve the same order for the virtual |
@@ -219,9 +222,9 @@ | |||
219 | 222 | ||
220 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 223 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
221 | 224 | ||
222 | <para>Click the <emphasis role="bold">Cloud Init</emphasis> tab to provide the | 225 | <para>Click the <emphasis role="bold">Cloud Init</emphasis> tab to |
223 | Cloud-Init configuration. There are three fields that need to be | 226 | provide the Cloud-Init configuration. There are three fields that need |
224 | populated:</para> | 227 | to be populated:</para> |
225 | 228 | ||
226 | <orderedlist> | 229 | <orderedlist> |
227 | <listitem> | 230 | <listitem> |
@@ -273,7 +276,7 @@ | |||
273 | <para>The <literal>Content Files Table</literal> is ONLY used if | 276 | <para>The <literal>Content Files Table</literal> is ONLY used if |
274 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init | 277 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init |
275 | Datasource. For each content file added, a <literal>Path</literal> | 278 | Datasource. For each content file added, a <literal>Path</literal> |
276 | must be provided. When the Enea uCPE Manager is used to create an | 279 | must be provided. When the Enea Edge Management is used to create an |
277 | instance for multiple VNFs, the user will be prompted to provide a | 280 | instance for multiple VNFs, the user will be prompted to provide a |
278 | data file for each entry in this table. Each type of VNF will | 281 | data file for each entry in this table. Each type of VNF will |
279 | require different cloud-init files, e.g.: a license file. The data | 282 | require different cloud-init files, e.g.: a license file. The data |
@@ -292,9 +295,9 @@ | |||
292 | <para>In this table, you can enter values for properties that will be | 295 | <para>In this table, you can enter values for properties that will be |
293 | used during instantiation of the VNF. The values will augment the | 296 | used during instantiation of the VNF. The values will augment the |
294 | default values in the <filename>domain.xml</filename> file used by | 297 | default values in the <filename>domain.xml</filename> file used by |
295 | <literal>libvirt/virsh</literal> (running in Enea NFV Access) when | 298 | <literal>libvirt/virsh</literal> (running in Enea Edge) when creating an |
296 | creating an instance of the VNF. Consult with the VNF Vendor or ENEA | 299 | instance of the VNF. Consult with the VNF Vendor or ENEA support for |
297 | support for values needed by specific VNFs.</para> | 300 | values needed by specific VNFs.</para> |
298 | 301 | ||
299 | <para><emphasis role="bold">Property Values</emphasis></para> | 302 | <para><emphasis role="bold">Property Values</emphasis></para> |
300 | 303 | ||
@@ -349,8 +352,8 @@ | |||
349 | 352 | ||
350 | <orderedlist> | 353 | <orderedlist> |
351 | <listitem> | 354 | <listitem> |
352 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> and | 355 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> |
353 | choose <emphasis role="bold">Instances</emphasis>.</para> | 356 | and choose <emphasis role="bold">Instances</emphasis>.</para> |
354 | </listitem> | 357 | </listitem> |
355 | 358 | ||
356 | <listitem> | 359 | <listitem> |
@@ -406,13 +409,14 @@ | |||
406 | </listitem> | 409 | </listitem> |
407 | 410 | ||
408 | <listitem> | 411 | <listitem> |
409 | <para>Hit the <emphasis role="bold">Create</emphasis> button to deploy the VNF and | 412 | <para>Hit the <emphasis role="bold">Create</emphasis> button to deploy |
410 | run it on the specified uCPE device.</para> | 413 | the VNF and run it on the specified uCPE device.</para> |
411 | </listitem> | 414 | </listitem> |
412 | </orderedlist> | 415 | </orderedlist> |
413 | 416 | ||
414 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then choosing <emphasis role="bold">Events</emphasis> | 417 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then |
415 | will show that the VNF was created and a connection was established.</para> | 418 | choosing <emphasis role="bold">Events</emphasis> will show that the VNF |
419 | was created and a connection was established.</para> | ||
416 | </section> | 420 | </section> |
417 | 421 | ||
418 | <section id="enter_console"> | 422 | <section id="enter_console"> |
@@ -425,8 +429,9 @@ | |||
425 | 429 | ||
426 | <orderedlist> | 430 | <orderedlist> |
427 | <listitem> | 431 | <listitem> |
428 | <para>SSH to the uCPE device from the Enea uCPE Manager | 432 | <para>SSH to the uCPE device from the Enea Edge Management (Access the |
429 | (Access the <emphasis role="bold">Device</emphasis> menu and select <emphasis role="bold">SSH</emphasis>) using:</para> | 433 | <emphasis role="bold">Device</emphasis> menu and select <emphasis |
434 | role="bold">SSH</emphasis>) using:</para> | ||
430 | 435 | ||
431 | <itemizedlist> | 436 | <itemizedlist> |
432 | <listitem> | 437 | <listitem> |
@@ -440,12 +445,13 @@ | |||
440 | <para>For reverse ssh connections (ssh to a uCPE device behind | 445 | <para>For reverse ssh connections (ssh to a uCPE device behind |
441 | NAT): the <literal>Username</literal> (default: root) and the | 446 | NAT): the <literal>Username</literal> (default: root) and the |
442 | <literal>Reverse ssh</literal> checkbox checked. The port will be | 447 | <literal>Reverse ssh</literal> checkbox checked. The port will be |
443 | automatically choosen by the Enea uCPE Manager in the range | 448 | automatically chosen by the Enea Edge Management in the range |
444 | defined in the <emphasis role="bold">SSH</emphasis> configuration panel, | 449 | defined in the <emphasis role="bold">SSH</emphasis> configuration |
445 | available when accessing <emphasis role="bold">System</emphasis>, then | 450 | panel, available when accessing <emphasis |
446 | <emphasis role="bold">Configuration</emphasis> and choosing <emphasis role="bold">Reverse | 451 | role="bold">System</emphasis>, then <emphasis |
447 | SSH</emphasis> . By default, the start port will | 452 | role="bold">Configuration</emphasis> and choosing <emphasis |
448 | be <literal>7000</literal> and the maximum number of ports | 453 | role="bold">Reverse SSH</emphasis> . By default, the start port |
454 | will be <literal>7000</literal> and the maximum number of ports | ||
449 | allocated to all devices is 10. Only one port per device is | 455 | allocated to all devices is 10. Only one port per device is |
450 | allowed.</para> | 456 | allowed.</para> |
451 | 457 | ||
diff --git a/doc/book-enea-nfv-access-getting-started/swcomp.mk b/doc/book-enea-nfv-access-getting-started/swcomp.mk index ca6439f..52b433e 100755 --- a/doc/book-enea-nfv-access-getting-started/swcomp.mk +++ b/doc/book-enea-nfv-access-getting-started/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-getting-started | 8 | BOOKPACKAGES := book-enea-nfv-access-getting-started |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Getting Started" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Getting Started" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
diff --git a/doc/book-enea-nfv-access-platform-open-source/doc/about.xml b/doc/book-enea-nfv-access-platform-open-source/doc/about.xml index 377562c..2a8bf01 100644 --- a/doc/book-enea-nfv-access-platform-open-source/doc/about.xml +++ b/doc/book-enea-nfv-access-platform-open-source/doc/about.xml | |||
@@ -4,5 +4,5 @@ | |||
4 | <chapter id="platform-open-source-packages-and-licenses"> | 4 | <chapter id="platform-open-source-packages-and-licenses"> |
5 | <title>About this Report</title> | 5 | <title>About this Report</title> |
6 | 6 | ||
7 | <para>This document contains the open source and license information pertaining to packages provided with this release of the Enea NFV Access Runtime Platform and the Installer.</para> | 7 | <para>This document contains the open source and license information pertaining to packages provided with this release of the Enea Edge Runtime and the Installer.</para> |
8 | </chapter> \ No newline at end of file | 8 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-platform-open-source/doc/book.xml b/doc/book-enea-nfv-access-platform-open-source/doc/book.xml index a17bb3d..1150b11 100644 --- a/doc/book-enea-nfv-access-platform-open-source/doc/book.xml +++ b/doc/book-enea-nfv-access-platform-open-source/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_platform_open_source"> | 6 | <book id="book_enea_nfv_access_platform_open_source"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Runtime Platform Open Source Report</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Runtime Open Source Report</title> |
8 | <subtitle>Release Version | 8 | <subtitle>Release Version |
9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> |
diff --git a/doc/book-enea-nfv-access-platform-open-source/doc/licenses.xml b/doc/book-enea-nfv-access-platform-open-source/doc/licenses.xml index 352f820..6f9aa06 100644 --- a/doc/book-enea-nfv-access-platform-open-source/doc/licenses.xml +++ b/doc/book-enea-nfv-access-platform-open-source/doc/licenses.xml | |||
@@ -538,13 +538,13 @@ specific documentation.--> | |||
538 | <row> | 538 | <row> |
539 | <entry>enea-nfv-access-vnf</entry> | 539 | <entry>enea-nfv-access-vnf</entry> |
540 | <entry>1.0</entry> | 540 | <entry>1.0</entry> |
541 | <entry>VNF image of the Enea NFV Access Platform includes kernel rootfs and boot parameters</entry> | 541 | <entry>VNF image of the Enea Edge Runtime includes kernel rootfs and boot parameters</entry> |
542 | <entry>MIT</entry> | 542 | <entry>MIT</entry> |
543 | </row> | 543 | </row> |
544 | <row> | 544 | <row> |
545 | <entry>enea-nfv-access</entry> | 545 | <entry>enea-nfv-access</entry> |
546 | <entry>1.0</entry> | 546 | <entry>1.0</entry> |
547 | <entry>Image for the host side of the Enea NFV Access Platform with ODM and NETCONF Edgelink customizations</entry> | 547 | <entry>Image for the host side of the Enea Edge Runtime with ODM and NETCONF Edgelink customizations</entry> |
548 | <entry>MIT</entry> | 548 | <entry>MIT</entry> |
549 | </row> | 549 | </row> |
550 | <row> | 550 | <row> |
@@ -1738,13 +1738,13 @@ specific documentation.--> | |||
1738 | <row> | 1738 | <row> |
1739 | <entry>nfv-installer</entry> | 1739 | <entry>nfv-installer</entry> |
1740 | <entry>1.0</entry> | 1740 | <entry>1.0</entry> |
1741 | <entry>Enea NFV Access installer</entry> | 1741 | <entry>Enea Edge installer</entry> |
1742 | <entry>Enea</entry> | 1742 | <entry>Enea</entry> |
1743 | </row> | 1743 | </row> |
1744 | <row> | 1744 | <row> |
1745 | <entry>nfva-cfgtool</entry> | 1745 | <entry>nfva-cfgtool</entry> |
1746 | <entry>1.0</entry> | 1746 | <entry>1.0</entry> |
1747 | <entry>Command line tool to for accessing the Enea NFV Access install configuration json file</entry> | 1747 | <entry>Command line tool to for accessing the Enea Edge install configuration json file</entry> |
1748 | <entry>Enea</entry> | 1748 | <entry>Enea</entry> |
1749 | </row> | 1749 | </row> |
1750 | <row> | 1750 | <row> |
@@ -1960,7 +1960,7 @@ specific documentation.--> | |||
1960 | <row> | 1960 | <row> |
1961 | <entry>packagegroup-enea-wifi</entry> | 1961 | <entry>packagegroup-enea-wifi</entry> |
1962 | <entry>1.0</entry> | 1962 | <entry>1.0</entry> |
1963 | <entry>This package group includes packages and packagegroups that enable WiFi connectivity in the Enea NFV Access platform</entry> | 1963 | <entry>This package group includes packages and packagegroups that enable WiFi connectivity in the Enea Edge Runtime</entry> |
1964 | <entry>MIT</entry> | 1964 | <entry>MIT</entry> |
1965 | </row> | 1965 | </row> |
1966 | <row> | 1966 | <row> |
diff --git a/doc/book-enea-nfv-access-platform-open-source/swcomp.mk b/doc/book-enea-nfv-access-platform-open-source/swcomp.mk index fc62acc..20202e4 100644 --- a/doc/book-enea-nfv-access-platform-open-source/swcomp.mk +++ b/doc/book-enea-nfv-access-platform-open-source/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-platform-open-source | 8 | BOOKPACKAGES := book-enea-nfv-access-platform-open-source |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access Runtime Platform Open Source Report" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge Runtime Open Source Report" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
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 2078a30..960f136 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 | |||
@@ -4,13 +4,13 @@ | |||
4 | <chapter id="relinfo-about-release"> | 4 | <chapter id="relinfo-about-release"> |
5 | <title>About This Release</title> | 5 | <title>About This Release</title> |
6 | 6 | ||
7 | <para>Enea NFV Access is a complete NFVI software platform designed for | 7 | <para>Enea Edge is a complete NFVI software platform designed for |
8 | deployment on any white box uCPE device, and optimized for common use cases. | 8 | deployment on any white box uCPE device, and optimized for common use cases. |
9 | Enea NFV Access includes both the Runtime Platform deployed on a white box, | 9 | Enea Edge includes both the Enea Edge Runtime deployed on a white box, |
10 | and a management component with automation tools deployed in a private or | 10 | and a management component with automation tools deployed in a private or |
11 | public cloud.</para> | 11 | public cloud.</para> |
12 | 12 | ||
13 | <para>The Enea NFV Access <xi:include | 13 | <para>The Enea Edge <xi:include |
14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
15 | xmlns:xi="http://www.w3.org/2001/XInclude" | 15 | xmlns:xi="http://www.w3.org/2001/XInclude" |
16 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of | 16 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of |
@@ -20,29 +20,29 @@ | |||
20 | Improvements</xref>.</para> | 20 | Improvements</xref>.</para> |
21 | 21 | ||
22 | <section id="release-content"> | 22 | <section id="release-content"> |
23 | <title>Enea NFV Access Release Content</title> | 23 | <title>Enea Edge Release Content</title> |
24 | 24 | ||
25 | <para>The release content is detailed below:</para> | 25 | <para>The release content is detailed below:</para> |
26 | 26 | ||
27 | <itemizedlist> | 27 | <itemizedlist> |
28 | <listitem> | 28 | <listitem> |
29 | <para>Enea_NFV_Access_Run_Time_Platform_C3000_<version>-build<build_number>.tar.gz</para> | 29 | <para>Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz</para> |
30 | </listitem> | 30 | </listitem> |
31 | 31 | ||
32 | <listitem> | 32 | <listitem> |
33 | <para>Enea_NFV_Access_Run_Time_Platform_XeonD_<version>-build<build_number>.tar.gz</para> | 33 | <para>Enea_Edge_Runtime_XeonD_<version>-build<build_number>.tar.gz</para> |
34 | </listitem> | 34 | </listitem> |
35 | 35 | ||
36 | <listitem> | 36 | <listitem> |
37 | <para>Enea_NFV_Access_AutomationFramework_<version>-build<build_number>.zip</para> | 37 | <para>Enea_Edge_Automation_<version>-build<build_number>.zip</para> |
38 | </listitem> | 38 | </listitem> |
39 | 39 | ||
40 | <listitem> | 40 | <listitem> |
41 | <para>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</para> | 41 | <para>Enea_Edge_Management_<version>-build<build_number>.tar.gz</para> |
42 | </listitem> | 42 | </listitem> |
43 | 43 | ||
44 | <listitem> | 44 | <listitem> |
45 | <para>Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz</para> | 45 | <para>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</para> |
46 | </listitem> | 46 | </listitem> |
47 | 47 | ||
48 | <listitem> | 48 | <listitem> |
@@ -50,14 +50,14 @@ | |||
50 | </listitem> | 50 | </listitem> |
51 | 51 | ||
52 | <listitem> | 52 | <listitem> |
53 | <para>Enea_NFV_Access_AF-TH_<version>-build<build_number>.zip | 53 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip |
54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and | 54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and |
55 | Improvements</xref>.)</para> | 55 | Improvements</xref>.)</para> |
56 | </listitem> | 56 | </listitem> |
57 | </itemizedlist> | 57 | </itemizedlist> |
58 | 58 | ||
59 | <programlisting condition="arm">-- documentation/ | 59 | <programlisting condition="arm">-- documentation/ |
60 | /* Enea NFV Access documentation */ | 60 | /* Enea Edge documentation */ |
61 | -- README | 61 | -- README |
62 | -- aarch64 /* architecture */ | 62 | -- aarch64 /* architecture */ |
63 | -- cn8304/ | 63 | -- cn8304/ |
@@ -104,13 +104,13 @@ | |||
104 | <section id="relinfo-documentation"> | 104 | <section id="relinfo-documentation"> |
105 | <title>User Documentation</title> | 105 | <title>User Documentation</title> |
106 | 106 | ||
107 | <para>This release of Enea NFV Access contains the following set of | 107 | <para>This release of Enea Edge contains the following set of |
108 | documents:</para> | 108 | documents:</para> |
109 | 109 | ||
110 | <itemizedlist> | 110 | <itemizedlist> |
111 | <listitem> | 111 | <listitem> |
112 | <para>Enea NFV Access Release Information. Describes the Enea NFV | 112 | <para>Enea Edge Release Information. Describes the Enea Edge |
113 | Access release content, main changes, the list of known issues and | 113 | release content, main changes, the list of known issues and |
114 | limitations.</para> | 114 | limitations.</para> |
115 | </listitem> | 115 | </listitem> |
116 | 116 | ||
@@ -118,7 +118,7 @@ | |||
118 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 118 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
119 | xmlns:xi="http://www.w3.org/2001/XInclude" | 119 | xmlns:xi="http://www.w3.org/2001/XInclude" |
120 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. | 120 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. |
121 | Describes how to deploy and upgrade an Enea NFV Access base | 121 | Describes how to deploy and upgrade an Enea Edge base |
122 | configuration, advanced configurations of the system and | 122 | configuration, advanced configurations of the system and |
123 | troubleshooting information.</para> | 123 | troubleshooting information.</para> |
124 | </listitem> | 124 | </listitem> |
@@ -135,14 +135,14 @@ | |||
135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
136 | xmlns:xi="http://www.w3.org/2001/XInclude" | 136 | xmlns:xi="http://www.w3.org/2001/XInclude" |
137 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />. | 137 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />. |
138 | Describes the Automation Framework for Enea NFV Access.</para> | 138 | Describes the Automation Framework for Enea Edge.</para> |
139 | </listitem> | 139 | </listitem> |
140 | 140 | ||
141 | <listitem> | 141 | <listitem> |
142 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 142 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
143 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" | 143 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" |
144 | xmlns:xi="http://www.w3.org/2001/XInclude" />. Describes the | 144 | xmlns:xi="http://www.w3.org/2001/XInclude" />. Describes the |
145 | Automation Framework and Test Harness for Enea NFV Access and | 145 | Automation Framework and Test Harness for Enea Edge and |
146 | provides instructions regarding the necessary steps to run these | 146 | provides instructions regarding the necessary steps to run these |
147 | software tools (deprecated, see | 147 | software tools (deprecated, see |
148 | <xref linkend="relinfo-changes-other">Section 2.1 New Features | 148 | <xref linkend="relinfo-changes-other">Section 2.1 New Features |
@@ -153,7 +153,7 @@ | |||
153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
154 | xmlns:xi="http://www.w3.org/2001/XInclude" | 154 | xmlns:xi="http://www.w3.org/2001/XInclude" |
155 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" />. | 155 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" />. |
156 | Describes a sample Test Suite for System Testing of Enea NFV Access. | 156 | Describes a sample Test Suite for System Testing of Enea Edge. |
157 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 | 157 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 |
158 | New Features and Improvements</xref>).</para> | 158 | New Features and Improvements</xref>).</para> |
159 | </listitem> | 159 | </listitem> |
diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml index 4a1e390..cffe9b5 100644 --- a/doc/book-enea-nfv-access-release-info/doc/book.xml +++ b/doc/book-enea-nfv-access-release-info/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_release_info"> | 6 | <book id="book_enea_nfv_access_release_info"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Release | 7 | <title><trademark class="registered">Enea</trademark> Edge Release |
8 | Information</title> | 8 | Information</title> |
9 | 9 | ||
10 | <subtitle>Release Version | 10 | <subtitle>Release Version |
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 31d3a03..d71deff 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 | |||
@@ -9,7 +9,7 @@ | |||
9 | 9 | ||
10 | <itemizedlist> | 10 | <itemizedlist> |
11 | <listitem> | 11 | <listitem> |
12 | <para><remark>LXCR-9904</remark>Enea NFV Access cannot be installed on | 12 | <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on |
13 | USB storage devices.</para> | 13 | USB storage devices.</para> |
14 | </listitem> | 14 | </listitem> |
15 | 15 | ||
@@ -20,13 +20,13 @@ | |||
20 | 20 | ||
21 | <listitem> | 21 | <listitem> |
22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea | 22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea |
23 | uCPE Manager will require the user to close and reopen the upload window | 23 | Edge Management will require the user to close and reopen the upload window |
24 | for the next upload to work.</para> | 24 | for the next upload to work.</para> |
25 | </listitem> | 25 | </listitem> |
26 | 26 | ||
27 | <listitem> | 27 | <listitem> |
28 | <para><remark>ELCCR-577</remark>If a uCPEM is restored from a backup | 28 | <para><remark>ELCCR-577</remark>If Enea Edge Management is restored from a backup |
29 | made on a release version older than 2.2.3, VNFs cannot be instantiated | 29 | made on a release version older than Enea NFV Access 2.2.3, VNFs cannot be instantiated |
30 | from the GUI.</para> | 30 | from the GUI.</para> |
31 | </listitem> | 31 | </listitem> |
32 | 32 | ||
@@ -45,8 +45,7 @@ | |||
45 | <listitem> | 45 | <listitem> |
46 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be | 46 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be |
47 | instantiated on the Xeon-D architectures due to missing CPU features in | 47 | instantiated on the Xeon-D architectures due to missing CPU features in |
48 | the VNF's domain XML. This impacts all example use cases and AF&TH | 48 | the VNF's domain XML. This impacts all example use cases where the Juniper VNF is used.</para> |
49 | tests where the Juniper VNF is used.</para> | ||
50 | </listitem> | 49 | </listitem> |
51 | 50 | ||
52 | <listitem> | 51 | <listitem> |
@@ -58,33 +57,33 @@ | |||
58 | <listitem> | 57 | <listitem> |
59 | <para><remark>LXCR-9992</remark>Depending on hardware capabilities, | 58 | <para><remark>LXCR-9992</remark>Depending on hardware capabilities, |
60 | there are certain limitations regarding the <literal>vfio-pci</literal> | 59 | there are certain limitations regarding the <literal>vfio-pci</literal> |
61 | and <literal>igb_uio</literal> drivers. While the Enea NFV Access Run | 60 | and <literal>igb_uio</literal> drivers. While the Enea Edge |
62 | Time Platform uses the <literal>vfio-pci</literal> driver by default, | 61 | Runtime uses the <literal>vfio-pci</literal> driver by default, |
63 | for certain hardware configurations, <literal>igb_uio</literal> should | 62 | for certain hardware configurations, <literal>igb_uio</literal> should |
64 | be used instead, by providing custom scripting. Please contact Enea for | 63 | be used instead, by providing custom scripting. Please contact Enea for |
65 | further details.</para> | 64 | further details.</para> |
66 | </listitem> | 65 | </listitem> |
67 | 66 | ||
68 | <listitem> | 67 | <listitem> |
69 | <para><remark>STCR-6224</remark>The Enea NFV Access Automation Framework | 68 | <para><remark>STCR-6224</remark>The Enea Edge Automation |
70 | and the Enea NFV Access Automation Framework and Test Harness do not | 69 | and the Enea Edge Automation Framework and Test Harness do not |
71 | support multiple custom scripts uploaded to a uCPE device at the same | 70 | support multiple custom scripts uploaded to a uCPE device at the same |
72 | time.</para> | 71 | time.</para> |
73 | </listitem> | 72 | </listitem> |
74 | 73 | ||
75 | <listitem> | 74 | <listitem> |
76 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | 75 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not |
77 | implemented in the Automation Framework and Test Harness.</para> | 76 | implemented in the Enea Edge Automation Framework and Test Harness.</para> |
78 | </listitem> | 77 | </listitem> |
79 | 78 | ||
80 | <listitem> | 79 | <listitem> |
81 | <para><remark>USERDOCAP-628</remark>Enea NFV Access Automation Framework | 80 | <para><remark>USERDOCAP-628</remark>Enea Edge Automation Framework |
82 | and Test Harness does not have support for product features implemented | 81 | and Test Harness does not have support for product features implemented |
83 | in Enea NFV Access 2.4.0 or newer.</para> | 82 | in Enea Edge 2.4.0 or newer.</para> |
84 | </listitem> | 83 | </listitem> |
85 | 84 | ||
86 | <listitem> | 85 | <listitem> |
87 | <para><remark>ELCCR-912</remark>When the Enea uCPE Manager is installed | 86 | <para><remark>ELCCR-912</remark>When the Enea Edge Management is installed |
88 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an | 87 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an |
89 | upgrade image fails. As a workaround, please update <literal>glib2</literal> | 88 | upgrade image fails. As a workaround, please update <literal>glib2</literal> |
90 | to version 2.54.2 or later, using <literal>#yum update glib2</literal>.</para> | 89 | to version 2.54.2 or later, using <literal>#yum update glib2</literal>.</para> |
@@ -101,8 +100,8 @@ | |||
101 | </listitem> | 100 | </listitem> |
102 | 101 | ||
103 | <listitem> | 102 | <listitem> |
104 | <para><remark>USERDOCAP-641</remark>Enea NFV Access does not have support | 103 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have support |
105 | for IPv6 addresses on both uCPE devices and the Enea uCPE Manager | 104 | for IPv6 addresses on both uCPE devices and the Enea Edge Management |
106 | installation.</para> | 105 | installation.</para> |
107 | </listitem> | 106 | </listitem> |
108 | 107 | ||
@@ -125,14 +124,14 @@ | |||
125 | 124 | ||
126 | <listitem> | 125 | <listitem> |
127 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for | 126 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for |
128 | the Enea uCPE Manager is generated at build time, with a hard-coded common-name | 127 | the Enea Edge Management is generated at build time, with a hard-coded common-name |
129 | causing the uCPE device upgrade to fail in HTTPS mode. As a workaround, | 128 | causing the uCPE device upgrade to fail in HTTPS mode. As a workaround, |
130 | another certificate (containing an IP based common-name) must be generated.</para> | 129 | another certificate (containing an IP based common-name) must be generated.</para> |
131 | 130 | ||
132 | <para>Perform the following the steps to generate the certificate:</para> | 131 | <para>Perform the following the steps to generate the certificate:</para> |
133 | 132 | ||
134 | <orderedlist> | 133 | <orderedlist> |
135 | <listitem><para>Stop the uCPE Manager service.</para></listitem> | 134 | <listitem><para>Stop the Enea Edge Management service.</para></listitem> |
136 | 135 | ||
137 | <listitem><para>Create the certificate using the | 136 | <listitem><para>Create the certificate using the |
138 | <filename>createCertificate.sh</filename> script from distribution | 137 | <filename>createCertificate.sh</filename> script from distribution |
@@ -141,7 +140,7 @@ | |||
141 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal> | 140 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal> |
142 | folder.</para></listitem> | 141 | folder.</para></listitem> |
143 | 142 | ||
144 | <listitem><para>Start the Enea uCPE Manager, the new certificate | 143 | <listitem><para>Start the Enea Edge Management, the new certificate |
145 | should now take effect.</para></listitem> | 144 | should now take effect.</para></listitem> |
146 | </orderedlist> | 145 | </orderedlist> |
147 | </listitem> | 146 | </listitem> |
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 10faf28..c01a149 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 | |||
@@ -6,8 +6,7 @@ | |||
6 | 6 | ||
7 | <para>Below you'll find information about the new features and updates made | 7 | <para>Below you'll find information about the new features and updates made |
8 | in this release, as well as details on the provided packages and the | 8 | in this release, as well as details on the provided packages and the |
9 | backwards compatibility with previous versions of Enea NFV Access if | 9 | backwards compatibility with previous versions.</para> |
10 | applicable.</para> | ||
11 | 10 | ||
12 | <section id="relinfo-changes-other"> | 11 | <section id="relinfo-changes-other"> |
13 | <title>New Features and Improvements</title> | 12 | <title>New Features and Improvements</title> |
@@ -27,22 +26,22 @@ | |||
27 | 26 | ||
28 | <listitem> | 27 | <listitem> |
29 | <para><remark>CPDX-3498</remark>High Availability support with redundant | 28 | <para><remark>CPDX-3498</remark>High Availability support with redundant |
30 | Enea uCPE Managers in active standby configuration.</para> | 29 | Enea Edge Management in active standby configuration.</para> |
31 | </listitem> | 30 | </listitem> |
32 | 31 | ||
33 | <listitem> | 32 | <listitem> |
34 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for | 33 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for |
35 | simplified deployment of the Enea uCPE Manager in cloud | 34 | simplified deployment of the Enea Edge Management in cloud |
36 | environments.</para> | 35 | environments.</para> |
37 | </listitem> | 36 | </listitem> |
38 | 37 | ||
39 | <listitem> | 38 | <listitem> |
40 | <para><remark>CPDX-3500</remark>The Enea NFV Access Automation | 39 | <para><remark>CPDX-3500</remark>The Enea Edge Automation, |
41 | Framework, a tool for automatic system configuration based on Python | 40 | a tool for automatic system configuration based on Python |
42 | scripting that will replace the existing Enea NFV Access Automation | 41 | scripting that will replace the existing Enea Edge Automation |
43 | Framework and Test Harness in the next major release.</para> | 42 | Framework and Test Harness in the next major release.</para> |
44 | 43 | ||
45 | <para>The Enea NFV Access Automation Framework and Test Harness, and | 44 | <para>The Enea Edge Automation Framework and Test Harness, and |
46 | its related documentation the <xi:include | 45 | its related documentation the <xi:include |
47 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 46 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
48 | xmlns:xi="http://www.w3.org/2001/XInclude" | 47 | xmlns:xi="http://www.w3.org/2001/XInclude" |
@@ -50,7 +49,7 @@ | |||
50 | and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 49 | and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
51 | xmlns:xi="http://www.w3.org/2001/XInclude" | 50 | xmlns:xi="http://www.w3.org/2001/XInclude" |
52 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" /> | 51 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" /> |
53 | are deprecated starting with Enea NFV Access 2.4.0.</para> | 52 | are deprecated starting with Enea Edge 2.4.0.</para> |
54 | </listitem> | 53 | </listitem> |
55 | </itemizedlist> | 54 | </itemizedlist> |
56 | 55 | ||
@@ -85,15 +84,15 @@ | |||
85 | <itemizedlist> | 84 | <itemizedlist> |
86 | <listitem> | 85 | <listitem> |
87 | <para>Platform Snapshots allow users to store, manage and restore | 86 | <para>Platform Snapshots allow users to store, manage and restore |
88 | snapshots of the Enea NFV Access Runtime Platform configuration, | 87 | snapshots of the Enea Edge Runtime configuration, |
89 | with the purpose of recovering after a failed reconfiguration. | 88 | with the purpose of recovering after a failed reconfiguration. |
90 | This feature is disabled by default.</para> | 89 | This feature is disabled by default.</para> |
91 | </listitem> | 90 | </listitem> |
92 | 91 | ||
93 | <listitem> | 92 | <listitem> |
94 | <para>VNF Snapshots allow users to store, manage and restore | 93 | <para>VNF Snapshots allow users to store, manage and restore |
95 | snapshots of VNFs deployed on the Enea NFV Access Runtime | 94 | snapshots of VNFs deployed on the Enea Edge |
96 | Platform, with the purpose of restoring the VNF after a persistent | 95 | Runtime, with the purpose of restoring the VNF after a persistent |
97 | VNF failure. This feature is disabled by default.</para> | 96 | VNF failure. This feature is disabled by default.</para> |
98 | </listitem> | 97 | </listitem> |
99 | </itemizedlist> | 98 | </itemizedlist> |
@@ -117,39 +116,39 @@ | |||
117 | <title>Open Source</title> | 116 | <title>Open Source</title> |
118 | 117 | ||
119 | <para>For more information about the Open Source packages included, please | 118 | <para>For more information about the Open Source packages included, please |
120 | refer to the Enea NFV Access Open Source Reports listed below. Each report | 119 | refer to the Enea Edge Open Source Reports listed below. Each report |
121 | contains open source and license information pertaining to packages | 120 | contains open source and license information pertaining to packages |
122 | provided with this release, for their respective component.</para> | 121 | provided with this release, for their respective component.</para> |
123 | 122 | ||
124 | <itemizedlist> | 123 | <itemizedlist> |
125 | <listitem> | 124 | <listitem> |
126 | <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 125 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
127 | xpointer="element(book_enea_nfv_access_platform_open_source/1)" | 126 | xpointer="element(book_enea_nfv_access_platform_open_source/1)" |
128 | xmlns:ns="http://www.w3.org/2001/XInclude" />.</para> | 127 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> |
129 | </listitem> | 128 | </listitem> |
130 | 129 | ||
131 | <listitem> | 130 | <listitem> |
132 | <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 131 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
133 | xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" | 132 | xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" |
134 | xmlns:ns="http://www.w3.org/2001/XInclude" />.</para> | 133 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> |
135 | </listitem> | 134 | </listitem> |
136 | 135 | ||
137 | <listitem> | 136 | <listitem> |
138 | <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 137 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
139 | xpointer="element(book_enea_nfv_access_telemetry_open_source/1)" | 138 | xpointer="element(book_enea_nfv_access_telemetry_open_source/1)" |
140 | xmlns:ns="http://www.w3.org/2001/XInclude" />.</para> | 139 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> |
141 | </listitem> | 140 | </listitem> |
142 | 141 | ||
143 | <listitem> | 142 | <listitem> |
144 | <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 143 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
145 | xpointer="element(book_enea_nfv_access_auto_fw_open_source/1)" | 144 | xpointer="element(book_enea_nfv_access_auto_fw_open_source/1)" |
146 | xmlns:ns="http://www.w3.org/2001/XInclude" />.</para> | 145 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> |
147 | </listitem> | 146 | </listitem> |
148 | 147 | ||
149 | <listitem> | 148 | <listitem> |
150 | <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 149 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
151 | xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)" | 150 | xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)" |
152 | xmlns:ns="http://www.w3.org/2001/XInclude" />.</para> | 151 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> |
153 | </listitem> | 152 | </listitem> |
154 | </itemizedlist> | 153 | </itemizedlist> |
155 | </section> | 154 | </section> |
diff --git a/doc/book-enea-nfv-access-release-info/swcomp.mk b/doc/book-enea-nfv-access-release-info/swcomp.mk index 3ba7c8d..76991ee 100644 --- a/doc/book-enea-nfv-access-release-info/swcomp.mk +++ b/doc/book-enea-nfv-access-release-info/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-release-info | 8 | BOOKPACKAGES := book-enea-nfv-access-release-info |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Release Information" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Release Information" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/book.xml b/doc/book-enea-nfv-access-system-test-specification/doc/book.xml index 2620554..9192ef5 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/book.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_system_test_specification"> | 6 | <book id="book_enea_nfv_access_system_test_specification"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access System Test Specification</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge System Test Specification</title> |
8 | 8 | ||
9 | <subtitle>Release Version | 9 | <subtitle>Release Version |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml index 4345326..62d9b72 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml | |||
@@ -5,8 +5,8 @@ | |||
5 | <section id="test_objects"> | 5 | <section id="test_objects"> |
6 | <title>Test Objects</title> | 6 | <title>Test Objects</title> |
7 | 7 | ||
8 | <para>The test objects for the Test Harness are the Enea NFV Access and | 8 | <para>The test objects for the Test Harness are the Enea Edge and |
9 | Enea uCPE Manager installations performed as indicated in the <olink | 9 | Enea Edge Management installations performed as indicated in the <olink |
10 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" | 10 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" |
11 | targetptr="components">Components chapter of the <xi:include | 11 | targetptr="components">Components chapter of the <xi:include |
12 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 12 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
@@ -44,7 +44,7 @@ | |||
44 | 44 | ||
45 | <note> | 45 | <note> |
46 | <para>Before running any test case, make sure the uCPE device(s) needed | 46 | <para>Before running any test case, make sure the uCPE device(s) needed |
47 | have been added to the uCPE Manager.</para> | 47 | have been added to the Enea Edge Management.</para> |
48 | </note> | 48 | </note> |
49 | 49 | ||
50 | <para>For detailed execution steps of the sample test cases included with | 50 | <para>For detailed execution steps of the sample test cases included with |
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml index 5a04673..07c5ef7 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml | |||
@@ -3,7 +3,7 @@ | |||
3 | <title>Overview</title> | 3 | <title>Overview</title> |
4 | 4 | ||
5 | <para>This document describes the Test Harness (TH) sample test cases for | 5 | <para>This document describes the Test Harness (TH) sample test cases for |
6 | the System Testing of Enea NFV Access, and the necessary environment setup | 6 | the System Testing of Enea Edge, and the necessary environment setup |
7 | to run these tests successfully.</para> | 7 | to run these tests successfully.</para> |
8 | 8 | ||
9 | <section id="def_acro_sts"> | 9 | <section id="def_acro_sts"> |
@@ -25,10 +25,10 @@ | |||
25 | 25 | ||
26 | <tbody> | 26 | <tbody> |
27 | <row> | 27 | <row> |
28 | <entry>Enea NFV Access</entry> | 28 | <entry>Enea Edge</entry> |
29 | 29 | ||
30 | <entry>The Enea NFV Access (with ODM) Runtime Platform and the | 30 | <entry>The Enea Edge (with ODM) Runtime and the |
31 | Enea uCPE Manager.</entry> | 31 | Enea Edge Management.</entry> |
32 | </row> | 32 | </row> |
33 | </tbody> | 33 | </tbody> |
34 | </tgroup> | 34 | </tgroup> |
@@ -52,7 +52,7 @@ | |||
52 | <row> | 52 | <row> |
53 | <entry>AF</entry> | 53 | <entry>AF</entry> |
54 | 54 | ||
55 | <entry>Automation Framework for Enea NFV Access.</entry> | 55 | <entry>Automation Framework for Enea Edge.</entry> |
56 | </row> | 56 | </row> |
57 | 57 | ||
58 | <row> | 58 | <row> |
@@ -88,11 +88,11 @@ | |||
88 | <row> | 88 | <row> |
89 | <entry>TH</entry> | 89 | <entry>TH</entry> |
90 | 90 | ||
91 | <entry>Test Harness for Enea NFV Access.</entry> | 91 | <entry>Test Harness for Enea Edge.</entry> |
92 | </row> | 92 | </row> |
93 | 93 | ||
94 | <row> | 94 | <row> |
95 | <entry>uCPE Manager</entry> | 95 | <entry>Enea Edge Management</entry> |
96 | 96 | ||
97 | <entry>Enea Universal Customer Premises Equipment Manager.</entry> | 97 | <entry>Enea Universal Customer Premises Equipment Manager.</entry> |
98 | </row> | 98 | </row> |
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 2fa087b..b1bfa1e 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 | |||
@@ -9,14 +9,14 @@ | |||
9 | <title>VNF, Device and Network Smoke Test Cases</title> | 9 | <title>VNF, Device and Network Smoke Test Cases</title> |
10 | 10 | ||
11 | <para>The following is an automated test suite that acts as basic smoke | 11 | <para>The following is an automated test suite that acts as basic smoke |
12 | tests for Enea NFV Access, and as a sanity-check test suite for the AF and | 12 | tests for Enea Edge, and as a sanity-check test suite for the AF and |
13 | TH.</para> | 13 | TH.</para> |
14 | 14 | ||
15 | <section id="onb_vnf_image"> | 15 | <section id="onb_vnf_image"> |
16 | <title>VNF - Onboard a VNF Image</title> | 16 | <title>VNF - Onboard a VNF Image</title> |
17 | 17 | ||
18 | <para><emphasis role="bold">Description: </emphasis>Onboarding a VNF | 18 | <para><emphasis role="bold">Description: </emphasis>Onboarding a VNF |
19 | Image into the uCPE Manager. For details please refer to:</para> | 19 | Image into the Enea Edge Management. For details please refer to:</para> |
20 | 20 | ||
21 | <itemizedlist> | 21 | <itemizedlist> |
22 | <listitem> | 22 | <listitem> |
@@ -61,7 +61,7 @@ vnfd=<VNF-Descriptor-name>"</programlisting></para> | |||
61 | <title>VNF - Offboard a VNF</title> | 61 | <title>VNF - Offboard a VNF</title> |
62 | 62 | ||
63 | <para><emphasis role="bold">Description:</emphasis> Removing a VNF | 63 | <para><emphasis role="bold">Description:</emphasis> Removing a VNF |
64 | Descriptor from the uCPE Manager. For details please refer to:</para> | 64 | Descriptor from the Enea Edge Management. For details please refer to:</para> |
65 | 65 | ||
66 | <itemizedlist> | 66 | <itemizedlist> |
67 | <listitem> | 67 | <listitem> |
@@ -74,7 +74,7 @@ vnfd=<VNF-Descriptor-name>"</programlisting></para> | |||
74 | </itemizedlist> | 74 | </itemizedlist> |
75 | 75 | ||
76 | <para><emphasis role="bold">Precondition:</emphasis> The VNF has been | 76 | <para><emphasis role="bold">Precondition:</emphasis> The VNF has been |
77 | previously onboarded in the uCPE Manager instance.</para> | 77 | previously onboarded in the Enea Edge Management instance.</para> |
78 | 78 | ||
79 | <para><emphasis role="bold">Action:</emphasis> Run the | 79 | <para><emphasis role="bold">Action:</emphasis> Run the |
80 | <filename>offboardVNF.yml</filename> Ansible Playbook with the | 80 | <filename>offboardVNF.yml</filename> Ansible Playbook with the |
@@ -93,7 +93,7 @@ vnfd=<VNF-Descriptor-name>"</programlisting></para> | |||
93 | <title>Device - Add a device</title> | 93 | <title>Device - Add a device</title> |
94 | 94 | ||
95 | <para><emphasis role="bold">Description:</emphasis> Adding a uCPE device | 95 | <para><emphasis role="bold">Description:</emphasis> Adding a uCPE device |
96 | to the uCPE Manager. For details please refer to:</para> | 96 | to the Enea Edge Management. For details please refer to:</para> |
97 | 97 | ||
98 | <itemizedlist> | 98 | <itemizedlist> |
99 | <listitem> | 99 | <listitem> |
@@ -123,10 +123,10 @@ vnfd=<VNF-Descriptor-name>"</programlisting></para> | |||
123 | </section> | 123 | </section> |
124 | 124 | ||
125 | <section id="device_upload_image"> | 125 | <section id="device_upload_image"> |
126 | <title>Device - Upload a NFV Access image</title> | 126 | <title>Device - Upload a Edge image</title> |
127 | 127 | ||
128 | <para><emphasis role="bold">Description:</emphasis> Upload a NFV Access | 128 | <para><emphasis role="bold">Description:</emphasis> Upload a Edge |
129 | image file onto the uCPE Manager. For details please refer to:</para> | 129 | image file onto the Enea Edge Management. For details please refer to:</para> |
130 | 130 | ||
131 | <itemizedlist> | 131 | <itemizedlist> |
132 | <listitem> | 132 | <listitem> |
@@ -172,7 +172,7 @@ A file with the same name is already uploaded.</programlisting></para> | |||
172 | <title>Device - Delete Upgraded File</title> | 172 | <title>Device - Delete Upgraded File</title> |
173 | 173 | ||
174 | <para><emphasis role="bold">Description:</emphasis> Deleting an uploaded | 174 | <para><emphasis role="bold">Description:</emphasis> Deleting an uploaded |
175 | NFV Access image file from the uCPE Manager. For details please refer | 175 | Edge image file from the Enea Edge Management. For details please refer |
176 | to:</para> | 176 | to:</para> |
177 | 177 | ||
178 | <itemizedlist> | 178 | <itemizedlist> |
@@ -186,7 +186,7 @@ A file with the same name is already uploaded.</programlisting></para> | |||
186 | </itemizedlist> | 186 | </itemizedlist> |
187 | 187 | ||
188 | <para><emphasis role="bold">Preconditions:</emphasis> The image file | 188 | <para><emphasis role="bold">Preconditions:</emphasis> The image file |
189 | must already be uploaded onto the uCPE Manager.</para> | 189 | must already be uploaded onto the Enea Edge Management.</para> |
190 | 190 | ||
191 | <para><emphasis role="bold">Action:</emphasis> Run the | 191 | <para><emphasis role="bold">Action:</emphasis> Run the |
192 | <filename>deleteUpgradeFile.yml</filename> Ansible Playbook with the | 192 | <filename>deleteUpgradeFile.yml</filename> Ansible Playbook with the |
@@ -237,10 +237,10 @@ localhost : ok=1 changed=1 unreachable=0 failed=0</pro | |||
237 | </section> | 237 | </section> |
238 | 238 | ||
239 | <section id="dev_inst_activ"> | 239 | <section id="dev_inst_activ"> |
240 | <title>Device - Install and Activate a NFV Access image</title> | 240 | <title>Device - Install and Activate a Edge image</title> |
241 | 241 | ||
242 | <para><emphasis role="bold">Description:</emphasis> Installing and | 242 | <para><emphasis role="bold">Description:</emphasis> Installing and |
243 | Activating a NFV Access image on a uCPE device from the uCPE Manager. | 243 | Activating a Edge image on a uCPE device from the Enea Edge Management. |
244 | For details please refer to:</para> | 244 | For details please refer to:</para> |
245 | 245 | ||
246 | <itemizedlist> | 246 | <itemizedlist> |
@@ -255,13 +255,13 @@ localhost : ok=1 changed=1 unreachable=0 failed=0</pro | |||
255 | 255 | ||
256 | <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist> | 256 | <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist> |
257 | <listitem> | 257 | <listitem> |
258 | <para>The device must be previously added to the uCPE Manager | 258 | <para>The device must be previously added to the Enea Edge Management |
259 | instance.</para> | 259 | instance.</para> |
260 | </listitem> | 260 | </listitem> |
261 | 261 | ||
262 | <listitem> | 262 | <listitem> |
263 | <para>The image file must already be uploaded onto the uCPE | 263 | <para>The image file must already be uploaded onto the Enea Edge |
264 | Manager.</para> | 264 | Management.</para> |
265 | </listitem> | 265 | </listitem> |
266 | </itemizedlist></para> | 266 | </itemizedlist></para> |
267 | 267 | ||
@@ -291,11 +291,11 @@ Duplicate entry - Release already installed</programlisting></para> | |||
291 | </section> | 291 | </section> |
292 | 292 | ||
293 | <section id="dev_upload_inst_activ"> | 293 | <section id="dev_upload_inst_activ"> |
294 | <title>Device - Upload, Install and Activate a NFV Access image on a | 294 | <title>Device - Upload, Install and Activate a Edge image on a |
295 | uCPE device</title> | 295 | uCPE device</title> |
296 | 296 | ||
297 | <para><emphasis role="bold">Description:</emphasis> Upload, install and | 297 | <para><emphasis role="bold">Description:</emphasis> Upload, install and |
298 | activate a NFV Access image on a uCPE device from the uCPE Manager. For | 298 | activate a Edge image on a uCPE device from the Enea Edge Management. For |
299 | details please refer to:</para> | 299 | details please refer to:</para> |
300 | 300 | ||
301 | <itemizedlist> | 301 | <itemizedlist> |
@@ -335,7 +335,7 @@ Duplicate entry - Release already installed</programlisting></para> | |||
335 | 335 | ||
336 | <itemizedlist> | 336 | <itemizedlist> |
337 | <listitem> | 337 | <listitem> |
338 | <para>The device has to be previously added to the uCPE Manager | 338 | <para>The device has to be previously added to the Enea Edge Management |
339 | instance.</para> | 339 | instance.</para> |
340 | </listitem> | 340 | </listitem> |
341 | 341 | ||
@@ -371,7 +371,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
371 | <title>Device - Wait a Device</title> | 371 | <title>Device - Wait a Device</title> |
372 | 372 | ||
373 | <para><emphasis role="bold">Description:</emphasis> Wait for a uCPE | 373 | <para><emphasis role="bold">Description:</emphasis> Wait for a uCPE |
374 | device to connect to the uCPE Manager. For details please refer | 374 | device to connect to the Enea Edge Management. For details please refer |
375 | to:</para> | 375 | to:</para> |
376 | 376 | ||
377 | <itemizedlist> | 377 | <itemizedlist> |
@@ -388,7 +388,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
388 | 388 | ||
389 | <itemizedlist> | 389 | <itemizedlist> |
390 | <listitem> | 390 | <listitem> |
391 | <para>The device has to be previously added to the uCPE Manager | 391 | <para>The device has to be previously added to the Enea Edge Management |
392 | instance.</para> | 392 | instance.</para> |
393 | </listitem> | 393 | </listitem> |
394 | 394 | ||
@@ -413,7 +413,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
413 | <title>Device - Remove a Device</title> | 413 | <title>Device - Remove a Device</title> |
414 | 414 | ||
415 | <para><emphasis role="bold">Description:</emphasis> Removing a uCPE | 415 | <para><emphasis role="bold">Description:</emphasis> Removing a uCPE |
416 | device from the uCPE Manager. For details please refer to:</para> | 416 | device from the Enea Edge Management. For details please refer to:</para> |
417 | 417 | ||
418 | <itemizedlist> | 418 | <itemizedlist> |
419 | <listitem> | 419 | <listitem> |
@@ -429,7 +429,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
429 | 429 | ||
430 | <itemizedlist> | 430 | <itemizedlist> |
431 | <listitem> | 431 | <listitem> |
432 | <para>The device has to be previously added to the uCPE Manager | 432 | <para>The device has to be previously added to the Enea Edge Management |
433 | instance.</para> | 433 | instance.</para> |
434 | </listitem> | 434 | </listitem> |
435 | 435 | ||
@@ -472,7 +472,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
472 | <itemizedlist> | 472 | <itemizedlist> |
473 | <listitem> | 473 | <listitem> |
474 | <para>A device must have been previously added and connected to the | 474 | <para>A device must have been previously added and connected to the |
475 | uCPE Manager instance.</para> | 475 | Enea Edge Management instance.</para> |
476 | </listitem> | 476 | </listitem> |
477 | 477 | ||
478 | <listitem> | 478 | <listitem> |
@@ -517,7 +517,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
517 | 517 | ||
518 | <itemizedlist> | 518 | <itemizedlist> |
519 | <listitem> | 519 | <listitem> |
520 | <para>A NIC is bound to a device in a uCPE Manager instance.</para> | 520 | <para>A NIC is bound to a device in a Enea Edge Management instance.</para> |
521 | </listitem> | 521 | </listitem> |
522 | 522 | ||
523 | <listitem> | 523 | <listitem> |
@@ -556,7 +556,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
556 | 556 | ||
557 | <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist> | 557 | <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist> |
558 | <listitem> | 558 | <listitem> |
559 | <para>A NIC is bound to a device in a uCPE Manager | 559 | <para>A NIC is bound to a device in a Enea Edge Management |
560 | instance.</para> | 560 | instance.</para> |
561 | </listitem> | 561 | </listitem> |
562 | 562 | ||
@@ -599,7 +599,7 @@ upgrade_type=xeon_d</programlisting></para> | |||
599 | 599 | ||
600 | <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist> | 600 | <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist> |
601 | <listitem> | 601 | <listitem> |
602 | <para>A Bridge exists for a device in a uCPE Manager | 602 | <para>A Bridge exists for a device in a Enea Edge Management |
603 | instance.</para> | 603 | instance.</para> |
604 | </listitem> | 604 | </listitem> |
605 | 605 | ||
@@ -638,8 +638,8 @@ bridge=<Bridge-name>"</programlisting></para> | |||
638 | 638 | ||
639 | <para><emphasis role="bold">Precondition: </emphasis></para> | 639 | <para><emphasis role="bold">Precondition: </emphasis></para> |
640 | 640 | ||
641 | <para>A device must have been previously added and connected to the uCPE | 641 | <para>A device must have been previously added and connected to the Enea Edge |
642 | Manager instance.</para> | 642 | Management instance.</para> |
643 | 643 | ||
644 | <para><emphasis role="bold">Action:</emphasis> Run the | 644 | <para><emphasis role="bold">Action:</emphasis> Run the |
645 | <filename>configDPDK.yml</filename> Ansible Playbook with the | 645 | <filename>configDPDK.yml</filename> Ansible Playbook with the |
@@ -657,11 +657,11 @@ DEBUG: Set DPDK state to <enable/disable></programlisting><emphasis | |||
657 | </section> | 657 | </section> |
658 | 658 | ||
659 | <section id="cs_upload"> | 659 | <section id="cs_upload"> |
660 | <title>Custom Scripts - Upload a Custom Script to the uCPE | 660 | <title>Custom Scripts - Upload a Custom Script to the Enea Edge |
661 | Manager</title> | 661 | Management</title> |
662 | 662 | ||
663 | <para><emphasis role="bold">Description:</emphasis> Upload a Custom | 663 | <para><emphasis role="bold">Description:</emphasis> Upload a Custom |
664 | Script to the uCPE Manager. For details please refer to:</para> | 664 | Script to the Enea Edge Management. For details please refer to:</para> |
665 | 665 | ||
666 | <itemizedlist> | 666 | <itemizedlist> |
667 | <listitem> | 667 | <listitem> |
@@ -689,15 +689,15 @@ phase= | |||
689 | run using the Test Harness:</para> | 689 | run using the Test Harness:</para> |
690 | 690 | ||
691 | <programlisting># Upload Custom Script task result | 691 | <programlisting># Upload Custom Script task result |
692 | DEBUG: "{{ scriptName }} was uploaded to uCPE Manager!"</programlisting> | 692 | DEBUG: "{{ scriptName }} was uploaded to Enea Edge Management!"</programlisting> |
693 | </section> | 693 | </section> |
694 | 694 | ||
695 | <section id="cs_upload_device"> | 695 | <section id="cs_upload_device"> |
696 | <title>Custom Scripts - Upload a Custom Script from the uCPE Manager to | 696 | <title>Custom Scripts - Upload a Custom Script from the Enea Edge Management to |
697 | a Device</title> | 697 | a Device</title> |
698 | 698 | ||
699 | <para><emphasis role="bold">Description:</emphasis> Upload a Custom | 699 | <para><emphasis role="bold">Description:</emphasis> Upload a Custom |
700 | Script from the uCPE Manager to a Device. For details please refer | 700 | Script from the Enea Edge Management to a Device. For details please refer |
701 | to:</para> | 701 | to:</para> |
702 | 702 | ||
703 | <itemizedlist> | 703 | <itemizedlist> |
@@ -715,12 +715,12 @@ DEBUG: "{{ scriptName }} was uploaded to uCPE Manager!"</programlisting> | |||
715 | <itemizedlist> | 715 | <itemizedlist> |
716 | <listitem> | 716 | <listitem> |
717 | <para>A device must have been previously added and connected to the | 717 | <para>A device must have been previously added and connected to the |
718 | uCPE Manager instance.</para> | 718 | Enea Edge Management instance.</para> |
719 | </listitem> | 719 | </listitem> |
720 | 720 | ||
721 | <listitem> | 721 | <listitem> |
722 | <para>A Custom Script must have been previously added to the uCPE | 722 | <para>A Custom Script must have been previously added to the Enea Edge |
723 | Manager instance.</para> | 723 | Management instance.</para> |
724 | </listitem> | 724 | </listitem> |
725 | </itemizedlist> | 725 | </itemizedlist> |
726 | 726 | ||
@@ -741,11 +741,11 @@ DEBUG: "{{ scriptName }} was uploaded to {{ device }}!"</programlisting> | |||
741 | </section> | 741 | </section> |
742 | 742 | ||
743 | <section id="cs_remove"> | 743 | <section id="cs_remove"> |
744 | <title>Custom Scripts - Remove a Custom Script from the uCPE | 744 | <title>Custom Scripts - Remove a Custom Script from the Enea Edge |
745 | Manager</title> | 745 | Management</title> |
746 | 746 | ||
747 | <para><emphasis role="bold">Description:</emphasis> Remove a Custom | 747 | <para><emphasis role="bold">Description:</emphasis> Remove a Custom |
748 | Script from the uCPE Manager. For details please refer to:</para> | 748 | Script from the Enea Edge Management. For details please refer to:</para> |
749 | 749 | ||
750 | <itemizedlist> | 750 | <itemizedlist> |
751 | <listitem> | 751 | <listitem> |
@@ -759,8 +759,8 @@ DEBUG: "{{ scriptName }} was uploaded to {{ device }}!"</programlisting> | |||
759 | 759 | ||
760 | <para><emphasis role="bold">Precondition:</emphasis></para> | 760 | <para><emphasis role="bold">Precondition:</emphasis></para> |
761 | 761 | ||
762 | <para>A Custom Script must have been previously added to the uCPE | 762 | <para>A Custom Script must have been previously added to the Enea Edge |
763 | Manager.</para> | 763 | Management.</para> |
764 | 764 | ||
765 | <para><emphasis role="bold">Action:</emphasis> Run the | 765 | <para><emphasis role="bold">Action:</emphasis> Run the |
766 | <filename>removeCustomScript.yml</filename> Ansible Playbook with the | 766 | <filename>removeCustomScript.yml</filename> Ansible Playbook with the |
@@ -772,8 +772,8 @@ phase= | |||
772 | <para><emphasis role="bold">Result:</emphasis> Output of the test case | 772 | <para><emphasis role="bold">Result:</emphasis> Output of the test case |
773 | run using the Test Harness:</para> | 773 | run using the Test Harness:</para> |
774 | 774 | ||
775 | <programlisting># Remove Custom Script in phase from uCPE Manager task result | 775 | <programlisting># Remove Custom Script in phase from Enea Edge Management task result |
776 | DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from uCPE Manager!"</programlisting> | 776 | DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from Enea Edge Management!"</programlisting> |
777 | </section> | 777 | </section> |
778 | 778 | ||
779 | <section id="cs_remove_device"> | 779 | <section id="cs_remove_device"> |
@@ -797,7 +797,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from uCPE Manager!"< | |||
797 | <itemizedlist> | 797 | <itemizedlist> |
798 | <listitem> | 798 | <listitem> |
799 | <para>A device must have been previously added and connected to the | 799 | <para>A device must have been previously added and connected to the |
800 | uCPE Manager instance.</para> | 800 | Enea Edge Management instance.</para> |
801 | </listitem> | 801 | </listitem> |
802 | 802 | ||
803 | <listitem> | 803 | <listitem> |
@@ -827,7 +827,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
827 | Store</title> | 827 | Store</title> |
828 | 828 | ||
829 | <para><emphasis role="bold">Description:</emphasis> Adding an Offline | 829 | <para><emphasis role="bold">Description:</emphasis> Adding an Offline |
830 | Config Store to the uCPE Manager. For details please refer to:</para> | 830 | Config Store to the Enea Edge Management. For details please refer to:</para> |
831 | 831 | ||
832 | <itemizedlist> | 832 | <itemizedlist> |
833 | <listitem> | 833 | <listitem> |
@@ -842,7 +842,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
842 | <para><emphasis role="bold">Precondition:</emphasis><itemizedlist> | 842 | <para><emphasis role="bold">Precondition:</emphasis><itemizedlist> |
843 | <listitem> | 843 | <listitem> |
844 | <para>The Offline Configuration Store should not already exist on | 844 | <para>The Offline Configuration Store should not already exist on |
845 | the uCPE Manager. If it exists, the test will report a | 845 | the Enea Edge Management. If it exists, the test will report a |
846 | duplicate.</para> | 846 | duplicate.</para> |
847 | </listitem> | 847 | </listitem> |
848 | 848 | ||
@@ -872,7 +872,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
872 | Store</title> | 872 | Store</title> |
873 | 873 | ||
874 | <para><emphasis role="bold">Description:</emphasis> Removing an Offline | 874 | <para><emphasis role="bold">Description:</emphasis> Removing an Offline |
875 | Config Store from the uCPE Manager. For details please refer to:</para> | 875 | Config Store from the Enea Edge Management. For details please refer to:</para> |
876 | 876 | ||
877 | <itemizedlist> | 877 | <itemizedlist> |
878 | <listitem> | 878 | <listitem> |
@@ -887,7 +887,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
887 | <para><emphasis role="bold">Precondition:</emphasis></para> | 887 | <para><emphasis role="bold">Precondition:</emphasis></para> |
888 | 888 | ||
889 | <para>The Offline Configuration Store the user wishes to remove should | 889 | <para>The Offline Configuration Store the user wishes to remove should |
890 | exist in the uCPE Manager. If it does not, the test will say so.</para> | 890 | exist in the Enea Edge Management. If it does not, the test will say so.</para> |
891 | 891 | ||
892 | <para><emphasis role="bold">Action:</emphasis> Run the | 892 | <para><emphasis role="bold">Action:</emphasis> Run the |
893 | <filename>removeConfigStore.yml</filename> Ansible Playbook with the | 893 | <filename>removeConfigStore.yml</filename> Ansible Playbook with the |
@@ -908,7 +908,7 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
908 | Configuration Store</title> | 908 | Configuration Store</title> |
909 | 909 | ||
910 | <para><emphasis role="bold">Description:</emphasis> Adding a network | 910 | <para><emphasis role="bold">Description:</emphasis> Adding a network |
911 | bridge to an Offline Config Store in uCPE Manager. For details please | 911 | bridge to an Offline Config Store in Enea Edge Management. For details please |
912 | refer to:</para> | 912 | refer to:</para> |
913 | 913 | ||
914 | <itemizedlist> | 914 | <itemizedlist> |
@@ -925,8 +925,8 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
925 | 925 | ||
926 | <itemizedlist> | 926 | <itemizedlist> |
927 | <listitem> | 927 | <listitem> |
928 | <para>The Offline Configuration Store should exist in the uCPE | 928 | <para>The Offline Configuration Store should exist in the Enea Edge |
929 | Manager. If it does not, the test will say so.</para> | 929 | Management. If it does not, the test will say so.</para> |
930 | </listitem> | 930 | </listitem> |
931 | 931 | ||
932 | <listitem> | 932 | <listitem> |
@@ -980,8 +980,8 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< | |||
980 | 980 | ||
981 | <para><emphasis role="bold">Precondition:</emphasis></para> | 981 | <para><emphasis role="bold">Precondition:</emphasis></para> |
982 | 982 | ||
983 | <para>An empty Offline Configuration Store should exist in uCPE | 983 | <para>An empty Offline Configuration Store should exist in Enea Edge |
984 | Manager.</para> | 984 | Management.</para> |
985 | 985 | ||
986 | <para><emphasis role="bold">Action:</emphasis> Run the | 986 | <para><emphasis role="bold">Action:</emphasis> Run the |
987 | <filename>configOfflineDPDK.yml</filename> Ansible Playbook with the | 987 | <filename>configOfflineDPDK.yml</filename> Ansible Playbook with the |
@@ -1022,12 +1022,12 @@ INFO: Done</programlisting> | |||
1022 | 1022 | ||
1023 | <itemizedlist> | 1023 | <itemizedlist> |
1024 | <listitem> | 1024 | <listitem> |
1025 | <para>The Offline Configuration Store should exist in the uCPE | 1025 | <para>The Offline Configuration Store should exist in the Enea Edge |
1026 | Manager.</para> | 1026 | Management.</para> |
1027 | </listitem> | 1027 | </listitem> |
1028 | 1028 | ||
1029 | <listitem> | 1029 | <listitem> |
1030 | <para>The device should be connected to the uCPE Manager.</para> | 1030 | <para>The device should be connected to the Enea Edge Management.</para> |
1031 | </listitem> | 1031 | </listitem> |
1032 | </itemizedlist> | 1032 | </itemizedlist> |
1033 | 1033 | ||
@@ -1078,7 +1078,7 @@ INFO: Done</programlisting> | |||
1078 | </listitem> | 1078 | </listitem> |
1079 | 1079 | ||
1080 | <listitem> | 1080 | <listitem> |
1081 | <para>The device should be connected to the uCPE Manager.</para> | 1081 | <para>The device should be connected to the Enea Edge Management.</para> |
1082 | </listitem> | 1082 | </listitem> |
1083 | </itemizedlist> | 1083 | </itemizedlist> |
1084 | 1084 | ||
@@ -1109,8 +1109,7 @@ INFO: Done</programlisting> | |||
1109 | <title>VNF Deployment and Lifecycle</title> | 1109 | <title>VNF Deployment and Lifecycle</title> |
1110 | 1110 | ||
1111 | <para>The following details the automated suite that handles the testing | 1111 | <para>The following details the automated suite that handles the testing |
1112 | of the instantiation, lifecycle and destruction of a VNF for Enea NFV | 1112 | of the instantiation, lifecycle and destruction of a VNF for Enea Edge.</para> |
1113 | Access.</para> | ||
1114 | 1113 | ||
1115 | <section id="inst_vnfi"> | 1114 | <section id="inst_vnfi"> |
1116 | <title>Instantiating a VNFI</title> | 1115 | <title>Instantiating a VNFI</title> |
@@ -1131,7 +1130,7 @@ INFO: Done</programlisting> | |||
1131 | <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist> | 1130 | <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist> |
1132 | <listitem> | 1131 | <listitem> |
1133 | <para>A VNF Image is onboarded and a device is added and connected | 1132 | <para>A VNF Image is onboarded and a device is added and connected |
1134 | to the uCPE Manager. Depending on the VNF, other steps may be | 1133 | to the Enea Edge Management. Depending on the VNF, other steps may be |
1135 | required.</para> | 1134 | required.</para> |
1136 | </listitem> | 1135 | </listitem> |
1137 | 1136 | ||
@@ -1250,8 +1249,8 @@ vnfi=<VNFI-name>"</programlisting><emphasis | |||
1250 | </listitem> | 1249 | </listitem> |
1251 | 1250 | ||
1252 | <listitem> | 1251 | <listitem> |
1253 | <para>Wait for the uCPE device to be connected in the Enea uCPE | 1252 | <para>Wait for the uCPE device to be connected in the Enea Edge |
1254 | Manager.</para> | 1253 | Management.</para> |
1255 | </listitem> | 1254 | </listitem> |
1256 | 1255 | ||
1257 | <listitem> | 1256 | <listitem> |
@@ -1272,7 +1271,7 @@ vnfi=<VNFI-name>"</programlisting><emphasis | |||
1272 | 1271 | ||
1273 | <listitem> | 1272 | <listitem> |
1274 | <para>Instantiate the FortiGate VNF using the basic Firewall | 1273 | <para>Instantiate the FortiGate VNF using the basic Firewall |
1275 | configuration provided with your Enea NFV Access Release, and the | 1274 | configuration provided with your Enea Edge Release, and the |
1276 | Fortigate License file.</para> | 1275 | Fortigate License file.</para> |
1277 | 1276 | ||
1278 | <note> | 1277 | <note> |
@@ -1323,7 +1322,7 @@ vnfi=<VNFI-name>"</programlisting><emphasis | |||
1323 | <itemizedlist> | 1322 | <itemizedlist> |
1324 | <listitem> | 1323 | <listitem> |
1325 | <para>A device must have been previously added and connected to | 1324 | <para>A device must have been previously added and connected to |
1326 | the uCPE Manager instance.</para> | 1325 | the Enea Edge Management instance.</para> |
1327 | </listitem> | 1326 | </listitem> |
1328 | 1327 | ||
1329 | <listitem> | 1328 | <listitem> |
@@ -1447,7 +1446,7 @@ FortigateFWInstance tested successfully!</programlisting></para> | |||
1447 | <itemizedlist> | 1446 | <itemizedlist> |
1448 | <listitem> | 1447 | <listitem> |
1449 | <para>A device must have been previously added and connected to | 1448 | <para>A device must have been previously added and connected to |
1450 | the uCPE Manager instance.</para> | 1449 | the Enea Edge Management instance.</para> |
1451 | </listitem> | 1450 | </listitem> |
1452 | 1451 | ||
1453 | <listitem> | 1452 | <listitem> |
@@ -1500,9 +1499,9 @@ FortigateFWInstance tested successfully!</programlisting></para> | |||
1500 | <listitem> | 1499 | <listitem> |
1501 | <para><olink targetdoc="book_enea_nfv_access_example_usecases" | 1500 | <para><olink targetdoc="book_enea_nfv_access_example_usecases" |
1502 | targetptr="fortigate_firewall_uc_1">FortiGate VNF as a | 1501 | targetptr="fortigate_firewall_uc_1">FortiGate VNF as a |
1503 | Firewall in the <ns:include | 1502 | Firewall in the <xi:include |
1504 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1503 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1505 | xmlns:ns="http://www.w3.org/2001/XInclude" | 1504 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1506 | xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink> | 1505 | xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink> |
1507 | Manual.</para> | 1506 | Manual.</para> |
1508 | </listitem> | 1507 | </listitem> |
@@ -1511,8 +1510,8 @@ FortigateFWInstance tested successfully!</programlisting></para> | |||
1511 | <para><olink | 1510 | <para><olink |
1512 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" | 1511 | targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" |
1513 | targetptr="python_testsuite">Python Unit-Test Suite in | 1512 | targetptr="python_testsuite">Python Unit-Test Suite in |
1514 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1513 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1515 | xmlns:ns="http://www.w3.org/2001/XInclude" | 1514 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1516 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>.</para> | 1515 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>.</para> |
1517 | </listitem> | 1516 | </listitem> |
1518 | </itemizedlist> | 1517 | </itemizedlist> |
@@ -1542,7 +1541,7 @@ FortigateFW Scenario deployed successfully!</programlisting></para> | |||
1542 | 1541 | ||
1543 | <para><emphasis role="bold">Description:</emphasis> This sample test | 1542 | <para><emphasis role="bold">Description:</emphasis> This sample test |
1544 | case corresponds to the "VNF Chaining Example Use-case" from the Enea | 1543 | case corresponds to the "VNF Chaining Example Use-case" from the Enea |
1545 | NFV Access Example Use-cases manual.</para> | 1544 | Edge Example Use-cases manual.</para> |
1546 | 1545 | ||
1547 | <para>For details please refer to:</para> | 1546 | <para>For details please refer to:</para> |
1548 | 1547 | ||
@@ -1565,7 +1564,7 @@ FortigateFW Scenario deployed successfully!</programlisting></para> | |||
1565 | <itemizedlist> | 1564 | <itemizedlist> |
1566 | <listitem> | 1565 | <listitem> |
1567 | <para>Two devices must have been previously added and connected to | 1566 | <para>Two devices must have been previously added and connected to |
1568 | the uCPE Manager instance.</para> | 1567 | the Enea Edge Management instance.</para> |
1569 | </listitem> | 1568 | </listitem> |
1570 | 1569 | ||
1571 | <listitem> | 1570 | <listitem> |
@@ -1726,7 +1725,7 @@ LAN-to-LAN connectivity (through VPN tunnel)tested successfully!</programlisting | |||
1726 | 1725 | ||
1727 | <orderedlist spacing="compact"> | 1726 | <orderedlist spacing="compact"> |
1728 | <listitem> | 1727 | <listitem> |
1729 | <para>Upload a Custom Script onto the uCPE Manager.</para> | 1728 | <para>Upload a Custom Script onto the Enea Edge Management.</para> |
1730 | </listitem> | 1729 | </listitem> |
1731 | 1730 | ||
1732 | <listitem> | 1731 | <listitem> |
@@ -1746,7 +1745,7 @@ LAN-to-LAN connectivity (through VPN tunnel)tested successfully!</programlisting | |||
1746 | </listitem> | 1745 | </listitem> |
1747 | 1746 | ||
1748 | <listitem> | 1747 | <listitem> |
1749 | <para>Remove the Custom Script from the uCPE Manager.</para> | 1748 | <para>Remove the Custom Script from the Enea Edge Management.</para> |
1750 | </listitem> | 1749 | </listitem> |
1751 | </orderedlist> | 1750 | </orderedlist> |
1752 | 1751 | ||
@@ -1755,7 +1754,7 @@ LAN-to-LAN connectivity (through VPN tunnel)tested successfully!</programlisting | |||
1755 | <itemizedlist> | 1754 | <itemizedlist> |
1756 | <listitem> | 1755 | <listitem> |
1757 | <para>A device must have been previously added and connected to the | 1756 | <para>A device must have been previously added and connected to the |
1758 | uCPE Manager.</para> | 1757 | Enea Edge Management.</para> |
1759 | </listitem> | 1758 | </listitem> |
1760 | 1759 | ||
1761 | <listitem> | 1760 | <listitem> |
@@ -1792,7 +1791,7 @@ inteld1521-1 ansible_host=172.24.12.73 ansible_port=22 ansible_user=root \ | |||
1792 | <para><emphasis role="bold">Result:</emphasis> Output of | 1791 | <para><emphasis role="bold">Result:</emphasis> Output of |
1793 | <filename>basicTest.yml</filename>:</para> | 1792 | <filename>basicTest.yml</filename>:</para> |
1794 | 1793 | ||
1795 | <programlisting>test_success_after_always was uploaded to uCPE Manager! | 1794 | <programlisting>test_success_after_always was uploaded to Enea Edge Management! |
1796 | test_success_after_always was uploaded to <Device-name>! | 1795 | test_success_after_always was uploaded to <Device-name>! |
1797 | 1796 | ||
1798 | <Device-name> device is connected! | 1797 | <Device-name> device is connected! |
@@ -1800,6 +1799,6 @@ test_success_after_always from phase always-after-startup was removed \ | |||
1800 | from <Device-name>! | 1799 | from <Device-name>! |
1801 | 1800 | ||
1802 | test_success_after_always from phase always-after-startup was removed \ | 1801 | test_success_after_always from phase always-after-startup was removed \ |
1803 | from uCPE Manager!</programlisting> | 1802 | from Enea Edge Management!</programlisting> |
1804 | </section> | 1803 | </section> |
1805 | </chapter> \ No newline at end of file | 1804 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-system-test-specification/swcomp.mk b/doc/book-enea-nfv-access-system-test-specification/swcomp.mk index aea86ca..6e08a56 100755 --- a/doc/book-enea-nfv-access-system-test-specification/swcomp.mk +++ b/doc/book-enea-nfv-access-system-test-specification/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-system-test-specification | 8 | BOOKPACKAGES := book-enea-nfv-access-system-test-specification |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) System Test Specification" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) System Test Specification" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
diff --git a/doc/book-enea-nfv-access-telemetry-open-source/doc/about.xml b/doc/book-enea-nfv-access-telemetry-open-source/doc/about.xml index 781b0bd..5366626 100644 --- a/doc/book-enea-nfv-access-telemetry-open-source/doc/about.xml +++ b/doc/book-enea-nfv-access-telemetry-open-source/doc/about.xml | |||
@@ -5,7 +5,7 @@ | |||
5 | <title>About this Report</title> | 5 | <title>About this Report</title> |
6 | 6 | ||
7 | <para>This document contains the open source and license information | 7 | <para>This document contains the open source and license information |
8 | pertaining to telemetry packages provided with Enea NFV Access <xi:include | 8 | pertaining to telemetry packages provided with Enea Edge <xi:include |
9 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 9 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
11 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> | 11 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> |
diff --git a/doc/book-enea-nfv-access-telemetry-open-source/doc/book.xml b/doc/book-enea-nfv-access-telemetry-open-source/doc/book.xml index b005dae..c671fd7 100644 --- a/doc/book-enea-nfv-access-telemetry-open-source/doc/book.xml +++ b/doc/book-enea-nfv-access-telemetry-open-source/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_telemetry_open_source"> | 6 | <book id="book_enea_nfv_access_telemetry_open_source"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access Telemetry Open Source Report</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Telemetry Open Source Report</title> |
8 | <subtitle>Release Version | 8 | <subtitle>Release Version |
9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> |
diff --git a/doc/book-enea-nfv-access-telemetry-open-source/swcomp.mk b/doc/book-enea-nfv-access-telemetry-open-source/swcomp.mk index 0314da2..332d0c8 100644 --- a/doc/book-enea-nfv-access-telemetry-open-source/swcomp.mk +++ b/doc/book-enea-nfv-access-telemetry-open-source/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-telemetry-open-source | 8 | BOOKPACKAGES := book-enea-nfv-access-telemetry-open-source |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access Telemetry Open Source Report" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge Telemetry Open Source Report" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |
diff --git a/doc/book-enea-nfv-access-ucpem-open-source/doc/about.xml b/doc/book-enea-nfv-access-ucpem-open-source/doc/about.xml index d443886..05cea19 100644 --- a/doc/book-enea-nfv-access-ucpem-open-source/doc/about.xml +++ b/doc/book-enea-nfv-access-ucpem-open-source/doc/about.xml | |||
@@ -5,7 +5,7 @@ | |||
5 | <title>About this Report</title> | 5 | <title>About this Report</title> |
6 | 6 | ||
7 | <para>This document contains the open source and license information | 7 | <para>This document contains the open source and license information |
8 | pertaining to packages provided with Enea NFV Access <xi:include | 8 | pertaining to packages provided with Enea Edge <xi:include |
9 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 9 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
11 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> | 11 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> |
diff --git a/doc/book-enea-nfv-access-ucpem-open-source/doc/book.xml b/doc/book-enea-nfv-access-ucpem-open-source/doc/book.xml index d140047..7401818 100644 --- a/doc/book-enea-nfv-access-ucpem-open-source/doc/book.xml +++ b/doc/book-enea-nfv-access-ucpem-open-source/doc/book.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_nfv_access_ucpem_open_source"> | 6 | <book id="book_enea_nfv_access_ucpem_open_source"> |
7 | <title><trademark class="registered">Enea</trademark> NFV Access uCPE Manager Open Source Report</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Management Open Source Report</title> |
8 | <subtitle>Release Version | 8 | <subtitle>Release Version |
9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 9 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> |
diff --git a/doc/book-enea-nfv-access-ucpem-open-source/swcomp.mk b/doc/book-enea-nfv-access-ucpem-open-source/swcomp.mk index 15d7a6d..a7e39ab 100644 --- a/doc/book-enea-nfv-access-ucpem-open-source/swcomp.mk +++ b/doc/book-enea-nfv-access-ucpem-open-source/swcomp.mk | |||
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | 6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) |
7 | 7 | ||
8 | BOOKPACKAGES := book-enea-nfv-access-ucpem-open-source | 8 | BOOKPACKAGES := book-enea-nfv-access-ucpem-open-source |
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access uCPE Manager Open Source Report" | 9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge Management Open Source Report" |
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | 10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) |