summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/about_release.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-release-info/doc/about_release.xml')
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml341
1 files changed, 109 insertions, 232 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 203637c..a470845 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,8 +4,8 @@
4<chapter id="relinfo-about-release"> 4<chapter id="relinfo-about-release">
5 <title>About This Release</title> 5 <title>About This Release</title>
6 6
7 <para>This release of Enea NFV Access <xi:include href="eltf_params_updated.xml" 7 <para>This release of Enea NFV Access <xi:include
8 xmlns:xi="http://www.w3.org/2001/XInclude" 8 href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available 9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
10 Enea NFV Access distribution for a selected set of targets. This release is 10 Enea NFV Access distribution for a selected set of targets. This release is
11 generated from the yocto <xi:include href="eltf_params_updated.xml" 11 generated from the yocto <xi:include href="eltf_params_updated.xml"
@@ -22,146 +22,101 @@
22 for important details about formats and how to do! The idea is that ELTF 22 for important details about formats and how to do! The idea is that ELTF
23 will auto-create/update it.</remark></para> 23 will auto-create/update it.</remark></para>
24 24
25 <section id="relinfo-provided-contents"> 25 <section id="release-content">
26 <title>Provided Contents</title> 26 <title>NFV Access Release content</title>
27 27
28 <informaltable> 28 <para>The NFV Access 1.0 Release contains along with other items,
29 <tgroup cols="1"> 29 documentation, pre-built kernels and images, a bootloader and a
30 <thead> 30 SDK.</para>
31 <row> 31
32 <entry>Item</entry> 32 <para>The directories structure is detailed below:</para>
33 </row> 33
34 </thead> 34 <programlisting>-- documentation/
35 35 /* NFV Access documentation */
36 <tbody> 36-- inteld1521/
37 <row> 37 /* artifacts for the host side */
38 <entry><para>Source code, recipes and scripts for building the 38 -- deb/
39 distribution and SDKs. See <xref 39 /* deb packages */
40 linkend="relinfo-getting-enea-linux" />.</para></entry> 40 -- images/
41 </row> 41 -- enea-image-virtualization-host
42 42 /* precompiled artifacts for the Host release image */
43 <row> 43 -- various artifacts
44 <entry><para>Documentation. See <xref 44 -- enea-image-virtualization-host-sdk
45 linkend="relinfo-documentation" />.</para></entry> 45 /* precompiled artifacts for the Host SDK image.
46 </row> 46 The SDK image contains userspace tools and kernel
47 47 configurations necessary for developing, debugging
48 <row> 48 and profiling applications and kernel modules */
49 <entry>Pre-built binaries (kernel image, dtb &amp; rootfs)</entry> 49 -- various artifacts
50 </row> 50 -- sdk
51 51 /* NFV Access SDK for the host */
52 <row> 52 -- enea-glibc-x86_64-enea-image-virtualization-host-sdk /
53 <entry>Pre-built packages (RPM). See links for each 53 -corei7-64-toolchain-7.0.sh
54 target.<remark>INFO Below is an Eclipse row from 54 /* self-extracting archive installing
55 eltf_params_updated.xml. MANUALLY if eclipse is not included, set 55 cross-compilation toolchain for the host */
56 condition hidden on the row element BOTH in template.xml and in 56-- qemux86-64
57 updated.xml.</remark></entry> 57 /* artifacts for the guest side */
58 </row> 58 -- deb/
59 59 /* deb packages */
60 <xi:include href="eltf_params_updated.xml" 60 -- images/
61 xmlns:xi="http://www.w3.org/2001/XInclude" 61 -- enea-image-virtualization-guest
62 xpointer="element(eltf-eclipse-version-row)" /> 62 /* precompiled artifacts for the Guest image */
63 </tbody> 63 -- various artifacts
64 </tgroup> 64 -- sdk
65 </informaltable> 65 /* NFV Access SDK for the guest */
66 </section> 66 -- enea-glibc-x86_64-enea-image-virtualization-guest-sdk /
67 67 -core2-64-toolchain-7.0.sh
68 <section id="relinfo-supported-targets"> 68 /* self-extracting archive installing cross-compilation
69 <title>Supported Targets</title> 69 toolchain for the guest (QEMU x86-64) */
70 70</programlisting>
71 <informaltable> 71
72 <tgroup cols="3"> 72 <para>For each combination of image and target, the following set of
73 <colspec align="left" colname="c1" colwidth="1*" /> 73 artifacts is available:</para>
74 74
75 <colspec align="left" colname="c2" colwidth="1*" /> 75 <programlisting>-- bzImage
76 76 /* kernel image */
77 <colspec align="left" colname="c3" colwidth="1*" /> 77-- bzImage-&lt;target&gt;.bin
78 78 /* kernel image, same as above */
79 <thead valign="bottom"> 79-- config-&lt;target&gt;.config
80 <row> 80 /* kernel configuration file */
81 <entry>Target</entry> 81-- core-image-minimal-initramfs-&lt;target&gt;.cpio.gz
82 82 /* cpio archive of the initramfs */
83 <entry>Architecture</entry> 83-- core-image-minimal-initramfs-&lt;target&gt;.qemuboot.conf
84 84 /* qemu config file for the initramfs image */
85 <entry>Specification</entry> 85-- &lt;image-name&gt;-&lt;target&gt;.ext4
86 </row> 86 /* EXT4 image of the rootfs */
87 </thead> 87-- &lt;image-name&gt;-&lt;target&gt;.hddimg
88 88 /* msdos filesystem containing syslinux, kernel, initrd and rootfs image */
89 <tbody> 89-- &lt;image-name&gt;-&lt;target&gt;.iso
90 <row> 90 /* CD .iso image */
91 <entry>P2041RDB</entry> 91-- &lt;image-name&gt;-&lt;target&gt;.qemuboot.conf
92 92 /* qemu config file for the image */
93 <entry><para>Power, e500mc</para></entry> 93-- &lt;image-name&gt;-&lt;target&gt;.tar.gz
94 94 /* tar archive of the image */
95 <entry>See <ulink 95-- &lt;image-name&gt;-&lt;target&gt;.wic
96 url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link 96 /* Wic image */
97 to NXP's datasheet</ulink></entry> 97-- microcode.cpio
98 </row> 98 /* kernel microcode data */
99 </tbody> 99-- modules-&lt;target&gt;.tgz
100 </tgroup> 100 /* external kernel modules */
101 </informaltable> 101-- ovmf.*.qcow2
102 102 /* ovmf firmware for uefi support in qemu */
103 <para><remark>FIXME should autocreate a list of targets, hopefully from 103-- rmc.db
104 the generated README file, by using MAKEFILE to update pardoc-distro 104 /* Central RMC Database */
105 AND/OR also auto-create an XML file to include here with description text 105-- systemd-bootx64.efi
106 for each target etc..</remark></para> 106 /* systemd-boot EFI file */
107-- grub-efi-bootx64.efi
108 /* GRUB EFI file */</programlisting>
107 </section> 109 </section>
108 110
109 <section id="relinfo-supported-host-environment"> 111 <xi:include href="../../s_doceneacommon/doc/supported_host_environment.xml"
110 <title>Supported Host Environment</title> 112 xmlns:xi="http://www.w3.org/2001/XInclude" />
111
112 <itemizedlist>
113 <listitem>
114 <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file.
115 Might be moved to the parameter file later.</remark><remark>INFO Below
116 is a complete section with ID "eltf-target-tables-section" included
117 from elft_params_updated.xml. It contains a variable number of target
118 tables and the section title should be "Supported Targets with
119 Parameters". It has have a short sentence about what it is in the
120 beginning. The subtitles shall have the directory name of the target
121 in the manifest.</remark></para>
122 </listitem>
123 </itemizedlist>
124 </section>
125 113
126 <xi:include href="eltf_params_updated.xml" 114 <xi:include href="eltf_params_updated.xml"
127 xmlns:xi="http://www.w3.org/2001/XInclude" 115 xmlns:xi="http://www.w3.org/2001/XInclude"
128 xpointer="element(eltf-target-tables-section)" /> 116 xpointer="element(eltf-target-tables-section)" />
129 117
130 <section id="relinfo-packages"> 118 <section condition="hidden" id="relinfo-provided-sdk">
131 <title>Provided Packages</title> 119 <title>Provided Toolchain(s) (SDK)</title>
132
133 <para><informaltable>
134 <tgroup cols="2">
135 <colspec align="left" colname="c1" colwidth="3*" />
136
137 <colspec align="left" colname="c2" colwidth="6*" />
138
139 <thead valign="bottom">
140 <row>
141 <entry>Type of Packages</entry>
142
143 <entry>Reference</entry>
144 </row>
145 </thead>
146
147 <tbody>
148 <row>
149 <entry>Packages in Enea NFV Access</entry>
150
151 <entry><para>See the <olink
152 targetdoc="book_enea_linux_open_source"
153 targetptr="book_enea_linux_open_source"><trademark
154 class="registered">Enea</trademark> NFV Access Open Source
155 Report</olink></para></entry>
156 </row>
157
158 </tbody>
159 </tgroup>
160 </informaltable></para>
161 </section>
162
163 <section id="relinfo-provided-sdk">
164 <title>Provided Toolchain/s (SDK)</title>
165 120
166 <para>The SDK contains toolchains supporting cross-compilation of 121 <para>The SDK contains toolchains supporting cross-compilation of
167 applications for the targets on an x86_64 host. See the <olink 122 applications for the targets on an x86_64 host. See the <olink
@@ -175,120 +130,42 @@
175 <section id="relinfo-documentation"> 130 <section id="relinfo-documentation">
176 <title>Provided Documentation</title> 131 <title>Provided Documentation</title>
177 132
178 <para>The following Enea NFV Access manuals are available:</para> 133 <para>Enea NFV Access is provided with the following set of
134 documents:</para>
179 135
180 <itemizedlist spacing="compact"> 136 <itemizedlist spacing="compact">
181 <listitem> 137 <listitem>
182 <para><trademark class="registered">Enea</trademark> NFV Access Release 138 <para><olink targetdoc="book_enea_nfv_access_guide"
183 Information (this document)</para> 139 targetptr="book_enea_nfv_access_guide">Enea NFV Access Guide</olink>
184 </listitem> 140 &ndash; A document describing how to use ENFV Access, as well as use
185 141 cases and benchmark results.</para>
186 <listitem>
187 <para><olink targetdoc="book_enea_linux_platforms_dev_guide"
188 targetptr="book_enea_linux_platforms_dev_guide"><trademark
189 class="registered">Enea</trademark> NFV Access Development
190 Guide</olink></para>
191 </listitem>
192
193 <listitem>
194 <para><olink targetdoc="book_enea_linux_app_dev_guide"
195 targetptr="book_enea_linux_app_dev_guide"><trademark
196 class="registered">Enea</trademark> NFV Access Application Development
197 Guide</olink></para>
198 </listitem> 142 </listitem>
199 143
200 <listitem> 144 <listitem>
201 <para><trademark class="registered">Enea</trademark> NFV Access Networking 145 <para>Enea NFV Access Release Information &ndash; This document,
202 Profile Guide</para> 146 describing the Enea NFV Access release content</para>
203 </listitem> 147 </listitem>
204 148
205 <listitem> 149 <listitem>
206 <para><olink targetdoc="book_enea_linux_open_source" 150 <para><olink targetdoc="book_enea_nfv_access_open_source"
207 targetptr="book_enea_linux_open_source"><trademark 151 targetptr="book_enea_nfv_access_open_source">Enea NFV Access Open
208 class="registered">Enea</trademark> NFV Access Open Source 152 Source Report</olink> &ndash; A document containing the open source
209 Report</olink></para> 153 and license information pertaining to packages provided with Enea NFV
154 Access 1.0.</para>
210 </listitem> 155 </listitem>
211 156
212 <listitem> 157 <listitem>
213 <para><olink targetdoc="book_enea_linux_eclipse_open_source" 158 <para>Enea NFV Access Test Report &ndash; The document that summarizes
214 targetptr="book_enea_linux_eclipse_open_source"><trademark 159 the test results for the Enea NFV Access release.</para>
215 class="registered">Enea</trademark> NFV Access Eclipse Open Source
216 Report</olink></para>
217 </listitem> 160 </listitem>
218 161
219 <listitem> 162 <listitem>
220 <para><trademark class="registered">Enea</trademark> NFV Access Test 163 <para>Enea NFV Access Security Report &ndash; The document that lists
221 Report</para> 164 all security fixes included in the Enea NFV Access 1.0 release.</para>
222 </listitem>
223
224 <listitem>
225 <para><trademark class="registered">Enea</trademark> NFV Access Real-Time
226 Guide can be read at <ulink
227 url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para>
228 </listitem> 165 </listitem>
229 </itemizedlist> 166 </itemizedlist>
230 </section> 167 </section>
231 168
232 <section condition="hidden" id="relinfo-provided-other"> 169 <xi:include href="../../s_doceneacommon/doc/security_fixes.xml"
233 <title>Other Provided Functionality</title> 170 xmlns:xi="http://www.w3.org/2001/XInclude" />
234
235 <para>The functionality in a distribution depends on included packages in
236 the default image. In addition to the supported features, the following
237 functionality is also available, among other:<remark>INFO: This section
238 might be hidden by setting condition hidden on the section, MANUALLY in
239 this file.</remark></para>
240
241 <itemizedlist spacing="compact">
242 <listitem>
243 <para>On target T4240RDB:</para>
244
245 <itemizedlist spacing="compact">
246 <listitem>
247 <para>SRIO support in user space (NWRITE, NREAD, msg,
248 doorbell)</para>
249 </listitem>
250
251 <listitem>
252 <para>USDPAA</para>
253 </listitem>
254 </itemizedlist>
255 </listitem>
256
257 <listitem>
258 <para>Smart Package Management</para>
259 </listitem>
260 </itemizedlist>
261 </section>
262
263 <section id="relinfo-security-fixes">
264 <title>Security Fixes</title>
265
266 <para>See <ulink
267 url="http://www.enea.com/solutions/Enea-Linux/Security/CVEs-list">List of
268 CVEs addressed in Enea NFV Access</ulink> and <ulink
269 url="http://www.enea.com/solutions/Enea-Linux/Security#how-to-get-security-updates">How
270 to Get Security Updates</ulink>.</para>
271 </section>
272
273 <section condition="hidden" id="relinfo-excluded">
274 <title>Intentional Limitations</title>
275
276 <para>The following functionality supported in other Enea NFV Access releases
277 has been excluded in this release:<remark>INFO: This section might be
278 hidden by setting condition hidden on the section, MANUALLY in this
279 file.</remark><itemizedlist spacing="compact">
280 <listitem>
281 <para>Networking features: DPDK vSwitch, DPDK</para>
282 </listitem>
283
284 <listitem>
285 <para>Real-time features: Fully Preemptible Kernel (FPK) from the
286 PREEMPT_RT patch</para>
287 </listitem>
288
289 <listitem>
290 <para>Memory features: NUMA</para>
291 </listitem>
292 </itemizedlist></para>
293 </section>
294</chapter> \ No newline at end of file 171</chapter> \ No newline at end of file