From e55c3d2a23de3eac0ae2f312b27a478e041b48e8 Mon Sep 17 00:00:00 2001 From: iosc Date: Fri, 19 Mar 2021 13:07:53 +0100 Subject: USERDOCAP-636 - all books changes Change-Id: I944098c2d726657c91edff3d62dc4a40fc8df8bb Signed-off-by: iosc --- doc/Makefile | 8 +- .../doc/about.xml | 2 +- .../doc/book.xml | 2 +- .../doc/licenses.xml | 4 +- .../swcomp.mk | 2 +- .../book-enea-nfv-access-auto-fw-th-user-guide.pdf | Bin 0 -> 401538 bytes .../doc/automation_framework_test_harness.xml | 364 ++++++++++----------- .../doc/book.xml | 2 +- .../doc/components.xml | 51 ++- .../doc/getting_started.xml | 32 +- .../doc/overview.xml | 23 +- .../doc/troubleshooting_guide.xml | 4 +- .../swcomp.mk | 2 +- .../doc/128t_vnf_router.xml | 6 +- .../doc/appendix_4.xml | 4 +- .../doc/appendix_5.xml | 6 +- .../doc/book.xml | 2 +- .../doc/clav_vnf_examples.xml | 4 +- .../doc/enea_test_vnf_examples.xml | 12 +- .../doc/forti_vnf_examples.xml | 8 +- .../doc/introduction.xml | 4 +- .../doc/service_chaining_128t_fortigate.xml | 4 +- .../doc/vnf_chaining.xml | 10 +- .../swcomp.mk | 2 +- .../doc/advanced_configurations.xml | 178 +++++----- .../doc/book.xml | 2 +- .../doc/grafana.xml | 209 ++++++------ .../doc/installation_guide.xml | 256 +++++++-------- .../doc/introduction.xml | 46 +-- .../doc/log_collector.xml | 46 +-- .../doc/net_config_options.xml | 123 +++---- .../doc/troubleshooting.xml | 74 ++--- .../doc/upgrade_ena.xml | 79 ++--- .../doc/vnf_mg.xml | 102 +++--- doc/book-enea-nfv-access-getting-started/swcomp.mk | 2 +- .../doc/about.xml | 2 +- .../doc/book.xml | 2 +- .../doc/licenses.xml | 10 +- .../swcomp.mk | 2 +- .../doc/about_release.xml | 36 +- doc/book-enea-nfv-access-release-info/doc/book.xml | 2 +- .../doc/known_bugs_and_limitations.xml | 37 +-- .../doc/main_changes.xml | 45 ++- doc/book-enea-nfv-access-release-info/swcomp.mk | 2 +- .../doc/book.xml | 2 +- .../doc/configuration.xml | 6 +- .../doc/overview.xml | 14 +- .../doc/sample_test_cases.xml | 153 +++++---- .../swcomp.mk | 2 +- .../doc/about.xml | 2 +- .../doc/book.xml | 2 +- .../swcomp.mk | 2 +- .../doc/about.xml | 2 +- .../doc/book.xml | 2 +- .../swcomp.mk | 2 +- 55 files changed, 1002 insertions(+), 1000 deletions(-) create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/book-enea-nfv-access-auto-fw-th-user-guide.pdf 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 #BUILDBOOT_XML := book-enea-nfv-access-release-info/doc/build_boot_generated.xml #BUILDBOOT_TEMPLATE := book-enea-nfv-access-release-info/doc/build_boot_template.xml -PKGDIFF_GEN_XML := book-enea-nfv-access-release-info/doc/pkgdiff_generated.xml -JIRA_ISSUES_GEN_XML := book-enea-nfv-access-release-info/doc/jiraissues_generated.xml +#PKGDIFF_GEN_XML := book-enea-nfv-access-release-info/doc/pkgdiff_generated.xml +#JIRA_ISSUES_GEN_XML := book-enea-nfv-access-release-info/doc/jiraissues_generated.xml MACHINE_LIST_XML := book-enea-nfv-access-release-info/doc/machine_list_generated.xml @@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes DOCBOOK_CLEANTMP ?= yes #Components (books) in this subsystem. Now use all books found here -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 +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 # -------------------------------------------------------------- @@ -184,7 +184,7 @@ endif books: init # BOOKPACKAGES is defined in all book-*/swcomp.mk $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ - BOOKVER="Enea NFV Access-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ + BOOKVER="Enea Edge-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ for book in $(BOOKPACKAGES); do \ for format in $(FORMAT); do \ $(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 @@ This document contains the open source and license information pertaining to the Automation Framework and Test Harness provided with - Enea NFV Access . 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 @@ ]> - <trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness Open Source Report + <trademark class="registered">Enea</trademark> Edge Automation Framework and Test Harness Open Source Report Release Version - Configuration and Automation Framework for the uCPE Manager + Configuration and Automation Framework for the Edge Manager GUI. ENEA-SRC-R2 @@ -54,7 +54,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(EneaLinux_REL_VER/1)" /> - Configuration and Automation Framework for the uCPE Manager + Configuration and Automation Framework for the Edge Manager GUI. ENEA-EXAMPLE-R2 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 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) BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-open-source -BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) AF&TH Open Source Report" +BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) AF&TH Open Source Report" 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 Binary files /dev/null and b/doc/book-enea-nfv-access-auto-fw-th-user-guide/book-enea-nfv-access-auto-fw-th-user-guide.pdf 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 @@ The /device folder contains Python scripts for adding uCPE device(s), receiving uCPE events' reports, removing a uCPE - device, waiting for a uCPE device to connect to the uCPE Manager, as well + device, waiting for a uCPE device to connect to the Enea Edge Management, as well as scripts for adding and removing an offline configuration store. This folder also contains scripts for uploading and removing an NFVA image into - the uCPE Manager, and for installing and activating a NFVA image on a uCPE + the Enea Edge Management, and for installing and activating a NFVA image on a uCPE Device. The /customScripts folder contains Python scripts - for uploading custom scripts onto the uCPE Manager and uCPE device(s), for - removing custom scripts from the uCPE Manager and uCPE device(s). + for uploading custom scripts onto the Enea Edge Management and uCPE device(s), for + removing custom scripts from the Enea Edge Management and uCPE device(s). The /network folder contains Python scripts for binding or unbinding a network interface to and from a uCPE device (DPDK @@ -79,7 +79,7 @@ the path to the file describing the test cases to be performed against the designated script. - Steps for running the Python unit-test suite on the uCPE Manager + Steps for running the Python unit-test suite on the Enea Edge Management are provided below.
@@ -88,16 +88,16 @@ $ python unittestSuite.py -h Usage: unittestSuite.py [options] -Run selected unit-test suite against Enea uCPE Manager. +Run selected unit-test suite against Enea Edge Management. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea uCPE Manager login username + Enea Edge Management login username -p PASSWORD, --password=PASSWORD - Enea uCPE Manager login password - -H HOST, --host=HOST Enea uCPE Manager host name or IP address + Enea Edge Management login password + -H HOST, --host=HOST Enea Edge Management host name or IP address -n DEVICENAME, --deviceName=DEVICENAME Name of vCPE device (Virtual Infrastructure Manager) -s SUITEFILE, --suite=SUITEFILE @@ -234,8 +234,8 @@ consoleLoggingLevel = logging.INFO username - The user authentication used to log into the uCPE - Manager. This can be overwritten by setting the Python + The user authentication used to log into the + Enea Edge Management. This can be overwritten by setting the Python unit-test suite command line option -u. @@ -243,7 +243,7 @@ consoleLoggingLevel = logging.INFO password - The password used to log into the uCPE Manager. This + The password used to log into the Enea Edge Management. This can be overwritten by setting the Python unit-test suite command line option -p. @@ -251,7 +251,7 @@ consoleLoggingLevel = logging.INFO host - The IP address of the uCPE Manager host. This can be + The IP address of the Enea Edge Management host. This can be overwritten by setting the Python unit-test suite command line option -H. @@ -540,7 +540,7 @@ OK Adding a uCPE Device Steps for adding, configuring and running a uCPE device onto the - uCPE manager are described below . + Enea Edge Management are described below .
Script Options @@ -548,16 +548,16 @@ OK $ python addDevice.py -h Usage: addDevice.py [options] -Add a uCPE device in Enea uCPE Manager. +Add a uCPE device in Enea Edge Management. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea uCPE Manager login username + Enea Edge Management login username -p PASSWORD, --password=PASSWORD - Enea uCPE Manager login password - -H HOST, --host=HOST Enea uCPE Manager host name or IP address + Enea Edge Management login password + -H HOST, --host=HOST Enea Edge Management host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format @@ -615,7 +615,7 @@ Options: 2019-03-07 17:33:10,756 - INFO: Add uCPE device 2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' 2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d -2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host +2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to Enea Edge Management host 2019-03-07 17:33:11,483 - INFO: Done 2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....
@@ -624,7 +624,7 @@ Options:
Removing a uCPE Device - Steps for removing a uCPE device from the uCPE manager are + Steps for removing a uCPE device from the Enea Edge Management are described below.
@@ -633,16 +633,16 @@ Options: $ python removeDevice.py -h Usage: removeDevice.py [options] -Remove a uCPE from Enea uCPE Manager. +Remove a uCPE from Enea Edge Management. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea uCPE Manager login username + Enea Edge Management login username -p PASSWORD, --password=PASSWORD - Enea uCPE Manager login password - -H HOST, --host=HOST Enea uCPE Manager host name or IP address + Enea Edge Management login password + -H HOST, --host=HOST Enea Edge Management host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format @@ -689,7 +689,7 @@ Options: 2019-03-07 17:33:56,835 - INFO: Remove uCPE device 2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' 2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d -2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager +2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from Enea Edge Management host 2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' 2019-03-07 17:33:57,159 - INFO: Done @@ -701,7 +701,7 @@ host Waiting a uCPE Device Steps and details for how to Wait a uCPE device to connect to the - uCPE Manager after installation, are described below. + Enea Edge Management after installation, are described below.
Script Options @@ -709,16 +709,16 @@ host $ python waitDeviceUp.py -h Usage: waitDeviceUp.py [options] -Wait for uCPE to connect to the Enea uCPE Manager after installation. +Wait for uCPE to connect to the Enea Edge Management after installation. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea uCPE Manager login username + Enea Edge Management login username -p PASSWORD, --password=PASSWORD - Enea uCPE Manager login password - -H HOST, --host=HOST Enea uCPE Manager host name or IP address + Enea Edge Management login password + -H HOST, --host=HOST Enea Edge Management host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format -t TIMEOUT, --timeout=TIMEOUT @@ -779,7 +779,7 @@ Options: Printing the uCPE Device Log Steps and details on how to Print the events log for a specific - uCPE device installed in the uCPE Manager, are explained below. + uCPE device installed in the Enea Edge Management, are explained below.