1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-about-release">
<title>About This Release</title>
<para>This release of Enea NFV Access <xi:include
href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
xpointer="element(EneaLinux_REL_VER/1)" /> 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.</para>
<para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis>
contains many parameters in the book, also in the open source books, and
MUST be created FROM <emphasis
role="bold">eltf_params_template.xml</emphasis>. 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
<emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis>
for important details about formats and how to do! The idea is that ELTF
will auto-create/update it.</remark></para>
<section id="release-content">
<title>Enea NFV Access Release Content</title>
<para>The current release contains documentation, prebuilt kernels and
images, a bootloader, an SDK and an eSDK. The directory structure is
detailed below:</para>
<programlisting condition="intel">-- documentation/
/* Enea NFV Access documentation */
-- x86-64 /* architecture */
-- inteld1521/
/* artifacts for the host side */
-- deb/
/* deb packages */
-- images/
-- enea-nfv-access
/* precompiled artifacts for the platform release image */
-- various artifacts (rootfs, kernel, config etc.)
-- enea-nfv-access-dev
/* precompiled artifacts for the development process. The image
contains userspace tools and kernel configurations necessary
for developing, debugging and profiling applications and
kernel modules */
-- various artifacts
-- qemux86-64
/* artifacts for the guest side */
-- deb/
/* deb packages */
-- images/
-- enea-nfv-access-guest
/* precompiled artifacts for the QEMU/Docker release image */
-- various artifacts
-- enea-nfv-access-guest-dev
/* precompiled artifacts for the development process. The image
contains userspace tools and kernel configurations necessary
for developing, debugging and profiling applications and
kernel modules */
-- various artifacts
-- install
-- sdk
/* SDK related artifacts including SDK installer and manifests */
-- install-sdk.sh
/* self-extracting archive installing cross-compilation
toolchain for the platform */
-- nfv-installer
/* Various tools assisting in booting Enea NFV Access */
-- script-installer
/* installer tool intended for creating a bootable Enea
NFV Access installation on a physical media */</programlisting>
<programlisting condition="arm">-- documentation/
/* Enea NFV Access documentation */
-- README
-- aarch64 /* architecture */
-- cn8304/
/* artifacts for the host side */
-- deb/
/* deb packages */
-- images/
-- enea-nfv-access
/* precompiled artifacts for the platform release image */
-- various artifacts (rootfs, kernel, config etc.)
-- enea-nfv-access-dev
/* precompiled artifacts for the development process. The image
contains userspace tools and kernel configurations necessary
for developing, debugging and profiling applications and
kernel modules */
-- various artifacts
-- qemuarm64
/* artifacts for the guest side */
-- deb/
/* deb packages */
-- images/
-- enea-nfv-access-guest
/* precompiled artifacts for the QEMU/Docker release image */
-- various artifacts
-- enea-nfv-access-guest-dev
/* precompiled artifacts for the development process. The image
contains userspace tools and kernel configurations necessary
for developing, debugging and profiling applications and
kernel modules */
-- various artifacts
-- install
-- sdk
/* SDK related artifacts including SDK installer and manifests */
-- install-sdk.sh
/* self-extracting archive installing cross-compilation
toolchain for the platform */
-- nfv-installer
/* Various tools assisting in booting Enea NFV Access */
-- docker-pxe-ramboot
/* tools and files used in buidling a boot setup */</programlisting>
<para>For each combination of image and target, the following set of
artifacts is available:</para>
<programlisting condition="intel">-- bzImage
/* kernel image */
-- bzImage-target.bin
/* kernel image, same as above */
-- config-target.config
/* kernel configuration file */
-- image-name-target.ext4.gz
/* compressed EXT4 image of the rootfs */
-- image-name-target.qcow2
/* QCOW image for QEMU - only for guest images */
-- image-name-target.qemuboot.conf
/* qemu config file for the guest images */
-- image-name-target.tar.gz
/* tar archive of the image */
-- modules-<target>.tgz
/* external kernel modules */
-- grub-efi-bootx64.efi
/* GRUB EFI file */</programlisting>
<programlisting condition="arm">-- Image
/* kernel image */
-- Image-target.bin
/* kernel image, same as above */
-- config-target.config
/* kernel configuration file */
-- image-name-target.ext4.gz
/* compressed EXT4 image of the rootfs */
-- image-name-target.qcow2
/* QCOW image for QEMU - only for guest images */
-- image-name-target.qemuboot.conf
/* qemu config file for the guest images */
-- image-name-target.tar.gz
/* tar archive of the image */
-- modules-<target>.tgz
/* external kernel modules */</programlisting>
</section>
<section id="relinfo-supported-host-environment">
<title>Supported Host Environment</title>
<para>The following environments have been validated as host environments
for Enea NFV Access <xi:include href="eltf_params_updated.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xpointer="element(EneaLinux_REL_VER/1)" />: <emphasis role="bold">Ubuntu
16.04 LTS, 64bit</emphasis>.</para>
<para><remark>Hardcoded now in this XML file. Might be moved to the
parameter file later.</remark> <remark>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.</remark>For
more details on host requirements and how to configure the host
environment, see <xref linkend="sys-req-prerequisites" />.</para>
</section>
<xi:include href="eltf_params_updated.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xpointer="element(eltf-target-tables-section)" />
<section id="relinfo-provided-sdk">
<title>Provided Toolchains</title>
<para>The provided SDK and eSDK contain toolchains supporting
cross-compilation of applications for both the host and the guest targets
on an <filename condition="intel">x86-64</filename><filename
condition="arm">arm64</filename> machine.</para>
</section>
<section id="relinfo-documentation">
<title>Provided Documentation</title>
<para>This release of Enea NFV Access contains the following set of
documents:</para>
<itemizedlist>
<listitem>
<para>Enea NFV Access Release Information. Describes the Enea NFV
Access release content.</para>
</listitem>
<listitem condition="intel">
<para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes
how to use Enea NFV Access, provides use cases and benchmark
results.</para>
</listitem>
<listitem condition="arm">
<para><phrase><olink targetdoc="book_enea_nfv_access_guide">Enea NFV
Access Guide</olink></phrase>. Describes how to use Enea NFV Access,
provides use cases and benchmark results.</para>
</listitem>
<listitem>
<para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xpointer="element(book_enea_nfv_access_open_source/1)" />. Contains
open source and license information pertaining to packages provided
with Enea NFV Access.</para>
</listitem>
<listitem>
<para>Enea NFV Access Development Open Source Report. Contains open
source and license information pertaining to packages provided with
Enea NFV Access for application developers.</para>
</listitem>
<listitem>
<para>Enea NFV Access Guest Open Source Report. Contains open source
and license information concerning packages provided with Enea NFV
Access for a guest target.</para>
</listitem>
<listitem>
<para>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.</para>
</listitem>
<listitem condition="hidden">
<para>Enea NFV Access Test Report. Summarizes the test results for the
Enea NFV Access release.</para>
</listitem>
<listitem>
<para>Enea NFV Access Security Report. Lists all security fixes
included in this release of Enea NFV Access.</para>
</listitem>
</itemizedlist>
</section>
<section id="security_fixes">
<title>Security Fixes</title>
<para>A detailed list of all security patches included with this release
is available in the Enea NFV Access Security Report document.</para>
</section>
</chapter>
|
