summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2017-10-12 17:32:48 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2017-10-12 17:32:48 +0200
commit150b41c6029eb0a33ec72cd460948f7befa6e134 (patch)
tree62b0e19b12cc2be2c9c283884727413323fcf9fc /doc/book-enea-nfv-access-release-info
parent2e204be9a8c5d6d466da0adc32df5d77e1cc63d2 (diff)
downloadel_releases-nfv-access-150b41c6029eb0a33ec72cd460948f7befa6e134.tar.gz
Made the final updates needed to Rel Notes and UG
LXCR-7925 Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
Diffstat (limited to 'doc/book-enea-nfv-access-release-info')
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml102
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/system_requirements.xml162
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml149
3 files changed, 95 insertions, 318 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 6ca8568..383f4f2 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
@@ -27,76 +27,60 @@
27 27
28 <programlisting>-- documentation/ 28 <programlisting>-- documentation/
29 /* NFV Access documentation */ 29 /* NFV Access documentation */
30-- inteld1521/ 30-- x86-64 /* architecture */
31 /* artifacts for the host side */ 31 -- inteld1521/
32 -- deb/ 32 /* artifacts for the host side */
33 /* deb packages */ 33 -- deb/
34 -- images/ 34 /* deb packages */
35 -- enea-image-virtualization-host 35 -- images/
36 /* precompiled artifacts for the Host release image */ 36 -- enea-nfv-access
37 -- various artifacts 37 /* precompiled artifacts for the platform release image */
38 -- enea-image-virtualization-host-sdk 38 -- various artifacts (rootfs, kernel, config etc.)
39 /* precompiled artifacts for the Host SDK image. 39 -- enea-nfv-access-dev
40 The SDK image contains userspace tools and kernel 40 /* precompiled artifacts for development process. The image
41 configurations necessary for developing, debugging 41 contains userspace tools and kernel configurations necessary
42 and profiling applications and kernel modules */ 42 for developing, debugging and profiling applications and
43 -- various artifacts 43 kernel modules */
44 -- sdk 44 -- various artifacts
45 /* NFV Access SDK for the host */ 45 -- qemux86-64
46 -- enea-glibc-x86_64-enea-image-virtualization-host-sdk / 46 -- deb/
47 -corei7-64-toolchain-7.0.sh 47 /* deb packages */
48 /* self-extracting archive installing 48 -- images/
49 cross-compilation toolchain for the host */ 49 -- enea-nfv-access-guest
50-- qemux86-64 50 /* precompiled artifacts for QEMU/Docker release image */
51 /* artifacts for the guest side */ 51 -- various artifacts
52 -- deb/ 52 -- enea-nfv-access-guest-dev
53 /* deb packages */ 53 /* precompiled artifacts for development process. The image
54 -- images/ 54 contains userspace tools and kernel configurations necessary
55 -- enea-image-virtualization-guest 55 for developing, debugging and profiling applications and
56 /* precompiled artifacts for the Guest image */ 56 kernel modules */
57 -- various artifacts 57 -- various artifacts
58 -- sdk 58 -- install
59 /* NFV Access SDK for the guest */ 59 -- install-sdk.sh
60 -- enea-glibc-x86_64-enea-image-virtualization-guest-sdk / 60 /* self-extracting archive installing cross-compilation
61 -core2-64-toolchain-7.0.sh 61 toolchain for the platform */</programlisting>
62 /* self-extracting archive installing cross-compilation
63 toolchain for the guest (QEMU x86-64) */</programlisting>
64 62
65 <para>For each combination of image and target, the following set of 63 <para>For each combination of image and target, the following set of
66 artifacts is available:</para> 64 artifacts is available:</para>
67 65
68 <programlisting>-- bzImage 66 <programlisting>-- bzImage
69 /* kernel image */ 67 /* kernel image */
70-- bzImage-target.bin 68-- bzImage-&lt;target&gt;.bin
71 /* kernel image, same as above */ 69 /* kernel image, same as above */
72-- config-target.config 70-- config-&lt;target&gt;.config
73 /* kernel configuration file */ 71 /* kernel configuration file */
74-- core-image-minimal-initramfs-target.cpio.gz 72-- &lt;image-name&gt;-&lt;target&gt;.ext4.gz
75 /* cpio archive of the initramfs */ 73 /* compressed EXT4 image of the rootfs */
76-- core-image-minimal-initramfs-target.qemuboot.conf 74-- &lt;image-name&gt;-&lt;target&gt;.qcow2
77 /* qemu config file for the initramfs image */ 75 /* QCOW image for QEMU - only for guest images */
78-- image-name-target.ext4 76-- &lt;image-name&gt;-&lt;target&gt;.qemuboot.conf
79 /* EXT4 image of the rootfs */ 77 /* qemu config file for the guest images */
80-- image-name-target.hddimg 78-- &lt;image-name&gt;-&lt;target&gt;.tar.gz
81 /* msdos filesystem containing syslinux, kernel, initrd and rootfs image */
82-- image-name-target.iso
83 /* CD .iso image */
84-- image-name-target.qemuboot.conf
85 /* qemu config file for the image */
86-- image-name-target.tar.gz
87 /* tar archive of the image */ 79 /* tar archive of the image */
88-- image-name-target.wic
89 /* Wic image */
90-- microcode.cpio 80-- microcode.cpio
91 /* kernel microcode data */ 81 /* kernel microcode data - Intel arch specific*/
92-- modules-target.tgz 82-- modules-&lt;target&gt;.tgz
93 /* external kernel modules */ 83 /* external kernel modules */
94-- ovmf.*.qcow2
95 /* ovmf firmware for uefi support in qemu */
96-- rmc.db
97 /* Central RMC Database */
98-- systemd-bootx64.efi
99 /* systemd-boot EFI file */
100-- grub-efi-bootx64.efi 84-- grub-efi-bootx64.efi
101 /* GRUB EFI file */</programlisting> 85 /* GRUB EFI file */</programlisting>
102 </section> 86 </section>
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
deleted file mode 100644
index 7bab63d..0000000
--- a/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml
+++ /dev/null
@@ -1,162 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="enea-nfv-access-sysreq">
5 <title>System Requirements</title>
6
7 <para>The host requirements listed below are extensive to allow for the
8 building of Linux images via the Yocto system, and not just
9 applications.</para>
10
11 <para>Please also see the system requirements in the Yocto 2.1 documents:
12 Yocto Project Start <ulink
13 url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources">
14 http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink>
15 and the Yocto Project Reference Manual <ulink
16 url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements">
17 http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>.
18 If needed, replace the Yocto version in the link(s) provided with a more
19 recent version.</para>
20
21 <informaltable>
22 <tgroup cols="2">
23 <colspec align="left" colname="1" colwidth="1*" />
24
25 <colspec align="left" colname="2" colwidth="3*" />
26
27 <spanspec nameend="2" namest="1" spanname="onetwo" />
28
29 <tbody>
30 <row>
31 <entry spanname="onetwo"><emphasis role="bold"> Build host
32 requirements<indexterm>
33 <primary>system requirements</primary>
34 </indexterm></emphasis></entry>
35 </row>
36
37 <row>
38 <entry>Linux distribution</entry>
39
40 <entry>The downloaded code shall be built on a Linux host to
41 generate images for your target or for emulation in QEMU. For
42 information about the supported hosts and targets, see the <emphasis
43 role="bold">Enea Linux Release Information</emphasis> in your Enea
44 Linux distribution.</entry>
45 </row>
46
47 <row>
48 <entry>Internet access</entry>
49
50 <entry>Internet access must be available when building an image,
51 since bitbake downloads source files from various servers during the
52 build.</entry>
53 </row>
54
55 <row>
56 <entry>Packages</entry>
57
58 <entry>Depending on the Linux distribution and version on host, some
59 packages may be required, by bitbake for example. You will install
60 any required packages while following the installation
61 instructions.</entry>
62 </row>
63
64 <row>
65 <entry>Targets</entry>
66
67 <entry>Images can be built or downloaded for any of the targets
68 supported in this release, as specified in the <emphasis
69 role="bold">Enea Linux Release Information</emphasis>.</entry>
70 </row>
71
72 <row>
73 <entry>Disk space</entry>
74
75 <entry><para>Your system should have at least 50 GB of free disk
76 space when bitbaking the basic enea-image-name kernel image.</para>
77 <para>For larger images and to allow for future package extensions
78 and variations in the build process, a minimum of 100 GB free disk
79 space is recommended.</para></entry>
80 </row>
81
82 <row>
83 <entry>Recommended RAM</entry>
84
85 <entry><para>Your system must have at least 4 GB available
86 RAM.</para> <para>It is recommended to have 8 GB RAM available for
87 parallel build jobs.</para></entry>
88 </row>
89
90 <row>
91 <entry>Java</entry>
92
93 <entry>Java <indexterm>
94 <primary>java</primary>
95 </indexterm>is required to run Eclipse. Currenly, Eclipse
96 generally recommends at least Java 6 JRE/JDK. More information
97 regarding operating environments for Eclipse, is provided in the
98 <emphasis>Eclipse Project Release Notes</emphasis> for the version
99 used. This can usually be found via
100 http://www.eclipse.org/eclipse/development/readme_eclipse_version.
101 See the <emphasis role="bold">Enea Linux Release Information
102 </emphasis>for the Eclipse Version.</entry>
103 </row>
104 </tbody>
105 </tgroup>
106 </informaltable>
107
108 <para>The build time depends on the capacity of the processor and other
109 hardware, available resources, speed of internet connection, load situation,
110 etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD disks, a complete
111 build from source could take about two hours.</para>
112
113 <informaltable>
114 <tgroup cols="2">
115 <colspec align="left" colname="1" colwidth="1*" />
116
117 <colspec align="left" colname="2" colwidth="3*" />
118
119 <spanspec nameend="2" namest="1" spanname="onetwo" />
120
121 <tbody>
122 <row>
123 <entry spanname="onetwo"><emphasis role="bold">Target
124 Requirements</emphasis></entry>
125 </row>
126
127 <row>
128 <entry>External memory</entry>
129
130 <entry>To boot a CGL<indexterm>
131 <primary>CGL</primary>
132 </indexterm> image, you need at least 16 GB on a hard-disk
133 drive<indexterm>
134 <primary>HDD</primary>
135 </indexterm> on eSATA, USB drive, or SD card.<remark>INFO: (packed
136 rootfs 4.5 GB + unpacked rootfs 1.5 GB + good
137 margins)</remark><remark>INFO: NFS does not support SELinux. In
138 order to have a security-enhanced Linux, one must take off from an
139 NFS-booted system and proceed with boot from external
140 memory.</remark></entry>
141 </row>
142 </tbody>
143 </tgroup>
144 </informaltable>
145
146 <section id="ensure-bash">
147 <title>System Shell Configuration</title>
148
149 <para>Before installing Enea Linux, ensure that bash is the default
150 shell.</para>
151
152 <para>If your system runs Ubuntu, you can use ls -l to ensure
153 <filename>/usr/bin</filename> is a symbolic link to bash. In case the link
154 points to dash, which is default in some Ubuntu versions, change it to
155 bash by running <emphasis role="bold">sudo dpkg-reconfigure
156 dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the
157 question "Use dash as the default system shell (/bin/sh)?":</para>
158
159 <programlisting># ls -l /bin/sh
160 lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
161 </section>
162</section> \ 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 3217339..fb3f57f 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
@@ -5,101 +5,56 @@
5 <title>System Requirements and Prerequisites</title> 5 <title>System Requirements and Prerequisites</title>
6 6
7 <para>Using Enea NFV Access or compiling applications requires certain 7 <para>Using Enea NFV Access or compiling applications requires certain
8 packages to be installed on your NFV Access development host.</para> 8 packages to be installed on your NFV Access development host. The host
9 9 requirements listed below are extensive to allow getting Enea NFV Access to
10 <section id="enea-nfv-access-sysreq"> 10 be booted on target machines and for building applications.</para>
11 <title>System Requirements</title> 11
12 12 <informaltable>
13 <para>The host requirements listed below are extensive to allow getting 13 <tgroup cols="2">
14 Enea NFV Access to be booted on target machines and for building 14 <colspec align="left" colname="1" colwidth="1*" />
15 applications.</para> 15
16 16 <colspec align="left" colname="2" colwidth="3*" />
17 <informaltable> 17
18 <tgroup cols="2"> 18 <spanspec nameend="2" namest="1" spanname="onetwo" />
19 <colspec align="left" colname="1" colwidth="1*" /> 19
20 20 <tbody>
21 <colspec align="left" colname="2" colwidth="3*" /> 21 <row>
22 22 <entry spanname="onetwo"><emphasis role="bold"> Build Host
23 <spanspec nameend="2" namest="1" spanname="onetwo" /> 23 Requirements<indexterm>
24 24 <primary>system requirements</primary>
25 <tbody> 25 </indexterm></emphasis></entry>
26 <row> 26 </row>
27 <entry spanname="onetwo"><emphasis role="bold"> Build Host 27
28 Requirements<indexterm> 28 <row>
29 <primary>system requirements</primary> 29 <entry>Linux distribution</entry>
30 </indexterm></emphasis></entry> 30
31 </row> 31 <entry>The downloaded product can installed on the target machine
32 32 using a Linux host. For information about the supported hosts and
33 <row> 33 targets, see <xref
34 <entry>Linux distribution</entry> 34 linkend="relinfo-supported-host-environment" />.</entry>
35 35 </row>
36 <entry>The downloaded product can installed on the target machine 36
37 using a Linux host. For information about the supported hosts and 37 <row>
38 targets, see <xref 38 <entry>Packages</entry>
39 linkend="relinfo-supported-host-environment" />.</entry> 39
40 </row> 40 <entry>Depending on the Linux distribution and version of the host,
41 41 some packages may be required. See details on what packages are
42 <row> 42 needed and how to install, in the following sections.</entry>
43 <entry>Packages</entry> 43 </row>
44 44
45 <entry>Depending on the Linux distribution and version of the 45 <row>
46 host, some packages may be required. See details on what packages 46 <entry>Disk space</entry>
47 are needed and how to install, in the following sections.</entry> 47
48 </row> 48 <entry>Your system should have at least 50 GB of free disk space for
49 49 installing the SDK or cross-compiling applications.</entry>
50 <row> 50 </row>
51 <entry>Disk space</entry> 51
52 52 <row>
53 <entry>Your system should have at least 50 GB of free disk space 53 <entry>Recommended RAM</entry>
54 for installing the SDK or cross-compiling applications.</entry> 54
55 </row> 55 <entry>Your system must have at least 4 GB available RAM.</entry>
56 56 </row>
57 <row> 57 </tbody>
58 <entry>Recommended RAM</entry> 58 </tgroup>
59 59 </informaltable>
60 <entry>Your system must have at least 4 GB available RAM.</entry>
61 </row>
62 </tbody>
63 </tgroup>
64 </informaltable>
65 </section>
66
67 <section id="ensure-bash">
68 <title>System Shell Configuration</title>
69
70 <para>Before installing Enea NFV Access, ensure that bash is the default
71 shell.</para>
72
73 <para>If your system runs Ubuntu, you can use ls -l to ensure
74 <filename>/usr/bin</filename> is a symbolic link to bash. In case the link
75 points to dash, which is default in some Ubuntu versions, change it to
76 bash by running <emphasis role="bold">sudo dpkg-reconfigure
77 dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the
78 question "Use dash as the default system shell (/bin/sh)?":</para>
79
80 <programlisting># ls -l /bin/sh
81 lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
82 </section>
83
84 <section id="preq-packages">
85 <title>Prerequisite Packages</title>
86
87 <para>First ensure the system is up-to-date, then for the supported
88 distribution(s), you need the following packages:<remark>INFO: The
89 programlisting below is a parameters in eltf_params_updated.xml with ID:
90 "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
91 the commands for each host in the same programlisting with empty lines
92 between each - the comment with the FULL HOST name and version is
93 essential.</remark></para>
94
95 <xi:include href="eltf_params_updated.xml"
96 xmlns:xi="http://www.w3.org/2001/XInclude"
97 xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
98 </section>
99
100 <section id="dns-server">
101 <title>Installing and Configuring the DNS server</title>
102
103 <para>CONTENT NEEDED</para>
104 </section>
105</chapter> \ No newline at end of file 60</chapter> \ No newline at end of file