From adc6872c65a4b266a67ab20770c29916ca79cb04 Mon Sep 17 00:00:00 2001 From: iosc Date: Mon, 22 Mar 2021 15:28:31 +0100 Subject: USERDOCAP-636 - all books renamed into enea edge Change-Id: I3ce4380c19653ef14792960ad968664b70f3c2bf --- .../doc/about_release.xml | 184 +++++++++++++++++ doc/book-enea-edge-release-info/doc/book.xml | 30 +++ .../doc/getting_enea_nfv_access.xml | 54 +++++ .../doc/jiraissues_override.xml | 36 ++++ .../doc/known_bugs_and_limitations.xml | 217 +++++++++++++++++++++ .../doc/main_changes.xml | 162 +++++++++++++++ .../doc/system_requirements_prerequisites.xml | 62 ++++++ doc/book-enea-edge-release-info/swcomp.mk | 10 + 8 files changed, 755 insertions(+) create mode 100644 doc/book-enea-edge-release-info/doc/about_release.xml create mode 100644 doc/book-enea-edge-release-info/doc/book.xml create mode 100644 doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml create mode 100644 doc/book-enea-edge-release-info/doc/jiraissues_override.xml create mode 100644 doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml create mode 100644 doc/book-enea-edge-release-info/doc/main_changes.xml create mode 100644 doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml create mode 100644 doc/book-enea-edge-release-info/swcomp.mk (limited to 'doc/book-enea-edge-release-info') diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml new file mode 100644 index 0000000..960f136 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/about_release.xml @@ -0,0 +1,184 @@ + + + + About This Release + + Enea Edge is a complete NFVI software platform designed for + deployment on any white box uCPE device, and optimized for common use cases. + Enea Edge includes both the Enea Edge Runtime deployed on a white box, + and a management component with automation tools deployed in a private or + public cloud. + + The Enea Edge Release includes a new version of + the major components as well as other features and optimizations, and + documentation updates. A list of new features and improvements can be found + in Section 2.1 New Features and + Improvements. + +
+ Enea Edge Release Content + + The release content is detailed below: + + + + Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz + + + + Enea_Edge_Runtime_XeonD_<version>-build<build_number>.tar.gz + + + + Enea_Edge_Automation_<version>-build<build_number>.zip + + + + Enea_Edge_Management_<version>-build<build_number>.tar.gz + + + + Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz + + + + VNF_example_configurations.tar.gz + + + + Enea_Edge_AF-TH_<version>-build<build_number>.zip + (deprecated, see Section 2.1 New Features and + Improvements.) + + + + -- documentation/ + /* Enea Edge documentation */ +-- README +-- aarch64 /* architecture */ + -- cn8304/ + /* artifacts for the host side */ + -- deb/ + /* deb packages */ + -- images/ + -- enea-nfv-access + /* precompiled artifacts for the platform release image */ + -- various artifacts (rootfs, kernel, config etc.) + -- enea-nfv-access-dev + /* precompiled artifacts for the development process. The image + contains userspace tools and kernel configurations necessary + for developing, debugging and profiling applications and + kernel modules */ + -- various artifacts + -- qemuarm64 + /* artifacts for the guest side */ + -- deb/ + /* deb packages */ + -- images/ + -- enea-nfv-access-guest + /* precompiled artifacts for the QEMU/Docker release image */ + -- various artifacts + -- enea-nfv-access-guest-dev + /* precompiled artifacts for the development process. The image + contains userspace tools and kernel configurations necessary + for developing, debugging and profiling applications and + kernel modules */ + -- various artifacts +
+ + INFO Below is a complete section with ID + "eltf-target-tables-section" included from elft_params_updated.xml. It + contains a variable number of target tables and the section title should be + "Supported Targets with Parameters". It has have a short sentence about what + it is in the beginning. The subtitles shall have the directory name of the + target in the manifest. + + + +
+ User Documentation + + This release of Enea Edge contains the following set of + documents: + + + + Enea Edge Release Information. Describes the Enea Edge + release content, main changes, the list of known issues and + limitations. + + + + . + Describes how to deploy and upgrade an Enea Edge base + configuration, advanced configurations of the system and + troubleshooting information. + + + + . + Describes examples of onboarding, instantiating and configuring + various VNFs. + + + + . + Describes the Automation Framework for Enea Edge. + + + + . Describes the + Automation Framework and Test Harness for Enea Edge and + provides instructions regarding the necessary steps to run these + software tools (deprecated, see + Section 2.1 New Features + and Improvements). + + + + . + Describes a sample Test Suite for System Testing of Enea Edge. + (deprecated, see Section 2.1 + New Features and Improvements). + + +
+ +
+ Supported Web Browsers + + These need to be updated + + The current release supports using the following web browsers: + + + + Google Chrome (tested with version 86). + + + + Mozilla Firefox (tested with version 82). + + + + Microsoft Edge (tested with version 84). + + +
+ \ No newline at end of file diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml new file mode 100644 index 0000000..b886ee1 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/book.xml @@ -0,0 +1,30 @@ + + +]> + + <trademark class="registered">Enea</trademark> Edge Release + Information + + Release Version + + + + + + + + + + + + + + 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 new file mode 100644 index 0000000..9eecd3c --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml @@ -0,0 +1,54 @@ + + + + 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/jiraissues_override.xml b/doc/book-enea-edge-release-info/doc/jiraissues_override.xml new file mode 100644 index 0000000..7282d0f --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/jiraissues_override.xml @@ -0,0 +1,36 @@ + + +
+ Release-Specific Problems + + + + + + + + + + Summary + + Enea Ref + + + + + + Eclipse Plug-Ins for Perf and Latencytop are not functioning properly on P2041RDB target. + + LXCR-6936 + + + + LTTng kernel tracing from Eclipse does not work due to RSE connectivity problems.As a workaround, traces can be collected on target and visualized on Eclipse, after copying the files on the host system. + + LXCR-7166 + + + + +
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 new file mode 100644 index 0000000..1f5fb0c --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml @@ -0,0 +1,217 @@ + + + + Known Issues and Limitations in this Release + + This chapter lists the known general issues and limitations that + affect the current release. + + + + LXCR-9904Enea Edge Runtime cannot be installed on + USB storage devices. + + + + LXCR-9799Proper boot order is not ensured if a + uCPE device has more than one HDD attached. + + + + ELCCR-527Cancelling a file upload in the Enea + Edge Management will require the user to close and reopen the upload window + for the next upload to work. + + + + ELCCR-577If Enea Edge Management is restored from a backup + made on a release version older than Enea NFV Access 2.2.3, VNFs cannot be instantiated + from the GUI. + + + + ELCCR-474Deleting VNF instances with flows + configured on the OVS bridges can be done only after removing the + flows. + + + + ELCCR-572Sometimes when selecting and deleting + more than one VNF instance simultaneously, an error message might be + triggered, even if the delete operation succeeds. + + + + ELCCR-847The Juniper vSRX VNF cannot be + instantiated on the Xeon-D architectures due to missing CPU features in + the VNF's domain XML. This impacts all example use cases where the Juniper VNF is used. + + + + USERDOCAP-648The storage size + parameter on the VNF onboarding page is ignored. The default storage + size specified when creating the VM image is used when instantiating the + VM and when presenting VM information. + + + + LXCR-9853The WAN interface of a uCPE device needs + to be connected to a network with at least a router/gateway installed + for next-hop communication. + + + + LXCR-9992Depending on hardware capabilities, + there are certain limitations regarding the vfio-pci + and igb_uio drivers. While the Enea Edge + Runtime uses the vfio-pci driver by default, + for certain hardware configurations, igb_uio should + be used instead, by providing custom scripting. Please contact Enea for + further details. + + + + STCR-6224The Enea Edge Automation + and the Enea Edge Automation Framework and Test Harness do not + support multiple custom scripts uploaded to a uCPE device at the same + time. + + + + STCR-6292Management of WAN Interfaces is not + implemented in the Enea Edge Automation Framework and Test Harness. + + + + USERDOCAP-628Enea Edge Automation Framework + and Test Harness does not have support for product features implemented + in Enea Edge 2.4.0 or newer. + + + + ELCCR-912When the Enea Edge Management is installed + on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an + upgrade image fails. As a workaround, please update + glib2 to version 2.54.2 or later, using #yum + update glib2. + + + + ELCCR-854Changing the management interface IP + address will result in a temporary loss of connection with the uCPE + device. If the device is behind a NAT, while using the Call Home + connection, reestablishing the connection automatically could take up to + 20 minutes. Restarting the vCPE Overlay will immediately reestablish the + connection, but that implies the existence of an alternate way to + trigger the vCPE restart operation on the device. + + + + USERDOCAP-641Enea Edge does not have + support for IPv6 addresses on both uCPE devices and the Enea Edge + Management installation. + + + + ELCCR-1428Wireless AP creation through the REST + API does not validate that the wireless interface and LAN bridge are + configured. Using these parameters may result in undefined + behavior. + + + + USERDOCAP-651Wireless AP configuration is + optimized for wireless modules that use the ath10k + driver. Using other wireless modules may result in undefined + behavior. + + + + ELCCR-1351The updated + .Keystore and server.xml files + from the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ + folder are overwritten during a product upgrade. As a workaround for + this issue, after an upgrade, copy the updated + .Keystore and server.xml files + into the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ + folder and restart the ucpemanager service. + + + + ELCCR-1371The current self-signed certificate for + the Enea Edge Management is generated at build time, with a hard-coded + common-name causing the uCPE device upgrade to fail in HTTPS mode. As a + workaround, another certificate (containing an IP based common-name) + must be generated. + + Perform the following the steps to generate the + certificate: + + + + Stop the Edge Management service. + + + + Create the certificate using the + createCertificate.sh script from distribution + folder. This will create a new .Keystore file + and copy it into the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates + folder. + + + + Start the Enea Edge Management, the new certificate should now + take effect. + + + + + + ELCCR-1378Modifying the type of the external + interfaces can lead to errors. Instead of modifying, it is recommended + to delete the old interfaces and recreate them with the desired + type. + + + + ELCCR-907At times the VIP address is not acquired + by any of the backup nodes if a power failure happens on primary node in + a High Availability setup. To recover, follow the official documentation + available at Galera Cluster + Recovery. + + + + LXCR-3283PDF + navigation: When using links to open other PDFs, or jump to + another place in the same PDF, jumping back sometimes fails. This has + been observed when opening a PDF in Adobe Reader, inside a browser with + PDF add-on, as well as when the browser is configured to open PDF files + in an external PDF reader. As a workaround, open the HTML version of the + document. + + + + ELCCR-1468When using the Enea Edge Management in + HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. + Either switch to HTTP mode (for more details see The uCPE device Upgrade Process in the + + Manual) or install it manually. + + + + + + + \ 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 new file mode 100644 index 0000000..c01a149 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml @@ -0,0 +1,162 @@ + + + + Main Changes + + Below you'll find information about the new features and updates made + in this release, as well as details on the provided packages and the + backwards compatibility with previous versions. + +
+ New Features and Improvements + + New Features: + + + + CPDX-3496Embedded WiFi support for all-in-one + store/home office deployment. + + + + CPDX-3499Expanded hardware, OS and network + monitoring capability with Grafana integration. + + + + CPDX-3498High Availability support with redundant + Enea Edge Management in active standby configuration. + + + + CPDX-3407HTTPS based downloads of VNFs for + simplified deployment of the Enea Edge Management in cloud + environments. + + + + CPDX-3500The Enea Edge Automation, + a tool for automatic system configuration based on Python + scripting that will replace the existing Enea Edge Automation + Framework and Test Harness in the next major release. + + The Enea Edge Automation Framework and Test Harness, and + its related documentation the + and the + are deprecated starting with Enea Edge 2.4.0. + + + + Improvements: + + + + A new Requirements page has + been added to the Web-installer, displaying device characteristics and + checking minimal hardware requirements. + + + + A Web-installer's log is displayed on the last page in case the + installation process has failed. + + + + Extended Web-installer support for NVME disks. + + + + Early Access Features: + + The following Early Access features are included in this release + (made originally available with Enea NFV Access 2.3.0): + + + + Platform and VNF Snapshots: + + + + Platform Snapshots allow users to store, manage and restore + snapshots of the Enea Edge Runtime configuration, + with the purpose of recovering after a failed reconfiguration. + This feature is disabled by default. + + + + VNF Snapshots allow users to store, manage and restore + snapshots of VNFs deployed on the Enea Edge + Runtime, with the purpose of restoring the VNF after a persistent + VNF failure. This feature is disabled by default. + + + + + Users that would like to try out the Snapshot features should + contact Enea Support for additional documentation and + assistance. + + + + + Early Access features are provided for evaluation and early + feedback. They are not allowed to be used for business-critical + deployment, unless previously approved by Enea. Support cases reported on + Early Access features may only be set to a Minor Priority, with the intent + of addressing them in upcoming GA releases. +
+ +
+ Open Source + + For more information about the Open Source packages included, please + refer to the Enea Edge Open Source Reports listed below. Each report + contains open source and license information pertaining to packages + provided with this release, for their respective component. + + + + . + + + + . + + + + . + + + + . + + + + . + + +
+ +
+ Compatibility + + This release does not contain any change impacting + compatibility. +
+ \ No newline at end of file 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 new file mode 100644 index 0000000..b0317b3 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml @@ -0,0 +1,62 @@ + + + + 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-release-info/swcomp.mk b/doc/book-enea-edge-release-info/swcomp.mk new file mode 100644 index 0000000..892f097 --- /dev/null +++ b/doc/book-enea-edge-release-info/swcomp.mk @@ -0,0 +1,10 @@ +# Component build specification + +# Version of THIS book +BOOK_VER ?= $(REL_VER)-dev + +DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) + +BOOKPACKAGES := book-enea-edge-release-info +BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Release Information" +BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) -- cgit v1.2.3-54-g00ecf