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 DeviceSteps 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 LogSteps 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.
Script Options
@@ -1382,8 +1392,8 @@ Options:
Onboarding a VNF Image Raw
- How to Onboard a VNF image in the Enea Edge Management based upon its raw
- constituents, is detailed in depth below.
+ How to Onboard a VNF image in the Enea Edge Management application
+ based upon its raw constituents, is detailed in depth below.Script Options
@@ -1499,8 +1509,8 @@ Options:
Offboarding a VNF
- Steps on how to Offboard a VNF from the Enea Edge Management are detailed
- below.
+ Steps on how to Offboard a VNF from the Enea Edge Management
+ application are detailed below.Script Options
@@ -1565,7 +1575,8 @@ Options:
Instantiating a VNF
- Instantiating a VNF via the Enea Edge Management is detailed below.
+ Instantiating a VNF via the Enea Edge Management application is
+ detailed below.Script Options
@@ -1644,8 +1655,8 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
Controlling a VNF Instance
- How to Control a VNF instance from the Enea Edge Management is
- detailed below.
+ How to Control a VNF instance from the Enea Edge Management
+ application is detailed below.If a sequence of commands aiming to change the state of the VNF
@@ -1653,7 +1664,8 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
become unresponsive. Depending on the actual VNF, the time required
between life-cycle operations may vary from several seconds to half a
minute or even more. If a VNF becomes unresponsive, the only possible
- action is to "Force Delete" the instance from the Enea Edge Management.
+ action is to "Force Delete" the instance from the Enea Edge Management
+ application.
@@ -1803,10 +1815,11 @@ fortigateFWInstance
- Uploading an Enea Edge image onto the Enea Edge Management
+ Uploading an Enea Edge image onto the Enea Edge Management
+ applicationSteps and options on how to Upload an Enea Edge image onto the
- Enea Edge Management are described below.
+ Enea Edge Management application are described below.
Script Options
@@ -1876,11 +1889,11 @@ Options:
- Deleting an Enea Edge image file from the
- Enea Edge Management
+ Deleting an Enea Edge image file from the Enea Edge Management
+ applicationSteps and options on how to Delete an Enea Edge image from the
- Enea Edge Management are described below.
+ Enea Edge Management application are described below.
Script Options
@@ -1951,11 +1964,11 @@ image was successfully removed
Installing and activating an Enea Edge image on an uCPE device
- from the Enea Edge Management
+ from the Enea Edge Management application
Steps and options on how to Install and Activate an Enea Edge
- image on an uCPE device from the Enea Edge Management are described
- below.
+ image on an uCPE device from the Enea Edge Management application are
+ described below.
Script Options
@@ -1991,10 +2004,10 @@ Options:
Configuring the JSON File
- The JSON configuration file needed to install and activate an Enea Edge
- image on a uCPE device from the Enea Edge Management should
- contain a list of dictionaries. Each dictionary indicates the test
- case name and the test case arguments passed to the
+ The JSON configuration file needed to install and activate an
+ Enea Edge image on a uCPE device from the Enea Edge Management
+ application should contain a list of dictionaries. Each dictionary
+ indicates the test case name and the test case arguments passed to the
installAndActivate Python module.Sample unit-test JSON file
@@ -2057,11 +2070,11 @@ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [20]
Clearing information about completed upgrades of uCPE devices
- from the Enea Edge Management
+ from the Enea Edge Management application
Steps and options on how to clear information about completed
- upgrades of uCPE devices from the Enea Edge Management are described
- below.
+ upgrades of uCPE devices from the Enea Edge Management application are
+ described below.Script Options
@@ -2089,9 +2102,9 @@ Options:
Configuring the JSON FileNo JSON configuration file is needed to clear information about
- completed upgrades of uCPE devices from the Enea Edge Management. The
- clearCompletedUpgradesInfo Python module can be
- run without a JSON file as a parameter.
+ completed upgrades of uCPE devices from the Enea Edge Management
+ application. The clearCompletedUpgradesInfo
+ Python module can be run without a JSON file as a parameter.
@@ -2112,10 +2125,11 @@ Options:
- Uploading a Custom Script to the Enea Edge Management
+ Uploading a Custom Script to the Enea Edge Management
+ application
- Steps and options on how to upload a custom script to the
- Enea Edge Management are described below.
+ Steps and options on how to upload a custom script to the Enea
+ Edge Management application are described below.Script Options
@@ -2149,8 +2163,9 @@ Options:
Configuring the JSON FileThe JSON configuration file needed to upload a Custom Script to
- the Enea Edge Management must contain a list of dictionaries. Each dictionary
- indicates the test case name and the test case arguments passed to the
+ the Enea Edge Management application must contain a list of
+ dictionaries. Each dictionary indicates the test case name and the
+ test case arguments passed to the
customScripts/upload Python module.Sample unit-test JSON file
@@ -2186,11 +2201,11 @@ echo test_success_after_always
- Uploading a Custom Script from the Enea Edge Management to a
- Device
+ Uploading a Custom Script from the Enea Edge Management
+ application to a Device
- Steps and options on how to upload a custom script from the
- Enea Edge Management to a Device are described below.
+ Steps and options on how to upload a custom script from the Enea
+ Edge Management application to a Device are described below.Script Options
@@ -2227,9 +2242,9 @@ Options:
Configuring the JSON FileThe JSON configuration file needed to upload a Custom Script
- from the Enea Edge Management to a Device must contain a list of dictionaries.
- Each dictionary indicates the test case name and the test case
- arguments passed to the
+ from the Enea Edge Management application to a Device must contain a
+ list of dictionaries. Each dictionary indicates the test case name and
+ the test case arguments passed to the
customScripts/uploadOnDevice Python
module.
@@ -2265,10 +2280,11 @@ test_success_after_always -e always-after-startup -n inteld1521-6
- Removing a Custom Script from the Enea Edge Management
+ Removing a Custom Script from the Enea Edge Management
+ application
- Steps and options on how to remove a custom script from the
- Enea Edge Management are described below.
+ Steps and options on how to remove a custom script from the Enea
+ Edge Management application are described below.Script Options
@@ -2302,9 +2318,10 @@ Options:
Configuring the JSON FileThe JSON configuration file needed to remove a Custom Script
- from the Enea Edge Managementdid you mean device or
- Enea Edge Management? must contain a list of dictionaries. Each dictionary
- indicates the test case name and the test case arguments passed to the
+ from the Enea Edge Management applicationdid you mean device
+ or Enea Edge Management application? must contain a list of
+ dictionaries. Each dictionary indicates the test case name and the
+ test case arguments passed to the
customScripts/delete Python module.Sample unit-test JSON file
@@ -2418,7 +2435,8 @@ phase always-after-startup from inteld1521-6
Custom Script - Full Example
- All Python API used in this example are described in detail in the following sections.
+ All Python API used in this example are described in detail in the
+ following sections.The list of custom scripts can be found in
<AF-TH-install-dir>/lab_config/customScripts:
@@ -2471,7 +2489,8 @@ phase always-after-startup from inteld1521-6
- Uploading a Custom Script to the Enea Edge Management
+ Uploading a Custom Script to the Enea Edge Management
+ application$ python automation_framework/customScripts/upload.py \
-f lab_config/customScripts/test_success_after_always -e always-after-startup
@@ -2487,8 +2506,8 @@ echo test_success_after_always
- Uploading a Custom Script from the Enea Edge Management to a
- Device
+ Uploading a Custom Script from the Enea Edge Management
+ application to a Device$ python automation_framework/customScripts/uploadOnDevice.py -c \
test_success_after_always -e always-after-startup -n inteld1521-6
@@ -2519,7 +2538,8 @@ phase always-after-startup from inteld1521-6
- Removing a Custom Script from the Enea Edge Management
+ Removing a Custom Script from the Enea Edge Management
+ application$ python automation_framework/customScripts/delete.py -c \
test_success_after_always -e always-after-startup
@@ -2538,15 +2558,15 @@ phase always-after-startup from uCPE Manager
Adding an Offline Configuration Store
- Steps and options on how to add a Config Store in the
- Enea Edge Management are described below.
+ Steps and options on how to add a Config Store in the Enea Edge
+ Management application are described below.Script Options
- To add a config store in the Enea Edge Management use the
- addConfigStore.py script detailed below. Bear in
- mind a CONFIGSTORE json file is needed to
+ To add a config store in the Enea Edge Management application
+ use the addConfigStore.py script detailed below.
+ Bear in mind a CONFIGSTORE json file is needed to
successfully run the script in order to add an offline configuration
store.
@@ -2568,8 +2588,8 @@ phase always-after-startup from uCPE Manager
Running the Python Module
- Adding an offline config store in the Enea Edge Management using
- the command line:
+ Adding an offline config store in the Enea Edge Management
+ application using the command line:python automation_framework/device/addConfigStore.py -f \
lab_config/inteld1521-16/store.json
@@ -2672,18 +2692,18 @@ Options:
- Removing an Offline Configuration Store in the
- Enea Edge Management
+ Removing an Offline Configuration Store in the Enea Edge
+ Management applicationSteps and options on how to remove an upload of a Config Store
- from the Enea Edge Management are described below.
+ from the Enea Edge Management application are described below.Modifications of an Offline Configurations Store are not
- possible post deployment in the Enea Edge Management, as there is no option
- for changing script states (e.g. changing the DPDK state in the
- configDPDK.py python script or unbinding
- interfaces). The offline store must be deleted and the new
+ possible post deployment in the Enea Edge Management application, as
+ there is no option for changing script states (e.g. changing the DPDK
+ state in the configDPDK.py python script or
+ unbinding interfaces). The offline store must be deleted and the new
state(s)/changes added in, before being deployed anew. This was not
deemed necessary for the current ZTP functionality.
@@ -2691,9 +2711,9 @@ Options:
Script options
- To remove a config store from the Enea Edge Management use the
- removeConfigStore.py script detailed
- below.
+ To remove a config store from the Enea Edge Management
+ application use the removeConfigStore.py script
+ detailed below.python removeConfigStore.py -h
Usage: removeConfigStore.py [options]
@@ -2772,9 +2792,9 @@ Options:
Manual.
The /uCPEM_config directory stores JSON
- configuration files needed for the setup of the Enea Edge Management used by TH.
- One configuration file is needed per Enea Edge Management installation, to be used
- in the TH.
+ configuration files needed for the setup of the Enea Edge Management
+ application used by TH. One configuration file is needed per Enea Edge
+ Management installation, to be used in the TH.
The /vnf_image directory stores the VNF Images
needed by the Ansible Playbooks (i.e. the sample test cases).
@@ -2799,4 +2819,4 @@ Options:
ansible.log and debug.log files,
respectively.
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml
index a1ffed1..d533a74 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml
@@ -1,33 +1,32 @@
-
+
]>
- Enea Edge Automation Framework and Test Harness User Guide
+ Enea Edge Automation
+ Framework and Test Harness User Guide
- Release Version
-
+ Release Version
-
+
-
+
-
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
index 60675a8..94ee384 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
@@ -1,9 +1,9 @@
-
+
Components
- An overview of the Enea Edge Runtime and the Edge Management
- in cooperation with the Enea Edge Automation Framework and Test Harness, will
+ An overview of the Enea Edge Runtime and the Edge Management in
+ cooperation with the Enea Edge Automation Framework and Test Harness, will
be presented in detail.
@@ -20,22 +20,23 @@
Enea Edge
- Enea Edge is comprised of the Enea Edge Management and the Enea
- Edge Runtime.
+ Enea Edge is comprised of the Enea Edge Management application and
+ Enea Edge Runtime.Enea Edge ManagementThe Enea Edge Management application needs to be installed on a
supported platform. Upon installation, the system will be set up to
- manage Enea Edge Runtime "devices", these are the virtualized CPE devices
- used in testing.
+ manage Enea Edge Runtime "devices", these are the virtualized CPE
+ devices used in testing.For more on Enea Edge Management installation instructions, please
refer to the section on how to Installing the Enea Edge Management in the
- Installing the Enea Edge Management
+ application in the
Manual.
@@ -44,13 +45,15 @@
Enea Edge Runtime
- One or more uCPE devices running the Enea Edge Runtime
- are required as hosts to run the VNF(s). The uCPE device is
- known to the Enea Edge Management as the "VcpeAgent" device module.
+ One or more uCPE devices running the Enea Edge Runtime are
+ required as hosts to run the VNF(s). The uCPE device is known to the
+ Enea Edge Management application as the "VcpeAgent" device
+ module.
- Before running any use case with the Enea Edge Automation Framework and
- Test Harness, make sure the uCPE device(s) have been added to the Edge Management.
+ Before running any use case with the Enea Edge Automation
+ Framework and Test Harness, make sure the uCPE device(s) have been
+ added to the Enea Edge Management application.Adding a VcpeAgent device can be done via two methods:
@@ -69,8 +72,8 @@
- For more on Enea Edge installation instructions, please
- refer to chapter For more on Enea Edge installation instructions, please refer to
+ chapter Preparing the USB stick for installation of the
Enea Edge Runtime in the Automation Framework
- Testing can be performed by running Automation Framework (AF) Python scripts
- against the Enea Edge Management REST API (Python samples supplied). This can be
- done by using the Python scripts individually or by using the Python
- unit-test suite that is able to automatically run test-cases defined for
- each available Python script.
+ Testing can be performed by running Automation Framework (AF) Python
+ scripts against the Enea Edge Management REST API (Python samples
+ supplied). This can be done by using the Python scripts individually or by
+ using the Python unit-test suite that is able to automatically run
+ test-cases defined for each available Python script.In either case, it is desirable to use a different host (instead of
- running the tests on the same system as the Enea Edge Management) in order to
- ensure that the Enea Edge Management is setup and installed correctly in terms of
- allowing external users to access it and use it effectively.
+ running the tests on the same system as the Enea Edge Management
+ application) in order to ensure that the Enea Edge Management application
+ is setup and installed correctly in terms of allowing external users to
+ access it and use it effectively.
@@ -100,8 +104,8 @@
The Test Harness (TH) provides a way for driving configuration with
Ansible Playbooks, by running the python modules from the Automation
- Framework and by direct connection over SSH to the boards that run
- Enea Edge.
+ Framework and by direct connection over SSH to the boards that run Enea
+ Edge.
The Test Harness includes an automated test suite that
contains:
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
index 455e142..255138b 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
@@ -1,4 +1,4 @@
-
+
Getting Started with the Enea Edge Automation Framework and Test
Harness
@@ -6,8 +6,8 @@
Prerequisites
- For installation of the Enea Edge Automation Framework and Test Harness a
- CentOS 7 host machine is needed with support for:
+ For installation of the Enea Edge Automation Framework and Test
+ Harness a CentOS 7 host machine is needed with support for:
@@ -28,10 +28,10 @@
- The Enea Edge Automation Framework and Test Harness installation may be done
- on the same machine used for Enea Edge Management installation, although this is
- not encouraged. For more details see section The Enea Edge Automation Framework and Test Harness installation
+ may be done on the same machine used for the Enea Edge Management
+ installation, although this is not encouraged. For more details see
+ section Automation Framework in the
- Enea Edge Management installed.
+ Enea Edge Management application installed.
- For details on how to install the Enea Edge Management, see Installing the Enea Edge Management in the
- For details on how to install the Enea Edge Management
+ application, see Installing the Enea Edge Management
+ application in the
Manual.
@@ -180,7 +181,8 @@
- Set up the Enea Edge Management which will be used by the TH:
+ Set up the Enea Edge Management application which will be used
+ by the TH:
@@ -221,18 +223,18 @@
<AF-THinstall-dir> directory.Subsequent use of the installation requires activating the Python
- virtual enviroment before using the Enea Edge Automation Framework and Test Harness:
- source
+ virtual enviroment before using the Enea Edge Automation Framework and
+ Test Harness: source
<AF-TH-install-dir>/testHarness-venv/bin/activate.
- Furthermore, if a user wants to use a new Enea Edge Management instance for
- a new session, the user also has to re-run the
+ Furthermore, if a user wants to use a new Enea Edge Management
+ instance for a new session, the user also has to re-run the
setupuCPEManager.yml playbook with the corresponding
JSON config for the new Enea Edge Management instance.
- Enea Edge Automation Framework and Test Harness History Information can be
- found in the AF&TH CHANGELOG file available in:
+ Enea Edge Automation Framework and Test Harness History
+ Information can be found in the AF&TH CHANGELOG file available in:
<AF-TH-install-dir>/CHANGELOG
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
index 4fec3d9..1d07512 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
@@ -1,21 +1,23 @@
-
+
Overview
- This document describes the Enea Edge Automation Framework and Test Harness, along with instructions regarding the necessary steps to
- run these software tools.
+ This document describes the Enea Edge Automation Framework and Test
+ Harness, along with instructions regarding the necessary steps to run these
+ software tools.DescriptionThe Automation Framework provides a way for driving configuration
- with Python scripting. It complements the Enea Edge Management GUI and uses
- the northbound REST APIs, given to provide full usability of the Enea Management
- features.
+ with Python scripting. It complements the Enea Edge Management GUI and
+ uses the northbound REST APIs, given to provide full usability of the Enea
+ Management features.
The Test Harness is based on running Ansible Playbooks to complete
different test cases, which make use of the Automation Framework Python
- modules and/or direct commands on the uCPE devices running the Enea Edge Runtime.
+ modules and/or direct commands on the uCPE devices running the Enea Edge
+ Runtime.
@@ -39,8 +41,7 @@
Enea Edge
- The Enea Edge Runtime and the
- Enea Edge Management.
+ The Enea Edge Runtime and the Enea Edge Management.
@@ -127,7 +128,6 @@
Network Functions Virtualization.
-
OVS
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
index a5cd664..1ed4d92 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
@@ -1,4 +1,4 @@
-
+
Troubleshooting Guide
@@ -21,12 +21,12 @@
- When setting up the Enea Edge Management to be used by the TH through the
- setupuCPEManager.yml Playbook, if the uCPE
- username/password/host are incorrect or are missing, all the Sample test
- cases will fail. If the FTP username/password/port are wrong or are
- missing, the tests that require file transfer to the Enea Edge Management will
- fail.
+ When setting up the Enea Edge Management application to be used by
+ the TH through the setupuCPEManager.yml Playbook, if
+ the uCPE username/password/host are incorrect or are missing, all the
+ Sample test cases will fail. If the FTP username/password/port are wrong
+ or are missing, the tests that require file transfer to the Enea Edge
+ Management application will fail.
diff --git a/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml
index 89692b0..993da22 100644
--- a/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml
+++ b/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml
@@ -1,4 +1,4 @@
-
+
128T VNF Router Example Use-case
@@ -68,8 +68,9 @@
Configuring Network Interfaces on uCPE
devices:
- Add the trgt uCPE device into Enea Edge Management:
- Devices -> Manage -> Add.
+ Add the trgt uCPE device into the Enea Edge Management
+ application: Devices -> Manage ->
+ Add.Fill in the required fields with the following data:
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_1.xml b/doc/book-enea-edge-example-usecases/doc/appendix_1.xml
index df262af..8c76884 100644
--- a/doc/book-enea-edge-example-usecases/doc/appendix_1.xml
+++ b/doc/book-enea-edge-example-usecases/doc/appendix_1.xml
@@ -1,4 +1,4 @@
-
+
How to create a 128T cloud-init iso image (day-0
configuration)
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_2.xml b/doc/book-enea-edge-example-usecases/doc/appendix_2.xml
index 2458d99..7ef7c41 100644
--- a/doc/book-enea-edge-example-usecases/doc/appendix_2.xml
+++ b/doc/book-enea-edge-example-usecases/doc/appendix_2.xml
@@ -1,4 +1,4 @@
-
+
How to create the 128T image for NFV Access
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_3.xml b/doc/book-enea-edge-example-usecases/doc/appendix_3.xml
index e8bd5ce..063483a 100644
--- a/doc/book-enea-edge-example-usecases/doc/appendix_3.xml
+++ b/doc/book-enea-edge-example-usecases/doc/appendix_3.xml
@@ -1,4 +1,4 @@
-
+
How to configure Fortigate VNF (day-0 configuration)
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml
index ef706ec..f52e33d 100644
--- a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml
+++ b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml
@@ -1,15 +1,15 @@
-
+
Running Enea Edge Automation Framework and Test Harness
- For more detailed information regarding the Enea Edge Automation Framework and
- Test Harness please see the For more detailed information regarding the Enea Edge Automation
+ Framework and Test Harness please see the .
- The most relevant information from the Enea Edge Automation Framework and Test
- Harness structure is presented below:
+ The most relevant information from the Enea Edge Automation Framework
+ and Test Harness structure is presented below:|---automation_framework
| |---unittestSuite
@@ -78,16 +78,17 @@
Before starting the two usecases detailed in the following appendix,
- the uCPE Device needs to be added into Enea Edge Management.
+ the uCPE Device needs to be added into the Enea Edge Management
+ application.
- To properly set up the Enea Edge Automation Framework and Test Harness please
- see To properly set up the Enea Edge Automation Framework and Test Harness
+ please see Installation and Initial Setup in the
- for more details.
+ xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /> for
+ more details.
To run a test:
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_5.xml b/doc/book-enea-edge-example-usecases/doc/appendix_5.xml
index 67f38e5..abb4be8 100644
--- a/doc/book-enea-edge-example-usecases/doc/appendix_5.xml
+++ b/doc/book-enea-edge-example-usecases/doc/appendix_5.xml
@@ -1,6 +1,7 @@
-
+
- Example Tests Results using the Automation Framework and Test Harness
+ Example Tests Results using the Automation Framework and Test
+ HarnessIn order to run the following example usecases, certain configuration
file entries need to be modified according to the network setup that it will
@@ -39,8 +40,8 @@
"maintMode": "false",
"version": "2.2.3",
"deviceId": "inteld1521-17"
-}The IP address of Enea Edge Management that will be used in
- these examples is 172.24.3.92.
+}The IP address of Enea Edge Management application that will
+ be used in these examples is 172.24.3.92.
The FortiGate and 128T VNF images need to be copied into the
vnf_image directory. The names should be the same as
diff --git a/doc/book-enea-edge-example-usecases/doc/book.xml b/doc/book-enea-edge-example-usecases/doc/book.xml
index 2ffbefe..fc69b88 100644
--- a/doc/book-enea-edge-example-usecases/doc/book.xml
+++ b/doc/book-enea-edge-example-usecases/doc/book.xml
@@ -1,14 +1,16 @@
-
+
]>
- Enea Edge Example Use-cases
+ Enea Edge Example
+ Use-cases
- Release Version
-
+ Release Version
@@ -36,9 +38,7 @@
-
+
-
-
+
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml
index 8895c23..80755c2 100644
--- a/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml
+++ b/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml
@@ -1,4 +1,4 @@
-
+
Clavister VNF Example Use-cases
@@ -33,23 +33,33 @@
- Enea Test VNF image. Please contact Enea to get this image.
+ Enea Test VNF image. Please contact Enea to get this
+ image.Clavister VNF image. Please contact Clavister to get this
image.
-
- VNF Configuration files. These files are provided with your Enea
- Edge release:
-
-
- clavister-cloudinit.conf.
- enea-vnf-iperf-client.conf.
- enea-vnf-iperf-server.conf.
+
+
+ VNF Configuration files. These files are provided with your
+ Enea Edge release:
+
+
+
+ clavister-cloudinit.conf.
+
+
+
+ enea-vnf-iperf-client.conf.
+
+
+
+ enea-vnf-iperf-server.conf.
+
-
+
@@ -62,22 +72,22 @@
bridges.
- Clavister VNF using an Open vSwitch bridge
-
-
-
-
-
-
-
-
-
- When connecting, the uCPE devices can use a back-to-back or a VPN connection.
- An appropriate interface with the required capabilities needs to be chosen for
- this purpose.
-
-
+ Clavister VNF using an Open vSwitch bridge
+
+
+
+
+
+
+
+
+
+ When connecting, the uCPE devices can use a back-to-back or a
+ VPN connection. An appropriate interface with the required
+ capabilities needs to be chosen for this purpose.
+
+
Network Configuration:
@@ -324,21 +334,32 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10
- Enea Test VNF image. Please contact Enea to get this image.
+ Enea Test VNF image. Please contact Enea to get this
+ image.Clavister VNF image. Please contact Clavister to get this
image.
-
- VNF Configuration files. These files are provided with your Enea
- Edge release:
+
+
+ VNF Configuration files. These files are provided with your
+ Enea Edge release:
+
- clavister-cloudinit.conf.
- enea-vnf-iperf-client.conf.
- enea-vnf-iperf-server.conf.
-
+
+ clavister-cloudinit.conf.
+
+
+
+ enea-vnf-iperf-client.conf.
+
+
+
+ enea-vnf-iperf-server.conf.
+
+
@@ -367,8 +388,9 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10
Select uCPE device 1, access Configuration,
add the network interface that will be used and configure it for
- SR-IOV. For sriov-mode select adapter-pool and for
- sriov-num-vfs select "2".
+ SR-IOV. For sriov-mode select
+ adapter-pool and for
+ sriov-num-vfs select "2".
diff --git a/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml
index bee5a63..0c3815e 100644
--- a/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml
+++ b/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml
@@ -1,4 +1,4 @@
-
+
Enea Test VNF Example Use-cases
@@ -17,8 +17,8 @@
- 2 Network Interfaces. One for Enea Edge Management and one for data
- traffic.
+ 2 Network Interfaces. One for the Enea Edge Management
+ application and one for data traffic.
@@ -168,8 +168,8 @@
- Instantiate the Enea Edge TestPMD termination VNF on
- uCPE Device 2 by filling the required fields with the following
+ Instantiate the Enea Edge TestPMD termination VNF on uCPE
+ Device 2 by filling the required fields with the following
values:
@@ -218,7 +218,7 @@
testpmd_term.
- The flow rules can be described using either the Enea Edge
+ The flow rules can be described using either the Enea Edge
Management interface or the configuration files.
diff --git a/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml
index 1e81ca4..cc3be97 100644
--- a/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml
+++ b/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml
@@ -1,4 +1,4 @@
-
+
FortiGate VNF Example Use-cases
@@ -254,8 +254,8 @@
targetptr="fortigate_webmg">FortiGate VNF web management in the
- Manual for more information.
+ xpointer="element(book_enea_edge_example_usecases/1)" /> Manual
+ for more information.
diff --git a/doc/book-enea-edge-example-usecases/doc/introduction.xml b/doc/book-enea-edge-example-usecases/doc/introduction.xml
index ca0b310..27824da 100644
--- a/doc/book-enea-edge-example-usecases/doc/introduction.xml
+++ b/doc/book-enea-edge-example-usecases/doc/introduction.xml
@@ -1,4 +1,4 @@
-
+
Introduction
@@ -6,19 +6,19 @@
configuration, onboarding and instantiation of certain VNFs, VNF chaining,
etc.
- Before running any example use case make sure the uCPE device(s) have
- been added to Enea Edge Management and placed on the map. For detailed
- information on how to add a device to Enea Edge Management, how to configure the
- network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, or VNF
- configuration, please refer to the Before running any example use-case make sure the uCPE device(s) have
+ been added to the Enea Edge Management application and placed on the map.
+ For detailed information on how to add a device to the Enea Edge Management
+ application, how to configure the network interfaces to use DPDK,
+ PCI-passthrough or SR-IOV drivers, or VNF configuration, please refer to the
+ Manual.Examples presented in this document use 3rd-party VNFs, which are
not provided by Enea. To procure and use these VNF image files and license
- files, please contact the VNF provider.
+ files, please contact the VNF provider.
Request the VNF prerequisites from the VNF vendors, or alternatively
obtain the prerequisites based on instructions from each VNF vendor
diff --git a/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml
index bb05905..4529fbf 100644
--- a/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml
+++ b/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml
@@ -1,10 +1,10 @@
-
+
Service Chaining 128T - Fortigate Example Use-caseThe following is an example of how to setup and configure a service
- chain on top of the Enea Edge Runtime, using the
- following commercial VNFs: 128T router and FortiGate.
+ chain on top of the Enea Edge Runtime, using the following commercial VNFs:
+ 128T router and FortiGate.Prerequisites
@@ -86,9 +86,9 @@
Configuring Network Interfaces on uCPE
devices:
- Add the trgt uCPE device into Enea Edge Management:
- Devices -> Manage -> Add, and fill in the
- required fields with the following data:
+ Add the trgt uCPE device into the Enea Edge Management
+ application: Devices -> Manage -> Add,
+ and fill in the required fields with the following data:
Device Details
diff --git a/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml b/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml
index 24442af..affbf39 100644
--- a/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml
+++ b/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml
@@ -1,4 +1,4 @@
-
+
VNF Chaining Example Use-case
@@ -11,9 +11,8 @@
The following is an example of how to setup and configure a
branch-to-branch service comprised on two commercial VNFs (SD-WAN +
- Firewall). This service will run in a service chain on top of the Enea
- Edge Runtime, deployed through the Enea Edge
- Management.
+ Firewall). This service will run in a service chain on top of the Enea Edge
+ Runtime, deployed through the Enea Edge Management.
In the example setup the following commercial VNFs are used: Juniper
vSRX as the SD-WAN VNF and Fortigate as the Router/Firewall.
diff --git a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
index e321cf9..90de441 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -1,4 +1,4 @@
-
+
@@ -23,14 +23,14 @@
proceeds to install the system by dividing the disk into 2 partitions: a
GPT partition containing the GRUB boot loader and a second partition
containing the Enea Edge Runtime root filesystem. When the installation is
- complete, the uCPE device is automatically rebooted into Enea Edge
+ complete, the uCPE device is automatically rebooted into the Enea Edge
Runtime.
The .hddimg, initramfs, and
bzImage files are available in the
Enea_Edge_Runtime_<processor>_<version>-<build_number>.tar.gz
- file you downloaded with your release.
+ file downloaded with your release.
@@ -102,32 +102,26 @@
An installation configuration file needs to be prepared on the
HTTP server. The format of the configuration file is a list of
"name = value" pairs and the available parameters
- are described below.
-
- Mandatory parameter(s):
+ are described below:
- image_url. The HTTP server URL used for
- downloading the Enea Edge Runtime image.
+ image_url (mandatory). The HTTP server
+ URL used for downloading the Enea Edge Runtime image.
-
-
- Optional parameters:
-
- install_drive. The name of the drive
- where the Enea Edge Runtime will be installed (e.g
+ install_drive (optional). The name of the
+ drive where the Enea Edge Runtime will be installed (e.g
/dev/sda). If not set, the installer will use
the largest detected (non-USB) drive on the uCPE device.
- prompt_user. If the parameter is set to
- "yes", the installer will ask for confirmation before formatting
- and partitioning the drive. The default behaviour is to proceed
- automatically without any user interaction.
+ prompt_user (optional). If the parameter
+ is set to "yes", the installer will ask for confirmation before
+ formatting and partitioning the drive. The default behaviour is to
+ proceed automatically without any user interaction.
@@ -175,7 +169,7 @@ ipappend 2
ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset
The uCPE devices should be configured in BIOS to boot from the
- installation drive first in order to automatically start the Enea Edge
+ installation drive first in order to automatically start Enea Edge
Runtime when the installation is finished.
@@ -418,12 +412,13 @@ node0.1048576kB = 3
- Installing the Enea Edge Management in High Availability
- Mode
+ Installing the Enea Edge Management application in High
+ Availability ModeThe following describes the setup needed for running the Enea Edge
- Management in High Availabilty (HA) mode, with a MariaDB database cluster.
- A setup example is illustrated in the diagram below.
+ Management application in High Availabilty (HA) mode, with a MariaDB
+ database cluster. A setup example is illustrated in the diagram
+ below.
The High Availability setup
@@ -441,24 +436,51 @@ node0.1048576kB = 3
example, two of the machines are running only MariaDB, while the rest are
hosting a MariaDB server and an Enea Edge Management instance. The entire
network is hidden behind a firewall that performs NAT. While in protection
- (cluster) mode, the Enea Edge Management instances promote a single
- Virtual IP (VIP). The cluster can be reached either from the primary
- server IP or via VIP (recommended), since the VIP interface is spawned on
- the primary server. In case of a primary failure, the newly elected
- primary (from one of the backups) will respawn the VIP interface. The
- firewall in this scenario will allocate a public IP for the outside world
- that will be translated into the VIP. Also in this example, the traffic
- towards the cluster from outside the firewall is done through HTTPS, which
- will be translated to HTTP inside the private network.
+ (cluster) mode, the Enea Edge Management application instances promote a
+ single Virtual IP (VIP). The cluster can be reached either from the
+ primary server IP or via VIP (recommended), since the VIP interface is
+ spawned on the primary server. In case of a primary failure, a newly
+ elected primary (from one of the backups) will respawn the VIP interface.
+ The firewall in this scenario will allocate a public IP for the outside
+ world that will be translated into the VIP. Also in this example, the
+ traffic towards the cluster from outside the firewall is done through
+ HTTPS, which will be translated to HTTP inside the private network.
- By default, communication to the Enea Edge Management is done with
- HTTPS. To enable HTTP, go to System,
- Configuration, click on the By default, communication to the Enea Edge Management application
+ is done with HTTPS. To enable HTTP, go to System, Configuration, click on the Web Access tab and check the Enable HTTP checkbox.
+ High-Availability - Design
+ Limitations
+
+ Enea's solution for Edge Management High-Availability is designed to
+ maximize resiliency of the management function. However, the current design
+ does not provide guaranteed consistency across all Enea Edge
+ Management instances, i.e. some information might become out-of-sync in
+ certain conditions.
+
+ In order to reach full consistency, design would rely on
+ transactional data updates across the Primary instance and all Backups,
+ but the latency would significantly increase for all management
+ operations, which is considered to be a severe limitation.
+
+ In the current version of the Enea Edge Management application when
+ in High Availability mode, there are two kinds of data that needs to be
+ synchronized: data in the database and data residing in the Primary
+ instance filesystem. This means that there are intervals when data is
+ being synchronized from the Primary instance to the Backup(s) and Primary
+ failure at this time will result in incomplete/inconsistent data on the
+ Backup(s). For example, a VNF which has been onboarded on the Primary
+ instance will not be visible in a Backup instance(s) until both database
+ and filesystem have been synchronized. If a Backup instance becomes the
+ active one before synchronization takes place, this would result in an
+ out-of-sync state.
+
Requirements for High Availability
@@ -467,7 +489,8 @@ node0.1048576kB = 3
- Machines running the Enea Edge Management and MariaDB:
+ Machines running the Enea Edge Management application and
+ MariaDB:
@@ -507,13 +530,12 @@ node0.1048576kB = 3
Firewall Rules
- Please refer to Please refer to Firewall Configuration in the
- Manual. In addition, the following configuration is needed:
+ xpointer="element(book_enea_edge_getting_started/1)" /> Manual.
+ In addition, the following configuration is needed:
@@ -590,7 +612,8 @@ SELINUXTYPE=targeted
For MariaDB, the following ports must be opened (on each MariaDB
- server, including the ones hosting the Enea Edge Management):
+ server, including the ones hosting the Enea Edge Management
+ application):
Ports for MariaDB Machines
@@ -685,9 +708,10 @@ SELINUXTYPE=targeted
Installing High Availability
- The Enea Edge Management can be installed in High Availability
- mode with a MariaDB database cluster by performing the following steps.
- The mandatory Java configuration is also detailed.
+ The Enea Edge Management application can be installed in High
+ Availability mode with a MariaDB database cluster by performing the
+ following steps. The mandatory Java configuration is also
+ detailed.Installing and configuring the MariaDB cluster
@@ -706,14 +730,16 @@ SELINUXTYPE=targeted
Install the MariaDB official yum repository. Create a file
named mariadb.repo in
/etc/yum.repos.d/ with the following
- content:# MariaDB 10.5 CentOS repository list - created 2021-02-16 08:46 UTC
+ content:
+
+ # MariaDB 10.5 CentOS repository list - created 2021-02-16 08:46 UTC
# http://downloads.mariadb.org/mariadb/repositories/
[mariadb]
name = MariaDB
baseurl = http://yum.mariadb.org/10.5/centos7-amd64
gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1
-
+
For more information about setting the repository, consult
@@ -825,20 +851,20 @@ Switch to unix_socket authentication [Y/n] Y
Enabled successfully!
Reloading privilege tables..
... Success!
-…
+…
Change the root password? [Y/n] Y
New password:
Re-enter new password:
Password updated successfully!
Reloading privilege tables..
... Success!
-…
+…
Remove anonymous users? [Y/n] Y
... Success!
-…
+…
Disallow root login remotely? [Y/n] Y
... Success!
-…
+…
Remove test database and access to it? [Y/n] Y (optional)
- Dropping test database...
... Success!
@@ -873,12 +899,12 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;
Installing the Java SDKPlease refer to Configuring OpenJDK and
PostgreSQL in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual, for details on how to install and configure Java
OpenJDK.
@@ -891,40 +917,40 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;
- Installing the Enea Edge Management in High Availabilty
- mode
+ Installing the Enea Edge Management application in High
+ Availabilty modeThese steps must be taken on each of the CentOS 7 machines that
- will host the Enea Edge Management. The Enea Edge Management will be
- installed and the setup for the external database cluster will be
+ will host the Enea Edge Management application. It will be installed
+ and the setup for the external database cluster will be
prepared.As the root user, go to the distribution folder of the Enea Edge
- Management, and run:
+ Management application, and run:
[root@localhost distro]#./install.sh /opt/ \
Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz
-This will install uCPEManager into /opt/ucpemanager folder.
+This will install the Enea Edge Management application into the /opt/ucpemanager folder.
Select the following options, while asked by the installation script:
Are you using the embedded PostgreSQL database? [Y/N]: N
External database selected, getting user information ...
Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \
for MySQL: 2
Specify database server name(s) or IP Address(es): \
-192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)
+192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)
Specify database ID (or name) [ucpemanager]:
Specify database server port [3306]:
Specify database user name [root]: enea
Specify database password [root]: somepassword
Specify database startup thread pool size [1]:
Creating database configuration file \
-/opt//ucpemanager/application/config/databaseConfig.xml ...
+/opt/ucpemanager/application/config/databaseConfig.xml ...
Done .
-…
+…
Installing ucpemanager service ..
Specify service username [ucpemanager]:
Specify service password [ucpemanager]: somepassword
-…
+…
Specify the IP address of the local interface: 192.168.10.11
Is this server part of a cluster? [Y/N]: Y
Specify the name of the cluster [ucpemanager]:
@@ -938,9 +964,9 @@ Configuration complete.For each Enea Edge Management installation, place the local
interface IP first in the list of IPs. This will optimize database
- communication, since the Enea Edge Management uses the list of IPs
- sequentially, therefore using the internal loopback interface for
- communicating with the database.
+ communication, since the Enea Edge Management application uses the
+ list of IPs sequentially, therefore using the internal loopback
+ interface for communicating with the database.
The arbiter IP and port are used to mitigate split brain
@@ -956,6 +982,24 @@ Configuration complete.
role="bold">System and select Cluster
View. The list of Enea Edge Management servers should be
displayed, with one listed as Primary and the rest as Backup.
+
+ To avoid split-brain (network-partitioning) scenarios, it is possible
+ for the user to specify an IP:port tuple for a system that acts as an
+ Arbiter. In case both Primary and Backup servers cannot reach the Arbiter,
+ there will be no Primary system to connect to and the management services
+ will be unavailable.
+
+ This can be manually remedied by either fixing the network situation
+ that caused the partitioning or modifying Arbiter information in the
+ configuration file on the server that the user decides should be the
+ (one and only) Primary server.
+
+ ELCCR-907At times the VIP address is not
+ acquired by any of the backup nodes if a power failure happens on
+ primary node in a High Availability setup. To recover, follow the
+ official documentation available at Galera
+ Cluster Recovery.To change the configuration at a later point after the
installation, either uninstall and then reinstall the product, or
@@ -972,8 +1016,9 @@ Configuration complete.
- We start with the assumption that ucpeManager-1
- is the "PRIMARY" server.
+ We start with the assumption that
+ EneaEdgeManagement-1 is the "PRIMARY"
+ server.
@@ -988,34 +1033,35 @@ Configuration complete.
- Run the upgrade process on ucpeManager-3
- and ucpeManager-4. This will upgrade the service
- to the current release. Once the upgrade process completes, shutdown
- the Enea Edge Management service on both machines.
+ Run the upgrade process on
+ EneaEdgeManagement-3 and
+ EneaEdgeManagement-4. This will upgrade the
+ service to the current release. Once the upgrade process completes,
+ shutdown the Enea Edge Management service on both machines.
- Disconnect the ucpeManager-2 machine from
- the network (which will take MariaDB-2 offline as well). At this
- point, only the "PRIMARY" server is running, this is the start of
- the interval when we are susceptible to single-server
+ Disconnect the EneaEdgeManagement-2 machine
+ from the network (which will take MariaDB-2 offline as well). At
+ this point, only the "PRIMARY" server is running, this is the start
+ of the interval when we are susceptible to single-server
failure.Shutdown the MariaDB-2 process and run the Enea Edge
- Management upgrade process on ucpeManager-2. This
- will upgrade the service to the current release. Once the upgrade
- process completes, shutdown the Enea Edge Management service on the
- machine.
+ Management upgrade process on
+ EneaEdgeManagement-2. This will upgrade the
+ service to the current release. Once the upgrade process completes,
+ shutdown the Enea Edge Management service on the machine.Reconnect the network interfaces towards the VPN for MariaDB-4
- (ucpeManager-3), MariaDB-5
- (ucpeManager-4) and MariaDB-6
- (ucpeManager-2). Restart database services on
- MariaDB-2, MariaDB-4, MariaDB-5 and MariaDB-6. This will allow
+ (EneaEdgeManagement-3), MariaDB-5
+ (EneaEdgeManagement-4) and MariaDB-6
+ (EneaEdgeManagement-2). Restart database services
+ on MariaDB-2, MariaDB-4, MariaDB-5 and MariaDB-6. This will allow
database services on all machines to synchronize, any data that has
been modified during the upgrade process will be made
consistent.
@@ -1023,35 +1069,36 @@ Configuration complete.
Shutdown the "Primary" server
- (ucpeManager-1). At this point, the service is no
- longer available.
+ (EneaEdgeManagement-1). At this point, the
+ service is no longer available.
- Start the Enea Edge Management services on
- ucpeManager-2. This machine will come up as the
- new "PRIMARY" with the upgraded software. As part of the startup
- process, it will upgrade the database and perform any other
+ Start the Enea Edge Management service on
+ EneaEdgeManagement-2. This machine will come up
+ as the new "PRIMARY" with the upgraded software. As part of the
+ startup process, it will upgrade the database and perform any other
upgrade-related functionality.At this point (once startup completes), service is available.
- However, we are still susceptible to single-server failure.
+ However, the system is still susceptible to single-server
+ failure.
Start the Enea Edge Management services on
- ucpeManager-3 and
- ucpeManager-4. At this point, we are in
- highly-available mode.
+ EneaEdgeManagement-3 and
+ EneaEdgeManagement-4. At this point, they will
+ operate in highly-available mode.
- Upgrade the Enea Edge Management on
- ucpeManager-1 (the one that has been shut down).
- Once that upgrade is complete and the service restarts, the entire
- setup has been upgraded to the new version.
+ Upgrade the Enea Edge Management application on
+ EneaEdgeManagement-1 (the one that has been shut
+ down). Once that upgrade is complete and the service restarts, the
+ entire setup has been upgraded to the new version.
diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml
index f02f770..07021cb 100644
--- a/doc/book-enea-edge-getting-started/doc/book.xml
+++ b/doc/book-enea-edge-getting-started/doc/book.xml
@@ -1,14 +1,16 @@
-
+
]>
- Enea Edge Getting Started
+ Enea Edge Getting
+ Started
- Release Version
-
+ Release Version
@@ -17,28 +19,26 @@
-
+
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
-
+
-
-
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+
-
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/grafana.xml b/doc/book-enea-edge-getting-started/doc/grafana.xml
index 5dfaa98..807c2ac 100644
--- a/doc/book-enea-edge-getting-started/doc/grafana.xml
+++ b/doc/book-enea-edge-getting-started/doc/grafana.xml
@@ -1,21 +1,25 @@
-
+
Using Grafana and InfluxDB
- InfluxDB is essentially a time series database process that runs on a
- server, while Grafana is a visualization tool for time series data. Grafana
- is a very lightweight server-side application, and most of the monitoring
- runs in a browser.
+ InfluxDB is
+ essentially a time series database process that runs on a server, while
+ Grafana is a
+ visualization tool for time series data. Grafana is a very lightweight
+ server-side application, and most of the data monitoring runs in a browser.
+
+ For details on version information for these two components, please refer to the
+ .Deploying Grafana and InfluxDBGrafana and InfluxDB can be deployed using images for Docker on
linux. These images are provided by Enea along with a deploy script and
- predefined dashboards.
-
- The Grafana and InfluxDB images can be deployed on the same machine
- or on separate machines.
+ predefined dashboards. The Grafana and InfluxDB images can be deployed on
+ the same machine or on separate machines.
Prerequisites for Deploying an Image
@@ -28,55 +32,59 @@
- Internet connection for installing the Docker tool.
+ Internet connection for installing the Docker tool.
- Root rights on the CentOS 7 machine.
+ Root rights on the CentOS 7 machine.
- Setting up Docker for Grafana and InfluxDB
-
- In order to use the Grafana and InfluxDB containers, the Docker
- tool that runs and manages containers needs to be available on
- the server.
-
- To install Docker on a CentOS 7 server open a terminal, log
- into a bash shell with the root account and run the following commands:
+ Setting up Docker for Grafana and InfluxDB
+
+ In order to use the Grafana and InfluxDB containers, the Docker
+ tool that runs and manages containers needs to be available on the
+ server.
+
+ To install Docker on a CentOS 7 server open a terminal, log into a
+ bash shell with the root account and run the following commands:
-
- yum check-update
-
-
- yum install -y yum-utils device-mapper-persistent-data lvm2
-
-
-
- yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
-
-
-
- yum install docker
-
-
-
- In order to deploy the Grafana and InfluxDB images, the Docker
- service needs to be started. To start the Docker service, log into
- a bash shell with the root account and run the following command:
- systemctl start docker.
-
- By default, the Docker service is not configured to start at boot.
- In order to configure it to autostart, log into a bash shell
- with the root account and run the following command:
- systemctl enable docker. The Grafana and InfluxDB
- images are configured to autostart when the Docker service starts.
-
+ yum check-update
+
+
+ yum install -y yum-utils
+ device-mapper-persistent-data lvm2
+
+
+
+ yum-config-manager --add-repo
+ https://download.docker.com/linux/centos/docker-ce.repo
+
+
+
+ yum install docker
+
+
+
+ In order to deploy the Grafana and InfluxDB images, the Docker
+ service needs to be started. To start the Docker service, log into a
+ bash shell with the root account and run the following command:
+ systemctl start docker.
+
+
+ By default, the Docker service is not configured to start at
+ boot. In order to configure it to autostart, log into a bash shell
+ with the root account and run the following command:
+ systemctl enable docker. The Grafana and InfluxDB
+ images are configured to autostart when the Docker service
+ starts.
+
+ Deploying Grafana and InfluxDB
@@ -90,11 +98,13 @@
Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz.
The directory in which the archive will be unpacked will be
- denoted as: <Telemetry-installdir>.
+ denoted as:
+ <Telemetry-installerdir>.
- Enter <Telemetry-installdir>.
+ Enter
+ <Telemetry-installerdir>.
@@ -103,25 +113,26 @@
- When prompted, select what images you want to deploy.
- Select Both unless you wish for the Grafana
- and InfluxDB images to be on separate servers.
-
-
- If an image is already deployed, you will be prompted
- to replace it.
-
- By default, Grafana is configured for deployment on the
- same server as InfluxDB. Please read the Grafana documentation
- on how to configure it if you wish to deploy the images
- on separate servers.
-
+ When prompted, select what images you want to deploy. Select
+ Both unless you wish for the Grafana and InfluxDB
+ images to be on separate servers.
+
+
+ If an image is already deployed, you will be prompted to
+ replace it.
+
+ By default, Grafana is configured for deployment on the same
+ server as InfluxDB. Please read the Grafana documentation on how
+ to configure it if you wish to deploy the images on separate
+ servers.
+ During the InfluxDB deployment, you will be prompted to
provide a username and password. These must match the ones
- configured in the Enea Edge Management for Telemetry.
+ configured in the Enea Edge Management application for
+ Telemetry.
Changing the InfluxDB username and password requires
@@ -135,47 +146,48 @@
present and have the status Up.
-
-
- The provided Grafana instance by default uses the
- Username:admin and
- Password:admin.
-
-
+
+
+ The provided Grafana instance by default uses the
+ Username:admin
+ and Password:admin.
+
-
-
- Firewall settings for Grafana and InfluxDB
-
- If a firewall is running on the machines where Grafana and InfluxDB are
- deployed, this firewall needs to be configured so the required ports are
- enabled.
-
- To enable the ports, log into a bash shell with the root account and
- perform the following:
-
-
-
-
- For InfluxDB, run the following command:
-
- firewall-cmd --permanent --add-port=25826/tcp
-
-
-
- For Grafana, run the following command:
-
- firewall-cmd --permanent --add-port=3000/tcp
-
-
+
+
+
+ Firewall settings for Grafana and InfluxDB
+
+ If a firewall is running on the machines where Grafana and InfluxDB
+ are deployed, this firewall needs to be configured so the required ports
+ are enabled.
+
+ To enable the ports, log into a bash shell with the root account and
+ perform the following:
+
+
+
+ For InfluxDB, run the following command:
+
+ firewall-cmd --permanent --add-port=25826/tcp
+
+
+
+ For Grafana, run the following command:
+
+ firewall-cmd --permanent --add-port=3000/tcp
+
+ Setting Grafana and InfluxDB parameters
- Customizing InfluxDB and Grafana parameters can be done in the Enea uCPE Manager
- GUI by selecting System, then the Configuration menu, accessing the Customizing InfluxDB and Grafana parameters can be done in the Enea
+ Edge Management GUI by selecting the System menu, then Configuration, accessing the Properties tab, and clicking on the Telemetry tab. The settings that can be changed are
listed in the table below:
@@ -202,8 +214,8 @@
Grafana Hostname or IP Address
- The public hostname or IP address where the Grafana instance is
- installed.
+ The public hostname or IP address where the Grafana
+ instance is installed.no default
@@ -220,7 +232,7 @@
Grafana DashboardThe dashboard that should be used when opening Grafana
- using the Enea Edge Management.
+ using the Enea Edge Management application.
host
@@ -228,8 +240,8 @@
InfluxDB Hostname or IP Address
- The public hostname or IP address where the InfluxDB database is
- installed.
+ The public hostname or IP address where the InfluxDB
+ database is installed.no default
@@ -265,8 +277,9 @@
When changing any of the settings in the Telemetry tab, the Enea Edge Management will inform
- all uCPE devices of the change if they have telemetry running.
+ role="bold">Telemetry tab, the Enea Edge Management application
+ will inform all uCPE devices of the change if they have telemetry
+ running.
Telemetry Properties
@@ -289,7 +302,7 @@
options are available.
When starting Telemetry for a uCPE device, the Enea Edge Management
- sends the following information about the InfluxDB:
+ application sends the following information about the InfluxDB:
@@ -324,9 +337,10 @@
When the Telemetry status is changed on a uCPE device, a
- notification is sent to the Enea Edge Management. These notifications can
- be inspected under Fault found in the
- Event menu.
+ notification is sent to the Enea Edge Management application. These
+ notifications can be inspected under Fault found in the Event menu.
@@ -344,4 +358,4 @@
Telemetry tab. The default dashboard
available when launching Grafana can be customized as well.
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
index 2805d4f..1ca3b02 100644
--- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
@@ -1,4 +1,4 @@
-
+
Setting up and Installing the Enea Edge Base Configuration
@@ -18,11 +18,12 @@
The CentOS 7 server must be updated to the latest revision
- before installing Enea Edge.
+ before installing Enea Edge, and configured for English language
+ usage.
The following will detail CPU, RAM and storage requirements for
- the Enea Edge Management Application.
+ the Enea Edge Management application:
@@ -81,9 +82,10 @@
The purpose of the CentOS 7 server is to host the Enea Edge
- Management Application. Network access between the CentOS 7 server and the uCPE
- devices is required. The Enea Edge Management and the uCPE devices
- will be connected on separate subnets to avoid inconsistencies.
+ Management application. Network access between the CentOS 7 server and
+ the uCPE devices is required. The Enea Edge Management application and
+ the uCPE devices will be connected on separate subnets to avoid
+ inconsistencies.
@@ -100,8 +102,7 @@
supported Intel CPUs of Enea Edge are documented in the
- Manual.
+ xpointer="element(book_enea_edge_release_info/1)" /> Manual.
Enea Edge Runtime needs EFI support in BIOS to boot. When
configuring the uCPE device BIOS a serial connection is
@@ -119,12 +120,12 @@
- Connecting to the GUI of the Enea Edge Management for
- management and configuration. Network access between the CentOS 7
- server and the laptop is required. Please see the Connecting to the GUI of the Enea Edge Management
+ application for management and configuration. Network access
+ between the CentOS 7 server and the laptop is required. Please see
+ the Manual
+ xpointer="element(book_enea_edge_release_info/1)" /> Manual
available with your release, for recommended browsers.
@@ -147,9 +148,10 @@
Any firewall running on the CentOS 7 server may block the
management protocols required to communicate between the uCPE device and
- the Enea Edge Management as well as between the Enea Edge Management and
- its northbound clients. Quick handling of a blocking firewall would be
- to disable it, typical for a lab environment, through:
+ the Enea Edge Management application as well as between the Enea Edge
+ Management application and its northbound clients. Quick handling of a
+ blocking firewall would be to disable it, typical for a lab environment,
+ through:
sudo systemctl stop firewalld
sudo systemctl disable firewalld
@@ -186,10 +188,8 @@ sudo systemctl mask now firewalldUDP
-
- Required for the Enea Edge Management High Availability
-
- Configuration.
+ Required for the Enea Edge Management application High
+ Availability Configuration.
@@ -197,9 +197,8 @@ sudo systemctl mask now firewalld
TCP
- Required for the Enea Edge Management High Availability
-
- Configuration.
+ Required for the Enea Edge Management application High
+ Availability Configuration.
@@ -223,7 +222,7 @@ sudo systemctl mask now firewalld
Use the following command sequence to enable the required ports
- for deployment of the Enea Edge Management:
+ for deployment of the Enea Edge Management application:
sudo firewall-cmd --permanent --add-port=80/tcp
sudo firewall-cmd --permanent --add-port=443/tcp
@@ -238,18 +237,19 @@ sudo firewall-cmd --reload
port-filtering firewall, then all the aforementioned ports need to
also be enabled on the respective firewall. As an additional
requirement, port 22/TCP also needs to be enabled for reverse SSH to
- the Enea Edge Management.
+ the Enea Edge Management application.
No enabling and no forwarding rules are necessary for ports
- 2021-2040 if using Enea Edge 2.4.0 or newer.
+ 2021-2040 if Enea Edge 2.4.0 or newer is used.
Configuring OpenJDK and PostgreSQL
- The Enea Edge Management requires a specific Java version (OpenJDK
- 11) and a PostgreSQL version to operate correctly.
+ The Enea Edge Management application requires a specific Java
+ version (OpenJDK 11) and a PostgreSQL version to operate
+ correctly.Installing OpenJDK
@@ -299,10 +299,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
- The Enea Edge Management requires a specific PostgreeSQL version.
- This is embedded in the Enea Edge Management installation. In order to
- avoid conflicts, any existing PostgreeSQL installation needs to be
- uninstalled.
+ The Enea Edge Management application requires a specific
+ PostgreSQL version. This is embedded in the Enea Edge Management
+ installation. In order to avoid conflicts, any existing PostgreSQL
+ installation needs to be uninstalled.Uninstalling PostgreSQL
@@ -324,8 +324,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
- This step is not necessary if the Enea Edge Management will
- be using an external database (like MariaDB).
+ This step is not necessary if the Enea Edge Management
+ application will be using an external database (like
+ MariaDB).yum remove postgres\*
@@ -357,11 +358,13 @@ userdel postgresFollow the installation steps for the Enea Edge Management
- available in Installing the Enea Edge Management in
- the Installing the Enea Edge Management
+ application in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -388,16 +391,14 @@ userdel postgres
Determining the Device IDEach uCPE device needs a unique identifier. This identifier is
- used to match the registration in the Enea Edge Management and the
- offline configuration of the uCPE device during ZTP (Zero Touch
+ used to match the registration in the Enea Edge Management application
+ and the offline configuration of the uCPE device during ZTP (Zero Touch
Provisioning).Select a text string to represent the uCPE device, e.g.
uCPE-1 or fwa-t1012vc_boston_1234.
It can have any length and any type of characters with the exception of
- quotation characters (' or ") or line terminators (\n or \r) which can
- interfere with the JSON format of the
- install_data.json file.
+ quotation characters (' or ") or line terminators (\n or \r).
@@ -459,30 +460,31 @@ userdel postgres
Preparing the Deployment
- Installing the Enea Edge Management
+ Installing the Enea Edge Management application
- The Enea Edge Management can be installed using a fresh
- (first-time) configuration or using a backup file of a previous
+ The Enea Edge Management application can be installed using a
+ fresh (first-time) configuration or using a backup file of a previous
installation, created within the Enea Edge Management GUI.
- Fresh Installation of the Enea Edge Management
+ Fresh Installation of the Enea Edge Management
+ applicationOn the CentOS 7 server open a terminal, log into a bash shell
with the root account and perform the following:
-
Extract
Enea_Edge_Management_<version>-build<build_number>.tar.gzThe directory in which the archive has been unpacked will be
- denoted as: <uCPEM-installdir>.
+ denoted as: <uCPEM-installerdir>.
- Enter <uCPEM-installdir>/dist.
+ Enter
+ <uCPEM-installerdir>/dist.
@@ -511,8 +513,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
The same configuration values set now will need to be
- provided when upgrading or uninstalling the Enea Edge
- Management.
+ provided when upgrading or uninstalling the Enea Edge Management
+ application.
@@ -527,32 +529,32 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
Specify the database process password
- [postgres]:
+ [postgres]:
Specify the database ID (or name)
- [ucpemanager]:
+ [ucpemanager]:
Specify the database server port
- [5432]:
+ [5432]:
Specify a database user name
- [postgres]:
+ [postgres]:
Specify a database password
- [postgres]:
+ [postgres]:
Specify the database startup thread pool size
- [1]:
+ [1]:
@@ -563,17 +565,17 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
Specify a service username
- [ucpemanager]:
+ [ucpemanager]:Specify a service password
- [ucpemanager]:
+ [ucpemanager]:
-
+ High Availability Configurations:
@@ -597,7 +599,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
Create the self-signed certificate: Specify IP
- or domain name:
+ or domain name:
The certificate can be generated again by running the
@@ -620,12 +622,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Install the Enea Edge Management as a service with the
- name ucpemanager.
+ Install the Enea Edge Management application as a
+ service with the name ucpemanager.
- Start the ucpemanager service
+ Start the ucpemanager service.
@@ -639,24 +641,24 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- The IPv4 address of the CentOS 7 Server, connected to the same
- network as the uCPE Devices, will be used as a configuration
+ The IPv4 address of the CentOS 7 Server will be used as a configuration
parameter when setting up the uCPE devices.If the CentOS 7 Server is installed behind NAT, the IPv4
address used will be the public IP of the NAT device and port
forwarding rules must be created to ensure the uCPE device can
- access the Enea Edge Management. For more details, please see Firewall Configuration.
+ access the Enea Edge Management application. For more details,
+ please see Firewall
+ Configuration.
- Installation of the Enea Edge Management using a System
- Back-up
+ Installation of the Enea Edge Management application using a
+ System Back-up
- The Enea Edge Management can be restored if a backup file has
- been previously created.
+ The Enea Edge Management application can be restored if a backup
+ file has been previously created.A backup file can be created by accessing the System menu, and clicking The System Back-up file obtained from the Enea Edge Management
GUI (SystemBackup_MMMDD_YYYY_HHMM_SS.zip) is
- different from the snapshot obtained during a Enea Edge Management
+ different from the snapshot obtained during an Enea Edge Management
Upgrade or Uninstall operation
(ucpemanager-Backup-YYYYddMMHHmm.tar.gz) needed
- for recovery of the Enea Edge Management. For more details, see
- Restoring a previous Enea Edge
Management installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
- To install the Enea Edge Management with the restore option
- provide an additional argument as shown below during
+ To install the Enea Edge Management application with the restore
+ option provide an additional argument as shown below during
installation:./install.sh \
@@ -708,8 +710,7 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zipThe .hddimg image is available in the
- Enea_Edge_Runtime_Platform_
- <processor>_<version>-build<build_number>.tar.gz
+ Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz
file you downloaded with your release.
@@ -719,7 +720,7 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip
Copy the .hddimg image file provided by
- Enea, into the CentOS 7 server.
+ Enea, onto the CentOS 7 server.
@@ -740,10 +741,9 @@ sdb 8:0 0 111.8G 0 disk
sudo dd if=./enea-nfv-access-<machine>.hddimg \
of=/dev/sdb bs=4M conv=fsync
- Where
- enea-nfv-access-<machine>.hddimg is the
- .hddimg file and sdb is the
- assigned USB device name.
+ Where enea-nfv-access-<machine>.hddimg is
+ the .hddimg file and sdb is
+ the assigned USB device name.
@@ -790,8 +790,9 @@ of=/dev/sdb bs=4M conv=fsync
On the Requirements page of
- the Web-installer, the user must confirm the current state of
- installation prerequisites is inline with the desired state:
+ the Web-installer, the user must confirm the the current state of
+ the installation prerequisites is inline with the desired
+ state:
@@ -833,12 +834,12 @@ of=/dev/sdb bs=4M conv=fsync
does not support IOMMU Group separation, there are certain
limitations regarding how the vfio-pci
driver can be used. For more details, see the Known Issues and Limitations in
this Release in the
+ xpointer="element(book_enea_edge_release_info/1)" />
Manual.
@@ -860,8 +861,8 @@ of=/dev/sdb bs=4M conv=fsync
- The static Enea Edge Management IP Address or FQDN. This can be
- either:
+ The static Enea Edge Management IP Address or FQDN. This
+ can be either:
@@ -878,23 +879,23 @@ of=/dev/sdb bs=4M conv=fsync
The Fully Qualified Domain Name (FQDN) of the Enea
- uCPE Manager host machine.
+ Edge Management host machine.
The unique identifier of the uCPE device (called
- "DeviceId" in this guide).
+ "DeviceId" in this Manual).
Customer Tags. They are used for Zero Touch Provisioning
(ZTP) and can be left empty for a base configuration. What can
be entered here (if needed), are the tag(s) specified when
- creating an offline configuration in the Enea Edge Management. A
- later addition of customer tags can only be done by reinstalling
- the uCPE devices.
+ creating an offline configuration in the Enea Edge Management
+ application. A later addition of customer tags can only be done
+ by reinstalling the uCPE devices.
@@ -912,8 +913,8 @@ of=/dev/sdb bs=4M conv=fsync
Select a WAN interface to use as the management network
- interface. This interface is used by the Enea Edge Management to
- communicate with the uCPE device.
+ interface. This interface is used by the Enea Edge Management
+ application to communicate with the uCPE device.
@@ -928,14 +929,14 @@ of=/dev/sdb bs=4M conv=fsync
Web-installer, Enea Edge Runtime is installed on the hard drive. At this
stage, the user should remove the USB stick and the LAN cable, and
shutdown the uCPE device. It will be started after necessary
- configurations are done in the Enea Edge Management, as described
- below.
+ configurations are done in the Enea Edge Management application, as
+ described below.
If errors are detected during installation, full logs will be
available on the last page of the Web-installer. Please contact Enea
- for log analysis. The system is not expected to be usable if errors are
- reported during installation.
+ for log analysis. The system is not expected to be usable if errors
+ are reported during installation.
If the USB stick was booted in UEFI mode, a UEFI boot entry is
automatically created and the system will start booting from the hard
@@ -962,12 +963,12 @@ of=/dev/sdb bs=4M conv=fsync
Network connection between the server running the Enea Edge
- Management and the laptop.
+ Management application and the laptop.Network connection between the server running the Enea Edge
- Management and the uCPE device.
+ Management application and the uCPE device.
@@ -977,15 +978,15 @@ of=/dev/sdb bs=4M conv=fsync
Management of uCPE DevicesWhen the installation is complete the uCPE device can be managed in
- the Enea Edge Management.
+ the Enea Edge Management application.
Add a default Offline ConfigurationZero Touch Provisioning is always turned on when a uCPE device
- connects to the Enea Edge Management. To enable it in the Enea Edge
- Management, an offline configuration needs to be registered for Day-0
- configuration.
+ connects to the Enea Edge Management application. To enable it in the
+ Enea Edge Management application, an offline configuration needs to be
+ registered for Day-0 configuration.
Day-0 configuration is a software lifecycle term referring to
@@ -998,10 +999,10 @@ of=/dev/sdb bs=4M conv=fsync
The offline configuration consists of data and parameters that are
meant to be automatically set when a uCPE device connects to the Enea
- Edge Management for the first time. The configuration is typically
- focused on setting up the network management of the uCPE device, e.g.
- configuring network interfaces, WAN and LAN networking and service
- chains.
+ Edge Management application for the first time. The configuration is
+ typically focused on setting up the network management of the uCPE
+ device, e.g. configuring network interfaces, WAN and LAN networking and
+ service chains.For this base configuration, the offline configuration will be
left blank. The blank offline configuration can be filled with
@@ -1011,33 +1012,35 @@ of=/dev/sdb bs=4M conv=fsync
If the offline configuration is not configured, an alarm will be
raised: Day-0 Config:ZTP:Major when the uCPE device
- tries to connect to the Enea Edge Management, informing the user that
- the ZTP setup failed for the uCPE device.
+ tries to connect to the Enea Edge Management application, informing
+ the user that the ZTP setup failed for the uCPE device.
- To create an offline
- configuration
-
- In a browser access the Enea Edge Management, open Applications and select Offline Config.
-
+ Creating an offline
+ configuration
-
- Create a new offline configuration in the GUI by selecting
- the Add button and filling in the
- mandatory fields: name,
- deviceVersion and
- deviceId.
-
- The name is user defined and can be set to any unique text
- string identifying the configuration. The
- deviceVersion must match the Enea Edge Runtime
- version of the uCPE device and the deviceId
- must be the previously set identifier of the uCPE device
- (DeviceId).
-
-
+
+
+ In a browser, access the Enea Edge Management application,
+ open Applications and select
+ Offline Config.
+
+
+
+ Create a new offline configuration in the GUI by selecting the
+ Add button and filling in the
+ mandatory fields: name,
+ deviceVersion and
+ deviceId.
+
+ The name is user defined and can be set to any unique text
+ string identifying the configuration. The
+ deviceVersion must match the Enea Edge Runtime
+ version of the uCPE device and the deviceId must
+ be the previously set identifier of the uCPE device
+ (DeviceId).
+
+
@@ -1045,10 +1048,10 @@ of=/dev/sdb bs=4M conv=fsync
In order to enroll a uCPE device in the management system and
establish a management connection, the user will add uCPE device
- information in the Enea Edge Management. This is accomplished by going
- to Devices, selecting Manage and then clicking the Add button.
+ information in the Enea Edge Management application. This is
+ accomplished by going to Devices,
+ selecting Manage and then clicking the
+ Add button.
The relevant parameters are:
@@ -1060,7 +1063,7 @@ of=/dev/sdb bs=4M conv=fsync
Name. The name by which the
- uCPE device is referred to in the Enea Edge Management.
+ uCPE device is referred to in the Enea Edge Management application.
(Mandatory).
@@ -1092,22 +1095,22 @@ of=/dev/sdb bs=4M conv=fsync
For more details concerning Device Calls Home, please see Device Call Home Connection for
Deployment behind NAT in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.Booting the uCPE device and adding it to the Map
- When connectivity is established with the Enea Edge Management and
- a uCPE device is already registered with a matching Device
- ID, the installation is complete, and the connection is
- established.
+ When connectivity is established with the Enea Edge Management
+ application and a uCPE device is already registered with a matching
+ Device ID, the installation is complete, and the
+ connection is established.When a uCPE device is registered it can be manually added to the
map for overview. Right-click on the
@@ -1116,17 +1119,16 @@ of=/dev/sdb bs=4M conv=fsync
In case of management connection failure (e.g. due to a
misconfiguration), the uCPE device status will be seen as RED
- (disconnected) in the Enea Edge Management. The uCPE device
+ (disconnected) in the Enea Edge Management application. The uCPE device
configuration can be corrected by removing the WAN cable(s),
reconnecting the laptop to the LAN interface of the uCPE device and
rebooting it. At this point, the Web-installer can be accessed from the
- laptop as described in Installing Enea Edge - uCPE Device
installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -1134,17 +1136,17 @@ of=/dev/sdb bs=4M conv=fsync
uCPE Device Monitorization and Control
- Once the uCPE device is connected to the Enea Edge Management
- application, it is ready for central management. Two important functions
- available in the Enea uCPE Management GUI are alarm checking and resource
- allocation. Additionally, the device can be rebooted, the factory settings
- can be restored or simply the vCPE service can be restarted.
+ Once the uCPE device is connected to the Enea Edge Management
+ application, it is ready for central management. Two important functions
+ available in the Enea Edge Management GUI are alarm checking and resource
+ allocation. Additionally, the device can be rebooted, the factory settings
+ can be restored or simply the vCPE service can be restarted.Checking Alarms
- The Enea Edge Management dashboard presents alarms in a specific
- window on the front page.
+ The Enea Edge Management application dashboard presents alarms in
+ a specific window on the front page.An alarm can be easily triggered by disconnecting and reconnecting
the WAN ethernet cable from the uCPE device. The management system will
@@ -1152,15 +1154,16 @@ of=/dev/sdb bs=4M conv=fsync
Disconnected::Critical.A separate Alarm Management window can be accessed from the Enea
- Edge Management menu for in-depth access and programming of Alarms and
- Events.
+ Edge Management menu for in-depth access and programming of Alarms and Events.
Checking uCPE device Resource Allocation
- When the uCPE device is connected to the Enea Edge Management it
- is of interest to check the amount of hardware resources in use.
+ When the uCPE device is connected to the Enea Edge Management
+ application it is of interest to check the amount of hardware resources
+ in use.To check CPU, RAM and disk utilization simply select the uCPE
device and go to the Virtual Machines
@@ -1171,23 +1174,26 @@ of=/dev/sdb bs=4M conv=fsync
Basic operations for uCPE device Managememt
- When the uCPE device is connected to the Enea Edge Management application, it can
- be rebooted, the factory settings can be restored or simply the vCPE
- service can be restarted.
+ When the uCPE device is connected to the Enea Edge Management
+ application, it can be rebooted, the factory settings can be restored or
+ simply the vCPE service can be restarted.Select the uCPE device and go to the Operations menu, where the following options are available:
+ role="bold">Operations menu, where the following options are
+ available:
- Reboot. Reboots the device. Settings will be preserved.
+ Reboot. Reboots the device.
+ Settings will be preserved.
- Factory reset. Resets the device to its
- default factory settings. All current configuration settings are lost. All
- running VNFs are destroyed. Any installed custom scripts will be removed and
- they will need to be reinstalled.
+ Factory reset. Resets the
+ device to its default factory settings. All current configuration
+ settings are lost. All running VNFs are destroyed. Any installed
+ custom scripts will be removed and they will need to be
+ reinstalled.Only the vCPE service will be restarted, the device will not
be rebooted. No reboot is needed.
@@ -1220,14 +1226,14 @@ of=/dev/sdb bs=4M conv=fsync
In case the uCPE device was installed behind a NAT device, the
reverse SSH connection will be used. For more details, please see
- Device Call Home Connection for
deployment behind NAT in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml
index 5786883..eaa5521 100644
--- a/doc/book-enea-edge-getting-started/doc/introduction.xml
+++ b/doc/book-enea-edge-getting-started/doc/introduction.xml
@@ -1,16 +1,16 @@
-
+
Overview
- This document describes the Enea Edge and provides installation
- steps for deploying a base configuration in order to create:
+ This document describes Enea Edge and provides installation steps for
+ deploying a base configuration in order to create:
- A functional Enea Edge Management installation ready to manage uCPE
- devices.
+ A functional Enea Edge Management installation ready to manage
+ uCPE devices.
@@ -32,44 +32,42 @@
- The Enea Edge Runtime, which acts as the host
- for Virtualized Network Functions (VNFs) and provides management over
- NETCONF.
+ Enea Edge Runtime, which acts as the host for Virtualized
+ Network Functions (VNFs) and provides management over NETCONF.
- The Enea Edge Management, a solution that runs on an external
+ Enea Edge Management, an application that runs on an external
server, used for VNF Management and managing large numbers of uCPE
devices.
-
- In addition, Enea Edge includes a framework for
- automation and testing. More information can be found in
- In addition, Enea Edge includes a framework for automation and
+ testing. More information can be found in the .
+ xpointer="element(book_enea_edge_automation_user_guide/1)" />.
Details concerning release content, including documentation
structure, are provided in the Manual included
+ xpointer="element(book_enea_edge_release_info/1)" /> Manual included
with your release.Enea Edge Runtime
- Enea Edge Runtime is a lightweight,
- multi-architecture virtualization platform built on de-facto standards
- in an SDN/NFV ecosystem. It is designed for a high networking
- performance with minimal hardware footprint, by only providing relevant
- functionalties and technologies.
+ Enea Edge Runtime is a lightweight, multi-architecture
+ virtualization platform built on de-facto standards in an SDN/NFV
+ ecosystem. It is designed for a high networking performance with minimal
+ hardware footprint, by only providing relevant functionalties and
+ technologies.Virtualization methods include Virtual Machines (KVM / QEMU) and
container(s) (Docker). High networking throughput and low latency are
- ensured by accelerated data plane relying on technologies like DPDK,
+ ensured by an accelerated data plane relying on technologies like DPDK,
OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as
platform software management, virtualized networking, VNFs life-cycle
management and FCAPS are provided through the YANG-modelled NETCONF
@@ -90,13 +88,14 @@
Enea Edge Management
- The Enea Edge Management is centralized control system providing
- uCPEs domain management capabilities through a GUI and REST API. It can
+ The Enea Edge Management application is a centralized control system providing
+ domain management capabilities to uCPEs through a GUI and REST API. It can
be deployed on a host or a virtual machine running 64-bit CentOS 7 on an
- x86 platform. The Enea Edge Management uses a southbound NETCONF protocol
- to connect and manage uCPE devices.
+ x86 platform. The Enea Edge Management application uses a southbound NETCONF
+ protocol to connect and manage uCPE devices.
- The Enea Edge Management provides the following key features:
+ The Enea Edge Management application provides the following key
+ features:
@@ -144,8 +143,8 @@
Enea Edge
- The Enea Edge Runtime and the Enea Edge
- Management.
+ The Enea Edge Runtime and Enea Edge
+ Management solutions.
@@ -158,15 +157,14 @@
Enea Edge Management
- Enea Universal Customer Premises Equipment
+ The Enea Universal Customer Premises Equipment
Manager.uCPE device
- A whitebox running the Enea Edge
- Runtime.
+ A whitebox running the Enea Edge Runtime.
diff --git a/doc/book-enea-edge-getting-started/doc/log_collector.xml b/doc/book-enea-edge-getting-started/doc/log_collector.xml
index baa1340..1148dc2 100644
--- a/doc/book-enea-edge-getting-started/doc/log_collector.xml
+++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml
@@ -1,17 +1,17 @@
-
+
Using the Log Collector
- Troubleshooting problems on the uCPE device require an analysis of a
- set of information i.e. logs collected from the uCPE device and/or the Enea
- Edge Management. The following information describes how the log collection
- mechanism works.
+ Troubleshooting problems on a uCPE device require an analysis of a set
+ of data and information i.e. logs collected from the uCPE device and/or the
+ Enea Edge Management application. The following information describes how
+ the log collection mechanism works.
- Log collecting using the Enea Edge Management
+ Log collecting using the Enea Edge Management application
- The Enea Edge Management allows for collecting a set of logs and state
- information from a uCPE device.
+ The Enea Edge Management application allows for collecting a set of
+ logs and state information from a uCPE device.Collecting the Logs
@@ -31,7 +31,8 @@
- Press the Execute button.
+ Press the Execute
+ button.A success message is shown in the same window as shown below.
At this moment, the process of collecting logs on the uCPE device
@@ -53,9 +54,9 @@
It might take some time for the archive to be created. When the
operation completes, a "CollectLogsComplete" notification is sent from
- the uCPE device to the Enea Edge Management. This can be viewed in the
- GUI in the Faults menu, after selecting
-Events.
+ the uCPE device to the Enea Edge Management application. This can be
+ viewed in the GUI in the Faults menu,
+ after selecting Events.Collecting Debug Logs
@@ -74,12 +75,13 @@
View collected LogsA list with the archives containing already collected logs will be
- shown in the Device File Listing table:
+ shown in the Device File Listing
+ table:
- Access Files and then the
-Download button.
+ Access the Files menu and
+ select the Download button.
@@ -100,9 +102,9 @@
If the filename you specified does not appear, it might still be
- in the process of creation. Click on the Refresh
- icon at the bottom of the table until you can see the desired file
- listing.
+ in the process of creation. Click on the Refresh icon at the bottom of the table until
+ you can see the desired file listing.
@@ -110,12 +112,12 @@
Downloading Logs from the uCPE DeviceThis option transfers a debug file archive from the uCPE device to
- Enea Edge Management.
+ Enea Edge Management application.
- Access Files and choose the
- Download button.
+ Access the Files menu and
+ select the Download button.
@@ -123,17 +125,17 @@
- In the Device File Listing table, select
- the archive you want to download from the uCPE device to Enea Edge
- Management.
+ In the Device File Listing
+ table, select the archive you want to download from the uCPE device
+ to Enea Edge Management.
- Press the Download from Device
- button.
+ Press the Download from
+ Device button.The archive will be downloaded from the uCPE device and stored
- on the Enea Edge Management.
+ on the Enea Edge Management application.
@@ -146,30 +148,33 @@
Downloading collected Logs locally
- This option downloads a logs archive from the Enea Edge Management to
- a local (user) machine for analysis. The archive must first be available
- in the Enea Edge Management in order to be downloaded.
+ This option downloads a logs archive from the Enea Edge Management
+ application to a local (user) machine for analysis. The archive must
+ first be available in the Enea Edge Management application in order to
+ be downloaded.
- Access the Devices menu and select
-Files.
+ Access the Devices menu and
+ select Files.
- Select the Downloaded Files tab.
+ Select the Downloaded Files
+ tab.
- Select an archive from the Downloaded Files
- table.
+ Select an archive from the Downloaded
+ Files table.
- Click the Download button.
+ Click the Download
+ button.
- The file will be downloaded in browser's download
- folder.
+ The file will be downloaded in the download folder of the
+ supported browser in use.Downloaded Files Table
@@ -189,12 +194,13 @@
Deleting a Logs Archive from a uCPE deviceUse this option when you want to delete unnecessary collected logs
- on the uCPE device.
+ on a uCPE device.
- Access Files and then click the
- Download button.
+ Access the Files menu and
+ then click the Download
+ button.
@@ -202,12 +208,14 @@
- In the Device File Listing table, select
- the archive you want to delete from the uCPE device.
+ In the Device File Listing
+ table, select the archive you want to delete from the uCPE
+ device.
- Press the Delete button.
+ Press the Delete
+ button.The archive will be deleted from the uCPE device and the table
will be updated.
@@ -218,8 +226,9 @@
- Access the Operations menu and
-select Delete Debug Log Archive.
+ Access the Operations menu
+ and select Delete Debug Log
+ Archive.
@@ -227,7 +236,8 @@ select Delete Debug Log Archive.
- Press the Execute button.
+ Press the Execute
+ button.A success message is displayed if the file is deleted from the
uCPE device correctly.
@@ -236,55 +246,59 @@ select Delete Debug Log Archive.
- Deleting a Logs Archive from the Enea Edge Management
+ Deleting a Logs Archive from the Enea Edge Management
+ application
- This option deletes a logs archive from the Enea Edge
- Management.
+ This option deletes a logs archive from the Enea Edge Management
+ application.
- Access the Devices menu, then select
- Files.
+ Access the Devices menu, then
+ select Files.
- Select the Downloaded Files tab.
+ Select the Downloaded Files
+ tab.
- Select an archive from the Downloaded Files
-table.
+ Select an archive from the Downloaded
+ Files table.
- Click the Delete button.
+ Click the Delete
+ button.
- The file will be deleted from the Enea Edge Management and the
- table will be updated.
+ The file will be deleted from the Enea Edge Management
+ application and the table will be updated.
- Deleting the logs file from the Enea Edge Management does not
- affect the file located on the uCPE device.
+ Deleting the logs file from the Enea Edge Management application
+ does not affect the file located on the uCPE device.
- Enabling/Disabling of the Log Collector via Permissions
+ Enabling/Disabling the Log Collector via PermissionsTo disable the ability to access/download the uCPE device's
- debug-log files from the Enea Edge Management, the appropriate permissions
- must be changed:
+ debug-log files from the Enea Edge Management application, the
+ appropriate permissions must be changed:
- Access the Security menu,
-then select Configuration.
+ Access the Security menu,
+ then select Configuration.
- Click the Security Groups tab.
+ Click the Security Groups
+ tab.
@@ -292,18 +306,19 @@ then select Configuration.
- Click the Permissions tab on the right
- side.
+ Click the Permissions tab on
+ the right side.
- Click the Devices tab like in the image
- below.
+ Click the Devices tab like in
+ the image below.
- Change the Device File Management option to
- none to disable the feature.
+ Change the Device File
+ Management option to none to disable the feature.
@@ -322,29 +337,30 @@ then select Configuration.
Downloading Enea Edge Management Logs
- Often, sending the Enea Edge Management logs together with collected
- uCPE device logs to the support team provides important information for
- troubleshooting (especially in cases of connectivity issues with the
- uCPE device and error popups).
+ Often, sending the Enea Edge Management logs together with
+ collected uCPE device logs to the support team provides important
+ information for troubleshooting (especially in cases of connectivity
+ issues with the uCPE device and error popups).Enea Edge Management log files are located in
- application/logs/ in the Enea Edge Management's
- installation folder
+ application/logs/ in the Enea Edge Management
+ application's installation folder
(e.g./opt/ems/ucpemanager/application/logs). They
can be copied from that location, or they can be downloaded using the
Enea Edge Management GUI by performing the following:
- Access Test, then Debug
- Settings and select the Log Files tab.
+ Access Test, then Debug Settings and select the Log Files tab.Select the desired log file
(ucpemanager.log or
- watchdog.log) and press the
- Download button.
+ watchdog.log) and press the Download button.
@@ -372,12 +388,13 @@ then select Configuration.
- Log collecting without using the Enea Edge Management
+ Log collecting without using the Enea Edge Management
+ applicationLog collection from uCPE Devices can also be done when there is no
- Enea Edge Management connection. A SSH connection to uCPE Device is needed
- for use of the log collector script, which can be found in the uCPE Device
- file system in /usr/local/enea/.
+ Enea Edge Management connection. A SSH connection to the uCPE Device is
+ needed for use of the log collector script, which can be found in the uCPE
+ Device file system in /usr/local/enea/.
The Log collector script takes relevant information about the system
and collects it in an archive:
@@ -385,7 +402,7 @@ then select Configuration.
./log-collector.sh -p <LOG_PATHh> -n <ARCHIVE_NAME>Where -p is the path where the log archive will
- be saved, -n is the archive name.
+ be saved, and -n is the archive name.
If -p is not provided, the default path will be
diff --git a/doc/book-enea-edge-getting-started/doc/net_config_options.xml b/doc/book-enea-edge-getting-started/doc/net_config_options.xml
index 344b79b..ff513c9 100644
--- a/doc/book-enea-edge-getting-started/doc/net_config_options.xml
+++ b/doc/book-enea-edge-getting-started/doc/net_config_options.xml
@@ -1,24 +1,24 @@
-
+
Network Configuration Options
- Various Advanced Network Configuration options can be done from Enea
- Edge Management GUI.
+ Various Advanced Network Configuration options can be done from the
+ Enea Edge Management application GUI.Device Call Home Connection for Deployment behind NATThe Device Call Home option enables the initiation of the connection
- between the uCPE Device and the Enea Edge Management, from the uCPE
- device. The Device Call Home option is required when deploying a uCPE
+ between the uCPE Device and the Enea Edge Management application, from the
+ uCPE device. The Device Call Home option is required when deploying a uCPE
device behind NAT since the IP address of the uCPE device is hidden for
- the Enea Edge Management.
+ the Enea Edge Management application.Enable Device Call Home by marking the Device Call Home checkbox
- when registering the uCPE device in Enea Edge Management. When using this
- mechanism, the device will initiate a connection to the Enea Edge
- Management for NETCONF traffic (over SSH), while the Enea Edge Management
- waits for a device connection.
+ when registering the uCPE device in Enea Edge Management application. When
+ using this mechanism, the device will initiate a connection to the Enea
+ Edge Management application for NETCONF traffic (over SSH), while the
+ application waits for a device connection.
@@ -30,7 +30,7 @@
selecting physical interfaces to be used by virtualized networking and
creating different types of bridges to enable VNF communication.
- The Zero Touch Provisioning mechanism is also touched upon, as
+ The Zero Touch Provisioning mechanism is also touched upon, as an
alternative to manual configuration of the virtualization
infrastructure.
@@ -52,9 +52,9 @@
configurations have been made.
- In Configuration, select
- DPDK where DPDK resources can also be
- configured such as:
+ In the Configuration menu, select
+ DPDK, here DPDK resources can also be
+ configured:
@@ -90,8 +90,8 @@
virtualization infrastructure and VNFs, they must be configured into the
management system.
- To add an interface into the Enea Edge Management, select the uCPE
- device, then from the top toolbar select To add an interface into the Enea Edge Management application,
+ select the uCPE device, then from the top toolbar select Configuration, then External Interfaces, Configuration, and click the Wan Interface Type
WAN interfaces configured during the installation of the uCPE
- device are automatically added in the Enea Edge Management as type
- wan. The WAN interface used for management of the
- uCPE device is marked with the Management property
- set to True.
+ device are automatically added in the Enea Edge Management application
+ as type wan. The WAN interface used for management
+ of the uCPE device is marked with the Management
+ property set to True.If a WAN interface is to be assigned for use by a VNF, it must
be changed into another interface type depending on the type of
@@ -305,9 +305,10 @@
Correct Country Code
selection is mandatory. All configuration options are available in
- the Enea Edge Management GUI but only the Radio Settings that
- conform with the selected country's official regulatory laws will be
- applied when the Wireless AP is started on the uCPE Device.
+ the Enea Edge Management application GUI but only the Radio Settings
+ that conform with the selected country's official regulatory laws
+ will be applied when the Wireless AP is started on the uCPE
+ Device.
@@ -429,7 +430,8 @@
Device management. Part of
- the device configuration done by the Enea Edge Management.
+ the device configuration done by the Enea Edge Management
+ application.
@@ -558,7 +560,8 @@
If the offline configuration is not configured for a uCPE device,
an alarm will be raised: Day-0 Config:ZTP:Major,
which occurs when the uCPE device connects to the Enea Edge Management
- informing that the ZTP setup failed for the specific uCPE device.
+ application informing that the ZTP setup failed for the specific uCPE
+ device.
To create an offline configuration, select from the top toolbar
the Applications menu, then
- When a device connects to the Enea Edge Management for the first
- time, it checks the device to see if it has been Zero Touch Provisioned
- (ZTP). If not, it looks for an offline configuration that matches these
- values, in the following order:
+ When a device connects to the Enea Edge Management application for
+ the first time, it checks the device to see if it has been Zero Touch
+ Provisioned (ZTP). If not, it looks for an offline configuration that
+ matches these values, in the following order:
@@ -633,9 +636,9 @@
The ZTP will only be triggered the first time a uCPE device
- connects to the Enea Edge Management. Just changing an offline
- configuration will not push the new changes to the device. If an
- offline configuration is changed after uCPE device registration, a
+ connects to the Enea Edge Management application. Just changing an
+ offline configuration will not push the new changes to the device. If
+ an offline configuration is changed after uCPE device registration, a
factory reset can be executed to force a new ZTP to execute. Select
the device, then access the Operations menu and select Uploading Scripts
- The scripts need to be uploaded to the Enea Edge Management prior
- to use. When uploading scripts to the Enea Edge Management make sure to
- select the right script type.
+ The scripts need to be uploaded to the Enea Edge Management
+ application prior to use. When uploading scripts to the Enea Edge
+ Management application make sure to select the right script type.The following script types are supported:
@@ -736,7 +739,7 @@
Select the script you want to delete from the Uploaded Scripts tab and then click Delete, which will remove the script
- immediately from the Enea Edge Management.
+ immediately from the Enea Edge Management application.
@@ -907,4 +910,4 @@
Interfaces.
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
index 4984a35..fcf991e 100644
--- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
+++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
@@ -1,24 +1,24 @@
-
+
Troubleshooting and RecoveryIn all scenarios where possible, collect the logs for debugging. More
information on log collecting can be found in Using the Log Collector in the Using
+ the Log Collector in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.The following is a small list of possible Enea Edge problems, and
their solutions. If you encounter other issues or can't get Enea Edge to
work successfully after consulting the information below, please use the
- Enea Support Team Form, available in the
Manual
+ xpointer="element(book_enea_edge_release_info/1)" /> Manual
downloaded with your release.
@@ -38,18 +38,18 @@
A uCPE device fails to connect to the Enea Edge Management
- after installation.
+ application after installation.
If the uCPE device is not able to connect to the Enea Edge
- Management after an installation, the Web-installer application is
- started automatically on the uCPE device to change the configuration
- via a web browser. Please see Booting the uCPE device and adding
it to the Map in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -65,12 +65,11 @@
Reinitiate the Upgrade procedure according to the steps
- in section uCPE device upgrades in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -78,22 +77,22 @@
After a failed uCPE device upgrade the previous Enea Edge
- image (from the GRUB menu) does not boot.
+ Runtime image (from the GRUB menu) does not boot.
- Reinstall Enea Edge on the uCPE device and redeploy the
- initial configuration and virtualized services, by following the
- steps in Reinstall Enea Edge Runtime on the uCPE device and redeploy
+ the initial configuration and virtualized services, by following the
+ steps in Installing Enea Edge - uCPE Device
installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
- The Enea Edge Management upgrade fails and a working snapshot
- is available.
+ The Enea Edge Management application upgrade fails and a
+ working snapshot is available.If a working snapshot obtained during a previous Upgrade or
Uninstall is available
@@ -107,20 +106,21 @@
Restore the previous installation as described in Restoring a previous
Enea Edge Management installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
- The Enea Edge Management upgrade fails and no working
- snapshot is available, but a System Back-up file exists.
+ The Enea Edge Management application upgrade fails and no
+ working snapshot is available, but a System Back-up file
+ exists.
@@ -132,20 +132,21 @@
Perform an installation with the restore option of a
previous Enea Edge Management configuration as described in
- Installation of the
- Enea Edge Management using a System Back-up in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
- The uCPE device is booted, the ssh connection is available
- but the device is not connected to the Enea Edge Management.
+ The uCPE device is booted, the SSH connection is available
+ but the device is not connected to the Enea Edge Management
+ application.
@@ -155,12 +156,13 @@
Use the Reconnect
- button from the Enea Edge Management's GUI.
+ button from the Enea Edge Management applications's
+ GUI.
- Connect to uCPE Device console and run the factory reset
- script:
+ Connect to the uCPE Device console and run the factory
+ reset script:/usr/local/odm/bin/factory_reset.sh
@@ -168,12 +170,12 @@
If the above actions do not work, reinstall and
reconfigure the device using the steps provided in Installing Enea Edge - uCPE
Device installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -185,12 +187,12 @@
Perform a hardware reboot on the uCPE device. If the problem
is not fixed, reinstall and reconfigure the device using the steps
- provided in Installing Enea Edge - uCPE Device
installation in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -208,7 +210,7 @@
Reboot the device by accessing Operations and then selecting Reboot from within the Enea Edge
- Management.
+ Management application.
diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
index 9680a0c..80473cb 100644
--- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
+++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
@@ -1,19 +1,20 @@
-
+
Upgrading Enea EdgeEnea provides regular releases that will require the upgrading of Enea
- Edge components. The Enea Edge Management must be upgraded first, followed
- by upgrading the Enea Edge Runtime on the uCPE devices.
+ Edge components. The Enea Edge Management application must be upgraded
+ first, followed by upgrading the Enea Edge Runtime on the uCPE
+ devices.
- Upgrading the Enea Edge Management
+ Upgrading the Enea Edge Management application
- It is recommended to create a system backup by accessing System and selecting System
- Backup from the Enea Edge Management GUI, for recovery in
- case of an upgrade failure.
+ It is recommended to create a system backup by accessing the
+ System menu and selecting System Backup from the Enea Edge Management GUI,
+ for recovery in case of an upgrade failure.
@@ -23,11 +24,11 @@
folder.
The directory in which the archive has been unpacked will be
- denoted as <uCPEM-installdir>.
+ denoted as <uCPEM-installerdir>.
- Enter <uCPEM-installdir>/dist.
+ Enter <uCPEM-installerdir>/dist.
@@ -53,11 +54,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzucpemanager-Back-up-YYYYddMMHHmm.tar.gz), which
contains a snapshot of the existing installation in the
- <uCPEM-installdir>/dist directory.
+ <uCPEM-installerdir>/dist directory.
The snapshot file created during the upgrade can be used for
- restoring the Enea Edge Management.
+ restoring the Enea Edge Management application.
@@ -71,23 +72,22 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Fresh Installation of the Enea Edge Management
- in the Fresh Installation of the Enea Edge
+ Management in the
- Manual contains information about the input required to be entered during
- the execution of the upgrade script.
+ xpointer="element(book_enea_edge_getting_started/1)" /> Manual
+ contains information about the input required to be entered during the
+ execution of the upgrade script.
-
- For an example on how to upgrade an Enea Edge Management installation
- in a High Availability setup, consult For an example on how to upgrade an Enea Edge
+ Management installation in a High Availability setup, consult Upgrading a High Availability Deployment in the
+ xpointer="element(book_enea_edge_getting_started/1)" />
Manual.
@@ -104,7 +104,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
The directory in which the archive has been unpacked will be
- denoted as <uCPEM-installdir>.
+ denoted as <uCPEM-installerdir>.
@@ -112,11 +112,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzucpemanager-Backup-YYYYddMMHHmm.tar.gz)
created during a previous Enea Edge Management Upgrade or Enea Edge
Management Uninstall Operation into the
- <uCPEM-installdir> directory.
+ <uCPEM-installerdir>/dist directory.
- Enter <uCPEM-installdir>/dist.
+ Enter
+ <uCPEM-installerdir>/dist.
@@ -156,9 +157,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Navigate to the folder where the Enea Edge Management is
- installed: <uCPEM-installdir>.
+ Navigate to the folder where the Enea Edge Management
+ application is unpacked:
+ <uCPEM-installerdir>.
+
+
+ Enter
+ <uCPEM-installerdir>/dist.
+ Run the following command with the root user and change
@@ -186,7 +193,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
The snapshot file created during the uninstall can be used
- for restoring Enea Edge Management.
+ for restoring the Enea Edge Management application.
@@ -205,8 +212,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- After these steps, the Enea Edge Management is completely removed
- from the system.
+ After these steps, the Enea Edge Management application is
+ completely removed from the system.
@@ -241,11 +248,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
Upgrading from Enea NFV Access 2.3.0 is not possible when using
- the Enea uCPE Manager in HTTPS mode. Either switch to HTTP by accessing
- System, Configuration, Web
- Access and checking the Enable
- HTTP box, or install Edge Enea 2.4.0 on the device manually.
+ the Enea Edge Management application in HTTPS mode. Either switch to
+ HTTP by accessing the System menu,
+ clicking on Configuration, then
+ Web Access and checking the Enable HTTP box, or by installing Edge Enea
+ 2.4.0 on the device manually.
@@ -379,8 +387,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- The hour represents the local Enea Edge Management server
- hour.
+ The hour represents the local Enea Edge Management
+ application server hour.
@@ -577,8 +585,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz tab by selecting the image file from the list and
clicking the Install on Device
button. The Image files that appear in the Image
- Library tab can be uploaded to the Enea Edge Management Application
- by following the steps listed in Image Library.
+ Library tab can be uploaded to the Enea Edge Management
+ Application by following the steps listed in Image Library.
Once an image is installed on the uCPE device, the image will be
available on the uCPE device and be visible in the Select it from the list and then start the upgrade by
- clicking the Upgrade button.
+ clicking the Upgrade
+ button.
- Select Operations, then
+ Select Operations, then
Upgrade, enter the
Release Name and press Execute. Filling in the Restore Archive
- text field is optional and should be left unset if the
- NFVi Snapshot feature is disabled.
+ role="bold">Execute. Filling in the Restore
+ Archive text field is optional and should be left unset
+ if the NFVi Snapshot feature is
+ disabled.
@@ -610,4 +621,4 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
index e3fcde2..058be40 100644
--- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
@@ -1,18 +1,18 @@
-
+
VNF Management
- The Enea Edge Management is responsible for onboarding, configuring
- (e.g. CloudInit) and ensuring life cycle management of VNFs that are
- instantiated and run on the various uCPE devices.
+ The Enea Edge Management application is responsible for onboarding,
+ configuring (e.g. CloudInit) and ensuring life cycle management of VNFs that
+ are instantiated and run on various uCPE devices.Onboarding a VNFThe onboarding of a VNF means adding it to the Enea Edge Management
- VNF Catalogue and preparing it for instantiation (deployment on connected
- uCPE devices). This is accomplished using the Enea Edge Management
- Onboarding graphical user interface.
+ application VNF Catalogue and preparing it for instantiation (deployment
+ on connected uCPE devices). This is accomplished using the Enea Edge
+ Management Onboarding graphical user interface.
Typically, the Getting Started Guide of a VNF, provided by the VNF
vendor, contains all necessary information needed to onboard a VNF.
@@ -36,7 +36,8 @@
There are no standard ways of managing VNF licenses,
therefore no general guidelines can be provided. One example of
license handling that can be employed in the Enea Edge Management
- is the adding of a license during the Cloud-Init setup.
+ application is the adding of a license during the Cloud-Init
+ setup.
@@ -109,10 +110,10 @@
- Onboarding into the Enea Edge Management
+ Onboarding into the Enea Edge Management applicationHow to onboard a VNF into the Enea Edge
- Management
+ Management application
@@ -122,15 +123,15 @@
- Click the On-board
+ Click the Onboard
button.This window contains data fields where both necessary and optional
information about the VNF can be supplied. After doing so, press the
- Onboard button, the Enea Edge Management will create the VNF descriptor
- and add it to its VNF Catalog.
+ Onboard button and the Enea Edge Management application will create the
+ VNF descriptor and add it to its VNF Catalog.
Onboard a VNF
@@ -167,7 +168,7 @@
Description. This field
contains any description provided and is only displayed in the GUI
- tables in the Enea Edge Management.
+ tables in the Enea Edge Management application.
@@ -206,11 +207,12 @@
configured, when creating an instance. Consult the VNF vendor to
determine which and how many are required. Each interface requires a
name, and optionally a description, used only by the Enea Edge
- Management.
+ Management application.
- CAUTION: The user MUST conserve the same order for the virtual
- interfaces during both onboarding and instantiation phases.
+ CAUTION: The user MUST save and use the same order for the
+ virtual interfaces during both the onboarding and instantiation
+ phases.Cloud Init Tab
@@ -242,7 +244,7 @@
NoCloud. This is a
- simpler method that uses only one cloud init file
+ simpler method that uses only one cloud-init file
(User-Data).
@@ -269,14 +271,14 @@
The Content Files Table is ONLY used if
ConfigDrive is chosen as the Cloud-Init
Datasource. For each content file added, a Path
- must be provided. When the Enea Edge Management is used to create an
- instance for multiple VNFs, the user will be prompted to provide a
- data file for each entry in this table. Each type of VNF will
- require different cloud-init files, e.g.: a license file. The data
- files will be added to the cloud-init image that the user provides
- at the instantiation of the VNF. If the cloud-init image is not
- provided, no Cloud-Init Data Source will be created for that VNF and
- there will be no warning.
+ must be provided. When the Enea Edge Management application is used
+ to create an instance for multiple VNFs, the user will be prompted
+ to provide a data file for each entry in this table. Each type of
+ VNF will require different cloud-init files, e.g.: a license file.
+ The data files will be added to the cloud-init image that the user
+ provides at the instantiation of the VNF. If the cloud-init image is
+ not provided, no Cloud-Init Data Source will be created for that VNF
+ and there will be no warning.
@@ -407,8 +409,9 @@
- Selecting the VNF menu then choosing Events
- will show that the VNF was created and a connection was established.
+ Selecting the VNF menu then
+ choosing Events will show that the VNF
+ was created and a connection was established.
@@ -430,7 +433,7 @@
Depending on the desired action, click the Delete/ Force Delete / Start / Stop / Pause /
- Resume button respectively.
+ Resume button, respectively.
@@ -443,15 +446,15 @@
Depending on the desired action, choosing Destroy / Start / Stop / Pause / Resume
- VM respectively.
+ role="bold">Destroy / Start / Stop / Pause / Resume VM
+ respectively.
The Id of the VM that should be modified can
- be found by selecting Configuration, then
- Virtual Machines, and then accessing the VMs tab.
+ be found by selecting Configuration,
+ then Virtual Machines, and then
+ accessing the VMs tab.
@@ -471,9 +474,9 @@
- SSH to the uCPE device from the Enea Edge Management (Access the
- Device menu and select SSH) using:
+ SSH to the uCPE device from the Enea Edge Management application
+ (access the Device menu and select
+ SSH) using:
@@ -484,13 +487,13 @@
- For reverse ssh connections (ssh to a uCPE device behind
+ For reverse SSH connections (SSH to a uCPE device behind
NAT): the Username (default: root) and the
- Reverse ssh checkbox checked. The port will be
- automatically chosen by the Enea Edge Management in the range
- defined in the SSH configuration
- panel, available when accessing System, then Reverse SSH checkbox checked. The port will be
+ automatically chosen by the Enea Edge Management application in
+ the range defined in the SSH
+ configuration panel, available when accessing the System menu, then Configuration and choosing Reverse SSH . By default, the start port
will be 7000 and the maximum number of ports
@@ -523,4 +526,4 @@
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-management-open-source/doc/about.xml b/doc/book-enea-edge-management-open-source/doc/about.xml
index 758efc9..e13cd41 100644
--- a/doc/book-enea-edge-management-open-source/doc/about.xml
+++ b/doc/book-enea-edge-management-open-source/doc/about.xml
@@ -5,8 +5,8 @@
About this ReportThis document contains the open source and license information
- pertaining to packages relating to the Enea Edge Management provided
- with Enea Edge .
diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml
index 766c02a..349c955 100644
--- a/doc/book-enea-edge-release-info/doc/about_release.xml
+++ b/doc/book-enea-edge-release-info/doc/about_release.xml
@@ -4,26 +4,28 @@
About This Release
- Enea Edge is a complete NFVI software platform designed for deployment
- on any white box uCPE device, and optimized for common use cases. Enea Edge
- includes both the Enea Edge Runtime deployed on a white box, and a
- management component with automation tools deployed in a private or public
- cloud.
+ Enea Edge is a complete Virtualization Infrastructure software
+ platform designed for deployment on any white box uCPE device, and optimized
+ for common use-cases. It includes the Enea Edge Runtime deployed
+ on a white box, the Enea Edge Management application and the Enea Edge
+ Automation, management and automation tools deployed in a
+ private or public cloud.The Enea Edge Release includes a new version of
- the major components as well as other features and optimizations, and
- documentation updates. A list of new features and improvements can be found
- in Section 2.1 New Features and
- Improvements.
-
+ xpointer="element(EneaLinux_REL_VER/1)" /> Release includes new features,
+ optimizations, corrections, and updates to the user documentation..
+ A list of major new features and improvements can be found in
+ Section 2.1 New Features and Improvements.
+
Enea Edge Release ContentThe release content is detailed below:
+ Main Components
+
Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz
@@ -42,17 +44,21 @@
- Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz
+ Enea_Edge_AF-TH_<version>-build<build_number>.zip
+ (deprecated, see Section 2.1 New
+ Features and Improvements.)
+
+ Example Deployments:
+
+
- VNF_example_configurations.tar.gz
+ Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz
- Enea_Edge_AF-TH_<version>-build<build_number>.zip
- (deprecated, see Section 2.1 New
- Features and Improvements.)
+ VNF_example_configurations.tar.gz
@@ -135,17 +141,17 @@
.
- Describes the Enea Edge Automation and provides instructions regarding
- the necessary steps to configure and run the tool.
+ Describes the Enea Edge Automation and provides instructions regarding
+ the necessary steps to configure and run the tool.
.
- Describes the Automation Framework and Test Harness for Enea Edge
- (deprecated, see Section 2.1
- New Features and Improvements).
+ Describes the Automation Framework and Test Harness for Enea Edge
+ (deprecated, see Section 2.1 New
+ Features and Improvements).
@@ -167,15 +173,15 @@
- Google Chrome (tested with version 86).
+ Google Chrome (tested with version 89).
- Mozilla Firefox (tested with version 82).
+ Mozilla Firefox (tested with version 87).
- Microsoft Edge (tested with version 84).
+ Microsoft Edge (tested with version 89).
diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml
index b886ee1..0b77f41 100644
--- a/doc/book-enea-edge-release-info/doc/book.xml
+++ b/doc/book-enea-edge-release-info/doc/book.xml
@@ -1,4 +1,4 @@
-
+
@@ -7,9 +7,10 @@
Enea Edge Release
Information
- Release Version
-
+ Release Version
@@ -27,4 +28,4 @@
-
+
\ No newline at end of file
diff --git a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml
index 4f3eb7a..0fdb9aa 100644
--- a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml
+++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml
@@ -20,14 +20,20 @@
ELCCR-527Cancelling a file upload in the Enea
- Edge Management will require the user to close and reopen the upload window
- for the next upload to work.
+ Edge Management will require the user to close and reopen the upload
+ window for the next upload to work.
- ELCCR-577If Enea Edge Management is restored from a backup
- made on a release version older than Enea NFV Access 2.2.3, VNFs cannot be instantiated
- from the GUI.
+ ELCCR-577If the Enea Edge Management application
+ is restored from a backup made on a release version older than Enea NFV
+ Access 2.2.3, VNFs cannot be instantiated from the GUI.
+
+
+
+ ELCCR-1134In order to avoid an incorrect boot
+ order after a failed upgrade, the user should remove the upgrade
+ image before attempting again.
@@ -45,7 +51,8 @@
ELCCR-847The Juniper vSRX VNF cannot be
instantiated on the Xeon-D architectures due to missing CPU features in
- the VNF's domain XML. This impacts all example use cases where the Juniper VNF is used.
+ the VNF's domain XML. This impacts all example use cases where the
+ Juniper VNF is used.
@@ -60,64 +67,53 @@
to be connected to a network with at least a router/gateway installed
for next-hop communication.
+
+
+ ELCCR-1504To change the type of an interface
+ from DPDK to SR-IOV, first delete the existing interface, then
+ recreate it with the desired type.
+ LXCR-9992Depending on hardware capabilities,
there are certain limitations regarding the vfio-pci
- and igb_uio drivers. While the Enea Edge
- Runtime uses the vfio-pci driver by default,
- for certain hardware configurations, igb_uio should
- be used instead, by providing custom scripting. Please contact Enea for
- further details.
+ and igb_uio drivers. While the Enea Edge Runtime uses
+ the vfio-pci driver by default, for certain hardware
+ configurations, igb_uio should be used instead, by
+ providing custom scripting. Please contact Enea for further
+ details.
- STCR-6224The Enea Edge Automation
- and the Enea Edge Automation Framework and Test Harness do not
- support multiple custom scripts uploaded to a uCPE device at the same
- time.
+ STCR-6224The Enea Edge Automation and the Enea
+ Edge Automation Framework and Test Harness do not support multiple
+ custom scripts uploaded to a uCPE device at the same time.STCR-6292Management of WAN Interfaces is not
- implemented in the Enea Edge Automation Framework and Test Harness.
-
-
-
- USERDOCAP-628Enea Edge Automation Framework
- and Test Harness does not have support for product features implemented
- in Enea Edge 2.4.0 or newer.
+ implemented in the Enea Edge Automation Framework and Test
+ Harness.
- ELCCR-912When the Enea Edge Management is installed
- on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an
- upgrade image fails. As a workaround, please update
- glib2 to version 2.54.2 or later, using #yum
- update glib2.
+ USERDOCAP-628Enea Edge Automation Framework and
+ Test Harness does not have support for product features implemented in
+ Enea Edge 2.4.0 or newer.
- ELCCR-854Changing the management interface IP
- address will result in a temporary loss of connection with the uCPE
- device. If the device is behind a NAT, while using the Call Home
- connection, reestablishing the connection automatically could take up to
- 20 minutes. Restarting the vCPE Overlay will immediately reestablish the
- connection, but that implies the existence of an alternate way to
- trigger the vCPE restart operation on the device.
+ ELCCR-912When the Enea Edge Management
+ application is installed on CentOS 7, prior to C7.1804 (kernel version
+ 3.10.0-862), adding an upgrade image fails. As a workaround, please
+ update glib2 to version 2.54.2 or later, using
+ #yum update glib2.
- USERDOCAP-641Enea Edge does not have
- support for IPv6 addresses on both uCPE devices and the Enea Edge
- Management installation.
-
-
-
- ELCCR-1428Wireless AP creation through the REST
- API does not validate that the wireless interface and LAN bridge are
- configured. Using these parameters may result in undefined
- behavior.
+ USERDOCAP-641Enea Edge does not have support for
+ IPv6 addresses on both uCPE devices and the Enea Edge Management
+ installation.
@@ -127,6 +123,11 @@
behavior.
+
+ ELCCR-1518The Wireless AP's wpa2psk password
+ should not contain white space characters.
+
+
ELCCR-1351The updated
.Keystore and server.xml files
@@ -142,10 +143,10 @@
ELCCR-1371The current self-signed certificate for
- the Enea Edge Management is generated at build time, with a hard-coded
- common-name causing the uCPE device upgrade to fail in HTTPS mode. As a
- workaround, another certificate (containing an IP based common-name)
- must be generated.
+ the Enea Edge Management application is generated at build time, with a
+ hard-coded common-name causing the uCPE device upgrade to fail in HTTPS
+ mode. As a workaround, another certificate (containing an IP based
+ common-name) must be generated.Perform the following the steps to generate the
certificate:
@@ -165,8 +166,8 @@
- Start the Enea Edge Management, the new certificate should now
- take effect.
+ Start the Enea Edge Management application, the new
+ certificate should now take effect.
@@ -177,14 +178,24 @@
to delete the old interfaces and recreate them with the desired
type.
-
+
+
+ ELCCR-1497If the Enea Edge Management application
+ has an incorrect database configuration, when performing an uninstallation,
+ the Tomcat instance and Watchdog service will not be stopped automatically.
+ Instead, they must be killed explicitly.
+
+
- ELCCR-907At times the VIP address is not acquired
- by any of the backup nodes if a power failure happens on primary node in
- a High Availability setup. To recover, follow the official documentation
- available at Galera Cluster
- Recovery.
+ ELCCR-1468When using the Enea Edge Management
+ application in HTTPS mode, upgrading a device from NFV Access 2.3.0 is
+ not possible. Either switch to HTTP mode (for more details see The uCPE device Upgrade Process in the
+ Manual)
+ or install it manually.
@@ -196,18 +207,6 @@
in an external PDF reader. As a workaround, open the HTML version of the
document.
-
-
- ELCCR-1468When using the Enea Edge Management in
- HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible.
- Either switch to HTTP mode (for more details see The uCPE device Upgrade Process in the
-
- Manual) or install it manually.
-
diff --git a/doc/book-enea-edge-release-info/doc/main_changes.xml b/doc/book-enea-edge-release-info/doc/main_changes.xml
index 63c2216..aafb31c 100644
--- a/doc/book-enea-edge-release-info/doc/main_changes.xml
+++ b/doc/book-enea-edge-release-info/doc/main_changes.xml
@@ -16,35 +16,59 @@
CPDX-3496Embedded WiFi support for all-in-one
- store/home office deployment.
+ store/home office deployment. For more details please see the Wap Interface Type in the
+ Manual.
CPDX-3499Expanded hardware, OS and network
- monitoring capability with Grafana integration.
+ monitoring capability with Grafana integration. For more details
+ please see Using Grafana and InfluxDB in the
+ Manual.
CPDX-3407HTTPS based downloads of VNFs for
- simplified deployment of the Enea Edge Management in cloud
- environments.
+ simplified deployment of the Enea Edge Management application in cloud
+ environments. For more details please see Fresh Installation of the Enea uCPE
+ Manager in the
+ Manual.
- CPDX-3500The Enea Edge Automation, a tool for
+ CPDX-3500Enea Edge Automation, a tool for
automatic system configuration based on Python scripting that will
replace the existing Enea Edge Automation Framework and Test Harness
- in the next major release.
-
- The Enea Edge Automation Framework and Test Harness, and its
- related documentation the and the
- are
- deprecated starting with Enea Edge 2.4.0.
+ xmlns:ns="http://www.w3.org/2001/XInclude"
+ xpointer="element(book_enea_edge_automation_user_guide/1)" />.
+
+
+ The Enea Edge Automation Framework and Test Harness, and its
+ related documentation the and
+ the
+ are deprecated starting with Enea Edge 2.4.0.
+
@@ -87,22 +111,22 @@
- Platform and VNF Snapshots (made originally available starting
- with Enea NFV Access 2.3.0).
-
+ Platform and VNF Snapshots (made originally available starting
+ with Enea NFV Access 2.3.0).
+
Platform Snapshots allow users to store, manage and restore
- snapshots of the Enea Edge Runtime configuration, with the purpose
- of recovering after a failed reconfiguration. This feature is
- disabled by default.
+ snapshots of the Enea Edge Runtime configuration, with the purpose of
+ recovering after a failed reconfiguration. This feature is disabled by
+ default.
- VNF Snapshots allow users to store, manage and restore
- snapshots of VNFs deployed on the Enea Edge Runtime, with the
- purpose of restoring the VNF after a persistent VNF failure. This
- feature is disabled by default.
+ VNF Snapshots allow users to store, manage and restore snapshots
+ of VNFs deployed on the Enea Edge Runtime, with the purpose of
+ restoring the VNF after a persistent VNF failure. This feature is
+ disabled by default.
- Users that would like to try out the Snapshot features should
- contact Enea Support for additional documentation and
+ Users that would like to try out the Early Access features
+ should contact Enea Support for additional documentation and
assistance.
diff --git a/doc/docsrc_common/pardoc-distro.xml b/doc/docsrc_common/pardoc-distro.xml
index fce0543..b6bc8bb 100644
--- a/doc/docsrc_common/pardoc-distro.xml
+++ b/doc/docsrc_common/pardoc-distro.xml
@@ -1,31 +1,57 @@
-
-
+
-
- Enea NFV Access DocBook XML Based UserDoc Names and Parameters
+ Enea NFV Access DocBook XML Based UserDoc Names and
+ Parameters
- NOTE: DO NOT EDIT THIS FILE IN xmlmind but you can open it to see any errors, don't save!!!!
+ NOTE: DO NOT EDIT THIS FILE IN xmlmind but you can open it to see any
+ errors, don't save!!!NOTE: Use xi:include to include parameters into a docbook XML file.
- Note: Only full elements can be included and the included element must
- be allowed in that place. Example: For ulink, entire ulink elements
- must be included, not just parts of them.
+ Note: Only full elements can be included and the included element must be
+ allowed in that place. Example: For ulink, entire ulink elements must be
+ included, not just parts of them.
**** The phrase elements below can be used as variables in several
- places in XML files and/or in make script files ****
+ places in XML files and/or in make script files ****
+
+
-
-
-doc/book-enea-nfv-access-open-source/doc/licenses.xml
-doc/book-enea-nfv-access-open-source/doc/licenses.xml
-doc/book-enea-nfv-access-openstack-open-source/doc/licenses.xml
-book-enea-nfv-access-openstack-open-source/doc/licenses.xml
-doc/book-enea-nfv-access-dev-open-source/doc/licenses.xml
-doc/book-enea-nfv-access-dev-open-source/doc/licenses.xml
-
+
+ doc/book_enea_edge_runtime_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_runtime_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_management_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_management_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_telemetry_open_source/licenses.xml
+
+ doc/book_enea_edge_telemetry_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_automation_open_source/licenses.xml
+
+ doc/book_enea_edge_automation_open_source/doc/licenses.xml
+
+ doc/book_enea_edge_auto_fw_th_open_source/licenses.xml
+
+ doc/book_enea_edge_auto_fw_th_open_source/doc/licenses.xml
+
\ No newline at end of file
--
cgit v1.2.3-54-g00ecf