diff options
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.xml | 179 |
1 files changed, 58 insertions, 121 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 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 @@ | |||
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>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)" /> includes following | 9 | xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the |
10 | components:<remark>INFO <emphasis | 10 | FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, |
11 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in | 11 | USB-stick based installation options, and various other optimizations, |
12 | the book, also in the open source books, and MUST be created FROM <emphasis | 12 | security patches and documentation updated accordingly.</para> |
13 | |||
14 | <para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis> | ||
15 | contains many parameters in the book, also in the open source books, and | ||
16 | MUST be created FROM <emphasis | ||
13 | role="bold">eltf_params_template.xml</emphasis>. The parameters are | 17 | role="bold">eltf_params_template.xml</emphasis>. The parameters are |
14 | automatically used in the books, via xi:include statements, similar to how | 18 | automatically used in the books, via xi:include statements, similar to how |
15 | parameters from pardoc-distro.xml are included in the book. Read the file | 19 | parameters from pardoc-distro.xml are included in the book. Read the file |
@@ -17,84 +21,12 @@ | |||
17 | for important details about formats and how to do! The idea is that ELTF | 21 | for important details about formats and how to do! The idea is that ELTF |
18 | will auto-create/update it.</remark></para> | 22 | will auto-create/update it.</remark></para> |
19 | 23 | ||
20 | <itemizedlist> | ||
21 | <listitem> | ||
22 | <para>DPDK 18.02</para> | ||
23 | </listitem> | ||
24 | |||
25 | <listitem> | ||
26 | <para>OVS 2.9</para> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem condition="intel"> | ||
30 | <para>Element ODM: FCAPS framework with NETCONF and Yang</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para>Edge Link Netconf (beta): NETCONF based VNF lifecycle Management | ||
35 | Tool</para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para>Extended Tools Feature Set:</para> | ||
40 | |||
41 | <itemizedlist> | ||
42 | <listitem> | ||
43 | <para>python-pip</para> | ||
44 | </listitem> | ||
45 | |||
46 | <listitem> | ||
47 | <para>dosfstools</para> | ||
48 | </listitem> | ||
49 | |||
50 | <listitem> | ||
51 | <para>htop</para> | ||
52 | </listitem> | ||
53 | </itemizedlist> | ||
54 | </listitem> | ||
55 | |||
56 | <listitem> | ||
57 | <para>Unified cross-development SDK for host and virtualized | ||
58 | environments</para> | ||
59 | </listitem> | ||
60 | |||
61 | <listitem> | ||
62 | <para>Native toolchain support on development image</para> | ||
63 | </listitem> | ||
64 | |||
65 | <listitem> | ||
66 | <para>USB-stick based installation</para> | ||
67 | </listitem> | ||
68 | |||
69 | <listitem> | ||
70 | <para>Product Maintenance:</para> | ||
71 | |||
72 | <itemizedlist> | ||
73 | <listitem> | ||
74 | <para>Optimizations</para> | ||
75 | </listitem> | ||
76 | |||
77 | <listitem> | ||
78 | <para>Security patches</para> | ||
79 | </listitem> | ||
80 | |||
81 | <listitem> | ||
82 | <para>Bug fixes</para> | ||
83 | </listitem> | ||
84 | |||
85 | <listitem> | ||
86 | <para>Updated documentation</para> | ||
87 | </listitem> | ||
88 | </itemizedlist> | ||
89 | </listitem> | ||
90 | </itemizedlist> | ||
91 | |||
92 | <section id="release-content"> | 24 | <section id="release-content"> |
93 | <title>Enea NFV Access Release Content</title> | 25 | <title>Enea NFV Access Release Content</title> |
94 | 26 | ||
95 | <para>The current release contains along with other items, documentation, | 27 | <para>The current release contains documentation, prebuilt kernels and |
96 | pre-built kernels and images, a bootloader and a SDK. The directory | 28 | images, a bootloader, an SDK and an eSDK. The directory structure is |
97 | structure is detailed below:</para> | 29 | detailed below:</para> |
98 | 30 | ||
99 | <programlisting condition="intel">-- documentation/ | 31 | <programlisting condition="intel">-- documentation/ |
100 | /* Enea NFV Access documentation */ | 32 | /* Enea NFV Access documentation */ |
@@ -185,9 +117,9 @@ | |||
185 | <para>For each combination of image and target, the following set of | 117 | <para>For each combination of image and target, the following set of |
186 | artifacts is available:</para> | 118 | artifacts is available:</para> |
187 | 119 | ||
188 | <programlisting condition="arm">-- Image | 120 | <programlisting condition="intel">-- bzImage |
189 | /* kernel image */ | 121 | /* kernel image */ |
190 | -- Image-target.bin | 122 | -- bzImage-target.bin |
191 | /* kernel image, same as above */ | 123 | /* kernel image, same as above */ |
192 | -- config-target.config | 124 | -- config-target.config |
193 | /* kernel configuration file */ | 125 | /* kernel configuration file */ |
@@ -200,11 +132,13 @@ | |||
200 | -- image-name-target.tar.gz | 132 | -- image-name-target.tar.gz |
201 | /* tar archive of the image */ | 133 | /* tar archive of the image */ |
202 | -- modules-<target>.tgz | 134 | -- modules-<target>.tgz |
203 | /* external kernel modules */</programlisting> | 135 | /* external kernel modules */ |
136 | -- grub-efi-bootx64.efi | ||
137 | /* GRUB EFI file */</programlisting> | ||
204 | 138 | ||
205 | <programlisting condition="intel">-- bzImage | 139 | <programlisting condition="arm">-- Image |
206 | /* kernel image */ | 140 | /* kernel image */ |
207 | -- bzImage-target.bin | 141 | -- Image-target.bin |
208 | /* kernel image, same as above */ | 142 | /* kernel image, same as above */ |
209 | -- config-target.config | 143 | -- config-target.config |
210 | /* kernel configuration file */ | 144 | /* kernel configuration file */ |
@@ -217,9 +151,7 @@ | |||
217 | -- image-name-target.tar.gz | 151 | -- image-name-target.tar.gz |
218 | /* tar archive of the image */ | 152 | /* tar archive of the image */ |
219 | -- modules-<target>.tgz | 153 | -- modules-<target>.tgz |
220 | /* external kernel modules */ | 154 | /* external kernel modules */</programlisting> |
221 | -- grub-efi-bootx64.efi | ||
222 | /* GRUB EFI file */</programlisting> | ||
223 | </section> | 155 | </section> |
224 | 156 | ||
225 | <section id="relinfo-supported-host-environment"> | 157 | <section id="relinfo-supported-host-environment"> |
@@ -247,69 +179,74 @@ | |||
247 | xpointer="element(eltf-target-tables-section)" /> | 179 | xpointer="element(eltf-target-tables-section)" /> |
248 | 180 | ||
249 | <section id="relinfo-provided-sdk"> | 181 | <section id="relinfo-provided-sdk"> |
250 | <title>Provided Toolchain(s) (SDK)</title> | 182 | <title>Provided Toolchains</title> |
251 | 183 | ||
252 | <para>The provided SDK contains toolchains supporting cross-compilation of | 184 | <para>The provided SDK and eSDK contain toolchains supporting |
253 | applications for both the host and the guest targets on an <filename | 185 | cross-compilation of applications for both the host and the guest targets |
254 | condition="arm">arm64</filename><filename | 186 | on an <filename condition="intel">x86-64</filename><filename |
255 | condition="intel">x86-64</filename> machine.</para> | 187 | condition="arm">arm64</filename> machine.</para> |
256 | |||
257 | <para><remark>(Possibly add this in later) See the <trademark | ||
258 | class="registered">Enea</trademark> NFV Access Application Development | ||
259 | Guide for information on how to build and install a | ||
260 | toolchain.</remark></para> | ||
261 | </section> | 188 | </section> |
262 | 189 | ||
263 | <section id="relinfo-documentation"> | 190 | <section id="relinfo-documentation"> |
264 | <title>Provided Documentation</title> | 191 | <title>Provided Documentation</title> |
265 | 192 | ||
266 | <para>Enea NFV Access is provided with the following set of | 193 | <para>This release of Enea NFV Access contains the following set of |
267 | documents:</para> | 194 | documents:</para> |
268 | 195 | ||
269 | <itemizedlist> | 196 | <itemizedlist> |
270 | <listitem> | 197 | <listitem> |
271 | <para>Enea NFV Access Release Information - This document, describing | 198 | <para>Enea NFV Access Release Information. Describes the Enea NFV |
272 | the Enea NFV Access release content.</para> | 199 | Access release content.</para> |
273 | </listitem> | 200 | </listitem> |
274 | 201 | ||
275 | <listitem> | 202 | <listitem condition="intel"> |
276 | <para>Enea NFV Access Guide - A document describing how to use Enea | 203 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
277 | NFV Access, as well as use cases and benchmark results.</para> | 204 | xmlns:xi="http://www.w3.org/2001/XInclude" |
205 | xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes | ||
206 | how to use Enea NFV Access, provides use cases and benchmark | ||
207 | results.</para> | ||
208 | </listitem> | ||
209 | |||
210 | <listitem condition="arm"> | ||
211 | <para><phrase><olink targetdoc="book_enea_nfv_access_guide">Enea NFV | ||
212 | Access Guide</olink></phrase>. Describes how to use Enea NFV Access, | ||
213 | provides use cases and benchmark results.</para> | ||
278 | </listitem> | 214 | </listitem> |
279 | 215 | ||
280 | <listitem> | 216 | <listitem> |
281 | <para>Enea NFV Access Open Source Report - A document containing the | 217 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
218 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
219 | xpointer="element(book_enea_nfv_access_open_source/1)" />. Contains | ||
282 | open source and license information pertaining to packages provided | 220 | open source and license information pertaining to packages provided |
283 | with Enea NFV Access.</para> | 221 | with Enea NFV Access.</para> |
284 | </listitem> | 222 | </listitem> |
285 | 223 | ||
286 | <listitem> | 224 | <listitem> |
287 | <para>Enea NFV Access Development Open Source Report - A document | 225 | <para>Enea NFV Access Development Open Source Report. Contains open |
288 | containing open source and license information pertaining to packages | 226 | source and license information pertaining to packages provided with |
289 | provided with Enea NFV Access for application developers.</para> | 227 | Enea NFV Access for application developers.</para> |
290 | </listitem> | 228 | </listitem> |
291 | 229 | ||
292 | <listitem> | 230 | <listitem> |
293 | <para>Enea NFV Access Guest Open Source Report - A document containing | 231 | <para>Enea NFV Access Guest Open Source Report. Contains open source |
294 | open source and license information concerning packages provided with | 232 | and license information concerning packages provided with Enea NFV |
295 | Enea NFV Access for a guest target.</para> | 233 | Access for a guest target.</para> |
296 | </listitem> | 234 | </listitem> |
297 | 235 | ||
298 | <listitem> | 236 | <listitem> |
299 | <para>Enea NFV Access Guest Development Open Source Report - A | 237 | <para>Enea NFV Access Guest Development Open Source Report. Details |
300 | document detailing the open source and license information of packages | 238 | the open source and license information of packages provided with Enea |
301 | provided with Enea NFV Access for applications development on a guest | 239 | NFV Access for applications development on a guest target.</para> |
302 | target.</para> | ||
303 | </listitem> | 240 | </listitem> |
304 | 241 | ||
305 | <listitem condition="hidden"> | 242 | <listitem condition="hidden"> |
306 | <para>Enea NFV Access Test Report - The document that summarizes the | 243 | <para>Enea NFV Access Test Report. Summarizes the test results for the |
307 | test results for the Enea NFV Access release.</para> | 244 | Enea NFV Access release.</para> |
308 | </listitem> | 245 | </listitem> |
309 | 246 | ||
310 | <listitem> | 247 | <listitem> |
311 | <para>Enea NFV Access Security Report - The document that lists all | 248 | <para>Enea NFV Access Security Report. Lists all security fixes |
312 | security fixes included in the Enea NFV Access release.</para> | 249 | included in this release of Enea NFV Access.</para> |
313 | </listitem> | 250 | </listitem> |
314 | </itemizedlist> | 251 | </itemizedlist> |
315 | </section> | 252 | </section> |
@@ -320,4 +257,4 @@ | |||
320 | <para>A detailed list of all security patches included with this release | 257 | <para>A detailed list of all security patches included with this release |
321 | is available in the Enea NFV Access Security Report document.</para> | 258 | is available in the Enea NFV Access Security Report document.</para> |
322 | </section> | 259 | </section> |
323 | </chapter> | 260 | </chapter> \ No newline at end of file |