From dca61bae299e6634568015a60e3a22b809206b8f Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 2 Apr 2021 14:34:05 +0200 Subject: Updated all books with missing information tweaks etc, namely the Getting started Manual and the Release Notes. Change-Id: I4dc6999687fed9aa2081e896b8341194f5452f68 Signed-off-by: mrpa --- doc/Makefile | 10 +- .../doc/automation_framework_test_harness.xml | 226 +++++++------ .../doc/book.xml | 21 +- .../doc/components.xml | 56 ++-- .../doc/getting_started.xml | 40 +-- .../doc/overview.xml | 20 +- .../doc/troubleshooting_guide.xml | 14 +- .../doc/128t_vnf_router.xml | 7 +- .../doc/appendix_1.xml | 2 +- .../doc/appendix_2.xml | 2 +- .../doc/appendix_3.xml | 2 +- .../doc/appendix_4.xml | 21 +- .../doc/appendix_5.xml | 9 +- doc/book-enea-edge-example-usecases/doc/book.xml | 20 +- .../doc/clav_vnf_examples.xml | 96 +++--- .../doc/enea_test_vnf_examples.xml | 12 +- .../doc/forti_vnf_examples.xml | 6 +- .../doc/introduction.xml | 16 +- .../doc/service_chaining_128t_fortigate.xml | 12 +- .../doc/vnf_chaining.xml | 7 +- .../doc/advanced_configurations.xml | 241 ++++++++------ doc/book-enea-edge-getting-started/doc/book.xml | 38 +-- doc/book-enea-edge-getting-started/doc/grafana.xml | 232 +++++++------- .../doc/installation_guide.xml | 356 +++++++++++---------- .../doc/introduction.xml | 60 ++-- .../doc/log_collector.xml | 191 ++++++----- .../doc/net_config_options.xml | 77 ++--- .../doc/troubleshooting.xml | 82 ++--- .../doc/upgrade_ena.xml | 103 +++--- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 91 +++--- .../doc/about.xml | 4 +- .../doc/about_release.xml | 54 ++-- doc/book-enea-edge-release-info/doc/book.xml | 11 +- .../doc/known_bugs_and_limitations.xml | 137 ++++---- .../doc/main_changes.xml | 78 +++-- doc/docsrc_common/pardoc-distro.xml | 62 ++-- 36 files changed, 1311 insertions(+), 1105 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index 1a1bd48..95cc7eb 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -23,13 +23,13 @@ include init.mk # ******************* AutoGenerated chapters from template and target READMEs ******* -#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 +#BUILDBOOT_XML := book-enea-edge-release-info/doc/build_boot_generated.xml +#BUILDBOOT_TEMPLATE := book-enea-edge-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-edge-release-info/doc/pkgdiff_generated.xml +#JIRA_ISSUES_GEN_XML := book-enea-edge-release-info/doc/jiraissues_generated.xml -MACHINE_LIST_XML := book-enea-nfv-access-release-info/doc/machine_list_generated.xml +MACHINE_LIST_XML := book-enea-edge-release-info/doc/machine_list_generated.xml ELTF_PARAMS_TEMPLATE := s_doceneacommon/doc/eltf_params_template.xml ELTF_PARAMS_UPDATED := s_doceneacommon/doc/eltf_params_updated.xml diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index 4fe1c9a..9f6e64f 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -1,4 +1,4 @@ - + Automation Framework and Test Harness @@ -11,15 +11,16 @@ 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 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 Enea Edge Management, and for installing and activating a NFVA image on a uCPE - Device. + device, waiting for a uCPE device to connect to the Enea Edge Management + application, 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 Enea Edge Management application, and for + installing and activating a NFVA image on a uCPE Device. The /customScripts folder contains Python scripts - 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). + for uploading custom scripts onto the Enea Edge Management application and + uCPE device(s), for removing custom scripts from the Enea Edge Management + application and uCPE device(s). The /network folder contains Python scripts for binding or unbinding a network interface to and from a uCPE device (DPDK @@ -32,14 +33,20 @@ Commands within the network folder that include the option -o allow the user to perform the action in an offline configuration store alternative available for use at a - later setup time. - Commands that include the -n - option refer to a uCPE device, with the operation being performed on uCPE device. - All options contain either -n, - -o or both. One of them must always be provided, - if both are provided, -o has priority, and -n is thus ignored. - In the following script examples, Enea Edge Management - is reffered as Enea uCPE Manager. + later setup time. + + Commands that include the -n + option refer to a uCPE device, with the operation being performed on + uCPE device. + + All options contain either -n, + -o or both. One of them must always be + provided, if both are provided, -o has priority, and -n is thus + ignored. + + In the following script examples, Enea Edge Management + is reffered as Enea uCPE + Manager. The /unittestSuite folder contains JSON files for @@ -81,8 +88,8 @@ 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 Enea Edge Management - are provided below. + Steps for running the Python unit-test suite on the Enea Edge + Management application are provided below.
Script Options @@ -236,26 +243,27 @@ consoleLoggingLevel = logging.INFO username - 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 + The user authentication used to log into the Enea Edge + Management application. This can be overwritten by setting the + Python unit-test suite command line option -u. password - 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. + The password used to log into the Enea Edge Management + application. This can be overwritten by setting the Python + unit-test suite command line option + -p. host - The IP address of the Enea Edge Management host. This can be - overwritten by setting the Python unit-test suite command line - option -H. + The IP address of the Enea Edge Management application + host. This can be overwritten by setting the Python unit-test + suite command line option -H. @@ -541,8 +549,8 @@ OK
Adding a uCPE Device - Steps for adding, configuring and running a uCPE device onto the - Enea Edge Management are described below . + Steps for adding, configuring and running a uCPE device into the + Enea Edge Management application are described below .
Script Options @@ -626,8 +634,8 @@ Options:
Removing a uCPE Device - Steps for removing a uCPE device from the Enea Edge Management are - described below. + Steps for removing a uCPE device from the Enea Edge Management + application are described below.
Script Options @@ -703,7 +711,8 @@ host Waiting a uCPE Device Steps and details for how to Wait a uCPE device to connect to the - Enea Edge Management after installation, are described below. + Enea Edge Management application after installation, are described + below.
Script Options @@ -781,7 +790,8 @@ Options: Printing the uCPE Device Log Steps and details on how to Print the events log for a specific - uCPE device installed in the Enea Edge Management, are explained below. + uCPE device installed in the Enea Edge Management application, are + explained below.