From ea4ed5cbcb7fe255461cc37119ec7b13b93f6dfb Mon Sep 17 00:00:00 2001 From: Catalin Iova Date: Wed, 5 May 2021 15:31:47 +0200 Subject: book-enea-edge-getting-started: Change name Enea Edge Change-Id: I6c29a34c20343be41468bf349ae28b948e565362 Signed-off-by: Catalin Iova --- .../doc/advanced_configurations.xml | 10 +++++----- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 c596735..83641b1 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -127,7 +127,7 @@ Installation Configuration File Example: - image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz + image_url = http://192.168.1.100/enea-edge-runtime-xeon-d.hddimg.gz install_drive = /dev/sda @@ -144,9 +144,9 @@ install_drive = /dev/sda /var/lib/tftpboot/pxelinux.cfg/default). The PXE entry should have the following settings: - default nfv_access -label nfv_access -menu label ^NFV_ACCESS_INSTALLER + default enea_edge_runtime +label enea_edge_runtime +menu label ^ENEA_EDGE_INSTALLER kernel <Path to kernel> append root=/dev/ram0 initrd=<Path to initramfs> LABEL=pxe-installer \ INSTALL_CFG=http://<Server IP>/<Path to install config file> \ @@ -300,7 +300,7 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address& Customizing Automatic Hugepage Reservation Configuration of Hugepage reservation is done in - /etc/enea-nfv-access/hugepages.cfg. + /etc/enea/hugepages.cfg. Parameters used by the automatic algorithm: 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 477b5c4..1eab201 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -754,10 +754,10 @@ sdb 8:0 0 111.8G 0 disk Copy the .hddimg image onto the USB stick, e.g: - sudo dd if=./enea-nfv-access-<machine>.hddimg \ + sudo dd if=./enea-edge-runtime-<machine>.hddimg \ of=/dev/sdb bs=4M conv=fsync - Where enea-nfv-access-<machine>.hddimg is + Where enea-edge-runtime-<machine>.hddimg is the .hddimg file and sdb is the assigned USB device name. -- cgit v1.2.3-54-g00ecf From 910df73e61f9f5fdb2d24766ce4632b0dfc03be4 Mon Sep 17 00:00:00 2001 From: lumc Date: Thu, 6 May 2021 13:29:11 +0300 Subject: ELCCR-1605: update factory reset documentation Change-Id: I138c24f8e27cf69a8d2d895766522865f6d40fc7 --- .../doc/advanced_configurations.xml | 3 ++- .../doc/installation_guide.xml | 17 ++++++----------- .../doc/net_config_options.xml | 4 ++-- 3 files changed, 10 insertions(+), 14 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 c596735..3366a43 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -435,7 +435,8 @@ node0.1048576kB = 3 - Run the following command: + Run the following command and change /opt/ems + to the location where the Enea Edge Management application is installed: ./createCertificate.sh ucpemanager <IP_or_domain> \ /opt/ems [<service_username>] 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 477b5c4..5f17ad1 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -614,14 +614,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Heap Configuration: - - - - Please enter the new Maximum Heap Size - [4g]: - - + Heap Configuration: Please enter the new + Maximum Heap Size [4g]: @@ -1207,9 +1201,10 @@ of=/dev/sdb bs=4M conv=fsync 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. + settings are lost. All running VNFs are destroyed. All uploaded VM + image files are deleted. Any installed custom scripts will be + removed and they will need to be reinstalled. Existing log files + will be kept. Only the vCPE service will be restarted, the device will not be rebooted. No reboot is needed. 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 ff513c9..5f265fb 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 @@ -678,8 +678,8 @@ - Once-after-startup. The script will always - execute after the system has rebooted, after all device + Once-after-startup. The script will only + execute once after the system has rebooted, after all device configuration processes have completed. -- cgit v1.2.3-54-g00ecf From d30d4955ff9e5b61329d7bf75d274d192d0d9adc Mon Sep 17 00:00:00 2001 From: Toma Bilius Date: Thu, 6 May 2021 16:28:21 +0300 Subject: ELCCR-1607 Review existing user documentation and add it to getting started. Change-Id: Ief47399f7a7b1094827aa8606b85c3714fa1d846 Signed-off-by: Toma Bilius --- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 125 ++++++++++++++++++++++ 1 file changed, 125 insertions(+) (limited to 'doc/book-enea-edge-getting-started') 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 058be40..d1b6f08 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -526,4 +526,129 @@ + +
+ VNF Snapshots + + The following sections describe the mechanism of saving + (snapshotting) and restoring a VNF context on the uCPE device using the + Enea Edge Management application. + + It is assumed the uCPE device referenced already contains at least + one instantiated VNF, added into the Edge Management application and is + connected. + +
+ VNF Live Snapshot + + To perform a snapshot of an existing VNF on a uCPE device, do the + following in the Enea Edge Management application: + + + + Select the uCPE device and access the Configuration menu, then select Virtual Machines and VMs. + + + + Select a virtual machine and click the Snapshots.. button. The VM Snapshot Table on <device-name> (IP) + window will open. + + + + Press the Create button and + the Create VM Snapshot on <device-name> + (IP) window will open. + + + + Change the file name, if needed, and press the Create button. The current popup window will + close after a few seconds and a new entry will be shown in the + VM Snapshot Table on <device-name + (IP)>. + + On the uCPE device, the snapshot file will be created under + /var/odm/vm_images/snapshots/{vm-id}/ (e.g: + /var/odm/vm_images/snapshots/e1b165f0-2590-11eb-be3a-525400070d85/). + + +
+ +
+ Restoring a VNF Snapshot + + When needed, a VNF snapshot can be restored by doing the + following: + + + + Select the uCPE device and access the Configuration menu, then select Virtual Machines and choose VMs. + + + + Select a virtual machine and press the Snapshots.. button. The VM Snapshot Table on <device-name> (IP) + window will open. + + + + Select the snapshot entry from table. + + + + Press the Restore button. A + success message will appear in the same window: Restored VM + from snapshot. + + +
+ +
+ Deleting a VNF Snapshot + + Deleting an older snapshot can be performed by doing the + following: + + + + Select the uCPE device and access the Configuration menu, then select Virtual Machines and choose VMs. + + + + Select a virtual machine and press the Snapshots.. button. The VM Snapshot Table on <device-name> (IP) + window will open. + + + + Select the snapshot entry from the table. + + + + Press the Delete + button. + + + + A success message will be shown in the same window: + Snapshot deleted. The snapshot file will be deleted + from the uCPE device and the table will be updated. + + Deleting a VNF instance automatically deletes all snapshots + associated with it. +
+
\ No newline at end of file -- cgit v1.2.3-54-g00ecf From 0bc82389b36fbdb6f9a4df4d44ea1379e440ca99 Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 28 May 2021 20:37:23 +0200 Subject: Updated the version variable for Enea Edge, Added in the versioning files ie all eltf updates files, 3 in total, Updated the EE Automation User Guide to reflect the new name, along with various edits and tweaks, Removed obsolete files from the Enea Edge Rel notes repo, Tweaked the AF User Guide 4.3.2 chapter. Change-Id: Ie08fab45236602e6875ba5f7d2724c0cd7306860 Signed-off-by: mrpa --- doc/Makefile | 6 +- .../doc/about.xml | 4 +- .../doc/book.xml | 2 +- .../doc/licenses.xml | 8 +- .../doc/book.xml | 4 +- .../doc/about.xml | 4 +- .../doc/book.xml | 2 +- .../doc/licenses.xml | 8 +- .../doc/automation_framework_test_harness.xml | 1300 ++++++++++---------- .../doc/book.xml | 4 +- .../doc/getting_started.xml | 404 +++--- doc/book-enea-edge-example-usecases/doc/book.xml | 4 +- doc/book-enea-edge-getting-started/doc/book.xml | 4 +- .../doc/net_config_options.xml | 4 +- .../doc/about.xml | 4 +- .../doc/book.xml | 2 +- .../doc/about_release.xml | 6 +- doc/book-enea-edge-release-info/doc/book.xml | 4 +- .../doc/getting_enea_nfv_access.xml | 54 - .../doc/system_requirements_prerequisites.xml | 62 - .../doc/about.xml | 4 +- .../doc/book.xml | 2 +- .../doc/book.xml | 2 +- .../doc/about.xml | 4 +- .../doc/book.xml | 2 +- doc/book-enea-nfv-access-evalkit/doc/book.xml | 2 +- .../doc/prerequisites.xml | 6 +- doc/eltf_params_template.xml | 151 +++ doc/eltf_params_updated.xml | 240 ++++ doc/eltf_params_updated_template_how_to_use.txt | 320 +++++ 30 files changed, 1633 insertions(+), 990 deletions(-) delete mode 100644 doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml delete mode 100644 doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml create mode 100644 doc/eltf_params_template.xml create mode 100644 doc/eltf_params_updated.xml create mode 100644 doc/eltf_params_updated_template_how_to_use.txt (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/Makefile b/doc/Makefile index 1f5b506..5c1a6b9 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -32,8 +32,8 @@ include init.mk 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 +ELTF_PARAMS_TEMPLATE := eltf_params_template.xml +ELTF_PARAMS_UPDATED := eltf_params_updated.xml @@ -184,7 +184,7 @@ endif books: init # BOOKPACKAGES is defined in all book-*/swcomp.mk - $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ + $(VERB)DISTRO_VERSION=`egrep '"EneaEdge_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ BOOKVER="Enea Edge-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ for book in $(BOOKPACKAGES); do \ for format in $(FORMAT); do \ diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml index 24f674d..53cda06 100644 --- a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml +++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml @@ -7,8 +7,8 @@ This document contains the open source and license information pertaining to the Enea Edge Automation Framework and Test Harness provided with Enea Edge . + xpointer="element(EneaEdge_REL_VER/1)" />. diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/book.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/book.xml index df5e029..960e0cc 100644 --- a/doc/book-enea-edge-auto-fw-th-open-source/doc/book.xml +++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/book.xml @@ -7,7 +7,7 @@ <trademark class="registered">Enea</trademark> Edge Automation Framework and Test Harness Open Source Report Release Version - diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml index 397e2b8..07902ad 100644 --- a/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml +++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml @@ -36,9 +36,9 @@ Enea Edge Automation Framework and Test Harness + xpointer="element(EneaEdge_REL_VER/1)" /> Configuration and Automation Framework for the Enea Edge Management GUI. @@ -50,9 +50,9 @@ Enea Edge Automation Framework and Test Harness + xpointer="element(EneaEdge_REL_VER/1)" /> Configuration and Automation Framework for the Enea Edge Management GUI. 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 d533a74..3a0c698 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 @@ -8,9 +8,9 @@ Framework and Test Harness User Guide Release Version + xpointer="element(EneaEdge_REL_VER/1)" /> diff --git a/doc/book-enea-edge-automation-open-source/doc/about.xml b/doc/book-enea-edge-automation-open-source/doc/about.xml index 50ce933..64a6616 100644 --- a/doc/book-enea-edge-automation-open-source/doc/about.xml +++ b/doc/book-enea-edge-automation-open-source/doc/about.xml @@ -7,8 +7,8 @@ This document contains the open source and license information pertaining to the Enea Edge Automation provided with Enea Edge . + xpointer="element(EneaEdge_REL_VER/1)" />. diff --git a/doc/book-enea-edge-automation-open-source/doc/book.xml b/doc/book-enea-edge-automation-open-source/doc/book.xml index 317c87d..79da1aa 100644 --- a/doc/book-enea-edge-automation-open-source/doc/book.xml +++ b/doc/book-enea-edge-automation-open-source/doc/book.xml @@ -7,7 +7,7 @@ <trademark class="registered">Enea</trademark> Edge Automation Open Source Report Release Version - diff --git a/doc/book-enea-edge-automation-open-source/doc/licenses.xml b/doc/book-enea-edge-automation-open-source/doc/licenses.xml index e2ade8a..01d0c08 100644 --- a/doc/book-enea-edge-automation-open-source/doc/licenses.xml +++ b/doc/book-enea-edge-automation-open-source/doc/licenses.xml @@ -36,9 +36,9 @@ Enea Edge Automation + xpointer="element(EneaEdge_REL_VER/1)" /> Configuration and Automation for the Enea Edge Management GUI. @@ -50,9 +50,9 @@ Enea Edge Automation + xpointer="element(EneaEdge_REL_VER/1)" /> Configuration and Automation for the Enea Edge Management GUI. diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml index bc974cc..c1b554e 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml @@ -1,54 +1,54 @@ - + Enea Edge Automation
File Structure - Enea Edge Automation is an open-source product, - with the following directory structure: - - - - ansible.cfg - + Enea Edge Automation is an open-source product, with the following + directory structure: - - automation_framework - + + + ansible.cfg + - - CHANGELOG - + + automation_framework + - - environment_variables.sh - + + CHANGELOG + - - modules - + + environment_variables.sh + - - setup_env_requirements.txt - + + modules + - - setup_env.sh - + + setup_env_requirements.txt + - - test_harness - + + setup_env.sh + - - unit_tests - + + test_harness + - - VERSION - - + + unit_tests + + + + VERSION + + Each file/directory is described in more details in the following sections. @@ -58,70 +58,72 @@ The setup_env.sh, setup_env_requirements.txt and - environment_variables.sh files are used to create the - testing virtual environment, using the following + environment_variables.sh files are used to create + the testing virtual environment, using the following prerequisites: - - - - The environment variable - - - Python packages - + + + The environment variable + - - Ansible package(s) - - + + Python packages + - Where the environment_variables.sh script sets the - environment variables. The setup_env_requirements.txt contains the - mapping between the package name and its version, and the setup_env.sh - script creates a testing virtual environment. + + Ansible package(s) + + - The setup_env.sh does the - following: - - - - Checks if the Python 3 and - pip packages are installed on the host. If at - least one package is not installed on the host, then an error is - displayed and the script stops. - + Where the environment_variables.sh script + sets the environment variables. The + setup_env_requirements.txt contains the mapping + between the package name and its version, and the + setup_env.sh script creates a testing virtual + environment. - - Creates and activates the testHarness-venv - virtual environment. - + The setup_env.sh does the following: - - Upgrades the pip package to the newest - version. - + + + Checks if the Python 3 and + pip packages are installed on the host. If at + least one package is not installed on the host, then an error is + displayed and the script stops. + - - Installs the packages defined in - setup_env_requirements.txt on the virtual - environment. - + + Creates and activates the testHarness-venv + virtual environment. + - - Sets the environment variables defined in - environment_variables.sh on the virtual - environment. - - + + Upgrades the pip package to the newest + version. + + + + Installs the packages defined in + setup_env_requirements.txt on the virtual + environment. + + + + Sets the environment variables defined in + environment_variables.sh on the virtual + environment. + +
-
+
VERSION and CHANGELOG - The VERSION and CHANGELOG files - contain information about the version, build number, and all the notable - changes added in the Enea Edge Automation. + The VERSION and + CHANGELOG files contain information about the + version, build number, and all the notable changes added in the Enea + Edge Automation.
@@ -129,26 +131,26 @@ The modules/enea directory contains the following: - - - - config - contains the configuration files - that need to be updated in order to successfully run the - Enea Edge Automation. For more details, see . - - - scenario - contains the test scenarios. - The test scenarios include custom script examples, service - chaining VNF examples and so on. - + + + config - contains the configuration files + that need to be updated in order to successfully run the Enea Edge + Automation. For more details, see . + - - VNF_images - contains the VNF images that - are used in test scenarios. - - + + scenario - contains the test scenarios. The + test scenarios include custom script examples, service chaining VNF + examples and so on. + + + + VNF_images - contains the VNF images that + are used in test scenarios. + +
@@ -156,55 +158,67 @@ The automation_framework directory includes all the Python scripts used by the Automation Framework. Each Python script - implements a class that defines a functionality of the Enea Edge Management application. + implements a class that defines a functionality of the Enea Edge + Management application. The Python scripts can be split into the following: - - - - The uCPEMgrHTTPClientRestAPIv2.py script, - where the uCPEMgrHTTPClient class is defined. This - class communicates with the Enea Edge Management application via REST API. - - - Other Python scripts, where the classes for the Enea Edge Management - module are defined. Each class inherits the - uCPEMgrHTTPClientRestAPIv2 class and uses its - methods to communicate with the Enea Edge Management application via the REST API. Each class - corresponds to an Enea Edge Management module. - - Example: the - OfflineConfigHandler.py script, where the - OfflineConfigHandler class is defined. Inside - this class, the methods for offline configuration functionality - are implemented: addOfflineConfig, - removeOfflineConfig, - uploaOfflineConfig and so on. - - + + + The ManagementHTTPClientRestAPIv2.py + script, where the ManagementClient class is + defined. This class communicates with the Enea Edge Management + application via REST API. + + + The uCPEMgrHTTPClientRestAPIv2.py + script is where the uCPEMgrHTTPClient class is + defined. The uCPEMgrHTTPClient class is a + wrapper of the ManagementClient class. This + script is deprecated and will be removed starting with the next + major release. + + + + + Other Python scripts, where the classes for the Enea Edge + Management module are defined. Each class inherits the + ManagementClient class and uses its methods to + communicate with the Enea Edge Management application via the REST + API. Each class corresponds to an Enea Edge Management + module. + + Example: the + OfflineConfigHandler.py script, where the + OfflineConfigHandler class is defined. Inside + this class, the methods for offline configuration functionality are + implemented: addOfflineConfig, + removeOfflineConfig, + uploaOfflineConfig and so on. + +
The unit_test directory The unit_test directory contains: - - - - JSON files for complex scenarios with multiple - operations. - - - The Python unit-test class. - + + + JSON files for complex scenarios with multiple + operations. + - - Loader scripts for generating specific test cases for the - available Python script. - - + + The Python unit-test class. + + + + Loader scripts for generating specific test cases for the + available Python script. + + The generated test cases are injected into the Python unit-test suite class to run using the Python @@ -222,11 +236,12 @@ The test_harness directory contains all the implemented playbooks. This directory is structured in multiple - subdirectories, each subdirectory represents a functionality of the Enea Edge Management application. Each implemented playbook from this directory runs a method - from a Python class from the automation_framework - directory. Each playbook is an atomic operation, a basic operation that - need to be tested. These playbooks are used in complex test - scenarios. + subdirectories, each subdirectory represents a functionality of the Enea + Edge Management application. Each implemented playbook from this + directory runs a method from a Python class from the + automation_framework directory. Each playbook is an + atomic operation, a basic operation that need to be tested. These + playbooks are used in complex test scenarios.
@@ -234,64 +249,67 @@ The log directory is added in the directory structure by the setup_env.sh script. The - setup_env.sh script stores the output logs in the - setup_env.log file. The Ansible playbooks store the logs - in the ansible.log file. The Python scripts store the logs in - the debug.log file. + setup_env.sh script stores the output logs in the + setup_env.log file. The Ansible playbooks store the + logs in the ansible.log file. The Python scripts + store the logs in the debug.log file.
Configuring the System - The configuration files must be updated before using Enea Edge Automation. - They are stored in the modules/enea/config + The configuration files must be updated before using Enea Edge + Automation. They are stored in the modules/enea/config directory. The configuration files are split according to the component that is used in the testing process: - - + + + + The Enea Edge Management application + + + + uCPE Devices + + + + VNFs + + + +
+ Configuration Files for the Enea Edge Management + application + + In order to create a connection with the Enea Edge Management + application, the following parameters have to be specified: + + - The Enea Edge Management application + Enea Edge Management username - uCPE Devices + Enea Edge Management password - VNFs + Enea Edge Management IP address or FQDN -
- Configuration Files for the Enea Edge Management application - - In order to create a connection with the Enea Edge Management application, the - following parameters have to be updated: - - - - Enea Edge Management username - - - - Enea Edge Management password - - - - Enea Edge Management IP address - - - - Updating the configuration file + Updating the configuration + file - Open modules/enea/config/uCPEManager/ucpem01.json - - { + Open + modules/enea/config/Management/management01.json + + { "ucpe_usr":"admin", "ucpe_pass":"admin", "ucpe_host":"172.24.3.92" @@ -300,30 +318,41 @@ Update the username, password and IP address + + + The + modules/enea/config/uCPEManager/ucpem01.json + file is a symbolic link to the + modules/enea/config/Management/management01.json + file. It is deprecated, and it will be removed starting with the + next major release. + It is possible to use another JSON file for the connection with the Enea Edge Management application. - Changing the path for the Enea Edge Management JSON - file - - - - Open the automation_framework/uCPEMgrHTTPClientRestAPIv2.py file. - + Changing the path for the Enea Edge + Management JSON file - - Go to the create_json_file method from the - eneaUcpeMgrConfig class. - + + + Open the + automation_framework/ManagementHTTPClientRestAPIv2.py + file. + - - Change the path of the Enea Edge Management JSON file in the - self.ucpe_json_file variable. - - + + Go to the create_json_file method from the + ManagementConfig class. + + + + Change the path of the Enea Edge Management JSON file in the + self.ucpe_json_file variable. + +
@@ -331,42 +360,42 @@ The modules/enea/config/uCPEDevices directory contains the following: - - - - Examples of the configuration files for different uCPE - Devices: - inteld1521-16,inteld1521-17, - and so on. - - - The scripts for generating all configuration files in - scripts folder. - - + + + Examples of the configuration files for different uCPE + Devices: + inteld1521-16,inteld1521-17, + and so on. + + + + The scripts for generating all configuration files in + scripts folder. + + The following scripts are implemented to generate the configuration files: - - - - generate_device_config.py - generates the - JSON configuration file for the uCPE Device. - - - generate_bridges_config_files.py - - generates configuration files for all possible OVS bridges created - on the uCPE Device. - + + + generate_device_config.py - generates the + JSON configuration file for the uCPE Device. + - - generate_nics_config_files.py - generates - the configuration files for all possible NICs created on the uCPE - Device. - - + + generate_bridges_config_files.py - + generates configuration files for all possible OVS bridges created + on the uCPE Device. + + + + generate_nics_config_files.py - generates + the configuration files for all possible NICs created on the uCPE + Device. + +
Generating Device config @@ -387,13 +416,14 @@ - Generating the device config + Generating the device + config Run generate_device_config.py: - - testHarness-venv)> python generate_device_config.py + + testHarness-venv)> python generate_device_config.py Device name: test Device ID: test_id Device groupings tags [ ]: test_id @@ -413,13 +443,15 @@ store.json - Check the configuration files in the modules/enea/config/uCPEDevices/test + Check the configuration files in the + modules/enea/config/uCPEDevices/test directory: test.json file - contains all the - input parameters for the test device: + input parameters for the test + device: { "deviceId": "test_id", @@ -445,9 +477,9 @@ store.json - store.json file - contains the input - parameters used for creating an offline config for the uCPE - Device: + store.json file - contains the + input parameters used for creating an offline config for the + uCPE Device: { "version": "2.4.0", @@ -462,8 +494,8 @@ store.json The generate_device_config.py script can be executed in a non-interactive way, as follows: - -testHarness-venv)>python generate_device_config.py --device_name=test + + testHarness-venv)>python generate_device_config.py --device_name=test --device_id=test_id --device_grouping_tags=test_id --version 2.4.0 --device_ip_addr=10.0.0.1 --call_home=false --mgmt_nic=eth0 --wan_nic=eth1 --lan_nic=eth2 --wap_nic=wlan0 @@ -474,8 +506,8 @@ store.json scenario. When the script is interactively run, the parameter's value - between the square brackets is the default one. It can be omitted when the - script is non-interactively run. + between the square brackets is the default one. It can be omitted when + the script is non-interactively run.
@@ -486,18 +518,20 @@ store.json - Run generate_nics_config_files.py: - - (testHarness-venv)> python generate_nics_config_files.py + Run + generate_nics_config_files.py: + + (testHarness-venv)> python generate_nics_config_files.py Device name: test Check 'test' directory for JSON configuration files - Check the configuration files for all interface types in the + Check the configuration files for all interface types in the modules/enea/config/uCPEDevices/test directory. - The interface name is defined in the test.json - file. The NIC config files have the following structure: + The interface name is defined in the + test.json file. The NIC config files have the + following structure: <interface_name>_<interface_type>_nic.json. For the eth2 lan interface, the following JSON files are created: @@ -528,8 +562,8 @@ Check 'test' directory for JSON configuration files - lan_wan_nic.json - contains Interface - type: WAN; Address assignment: + lan_wan_nic.json - contains + Interface type: WAN; Address assignment: DHCP. { @@ -542,8 +576,8 @@ Check 'test' directory for JSON configuration files - wap_wap_nic.json - contains Interface - type: WAP; Country Code: + wap_wap_nic.json - contains + Interface type: WAP; Country Code: SE; Wireless band: band5GHz; Wireless Mode: 802.11 g/n; Radio Channel: 42 (80 MHz @@ -561,10 +595,10 @@ Check 'test' directory for JSON configuration files - The generate_nics_config_files.py script can - be executed in a non-interactive way, as follows: - - (testHarness-venv)> python generate_nics_config_files.py --device_name=test + The generate_nics_config_files.py script + can be executed in a non-interactive way, as follows: + + (testHarness-venv)> python generate_nics_config_files.py --device_name=test Check 'test' directory for JSON configuration files The values from the JSON files depend on the input @@ -579,74 +613,76 @@ Check 'test' directory for JSON configuration files - Run generate_bridges_config_files.py: - - (testHarness-venv)> python generate_bridges_config_files.py + Run + generate_bridges_config_files.py: + + (testHarness-venv)> python generate_bridges_config_files.py Device name: test Check 'test' directory for JSON configuration files - Check the configuration files in the + Check the configuration files in the modules/enea/config/uCPEDevices/test directory. The name of OVS bridges type has the following structure: <bridge_type>_br.json. The following JSON files are created: - - - - ibm_br.json - contains information about the - Inband management OVS bridge: - { + + + ibm_br.json - contains information + about the Inband management OVS + bridge: + + { "name": "ibm_br", "type": "inband_mgmt" } - + - - sfc_br.json - contains: - Dataplane OVS bridge; Type: - integration: + + sfc_br.json - contains: + Dataplane OVS bridge; Type: + integration: - { + { "name": "sfc_br", "type": "dataplane", "subType": "integration", "interfaces": [] } - + - - vnfmgmt_ipv4_br.json - contains - VNF Management OVS bridge, IPv4: + + vnfmgmt_ipv4_br.json - contains + VNF Management OVS bridge, IPv4: - { + { "name": "vnfmgmt_ipv4_br", "type": "vnfMgmt", "vnfMgmtAddress": "10.0.0.1" } - + - - vnfmgmt_ipv6_br.json - contains - VNF Management OVS bridge, IPv6: + + vnfmgmt_ipv6_br.json - contains + VNF Management OVS bridge, IPv6: - + { "name": "vnfmgmt_ipv6_br", "type": "vnfMgmt", "vnfMgmtAddress": "2001:db8:0:0:0:0:0:0" } - + - - lan_br.json - contains - Dataplane OVS bridge; Type: - communication; Interface: - eth2: + + lan_br.json - contains + Dataplane OVS bridge; Type: + communication; Interface: + eth2: - lan_br.json + lan_br.json { "name": "lan_br", "type": "dataplane", @@ -655,28 +691,28 @@ Check 'test' directory for JSON configuration files "eth2" ] } - + - - wap_br.json - contains - Dataplane OVS bridge; Type: - communication: + + wap_br.json - contains + Dataplane OVS bridge; Type: + communication: - { + { "name": "wap_br", "type": "dataplane", "subType": "communication", "interfaces": [] } - - + + The generate_bridges_config_files.py script can be executed in a non-interactive way, as follows: - - (testHarness-venv)> python generate_bridges_config_files.py --device-name=test + + (testHarness-venv)> python generate_bridges_config_files.py --device-name=test Check 'test' directory for JSON configuration files The values from the JSON files depend on the input @@ -687,14 +723,14 @@ Check 'test' directory for JSON configuration files
Configuration Files for the VNF - The VNF directory modules/enea/config/VNF, - contains subdirectories for each defined VNF: + The VNF directory modules/enea/config/VNF, + contains subdirectories for each defined VNF: fortigateFWImage, junipervSRXImae and so on. - Each VNF subdirectory contains configuration files for: cloud-init, - VNF Descriptors, VNF instances. These configuration files are - examples used in test scenarios from Enea Edge Automation. + Each VNF subdirectory contains configuration files for: + cloud-init, VNF Descriptors, VNF instances. These configuration files + are examples used in test scenarios from Enea Edge Automation. For more details about the test scenarios from modules/enea/scenario/, see
The Automation Framework - The Automation Framework scripts described in the following section - are located in the <AF-installdir>/automation_framework directory. + The Automation Framework scripts described in the following section + are located in the + <Automation-installdir>/automation_framework + directory.
- The uCPEMgrHTTPClient class + The ManagementClient class - The uCPEMgrHTTPClient class is implemented in the - uCPEMgrHTTPClientRestAPIv2.py script. + The ManagementClient class is implemented in + the ManagementHTTPClientRestAPIv2.py script. - The scope of this class is to send REST API requests to the Enea Edge Management application. - The methods of the uCPEMgrHTTPClient class - represent REST API calls to the Enea Edge Management application or ways for creating the - objects that are used as input for sending the request. + The scope of this class is to send REST API requests to the Enea + Edge Management application. The methods of the + ManagementClient class represent REST API calls to + the Enea Edge Management application or ways for creating the objects + that are used as input for sending the request. - The dictionaries used as the payload in the REST API requests are created - in methods from this class. The output of these methods is used as input - for the REST API request payload. + The dictionaries used as the payload in the REST API requests are + created in methods from this class. The output of these methods is used + as input for the REST API request payload. Each method has a short description in the header, as follows: - - - - The scope of the method - - - The input parameters - + + + The scope of the method + - - The return value from the source code - + + The input parameters + - - The URL for the REST API call - + + The return value from the source code + - - The payload dictionary for the REST API call - - + + The URL for the REST API call + + + + The payload dictionary for the REST API call + + Other classes from the automation_framework directory inherit this class, and call its methods. + + + The uCPEMgrHTTPClient class is a wrapper of + the ManagementClient class. All the methods defined + in the ManagementClient class can be used when the + uCPEMgrHTTPClient object is instantiated. The + uCPEMgrHTTPClient object is deprecated and will be + removed starting with the next major release. It is recommended to use + the ManagementClient class instead. + Examples: - uCPE Device functionalities are defined in the uCPEDeviceHandler class. + uCPE Device functionalities are defined in the + uCPEDeviceHandler class. - The uCPEDeviceHandler class inherites the uCPEMgrHTTPClient class. + The uCPEDeviceHandler class inherites the + ManagementClient class. - The uCPEDeviceHandler method calls methods from - uCPEMgrHTTPClient to send requests to the Enea Edge Management application. + The uCPEDeviceHandler method calls methods + from ManagementClient to send requests to the + Enea Edge Management application. - Methods from uCPEMgrHTTPClient create the - payload dictionary starting from the input parameters and send the REST API - request. + Methods from ManagementClient create the + payload dictionary starting from the input parameters and send the + REST API request. @@ -783,18 +835,19 @@ Check 'test' directory for JSON configuration files
Handlers for Enea Edge Management Functionalities - In Enea Edge Automation the modules of the Enea Edge Management application are - represented by Python classes called Handlers. Each - Python class represents a functionality of the Enea Edge Management application. + In Enea Edge Automation the modules of the Enea Edge Management + application are represented by Python classes called + Handlers. Each Python class represents a + functionality of the Enea Edge Management application. - These classes are implemented in the Python scripts that have a - Handler string included in the name. The name of the + These classes are implemented in the Python scripts that have a + Handler string included in the name. The name of the classes is the same as the name of Python script. - For the usage of any class, run the Python script with the --help option: - - python automation_framework/uCPEDeviceHandler.py --help + For the usage of any class, run the Python script with the + --help option: + + python automation_framework/uCPEDeviceHandler.py --help Usage: uCPEDeviceHandler.py [OPTIONS] [PARAMETERS]... Options: @@ -807,12 +860,12 @@ Options: -o, --display_output Display output of the method --help Show this message and exit. - In the test_harness/<module name> directory, - the Ansible Playbooks are implemented for running the Python scripts - from Enea Edge Automation. The name of the Ansible Playbooks is the same - as the name of the Python method. The Python command is between the - <command> ... </command> tags from the - *.yml files. + In the test_harness/<module name> + directory, the Ansible Playbooks are implemented for running the Python + scripts from Enea Edge Automation. The name of the Ansible Playbooks is + the same as the name of the Python method. The Python command is between + the <command> ... </command> tags from + the *.yml files.
uCPE Device @@ -847,8 +900,8 @@ Options: - Configuration file located in - modules/enea/config/uCPEDevices, with the + Configuration file located in + modules/enea/config/uCPEDevices, with the -f option. @@ -885,19 +938,19 @@ addDpdkExternalInterface -f modules/enea/config/uCPEDevices/<device_name>/<interface_name>_dpdk_nic.json Example: - - python automation_framework/uCPEDeviceHandler.py -d vep1445-8 -m + + python automation_framework/uCPEDeviceHandler.py -d vep1445-8 -m addDpdkExternalInterface -f modules/enea/config/uCPEDevices/vep1445-8/lan_dpdk_nic.json The syntax for running the addDpdkExternalInterface functionality: - + python automation_framework/uCPEDeviceHandler.py -d <device_name> -m addDpdkExternalInterface <interface_name> <dpdk_type> Example: - - python automation_framework/uCPEDeviceHandler.py -d vep1445-8 -m + + python automation_framework/uCPEDeviceHandler.py -d vep1445-8 -m addDpdkExternalInterface eno4 vfio-pci
@@ -907,23 +960,23 @@ addDpdkExternalInterface eno4 vfio-pci The Enea Edge Management functionalities regarding the offline configuration are implemented as follows: - - - automation_framework/OfflineConfigHandler.py - - OfflineConfigHandler class has methods for - adding an offline config, removing an offline config, uploading - an offline config on a uCPE Device, and so on. - + + + automation_framework/OfflineConfigHandler.py + - OfflineConfigHandler class has methods for + adding an offline config, removing an offline config, uploading an + offline config on a uCPE Device, and so on. + - - automation_framework/Configuration.py - - Configuration class has methods for - configuring the uCPE Device: DPDK, external interface, and OVS - bridges. The methods of the Configuration - class are used in the uCPEDeviceHandler and - OfflineConfigHandler classes. - - + + automation_framework/Configuration.py - + Configuration class has methods for configuring + the uCPE Device: DPDK, external interface, and OVS bridges. The + methods of the Configuration class are used in + the uCPEDeviceHandler and + OfflineConfigHandler classes. + + The OfflineConfigHandler class inherites the Configuration class with all its methods. @@ -931,18 +984,19 @@ addDpdkExternalInterface eno4 vfio-pci The functionalities for the adding offline config store, removing offline config store, configuring external interfaces, - configuring OVS bridges can be run using the: + configuring OVS bridges can be run using + the: - - - Configuration file located in modules/enea/config/uCPEDevices. - + + + Configuration file located in + modules/enea/config/uCPEDevices. + - - Input parameters. - - + + Input parameters. + + The other functionalities can be run using only input parameters. @@ -951,7 +1005,7 @@ addDpdkExternalInterface eno4 vfio-pci script with the -v/--verbose option: -python automation_framework/OfflineConfigHandler.py -v + python automation_framework/OfflineConfigHandler.py -v Info about OfflineConfigHandler methods ... Method: addOfflineConfigStore @@ -962,47 +1016,48 @@ Parameters: version, deviceId, deviceGroupingTags, descr='' addOfflineConfigStore using the configuration file: -python automation_framework/OfflineConfigHandler.py -s <store_name> -m + python automation_framework/OfflineConfigHandler.py -s <store_name> -m addOfflineConfigStore -f <path_to_store_configuration_file> Example: -python automation_framework/OfflineConfigHandler.py -s testOfflienConfig -m + python automation_framework/OfflineConfigHandler.py -s testOfflienConfig -m addOfflineConfigStore -f modules/enea/config/uCPEDevices/test/store.json - The syntax for running the addOfflineConfigStore - functionality using input parameters: version, - deviceId, deviceGroupingTags, - desc: + The syntax for running the + addOfflineConfigStore functionality using input + parameters: version, deviceId, + deviceGroupingTags, desc: -python automation_framework/OfflineConfigHandler.py -s <store_name> -m + python automation_framework/OfflineConfigHandler.py -s <store_name> -m addOfflineConfigStore <version> <deviceId> <deviceGroupingTags> Example: -python automation_framework/OfflineConfigHandler.py -s testStoreName -m + python automation_framework/OfflineConfigHandler.py -s testStoreName -m addOfflineConfigStore 2.4.0 deviceId customerTag
Custom scripts - All the Enea Edge Management functionalities regarding the custom - scripts are implemented in the CustomScriptsHandler.py - script. + All the Enea Edge Management functionalities regarding the + custom scripts are implemented in the + CustomScriptsHandler.py script. The CustomScriptsHandler class is implemented in CustomScriptsHandler.py script. - Examples of custom scripts are in the -modules/enea/config/customScripts/ directory. They - can be used when running a Python method from the CustomScriptsHandler class. + Examples of custom scripts are in the + modules/enea/config/customScripts/ directory. They + can be used when running a Python method from the + CustomScriptsHandler class. To list the implemented methods (functionalities), run the script with the -v/--verbose option: -python automation_framework/CustomScriptsHandler.py -v + python automation_framework/CustomScriptsHandler.py -v Info about CustomScriptHandler methods ... Method: uploadCustomScript @@ -1012,7 +1067,7 @@ Parameters: customScript, phase The syntax for running the uploadCustomScript functionality starting from the input parameters: -python automation_framework/CustomScriptsHandler.py -m + python automation_framework/CustomScriptsHandler.py -m uploadCustomScript <customScript> <phase> Example: @@ -1026,9 +1081,9 @@ modules/enea/config/customScripts/test_fail_after_once once-after-startup Device upgrade - The Enea Edge Management functionalities regarding the uCPE Device - upgrade are implemented in the DeviceUpgradeHandler.py - script. + The Enea Edge Management functionalities regarding the uCPE + Device upgrade are implemented in the + DeviceUpgradeHandler.py script. The DeviceUpgradeHandler class is implemented in the DeviceUpgradeHandler.py script. @@ -1037,7 +1092,7 @@ modules/enea/config/customScripts/test_fail_after_once once-after-startup-v/--verbose option: -python automation_framework/DeviceUpgradeHandler.py -v + python automation_framework/DeviceUpgradeHandler.py -v Info about DeviceUpgradeHandler methods ... Method: uploadImage @@ -1047,7 +1102,7 @@ Parameters: imagePath, type, module='VcpeAgent' The syntax for running the uploadImage functionality starting from the input parameters: -python automation_framework/DeviceUpgradeHandler.py -m + python automation_framework/DeviceUpgradeHandler.py -m uploadImage <imagePath> <type> The default value for the module is @@ -1068,45 +1123,27 @@ uploadImage <imagePath> <type> The Enea Edge Management functionalities regarding the VNF are implemented in the VNFHandler.py script. - The VNFHandler class is implemented in - the VNFHandler.py script. + The VNFHandler class is implemented in the + VNFHandler.py script. To list the implemented methods (functionalities), run the script with the -v/--verbose option: -python automation_framework/VNFHandler.py -v + python automation_framework/VNFHandler.py -v Info about VNFHandler methods ... Method: getVNFDescriptorByName Parameters: vnfDescriptorName ... - The syntax for running the getVNFDescriptorByName - functionality starting from the input parameters: - -python automation_framework/VNFHandler.py -[-m getVNFDescriptorByName <vnfDescriptorName> [-o]] [-v] - - Where the following are included: - - - - vnfDescriptorName - name - of the VNF Descriptor - - - - v - verbose option - + The syntax for running the + getVNFDescriptorByName functionality starting from + the input parameters: - - o - displays the full - output - - + python automation_framework/VNFHandler.py -m getVNFDescriptorByName <vnfDescriptorName> -o - Example: + Example: python automation_framework/VNFHandler.py -m getVNFDescriptorByName fortigateImage -o @@ -1116,43 +1153,43 @@ Parameters: vnfDescriptorName
Enea Edge Management - The functionalities regarding the Enea Edge Management configuration - are implemented in the uCPEManagerHandler.py - script. + The functionalities regarding the Enea Edge Management + configuration are implemented in the + ManagementHandler.py script. - The uCPEManagerHandler class is implemented - in the uCPEManagerHandler.py script. + The ManagementHandler class is implemented in + the ManagementHandler.py script. To list the implemented methods (functionalities), run the script with the -v/--verbose option: -python automation_framework/uCPEManagerHandler.py -v -Info about uCPEManagerHandler methods + python automation_framework/ManagementHandler.py -v +Info about ManagementHandler methods ... -Method: getuCPEManagerVersion +Method: getManagementVersion Parameters(not needed): -- ... - The syntax for running the getuCPEManagerVersion - functionaltity is: - -python automation_framework/uCPEManagerHandler.py [-m getuCPEManagerVersion [-o]][-v] - - Where the following are included: - - - - v - verbose option - + The syntax for running the + getManagementVersion functionaltity is: - - o - displays the full - output - - + python automation_framework/ManagementHandler.py -m getManagementVersion -o All the other methods run in a similar way. + + + The functionalities relating to the Enea Edge Management + application configuration are also implemented in the + uCPEManagerHandler.py script where the + uCPEManagerHandler class is defined. The + uCPEManagerHandler class is a wrapper of the + ManagementHandler class. The + uCPEManagerHandler.py file is deprecated and + will be removed starting with the next major release. It is + recommended to use the ManagementHandler.py + script instead. +
@@ -1162,13 +1199,14 @@ Parameters(not needed): --
The Configuration class - The Configuration class is implemented in - the Configuration.py script. The + The Configuration class is implemented in the + Configuration.py script. The Configuration class cannot be independently used. The uCPEDeviceHandler and - OfflineConfigHandler classes inherit the Configuration class. The methods should be + OfflineConfigHandler classes inherit the + Configuration class. The methods should be implemented for both functionalities: uCPE Device and Offline config.
@@ -1176,52 +1214,53 @@ Parameters(not needed): --
The Logger Class - The Logger class is implemented in - the Logger.py script. It is inherited in all the + The Logger class is implemented in the + Logger.py script. It is inherited in all the classes defined in automation_framework. This class defines a logger for displaying the logs from Python scripts, in console log and file log. For console log, the logger has: - + - - Default severity: INFO - + + Default severity: INFO + - - Format of the logs: [datetime] [severity] - message - - + + Format of the logs: [datetime] [severity] + message + + For file log, the logger has: - + - - Logs path: log/debug.log - + + Logs path: log/debug.log + - - Default severity: DEBUG - + + Default severity: DEBUG + - - Format of the logs: [severity] - [name_of_Python_script] message - - + + Format of the logs: [severity] + [name_of_Python_script] message + +
Test Harness - - The Test Harness sources are in the - <AF-installdir>/test_harness directory. - + + The Test Harness sources are in the + <Automation-installdir>/test_harness + directory. +
Individual Ansible Playbooks @@ -1229,8 +1268,8 @@ Parameters(not needed): -- structuring the files needed for creating automated test cases using the Enea Edge Automation, and provides a way to implement them. - The ansible.cfg file contains an example of the - Ansible default configuration. The default value for + The ansible.cfg file contains an example of + the Ansible default configuration. The default value for stdout_callback is set to selective, to print only certain tasks. It is recommended to switch to debug when a test fails. By @@ -1238,46 +1277,45 @@ Parameters(not needed): -- True, task failures are considered fatal errors and the play execution stops. - All the Playbooks that execute Automation Framework Python modules run on localhost. - New entries have to be created for direct communication over SSH with - the boards. + All the Playbooks that execute Automation Framework Python modules + run on localhost. New entries have to be created for + direct communication over SSH with the boards. The setup_env.sh script sets up the - testHarness test environment by creating - the testHarness-venv Python virtual environment, + testHarness test environment by creating the + testHarness-venv Python virtual environment, executing requests needed by Automation Framework Python modules, and installing Ansible. The Ansible package version is 2.9.6. The test_harness directory contains all the - implemented Ansible Playbooks. This directory contains - the check_errror.yml Playbook and many subdirectories, + implemented Ansible Playbooks. This directory contains the + check_errror.yml Playbook and many subdirectories, each subdirectory representing an Enea Edge Management module. - The check_errors.yml Playbook checks the Python - output and returns success or fail results. This file is imported in all - playbooks from the test_harness directory and it cannot - be run standalone. + The check_errors.yml Playbook checks the + Python output and returns success or fail results. This file is imported + in all playbooks from the test_harness directory and + it cannot be run standalone. - According to their functionality, the Ansible Playbooks that - refer to offline configuration are in the OfflineConfig + According to their functionality, the Ansible Playbooks that refer + to offline configuration are in the OfflineConfig directory, the ones that refers to CustomScript are in the CustomScripts, and so on. Each Ansible Playbook has a help menu for: - - - - Returning the syntax, and examples for running the - Playbook. - - - Warning if the input parameters are wrong or not - enough. The input parameters are called extra-vars in Ansible - playbooks. - - + + + Returning the syntax, and examples for running the + Playbook. + + + + Warning if the input parameters are wrong or not enough. The + input parameters are called extra-vars in Ansible + playbooks. + + The help menu is activated when the Playbook is run without any parameters. @@ -1289,7 +1327,7 @@ Parameters(not needed): -- Display the help menu for addDataPlaneOvsBridge.yml: -ansible-playbook test_harness/uCPEDevice/addDataPlaneOvsBridge.yml + ansible-playbook test_harness/uCPEDevice/addDataPlaneOvsBridge.yml This playbook runs 'addDataPlaneOvsBridge' method from uCPEDeviceHandler module @@ -1322,8 +1360,8 @@ Usage: Run the addDataPlaneOvsBridge.yml playbook: - -ansible-playbook test_harness/uCPEDevice/addDataPlaneOvsBridge.yml -e + + ansible-playbook test_harness/uCPEDevice/addDataPlaneOvsBridge.yml -e "device=inteld1521-17 bridge_config_file=sfc_br.json" ansible-playbook test_harness/uCPEDevice/addDataPlaneOvsBridge.yml -e "device=inteld1521-17 bridge_config_file=lan_br.json" @@ -1342,17 +1380,17 @@ interfaces=eno4,eno5" Each Ansible Playbook from the test_harness directory represents an atomic operation, a basic functionality that is - performed on the Enea Edge Management application at a specific period of the time. They can - be sequentially run or they can be imported into other playbooks for - creating complex scenarios. + performed on the Enea Edge Management application at a specific period + of the time. They can be sequentially run or they can be imported into + other playbooks for creating complex scenarios. Example: To instantiate a VNF, the following operations have to be - performed: connect to the uCPE Device, bind NICs, create an OVS - bridge, create a VNF descriptor, and instantiate the VNF on the - device. All these operations can be run Playbook after Playbook using - the *.yml files from the test_harness + performed: connect to the uCPE Device, bind NICs, create an OVS bridge, + create a VNF descriptor, and instantiate the VNF on the device. All + these operations can be run Playbook after Playbook using the + *.yml files from the test_harness directory.
@@ -1362,74 +1400,75 @@ interfaces=eno4,eno5" All the individual Playbooks can be used as imported Playbooks in complex test scenarios. - The complex scenarios are defined in: modules/enea/scenario. + The complex scenarios are defined in: + modules/enea/scenario. The test scenarios are split into the following: - + - - Functionalities to be tested and used: the - CustomScripts, OfflineConfig, ovsTests - directories. - + + Functionalities to be tested and used: the + CustomScripts, OfflineConfig, ovsTests + directories. + - - Service Creation and Lifecycle: - the chainedVNFsService directory. - + + Service Creation and Lifecycle: the + chainedVNFsService directory. + - - VNF Deployment and Lifecycle: - the fortigateFWService directory. - - + + VNF Deployment and Lifecycle: the + fortigateFWService directory. + + For each test scenario, the README file contains: - + - - Preconditions: - - - - The configuration files to be updated - - - - The VNF images to be copied - - - - The license file needed from the provider and added to a - specific path, etc. - - - + + Preconditions: - - Running procedures: - - - - The ansible-playbook commands for - setup the configuration - - - - Testing the configuration - - - - Cleaning up the configuration - - - - + + + The configuration files to be updated + + + + The VNF images to be copied + + + + The license file needed from the provider and added to a + specific path, etc. + + + + + + Running procedures: + + + + The ansible-playbook commands for setup + the configuration + + + + Testing the configuration + + + + Cleaning up the configuration + + + + - The test scenarios have the variable.yml file that - contains the input parameters for the Playbooks. These variables can be - reused when the same setup is run on another device. + The test scenarios have the variable.yml file + that contains the input parameters for the Playbooks. These variables + can be reused when the same setup is run on another device. Example: @@ -1450,63 +1489,70 @@ vnfi_name: "fortigateFWInstance" The unit-test suite is implemented in the unit_tests directory. - The unit-test suite contains the - unit-test class defined in unittestSuite.py, and examples of JSON configuration - files that can be used for the execution of AF Python classes from the + The unit-test suite contains the + unit-test class defined in + unittestSuite.py, and examples of JSON configuration + files that can be used for the execution of AF Python classes from the automation_framework directory. The Python unit-test class defined in the - unittestSuite.py script provides a way to automate the execution of - specific test cases for each supported Python script. + unittestSuite.py script provides a way to automate + the execution of specific test cases for each supported Python + script. This class requires a test suite configuration JSON file that - contains a dictionary list of the Python scripts to be processed. Each dictionary contains the - path of the Python script to be loaded and the path to the file describing the test cases to - be performed against the designated script. + contains a dictionary list of the Python scripts to be processed. Each + dictionary contains the path of the Python script to be loaded and the + path to the file describing the test cases to be performed against the + designated script. Python unit-test suite examples are in the unit_tests/scenario directory. Each scenario has 3 parts: - + - - README - explains the prerequisites needed before running the - Python unit-test suite. - + + README - explains the prerequisites needed + before running the Python unit-test suite. + - - config - contains a JSON file for each - functionality that is used in the specified scenario. The JSON files have two keys: - - - - name: The description of the functionality. - + + config - contains a JSON file for each + functionality that is used in the specified scenario. The JSON files + have two keys: - - args: The arguments of the Python module. - - - + + + name: The description of the functionality. + - - JSON - used for running the scenario. Each JSON file contains - the calls to the JSON files from the config directory, and has two keys: - - - - config: The JSON file from the config directory that is used. - + + args: The arguments of the Python module. + + + - - module: The Python module that is run. - - - - + + JSON - used for running the scenario. Each + JSON file contains the calls to the JSON files from the + config directory, and has two keys: + + + + config: The JSON file from the config + directory that is used. + + + + module: The Python module that is run. + + + + - Steps for running the Python unit-test suite on the Enea Edge Management application are - provided in the README file from scenario in use. + Steps for running the Python unit-test suite on the Enea Edge + Management application are provided in the README file + from scenario in use.
\ No newline at end of file diff --git a/doc/book-enea-edge-automation-user-guide/doc/book.xml b/doc/book-enea-edge-automation-user-guide/doc/book.xml index 95547b6..3a28109 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/book.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/book.xml @@ -8,9 +8,9 @@ User Guide Release Version + xpointer="element(EneaEdge_REL_VER/1)" /> diff --git a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml index 27979cc..517f165 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml @@ -1,4 +1,4 @@ - + Getting Started with Enea Edge Automation @@ -10,133 +10,133 @@ Basic Setup - -
- Lab setup overview for Basic Setup - - - - - - -
+ +
+ Lab setup overview for Basic Setup + + + + + + +
Chained VNFs Service - -
- Lab Setup Overview for Chained VNFs Service - - - - - - -
+ +
+ Lab Setup Overview for Chained VNFs Service + + + + + + +
- The following environment setup is needed for running the Enea Edge Automation - tests: + The following environment setup is needed for running the Enea Edge + Automation tests: Lab Network Requirements: - - - - DHCP enabled - - - - Internet connectivity - - + + + + DHCP enabled + + + + Internet connectivity + + Enea Edge Management Host Requirements: - - - - CentOS 7 installed - - - - A connection to the Lab Network - - - - The Enea Edge Management application installed. For details, see Installing the Enea Edge Management application in the - - Manual. - - + + + + CentOS 7 installed + + + + A connection to the Lab Network + + + + The Enea Edge Management application installed. For details, + see Installing the Enea Edge Management + application in the + Manual. + + uCPE device Requirements for Basic Setup: - - - - Minimum of 4 Physical Network Devices - - - - 4GB RAM and 4 cores (Intel C3000 or Xeon D) - - - - 2 Physical connections to the Lab Network - - - - Enea Edge Runtime installed. For more - details, see Preparing the USB stick for - installation of the Enea Edge Runtime in the - - Manual. - - + + + + Minimum of 4 Physical Network Devices + + + + 4GB RAM and 4 cores (Intel C3000 or Xeon D) + + + + 2 Physical connections to the Lab Network + + + + Enea Edge Runtime installed. For more details, see Preparing the USB stick for installation + of the Enea Edge Runtime in the + Manual. + + uCPE device 1 and 2 Requirements for Chained VNFs Service: - - - - Minimum of 4 Physical Network Devices - - - - 16GB RAM and 8 cores (Intel C3000 or Xeon D) - - - - 2 Physical connections to the Lab Network - - - - 1 Physical connection back to back between both uCPE - devices - - - - Enea Edge Runtime installed - - + + + + Minimum of 4 Physical Network Devices + + + + 16GB RAM and 8 cores (Intel C3000 or Xeon D) + + + + 2 Physical connections to the Lab Network + + + + 1 Physical connection back to back between both uCPE + devices + + + + Enea Edge Runtime installed + +
@@ -154,125 +154,127 @@ EPEL Repository - - sudo yum install epel-release + + sudo yum install epel-release PIP package manager - - sudo yum -y install python-pip + + sudo yum -y install python-pip Virtualenv tool - - sudo pip install virtualenv + + sudo pip install virtualenv - It is recommended to install Enea Edge Automation and the Enea Edge Management application - on different machines. + It is recommended to install Enea Edge Automation and the Enea + Edge Management application on different machines.
Installing the Enea Edge Automation - Installing the - Enea Edge Automation - - - - Log into the host machine - - - - cd <AF-installdir> - - - - Extract the archive file - - unzip Enea_Edge_Automation_<version>-build<build_number>.zip - - - - Run the setup of virtual environment script: - - source setup_env.sh - - - - Configure the system. For more details, see . - - - - - The steps are executed only once, for the initial setup of the - environment. - - - Setting up the enviroment for the Enea Edge Automation - - - - Activate the Python virtual enviroment - - source <AF-installdir>/testHarness-venv/bin/activate - - - - Optionally, check the History Information - - vi <AF-installdir>/CHANGELOG - - - - Close the Python virtual environment - - deactivate - - + Installing the Enea + Edge Automation + + + + Log into the host machine + + + + cd <Automation-installdir> + + + + Extract the archive file + + unzip Enea_Edge_Automation_<version>-build<build_number>.zip + + + + Run the setup of virtual environment script: + + source setup_env.sh + + + + Configure the system. For more details, see . + + + + + The steps are executed only once, for the initial setup of the + environment. + + + Setting up the enviroment for the Enea Edge + Automation + + + + Activate the Python virtual enviroment + + source <Automation-installdir>/testHarness-venv/bin/activate + + + + Optionally, check the History Information + + vi <Automation-installdir>/CHANGELOG + + + + Close the Python virtual environment + + deactivate + +
Upgrading the Enea Edge Automation - Upgrading the Enea Edge Automation - - - - Log into the host machine - - - - cd <AF-installdir> - - - - Back up the configuration files from - modules/enea/config. - - - - Extract the archive file: - - unzip Enea_Edge_Automation_<version>-build<build_number>.zip - - - - Restore the configuration files from step 2 into - modules/enea/config . - - - - Run the setup of virtual environment script: - - source setup_env.sh - - + Upgrading the Enea Edge + Automation + + + + Log into the host machine + + + + cd <Automation-installdir> + + + + Back up the configuration files from + modules/enea/config. + + + + Extract the archive file: + + unzip Enea_Edge_Automation_<version>-build<build_number>.zip + + + + Restore the configuration files from step 2 into + modules/enea/config . + + + + Run the setup of virtual environment script: + + source setup_env.sh + +
\ No newline at end of file diff --git a/doc/book-enea-edge-example-usecases/doc/book.xml b/doc/book-enea-edge-example-usecases/doc/book.xml index fc69b88..e872c95 100644 --- a/doc/book-enea-edge-example-usecases/doc/book.xml +++ b/doc/book-enea-edge-example-usecases/doc/book.xml @@ -8,9 +8,9 @@ Use-cases Release Version + xpointer="element(EneaEdge_REL_VER/1)" /> diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index 07021cb..f317f15 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml @@ -8,9 +8,9 @@ Started Release Version + xpointer="element(EneaEdge_REL_VER/1)" /> 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 5f265fb..39ef10a 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 @@ -580,9 +580,9 @@ DeviceVersion: + xpointer="element(EneaEdge_REL_VER/1)" /> 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 e13cd41..350852b 100644 --- a/doc/book-enea-edge-management-open-source/doc/about.xml +++ b/doc/book-enea-edge-management-open-source/doc/about.xml @@ -7,7 +7,7 @@ This document contains the open source and license information pertaining to packages relating to the Enea Edge Management application provided with Enea Edge . + xpointer="element(EneaEdge_REL_VER/1)" />. \ No newline at end of file diff --git a/doc/book-enea-edge-management-open-source/doc/book.xml b/doc/book-enea-edge-management-open-source/doc/book.xml index 715fbe6..cb63551 100644 --- a/doc/book-enea-edge-management-open-source/doc/book.xml +++ b/doc/book-enea-edge-management-open-source/doc/book.xml @@ -6,7 +6,7 @@ <trademark class="registered">Enea</trademark> Edge Management Open Source Report Release Version - 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 349c955..2260bce 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml @@ -12,9 +12,9 @@ private or public cloud. The Enea Edge Release includes new features, + xpointer="element(EneaEdge_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. @@ -103,7 +103,7 @@ it is in the beginning. The subtitles shall have the directory name of the target in the manifest. - diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml index 0b77f41..6897c6f 100644 --- a/doc/book-enea-edge-release-info/doc/book.xml +++ b/doc/book-enea-edge-release-info/doc/book.xml @@ -8,9 +8,9 @@ Information Release Version + xpointer="element(EneaEdge_REL_VER/1)" /> diff --git a/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml deleted file mode 100644 index 9eecd3c..0000000 --- a/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - Getting Enea NFV Access - - Enea NFV Access releases and updates are available as binaries ready - for download. - - Downloading Enea NFV Access -Does the content below need to be revised to no longer make reference or mention to Enea Portal? - - - Log in to the link above using the credentials provided by - Enea. - - - - From the right corner of the top main menu, choose the - Access section. - - - - The Files section on the left will display each - official release of Enea NFV Access, with the latest at the top. - - Each release listing displays the dates for release and updates - available, along with a Download button that allows - you to directly save the version you wish to use. - - - - By clicking on the link at the top of any listing of Enea NFV - Access, you'll access the changelog page for that version. At the bottom - of the page are clearly labeled region-specific zip files containing the - binary sources. - - Documentation is also available at the bottom of the page. - - - - On the right side of the main Access page is - the Online Documentation section, listing pdfs for - the latest versions of documentation. They can all be accessed for - indiviudual downloading without the need to download the binaries - first. - - - - For details about the books delivered and their purpose, refer to - . For information concerning the - contents of the release package, please see . - diff --git a/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml deleted file mode 100644 index b0317b3..0000000 --- a/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - Host Requirements - - Using Enea NFV Access or compiling applications requires certain - packages to be installed on your build host. The requirements listed below - are extensive to allow getting Enea NFV Access to be booted on target - machines and for building applications. - - - - - - - - - - - - Build Host - Requirements - host requirements - - - - - Linux distribution - - The downloaded product can installed on the target machine - using a Linux host. For information about supported hosts and - targets, see . - - - - Packages - - Depending on the Linux distribution and version of the host, - certain packages may be required. See details on what packages are - needed and how to install them in the following sections. - - - - Disk space - - Your build host should have at least 50 GB of free disk space - for installing the SDK, eSDK or cross-compiling - applications. - - - - Recommended RAM - - Your build host must have at least 4 GB available - RAM. - - - - - \ No newline at end of file diff --git a/doc/book-enea-edge-runtime-open-source/doc/about.xml b/doc/book-enea-edge-runtime-open-source/doc/about.xml index 94136a3..d1e04b4 100644 --- a/doc/book-enea-edge-runtime-open-source/doc/about.xml +++ b/doc/book-enea-edge-runtime-open-source/doc/about.xml @@ -7,7 +7,7 @@ This document contains the open source and license information pertaining to packages relating to the Enea Edge Runtime and the Installer provided with Enea Edge . \ No newline at end of file diff --git a/doc/book-enea-edge-runtime-open-source/doc/book.xml b/doc/book-enea-edge-runtime-open-source/doc/book.xml index a575375..4e2ecf2 100644 --- a/doc/book-enea-edge-runtime-open-source/doc/book.xml +++ b/doc/book-enea-edge-runtime-open-source/doc/book.xml @@ -6,7 +6,7 @@ <trademark class="registered">Enea</trademark> Edge Runtime Open Source Report Release Version - diff --git a/doc/book-enea-edge-system-test-specification/doc/book.xml b/doc/book-enea-edge-system-test-specification/doc/book.xml index bcc2dcd..0884348 100644 --- a/doc/book-enea-edge-system-test-specification/doc/book.xml +++ b/doc/book-enea-edge-system-test-specification/doc/book.xml @@ -7,7 +7,7 @@ <trademark class="registered">Enea</trademark> Edge System Test Specification Release Version - diff --git a/doc/book-enea-edge-telemetry-open-source/doc/about.xml b/doc/book-enea-edge-telemetry-open-source/doc/about.xml index 443bf36..3c64d62 100644 --- a/doc/book-enea-edge-telemetry-open-source/doc/about.xml +++ b/doc/book-enea-edge-telemetry-open-source/doc/about.xml @@ -6,7 +6,7 @@ This document contains the open source and license information pertaining to Telemetry packages provided with Enea Edge . + xpointer="element(EneaEdge_REL_VER/1)" />. \ No newline at end of file diff --git a/doc/book-enea-edge-telemetry-open-source/doc/book.xml b/doc/book-enea-edge-telemetry-open-source/doc/book.xml index 9b0aa33..0c54870 100644 --- a/doc/book-enea-edge-telemetry-open-source/doc/book.xml +++ b/doc/book-enea-edge-telemetry-open-source/doc/book.xml @@ -6,7 +6,7 @@ <trademark class="registered">Enea</trademark> Edge Telemetry Open Source Report Release Version - diff --git a/doc/book-enea-nfv-access-evalkit/doc/book.xml b/doc/book-enea-nfv-access-evalkit/doc/book.xml index 90399a7..68b36af 100644 --- a/doc/book-enea-nfv-access-evalkit/doc/book.xml +++ b/doc/book-enea-nfv-access-evalkit/doc/book.xml @@ -7,7 +7,7 @@ <trademark class="registered">Enea</trademark> NFV Access Evaluation Kit Release Version - diff --git a/doc/book-enea-nfv-access-evalkit/doc/prerequisites.xml b/doc/book-enea-nfv-access-evalkit/doc/prerequisites.xml index fca409c..7204f7b 100644 --- a/doc/book-enea-nfv-access-evalkit/doc/prerequisites.xml +++ b/doc/book-enea-nfv-access-evalkit/doc/prerequisites.xml @@ -153,10 +153,10 @@ - See the Enea NFV Access See the Enea Edge Release Information for more + xpointer="element(EneaEdge_REL_VER/1)" /> Release Information Manual for more details.
\ No newline at end of file diff --git a/doc/eltf_params_template.xml b/doc/eltf_params_template.xml new file mode 100644 index 0000000..8a05079 --- /dev/null +++ b/doc/eltf_params_template.xml @@ -0,0 +1,151 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + ELTF_PL_HOST_PREREQ + + A programlisting, ID + "eltf-getting-repo-install-command" + + ELTF_PL_GET_REPO + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + ELTF_EL_REL_VER + + ELTF_YOCTO_VER + + ELTF_YOCTO_NAME + + ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL + + ELTF_EL_DOWNLOAD_TXTURL + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + ELTF_PL_CLONE_W_REPO + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the + template.xml and in the updated.xml, set condition hidden on the + <row>, if eclipse is not in the release. + + + + + + Eclipse version ELTF_ECLIPSE_VERSION plus command line + development tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Targets with Parameters + + The tables below describes the target(s) supported in this Enea + Linux release. + +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + + + + + + + + + + Target official name + + ELTF_T_NAME + + + + Architecture and Description + + ELTF_T_ARC_DESC + + + + Link to target datasheet + + See ELTF_T_DS_TXTURL + + + + Poky version + + ELTF_T_POKY_VER + + + + GCC version + + ELTF_T_GCC_VER + + + + Linux Kernel Version + + ELTF_T_KERN_VER + + + + Supported Drivers + + ELTF_T_DRIVERS + + + + Enea rpm folder for downloading RPM packages for this + target + + ELTF_T_EL_RPM_TXTURL + + + + +
+ + +
+
\ No newline at end of file diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml new file mode 100644 index 0000000..34739ee --- /dev/null +++ b/doc/eltf_params_updated.xml @@ -0,0 +1,240 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + # Host Ubuntu 16.04 LTS 64bit +sudo apt-get -y update +sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + + A programlisting, ID + "eltf-getting-repo-install-command" + + mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + 2.5.0 + + 1 + + 2.4 + + rocko + + http://www.yoctoproject.org/downloads + + https://linux.enea.com/6 + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + mkdir enea-linux +cd enea-linux +repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ + -b refs/tags/EL6 -m $MACHINE/default.xml +repo sync + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set + condition hidden if eclipse is not in the release. Do this both in + template.xml and updated.xml. + + + + + + Eclipse version 4.3 (Mars) plus command line development + tools are included in this Enea Edge release. + + + + + + Below is one big section with title "Supported Processor with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Reference Processors with Parameters + + The table(s) below describes the tested processors for this Enea + Edge release. + + + Processor Product Family Information - Intel Xeon D-1500 + + + + + + + Component + + Description + + + + + + Processor official product family name + + Intel Xeon D-1500 (Broadwell) + + + + Architecture and Description + + x86-64 + + + + Link to processor datasheet + + Intel's + datasheet + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Tested Whiteboxes + + + + + Supermicro X10SDV-4C-TLN2F (Intel Xeon + D-1521) + + + + Kontron ME1100 (Intel Xeon D-1548). + + + + + + +
+ + + Processor Product Family Information - Intel Atom C3000 + + + + + + + Component + + Description + + + + + + Processor official product family name + + Intel Atom C3000 (Denverton) + + + + Architecture and Description + + x86-64 + + + + Link to the processor datasheet + + Intel's + datasheet + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Tested Whiteboxes + + + + + Dell EMC Networking VEP1445 (Intel Atom + C3758) + + + + Advantech FWA-1012VCR-4CA1S (Intel Atom + C3558) + + + + Advantech FWA-1112VCL-2CA1S (Intel Atom + C3558-4C) + + + + Supermicro A2SDi-TP8F (Intel Atom C3858) + + + + Supermicro SuperServer 5019A-12TN4 (Intel Atom + C3850) + + + + Silicom C3000 (Intel Atom 3558) + + + + + + +
+
+
\ No newline at end of file diff --git a/doc/eltf_params_updated_template_how_to_use.txt b/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..97b07aa --- /dev/null +++ b/doc/eltf_params_updated_template_how_to_use.txt @@ -0,0 +1,320 @@ +eltf_params_template_updated_howto_use.txt + +This is a way to collect all parameters for an Enea Edge release +in one parameter file, easy to automatically update by ELTF regularly. + +NOTE: Both the release info AND the open source books use parameters from + here, but the XML file is inside the release info book directory. + +NOTE: The manifest_conf.mk, or overridden by the environment variable + MANIFESTHASH, contains the full tag (or hashvalue) for downloading + the manifest when the books are built. The list of target + directories are fetched from the manifest into the book. + The eltf_params_updates.xml can all the time contain + the final next complete tag e.g. refs/tags/EL6 or similar + in the ELTF_PL_CLONE_W_REPO parameter command lines. + +The ordinary book XML files use xi:include statements to include elements +from this parameter file. The book XML files can thus be manually edited. +Before editing, you must run "make init". +Any other text in the template or updated.xml file, outside the parts that +are included in the book, are not used but still all must be correct +DocBook XML files. + +ELTF work: + template => ELTF replaces ALL ELTF_xxx variables => updated XML file + => push to git only if changed + + +eltf_params_template.xml (in git) + File used by ELTF to autocreate/update the real parameter + file eltf_params_updated.xml. + +eltf_params_updated.xml (in git) + Real parameter file where ELTF has replaced all ELTF_xx variables with + strings, in several cases with multiline strings. + No spaces or linefeed allowed in beginning or end of the variable values! + + +xi:include: Each parameter is xi:include'ed in various book files, using + the IDs existing in the parameter files. + In most cases the 1:st element inside an element with an ID is included + using a format like eltf-prereq-apt-get-commands-host/1. + In very few cases the element with the ID is included in the book, one + example is the target section which has an ID, but which contains + multiple subsections, one per target. + All IDs in a book must be unique. + +DocBook XML: All XML files must be correct DocBook XML files. + +Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes + not done by ELTF. But it is OK to open the real file in XMLmind to + check that the format is correct. + +ELTF should autocreate a temporary "real" file but only replace + and push the eltf_params_updated.xml if it is changed. + + +make eltf + This lists all ELTF_xxx variables and some rules how to treat them + +DocBook Format: All elements - rules: + Several strict generic XML rules apply for all strings: + 1. No TABs allowed or any other control chr than "linefeed" + 2. Only 7-bit ASCII + 3. Any < > & must be converted to < > and & + Similar for any other non-7-bit-ASCII but avoid those! + 4. No leading spaces or linefeeds when replacing the ELTF_* variable + 5. No trailing spaces or linefeeds when replacing the ELTF_* variable + 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. + +DocBook Format: - rules: ELTF*PL* variables + Several strict rules apply for the multiline string in programlisting + in addition to the general XML rules above: + 7. Max line length < 80 char + 8. Use backslash (\) to break longer lines + 9. Use spaces (e.g. 4) to indent continuation lines in programlistings + 10. No trailing spaces on any line + 11. No spaces or linefeed immediately after leading + 12. No spaces or linefeed before trailing + +DocBook Format: - rules: ELTF_*URL* variables + 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings + 14. Only if the URL is extremely long, the TXTURL can be a separate string + +Each target has one section with target parameters: +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + ..... with many ELTF_ variables .... +
+ + 15. If there is only one target. ELTF just replaces ELTF parameters + + 16. It there are multiple targets. ELTF copies the section and appends the + section the required number of times. + Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR + Each section title will become unique + +Tables with target parameters in each target section: + 17. It is possible for ELTF to append more rows with one parameter each + to these tables, because the entire tables are included in the book + +Special - NOT YET READY DEFINED how to handle the optionally included + Eclipse and its version, but this is a first suggestion: + 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string + with both version number and name, + 19. MANUALLY if Eclipse is NOT included in the release, + the release manager should manually set condition="hidden" on + the entire section in the book XML about Eclipse + + + +BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf +if there are more new variables, missing in this description file. + +_____________________________________________________________________________ +ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands + like sudo apt-get install xxxx or similar. + First line = comment with the complete host name! + It is possible to include multiple hosts by just + adding an empty line, comment with host name, etc. + xi:include eltf-prereq-apt-get-commands-host/1 + This is a ... + Example: +# Host Ubuntu 14.04.5 LTS 64bit +sudo apt-get update +sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + +_____________________________________________________________________________ +ELTF_PL_GET_REPO Multiline commands to download the repo tool + xi:include eltf-getting-repo-install-command/1 + This is a ... + Example: +mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + +_____________________________________________________________________________ +ELTF_EL_REL_VER General parameter string: The version of this Enea + NFV Access release. Major version and optional .Minor + Typically created from MAJOR and MINOR in enea.conf + MINOR in enea.conf is empty or contains a dot+minor + xi_include EneaEdge_REL_VER/1 + This is a X.x used in many places. + Examples: +6 + or +6.1 + +_____________________________________________________________________________ +ELTF_YOCTO_VER General parameter string: Yocto version, created + from DISTRO in poky.ent + xi:include Yocto_VER/1 + This is a X.x used in many places. + Example: +2.1 + +_____________________________________________________________________________ +ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created + from DISTRO_NAME_NO_CAP in poky.ent + xi:include Yocto_NAME/1 + This is a X.x used in many places. + Example: +krogoth + +_____________________________________________________________________________ +ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL +ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string + at the end, typically without "dot". + xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 + This is an ... + Example: +http://www.yoctoproject.org/downloads/core/krogoth/21 + +_____________________________________________________________________________ +ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings +ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where + Enea NFV Access can be downloaded + Often containing same version as in ELTF_EL_REL_VER + xi:include ULINK_ENEA_LINUX_URL/1 + This is an ... + Example: +http://linux.enea.com/6 + +_____________________________________________________________________________ +ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. + Use the variable $MACHINE/default.xml (the text in + the book will list the avaiable values of MACHINE, + taken from the manifest repository) + xi:include eltf-repo-cloning-enea-linux/1 + This is a ... + Example: +mkdir enea-linux +cd enea-linux +repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ + -b refs/tags/EL6 -m $MACHINE/default.xml +repo sync + +_____________________________________________________________________________ +ELTF_ECLIPSE_VERSION Optional general parameter string. + NOT YET READY DEFINED + Just now a release manage must manually set + condition="hidden" on the Eclipse section, + if Eclipse is not included in the release. + ELTF just replaces ELTF_ECLIPSE_VERSION with a full + string with "X.Y (name)" + It includes the ID and can only be ONCE in the book. + xi:include eltf-eclipse-version-row + Example. +4.5 (Mars) + + +_____________________________________________________________________________ +ELTF_T_* All these are in each target (MACHINE) and ELTF + must separately replace them with strings for + each target + NOTE: All (except the MANIFEST_DIR) are in rows + in a table and ELTF can select to append + more parameters by adding more rows + +_____________________________________________________________________________ +ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly +ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same + as the MACHINE names in $MACHINE/default.xml. + In book: a) Part of section ID + b) Part of section title + Examples: +p2041rgb + or +ls1021aiot + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_NAME Target specific: "Target Official Name" + NOT same as the target directory name in most cases. + In book: An element in a row + Examples: +P2041RGB + or +LS1021a-IoT + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_ARC_DESC Target specific: "Architecture and Description" + It can be a short identification string or + it can be a longer descriptive sentence. + In book: An element in a row + Examples: +Power, e500mc + or +ARM Cortex-A7 + +_____________________________________________________________________________ +ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These +ELTF_T_DS_URL two usually are IDENTICAL strings with correct + hyperlink to the target's official datasheet. + In book: an ... + Only if the link is VERY LONG, the text part shall + instead be a descriptive string (see 2:nd example). + NOTE: Also here no spaces or line-feeds! + Examples: +url="http://wiki.qemu.org">http://wiki.qemu.org +or +url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet + +_____________________________________________________________________________ +ELTF_T_POKY_VER Target specific: "Poky version" created either + from POKYVERSION in poky.ent + or using a hashvalue with a leading string, in + which case it may be different per target. + In book: An in a row + Examples: +15.0.0 +or +Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 + +_____________________________________________________________________________ +ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky + but not easy to find among various parameters. + ELTF would extract it from build logs building SDK + and it is possibly different per target. + In book: An in a row + Example: +5.3 + +_____________________________________________________________________________ +ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often + different per target. + In book: An in a row + Example: +3.12 + +_____________________________________________________________________________ +ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a + comma-separated list of driver names. + ELTF should create the list in same order for each + target, e.g. alphabetic migth be OK. + In book: An in a row + Example: +Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC + + +_____________________________________________________________________________ +ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading +ELTF_T_EL_RPM_URL RPM packages for this target". These two are + INDENTICAL strings with hyperlink to the web site + at Enea where the customer can download RPMs + Note: Often the ELFT_EL_REL_VER value and + the ELTF_T_MANIFEST_DIR are used in the link. + In book: an ... + Example: +url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm + +_____________________________________________________________________________ -- cgit v1.2.3-54-g00ecf From 068fba5c491196290632280936ac95412b623015 Mon Sep 17 00:00:00 2001 From: Toma Bilius Date: Wed, 9 Jun 2021 15:07:38 +0300 Subject: ELCCR-1702 Add documentation to the Enea Getting Started Manual - Add documentation for NFVi Backup Change-Id: I782d4946def16b23864419369b885a42c69124ab Signed-off-by: Toma Bilius --- .../doc/advanced_configurations.xml | 220 ++++++++++++++++----- 1 file changed, 173 insertions(+), 47 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 3366a43..cc6ea9d 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -414,62 +414,186 @@ node0.1048576kB = 3
Tomcat Certificate Generation - The self-signed Tomcat Certificate the Enea Edge - Management application uses is generated at installation time. It can - be regenerated anytime after installation by using the + The self-signed Tomcat Certificate the Enea Edge Management + application uses is generated at installation time. It can be regenerated + anytime after installation by using the createCertificate.sh script. On 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.gz + + The directory in which the archive has been unpacked will be + denoted as: <uCPEM-installerdir>. + + + + Enter <uCPEM-installerdir>/dist. + + + + Run the following command and change /opt/ems + to the location where the Enea Edge Management application is + installed: + + ./createCertificate.sh ucpemanager <IP_or_domain> \ + /opt/ems [<service_username>] + + Where the following need to be included: + + + + The IP or domain name of the server the Enea Edge Management + application is running on. + + + + The service username, which is the one set when installing + the Enea Edge Management application. For more details see Fresh Installation of the Enea + Edge Management application in the + Manual. Providing the service username is optional. If it is not + provided, the default value will be used. + + + + + + Restart the Enea Edge Management service: + + service ucpemanager restart + + +
+ +
+ NFV Infrastructure Backup Operations + + In the following sections are described the operations that can be + performed in order to backup and restore the NFV Infrastructure (NFVi) + configuration. This allows for recovery from unintended configuration + errors. + +
+ NFVi Snapshotting + + To perform a snapshot (a backup of the current state) of the NFVi, + perform the following steps in the Enea Edge Management application: + + - Extract Enea_Edge_Management_<version>-build<build_number>.tar.gz + Select the uCPE device, access the Configuration menu, and select NFVI Backup. The NFVI Config Archive Table will be + shown. + - The directory in which the archive has been unpacked will be - denoted as: <uCPEM-installerdir>. + + Press the Create + button. - Enter <uCPEM-installerdir>/dist. + Edit the default file name, if needed, and press the Create button. The current window will + close and the success message Created + successfully will be shown. + + A new entry will be added in the NFVI + Config Archive Table and the BackupArchiveCreated event can be seen by acessing + the Fault menu and triggering the + Events window. The backup + file will be created on the uCPE device in the + /var/odm/backup/ folder. +
+ +
+ Restoring an NFVi backup + + When needed, an NFVi backup can be restored in the following + way: + + - Run the following command and change /opt/ems - to the location where the Enea Edge Management application is installed: + Select the uCPE device, access the Configuration menu and select NFVI Backup. The NFVI Config Archive Table will be + shown. + - ./createCertificate.sh ucpemanager <IP_or_domain> \ - /opt/ems [<service_username>] + + Select an existing backup from the NFVI Config Archive + Table. + - Where the following need to be included: + + Press the Restore button + and Confirm the action. + + - - - The IP or domain name of the server the Enea Edge - Management application is running on. - + A success message will be shown in the same window: Restored NFVI configuration. Two events will + appear in the Events window (accesible + through the Fault menu): + Restore started and + Restore complete. - - The service username, which is the one set when installing the - Enea Edge Management application. For more details - see Fresh Installation of the Enea - Edge Management application in the Manual. - Providing the service username is optional. If it is not provided, the default - value will be used. - - + + When restoring an NFVi backup, connectivity with the uCPE device + may be lost for a period of time. After a successful restoration the + connection with the device will be restored. Any saved custom scripts + of type once-before-startup or + once-after-startup will be re-executed as part + of the NFVi restore process. + +
+ +
+ Deleting an NFVi backup + + Deleting an older NFVi backup can be performed in the following + way: + + + + Select the uCPE device, access the + Configuration menu, and select + NFVI Backup. The NFVI Config Archive Table will be + shown. - Restart the Enea Edge Management service: + Select an existing backup from the NFVI Config Archive + Table. + - service ucpemanager restart + + Press the Delete + button. + + A success message will be shown in the same window: NFVI configuration backup deleted. The backup + file will be deleted from the uCPE device (from the + /var/odm/backup/ folder), and the table will be + updated. +
@@ -520,8 +644,8 @@ node0.1048576kB = 3 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 + 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. @@ -541,7 +665,7 @@ node0.1048576kB = 3 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 @@ -1043,17 +1167,19 @@ 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. + + + 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 @@ -1164,4 +1290,4 @@ Configuration complete.
- + \ No newline at end of file -- cgit v1.2.3-54-g00ecf From 6e6646fa7cdc17995c6c5ac9c8a37c0e3ff74acb Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Fri, 28 May 2021 16:06:13 +0300 Subject: ELCCR-1657:custom script reinstall after factory reset reboots device Change-Id: I8f08a25e2459ccc508b2cd49f518d7996cb06e90 --- .../doc/installation_guide.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 5f17ad1..f0c8961 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -607,8 +607,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Manual. - The generation of the Tomcat self-signed cerificate - should be skipped only if another certifcate will be + The generation of the Tomcat self-signed certificate + should be skipped only if another certificate will be provided. @@ -1202,15 +1202,15 @@ of=/dev/sdb bs=4M conv=fsync Factory reset. Resets the device to its default factory settings. All current configuration settings are lost. All running VNFs are destroyed. All uploaded VM - image files are deleted. Any installed custom scripts will be - removed and they will need to be reinstalled. Existing log files - will be kept. + image files are deleted. Existing log files will be kept. Only the vCPE service will be restarted, the device will not be rebooted. No reboot is needed. Once the vCPE service restart completes, appropriate day-0 - provisioning will take place. + provisioning will take place. Previously installed custom scripts + will be reinstalled on the uCPE device, and upon receiving the custom + script(s), the device will reboot. -- cgit v1.2.3-54-g00ecf From 24b8b987e179cb4bc99c080cbd5adcf9b56d6d90 Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 16 Jun 2021 23:01:08 +0200 Subject: Moved the browser recommendation to the Getting Started Manual. Change-Id: I77ec86debfb9b42f155f050c91c4a78ff9c273a2 Signed-off-by: mrpa --- .../doc/installation_guide.xml | 58 ++++++++++++---------- .../doc/about_release.xml | 21 -------- 2 files changed, 31 insertions(+), 48 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 f0c8961..2297cda 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -121,12 +121,13 @@ 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 - available with your release, for recommended browsers. + application for management and configuration. + + + Network access between the CentOS 7 server and the laptop + is required. The recommended browser for the current release is + Google Chrome. + @@ -593,19 +594,21 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Create the self-signed certificate: Specify IP or domain name - (or press Enter to skip): - - The Tomcat self-signed certificate can be generated - again by running the - createCertificate.sh. For more details, please see Tomcat Certificate - Generation in the Manual. - + Create the self-signed certificate: Specify IP + or domain name (or press Enter to + skip): + + The Tomcat self-signed certificate can be generated + again by running the + createCertificate.sh. For more details, + please see Tomcat Certificate Generation + in the + Manual. + The generation of the Tomcat self-signed certificate should be skipped only if another certificate will be @@ -651,8 +654,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - The IPv4 address of the CentOS 7 Server will be used as a configuration - parameter when setting up the uCPE devices. + 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 @@ -751,9 +754,10 @@ 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.
@@ -1209,8 +1213,8 @@ of=/dev/sdb bs=4M conv=fsync Once the vCPE service restart completes, appropriate day-0 provisioning will take place. Previously installed custom scripts - will be reinstalled on the uCPE device, and upon receiving the custom - script(s), the device will reboot. + will be reinstalled on the uCPE device, and upon receiving the + custom script(s), the device will reboot. @@ -1247,4 +1251,4 @@ of=/dev/sdb bs=4M conv=fsync
- + \ No newline at end of file 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 2260bce..3cc854e 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml @@ -164,25 +164,4 @@ - -
- Supported Web Browsers - - The current release supports using the following web - browsers: - - - - Google Chrome (tested with version 89). - - - - Mozilla Firefox (tested with version 87). - - - - Microsoft Edge (tested with version 89). - - -
\ No newline at end of file -- cgit v1.2.3-54-g00ecf From 43602e8650d534d3bbfb0532bf1a901d1e357275 Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 7 Jul 2021 12:06:53 +0200 Subject: Updated the names from ucpe manager to enea edge management where applicable. Service names and database IDs remain unedited. Change-Id: I6ffecdc0fb1364e8afe0f1d6563eb179e804380f Signed-off-by: mrpa --- .../doc/advanced_configurations.xml | 2 +- .../doc/installation_guide.xml | 80 +++--- .../doc/log_collector.xml | 4 +- .../doc/upgrade_ena.xml | 10 +- .../doc/about_release.xml | 27 +- doc/eltf_params_template.xml | 151 ++++++++++ doc/eltf_params_updated.xml | 173 +++++++++++ doc/eltf_params_updated_template_how_to_use.txt | 320 +++++++++++++++++++++ 8 files changed, 697 insertions(+), 70 deletions(-) create mode 100644 doc/eltf_params_template.xml create mode 100644 doc/eltf_params_updated.xml create mode 100644 doc/eltf_params_updated_template_how_to_use.txt (limited to 'doc/book-enea-edge-getting-started') 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 83641b1..c387e7f 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -437,7 +437,7 @@ node0.1048576kB = 3 Run the following command: - ./createCertificate.sh ucpemanager <IP_or_domain> \ + ./createCertificate.sh EneaEdgeManagement <IP_or_domain> \ /opt/ems [<service_username>] Where the following need to be included: 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 1eab201..b4324de 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -490,12 +490,12 @@ userdel postgres Choose the target installation folder, e.g. /opt/ems. Everything will be installed under a - folder called /ucpemanager within the target - installation folder. + folder called /ucpemanager within the + target installation folder. The application files will be installed in - /opt/ems/ucpemanager/application. The database - will be installed in + /opt/ems/ucpemanager/application. The + database will be installed in /opt/ems/ucpemanager/database. @@ -503,7 +503,7 @@ userdel postgres Run the following interactive command: ./install.sh /opt/ems \ -Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz +Enea_Edge_Management_<version>-build<build_number>.tar.gz The default configuration values are specified in brackets. If no other value is preferred and typed in, pressing @@ -565,12 +565,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Specify a service username - [ucpemanager]: + [EneaEdgeManagement]: Specify a service password - [ucpemanager]: + [EneaEdgeManagement]: @@ -593,19 +593,21 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Create the self-signed certificate: Specify IP or domain name - (or press Enter to skip): - - The Tomcat self-signed certificate can be generated - again by running the - createCertificate.sh. For more details, please see Tomcat Certificate - Generation in the Manual. - + Create the self-signed certificate: Specify IP + or domain name (or press Enter to + skip): + + The Tomcat self-signed certificate can be generated + again by running the + createCertificate.sh. For more details, + please see Tomcat Certificate Generation + in the + Manual. + The generation of the Tomcat self-signed cerificate should be skipped only if another certifcate will be @@ -614,14 +616,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Heap Configuration: - + Heap Configuration: + - - Please enter the new Maximum Heap Size - [4g]: - - + + Please enter the new Maximum Heap Size [4g]: + + @@ -639,11 +640,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Install the Enea Edge Management application as a - service with the name ucpemanager. + service with the name + ucpemanager. - Start the ucpemanager service. + Start the ucpemanager + service. @@ -657,8 +660,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - The IPv4 address of the CentOS 7 Server will be used as a configuration - parameter when setting up the uCPE devices. + 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 @@ -680,8 +683,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzSystem menu, and clicking System Backup, from the Enea Edge Management GUI. The resulting zip archive will be located in the - /opt/ems/ucpemanager/application/backup folder - and will be named + /opt/ems/ucpemanager/application/backup + folder and will be named SystemBackup_MMMDD_YYYY_HHMM_SS.zip (e.g System-Backup_Feb19_2013_2257_42.zip). Save the archive to another location outside the Enea Edge Management installation folder for @@ -708,7 +711,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz ./install.sh \ -/opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ +/opt/ems Enea_Edge_Management_<version>-build<build_number>.tar.gz \ SystemBackup_MMMDD_YYYY_HHMM_SS.zip @@ -757,9 +760,10 @@ sdb 8:0 0 111.8G 0 disk sudo dd if=./enea-edge-runtime-<machine>.hddimg \ of=/dev/sdb bs=4M conv=fsync - Where enea-edge-runtime-<machine>.hddimg is - the .hddimg file and sdb is - the assigned USB device name. + Where + enea-edge-runtime-<machine>.hddimg is the + .hddimg file and sdb is the + assigned USB device name. @@ -1252,4 +1256,4 @@ of=/dev/sdb bs=4M conv=fsync - + \ No newline at end of file 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 1148dc2..d7d99dd 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml @@ -341,7 +341,7 @@ 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 application's installation folder @@ -358,7 +358,7 @@ Select the desired log file - (ucpemanager.log or + (EneaEdgeManagement.log or watchdog.log) and press the Download button. 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 ac2ebb6..e213a0f 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml @@ -37,7 +37,7 @@ Management installation: ./upgrade.sh /opt/ems \ -Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz +Enea_Edge_Management_<version>-build<build_number>.tar.gz @@ -52,7 +52,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Create a compressed file of the ucpemanager application folder - (ucpemanager-Back-up-YYYYddMMHHmm.tar.gz), which + (EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz), which contains a snapshot of the existing installation in the <uCPEM-installerdir>/dist directory. @@ -109,7 +109,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Copy the snapshot file - (ucpemanager-Backup-YYYYddMMHHmm.tar.gz) + (EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz) created during a previous Enea Edge Management Upgrade or Enea Edge Management Uninstall Operation into the <uCPEM-installerdir>/dist directory. @@ -124,7 +124,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz/opt/ems to the correct location of the Enea Edge Management installation: - ./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz + ./restore.sh /opt/ems EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz @@ -186,7 +186,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Create a compressed file of the ucpemanager application folder: - ucpemanager-Back-up-YYYYddMMHHmm.tar.gz, which + EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz, which contains a snapshot of the existing installation and functions as a restore point. 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 349c955..3cc854e 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml @@ -12,9 +12,9 @@ private or public cloud. The Enea Edge Release includes new features, + xpointer="element(EneaEdge_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. @@ -103,7 +103,7 @@ it is in the beginning. The subtitles shall have the directory name of the target in the manifest. - @@ -164,25 +164,4 @@ - -
- Supported Web Browsers - - The current release supports using the following web - browsers: - - - - Google Chrome (tested with version 89). - - - - Mozilla Firefox (tested with version 87). - - - - Microsoft Edge (tested with version 89). - - -
\ No newline at end of file diff --git a/doc/eltf_params_template.xml b/doc/eltf_params_template.xml new file mode 100644 index 0000000..8a05079 --- /dev/null +++ b/doc/eltf_params_template.xml @@ -0,0 +1,151 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + ELTF_PL_HOST_PREREQ + + A programlisting, ID + "eltf-getting-repo-install-command" + + ELTF_PL_GET_REPO + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + ELTF_EL_REL_VER + + ELTF_YOCTO_VER + + ELTF_YOCTO_NAME + + ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL + + ELTF_EL_DOWNLOAD_TXTURL + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + ELTF_PL_CLONE_W_REPO + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the + template.xml and in the updated.xml, set condition hidden on the + <row>, if eclipse is not in the release. + + + + + + Eclipse version ELTF_ECLIPSE_VERSION plus command line + development tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Targets with Parameters + + The tables below describes the target(s) supported in this Enea + Linux release. + +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + + + + + + + + + + Target official name + + ELTF_T_NAME + + + + Architecture and Description + + ELTF_T_ARC_DESC + + + + Link to target datasheet + + See ELTF_T_DS_TXTURL + + + + Poky version + + ELTF_T_POKY_VER + + + + GCC version + + ELTF_T_GCC_VER + + + + Linux Kernel Version + + ELTF_T_KERN_VER + + + + Supported Drivers + + ELTF_T_DRIVERS + + + + Enea rpm folder for downloading RPM packages for this + target + + ELTF_T_EL_RPM_TXTURL + + + + +
+ + +
+
\ No newline at end of file diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml new file mode 100644 index 0000000..f5f3f7d --- /dev/null +++ b/doc/eltf_params_updated.xml @@ -0,0 +1,173 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + +
+ Common Parameters + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + 2.5.0 + + 1 + + Below is one big section with title "Supported Processor with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Reference Processors with Parameters + + The table(s) below describes the tested processors for this Enea + Edge release. + + + Processor Product Family Information - Intel Xeon D-1500 + + + + + + + Component + + Description + + + + + + Processor official product family name + + Intel Xeon D-1500 (Broadwell) + + + + Architecture and Description + + x86-64 + + + + Link to processor datasheet + + Intel's + datasheet + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Tested Whiteboxes + + + + + Supermicro X10SDV-4C-TLN2F (Intel Xeon + D-1521) + + + + Kontron ME1100 (Intel Xeon D-1548). + + + + + + +
+ + + Processor Product Family Information - Intel Atom C3000 + + + + + + + Component + + Description + + + + + + Processor official product family name + + Intel Atom C3000 (Denverton) + + + + Architecture and Description + + x86-64 + + + + Link to the processor datasheet + + Intel's + datasheet + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Tested Whiteboxes + + + + + Dell EMC Networking VEP1445 (Intel Atom + C3758) + + + + Advantech FWA-1012VCR-4CA1S (Intel Atom + C3558) + + + + Advantech FWA-1112VCL-2CA1S (Intel Atom + C3558-4C) + + + + Supermicro A2SDi-TP8F (Intel Atom C3858) + + + + Supermicro SuperServer 5019A-12TN4 (Intel Atom + C3850) + + + + Silicom C3000 (Intel Atom 3558) + + + + + + +
+
+
\ No newline at end of file diff --git a/doc/eltf_params_updated_template_how_to_use.txt b/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..97b07aa --- /dev/null +++ b/doc/eltf_params_updated_template_how_to_use.txt @@ -0,0 +1,320 @@ +eltf_params_template_updated_howto_use.txt + +This is a way to collect all parameters for an Enea Edge release +in one parameter file, easy to automatically update by ELTF regularly. + +NOTE: Both the release info AND the open source books use parameters from + here, but the XML file is inside the release info book directory. + +NOTE: The manifest_conf.mk, or overridden by the environment variable + MANIFESTHASH, contains the full tag (or hashvalue) for downloading + the manifest when the books are built. The list of target + directories are fetched from the manifest into the book. + The eltf_params_updates.xml can all the time contain + the final next complete tag e.g. refs/tags/EL6 or similar + in the ELTF_PL_CLONE_W_REPO parameter command lines. + +The ordinary book XML files use xi:include statements to include elements +from this parameter file. The book XML files can thus be manually edited. +Before editing, you must run "make init". +Any other text in the template or updated.xml file, outside the parts that +are included in the book, are not used but still all must be correct +DocBook XML files. + +ELTF work: + template => ELTF replaces ALL ELTF_xxx variables => updated XML file + => push to git only if changed + + +eltf_params_template.xml (in git) + File used by ELTF to autocreate/update the real parameter + file eltf_params_updated.xml. + +eltf_params_updated.xml (in git) + Real parameter file where ELTF has replaced all ELTF_xx variables with + strings, in several cases with multiline strings. + No spaces or linefeed allowed in beginning or end of the variable values! + + +xi:include: Each parameter is xi:include'ed in various book files, using + the IDs existing in the parameter files. + In most cases the 1:st element inside an element with an ID is included + using a format like eltf-prereq-apt-get-commands-host/1. + In very few cases the element with the ID is included in the book, one + example is the target section which has an ID, but which contains + multiple subsections, one per target. + All IDs in a book must be unique. + +DocBook XML: All XML files must be correct DocBook XML files. + +Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes + not done by ELTF. But it is OK to open the real file in XMLmind to + check that the format is correct. + +ELTF should autocreate a temporary "real" file but only replace + and push the eltf_params_updated.xml if it is changed. + + +make eltf + This lists all ELTF_xxx variables and some rules how to treat them + +DocBook Format: All elements - rules: + Several strict generic XML rules apply for all strings: + 1. No TABs allowed or any other control chr than "linefeed" + 2. Only 7-bit ASCII + 3. Any < > & must be converted to < > and & + Similar for any other non-7-bit-ASCII but avoid those! + 4. No leading spaces or linefeeds when replacing the ELTF_* variable + 5. No trailing spaces or linefeeds when replacing the ELTF_* variable + 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. + +DocBook Format: - rules: ELTF*PL* variables + Several strict rules apply for the multiline string in programlisting + in addition to the general XML rules above: + 7. Max line length < 80 char + 8. Use backslash (\) to break longer lines + 9. Use spaces (e.g. 4) to indent continuation lines in programlistings + 10. No trailing spaces on any line + 11. No spaces or linefeed immediately after leading + 12. No spaces or linefeed before trailing + +DocBook Format: - rules: ELTF_*URL* variables + 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings + 14. Only if the URL is extremely long, the TXTURL can be a separate string + +Each target has one section with target parameters: +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + ..... with many ELTF_ variables .... +
+ + 15. If there is only one target. ELTF just replaces ELTF parameters + + 16. It there are multiple targets. ELTF copies the section and appends the + section the required number of times. + Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR + Each section title will become unique + +Tables with target parameters in each target section: + 17. It is possible for ELTF to append more rows with one parameter each + to these tables, because the entire tables are included in the book + +Special - NOT YET READY DEFINED how to handle the optionally included + Eclipse and its version, but this is a first suggestion: + 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string + with both version number and name, + 19. MANUALLY if Eclipse is NOT included in the release, + the release manager should manually set condition="hidden" on + the entire section in the book XML about Eclipse + + + +BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf +if there are more new variables, missing in this description file. + +_____________________________________________________________________________ +ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands + like sudo apt-get install xxxx or similar. + First line = comment with the complete host name! + It is possible to include multiple hosts by just + adding an empty line, comment with host name, etc. + xi:include eltf-prereq-apt-get-commands-host/1 + This is a ... + Example: +# Host Ubuntu 14.04.5 LTS 64bit +sudo apt-get update +sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + +_____________________________________________________________________________ +ELTF_PL_GET_REPO Multiline commands to download the repo tool + xi:include eltf-getting-repo-install-command/1 + This is a ... + Example: +mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + +_____________________________________________________________________________ +ELTF_EL_REL_VER General parameter string: The version of this Enea + NFV Access release. Major version and optional .Minor + Typically created from MAJOR and MINOR in enea.conf + MINOR in enea.conf is empty or contains a dot+minor + xi_include EneaEdge_REL_VER/1 + This is a X.x used in many places. + Examples: +6 + or +6.1 + +_____________________________________________________________________________ +ELTF_YOCTO_VER General parameter string: Yocto version, created + from DISTRO in poky.ent + xi:include Yocto_VER/1 + This is a X.x used in many places. + Example: +2.1 + +_____________________________________________________________________________ +ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created + from DISTRO_NAME_NO_CAP in poky.ent + xi:include Yocto_NAME/1 + This is a X.x used in many places. + Example: +krogoth + +_____________________________________________________________________________ +ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL +ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string + at the end, typically without "dot". + xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 + This is an ... + Example: +http://www.yoctoproject.org/downloads/core/krogoth/21 + +_____________________________________________________________________________ +ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings +ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where + Enea NFV Access can be downloaded + Often containing same version as in ELTF_EL_REL_VER + xi:include ULINK_ENEA_LINUX_URL/1 + This is an ... + Example: +http://linux.enea.com/6 + +_____________________________________________________________________________ +ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. + Use the variable $MACHINE/default.xml (the text in + the book will list the avaiable values of MACHINE, + taken from the manifest repository) + xi:include eltf-repo-cloning-enea-linux/1 + This is a ... + Example: +mkdir enea-linux +cd enea-linux +repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ + -b refs/tags/EL6 -m $MACHINE/default.xml +repo sync + +_____________________________________________________________________________ +ELTF_ECLIPSE_VERSION Optional general parameter string. + NOT YET READY DEFINED + Just now a release manage must manually set + condition="hidden" on the Eclipse section, + if Eclipse is not included in the release. + ELTF just replaces ELTF_ECLIPSE_VERSION with a full + string with "X.Y (name)" + It includes the ID and can only be ONCE in the book. + xi:include eltf-eclipse-version-row + Example. +4.5 (Mars) + + +_____________________________________________________________________________ +ELTF_T_* All these are in each target (MACHINE) and ELTF + must separately replace them with strings for + each target + NOTE: All (except the MANIFEST_DIR) are in rows + in a table and ELTF can select to append + more parameters by adding more rows + +_____________________________________________________________________________ +ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly +ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same + as the MACHINE names in $MACHINE/default.xml. + In book: a) Part of section ID + b) Part of section title + Examples: +p2041rgb + or +ls1021aiot + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_NAME Target specific: "Target Official Name" + NOT same as the target directory name in most cases. + In book: An element in a row + Examples: +P2041RGB + or +LS1021a-IoT + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_ARC_DESC Target specific: "Architecture and Description" + It can be a short identification string or + it can be a longer descriptive sentence. + In book: An element in a row + Examples: +Power, e500mc + or +ARM Cortex-A7 + +_____________________________________________________________________________ +ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These +ELTF_T_DS_URL two usually are IDENTICAL strings with correct + hyperlink to the target's official datasheet. + In book: an ... + Only if the link is VERY LONG, the text part shall + instead be a descriptive string (see 2:nd example). + NOTE: Also here no spaces or line-feeds! + Examples: +url="http://wiki.qemu.org">http://wiki.qemu.org +or +url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet + +_____________________________________________________________________________ +ELTF_T_POKY_VER Target specific: "Poky version" created either + from POKYVERSION in poky.ent + or using a hashvalue with a leading string, in + which case it may be different per target. + In book: An in a row + Examples: +15.0.0 +or +Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 + +_____________________________________________________________________________ +ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky + but not easy to find among various parameters. + ELTF would extract it from build logs building SDK + and it is possibly different per target. + In book: An in a row + Example: +5.3 + +_____________________________________________________________________________ +ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often + different per target. + In book: An in a row + Example: +3.12 + +_____________________________________________________________________________ +ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a + comma-separated list of driver names. + ELTF should create the list in same order for each + target, e.g. alphabetic migth be OK. + In book: An in a row + Example: +Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC + + +_____________________________________________________________________________ +ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading +ELTF_T_EL_RPM_URL RPM packages for this target". These two are + INDENTICAL strings with hyperlink to the web site + at Enea where the customer can download RPMs + Note: Often the ELFT_EL_REL_VER value and + the ELTF_T_MANIFEST_DIR are used in the link. + In book: an ... + Example: +url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm + +_____________________________________________________________________________ -- cgit v1.2.3-54-g00ecf From 9cdc42a5c4fab1e2e844424b06da8dc43d019436 Mon Sep 17 00:00:00 2001 From: mrpa Date: Tue, 13 Jul 2021 17:01:29 +0200 Subject: Replacing uCPE Manager, NFV Access and more where needed. Change-Id: Ib8579cc4da63e24fbceaa080d4b1843a6e9e224d Signed-off-by: mrpa --- doc/book-enea-edge-example-usecases/doc/appendix_4.xml | 2 +- .../doc/advanced_configurations.xml | 18 +++++++++--------- .../doc/installation_guide.xml | 6 +++--- .../doc/troubleshooting.xml | 2 +- doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | 16 ++++++++-------- doc/book-enea-edge-management-open-source/doc/README | 4 ++-- doc/book-enea-edge-runtime-open-source/doc/README | 6 +++--- .../doc/licenses.xml | 2 +- doc/book-enea-edge-telemetry-open-source/doc/README | 4 ++-- 9 files changed, 30 insertions(+), 30 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 f52e33d..4d30ff6 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml @@ -93,7 +93,7 @@ To run a test: > cd automation_framework/unittestSuite/ -> python unittestSuite.py -u admin -p admin -H <uCPEManager IP address> -n \ +> python unittestSuite.py -u admin -p admin -H <EneaEdgeManagement IP address> -n \ <uCPE Device name> -s <Test suite> -d <description> The Test suite must be one from any of the 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 c387e7f..bea8610 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -427,11 +427,11 @@ node0.1048576kB = 3 Extract Enea_Edge_Management_<version>-build<build_number>.tar.gz The directory in which the archive has been unpacked will be - denoted as: <uCPEM-installerdir>. + denoted as: <EEMg-installerdir>. - Enter <uCPEM-installerdir>/dist. + Enter <EEMg-installerdir>/dist. @@ -840,7 +840,7 @@ galera-4-26.4.6-1.el7.centos.x86_64 #wsrep_provider_options= # Logical cluster name. Should be the same for all nodes. -wsrep_cluster_name="ucpemanager" +wsrep_cluster_name="EneaEdgeManagement" # Group communication system handle wsrep_cluster_address="gcomm://192.168.10.11,192.168.10.12,..,192.168.10.16" @@ -945,11 +945,11 @@ Thanks for using MariaDB! Create the initial database and grant access to it: [root@localhost application]# mysql --host=localhost --user=root -p -MariaDB [(none)]> CREATE DATABASE ucpemanager CHARACTER SET='utf8' \ +MariaDB [(none)]> CREATE DATABASE EneaEdgeManagement CHARACTER SET='utf8' \ COLLATE='utf8_bin'; Query OK, 1 row affected (0.004 sec) -MariaDB [(none)]> GRANT ALL PRIVILEGES ON ucpemanager.* \ +MariaDB [(none)]> GRANT ALL PRIVILEGES ON EneaEdgeManagement.* \ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION; @@ -989,7 +989,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION; Management application, and run: [root@localhost distro]#./install.sh /opt/ \ -Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz +Enea_Edge_Management_<version>-build<build_number>.tar.gz 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 @@ -1008,12 +1008,12 @@ Creating database configuration file \ Done . … Installing ucpemanager service .. -Specify service username [ucpemanager]: -Specify service password [ucpemanager]: somepassword +Specify service username [EneaEdgeManagement]: +Specify service password [EneaEdgeManagement]: 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]: +Specify the name of the cluster [EneaEdgeManagement]: Specify the shared (virtual) cluster IP address: 192.168.10.10 Specify the netmask for the cluster IP address [255.255.255.0]: Specify the IP address of the (optional) arbiter: 192.168.10.13 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 b4324de..55cc867 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -479,12 +479,12 @@ userdel postgres Enea_Edge_Management_<version>-build<build_number>.tar.gz The directory in which the archive has been unpacked will be - denoted as: <uCPEM-installerdir>. + denoted as: <EEMg-installerdir>. Enter - <uCPEM-installerdir>/dist. + <EEMg-installerdir>/dist. @@ -695,7 +695,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzSystemBackup_MMMDD_YYYY_HHMM_SS.zip) is different from the snapshot obtained during an Enea Edge Management Upgrade or Uninstall operation - (ucpemanager-Backup-YYYYddMMHHmm.tar.gz) needed + (EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz) needed for recovery of the Enea Edge Management application. For more details, see Restoring a previous Enea Edge diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml index fcf991e..3145f32 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml @@ -96,7 +96,7 @@ If a working snapshot obtained during a previous Upgrade or Uninstall is available - (ucpemanager-Backup-YYYYddMMHHmm.tar.gz): + (EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz): Cleanup the current upgrade attempt with: 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 e213a0f..7c9c1f9 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml @@ -24,11 +24,11 @@ folder. The directory in which the archive has been unpacked will be - denoted as <uCPEM-installerdir>. + denoted as <EEMg-installerdir>. - Enter <uCPEM-installerdir>/dist. + Enter <EEMg-installerdir>/dist. @@ -54,7 +54,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzEneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz), which contains a snapshot of the existing installation in the - <uCPEM-installerdir>/dist directory. + <EEMg-installerdir>/dist directory. The snapshot file created during the upgrade can be used for @@ -104,7 +104,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz The directory in which the archive has been unpacked will be - denoted as <uCPEM-installerdir>. + denoted as <EEMg-installerdir>. @@ -112,11 +112,11 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzEneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz) created during a previous Enea Edge Management Upgrade or Enea Edge Management Uninstall Operation into the - <uCPEM-installerdir>/dist directory. + <EEMg-installerdir>/dist directory. - Enter <uCPEM-installerdir>/dist. + Enter <EEMg-installerdir>/dist. @@ -158,12 +158,12 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz Navigate to the folder where the Enea Edge Management application is unpacked: - <uCPEM-installerdir>. + <EEMg-installerdir>. Enter - <uCPEM-installerdir>/dist. + <EEMg-installerdir>/dist. diff --git a/doc/book-enea-edge-management-open-source/doc/README b/doc/book-enea-edge-management-open-source/doc/README index 1077acb..cb17733 100644 --- a/doc/book-enea-edge-management-open-source/doc/README +++ b/doc/book-enea-edge-management-open-source/doc/README @@ -1,4 +1,4 @@ -The licenses.xml in the git repository of Enea NFV Access Open Source Report -is the frozen version belonging to the last official release of Enea NFV Access. +The licenses.xml in the git repository of the Enea Edge Open Source Report +is the frozen version belonging to the last official release of Enea Edge. The contents must be generated from the release script to obtain the latest lists of packages and licenses. diff --git a/doc/book-enea-edge-runtime-open-source/doc/README b/doc/book-enea-edge-runtime-open-source/doc/README index 607ce67..6aeccc9 100644 --- a/doc/book-enea-edge-runtime-open-source/doc/README +++ b/doc/book-enea-edge-runtime-open-source/doc/README @@ -1,4 +1,4 @@ -The licenses.xml in the git repository of Enea NFV Access Runtime Platform Open Source Report -is the frozen version belonging to the last official release of Enea NFV Access. +The licenses.xml in the git repository of the Enea Edge Runtime Platform Open Source Report +is the frozen version belonging to the last official release of Enea Edge. The contents must be generated from the release script to obtain the latest -lists of packages and licenses. +lists of packages and licenses. \ No newline at end of file diff --git a/doc/book-enea-edge-runtime-open-source/doc/licenses.xml b/doc/book-enea-edge-runtime-open-source/doc/licenses.xml index 6f9aa06..45e6076 100644 --- a/doc/book-enea-edge-runtime-open-source/doc/licenses.xml +++ b/doc/book-enea-edge-runtime-open-source/doc/licenses.xml @@ -1786,7 +1786,7 @@ specific documentation.--> ntp-user-stub 1.0 - The NTP user/group were added in previous NFVA releases and are needed for OSTree upgrades to ensure backwards compatibility. + The NTP user/group were added in previous Enea Edge releases and are needed for OSTree upgrades to ensure backwards compatibility. Enea diff --git a/doc/book-enea-edge-telemetry-open-source/doc/README b/doc/book-enea-edge-telemetry-open-source/doc/README index 1077acb..e5cb471 100644 --- a/doc/book-enea-edge-telemetry-open-source/doc/README +++ b/doc/book-enea-edge-telemetry-open-source/doc/README @@ -1,4 +1,4 @@ -The licenses.xml in the git repository of Enea NFV Access Open Source Report -is the frozen version belonging to the last official release of Enea NFV Access. +The licenses.xml in the git repository of Enea Edge Open Source Report +is the frozen version belonging to the last official release of Enea Edge. The contents must be generated from the release script to obtain the latest lists of packages and licenses. -- cgit v1.2.3-54-g00ecf From 17504ce620c21f93902987fbd5532ae5d5052d02 Mon Sep 17 00:00:00 2001 From: Remus Turea Date: Mon, 19 Jul 2021 13:19:31 +0200 Subject: ELCCR-1807 Implement EdgeManagement support for DNS server list for wan interfaces Change-Id: I448af6ce2ae8edf33d4afc25f6f9e51fa1b62405 Signed-off-by: Remus Turea --- .../doc/images/edit_inter.png | Bin 9000 -> 10102 bytes .../doc/net_config_options.xml | 9 +++++---- 2 files changed, 5 insertions(+), 4 deletions(-) (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/book-enea-edge-getting-started/doc/images/edit_inter.png b/doc/book-enea-edge-getting-started/doc/images/edit_inter.png index fddde37..33015fa 100755 Binary files a/doc/book-enea-edge-getting-started/doc/images/edit_inter.png and b/doc/book-enea-edge-getting-started/doc/images/edit_inter.png differ 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 39ef10a..ffa0eb8 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,4 +1,4 @@ - + Network Configuration Options @@ -240,9 +240,10 @@ When changing the address-assignment from static to DHCP, if any of the ip-address, - netmask or gateway fields have - invalid values a validation error will be triggered. These fields - must be empty or have the valid values for their respective address + netmask, gateway or + dns-servers fields have invalid values a + validation error will be triggered. These fields must be empty or + have the valid values for their respective address assignment. -- cgit v1.2.3-54-g00ecf From 729309c771f257bf768260609d7c917417497658 Mon Sep 17 00:00:00 2001 From: mrpa Date: Tue, 20 Jul 2021 19:48:13 +0200 Subject: Updated the release notes main changes file and edited a path in the known issues and limitations. Change-Id: I920e4d8d042b00906471ca843c9b43b269ef9235 Signed-off-by: mrpa --- .../doc/installation_guide.xml | 2 +- .../doc/known_bugs_and_limitations.xml | 49 +++---- .../doc/main_changes.xml | 155 ++++++++++++++------- 3 files changed, 132 insertions(+), 74 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 2e1fe7e..53d883f 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -1188,7 +1188,7 @@ of=/dev/sdb bs=4M conv=fsync
- Basic operations for uCPE device Managememt + Basic operations for uCPE device Management When the uCPE device is connected to the Enea Edge Management application, it can be rebooted, the factory settings can be restored or 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 d6e04ce..08e3e0d 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 @@ -19,9 +19,9 @@ - ELCCR-527Canceling 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. + ELCCR-527Canceling 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. @@ -29,11 +29,11 @@ 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. + ELCCR-1134In order to avoid an incorrect boot + order after a failed upgrade, the user should remove the upgrade image + before attempting again. @@ -67,11 +67,11 @@ 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. + 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. @@ -85,9 +85,9 @@ - STCR-6224The 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 Framework and + Test Harness do not support multiple custom scripts uploaded to a uCPE + device at the same time. @@ -124,9 +124,10 @@ - ELCCR-1561Before starting an Enea Edge Management - upgrade, any owned Tomcat certificates should be manually copied into the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates + ELCCR-1565Before starting an Enea Edge Management + upgrade, any owned Tomcat certificates should be manually copied into + the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/certificates folder. @@ -136,14 +137,14 @@ 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-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-1468When using the Enea Edge Management application in HTTPS mode, upgrading a device from NFV Access 2.3.0 is @@ -171,4 +172,4 @@ - + \ No newline at end of file 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 63e2c47..c686278 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml @@ -15,60 +15,58 @@ - CPDX-3496Embedded Wi-Fi support for all-in-one - store/home office deployment. For more details please see the Wap Interface Type in the - Manual. + Support for Fully Qualified Domain Names (FQDN) for the Enea Edge + Management application address. For more details + please see Preparing the Deployment in the + Manual. - CPDX-3499Expanded hardware, OS and network - monitoring capability with Grafana integration. For more details - please see Using Grafana and InfluxDB in the - Manual. + Support for a DNS servers list in the case of + static WAN interfaces, to resolve the FQDN used by the Enea Edge Management + application. For more details please + see Installing Enea Edge - uCPE Device Installation + in the + Manual. - CPDX-3407HTTPS based downloads of VNFs for - simplified deployment of the Enea Edge Management application in cloud - environments. For more details please see Fresh Installation of the Enea Edge - Management application in the + Support for NFV Infrastructure backup and restore to allow for recovery + to a previously known state. For more details please see NFV Infrastructure Backup Operations + in the Manual. - 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. For more details please see the . + Support for VNF snapshotting to allow for storing, managing and + restoring snapshots of VNFs deployed on Enea Edge Runtime. For more details + please see VNF Snapshots + in the Manual. + + - - The Enea Edge Automation Framework and Test Harness, and its - related documentation the and - the - are deprecated starting with Enea Edge 2.4.0. - + + Support for a Factory Reset to allow reverting of the Enea Edge Runtime + to its initial state. For more details please see Basic operations for uCPE device Management + in the Manual. @@ -76,18 +74,77 @@ - A new Requirements page has - been added to the Web-installer, displaying device characteristics and - checking minimal hardware requirements. + Added support for uploading multiple custom scripts on a uCPE Device + in the Enea Edge Automation framework. + + + + Python APIs from the Enea Edge Automation framework can now be run + with a limited set of optional parameters. + + + + Configuration files from the Enea Edge Automation framework can now + be generated in a non-interactive way with a limited set of optional + parameters. + + + + The Enea Edge Management application represents the new name for + the uCPE Manager component. + + + + Improved support for large deployments of Enea Edge: addressed + possible connectivity issues, added call-home tuning + parameters. + + + + Increased the wait time from 5 minutes to 10 minutes after an + Enea Edge Runtime upgrade. + + + + Improved the upgrade and uninstall processes of the Enea Edge + Management component: the database information is no longer requested + during an upgrade or an uninstall. + + + + Improved the Events feature by discarding logging of the + NetconfSessionStart and the + NetconfSessionEnd notifications. - A Web-installer's log is displayed on the last page in case the - installation process has failed. + Enea Edge Runtime key component upgrades include: + + + Linux kernel 5.10 + + + + Open vSwitch 2.15 + + + + QEMU 5.2.0 + + + + libvirt 6.3.0 + + + + DPDK 2.11.0 + + - Extended Web-installer support for NVME disks. + Python3 (v3.9.4) replaced Python2 support in Enea Edge + Runtime. -- cgit v1.2.3-54-g00ecf From 86de8ca3c33a2283f87dfe8e72ad09055613d9ff Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 21 Jul 2021 11:28:17 +0200 Subject: Updated the factory reset script location in the troubleshooting chapter. Change-Id: I9cb54d956dd5ae0f653e6ad8ac6e1b70de6ef425 Signed-off-by: mrpa --- doc/book-enea-edge-getting-started/doc/troubleshooting.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml index 3145f32..299e183 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml @@ -164,7 +164,7 @@ Connect to the uCPE Device console and run the factory reset script: - /usr/local/odm/bin/factory_reset.sh + /usr/enea/odm/bin/factory_reset.sh -- cgit v1.2.3-54-g00ecf From 1a395f626e889b189e6abf5bf19d02aef029a57a Mon Sep 17 00:00:00 2001 From: mrpa Date: Thu, 22 Jul 2021 13:50:05 +0200 Subject: Removed internal information from the Getting Started Manual. Change-Id: I77ace637dc9dc1aa65c91e4cc9433f47004d38ea Signed-off-by: mrpa --- .../doc/advanced_configurations.xml | 58 ++++++++++------------ doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 4 -- 2 files changed, 27 insertions(+), 35 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 84b70ec..ff77f03 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -486,15 +486,15 @@ node0.1048576kB = 3 NFVi Snapshotting To perform a snapshot (a backup of the current state) of the NFVi, - perform the following steps in the Enea Edge Management application: + perform the following steps in the Enea Edge Management + application: Select the uCPE device, access the Configuration menu, and select NFVI Backup. The NFVI Config Archive Table will be - shown. + role="bold">NFVI Backup. The NFVI + Config Archive Table will be shown. @@ -504,19 +504,18 @@ node0.1048576kB = 3 Edit the default file name, if needed, and press the Create button. The current window will - close and the success message Created + role="bold">Create button. The current window will close + and the success message Created successfully will be shown. - A new entry will be added in the NFVI - Config Archive Table and the BackupArchiveCreated event can be seen by acessing - the Fault menu and triggering the - Events window. The backup - file will be created on the uCPE device in the - /var/odm/backup/ folder. + A new entry will be added in the NFVI Config + Archive Table and the BackupArchiveCreated event can be seen by + acessing the Fault menu and triggering + the Events window. The backup + file will be created on the uCPE device.
@@ -529,9 +528,8 @@ node0.1048576kB = 3 Select the uCPE device, access the Configuration menu and select NFVI Backup. The NFVI Config Archive Table will be - shown. + role="bold">NFVI Backup. The NFVI + Config Archive Table will be shown. @@ -540,25 +538,25 @@ node0.1048576kB = 3 - Press the Restore button - and Confirm the action. + Press the Restore button and + Confirm the action. A success message will be shown in the same window: Restored NFVI configuration. Two events will - appear in the Events window (accesible - through the Fault menu): - Restore started and - Restore complete. + appear in the Events window (accesible + through the Fault menu): Restore started and Restore + complete. When restoring an NFVi backup, connectivity with the uCPE device may be lost for a period of time. After a successful restoration the connection with the device will be restored. Any saved custom scripts of type once-before-startup or - once-after-startup will be re-executed as part - of the NFVi restore process. + once-after-startup will be re-executed as part of + the NFVi restore process.
@@ -570,11 +568,10 @@ node0.1048576kB = 3 - Select the uCPE device, access the - Configuration menu, and select - NFVI Backup. The NFVI Config Archive Table will be - shown. + Select the uCPE device, access the Configuration menu, and select NFVI Backup. The NFVI + Config Archive Table will be shown. @@ -590,8 +587,7 @@ node0.1048576kB = 3 A success message will be shown in the same window: NFVI configuration backup deleted. The backup - file will be deleted from the uCPE device (from the - /var/odm/backup/ folder), and the table will be + file will be deleted from the uCPE device and the table will be updated. 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 d1b6f08..c820f2a 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -571,10 +571,6 @@ close after a few seconds and a new entry will be shown in the VM Snapshot Table on <device-name (IP)>. - - On the uCPE device, the snapshot file will be created under - /var/odm/vm_images/snapshots/{vm-id}/ (e.g: - /var/odm/vm_images/snapshots/e1b165f0-2590-11eb-be3a-525400070d85/). -- cgit v1.2.3-54-g00ecf From c31a9e745421874761889c467d2fdd635e27c1ef Mon Sep 17 00:00:00 2001 From: Dragos Ciprian Nedelcu Date: Mon, 26 Jul 2021 10:26:21 +0200 Subject: Correct minimum requirements for uCPE device RAM Change-Id: Iec0d8c45e2e749d3f403b08a1328ed8aa270a332 Signed-off-by: Dragos Ciprian Nedelcu --- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 53d883f..b68a6c4 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -92,7 +92,7 @@ One or more uCPE devices. Whitebox devices where the Enea Edge Runtime will be installed, - containing a minimum of 2 cores and 4 GB RAM and at least two ethernet + containing a minimum of 2 cores and 2 GB RAM and at least two ethernet ports that will be configured as WAN and LAN during deployment. When hosting an entire solution including one or several network @@ -1253,4 +1253,4 @@ of=/dev/sdb bs=4M conv=fsync - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From e112d581beb8b4127dc587d8fd0be2767f097c1d Mon Sep 17 00:00:00 2001 From: mrpa Date: Tue, 27 Jul 2021 21:36:51 +0200 Subject: Updated the Automation User Guide and Getting Started Manuals with the edits needed and uniformization of installerdir terms. Change-Id: I3b2742eda5798c0116847239ce89e30f57a545a6 Signed-off-by: mrpa --- .../doc/automation_framework_test_harness.xml | 14 +- .../doc/components.xml | 195 +++++++++++---------- .../doc/getting_started.xml | 8 +- .../doc/overview.xml | 50 ++++-- .../doc/installation_guide.xml | 33 ++-- .../doc/log_collector.xml | 4 +- .../doc/troubleshooting.xml | 2 +- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 22 +-- 8 files changed, 174 insertions(+), 154 deletions(-) (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml index bdc3343..0d25bd7 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml @@ -76,10 +76,10 @@ - Where the environment_variables.sh script - sets the environment variables. The - setup_env_requirements.txt contains the mapping - between the package name and its version, and the + The environment_variables.sh script sets the + environment variables, the + setup_env_requirements.txt file contains the + mapping between the package name and its version, and the setup_env.sh script creates a testing virtual environment. @@ -317,7 +317,7 @@ - Update the username, password and IP address + Update the username, password and IP address or FQDN. The @@ -751,7 +751,7 @@ Check 'test' directory for JSON configuration files The Automation Framework scripts described in the following section are located in the - <Automation-installdir>/automation_framework + <Automation-installerdir>/automation_framework directory.
@@ -1302,7 +1302,7 @@ Parameters(not needed): -- Test Harness The Test Harness sources are in the - <Automation-installdir>/test_harness + <Automation-installerdir>/test_harness directory.
diff --git a/doc/book-enea-edge-automation-user-guide/doc/components.xml b/doc/book-enea-edge-automation-user-guide/doc/components.xml index cb6c783..2323fdf 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/components.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/components.xml @@ -1,8 +1,9 @@ - + Components - This chapter presents an overview of the Enea Edge components: Enea Edge Runtime, Enea Edge Management and Enea Edge Automation. + This chapter presents an overview of the Enea Edge components: Enea + Edge Runtime, Enea Edge Management and Enea Edge Automation.
Component Overview @@ -15,97 +16,101 @@
-
- Enea Edge Management - - The Enea Edge Management application is installed on a supported - platform. It manages Enea Edge devices, that - are virtualized CPE devices. - - For more details about Enea Edge Management installation, see Installing the Enea Edge Management application in the - - Manual. -
- -
- Enea Edge Runtime - - One or more uCPE devices running the Enea Edge Runtime - are required as hosts, to run the VNFs. 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, the uCPE devices have to be added to the Enea Edge Management application. - - Adding a VcpeAgent device can be done: - - - - using the Enea Edge Management GUI - - - - using REST API - - - - For more details about Enea Edge installation, see Preparing the USB stick for installation of the - Edge Runtime in the - Manual. -
- -
- Enea Edge Automation - - Enea Edge Automation has two components: Automation Framework and Test Harness. - It provides Python scripts using Enea Edge Management REST API and Ansible Playbooks. - - The Automation Framework component provides a Python unit-test suite that runs automatically the - test-cases defined for each Python script. - - It is recommended to use a different host for running the tests, in - order to allow external users to access and use the Enea Edge Management application - effectively. - - The Test Harness component provides a way for driving configuration with - Ansible Playbooks, by running the Python modules from the Automation Framework component - and by direct connection over SSH to the boards that run Enea - Edge. - - The Test Harness includes an automated test suite that - contains: - - - - VNF, Device and Network Smoke Test Cases. A sample test suite - that acts as basic smoke tests for Enea Edge and also as a - sanity-check test suite for the Enea Edge Automation. - - - - VNF Deployment and Lifecycle. A sample test suite that verifies - the instantiation, lifecycle control and destruction of a VNF for Enea - Edge. - - - - Service Creation and Lifecycle. A sample test suite that - contains complex test cases showcasing service creation and lifecycle - management. - - - - For more details about the test suites or test cases, see the README - file included in the test scenario folders from the Enea Edge Automation - archive. -
+
+ Enea Edge Management + + The Enea Edge Management application is installed on a supported + platform. It manages Enea Edge devices, that are + virtualized CPE devices. + + For more details about Enea Edge Management installation, see Installing the Enea Edge Management + application in the + Manual. +
+ +
+ Enea Edge Runtime + + One or more uCPE devices running the Enea Edge Runtime are required + as hosts, to run the VNFs. 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, the uCPE + devices have to be added to the Enea Edge Management application. + + Adding a VcpeAgent device can be done: + + + + using the Enea Edge Management GUI + + + + using REST API + + + + For more details about the Enea Edge Runtime installation, see + Preparing the USB stick for installation of the + Edge Runtime in the + Manual. +
+ +
+ Enea Edge Automation + + Enea Edge Automation has two components: Automation Framework and + Test Harness. It provides Python scripts using Enea Edge Management REST + API and Ansible Playbooks. + + The Automation Framework component provides a Python unit-test suite + that runs automatically the test-cases defined for each Python + script. + + It is recommended to use a different host for running the tests, in + order to allow external users to access and use the Enea Edge Management + application effectively. + + The Test Harness component provides a way for driving configuration + with Ansible Playbooks, by running the Python modules from the Automation + Framework component and by direct connection over SSH to the boards that + run Enea Edge. + + The Test Harness includes an automated test suite that + contains: + + + + VNF, Device and Network Smoke Test Cases. A sample test suite + that acts as basic smoke tests for Enea Edge and also as a + sanity-check test suite for the Enea Edge Automation. + + + + VNF Deployment and Lifecycle. A sample test suite that verifies + the instantiation, lifecycle control and destruction of a VNF for Enea + Edge. + + + + Service Creation and Lifecycle. A sample test suite that + contains complex test cases showcasing service creation and lifecycle + management. + + + + For more details about the test suites or test cases, see the README + file included in the test scenario folders from the Enea Edge Automation + archive. +
\ No newline at end of file diff --git a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml index c5b9568..536cea6 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml @@ -189,7 +189,7 @@ - cd <Automation-installdir> + cd <Automation-installerdir> @@ -222,13 +222,13 @@ Activate the Python virtual environment - source <Automation-installdir>/testHarness-venv/bin/activate + source <Automation-installerdir>/testHarness-venv/bin/activate Optionally, check the History Information - vi <Automation-installdir>/CHANGELOG + vi <Automation-installerdir>/CHANGELOG @@ -251,7 +251,7 @@ - cd <Automation-installdir> + cd <Automation-installerdir> diff --git a/doc/book-enea-edge-automation-user-guide/doc/overview.xml b/doc/book-enea-edge-automation-user-guide/doc/overview.xml index 30cc91f..78e5e82 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/overview.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/overview.xml @@ -1,24 +1,26 @@ - + Overview - This document describes the Enea Edge Automation for Enea Edge, - along with instructions regarding the necessary steps to run these software + This document describes the Enea Edge Automation for Enea Edge, along + with instructions regarding the necessary steps to run these software tools.
Description - The Enea Edge Automation complements the Enea Edge Management - GUI and uses the northbound REST APIs, given to provide full usability of - the Enea Edge Management features. - - The Enea Edge Automation includes an Automation Framework (AF) component, providing a way for driving - configuration with Python scripting, and a Test Harness (TH) component, based on Ansible Playbooks to complete different test - cases. - - The Test Harness makes use of the Automation Framework Python modules and/or - direct commands on the uCPE devices running the Enea Edge Runtime. + The Enea Edge Automation complements the Enea Edge Management GUI + and uses the northbound REST APIs, given to provide full usability of the + Enea Edge Management features. + + The Enea Edge Automation includes an Automation Framework (AF) + component, providing a way for driving configuration with Python + scripting, and a Test Harness (TH) component, based on Ansible Playbooks + to complete different test cases. + + The Test Harness makes use of the Automation Framework Python + modules and/or direct commands on the uCPE devices running the Enea Edge + Runtime.
@@ -41,21 +43,29 @@ Enea Edge + Enea NFVI software platform. + Enea Edge Runtime - A lightweight, multi-architecture virtualization platform, supporting Virtual Machines. + + A lightweight, multi-architecture virtualization platform, + supporting Virtual Machines. + Enea Edge Management + Enea Universal Customer Premises Equipment Manager. + Enea Edge Automation - Enea Edge framework for automated deployment and testing. - + Enea Edge framework for automated deployment and + testing. + @@ -99,6 +109,12 @@ Data Plane Development Kit. + + FQDN + + Fully Qualified Domain Name. + + FTP @@ -186,4 +202,4 @@
- + \ 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 b68a6c4..a61e385 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -495,8 +495,8 @@ userdel postgres installation folder. The application files will be installed in - /opt/ems/ucpemanager/application. The - database will be installed in + /opt/ems/ucpemanager/application. The database + will be installed in /opt/ems/ucpemanager/database. @@ -636,13 +636,11 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz Install the Enea Edge Management application as a - service with the name - ucpemanager. + service with the name ucpemanager. - Start the ucpemanager - service. + Start the ucpemanager service. @@ -679,8 +677,8 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzSystem menu, and clicking System Backup, from the Enea Edge Management GUI. The resulting zip archive will be located in the - /opt/ems/ucpemanager/application/backup - folder and will be named + /opt/ems/ucpemanager/application/backup folder + and will be named SystemBackup_MMMDD_YYYY_HHMM_SS.zip (e.g System-Backup_Feb19_2013_2257_42.zip). Save the archive to another location outside the Enea Edge Management installation folder for @@ -691,9 +689,9 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzSystemBackup_MMMDD_YYYY_HHMM_SS.zip) is different from the snapshot obtained during an Enea Edge Management Upgrade or Uninstall operation - (EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz) needed - for recovery of the Enea Edge Management application. For more - details, see EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz) + needed for recovery of the Enea Edge Management application. For + more details, see Restoring a previous Enea Edge Management installation in the
Preparing Physical Deployment for Installation -
+
Preparing for Hardware Installation @@ -917,9 +915,10 @@ of=/dev/sdb bs=4M conv=fsync - Connect the WAN cable to the uCPE device (see Figure 2). This - will be used as the uCPE management network interface, as described - below. + Connect the WAN cable to the uCPE device (see Figure 2.1 Preparing for Hardware + Installation). This will be used as the uCPE management + network interface, as described below. @@ -963,7 +962,7 @@ of=/dev/sdb bs=4M conv=fsync
Preparing Physical Deployment for Execution -
+
Preparing for Deployment Execution @@ -1253,4 +1252,4 @@ of=/dev/sdb bs=4M conv=fsync
- + \ No newline at end of file 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 d7d99dd..ea99c9b 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml @@ -341,7 +341,7 @@ 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 application's installation folder @@ -394,7 +394,7 @@ Log collection from uCPE Devices can also be done when there is no 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/. + Device file system in /usr/enea/. The Log collector script takes relevant information about the system and collects it in an archive: diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml index 299e183..0e6322f 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml @@ -54,7 +54,7 @@ - The uCPE Device cannot boot after an upgrade. + The uCPE device cannot boot after an upgrade. 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 c820f2a..4586a96 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -210,9 +210,8 @@ Management application. - CAUTION: The user MUST save and use the same order for the - virtual interfaces during both the onboarding and instantiation - phases. + The user MUST save and use the same order for the virtual + interfaces during both the onboarding and instantiation phases. Cloud Init Tab @@ -534,9 +533,8 @@ (snapshotting) and restoring a VNF context on the uCPE device using the Enea Edge Management application. - It is assumed the uCPE device referenced already contains at least - one instantiated VNF, added into the Edge Management application and is - connected. + The uCPE devices should be connected to the Enea Edge Management + application and should have at least one VNF instantiated.
VNF Live Snapshot @@ -591,7 +589,7 @@ Select a virtual machine and press the Snapshots.. button. The Snapshots button. The VM Snapshot Table on <device-name> (IP) window will open. @@ -640,11 +638,13 @@ A success message will be shown in the same window: - Snapshot deleted. The snapshot file will be deleted - from the uCPE device and the table will be updated. + Snapshot deleted. The snapshot file will be deleted + from the uCPE device and the table will be updated. - Deleting a VNF instance automatically deletes all snapshots - associated with it. + + Deleting a VNF instance automatically deletes all snapshots + associated with it. +
\ No newline at end of file -- cgit v1.2.3-54-g00ecf From c234fdb31b31a5b81a8bae546a9a051a7ece4f9b Mon Sep 17 00:00:00 2001 From: Matei Valeanu Date: Thu, 29 Jul 2021 17:50:31 +0200 Subject: Add interface static mode description Change-Id: Ib5a8156057391cbe003bc07a1b8efe1106070035 Signed-off-by: Matei Valeanu --- .../doc/installation_guide.xml | 29 +++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 a61e385..23eef5f 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -933,8 +933,31 @@ of=/dev/sdb bs=4M conv=fsync - Plug-in additional WAN interfaces (if applicable) and - provide their Layer 3 configuration. + Plug in additional WAN interfaces (if applicable) and + provide their Layer 3 configuration. An interface can be + configured in dhcp or + static mode. When configured in static + mode, the following options are available: + + + + Static IP (mandatory) + + + + Netmask (mandatory) + + + + Gateway (mandatory) + + + + DNS Server List (a comma separated list of IPv4 + addresses) (optional). If left empty it will use the + Gateway as the DNS, with 1.1.1.1 as fallback. + + @@ -1252,4 +1275,4 @@ of=/dev/sdb bs=4M conv=fsync
- \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From 20d800859c2e1643f31388d5529d8776b00e7dd0 Mon Sep 17 00:00:00 2001 From: Toma Bilius Date: Mon, 2 Aug 2021 12:07:52 +0300 Subject: ELCCR-1897 VNF state is not preserved when restoring NFVi snapshots. Change-Id: Ica58612acde1415baa4fd2d359c93aab33feb8da Signed-off-by: Toma Bilius --- .../doc/advanced_configurations.xml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 ff77f03..997663b 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -514,8 +514,8 @@ node0.1048576kB = 3 Archive Table and the BackupArchiveCreated event can be seen by acessing the Fault menu and triggering - the Events window. The backup - file will be created on the uCPE device. + the Events window. The backup file will + be created on the uCPE device.
@@ -558,6 +558,11 @@ node0.1048576kB = 3 once-after-startup will be re-executed as part of the NFVi restore process. + + When restoring an NFVi backup all VNF instances will be removed. + Instances that were present at the moment the backup was taken will be + restored to their initial state, as if newly created. All snapshots + associated with previously instantiated VNFs will be deleted.
-- cgit v1.2.3-54-g00ecf From 17030b4667b712bf3defca9f60afe5eb43960af4 Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 4 Aug 2021 15:02:58 +0200 Subject: Generalized typo fixing for hunspell. Change-Id: I5f3c8d03ae336157aac6c745dff043bfd1132c62 Signed-off-by: mrpa --- .../doc/automation_framework_test_harness.xml | 6 +++--- .../doc/getting_started.xml | 4 ++-- doc/book-enea-edge-example-usecases/doc/appendix_4.xml | 4 ++-- doc/book-enea-edge-example-usecases/doc/appendix_5.xml | 2 +- .../doc/enea_test_vnf_examples.xml | 2 +- .../doc/service_chaining_128t_fortigate.xml | 2 +- .../doc/vnf_chaining.xml | 2 +- .../doc/advanced_configurations.xml | 18 +++++++++--------- .../doc/installation_guide.xml | 2 +- .../doc/introduction.xml | 4 ++-- .../doc/log_collector.xml | 6 +++--- .../doc/net_config_options.xml | 8 ++++---- doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | 2 +- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 8 ++++---- 14 files changed, 35 insertions(+), 35 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 9f6e64f..555a287 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 @@ -45,7 +45,7 @@ ignored. In the following script examples, Enea Edge Management - is reffered as Enea uCPE + is referred as Enea uCPE Manager. @@ -2801,14 +2801,14 @@ Options: The /lab_config directory stores the JSON configuration files related to a device (devices, NICs and bridges) as - well as sample custom scripts. Each subfolder should be named exactly like + well as sample custom scripts. Each sub-folder should be named exactly like the device name and should contain all the related configuration files needed for the test cases to be run on it. The /vnf_config directory stores the configuration files related to a VNF Descriptor and VNF instances. Typically these include a VNF Image JSON, VNF Instance JSON, VNF license - and any other files required by the type of the VNF. Each subfolder should + and any other files required by the type of the VNF. Each sub-folder should be named exactly like the name of the VNF Descriptor and should contain all the related configuration files needed for test cases to be run using this VNF. 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 255138b..599a523 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 @@ -51,7 +51,7 @@ fileref="images/environment_basicsetup.png" /> - The following enviroment setup is needed for running all tests + The following environment setup is needed for running all tests defined in the <AF-THinstall-dir> directory. Subsequent use of the installation requires activating the Python - virtual enviroment before using the Enea Edge Automation Framework and + virtual environment before using the Enea Edge Automation Framework and Test Harness: source <AF-TH-install-dir>/testHarness-venv/bin/activate. 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 4d30ff6..f554b37 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml @@ -40,7 +40,7 @@ | | |---centos_128t_internet_ci.iso - 128T cloud init (day-0) iso image. | |---fortigate | | |---fg_basic_fw.conf - Fortigate day-0 configuration. -| | |---fortigateInstance.json - Fortigate instantiantion. +| | |---fortigateInstance.json - Fortigate instantiation. | | |---fortigate.json - Fortigate onboarding. | | |---fortigateLicense.lic - Fortigate license - contact Fortinet to get a VNF image and license file. @@ -77,7 +77,7 @@ - Before starting the two usecases detailed in the following appendix, + Before starting the two use-cases detailed in the following appendix, the uCPE Device needs to be added into the Enea Edge Management application. 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 abb4be8..ac09bda 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_5.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_5.xml @@ -3,7 +3,7 @@ Example Tests Results using the Automation Framework and Test Harness - In order to run the following example usecases, certain configuration + In order to run the following example use-cases, certain configuration file entries need to be modified according to the network setup that it will be used, for more details see the previous appendix: 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 0c3815e..846ec86 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 @@ -272,7 +272,7 @@ tail -f /var/log/testpmd-out Make sure that neither uCPE device 1 nor uCPE device 2 have - any configured host interfaces by selcting uCPE device : + any configured host interfaces by selecting uCPE device : Configuration -> OpenVSwitch -> Host Interfaces. 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 4529fbf..1412d68 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 @@ -10,7 +10,7 @@ Prerequisites The 128T router and the Fortinet firewall in a service chain require - the following prequisites for this example use case: + the following prerequisites for this example use case: 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 affbf39..0df2605 100644 --- a/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml +++ b/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml @@ -394,7 +394,7 @@ disable type: physical netflow-sampler: disable sflow-sampler: disable Since Fortigate VNF, which is acting as router and firewall, is configured to be the DHCP server for the LAN network, the device interface connected to the uCPE LAN port has to be configured to get - dinamically assigned IPs. These IPs are in the 172.0.0.0/24 network for + dynamically assigned IPs. These IPs are in the 172.0.0.0/24 network for Site1 and the 172.10.10.0/24 network for Site2. Therefore, site-to-site connectivity can be checked (from Site1) as such: 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 997663b..992a629 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -120,7 +120,7 @@ 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 + formatting and partitioning the drive. The default behavior is to proceed automatically without any user interaction. @@ -513,9 +513,9 @@ node0.1048576kB = 3 A new entry will be added in the NFVI Config Archive Table and the BackupArchiveCreated event can be seen by - acessing the Fault menu and triggering - the Events window. The backup file will - be created on the uCPE device. + accessing the Fault menu and triggering + the Events window. The backup + file will be created on the uCPE device.
@@ -545,7 +545,7 @@ node0.1048576kB = 3 A success message will be shown in the same window: Restored NFVI configuration. Two events will - appear in the Events window (accesible + appear in the Events window (accessible through the Fault menu): Restore started and Restore complete. @@ -602,7 +602,7 @@ node0.1048576kB = 3 Availability Mode The following describes the setup needed for running the Enea Edge - Management application in High Availabilty (HA) mode, with a MariaDB + Management application in High Availability (HA) mode, with a MariaDB database cluster. A setup example is illustrated in the diagram below. @@ -626,7 +626,7 @@ node0.1048576kB = 3 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. + elected primary (from one of the backups) will re-spawn 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 @@ -1104,7 +1104,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;
Installing the Enea Edge Management application in High - Availabilty mode + Availability mode These steps must be taken on each of the CentOS 7 machines that will host the Enea Edge Management application. It will be installed @@ -1198,7 +1198,7 @@ Configuration complete.
Upgrading a High Availability Deployment - Upgrading a High Availabilty deployment is a highly complex, + Upgrading a High Availability deployment is a highly complex, multi-step process that requires care to ensure both consistency and high-availability. Some steps need to be done manually. 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 23eef5f..76463f0 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -909,7 +909,7 @@ of=/dev/sdb bs=4M conv=fsync be entered here (if needed), are the tag(s) specified when 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. + by re-installing the uCPE devices. diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml index eaa5521..8f1e854 100644 --- a/doc/book-enea-edge-getting-started/doc/introduction.xml +++ b/doc/book-enea-edge-getting-started/doc/introduction.xml @@ -62,7 +62,7 @@ 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 + hardware footprint, by only providing relevant functionalities and technologies. Virtualization methods include Virtual Machines (KVM / QEMU) and @@ -70,7 +70,7 @@ 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 + management and FCAPS are provided through the YANG-modeled NETCONF protocol.
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 ea99c9b..3499978 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml @@ -340,7 +340,7 @@ 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). + issues with the uCPE device and error pop-ups). Enea Edge Management log files are located in application/logs/ in the Enea Edge Management @@ -364,8 +364,8 @@ - A new (blank) popup window opens and the file is downloaded - locally. This popup can be closed after the download. + A new (blank) pop-up window opens and the file is downloaded + locally. This pop-up can be closed after the download. 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 ffa0eb8..ed8674d 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 @@ -218,8 +218,8 @@ In order to edit an already configured interface, (as in the - example popup shown below, a WAN interface) double click on the - desired one and a popup will appear. A different popup appears for + example pop-up shown below, a WAN interface) double click on the + desired one and a pop-up will appear. A different pop-up appears for each type of interface. From the Host Interface window, a user can change the networking type and the IP address assignment: @@ -271,7 +271,7 @@ In order to edit an already configured interface, (as in the - example popup shown below, a WAP interface) double click on the + example pop-up shown below, a WAP interface) double click on the desired one and a pop-up will appear. A different pop-up appears for each type of interface. From the Host Interface window, the following parameters are @@ -386,7 +386,7 @@ There are three types of bridges which can be created, each one - fulfiling a different role. + fulfilling a different role.
uCPE In-band Management bridge 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 7c9c1f9..79acd9d 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml @@ -470,7 +470,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gzThe status of the installation and upgrade can be viewed in the Upgrade Operations tab. Ongoing or - scheduled upgrade operations can be viewed or cancelled. + scheduled upgrade operations can be viewed or canceled. To view the status of an installation or upgrade operations 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 4586a96..628ff76 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -10,7 +10,7 @@ Onboarding a VNF The onboarding of a VNF means adding it to the Enea Edge Management - application VNF Catalogue and preparing it for instantiation (deployment + application VNF Catalog and preparing it for instantiation (deployment on connected uCPE devices). This is accomplished using the Enea Edge Management Onboarding graphical user interface. @@ -227,7 +227,7 @@ To onboard a VNF you must specify the Cloud-Init Datasource that the VNF uses. This information is procured from the VNF Vendor. Choose one of the following methods to specify - the datasource: + the data-source: @@ -319,7 +319,7 @@ - The last three properties are useful in conjuction with the + The last three properties are useful in conjunction with the vnfMgmt bridge type. They allow the user to map the internal VNF management port to an external port, useful for VNF configuration from WAN. @@ -565,7 +565,7 @@ Change the file name, if needed, and press the Create button. The current popup window will + role="bold">Create button. The current pop-up window will close after a few seconds and a new entry will be shown in the VM Snapshot Table on <device-name (IP)>. -- cgit v1.2.3-54-g00ecf From 09a284503deb0ba7725132b7262475ee4f4dc6a1 Mon Sep 17 00:00:00 2001 From: Remus Turea Date: Thu, 5 Aug 2021 09:24:56 +0200 Subject: ELCCR-1771 Behavior for custom scripts is not documented properly Change-Id: Ia5273d81e60ae1d97f7a9ecfd980460ecdcfe2b7 Signed-off-by: Remus Turea --- .../doc/net_config_options.xml | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 ed8674d..7238fef 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 @@ -219,8 +219,8 @@ In order to edit an already configured interface, (as in the example pop-up shown below, a WAN interface) double click on the - desired one and a pop-up will appear. A different pop-up appears for - each type of interface. From the Host + desired one and a pop-up will appear. A different pop-up appears + for each type of interface. From the Host Interface window, a user can change the networking type and the IP address assignment: @@ -652,10 +652,15 @@ Custom Scripts for Custom Networking Configurations The custom scripts feature allows users to execute user-defined - scripts on the uCPE device at various times.This allows for more flexible + scripts on the uCPE device at various times. This allows for more flexible and advanced configurations such as a LTE modem configuration, advanced network configurations or OVS flow rule programming at any time. + + In the current Enea Edge Management application version custom + scripts are not supported as part of the offline config. + +
Uploading Scripts @@ -721,6 +726,16 @@ role="bold">Send. + + + If two scripts are uploaded one at a time, the Enea Edge + Management application will delete the first script already added from + the device and apply the new one. In order for both scripts to be available on + the device, both scripts must be uploaded at once. + + If multiple custom scripts of the same type are uploaded at the + same time, they are executed in alphabetical order. +
-- cgit v1.2.3-54-g00ecf From efa870626e74a5514fd1fa17087f330a4b0110c8 Mon Sep 17 00:00:00 2001 From: Matei Valeanu Date: Thu, 5 Aug 2021 13:04:41 +0200 Subject: Replace machine with processor Change-Id: I637fc41bdf01fba297572801a8a89bc6ccd95d19 Signed-off-by: Matei Valeanu --- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 76463f0..940fc40 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -751,11 +751,11 @@ sdb 8:0 0 111.8G 0 disk Copy the .hddimg image onto the USB stick, e.g: - sudo dd if=./enea-edge-runtime-<machine>.hddimg \ + sudo dd if=./enea-edge-runtime-<processor>.hddimg \ of=/dev/sdb bs=4M conv=fsync Where - enea-edge-runtime-<machine>.hddimg is the + enea-edge-runtime-<processor>.hddimg is the .hddimg file and sdb is the assigned USB device name. -- cgit v1.2.3-54-g00ecf From 3b972fc8c4546117b5a811fcdae407cac77722f5 Mon Sep 17 00:00:00 2001 From: Remus Turea Date: Fri, 6 Aug 2021 09:56:03 +0200 Subject: ELCCR-1565 Documentation for SSL certificate change Change-Id: I0de5bd0bded7d59dc8b86bb79a9ef6668069bd1a Signed-off-by: Remus Turea --- .../doc/installation_guide.xml | 37 ++++++++++++++++------ .../doc/known_bugs_and_limitations.xml | 2 +- 2 files changed, 28 insertions(+), 11 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 940fc40..a60c986 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -612,7 +612,24 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz The generation of the Tomcat self-signed certificate should be skipped only if another certificate will be - provided. + provided. In case a custom certificate is used, not generated with the + createCertificate.sh script, the keystore file + containing the certificate must be manually copied + to the + /opt/ems/ucpemanager/application/config/certificates folder, + after the installation is done. The application must then be + restarted in order for the certificate to take effect. The default + name of the file is .Keystore. + + To change the default name, the configuration file + server.xml from the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config + folder must be copied to /opt/ems/ucpemanager/application/config/. + The keystoreFile attribute from the <Connector + executor="tomcatThreadPool" tag must also be changed. Similarly, + if a password has been set, it should be added to the + keystorePass attribute: + keystorePass="NEW_PASSWORD". @@ -755,9 +772,9 @@ sdb 8:0 0 111.8G 0 disk of=/dev/sdb bs=4M conv=fsync Where - enea-edge-runtime-<processor>.hddimg is the - .hddimg file and sdb is the - assigned USB device name. + enea-edge-runtime-<processor>.hddimg is + the .hddimg file and sdb is + the assigned USB device name.
@@ -935,9 +952,9 @@ of=/dev/sdb bs=4M conv=fsync Plug in additional WAN interfaces (if applicable) and provide their Layer 3 configuration. An interface can be - configured in dhcp or - static mode. When configured in static - mode, the following options are available: + configured in dhcp or + static mode. When configured in static mode, + the following options are available: @@ -954,8 +971,8 @@ of=/dev/sdb bs=4M conv=fsync DNS Server List (a comma separated list of IPv4 - addresses) (optional). If left empty it will use the - Gateway as the DNS, with 1.1.1.1 as fallback. + addresses) (optional). If left empty it will use the Gateway + as the DNS, with 1.1.1.1 as fallback. @@ -1275,4 +1292,4 @@ of=/dev/sdb bs=4M conv=fsync
- + \ 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 08e3e0d..99170d9 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 @@ -127,7 +127,7 @@ ELCCR-1565Before starting an Enea Edge Management upgrade, any owned Tomcat certificates should be manually copied into the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/certificates + /opt/ems/ucpemanager/application/config/certificates folder. -- cgit v1.2.3-54-g00ecf From 4d96e8e6de0ebd74131ed043e65102ef5de2adb1 Mon Sep 17 00:00:00 2001 From: Stefan Chiripuci Date: Wed, 4 Aug 2021 15:37:34 +0300 Subject: Add additional documentation on backup/restore Postgres database Change-Id: Iabd09a48c594165bcbbb7c6a3292785d88ba32c5 --- .../doc/advanced_configurations.xml | 159 +++++++++++++++++++++ .../doc/images/scheduled_backup.png | Bin 0 -> 49672 bytes 2 files changed, 159 insertions(+) create mode 100644 doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png (limited to 'doc/book-enea-edge-getting-started') 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 992a629..518d9ec 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -597,6 +597,165 @@ node0.1048576kB = 3
+
+ Database backup for the Enea Edge Management application + + The following handles advanced configuration for a database + backup. A backup can be used to restore the database in case + of corruption. + +
+ One-time backup of the database + + The following steps are used to perform a database backup + from the Enea Edge Management application: + + + + In the System Backup window, + select the Backups tab. + + + + Press the Backup Now button + in the Backups tab. + + + + In the new window select the + Database Export option from + the Backup Type drop-down. + + + + Set the Execution option + to Now. + + + + Press the Execute button + and wait until the Status message shows: + System Backup Completed. + + + + Once the backup is successfully executed it will be visible in + the System Backup window with a + name that respects the following format: + DatabaseExport_[date]_[timestamp].zip. +
+ +
+ Restoring the database from a backup + + The following steps are used to perform a database restore + from the Enea Edge Management application: + + + + In the System Backup window, + select the Backups tab. + + + + Select the backup you want to restore from the list. + + + Database backups follow the naming convention: + DatabaseExport_[date]_[timestamp].zip. + + + + + Click the Restore button. + + + + In the window that appears, click + OK to proceed with the + restore operation. + + + + Follow the instructions in the pop-up window to restart + the server using the CentOS 7 command: + + sudo systemctl restart ucpemanager.service + + +
+ +
+ Scheduled backup of the database + + The following steps are used to perform a scheduled database backup + from the Enea Edge Management application: + + + + In the System Backup window, + select the Backups tab. + + + + Press the Backup Now button + in the Backups tab. + + + + In the new window select the + Database Export + option from the Backup Type drop-down. + + + + Set the Execution option + to Scheduled. + + + + Fill in the Description field. + + + + Set the Begin Date. + + + + Fill in the non-mandatory fields accordingly. + + + The End Date field becomes + available once the Periodicity option + is set to something other than + Once. + + + + + Click the Schedule button to + schedule the backup. + + + +
+ Scheduled Backup Configuration Example + + + + + + +
+ + The backups created will be visible in the + System Backup window with a + name following the format: + DatabaseExport_[date]_[timestamp].zip. +
+
+
Installing the Enea Edge Management application in High Availability Mode diff --git a/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png b/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png new file mode 100644 index 0000000..bf66b99 Binary files /dev/null and b/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png differ -- cgit v1.2.3-54-g00ecf From de3b10f43c54d4cf1c8c9a74d77ded5462f40cb3 Mon Sep 17 00:00:00 2001 From: Stefan Chiripuci Date: Tue, 10 Aug 2021 13:08:32 +0300 Subject: Documentation about FQDN can be improved. Change-Id: I68903169864121445a3abd6b022beddde034299d --- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 a60c986..32a39c0 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -663,7 +663,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz - Using the IPv4 address of the CentOS 7 Server in a web + Using the IPv4 address or the FQDN of the CentOS 7 Server in a web browser, running on the laptop, log into the Enea Edge Management GUI using the default username and password: admin/admin. @@ -671,7 +671,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz - The IPv4 address of the CentOS 7 Server will be used as a + The IPv4 address or the FQDN 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 -- cgit v1.2.3-54-g00ecf From 76b716998129cc4d168fda1f168a51c31ad2b838 Mon Sep 17 00:00:00 2001 From: Paul Buhai Date: Tue, 10 Aug 2021 11:26:32 +0300 Subject: Increase reverse SSH ports range Change-Id: Ied09bd2cb25e627c60bb2835766a6985a68cff94 --- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/book-enea-edge-getting-started') 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 628ff76..beea8fc 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -497,7 +497,8 @@ role="bold">Reverse SSH . By default, the start port will be 7000 and the maximum number of ports allocated to all devices is 10. Only one port per device is - allowed. + allowed. The maximum number of ports allocated can be increased + up to 65536, if necessary. When the SSH window is closed, the tunnel configuration is deleted on the uCPE device and the tunnel is destroyed, so that -- cgit v1.2.3-54-g00ecf From 994a612560ec09a71d67f7521920e8e01ad243f3 Mon Sep 17 00:00:00 2001 From: Toma Bilius Date: Thu, 12 Aug 2021 13:14:08 +0300 Subject: ELCCR-1658 Onboarded VNFs cannot be restored when using NFVi Backup Change-Id: I05948ff41f9c23ad2b2f4180c2a0ab8a319254d9 Signed-off-by: Toma Bilius --- .../doc/advanced_configurations.xml | 278 +++++++++++---------- 1 file changed, 142 insertions(+), 136 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 518d9ec..14981e9 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -514,8 +514,8 @@ node0.1048576kB = 3 Archive Table and the BackupArchiveCreated event can be seen by accessing the Fault menu and triggering - the Events window. The backup - file will be created on the uCPE device. + the Events window. The backup file will + be created on the uCPE device.
@@ -563,6 +563,12 @@ node0.1048576kB = 3 Instances that were present at the moment the backup was taken will be restored to their initial state, as if newly created. All snapshots associated with previously instantiated VNFs will be deleted. + + + If the VNF descriptor associated with the VNFs that were saved + as part of the backup is deleted after the backup is performed, then a + backup restore will not be able to recreate those VNFs. +
@@ -598,161 +604,161 @@ node0.1048576kB = 3
- Database backup for the Enea Edge Management application - - The following handles advanced configuration for a database - backup. A backup can be used to restore the database in case - of corruption. - + Database backup for the Enea Edge Management application + + The following handles advanced configuration for a database backup. + A backup can be used to restore the database in case of corruption. +
- One-time backup of the database - - The following steps are used to perform a database backup - from the Enea Edge Management application: - - - - In the System Backup window, - select the Backups tab. - + One-time backup of the database - - Press the Backup Now button - in the Backups tab. - + The following steps are used to perform a database backup from the + Enea Edge Management application: - - In the new window select the - Database Export option from - the Backup Type drop-down. - + + + In the System Backup window, + select the Backups tab. + - - Set the Execution option - to Now. - + + Press the Backup Now button + in the Backups tab. + - - Press the Execute button - and wait until the Status message shows: - System Backup Completed. - - - - Once the backup is successfully executed it will be visible in - the System Backup window with a - name that respects the following format: - DatabaseExport_[date]_[timestamp].zip. + + In the new window select the Database + Export option from the Backup + Type drop-down. + + + + Set the Execution option to + Now. + + + + Press the Execute button and + wait until the Status message shows: System + Backup Completed. + + + + Once the backup is successfully executed it will be visible in the + System Backup window with a name that + respects the following format: + DatabaseExport_[date]_[timestamp].zip.
- +
- Restoring the database from a backup - - The following steps are used to perform a database restore - from the Enea Edge Management application: - - - - In the System Backup window, - select the Backups tab. - + Restoring the database from a backup - - Select the backup you want to restore from the list. - - - Database backups follow the naming convention: - DatabaseExport_[date]_[timestamp].zip. - - + The following steps are used to perform a database restore from + the Enea Edge Management application: - - Click the Restore button. - + + + In the System Backup window, + select the Backups tab. + - - In the window that appears, click - OK to proceed with the - restore operation. - + + Select the backup you want to restore from the list. - - Follow the instructions in the pop-up window to restart - the server using the CentOS 7 command: - - sudo systemctl restart ucpemanager.service - - + + Database backups follow the naming convention: + DatabaseExport_[date]_[timestamp].zip. + + + + + Click the Restore + button. + + + + In the window that appears, click OK to proceed with the restore + operation. + + + + Follow the instructions in the pop-up window to restart the + server using the CentOS 7 command: + + sudo systemctl restart ucpemanager.service + +
- +
- Scheduled backup of the database - - The following steps are used to perform a scheduled database backup - from the Enea Edge Management application: - - - - In the System Backup window, - select the Backups tab. - + Scheduled backup of the database - - Press the Backup Now button - in the Backups tab. - + The following steps are used to perform a scheduled database + backup from the Enea Edge Management application: - - In the new window select the - Database Export - option from the Backup Type drop-down. - + + + In the System Backup window, + select the Backups tab. + - - Set the Execution option - to Scheduled. - + + Press the Backup Now button + in the Backups tab. + - - Fill in the Description field. - + + In the new window select the Database + Export option from the Backup + Type drop-down. + - - Set the Begin Date. - + + Set the Execution option to + Scheduled. + - - Fill in the non-mandatory fields accordingly. - - - The End Date field becomes - available once the Periodicity option - is set to something other than - Once. - - + + Fill in the Description + field. + - - Click the Schedule button to - schedule the backup. - - + + Set the Begin Date. + + + + Fill in the non-mandatory fields accordingly. + + + The End Date field becomes + available once the Periodicity + option is set to something other than Once. + + + + + Click the Schedule button to + schedule the backup. + + + +
+ Scheduled Backup Configuration Example + + + + + + +
-
- Scheduled Backup Configuration Example - - - - - - -
- - The backups created will be visible in the - System Backup window with a - name following the format: - DatabaseExport_[date]_[timestamp].zip. + The backups created will be visible in the System Backup window with a name following the + format: DatabaseExport_[date]_[timestamp].zip.
-- cgit v1.2.3-54-g00ecf From e2bec9bdd9b397cf519f56744e4e2291365cc00b Mon Sep 17 00:00:00 2001 From: Matei Valeanu Date: Fri, 13 Aug 2021 09:44:17 +0200 Subject: Update reference to ostree image Change-Id: Idcbe006a7e495d1e6b42f8c63dade6d8364e56db Signed-off-by: Matei Valeanu --- doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 79acd9d..6a02d47 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml @@ -289,7 +289,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz The uCPE Device upgrade is done with image files of the type - rootfs.ostree.tar.bz2, which are available in the + ostree.tar.bz2, which are available in the Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz file you downloaded with your release. @@ -313,7 +313,7 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz Select Choose File to provide the path to the image file (must be of type - rootfs.os-tree.tar.bz2). + ostree.tar.bz2). @@ -620,4 +620,4 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From 1f86725f48a1bcc9ce6d6120dc69def08acebef9 Mon Sep 17 00:00:00 2001 From: Alexandru Avadanii Date: Fri, 13 Aug 2021 10:20:43 +0200 Subject: Wireless AP: 802.11g/n: 20MHz instead of 40MHz Note that 802.11g/n might use 20MHz channels instead of the expected 40MHz when overlapping BSSes are found in the neighbourhood. Although we could force our AP to use 40MHz, we won't, as that might break the law (depending on the law applicable on the customer's premises). Change-Id: I7dba9bb73352403f04129175044ac2d5e400eede Signed-off-by: Alexandru Avadanii --- .../doc/net_config_options.xml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'doc/book-enea-edge-getting-started') 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 7238fef..9c9dfe2 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 @@ -925,5 +925,15 @@ menu and selecting External Interfaces. + + + For the 2.4GHz band, the 802.11 g/n wireless + mode will use a 40MHz channel width by default. For regulatory + requirements compliance, channels are scanned in order to avoid + overlapping with existing networks. If overlaps are detected, primary + and secondary Wireless AP channels will be swapped, resulting in an + effective channel width of 20MHz instead of 40Mhz being used. + To avoid this, select another wireless channel. + - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From 039084cbbb1d580614978037e32708867acf50de Mon Sep 17 00:00:00 2001 From: Alexandru Avadanii Date: Fri, 13 Aug 2021 10:47:27 +0200 Subject: Wireless AP: 802.11ac/n: Different channel number Note that 802.11n or 802.11ac/n might use a different channel than the one explicitly requested when overlapping BSSes are found in the neighbourhood. Change-Id: I7ab45b00b7d0461fb2dfce0c3c794b99df70a823 Signed-off-by: Alexandru Avadanii --- .../doc/net_config_options.xml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 9c9dfe2..a9faf0a 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 @@ -916,15 +916,13 @@ - - Only a single Wireless AP is allowed on a physical interface. The + Only a single Wireless AP is allowed on a physical interface. The validation of the wap-capable interface is done when adding the Wireless AP, so, in case of an error, the parameters of the wap-capable interface must be rechecked. This can be done by accessing the Configuration menu and selecting External Interfaces. - For the 2.4GHz band, the 802.11 g/n wireless @@ -934,6 +932,16 @@ and secondary Wireless AP channels will be swapped, resulting in an effective channel width of 20MHz instead of 40Mhz being used. To avoid this, select another wireless channel. + + For the 5GHz band, the 802.11 n and the + 802.11 ac/n wireless modes can be configured + explicitly to use a specific channel number, even when Automatic + Channel Selection (ACS) is available. For regulatory + requirements compliance, channels are scanned in order to avoid + overlapping with existing networks. If overlaps are detected, + ACS will try to find another free channel, + resulting in a different channel number being used instead of the one + explicitly configured. To avoid this, select another wireless channel. -- cgit v1.2.3-54-g00ecf From 3290dcb674c968427b7fbfac8a02dffdd63ad2a9 Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 13 Aug 2021 13:07:55 +0200 Subject: Corrected the note about VNFs cannot be restored when using NFVi Backup. Change-Id: I489e056f877f502f5f729f013f5705dd4083b950 Signed-off-by: mrpa --- doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 14981e9..5f20c7f 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml @@ -565,9 +565,8 @@ node0.1048576kB = 3 associated with previously instantiated VNFs will be deleted. - If the VNF descriptor associated with the VNFs that were saved - as part of the backup is deleted after the backup is performed, then a - backup restore will not be able to recreate those VNFs. + VNF instances will not be recreated if their associated VNF + descriptor has been deleted prior to restoring the NFVi backup. -- cgit v1.2.3-54-g00ecf From 01a40353d65ff7b73d507270d4c76d50886207de Mon Sep 17 00:00:00 2001 From: Andreas Wellving Date: Mon, 23 Aug 2021 16:01:06 +0200 Subject: getting-started: Mention postinstall timeout Change-Id: I6cf6d6a8e1e795bd464d845ac1024ad381a3ccb6 Signed-off-by: Andreas Wellving --- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 32a39c0..dbf4c54 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -97,8 +97,8 @@ When hosting an entire solution including one or several network services, the hardware must also have the resources to host one or - more VNFs. During a typical evaluation, a dual VNF service on the Enea - Edge Runtime needs a CPU with 4-8 cores and at least 8 GB RAM. The + more VNFs. A dual VNF service on the Enea + Edge Runtime typically needs a CPU with 4-8 cores and at least 8 GB RAM. The supported Intel CPUs of Enea Edge are documented in the (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 - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From 6ef055c881ec4f93dbafd54912417e9efcc6925d Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Tue, 31 Aug 2021 13:03:09 +0300 Subject: ELCCR-1566: improve "Restart vCPE" documentation Change-Id: Ic4eca909f6aba2910bc9ca8fd82ee10b70aff4bf --- .../doc/installation_guide.xml | 77 ++++++++++++---------- 1 file changed, 42 insertions(+), 35 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 dbf4c54..e6f8c82 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 @@ -97,9 +97,9 @@ When hosting an entire solution including one or several network services, the hardware must also have the resources to host one or - more VNFs. A dual VNF service on the Enea - Edge Runtime typically needs a CPU with 4-8 cores and at least 8 GB RAM. The - supported Intel CPUs of Enea Edge are documented in the Manual. @@ -612,24 +612,27 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz The generation of the Tomcat self-signed certificate should be skipped only if another certificate will be - provided. In case a custom certificate is used, not generated with the - createCertificate.sh script, the keystore file - containing the certificate must be manually copied - to the - /opt/ems/ucpemanager/application/config/certificates folder, - after the installation is done. The application must then be - restarted in order for the certificate to take effect. The default - name of the file is .Keystore. + provided. In case a custom certificate is used, not + generated with the createCertificate.sh + script, the keystore file containing the certificate must be + manually copied to the + /opt/ems/ucpemanager/application/config/certificates + folder, after the installation is done. The application must + then be restarted in order for the certificate to take + effect. The default name of the file is + .Keystore. To change the default name, the configuration file - server.xml from the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config - folder must be copied to /opt/ems/ucpemanager/application/config/. - The keystoreFile attribute from the <Connector - executor="tomcatThreadPool" tag must also be changed. Similarly, - if a password has been set, it should be added to the - keystorePass attribute: - keystorePass="NEW_PASSWORD". + server.xml from the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config + folder must be copied to + /opt/ems/ucpemanager/application/config/. + The keystoreFile attribute from the + <Connector executor="tomcatThreadPool" + tag must also be changed. Similarly, if a password has been + set, it should be added to the + keystorePass attribute: + keystorePass="NEW_PASSWORD". @@ -663,16 +666,17 @@ Enea_Edge_Management_<version>-build<build_number>.tar.gz - Using the IPv4 address or the FQDN of the CentOS 7 Server in a web - browser, running on the laptop, log into the Enea Edge Management - GUI using the default username and password: + Using the IPv4 address or the FQDN of the CentOS 7 Server in + a web browser, running on the laptop, log into the Enea Edge + Management GUI using the default username and password: admin/admin. - The IPv4 address or the FQDN of the CentOS 7 Server will be used as a - configuration parameter when setting up the uCPE devices. + The IPv4 address or the FQDN 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 @@ -1177,9 +1181,9 @@ of=/dev/sdb bs=4M conv=fsync (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. After a timeout of a few minutes, - the Web-installer can be accessed from the laptop as described in - Installing Enea Edge - uCPE Device installation in the 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. + can be restored or simply the Enea Edge Management Agent service can be + restarted.
Checking Alarms @@ -1232,7 +1237,7 @@ of=/dev/sdb bs=4M conv=fsync 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. + simply the Enea Edge Management Agent service can be restarted. Select the uCPE device and go to the Operations menu, where the following options are @@ -1250,10 +1255,11 @@ of=/dev/sdb bs=4M conv=fsync settings are lost. All running VNFs are destroyed. All uploaded VM image files are deleted. Existing log files will be kept. - Only the vCPE service will be restarted, the device will not - be rebooted. No reboot is needed. + This command will only restart the Enea Edge Management Agent + service, the device will not be rebooted. No reboot is + needed. - Once the vCPE service restart completes, appropriate day-0 + Once the service restart completes, appropriate day-0 provisioning will take place. Previously installed custom scripts will be reinstalled on the uCPE device, and upon receiving the custom script(s), the device will reboot. @@ -1261,7 +1267,8 @@ of=/dev/sdb bs=4M conv=fsync Restart Vcpe. Restarts the - vCPE service on the device. The device will not be rebooted. + Enea Edge Management Agent service. The device will not be + rebooted.
@@ -1293,4 +1300,4 @@ of=/dev/sdb bs=4M conv=fsync - + \ No newline at end of file -- cgit v1.2.3-54-g00ecf From 4c40aa2d67684b44438d4adbd7ca9a2bd6aed4a5 Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Mon, 30 Aug 2021 16:00:08 +0300 Subject: ELCCR-1267 - add documentation to Submaps Change-Id: I1833c7ecdf03e349a593f3b35274293cfbe85dbb --- doc/book-enea-edge-getting-started/doc/book.xml | 7 +- doc/book-enea-edge-getting-started/doc/submaps.xml | 344 +++++++++++++++++++++ 2 files changed, 348 insertions(+), 3 deletions(-) create mode 100644 doc/book-enea-edge-getting-started/doc/submaps.xml (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index f317f15..e74ac85 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml @@ -1,4 +1,4 @@ - + @@ -7,8 +7,7 @@ <trademark class="registered">Enea</trademark> Edge Getting Started - Release Version Release Version @@ -37,6 +36,8 @@ + + + + Submaps + + The System domain of the Enea Edge Managemement application can be + split into different submaps, used to organize the uCPE devices more + effectively. Each domain is organized like a tree, with each submap being + able to have several other submaps within it. Each device can be placed in + only one submap and the user can create virtual links between devices. + + Submaps support managed and unmanaged uCPE devices. An unmanaged + device is an icon that looks like a device within the + Map (it supports links and has a similar + icon) but is not a real managed device. + +
+ Submap Operations + + In the System view, right-clicking + on a submap opens up a menu with the following operations: + + + + Add Submap + + This option is used for adding a new submap, placed in the + System view under the current one in + the tree. The new submap will also be added in the Map view of the parent submap. + + When selecting this option, the following fields need to be set + in the Add Submap window that + pops-up: + + + Submap properties + + + + + Name + + The name of the domain map. This is + mandatory. + + + + Description + + A text description of the domain map. + + + + Background Color + + The background color of the domain map. Possible + values: white, black, blue, cyan, grey, green, magenta, + orange, pink, red, yellow. + + + + Background Image + + The background image of the domain map. + + + + Icon Image + + The icon image of the domain map. + + + + Snap to Grid + + True if a placed device should snap to the grid + automatically. + + + + X Grid (px) + + The number of pixels between placement positions in + the horizontal position in the grid. Disabled if + Snap to Grid is false. + + + + Y Grid (px) + + The number of pixels between placement positions in + the vertical position in the grid. Disabled if Snap + to Grid is false. + + + + Direction + + This value describes the direction of sorting the + items (horizontal or vertical). + + + + Sort Method + + This value describes the sorting method used when + arranging icons. Natural is [a1,a2,a11] and Alphabetical is + [a1,a11,a2]. + + + + Arrangement Wrap + + This value indicates the maximum number of items + placed before wrapping to the next row or column. + + + +
+ + + Snap to Grid, Direction + and Sort Method have the System + Default option. This option can be set by accessing + System, selecting Configuration under the Properties tab, and navigating to the GUI tab. + + More images for backgrounds and icons can be uploaded by + accessing System, selecting + Media Files under the Icons tab or the Backgrounds tab, respectively. + + + + + Remove Submap + + This option is used for removing the current submap. The submap + must be empty, all children submaps or uCPE Devices must be deleted first. + + + + Properties + + This option is used for viewing and/or editing the properties of + the current submap. For more details please see the Submap properties table. + + + + Move Device + + This option is used for adding devices to the current submap. + All devices appear in this list (placed and unplaced). If the device + is already added to a submap, it will be moved from that submap to the + current one. + + +
+ +
+ Map Operations + + Right-clicking anywhere in the Map + view opens up a menu with the following operations: + + + + Place Device + + This option is used for adding one or more devices in the + current submap. Only unplaced devices appear in this list. + + + + Move Device + + This option is used for moving one or more devices from other + submaps to the current submap. All devices appear in this list (placed + and unplaced). If the device is already added to a submap, it will be + removed from that submap. + + + + Add Unmanaged + + This option is used for creating an unmanaged device. An + unmanaged device is represented by an icon in the current view that + looks like a device (it supports links and has a similar icon) but + is not a real managed device. It will be automatically placed in the current + submap. When selecting this option, the following fields need to be + set in the Add Unmanaged window that + pops-up: + + + Unmanaged device properties + + + + + Name + + The name of the device. + + + + Description + + A text description of the device. + + + + Icon Image + + The icon image of the device. + + + + Status + + The status of the device. + + + + Status Tooltip + + The tooltip for the device status. + + + +
+ + + + Add Link + + This option is used for creating a virtual link between two + devices. They can be any two devices, it does not matter if they are + unplaced, placed in the current submap or placed in any other submap. + When selecting this option, the following fields need to be set in the + Add Link window: + + + Link properties + + + + + Name + + The name of the link. + + + + Description + + A text description of the link. + + + + From + + One of the endpoints of the link. + + + + To + + The 2nd endpoint of the link. + + + + + + + + Properties + + This option is used for viewing and/or editing the properties of + the current submap. For more details please see the Submap properties table. + + + + Arrange icons + + This option can be used to auto-arrange devices placed in the + current submap. The rearrangement is done based on the submap's + properties. + + +
+ +
+ Device Operations + + In the Map view, right-clicking on + a device opens up a menu with the following operations: + + + + Links... + + This option is used for viewing all links to and from that + device. + + + + Remove + + For managed devices, this option is used for removing the device + from the map. The managed device will not be removed completely from + the Enea Edge Management application, but will be moved to the Unplaced submap instead. + + For unmanaged devices, this option removes the device altogether + from the Enea Edge Management application. + + + + Add Link + + This option is used for creating a virtual link between two + devices. They can be any two devices, it does not matter if they are + unplaced, placed in the current submap or placed in any other submap. + The current device is already selected as the From endpoint in the Add + Link pop-up. For more details please see the Link properties table. + + + + Properties + + This option is used for viewing and editing the properties of an + unmanaged device. For more details please see the Unmanaged device properties table. + + +
+ \ No newline at end of file -- cgit v1.2.3-54-g00ecf From 926745af074f7c3417b67217121a3779719e2b6d Mon Sep 17 00:00:00 2001 From: Marius Ene Date: Thu, 2 Sep 2021 13:06:18 +0200 Subject: ELCCR-1950 - Changed the reference to Virtual Machines tab. Now the tab title is the name of the device. Change-Id: I754f7ac2ac3525a0bbb2531a92ea0431e97141af Signed-off-by: Marius Ene --- doc/book-enea-edge-getting-started/doc/installation_guide.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/book-enea-edge-getting-started') 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 e6f8c82..da62568 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 @@ -1227,9 +1227,9 @@ of=/dev/sdb bs=4M conv=fsync in use. To check CPU, RAM and disk utilization simply select the uCPE - device and go to the Virtual Machines - tab in the map view. The same view will show active VNFs running on the - uCPE device once instantiated. + device and go to the device view tab (the tab bears the device name + as its title). The same view will show active VNFs running on the + uCPE device once instantiated.
-- cgit v1.2.3-54-g00ecf From 00eaed1b8321781119e963a52a24321434587617 Mon Sep 17 00:00:00 2001 From: Marius Ene Date: Fri, 3 Sep 2021 09:46:33 +0200 Subject: ELCCR-1673 - Updated 2 images related to Onboarding a VNF and Debug Settings Change-Id: Ibf018cc3190ff3599af8c39ce7e8ae5efa7182d8 Signed-off-by: Marius Ene --- .../doc/images/debug_settings.png | Bin 32833 -> 35056 bytes .../doc/images/onboard_a_vnf_image.png | Bin 19864 -> 23297 bytes 2 files changed, 0 insertions(+), 0 deletions(-) (limited to 'doc/book-enea-edge-getting-started') diff --git a/doc/book-enea-edge-getting-started/doc/images/debug_settings.png b/doc/book-enea-edge-getting-started/doc/images/debug_settings.png index 2c97b2c..7bd9be2 100755 Binary files a/doc/book-enea-edge-getting-started/doc/images/debug_settings.png and b/doc/book-enea-edge-getting-started/doc/images/debug_settings.png differ diff --git a/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png b/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png index da52202..773c1ef 100755 Binary files a/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png and b/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png differ -- cgit v1.2.3-54-g00ecf