From b23e40cff8fac1215802541a6514a51473c11ce9 Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Fri, 25 May 2018 11:27:12 +0200 Subject: Updated the rel notes with olinks, rephrasing of various paragraphs USERDOCAP-243 Updated several chapters to include comments made by iosc/dape. Signed-off-by: Miruna Paun --- .../doc/about_release.xml | 179 +++++++-------------- .../doc/eltf_params_updated.xml | 175 +++++++++++--------- .../doc/getting_enea_nfv_access.xml | 51 +++--- .../doc/known_bugs_and_limitations.xml | 21 +-- .../doc/main_changes.xml | 23 +-- .../doc/system_requirements_prerequisites.xml | 3 +- 6 files changed, 203 insertions(+), 249 deletions(-) (limited to 'doc/book-enea-nfv-access-release-info') diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml index 0f5e5e5..171a5fa 100644 --- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml @@ -4,12 +4,16 @@ About This Release - Enea NFV Access includes following - components:INFO eltf_params_updated.xml contains many parameters in - the book, also in the open source books, and MUST be created FROM This release of Enea NFV Access includes optimizations to the + FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, + USB-stick based installation options, and various other optimizations, + security patches and documentation updated accordingly. + + INFO eltf_params_updated.xml + contains many parameters in the book, also in the open source books, and + MUST be created FROM eltf_params_template.xml. The parameters are automatically used in the books, via xi:include statements, similar to how parameters from pardoc-distro.xml are included in the book. Read the file @@ -17,84 +21,12 @@ for important details about formats and how to do! The idea is that ELTF will auto-create/update it. - - - DPDK 18.02 - - - - OVS 2.9 - - - - Element ODM: FCAPS framework with NETCONF and Yang - - - - Edge Link Netconf (beta): NETCONF based VNF lifecycle Management - Tool - - - - Extended Tools Feature Set: - - - - python-pip - - - - dosfstools - - - - htop - - - - - - Unified cross-development SDK for host and virtualized - environments - - - - Native toolchain support on development image - - - - USB-stick based installation - - - - Product Maintenance: - - - - Optimizations - - - - Security patches - - - - Bug fixes - - - - Updated documentation - - - - -
Enea NFV Access Release Content - The current release contains along with other items, documentation, - pre-built kernels and images, a bootloader and a SDK. The directory - structure is detailed below: + The current release contains documentation, prebuilt kernels and + images, a bootloader, an SDK and an eSDK. The directory structure is + detailed below: -- documentation/ /* Enea NFV Access documentation */ @@ -185,9 +117,9 @@ For each combination of image and target, the following set of artifacts is available: - -- Image + -- bzImage /* kernel image */ --- Image-target.bin +-- bzImage-target.bin /* kernel image, same as above */ -- config-target.config /* kernel configuration file */ @@ -200,11 +132,13 @@ -- image-name-target.tar.gz /* tar archive of the image */ -- modules-<target>.tgz - /* external kernel modules */ + /* external kernel modules */ +-- grub-efi-bootx64.efi + /* GRUB EFI file */ - -- bzImage + -- Image /* kernel image */ --- bzImage-target.bin +-- Image-target.bin /* kernel image, same as above */ -- config-target.config /* kernel configuration file */ @@ -217,9 +151,7 @@ -- image-name-target.tar.gz /* tar archive of the image */ -- modules-<target>.tgz - /* external kernel modules */ --- grub-efi-bootx64.efi - /* GRUB EFI file */ + /* external kernel modules */
@@ -247,69 +179,74 @@ xpointer="element(eltf-target-tables-section)" />
- Provided Toolchain(s) (SDK) + Provided Toolchains - The provided SDK contains toolchains supporting cross-compilation of - applications for both the host and the guest targets on an arm64x86-64 machine. - - (Possibly add this in later) See the Enea NFV Access Application Development - Guide for information on how to build and install a - toolchain. + The provided SDK and eSDK contain toolchains supporting + cross-compilation of applications for both the host and the guest targets + on an x86-64arm64 machine.
Provided Documentation - Enea NFV Access is provided with the following set of + This release of Enea NFV Access contains the following set of documents: - Enea NFV Access Release Information - This document, describing - the Enea NFV Access release content. + Enea NFV Access Release Information. Describes the Enea NFV + Access release content. - - Enea NFV Access Guide - A document describing how to use Enea - NFV Access, as well as use cases and benchmark results. + + . Describes + how to use Enea NFV Access, provides use cases and benchmark + results. + + + + Enea NFV + Access Guide. Describes how to use Enea NFV Access, + provides use cases and benchmark results. - Enea NFV Access Open Source Report - A document containing the + . Contains open source and license information pertaining to packages provided with Enea NFV Access. - Enea NFV Access Development Open Source Report - A document - containing open source and license information pertaining to packages - provided with Enea NFV Access for application developers. + Enea NFV Access Development Open Source Report. Contains open + source and license information pertaining to packages provided with + Enea NFV Access for application developers. - Enea NFV Access Guest Open Source Report - A document containing - open source and license information concerning packages provided with - Enea NFV Access for a guest target. + Enea NFV Access Guest Open Source Report. Contains open source + and license information concerning packages provided with Enea NFV + Access for a guest target. - Enea NFV Access Guest Development Open Source Report - A - document detailing the open source and license information of packages - provided with Enea NFV Access for applications development on a guest - target. + Enea NFV Access Guest Development Open Source Report. Details + the open source and license information of packages provided with Enea + NFV Access for applications development on a guest target. - Enea NFV Access Test Report - The document that summarizes the - test results for the Enea NFV Access release. + Enea NFV Access Test Report. Summarizes the test results for the + Enea NFV Access release. - Enea NFV Access Security Report - The document that lists all - security fixes included in the Enea NFV Access release. + Enea NFV Access Security Report. Lists all security fixes + included in this release of Enea NFV Access.
@@ -320,4 +257,4 @@ A detailed list of all security patches included with this release is available in the Enea NFV Access Security Report document.
- + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml index 40bc8bf..d8ae98e 100644 --- a/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml @@ -42,7 +42,8 @@ export PATH=~/bin:$PATH correct also compared to the "previous" REL VER in pardoc-distro.xml "prev_baseline". - 1.1.1 + 2.01.1.1 2.1 @@ -94,116 +95,130 @@ repo sync The table(s) below describes the target(s) supported in this Enea NFV Access release. -
+ MACHINE Information - - - + + - + + + Component - - - Target official name + Description + + - OCTEON TX™ cn8304 - + + + Target official name - - Architecture and Description + Intel Xeon D-1521 + - arm64 - + + Architecture and Description - - Link to target datasheet + x86-64 + - See link to OCTEON - TX™ cn8304 datasheet - + + Link to target datasheet - - Poky version + Intel's + datasheet + - Git-commit-id: - f01b909a266498853e6b3f10e6b39f2d95148129 - + + Poky version - - GCC version + Git-commit-id: + f01b909a266498853e6b3f10e6b39f2d95148129 + - 5.3FIXME - + + GCC version - - Linux Kernel Version + 5.3FIXME + - 3.12FIXME - + + Linux Kernel Version - - Supported Drivers + 3.12FIXME + - Ethernet, RTC, UART - - - - - - + + Supported Drivers - + Ethernet, RTC, UART + + + +
- - - Target official name + + MACHINE Information - Intel Xeon D-1521 - + + - - Architecture and Description + + + Component - x86-64 - + Description + + - - Link to target datasheet + + + Target official name - See link to Intel's - datasheet - + OCTEON TX™ cn8304 + - - Poky version + + Architecture and Description - Git-commit-id: - f01b909a266498853e6b3f10e6b39f2d95148129 - + arm64 + - - GCC version + + Link to target datasheet - 5.3FIXME - + OCTEON + TX™ cn8304 datasheet + - - Linux Kernel Version + + Poky version - 3.12FIXME - + Git-commit-id: + f01b909a266498853e6b3f10e6b39f2d95148129 + + + + GCC version + + 5.3FIXME + - - Supported Drivers + + Linux Kernel Version - Ethernet, RTC, UART - - - - - + 3.12FIXME + + + + Supported Drivers + + Ethernet, RTC, UART + + + +
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml index 2bf9c22..5d8c1ce 100644 --- a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml +++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml @@ -4,25 +4,40 @@ Getting Enea NFV Access - Enea NFV Access releases are available as binaries ready for download - on the Enea NFV Access releases and updates are available as binaries ready + for download from the Enea - Download Portal. Updates of Enea NFV Access are also available for - download through the portal. - - Log in using the credentials provided by Enea. Using the menu at the - top, browse to the NFV section, which will provide access - to a Files section and an Online - Documentation section. The Files section lists - each Enea NFV Access release version as a separate download package. - Clicking on any of the release packages will provide further details such as - the date when it was made available, the file size and the changelog. Most - importantly, it provides access to the download links. - - Each archive is mirrored in several places, geographically. Choose the - archive in the region closest to you for better download speeds. For details - about the contents of the release package, please refer to . + Download Portal. + + Downloading Enea NFV Access + + + + Log in using the credentials provided by Enea. + + + + Using the menu at the top, browse to the NFV + section, which will provide access to a Files section + and an Online Documentation section. + + + + The Files section lists each Enea NFV Access + release version as a separate download package. Clicking on any of the + release packages will provide further details such as the date when it + was made available, the file size and the changelog. Most importantly, + it provides access to the download links. + + + + Choose the archive in the region closest to you for better + download speeds and download it. + + + + For details about the contents of the release package, please refer to + . The Online documentation section provides quick access to the documents delivered with the release. For details about the diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index 2d3e576..cccb4df 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml @@ -2,7 +2,7 @@ - Known Problems in This Release + Known Issues in this Release All known issues listed in this chapter will be addressed in maintenance updates following the major release.INFO: The Release-Specific Limitations - Issues concerning the current - release: - - - OFP and ODP are not included with the current release but they - will be included in a later maintenance update.FIXME, - requesting help from Ca - - Kernel modules build using the SDK cannot be removed from the enea-nfv-access image. - - - Issues affecting - documentation: - - - - Documents provided in this release will continue to be regularly - updated with additional content. - PDF navigation: When using diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml index 48e913f..aabe461 100644 --- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml @@ -4,9 +4,10 @@ Main Changes - This chapter provides information about the new features added in the - current release, as well as details on the provided packages and the - backwards compatibility with previous versions of Enea NFV Access. + 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 of Enea NFV Access if + applicable.
New Features @@ -23,6 +24,10 @@ OVS 2.9 + + + ODP + @@ -60,7 +65,7 @@ - Unified cross-development SDK for host and virtualized + Unified cross-development SDK and eSDK for host and virtualized environments @@ -107,12 +112,12 @@
Compatibility - Due to the fact that the current release is only - supported on ARM reference boards, it is not backwards compatible with - previous versions of Enea NFV Access. - Due to the fact that ODP and OFP are not included in this release, any applications dependent on these components are not compatible with the current release. + + Due to the fact that the current release is only + supported on ARM reference boards, it is not backwards compatible with + previous versions of Enea NFV Access.
- + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml index 44e70af..b0317b3 100644 --- a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml @@ -46,7 +46,8 @@ Disk space Your build host should have at least 50 GB of free disk space - for installing the SDK or cross-compiling applications. + for installing the SDK, eSDK or cross-compiling + applications. -- cgit v1.2.3-54-g00ecf