From ae8a4bb3dfe9be55f341b97a578bf031cacb7aa7 Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Thu, 17 Aug 2017 17:15:32 +0200 Subject: Restructuring Enea NFV Access Rel Notes USERDOCAP-224 Signed-off-by: Miruna Paun --- .../doc/about_release.xml | 45 +++-- doc/book-enea-nfv-access-release-info/doc/book.xml | 4 +- .../doc/eltf_params_updated.xml | 22 +-- .../doc/getting_enea_nfv_access.xml | 8 +- .../doc/main_changes.xml | 6 +- .../doc/system_requirements.xml | 12 +- .../doc/system_requirements_prerequisites.xml | 205 ++++++++++++++++++--- 7 files changed, 226 insertions(+), 76 deletions(-) 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 a3b6779..9ee8d14 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 @@ -103,23 +103,34 @@ /* GRUB EFI file */ - +
+ Supported Host Environment + + + + Ubuntu 14.04 LTS, 64-bitHardcoded now in this XML file. + Might be moved to the parameter file later.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. + + +
-
+
Provided Toolchain(s) (SDK) The SDK contains toolchains supporting cross-compilation of - applications for the targets on an x86_64 host. See the Enea NFV Access Application Development - Guide for information on how to build and install a - toolchain. + Guide for information on how to build and install a toolchain.
@@ -130,23 +141,19 @@ - Enea NFV Access Guide - – A document describing how to use ENFV Access, as well as use - cases and benchmark results. + Enea NFV Access Release Information – This document, + describing the Enea NFV Access release content. - Enea NFV Access Release Information – This document, - describing 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. - Enea NFV Access Open - Source Report – A document containing the open source - and license information pertaining to packages provided with Enea NFV - Access. + Enea NFV Access Open Source Report – A document containing + the open source and license information pertaining to packages + provided with Enea NFV Access. diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml index 41cd118..f98751b 100644 --- a/doc/book-enea-nfv-access-release-info/doc/book.xml +++ b/doc/book-enea-nfv-access-release-info/doc/book.xml @@ -23,8 +23,8 @@ - + 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 0d0d805..503eb7c 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 @@ -94,8 +94,8 @@ repo sync The table(s) below describes the target(s) supported in this Enea NFV Access release. -
- MACHINE p2041rdb - Information +
+ MACHINE Intel Xeon D-1521 - Information @@ -107,21 +107,21 @@ repo sync Target official name - P2041RDB + Intel Xeon D-1521 Architecture and Description - Power, e500mc + x86-64b Link to target datasheet - See link - to NXP's datasheet + See link to Intel's + datasheet @@ -149,14 +149,6 @@ repo sync Ethernet, I2C, SPI, PCI Express, USB, Flash, SD/SDHC/SDXC, RTC - - - Enea rpm folder for downloading RPM packages for this - target - - https://linux.enea.com/6/p2041rgb/rpm - 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 664766d..aedfd1b 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 @@ -43,9 +43,9 @@ - rpm directory – this directory - contains all the packages included in the distribution in rpm format, - which can be installed using the package manager. + rpm/deb directory – this directory + contains all the packages included in the distribution in rpm/deb + format, which can be installed using the package manager. @@ -98,7 +98,7 @@
-
+
Getting the Sources Enea NFV Access sources are available for cloning from a set of Git 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 ebe69c6..3dd3e80 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 @@ -9,7 +9,7 @@ This is the first release of Enea NFV Access, Networking profile. -
+
New Features Based in the Jira query: 'project = CPDX and fixVersion = "Enea @@ -30,8 +30,8 @@ For details, see the Git logs for the repositories specified in the - manifest files. See for more inf - on repos and the manifest. + manifest files. See for + more inf on repos and the manifest.
diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml index 015edb5..7bab63d 100644 --- a/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml @@ -1,11 +1,11 @@ -
+
System Requirements The host requirements listed below are extensive to allow for the - building of Linux images via the Yocto system and not just + building of Linux images via the Yocto system, and not just applications. Please also see the system requirements in the Yocto 2.1 documents: @@ -40,7 +40,7 @@ The downloaded code shall be built on a Linux host to generate images for your target or for emulation in QEMU. For information about the supported hosts and targets, see the Enea NFV Access Release Information in your Enea + role="bold">Enea Linux Release Information in your Enea Linux distribution. @@ -66,7 +66,7 @@ Images can be built or downloaded for any of the targets supported in this release, as specified in the Enea NFV Access Release Information. + role="bold">Enea Linux Release Information. @@ -98,7 +98,7 @@ Eclipse Project Release Notes for the version used. This can usually be found via http://www.eclipse.org/eclipse/development/readme_eclipse_version. - See the Enea NFV Access Release Information + See the Enea Linux Release Information for the Eclipse Version. @@ -146,7 +146,7 @@
System Shell Configuration - Before installing Enea NFV Access, ensure that bash is the default + Before installing Enea Linux, ensure that bash is the default shell. If your system runs Ubuntu, you can use ls -l to ensure 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 f598693..f4a815f 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 @@ -4,31 +4,182 @@ System Requirements and Prerequisites - Using Enea NFV Access or compiling applications requires that your git - environment be setup properly and for certain packages to be installed on - your NFV Access development host. - - Please refer to Getting - Started - First-Time Git Setup, for more details on how to set up - your git environment correctly, including how to set your identity using the - following commands: - - $ git config --global user.name "John Doe" -$ git config --global user.email johndoe@example.com - - First ensure the system is up-to-date, then for the supported - distribution(s), you need the following packages:INFO: The - programlisting below is a parameters in eltf_params_updated.xml with ID: - "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store - the commands for each host in the same programlisting with empty lines - between each - the comment with the FULL HOST name and version is - essential. - - - - + Using Enea NFV Access or compiling applications requires certain + packages to be installed on your NFV Access development host. + +
+ System Requirements + + The host requirements listed below are extensive to allow for the + building of Linux images via the Yocto system, and not just + applications. + + Please also see the system requirements in the Yocto 2.1 documents: + Yocto Project Start + http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources + and the Yocto Project Reference Manual + http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements. + If needed, replace the Yocto version in the link(s) provided with a more + recent version. + + + + + + + + + + + + Build host + requirements + system requirements + + + + + Linux distribution + + The downloaded code shall be built on a Linux host to + generate images for your target or for emulation in QEMU. For + information about the supported hosts and targets, see the + Enea Linux Release Information in + your Enea Linux distribution. + + + + Internet access + + Internet access must be available when building an image, + since bitbake downloads source files from various servers during + the build. + + + + Packages + + Depending on the Linux distribution and version on host, + some packages may be required, by bitbake for example. You will + install any required packages while following the installation + instructions. + + + + Targets + + Images can be built or downloaded for any of the targets + supported in this release, as specified in the Enea Linux Release Information. + + + + Disk space + + Your system should have at least 50 GB of free disk + space when bitbaking the basic enea-image-name kernel + image. For larger images and to allow for future + package extensions and variations in the build process, a minimum + of 100 GB free disk space is recommended. + + + + Recommended RAM + + Your system must have at least 4 GB available + RAM. It is recommended to have 8 GB RAM available for + parallel build jobs. + + + + Java + + Java + java + is required to run Eclipse. Currenly, Eclipse + generally recommends at least Java 6 JRE/JDK. More information + regarding operating environments for Eclipse, is provided in the + Eclipse Project Release Notes for the version + used. This can usually be found via + http://www.eclipse.org/eclipse/development/readme_eclipse_version. + See the Enea Linux Release Information + for the Eclipse Version. + + + + + + The build time depends on the capacity of the processor and other + hardware, available resources, speed of internet connection, load + situation, etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD + disks, a complete build from source could take about two hours. + + + + + + + + + + + + Target + Requirements + + + + External memory + + To boot a CGL + CGL + image, you need at least 16 GB on a hard-disk + drive + HDD + on eSATA, USB drive, or SD card.INFO: + (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good + margins)INFO: NFS does not support SELinux. In + order to have a security-enhanced Linux, one must take off from an + NFS-booted system and proceed with boot from external + memory. + + + + +
+ +
+ System Shell Configuration + + Before installing Enea Linux, ensure that bash is the default + shell. + + If your system runs Ubuntu, you can use ls -l to ensure + /usr/bin is a symbolic link to bash. In case the link + points to dash, which is default in some Ubuntu versions, change it to + bash by running sudo dpkg-reconfigure + dash and answer No to the + question "Use dash as the default system shell (/bin/sh)?": + + # ls -l /bin/sh + lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash +
+ +
+ Prerequisite Packages + + First ensure the system is up-to-date, then for the supported + distribution(s), you need the following packages:INFO: The + programlisting below is a parameters in eltf_params_updated.xml with ID: + "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store + the commands for each host in the same programlisting with empty lines + between each - the comment with the FULL HOST name and version is + essential. + + +
\ No newline at end of file -- cgit v1.2.3-54-g00ecf