diff options
15 files changed, 157 insertions, 1435 deletions
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/about_release.xml b/doc/book-enea-nfv-access-release-info-intel/doc/about_release.xml deleted file mode 100644 index b76f3ff..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/about_release.xml +++ /dev/null | |||
@@ -1,272 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-about-release"> | ||
5 | <title>About This Release</title> | ||
6 | |||
7 | <para>Enea NFV Access <xi:include href="eltf_params_updated.xml" | ||
8 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
9 | xpointer="element(EneaLinux_REL_VER/1)" /> is a maintenance update to Enea | ||
10 | NFV Access 1.0 with the major changes listed below:<remark>INFO <emphasis | ||
11 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in | ||
12 | the book, also in the open source books, and MUST be created FROM <emphasis | ||
13 | role="bold">eltf_params_template.xml</emphasis>. The parameters are | ||
14 | 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 | ||
16 | <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> | ||
17 | for important details about formats and how to do! The idea is that ELTF | ||
18 | will auto-create/update it.</remark></para> | ||
19 | |||
20 | <itemizedlist> | ||
21 | <listitem> | ||
22 | <para>Key Component updates:</para> | ||
23 | |||
24 | <itemizedlist> | ||
25 | <listitem> | ||
26 | <para>DPDK 17.08</para> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem> | ||
30 | <para>OVS 2.8</para> | ||
31 | </listitem> | ||
32 | </itemizedlist> | ||
33 | </listitem> | ||
34 | |||
35 | <listitem> | ||
36 | <para>Feature Extensions:</para> | ||
37 | |||
38 | <itemizedlist> | ||
39 | <listitem> | ||
40 | <para>Element ODM: FCAPS framework with NETCONF and Yang.</para> | ||
41 | </listitem> | ||
42 | |||
43 | <listitem> | ||
44 | <para>EdgeLink Netconf (beta): NETCONF based VNF lifecycle | ||
45 | Management Tool.</para> | ||
46 | </listitem> | ||
47 | </itemizedlist> | ||
48 | </listitem> | ||
49 | |||
50 | <listitem> | ||
51 | <para>Extended Tools Feature Set:</para> | ||
52 | |||
53 | <itemizedlist> | ||
54 | <listitem> | ||
55 | <para>python-pip</para> | ||
56 | </listitem> | ||
57 | |||
58 | <listitem> | ||
59 | <para>dosfstools</para> | ||
60 | </listitem> | ||
61 | |||
62 | <listitem> | ||
63 | <para>htop</para> | ||
64 | </listitem> | ||
65 | </itemizedlist> | ||
66 | </listitem> | ||
67 | |||
68 | <listitem> | ||
69 | <para>Unified cross-development SDK for host and virtualized | ||
70 | environments.</para> | ||
71 | </listitem> | ||
72 | |||
73 | <listitem> | ||
74 | <para>Native toolchain support on development image.</para> | ||
75 | </listitem> | ||
76 | |||
77 | <listitem> | ||
78 | <para>USB-stick based installation</para> | ||
79 | </listitem> | ||
80 | |||
81 | <listitem> | ||
82 | <para>Product Maintenance:</para> | ||
83 | |||
84 | <itemizedlist> | ||
85 | <listitem> | ||
86 | <para>Optimizations</para> | ||
87 | </listitem> | ||
88 | |||
89 | <listitem> | ||
90 | <para>Security patches</para> | ||
91 | </listitem> | ||
92 | |||
93 | <listitem> | ||
94 | <para>Bug fixes</para> | ||
95 | </listitem> | ||
96 | |||
97 | <listitem> | ||
98 | <para>Updated documentation</para> | ||
99 | </listitem> | ||
100 | </itemizedlist> | ||
101 | </listitem> | ||
102 | </itemizedlist> | ||
103 | |||
104 | <section id="release-content"> | ||
105 | <title>Enea NFV Access Release Content</title> | ||
106 | |||
107 | <para>The current release contains along with other items, documentation, | ||
108 | pre-built kernels and images, a bootloader and a SDK. The directories | ||
109 | structure is detailed below:</para> | ||
110 | |||
111 | <programlisting>-- documentation/ | ||
112 | /* Enea NFV Access documentation */ | ||
113 | -- x86-64 /* architecture */ | ||
114 | -- inteld1521/ | ||
115 | /* artifacts for the host side */ | ||
116 | -- deb/ | ||
117 | /* deb packages */ | ||
118 | -- images/ | ||
119 | -- enea-nfv-access | ||
120 | /* precompiled artifacts for the platform release image */ | ||
121 | -- various artifacts (rootfs, kernel, config etc.) | ||
122 | -- enea-nfv-access-dev | ||
123 | /* precompiled artifacts for the development process. The image | ||
124 | contains userspace tools and kernel configurations necessary | ||
125 | for developing, debugging and profiling applications and | ||
126 | kernel modules */ | ||
127 | -- various artifacts | ||
128 | -- qemux86-64 | ||
129 | /* artifacts for the guest side */ | ||
130 | -- deb/ | ||
131 | /* deb packages */ | ||
132 | -- images/ | ||
133 | -- enea-nfv-access-guest | ||
134 | /* precompiled artifacts for the QEMU/Docker release image */ | ||
135 | -- various artifacts | ||
136 | -- enea-nfv-access-guest-dev | ||
137 | /* precompiled artifacts for the development process. The image | ||
138 | contains userspace tools and kernel configurations necessary | ||
139 | for developing, debugging and profiling applications and | ||
140 | kernel modules */ | ||
141 | -- various artifacts | ||
142 | -- install | ||
143 | -- sdk | ||
144 | /* SDK related artifacts including SDK installer and manifests */ | ||
145 | -- install-sdk.sh | ||
146 | /* self-extracting archive installing cross-compilation | ||
147 | toolchain for the platform */ | ||
148 | -- nfv-installer | ||
149 | /* Various tools assisting in booting Enea NFV Access */ | ||
150 | -- script-installer | ||
151 | /* installer tool intended for creating a bootable Enea | ||
152 | NFV Access installation on a physical media */</programlisting> | ||
153 | |||
154 | <para>For each combination of image and target, the following set of | ||
155 | artifacts is available:</para> | ||
156 | |||
157 | <programlisting>-- bzImage | ||
158 | /* kernel image */ | ||
159 | -- bzImage-target.bin | ||
160 | /* kernel image, same as above */ | ||
161 | -- config-target.config | ||
162 | /* kernel configuration file */ | ||
163 | -- image-name-target.ext4.gz | ||
164 | /* compressed EXT4 image of the rootfs */ | ||
165 | -- image-name-target.qcow2 | ||
166 | /* QCOW image for QEMU - only for guest images */ | ||
167 | -- image-name-target.qemuboot.conf | ||
168 | /* qemu config file for the guest images */ | ||
169 | -- image-name-target.tar.gz | ||
170 | /* tar archive of the image */ | ||
171 | -- modules-<target>.tgz | ||
172 | /* external kernel modules */ | ||
173 | -- grub-efi-bootx64.efi | ||
174 | /* GRUB EFI file */</programlisting> | ||
175 | </section> | ||
176 | |||
177 | <section id="relinfo-supported-host-environment"> | ||
178 | <title>Supported Host Environment</title> | ||
179 | |||
180 | <para>The following environments have been validated as host environments | ||
181 | for Enea NFV Access 1.1: <emphasis role="bold">Ubuntu 16.04 LTS, | ||
182 | 64bit</emphasis>.</para> | ||
183 | |||
184 | <para><remark>Hardcoded now in this XML file. Might be moved to the | ||
185 | parameter file later.</remark> <remark>INFO Below is a complete section | ||
186 | with ID "eltf-target-tables-section" included from | ||
187 | elft_params_updated.xml. It contains a variable number of target tables | ||
188 | and the section title should be "Supported Targets with Parameters". It | ||
189 | has have a short sentence about what it is in the beginning. The subtitles | ||
190 | shall have the directory name of the target in the manifest.</remark>For | ||
191 | more details on host requirements and how to configure the host | ||
192 | environment, please see <xref linkend="sys-req-prerequisites" />.</para> | ||
193 | </section> | ||
194 | |||
195 | <xi:include href="eltf_params_updated.xml" | ||
196 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
197 | xpointer="element(eltf-target-tables-section)" /> | ||
198 | |||
199 | <section id="relinfo-provided-sdk"> | ||
200 | <title>Provided Toolchain(s) (SDK)</title> | ||
201 | |||
202 | <para>The provided SDK contains toolchains supporting cross-compilation of | ||
203 | applications for both the host and the guest targets on an x86-64 | ||
204 | machine.</para> | ||
205 | |||
206 | <para><remark>(Possibly add this in later) See the <trademark | ||
207 | class="registered">Enea</trademark> NFV Access Application Development | ||
208 | Guide for information on how to build and install a | ||
209 | toolchain.</remark></para> | ||
210 | </section> | ||
211 | |||
212 | <section id="relinfo-documentation"> | ||
213 | <title>Provided Documentation</title> | ||
214 | |||
215 | <para>Enea NFV Access is provided with the following set of | ||
216 | documents:</para> | ||
217 | |||
218 | <itemizedlist> | ||
219 | <listitem> | ||
220 | <para>Enea NFV Access Release Information - This document, describing | ||
221 | the Enea NFV Access release content.</para> | ||
222 | </listitem> | ||
223 | |||
224 | <listitem> | ||
225 | <para>Enea NFV Access Guide - A document describing how to use Enea | ||
226 | NFV Access, as well as use cases and benchmark results.</para> | ||
227 | </listitem> | ||
228 | |||
229 | <listitem> | ||
230 | <para>Enea NFV Access Open Source Report - A document containing the | ||
231 | open source and license information pertaining to packages provided | ||
232 | with Enea NFV Access.</para> | ||
233 | </listitem> | ||
234 | |||
235 | <listitem> | ||
236 | <para>Enea NFV Access Development Open Source Report - A document | ||
237 | containing open source and license information pertaining to packages | ||
238 | provided with Enea NFV Access for application developers.</para> | ||
239 | </listitem> | ||
240 | |||
241 | <listitem> | ||
242 | <para>Enea NFV Access Guest Open Source Report - A document containing | ||
243 | open source and license information concerning packages provided with | ||
244 | Enea NFV Access for a guest target.</para> | ||
245 | </listitem> | ||
246 | |||
247 | <listitem> | ||
248 | <para>Enea NFV Access Guest Development Open Source Report - A | ||
249 | document detailing the open source and license information of packages | ||
250 | provided with Enea NFV Access for applications development on a guest | ||
251 | target.</para> | ||
252 | </listitem> | ||
253 | |||
254 | <listitem condition="hidden"> | ||
255 | <para>Enea NFV Access Test Report - The document that summarizes the | ||
256 | test results for the Enea NFV Access release.</para> | ||
257 | </listitem> | ||
258 | |||
259 | <listitem> | ||
260 | <para>Enea NFV Access Security Report - The document that lists all | ||
261 | security fixes included in the Enea NFV Access release.</para> | ||
262 | </listitem> | ||
263 | </itemizedlist> | ||
264 | </section> | ||
265 | |||
266 | <section id="security_fixes"> | ||
267 | <title>Security Fixes</title> | ||
268 | |||
269 | <para>A detailed list of all security patches included with this release | ||
270 | is available in the Enea NFV Access Security Report document.</para> | ||
271 | </section> | ||
272 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/book.xml b/doc/book-enea-nfv-access-release-info-intel/doc/book.xml deleted file mode 100644 index 1ce7046..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/book.xml +++ /dev/null | |||
@@ -1,36 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ | ||
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | ||
5 | ]> | ||
6 | <book id="book_enea_nfv_access_release_info"> | ||
7 | <title><trademark class="registered">Enea</trademark> NFV Access Release | ||
8 | Information</title> | ||
9 | |||
10 | <subtitle>Release Version <xi:include href="eltf_params_updated.xml" | ||
11 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
12 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | ||
13 | |||
14 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | ||
15 | |||
16 | <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" | ||
17 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
18 | |||
19 | <xi:include href="about_release.xml" | ||
20 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
21 | |||
22 | <xi:include href="system_requirements_prerequisites.xml" | ||
23 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
24 | |||
25 | <xi:include href="getting_enea_nfv_access.xml" | ||
26 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
27 | |||
28 | <xi:include href="main_changes.xml" | ||
29 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
30 | |||
31 | <xi:include href="known_bugs_and_limitations.xml" | ||
32 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
33 | |||
34 | <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml" | ||
35 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
36 | </book> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_template.xml deleted file mode 100644 index eaa7ebd..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_template.xml +++ /dev/null | |||
@@ -1,151 +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="eltf_created_params"> | ||
5 | <title>File with Parameters in the Book Auto-updated by ELFT</title> | ||
6 | |||
7 | <note> | ||
8 | <para>See the <emphasis | ||
9 | role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text | ||
10 | file for description of how to create the final <emphasis | ||
11 | role="bold">eltf_params_updated.xml</emphasis> from this template and for | ||
12 | all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command | ||
13 | "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all | ||
14 | ELTF variables, which always begins with ELTF_ and don't only rely on the | ||
15 | howto text file list! The plan is that ELTF will auto-update this when | ||
16 | needed.</para> | ||
17 | </note> | ||
18 | |||
19 | <section id="host_prereq"> | ||
20 | <title>Common Parameters</title> | ||
21 | |||
22 | <bridgehead>A programlisting, ID | ||
23 | "eltf-prereq-apt-get-commands-host"</bridgehead> | ||
24 | |||
25 | <para id="eltf-prereq-apt-get-commands-host"><programlisting>ELTF_PL_HOST_PREREQ</programlisting></para> | ||
26 | |||
27 | <bridgehead>A programlisting, ID | ||
28 | "eltf-getting-repo-install-command"</bridgehead> | ||
29 | |||
30 | <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para> | ||
31 | |||
32 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | ||
33 | correct also compared to the "previous" REL VER in pardoc-distro.xml | ||
34 | "prev_baseline".</bridgehead> | ||
35 | |||
36 | <para id="EneaLinux_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para> | ||
37 | |||
38 | <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para> | ||
39 | |||
40 | <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para> | ||
41 | |||
42 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | ||
43 | url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para> | ||
44 | |||
45 | <para id="ULINK_ENEA_LINUX_URL"><ulink | ||
46 | url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para> | ||
47 | |||
48 | <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use | ||
49 | $MACHINE/default.xml as parameter, where MACHINE is one of the target | ||
50 | directory names in the manifest.</bridgehead> | ||
51 | |||
52 | <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para> | ||
53 | |||
54 | <bridgehead>A table with ONE row, only the row with ID | ||
55 | "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the | ||
56 | template.xml and in the updated.xml, set condition hidden on the | ||
57 | <row>, if eclipse is not in the release.</bridgehead> | ||
58 | |||
59 | <informaltable> | ||
60 | <tgroup cols="1"> | ||
61 | <tbody> | ||
62 | <row id="eltf-eclipse-version-row"> | ||
63 | <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line | ||
64 | development tools are included in this Enea NFV Access release.</entry> | ||
65 | </row> | ||
66 | </tbody> | ||
67 | </tgroup> | ||
68 | </informaltable> | ||
69 | |||
70 | <bridgehead>Below is one big section with title "Supported Targets with | ||
71 | Parameters". The entire section is included completely in the book via ID | ||
72 | "eltf-target-tables-section" and shall be LAST in the template. The | ||
73 | template contains ONE target subsection. COPY/APPEND it, if multiple | ||
74 | targets exist in the release and optionally add rows with additional | ||
75 | target parameters in each target subsection table.</bridgehead> | ||
76 | </section> | ||
77 | |||
78 | <section id="eltf-target-tables-section"> | ||
79 | <title>Supported Targets with Parameters</title> | ||
80 | |||
81 | <para>The tables below describes the target(s) supported in this Enea | ||
82 | NFV Access release.</para> | ||
83 | |||
84 | <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> | ||
85 | <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> | ||
86 | |||
87 | <para><informaltable> | ||
88 | <tgroup cols="2"> | ||
89 | <colspec colwidth="6*" /> | ||
90 | |||
91 | <colspec colwidth="9*" /> | ||
92 | |||
93 | <tbody> | ||
94 | <row> | ||
95 | <entry>Target official name</entry> | ||
96 | |||
97 | <entry>ELTF_T_NAME</entry> | ||
98 | </row> | ||
99 | |||
100 | <row> | ||
101 | <entry>Architecture and Description</entry> | ||
102 | |||
103 | <entry>ELTF_T_ARC_DESC</entry> | ||
104 | </row> | ||
105 | |||
106 | <row> | ||
107 | <entry>Link to target datasheet</entry> | ||
108 | |||
109 | <entry>See <ulink | ||
110 | url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry> | ||
111 | </row> | ||
112 | |||
113 | <row> | ||
114 | <entry>Poky version</entry> | ||
115 | |||
116 | <entry>ELTF_T_POKY_VER</entry> | ||
117 | </row> | ||
118 | |||
119 | <row> | ||
120 | <entry>GCC version</entry> | ||
121 | |||
122 | <entry>ELTF_T_GCC_VER</entry> | ||
123 | </row> | ||
124 | |||
125 | <row> | ||
126 | <entry>Linux Kernel Version</entry> | ||
127 | |||
128 | <entry>ELTF_T_KERN_VER</entry> | ||
129 | </row> | ||
130 | |||
131 | <row> | ||
132 | <entry>Supported Drivers</entry> | ||
133 | |||
134 | <entry>ELTF_T_DRIVERS</entry> | ||
135 | </row> | ||
136 | |||
137 | <row> | ||
138 | <entry>Enea rpm folder for downloading RPM packages for this | ||
139 | target</entry> | ||
140 | |||
141 | <entry><ulink | ||
142 | url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry> | ||
143 | </row> | ||
144 | </tbody> | ||
145 | </tgroup> | ||
146 | </informaltable></para> | ||
147 | </section> | ||
148 | |||
149 | <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED --> | ||
150 | </section> | ||
151 | </section> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated.xml deleted file mode 100644 index e6d3929..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated.xml +++ /dev/null | |||
@@ -1,156 +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="eltf_created_params"> | ||
5 | <title>File with Parameters in the Book Auto-updated by ELFT</title> | ||
6 | |||
7 | <note> | ||
8 | <para>See the <emphasis | ||
9 | role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text | ||
10 | file for description of how to create the final <emphasis | ||
11 | role="bold">eltf_params_updated.xml</emphasis> from this template and for | ||
12 | all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command | ||
13 | "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all | ||
14 | ELTF variables, which always begins with ELTF_ and don't only rely on the | ||
15 | howto text file list! The plan is that ELTF will auto-update this when | ||
16 | needed.</para> | ||
17 | </note> | ||
18 | |||
19 | <section id="host_prereq"> | ||
20 | <title>Common Parameters</title> | ||
21 | |||
22 | <bridgehead>A programlisting, ID | ||
23 | "eltf-prereq-apt-get-commands-host"</bridgehead> | ||
24 | |||
25 | <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 16.04 LTS 64bit | ||
26 | sudo apt-get -y update | ||
27 | sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \ | ||
28 | texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ | ||
29 | make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ | ||
30 | libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ | ||
31 | libxml-parser-perl</programlisting></para> | ||
32 | |||
33 | <bridgehead>A programlisting, ID | ||
34 | "eltf-getting-repo-install-command"</bridgehead> | ||
35 | |||
36 | <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin | ||
37 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
38 | chmod a+x ~/bin/repo | ||
39 | export PATH=~/bin:$PATH</programlisting></para> | ||
40 | |||
41 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | ||
42 | correct also compared to the "previous" REL VER in pardoc-distro.xml | ||
43 | "prev_baseline".</bridgehead> | ||
44 | |||
45 | <para id="EneaLinux_REL_VER"><phrase>1.1</phrase></para> | ||
46 | |||
47 | <para id="Yocto_VER"><phrase>2.1</phrase></para> | ||
48 | |||
49 | <para id="Yocto_NAME"><phrase>krogoth</phrase></para> | ||
50 | |||
51 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | ||
52 | url="http://www.yoctoproject.org/downloads/core/krogoth/21">http://www.yoctoproject.org/downloads/core/krogoth/21</ulink></para> | ||
53 | |||
54 | <para id="ULINK_ENEA_LINUX_URL"><ulink | ||
55 | url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para> | ||
56 | |||
57 | <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use | ||
58 | $MACHINE/default.xml as parameter, where MACHINE is one of the target | ||
59 | directory names in the manifest.</bridgehead> | ||
60 | |||
61 | <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux | ||
62 | cd enea-linux | ||
63 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
64 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
65 | repo sync</programlisting></para> | ||
66 | |||
67 | <bridgehead>A table with ONE row, only the row with ID | ||
68 | "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set | ||
69 | condition hidden if eclipse is not in the release. Do this both in | ||
70 | template.xml and updated.xml.</bridgehead> | ||
71 | |||
72 | <informaltable> | ||
73 | <tgroup cols="1"> | ||
74 | <tbody> | ||
75 | <row condition="hidden" id="eltf-eclipse-version-row"> | ||
76 | <entry>Eclipse version 4.3 (Mars) plus command line development | ||
77 | tools are included in this Enea NFV Access release.</entry> | ||
78 | </row> | ||
79 | </tbody> | ||
80 | </tgroup> | ||
81 | </informaltable> | ||
82 | |||
83 | <bridgehead>Below is one big section with title "Supported Targets with | ||
84 | Parameters". The entire section is included completely in the book via ID | ||
85 | "eltf-target-tables-section" and shall be LAST in the template. The | ||
86 | template contains ONE target subsection. COPY/APPEND it, if multiple | ||
87 | targets exist in the release and optionally add rows with additional | ||
88 | target parameters in each target subsection table.</bridgehead> | ||
89 | </section> | ||
90 | |||
91 | <section id="eltf-target-tables-section"> | ||
92 | <title>Supported Reference Boards with Parameters</title> | ||
93 | |||
94 | <para>The table(s) below describes the target(s) supported in this Enea | ||
95 | NFV Access release.</para> | ||
96 | |||
97 | <section id="eltf-target-table-D-1521"> | ||
98 | <title>MACHINE Intel Xeon D-1521 - Information</title> | ||
99 | |||
100 | <para><informaltable> | ||
101 | <tgroup cols="2"> | ||
102 | <colspec colwidth="6*" /> | ||
103 | |||
104 | <colspec colwidth="9*" /> | ||
105 | |||
106 | <tbody> | ||
107 | <row> | ||
108 | <entry>Target official name</entry> | ||
109 | |||
110 | <entry>Intel Xeon D-1521</entry> | ||
111 | </row> | ||
112 | |||
113 | <row> | ||
114 | <entry>Architecture and Description</entry> | ||
115 | |||
116 | <entry>x86-64</entry> | ||
117 | </row> | ||
118 | |||
119 | <row> | ||
120 | <entry>Link to target datasheet</entry> | ||
121 | |||
122 | <entry>See link to <ulink | ||
123 | url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's | ||
124 | datasheet</ulink></entry> | ||
125 | </row> | ||
126 | |||
127 | <row> | ||
128 | <entry>Poky version</entry> | ||
129 | |||
130 | <entry>Git-commit-id: | ||
131 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | ||
132 | </row> | ||
133 | |||
134 | <row> | ||
135 | <entry>GCC version</entry> | ||
136 | |||
137 | <entry>5.3<remark>FIXME</remark></entry> | ||
138 | </row> | ||
139 | |||
140 | <row> | ||
141 | <entry>Linux Kernel Version</entry> | ||
142 | |||
143 | <entry>3.12<remark>FIXME</remark></entry> | ||
144 | </row> | ||
145 | |||
146 | <row condition="hidden"> | ||
147 | <entry>Supported Drivers</entry> | ||
148 | |||
149 | <entry>Ethernet, RTC, UART</entry> | ||
150 | </row> | ||
151 | </tbody> | ||
152 | </tgroup> | ||
153 | </informaltable></para> | ||
154 | </section> | ||
155 | </section> | ||
156 | </section> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated_template_how_to_use.txt deleted file mode 100644 index 62e5d02..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/eltf_params_updated_template_how_to_use.txt +++ /dev/null | |||
@@ -1,320 +0,0 @@ | |||
1 | eltf_params_template_updated_howto_use.txt | ||
2 | |||
3 | This is a way to collect all parameters for an Enea NFV Access release | ||
4 | in one parameter file, easy to automatically update by ELTF regularly. | ||
5 | |||
6 | NOTE: Both the release info AND the open source books use parameters from | ||
7 | here, but the XML file is inside the release info book directory. | ||
8 | |||
9 | NOTE: The manifest_conf.mk, or overridden by the environment variable | ||
10 | MANIFESTHASH, contains the full tag (or hashvalue) for downloading | ||
11 | the manifest when the books are built. The list of target | ||
12 | directories are fetched from the manifest into the book. | ||
13 | The eltf_params_updates.xml can all the time contain | ||
14 | the final next complete tag e.g. refs/tags/EL6 or similar | ||
15 | in the ELTF_PL_CLONE_W_REPO parameter command lines. | ||
16 | |||
17 | The ordinary book XML files use xi:include statements to include elements | ||
18 | from this parameter file. The book XML files can thus be manually edited. | ||
19 | Before editing, you must run "make init". | ||
20 | Any other text in the template or updated.xml file, outside the parts that | ||
21 | are included in the book, are not used but still all must be correct | ||
22 | DocBook XML files. | ||
23 | |||
24 | ELTF work: | ||
25 | template => ELTF replaces ALL ELTF_xxx variables => updated XML file | ||
26 | => push to git only if changed | ||
27 | |||
28 | |||
29 | eltf_params_template.xml (in git) | ||
30 | File used by ELTF to autocreate/update the real parameter | ||
31 | file eltf_params_updated.xml. | ||
32 | |||
33 | eltf_params_updated.xml (in git) | ||
34 | Real parameter file where ELTF has replaced all ELTF_xx variables with | ||
35 | strings, in several cases with multiline strings. | ||
36 | No spaces or linefeed allowed in beginning or end of the variable values! | ||
37 | |||
38 | |||
39 | xi:include: Each parameter is xi:include'ed in various book files, using | ||
40 | the IDs existing in the parameter files. | ||
41 | In most cases the 1:st element inside an element with an ID is included | ||
42 | using a format like eltf-prereq-apt-get-commands-host/1. | ||
43 | In very few cases the element with the ID is included in the book, one | ||
44 | example is the target section which has an ID, but which contains | ||
45 | multiple subsections, one per target. | ||
46 | All IDs in a book must be unique. | ||
47 | |||
48 | DocBook XML: All XML files must be correct DocBook XML files. | ||
49 | |||
50 | Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes | ||
51 | not done by ELTF. But it is OK to open the real file in XMLmind to | ||
52 | check that the format is correct. | ||
53 | |||
54 | ELTF should autocreate a temporary "real" file but only replace | ||
55 | and push the eltf_params_updated.xml if it is changed. | ||
56 | |||
57 | |||
58 | make eltf | ||
59 | This lists all ELTF_xxx variables and some rules how to treat them | ||
60 | |||
61 | DocBook Format: All elements - rules: | ||
62 | Several strict generic XML rules apply for all strings: | ||
63 | 1. No TABs allowed or any other control chr than "linefeed" | ||
64 | 2. Only 7-bit ASCII | ||
65 | 3. Any < > & must be converted to < > and & | ||
66 | Similar for any other non-7-bit-ASCII but avoid those! | ||
67 | 4. No leading spaces or linefeeds when replacing the ELTF_* variable | ||
68 | 5. No trailing spaces or linefeeds when replacing the ELTF_* variable | ||
69 | 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. | ||
70 | |||
71 | DocBook Format: <programlisting> - rules: ELTF*PL* variables | ||
72 | Several strict rules apply for the multiline string in programlisting | ||
73 | in addition to the general XML rules above: | ||
74 | 7. Max line length < 80 char | ||
75 | 8. Use backslash (\) to break longer lines | ||
76 | 9. Use spaces (e.g. 4) to indent continuation lines in programlistings | ||
77 | 10. No trailing spaces on any line | ||
78 | 11. No spaces or linefeed immediately after leading <programlisting> | ||
79 | 12. No spaces or linefeed before trailing </programlisting> | ||
80 | |||
81 | DocBook Format: <ulink> - rules: ELTF_*URL* variables | ||
82 | 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings | ||
83 | 14. Only if the URL is extremely long, the TXTURL can be a separate string | ||
84 | |||
85 | Each target has one section with target parameters: | ||
86 | <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> | ||
87 | <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> | ||
88 | ..... with many ELTF_ variables .... | ||
89 | </section> | ||
90 | |||
91 | 15. If there is only one target. ELTF just replaces ELTF parameters | ||
92 | |||
93 | 16. It there are multiple targets. ELTF copies the section and appends the | ||
94 | section the required number of times. | ||
95 | Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR | ||
96 | Each section title will become unique | ||
97 | |||
98 | Tables with target parameters in each target section: | ||
99 | 17. It is possible for ELTF to append more rows with one parameter each | ||
100 | to these tables, because the entire tables are included in the book | ||
101 | |||
102 | Special - NOT YET READY DEFINED how to handle the optionally included | ||
103 | Eclipse and its version, but this is a first suggestion: | ||
104 | 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string | ||
105 | with both version number and name, | ||
106 | 19. MANUALLY if Eclipse is NOT included in the release, | ||
107 | the release manager should manually set condition="hidden" on | ||
108 | the entire section in the book XML about Eclipse | ||
109 | |||
110 | |||
111 | |||
112 | BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf | ||
113 | if there are more new variables, missing in this description file. | ||
114 | |||
115 | _____________________________________________________________________________ | ||
116 | ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands | ||
117 | like sudo apt-get install xxxx or similar. | ||
118 | First line = comment with the complete host name! | ||
119 | It is possible to include multiple hosts by just | ||
120 | adding an empty line, comment with host name, etc. | ||
121 | xi:include eltf-prereq-apt-get-commands-host/1 | ||
122 | This is a <programlisting>...</programlisting> | ||
123 | Example: | ||
124 | # Host Ubuntu 14.04.5 LTS 64bit | ||
125 | sudo apt-get update | ||
126 | sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ | ||
127 | texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ | ||
128 | make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ | ||
129 | libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ | ||
130 | libxml-parser-perl | ||
131 | |||
132 | _____________________________________________________________________________ | ||
133 | ELTF_PL_GET_REPO Multiline commands to download the repo tool | ||
134 | xi:include eltf-getting-repo-install-command/1 | ||
135 | This is a <programlisting>...</programlisting> | ||
136 | Example: | ||
137 | mkdir -p ~/bin | ||
138 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
139 | chmod a+x ~/bin/repo | ||
140 | export PATH=~/bin:$PATH | ||
141 | |||
142 | _____________________________________________________________________________ | ||
143 | ELTF_EL_REL_VER General parameter string: The version of this Enea | ||
144 | NFV Access release. Major version and optional .Minor | ||
145 | Typically created from MAJOR and MINOR in enea.conf | ||
146 | MINOR in enea.conf is empty or contains a dot+minor | ||
147 | xi_include EneaLinux_REL_VER/1 | ||
148 | This is a <phrase>X.x</phrase> used in many places. | ||
149 | Examples: | ||
150 | 6 | ||
151 | or | ||
152 | 6.1 | ||
153 | |||
154 | _____________________________________________________________________________ | ||
155 | ELTF_YOCTO_VER General parameter string: Yocto version, created | ||
156 | from DISTRO in poky.ent | ||
157 | xi:include Yocto_VER/1 | ||
158 | This is a <phrase>X.x</phrase> used in many places. | ||
159 | Example: | ||
160 | 2.1 | ||
161 | |||
162 | _____________________________________________________________________________ | ||
163 | ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created | ||
164 | from DISTRO_NAME_NO_CAP in poky.ent | ||
165 | xi:include Yocto_NAME/1 | ||
166 | This is a <phrase>X.x</phrase> used in many places. | ||
167 | Example: | ||
168 | krogoth | ||
169 | |||
170 | _____________________________________________________________________________ | ||
171 | ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL | ||
172 | ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string | ||
173 | at the end, typically without "dot". | ||
174 | xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 | ||
175 | This is an <ulink url="...">...</ulink> | ||
176 | Example: | ||
177 | http://www.yoctoproject.org/downloads/core/krogoth/21 | ||
178 | |||
179 | _____________________________________________________________________________ | ||
180 | ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings | ||
181 | ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where | ||
182 | Enea NFV Access can be downloaded | ||
183 | Often containing same version as in ELTF_EL_REL_VER | ||
184 | xi:include ULINK_ENEA_LINUX_URL/1 | ||
185 | This is an <ulink url="...">...</ulink> | ||
186 | Example: | ||
187 | http://linux.enea.com/6 | ||
188 | |||
189 | _____________________________________________________________________________ | ||
190 | ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. | ||
191 | Use the variable $MACHINE/default.xml (the text in | ||
192 | the book will list the avaiable values of MACHINE, | ||
193 | taken from the manifest repository) | ||
194 | xi:include eltf-repo-cloning-enea-linux/1 | ||
195 | This is a <programlisting>...</programlisting> | ||
196 | Example: | ||
197 | mkdir enea-linux | ||
198 | cd enea-linux | ||
199 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
200 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
201 | repo sync | ||
202 | |||
203 | _____________________________________________________________________________ | ||
204 | ELTF_ECLIPSE_VERSION Optional general parameter string. | ||
205 | NOT YET READY DEFINED | ||
206 | Just now a release manage must manually set | ||
207 | condition="hidden" on the Eclipse section, | ||
208 | if Eclipse is not included in the release. | ||
209 | ELTF just replaces ELTF_ECLIPSE_VERSION with a full | ||
210 | string with "X.Y (name)" | ||
211 | It includes the ID and can only be ONCE in the book. | ||
212 | xi:include eltf-eclipse-version-row | ||
213 | Example. | ||
214 | 4.5 (Mars) | ||
215 | |||
216 | |||
217 | _____________________________________________________________________________ | ||
218 | ELTF_T_* All these are in each target (MACHINE) and ELTF | ||
219 | must separately replace them with strings for | ||
220 | each target | ||
221 | NOTE: All (except the MANIFEST_DIR) are in rows | ||
222 | in a table and ELTF can select to append | ||
223 | more parameters by adding more rows | ||
224 | |||
225 | _____________________________________________________________________________ | ||
226 | ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly | ||
227 | ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same | ||
228 | as the MACHINE names in $MACHINE/default.xml. | ||
229 | In book: a) Part of section ID | ||
230 | b) Part of section title | ||
231 | Examples: | ||
232 | p2041rgb | ||
233 | or | ||
234 | ls1021aiot | ||
235 | or | ||
236 | qemuarm | ||
237 | |||
238 | _____________________________________________________________________________ | ||
239 | ELTF_T_NAME Target specific: "Target Official Name" | ||
240 | NOT same as the target directory name in most cases. | ||
241 | In book: An <entry> element in a row | ||
242 | Examples: | ||
243 | P2041RGB | ||
244 | or | ||
245 | LS1021a-IoT | ||
246 | or | ||
247 | qemuarm | ||
248 | |||
249 | _____________________________________________________________________________ | ||
250 | ELTF_T_ARC_DESC Target specific: "Architecture and Description" | ||
251 | It can be a short identification string or | ||
252 | it can be a longer descriptive sentence. | ||
253 | In book: An <entry> element in a row | ||
254 | Examples: | ||
255 | Power, e500mc | ||
256 | or | ||
257 | ARM Cortex-A7 | ||
258 | |||
259 | _____________________________________________________________________________ | ||
260 | ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These | ||
261 | ELTF_T_DS_URL two usually are IDENTICAL strings with correct | ||
262 | hyperlink to the target's official datasheet. | ||
263 | In book: an <ulink url="...">...</ulink> | ||
264 | Only if the link is VERY LONG, the text part shall | ||
265 | instead be a descriptive string (see 2:nd example). | ||
266 | NOTE: Also here no spaces or line-feeds! | ||
267 | Examples: | ||
268 | url="http://wiki.qemu.org">http://wiki.qemu.org | ||
269 | or | ||
270 | url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet | ||
271 | |||
272 | _____________________________________________________________________________ | ||
273 | ELTF_T_POKY_VER Target specific: "Poky version" created either | ||
274 | from POKYVERSION in poky.ent | ||
275 | or using a hashvalue with a leading string, in | ||
276 | which case it may be different per target. | ||
277 | In book: An <entry> in a row | ||
278 | Examples: | ||
279 | 15.0.0 | ||
280 | or | ||
281 | Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 | ||
282 | |||
283 | _____________________________________________________________________________ | ||
284 | ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky | ||
285 | but not easy to find among various parameters. | ||
286 | ELTF would extract it from build logs building SDK | ||
287 | and it is possibly different per target. | ||
288 | In book: An <entry> in a row | ||
289 | Example: | ||
290 | 5.3 | ||
291 | |||
292 | _____________________________________________________________________________ | ||
293 | ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often | ||
294 | different per target. | ||
295 | In book: An <entry> in a row | ||
296 | Example: | ||
297 | 3.12 | ||
298 | |||
299 | _____________________________________________________________________________ | ||
300 | ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a | ||
301 | comma-separated list of driver names. | ||
302 | ELTF should create the list in same order for each | ||
303 | target, e.g. alphabetic migth be OK. | ||
304 | In book: An <entry> in a row | ||
305 | Example: | ||
306 | Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC | ||
307 | |||
308 | |||
309 | _____________________________________________________________________________ | ||
310 | ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading | ||
311 | ELTF_T_EL_RPM_URL RPM packages for this target". These two are | ||
312 | INDENTICAL strings with hyperlink to the web site | ||
313 | at Enea where the customer can download RPMs | ||
314 | Note: Often the ELFT_EL_REL_VER value and | ||
315 | the ELTF_T_MANIFEST_DIR are used in the link. | ||
316 | In book: an <ulink url="...">...</ulink> | ||
317 | Example: | ||
318 | url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm | ||
319 | |||
320 | _____________________________________________________________________________ | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info-intel/doc/getting_enea_nfv_access.xml deleted file mode 100644 index 2bf9c22..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/getting_enea_nfv_access.xml +++ /dev/null | |||
@@ -1,31 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-getting-enea-nfv-access"> | ||
5 | <title>Getting Enea NFV Access</title> | ||
6 | |||
7 | <para>Enea NFV Access releases are available as binaries ready for download | ||
8 | on the <ulink | ||
9 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea | ||
10 | Download Portal</ulink>. Updates of Enea NFV Access are also available for | ||
11 | download through the portal.</para> | ||
12 | |||
13 | <para>Log in using the credentials provided by Enea. Using the menu at the | ||
14 | top, browse to the <literal>NFV</literal> section, which will provide access | ||
15 | to a <literal>Files</literal> section and an <literal>Online | ||
16 | Documentation</literal> section. The <literal>Files</literal> section lists | ||
17 | each Enea NFV Access release version as a separate download package. | ||
18 | Clicking on any of the release packages will provide further details such as | ||
19 | the date when it was made available, the file size and the changelog. Most | ||
20 | importantly, it provides access to the download links.</para> | ||
21 | |||
22 | <para>Each archive is mirrored in several places, geographically. Choose the | ||
23 | archive in the region closest to you for better download speeds. For details | ||
24 | about the contents of the release package, please refer to <xref | ||
25 | linkend="release-content" />.</para> | ||
26 | |||
27 | <para>The <literal>Online documentation</literal> section provides quick | ||
28 | access to the documents delivered with the release. For details about the | ||
29 | books delivered and their purpose, please refer to <xref | ||
30 | linkend="relinfo-documentation" />.</para> | ||
31 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/jiraissues_override.xml b/doc/book-enea-nfv-access-release-info-intel/doc/jiraissues_override.xml deleted file mode 100644 index 7282d0f..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/jiraissues_override.xml +++ /dev/null | |||
@@ -1,36 +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="relinfo-extracted-from-jira"> | ||
5 | <title>Release-Specific Problems</title> | ||
6 | |||
7 | <informaltable> | ||
8 | <tgroup cols="2"> | ||
9 | <colspec colwidth="6*" colname="c1"/> | ||
10 | |||
11 | <colspec align="center" colwidth="1*" colname="c2"/> | ||
12 | |||
13 | <thead> | ||
14 | <row> | ||
15 | <entry align="center">Summary</entry> | ||
16 | |||
17 | <entry>Enea Ref</entry> | ||
18 | </row> | ||
19 | </thead> | ||
20 | |||
21 | <tbody> | ||
22 | <row> | ||
23 | <entry>Eclipse Plug-Ins for Perf and Latencytop are not functioning properly on P2041RDB target.</entry> | ||
24 | |||
25 | <entry>LXCR-6936</entry> | ||
26 | </row> | ||
27 | |||
28 | <row> | ||
29 | <entry><para>LTTng kernel tracing from Eclipse does not work due to RSE connectivity problems.</para><para>As a workaround, traces can be collected on target and visualized on Eclipse, after copying the files on the host system.</para></entry> | ||
30 | |||
31 | <entry>LXCR-7166</entry> | ||
32 | </row> | ||
33 | </tbody> | ||
34 | </tgroup> | ||
35 | </informaltable> | ||
36 | </section> | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info-intel/doc/known_bugs_and_limitations.xml deleted file mode 100644 index 67db036..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/known_bugs_and_limitations.xml +++ /dev/null | |||
@@ -1,53 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="bugs-limitations"> | ||
5 | <title>Known Problems in This Release</title> | ||
6 | |||
7 | <para>All known issues listed in this chapter will be addressed in | ||
8 | maintenance updates following the major release.<remark>INFO: The <emphasis | ||
9 | role="bold">Release-Specific Problems</emphasis> section further down is | ||
10 | generated from JIRA with gen_known_issues.py, but that script is HARDCODED | ||
11 | with affectedversion "EL7_3-virtualization" and needs to be adapted when a | ||
12 | release info for another ENFV Access version changes.</remark></para> | ||
13 | |||
14 | <section id="release-specific-limitations"> | ||
15 | <title>Release-Specific Limitations</title> | ||
16 | |||
17 | <para><emphasis role="bold">Issues concerning the current | ||
18 | release</emphasis>:</para> | ||
19 | |||
20 | <itemizedlist> | ||
21 | <listitem> | ||
22 | <para>OFP and ODP are not included with the current release but they | ||
23 | will be included in a later maintenance update.<remark>FIXME, | ||
24 | requesting help from Ca</remark></para> | ||
25 | </listitem> | ||
26 | </itemizedlist> | ||
27 | |||
28 | <para><emphasis role="bold">Issues affecting | ||
29 | documentation</emphasis>:</para> | ||
30 | |||
31 | <itemizedlist> | ||
32 | <listitem> | ||
33 | <para>Documents provided in this release will continue to be regularly | ||
34 | updated with additional content. </para> | ||
35 | </listitem> | ||
36 | |||
37 | <listitem> | ||
38 | <para><emphasis role="bold">PDF navigation</emphasis>: When using | ||
39 | links to open other PDFs, or jump to another place in the same PDF, | ||
40 | jumping back sometimes fails. This has been observed when opening a | ||
41 | PDF in Adobe Reader, inside a browser with PDF add-on, as well as when | ||
42 | the browser is configured to open PDF files in an external PDF reader. | ||
43 | As a workaround, open the HTML version of the | ||
44 | document.<remark>LXCR-3283</remark></para> | ||
45 | </listitem> | ||
46 | </itemizedlist> | ||
47 | </section> | ||
48 | |||
49 | <!-- The file with a section below is autocreated by make init --> | ||
50 | |||
51 | <!-- <xi:include href="jiraissues_generated.xml" | ||
52 | xmlns:xi="http://www.w3.org/2001/XInclude" /> --> | ||
53 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info-intel/doc/main_changes.xml deleted file mode 100644 index a0cf1c5..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/main_changes.xml +++ /dev/null | |||
@@ -1,114 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-changes"> | ||
5 | <title>Main Changes</title> | ||
6 | |||
7 | <para>This chapter provides information about the new features added in the | ||
8 | current release, as well as details on the provided packages and the | ||
9 | backwards compatibility with previous versions of Enea NFV Access.</para> | ||
10 | |||
11 | <section id="relinfo-changes-other"> | ||
12 | <title>New Features</title> | ||
13 | |||
14 | <itemizedlist> | ||
15 | <listitem> | ||
16 | <para>Key Component updates:</para> | ||
17 | |||
18 | <itemizedlist> | ||
19 | <listitem> | ||
20 | <para>DPDK 17.08</para> | ||
21 | </listitem> | ||
22 | |||
23 | <listitem> | ||
24 | <para>OVS 2.8</para> | ||
25 | </listitem> | ||
26 | </itemizedlist> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem> | ||
30 | <para>Feature Extensions:</para> | ||
31 | |||
32 | <itemizedlist> | ||
33 | <listitem> | ||
34 | <para>Element ODM: FCAPS framework with NETCONF and Yang.</para> | ||
35 | </listitem> | ||
36 | |||
37 | <listitem> | ||
38 | <para>EdgeLink Netconf (beta): NETCONF based VNF lifecycle | ||
39 | Management Tool.</para> | ||
40 | </listitem> | ||
41 | </itemizedlist> | ||
42 | </listitem> | ||
43 | |||
44 | <listitem> | ||
45 | <para>Extended Tools Feature Set:</para> | ||
46 | |||
47 | <itemizedlist> | ||
48 | <listitem> | ||
49 | <para>python-pip</para> | ||
50 | </listitem> | ||
51 | |||
52 | <listitem> | ||
53 | <para>dosfstools</para> | ||
54 | </listitem> | ||
55 | |||
56 | <listitem> | ||
57 | <para>htop</para> | ||
58 | </listitem> | ||
59 | </itemizedlist> | ||
60 | </listitem> | ||
61 | |||
62 | <listitem> | ||
63 | <para>Unified cross-development SDK for host and virtualized | ||
64 | environments.</para> | ||
65 | </listitem> | ||
66 | |||
67 | <listitem> | ||
68 | <para>Native toolchain support on development image.</para> | ||
69 | </listitem> | ||
70 | |||
71 | <listitem> | ||
72 | <para>USB-stick based installation</para> | ||
73 | </listitem> | ||
74 | |||
75 | <listitem> | ||
76 | <para>Product Maintenance:</para> | ||
77 | |||
78 | <itemizedlist> | ||
79 | <listitem> | ||
80 | <para>Optimizations</para> | ||
81 | </listitem> | ||
82 | |||
83 | <listitem> | ||
84 | <para>Security patches</para> | ||
85 | </listitem> | ||
86 | |||
87 | <listitem> | ||
88 | <para>Bug fixes</para> | ||
89 | </listitem> | ||
90 | |||
91 | <listitem> | ||
92 | <para>Updated documentation</para> | ||
93 | </listitem> | ||
94 | </itemizedlist> | ||
95 | </listitem> | ||
96 | </itemizedlist> | ||
97 | </section> | ||
98 | |||
99 | <section id="open_source"> | ||
100 | <title>Open Source</title> | ||
101 | |||
102 | <para>For more information about the Open Source packages included, please | ||
103 | refer to the Enea NFV Access Open Source Reports provided with this | ||
104 | release.</para> | ||
105 | </section> | ||
106 | |||
107 | <section id="relinfo-backward-compat"> | ||
108 | <title>Compatibility</title> | ||
109 | |||
110 | <para>Due to the fact that ODP and OFP are not included in this release, | ||
111 | any applications dependent on these components are not compatible with the | ||
112 | current release.</para> | ||
113 | </section> | ||
114 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/system_requirements.xml b/doc/book-enea-nfv-access-release-info-intel/doc/system_requirements.xml deleted file mode 100644 index 7bab63d..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/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 -> bash</programlisting> | ||
161 | </section> | ||
162 | </section> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/doc/system_requirements_prerequisites.xml b/doc/book-enea-nfv-access-release-info-intel/doc/system_requirements_prerequisites.xml deleted file mode 100644 index 44e70af..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/doc/system_requirements_prerequisites.xml +++ /dev/null | |||
@@ -1,61 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="sys-req-prerequisites"> | ||
5 | <title>Host Requirements</title> | ||
6 | |||
7 | <para>Using Enea NFV Access or compiling applications requires certain | ||
8 | packages to be installed on your build host. The requirements listed below | ||
9 | are extensive to allow getting Enea NFV Access to be booted on target | ||
10 | machines and for building applications.</para> | ||
11 | |||
12 | <informaltable> | ||
13 | <tgroup cols="2"> | ||
14 | <colspec align="left" colname="1" colwidth="1*" /> | ||
15 | |||
16 | <colspec align="left" colname="2" colwidth="3*" /> | ||
17 | |||
18 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
19 | |||
20 | <tbody> | ||
21 | <row> | ||
22 | <entry spanname="onetwo"><emphasis role="bold"> Build Host | ||
23 | Requirements<indexterm> | ||
24 | <primary>host requirements</primary> | ||
25 | </indexterm></emphasis></entry> | ||
26 | </row> | ||
27 | |||
28 | <row> | ||
29 | <entry>Linux distribution</entry> | ||
30 | |||
31 | <entry>The downloaded product can installed on the target machine | ||
32 | using a Linux host. For information about supported hosts and | ||
33 | targets, see <xref | ||
34 | linkend="relinfo-supported-host-environment" />.</entry> | ||
35 | </row> | ||
36 | |||
37 | <row> | ||
38 | <entry>Packages</entry> | ||
39 | |||
40 | <entry>Depending on the Linux distribution and version of the host, | ||
41 | certain packages may be required. See details on what packages are | ||
42 | needed and how to install them in the following sections.</entry> | ||
43 | </row> | ||
44 | |||
45 | <row> | ||
46 | <entry>Disk space</entry> | ||
47 | |||
48 | <entry>Your build host should have at least 50 GB of free disk space | ||
49 | for installing the SDK or cross-compiling applications.</entry> | ||
50 | </row> | ||
51 | |||
52 | <row> | ||
53 | <entry>Recommended RAM</entry> | ||
54 | |||
55 | <entry>Your build host must have at least 4 GB available | ||
56 | RAM.</entry> | ||
57 | </row> | ||
58 | </tbody> | ||
59 | </tgroup> | ||
60 | </informaltable> | ||
61 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info-intel/swcomp.mk b/doc/book-enea-nfv-access-release-info-intel/swcomp.mk deleted file mode 100644 index 3ba7c8d..0000000 --- a/doc/book-enea-nfv-access-release-info-intel/swcomp.mk +++ /dev/null | |||
@@ -1,10 +0,0 @@ | |||
1 | # Component build specification | ||
2 | |||
3 | # Version of THIS book | ||
4 | BOOK_VER ?= $(REL_VER)-dev | ||
5 | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | ||
7 | |||
8 | BOOKPACKAGES := book-enea-nfv-access-release-info | ||
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Release Information" | ||
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | ||
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 df1d831..6aab432 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 | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <chapter id="relinfo-about-release"> | 4 | <chapter id="relinfo-about-release"> |
@@ -17,7 +17,7 @@ | |||
17 | for important details about formats and how to do! The idea is that ELTF | 17 | for important details about formats and how to do! The idea is that ELTF |
18 | will auto-create/update it.</remark></para> | 18 | will auto-create/update it.</remark></para> |
19 | 19 | ||
20 | <itemizedlist> | 20 | <itemizedlist spacing="compact"> |
21 | <listitem> | 21 | <listitem> |
22 | <para>DPDK 17.08</para> | 22 | <para>DPDK 17.08</para> |
23 | </listitem> | 23 | </listitem> |
@@ -26,9 +26,13 @@ | |||
26 | <para>OVS 2.8</para> | 26 | <para>OVS 2.8</para> |
27 | </listitem> | 27 | </listitem> |
28 | 28 | ||
29 | <listitem condition="intel"> | ||
30 | <para>Element ODM: FCAPS framework with NETCONF and Yang</para> | ||
31 | </listitem> | ||
32 | |||
29 | <listitem> | 33 | <listitem> |
30 | <para>Edge Link Netconf (beta): NETCONF based VNF lifecycle Management | 34 | <para>Edge Link Netconf (beta): NETCONF based VNF lifecycle Management |
31 | Tool.</para> | 35 | Tool</para> |
32 | </listitem> | 36 | </listitem> |
33 | 37 | ||
34 | <listitem> | 38 | <listitem> |
@@ -51,11 +55,11 @@ | |||
51 | 55 | ||
52 | <listitem> | 56 | <listitem> |
53 | <para>Unified cross-development SDK for host and virtualized | 57 | <para>Unified cross-development SDK for host and virtualized |
54 | environments.</para> | 58 | environments</para> |
55 | </listitem> | 59 | </listitem> |
56 | 60 | ||
57 | <listitem> | 61 | <listitem> |
58 | <para>Native toolchain support on development image.</para> | 62 | <para>Native toolchain support on development image</para> |
59 | </listitem> | 63 | </listitem> |
60 | 64 | ||
61 | <listitem> | 65 | <listitem> |
@@ -89,10 +93,53 @@ | |||
89 | <title>Enea NFV Access Release Content</title> | 93 | <title>Enea NFV Access Release Content</title> |
90 | 94 | ||
91 | <para>The current release contains along with other items, documentation, | 95 | <para>The current release contains along with other items, documentation, |
92 | pre-built kernels and images, a bootloader and a SDK. The directories | 96 | pre-built kernels and images, a bootloader and a SDK. The directory |
93 | structure is detailed below:</para> | 97 | structure is detailed below:</para> |
94 | 98 | ||
95 | <programlisting>-- Documentation/ | 99 | <programlisting condition="intel">-- documentation/ |
100 | /* Enea NFV Access documentation */ | ||
101 | -- x86-64 /* architecture */ | ||
102 | -- inteld1521/ | ||
103 | /* artifacts for the host side */ | ||
104 | -- deb/ | ||
105 | /* deb packages */ | ||
106 | -- images/ | ||
107 | -- enea-nfv-access | ||
108 | /* precompiled artifacts for the platform release image */ | ||
109 | -- various artifacts (rootfs, kernel, config etc.) | ||
110 | -- enea-nfv-access-dev | ||
111 | /* precompiled artifacts for the development process. The image | ||
112 | contains userspace tools and kernel configurations necessary | ||
113 | for developing, debugging and profiling applications and | ||
114 | kernel modules */ | ||
115 | -- various artifacts | ||
116 | -- qemux86-64 | ||
117 | /* artifacts for the guest side */ | ||
118 | -- deb/ | ||
119 | /* deb packages */ | ||
120 | -- images/ | ||
121 | -- enea-nfv-access-guest | ||
122 | /* precompiled artifacts for the QEMU/Docker release image */ | ||
123 | -- various artifacts | ||
124 | -- enea-nfv-access-guest-dev | ||
125 | /* precompiled artifacts for the development process. The image | ||
126 | contains userspace tools and kernel configurations necessary | ||
127 | for developing, debugging and profiling applications and | ||
128 | kernel modules */ | ||
129 | -- various artifacts | ||
130 | -- install | ||
131 | -- sdk | ||
132 | /* SDK related artifacts including SDK installer and manifests */ | ||
133 | -- install-sdk.sh | ||
134 | /* self-extracting archive installing cross-compilation | ||
135 | toolchain for the platform */ | ||
136 | -- nfv-installer | ||
137 | /* Various tools assisting in booting Enea NFV Access */ | ||
138 | -- script-installer | ||
139 | /* installer tool intended for creating a bootable Enea | ||
140 | NFV Access installation on a physical media */</programlisting> | ||
141 | |||
142 | <programlisting condition="arm">-- documentation/ | ||
96 | /* Enea NFV Access documentation */ | 143 | /* Enea NFV Access documentation */ |
97 | -- README | 144 | -- README |
98 | -- aarch64 /* architecture */ | 145 | -- aarch64 /* architecture */ |
@@ -129,13 +176,12 @@ | |||
129 | /* SDK related artifacts including SDK installer and manifests */ | 176 | /* SDK related artifacts including SDK installer and manifests */ |
130 | -- install-sdk.sh | 177 | -- install-sdk.sh |
131 | /* self-extracting archive installing cross-compilation | 178 | /* self-extracting archive installing cross-compilation |
132 | toolchain for the platform */ | 179 | toolchain for the platform */</programlisting> |
133 | </programlisting> | ||
134 | 180 | ||
135 | <para>For each combination of image and target, the following set of | 181 | <para>For each combination of image and target, the following set of |
136 | artifacts is available:</para> | 182 | artifacts is available:</para> |
137 | 183 | ||
138 | <programlisting>-- Image | 184 | <programlisting condition="arm">-- Image |
139 | /* kernel image */ | 185 | /* kernel image */ |
140 | -- Image-target.bin | 186 | -- Image-target.bin |
141 | /* kernel image, same as above */ | 187 | /* kernel image, same as above */ |
@@ -150,16 +196,36 @@ | |||
150 | -- image-name-target.tar.gz | 196 | -- image-name-target.tar.gz |
151 | /* tar archive of the image */ | 197 | /* tar archive of the image */ |
152 | -- modules-<target>.tgz | 198 | -- modules-<target>.tgz |
199 | /* external kernel modules */</programlisting> | ||
200 | |||
201 | <programlisting condition="intel">-- bzImage | ||
202 | /* kernel image */ | ||
203 | -- bzImage-target.bin | ||
204 | /* kernel image, same as above */ | ||
205 | -- config-target.config | ||
206 | /* kernel configuration file */ | ||
207 | -- image-name-target.ext4.gz | ||
208 | /* compressed EXT4 image of the rootfs */ | ||
209 | -- image-name-target.qcow2 | ||
210 | /* QCOW image for QEMU - only for guest images */ | ||
211 | -- image-name-target.qemuboot.conf | ||
212 | /* qemu config file for the guest images */ | ||
213 | -- image-name-target.tar.gz | ||
214 | /* tar archive of the image */ | ||
215 | -- modules-<target>.tgz | ||
153 | /* external kernel modules */ | 216 | /* external kernel modules */ |
154 | </programlisting> | 217 | -- grub-efi-bootx64.efi |
218 | /* GRUB EFI file */</programlisting> | ||
155 | </section> | 219 | </section> |
156 | 220 | ||
157 | <section id="relinfo-supported-host-environment"> | 221 | <section id="relinfo-supported-host-environment"> |
158 | <title>Supported Host Environment</title> | 222 | <title>Supported Host Environment</title> |
159 | 223 | ||
160 | <para>The following environments have been validated as host environments | 224 | <para>The following environments have been validated as host environments |
161 | for Enea NFV Access 1.1: <emphasis role="bold">Ubuntu 16.04 LTS, | 225 | for Enea NFV Access <xi:include href="eltf_params_updated.xml" |
162 | 64bit</emphasis>.</para> | 226 | xmlns:xi="http://www.w3.org/2001/XInclude" |
227 | xpointer="element(EneaLinux_REL_VER/1)" />: <emphasis role="bold">Ubuntu | ||
228 | 16.04 LTS, 64bit</emphasis>.</para> | ||
163 | 229 | ||
164 | <para><remark>Hardcoded now in this XML file. Might be moved to the | 230 | <para><remark>Hardcoded now in this XML file. Might be moved to the |
165 | parameter file later.</remark> <remark>INFO Below is a complete section | 231 | parameter file later.</remark> <remark>INFO Below is a complete section |
@@ -169,7 +235,7 @@ | |||
169 | has have a short sentence about what it is in the beginning. The subtitles | 235 | has have a short sentence about what it is in the beginning. The subtitles |
170 | shall have the directory name of the target in the manifest.</remark>For | 236 | shall have the directory name of the target in the manifest.</remark>For |
171 | more details on host requirements and how to configure the host | 237 | more details on host requirements and how to configure the host |
172 | environment, please see <xref linkend="sys-req-prerequisites" />.</para> | 238 | environment, see <xref linkend="sys-req-prerequisites" />.</para> |
173 | </section> | 239 | </section> |
174 | 240 | ||
175 | <xi:include href="eltf_params_updated.xml" | 241 | <xi:include href="eltf_params_updated.xml" |
@@ -180,8 +246,9 @@ | |||
180 | <title>Provided Toolchain(s) (SDK)</title> | 246 | <title>Provided Toolchain(s) (SDK)</title> |
181 | 247 | ||
182 | <para>The provided SDK contains toolchains supporting cross-compilation of | 248 | <para>The provided SDK contains toolchains supporting cross-compilation of |
183 | applications for both the host and the guest targets on an arm64 | 249 | applications for both the host and the guest targets on an <filename |
184 | machine.</para> | 250 | condition="arm">arm64</filename><filename |
251 | condition="intel">x86-64</filename> machine.</para> | ||
185 | 252 | ||
186 | <para><remark>(Possibly add this in later) See the <trademark | 253 | <para><remark>(Possibly add this in later) See the <trademark |
187 | class="registered">Enea</trademark> NFV Access Application Development | 254 | class="registered">Enea</trademark> NFV Access Application Development |
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 0f03d8c..40bc8bf 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 | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <section id="eltf_created_params"> | 4 | <section id="eltf_created_params"> |
@@ -94,10 +94,10 @@ repo sync</programlisting></para> | |||
94 | <para>The table(s) below describes the target(s) supported in this Enea | 94 | <para>The table(s) below describes the target(s) supported in this Enea |
95 | NFV Access release.</para> | 95 | NFV Access release.</para> |
96 | 96 | ||
97 | <section id="eltf-target-table-D-1521"> | 97 | <section id="eltf-target-table"> |
98 | <title>MACHINE OCTEON TX™ cn8304 - Information</title> | 98 | <title>MACHINE Information</title> |
99 | 99 | ||
100 | <para><informaltable> | 100 | <para><informaltable condition="arm"> |
101 | <tgroup cols="2"> | 101 | <tgroup cols="2"> |
102 | <colspec colwidth="6*" /> | 102 | <colspec colwidth="6*" /> |
103 | 103 | ||
@@ -107,7 +107,7 @@ repo sync</programlisting></para> | |||
107 | <row> | 107 | <row> |
108 | <entry>Target official name</entry> | 108 | <entry>Target official name</entry> |
109 | 109 | ||
110 | <entry>OCTEON TX™ cn8304</entry> | 110 | <entry>OCTEON TX™ cn8304</entry> |
111 | </row> | 111 | </row> |
112 | 112 | ||
113 | <row> | 113 | <row> |
@@ -121,7 +121,60 @@ repo sync</programlisting></para> | |||
121 | 121 | ||
122 | <entry>See link to <ulink | 122 | <entry>See link to <ulink |
123 | url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON | 123 | url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON |
124 | TX™ cn8304 datasheet</ulink></entry> | 124 | TX™ cn8304 datasheet</ulink></entry> |
125 | </row> | ||
126 | |||
127 | <row> | ||
128 | <entry>Poky version</entry> | ||
129 | |||
130 | <entry>Git-commit-id: | ||
131 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | ||
132 | </row> | ||
133 | |||
134 | <row> | ||
135 | <entry>GCC version</entry> | ||
136 | |||
137 | <entry>5.3<remark>FIXME</remark></entry> | ||
138 | </row> | ||
139 | |||
140 | <row> | ||
141 | <entry>Linux Kernel Version</entry> | ||
142 | |||
143 | <entry>3.12<remark>FIXME</remark></entry> | ||
144 | </row> | ||
145 | |||
146 | <row condition="hidden"> | ||
147 | <entry>Supported Drivers</entry> | ||
148 | |||
149 | <entry>Ethernet, RTC, UART</entry> | ||
150 | </row> | ||
151 | </tbody> | ||
152 | </tgroup> | ||
153 | </informaltable><informaltable condition="intel"> | ||
154 | <tgroup cols="2"> | ||
155 | <colspec colwidth="6*" /> | ||
156 | |||
157 | <colspec colwidth="9*" /> | ||
158 | |||
159 | <tbody> | ||
160 | <row> | ||
161 | <entry>Target official name</entry> | ||
162 | |||
163 | <entry>Intel Xeon D-1521</entry> | ||
164 | </row> | ||
165 | |||
166 | <row> | ||
167 | <entry>Architecture and Description</entry> | ||
168 | |||
169 | <entry>x86-64</entry> | ||
170 | </row> | ||
171 | |||
172 | <row> | ||
173 | <entry>Link to target datasheet</entry> | ||
174 | |||
175 | <entry>See link to <ulink | ||
176 | url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's | ||
177 | datasheet</ulink></entry> | ||
125 | </row> | 178 | </row> |
126 | 179 | ||
127 | <row> | 180 | <row> |
@@ -153,4 +206,4 @@ repo sync</programlisting></para> | |||
153 | </informaltable></para> | 206 | </informaltable></para> |
154 | </section> | 207 | </section> |
155 | </section> | 208 | </section> |
156 | </section> | 209 | </section> \ No newline at end of file |
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 6a453a0..00cf31f 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 | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <chapter id="relinfo-changes"> | 4 | <chapter id="relinfo-changes"> |
@@ -24,7 +24,7 @@ | |||
24 | <para>OVS 2.8</para> | 24 | <para>OVS 2.8</para> |
25 | </listitem> | 25 | </listitem> |
26 | 26 | ||
27 | <listitem> | 27 | <listitem condition="arm"> |
28 | <para>ODP</para> | 28 | <para>ODP</para> |
29 | </listitem> | 29 | </listitem> |
30 | </itemizedlist> | 30 | </itemizedlist> |
@@ -34,13 +34,13 @@ | |||
34 | <para>Feature Extensions:</para> | 34 | <para>Feature Extensions:</para> |
35 | 35 | ||
36 | <itemizedlist> | 36 | <itemizedlist> |
37 | <listitem> | 37 | <listitem condition="intel"> |
38 | <para>Element ODM: FCAPS framework with NETCONF and Yang.</para> | 38 | <para>Element ODM: FCAPS framework with NETCONF and Yang</para> |
39 | </listitem> | 39 | </listitem> |
40 | 40 | ||
41 | <listitem> | 41 | <listitem> |
42 | <para>EdgeLink Netconf (beta): NETCONF based VNF lifecycle | 42 | <para>EdgeLink Netconf (beta): NETCONF based VNF lifecycle |
43 | Management Tool.</para> | 43 | Management Tool</para> |
44 | </listitem> | 44 | </listitem> |
45 | </itemizedlist> | 45 | </itemizedlist> |
46 | </listitem> | 46 | </listitem> |
@@ -65,11 +65,11 @@ | |||
65 | 65 | ||
66 | <listitem> | 66 | <listitem> |
67 | <para>Unified cross-development SDK for host and virtualized | 67 | <para>Unified cross-development SDK for host and virtualized |
68 | environments.</para> | 68 | environments</para> |
69 | </listitem> | 69 | </listitem> |
70 | 70 | ||
71 | <listitem> | 71 | <listitem> |
72 | <para>Native toolchain support on development image.</para> | 72 | <para>Native toolchain support on development image</para> |
73 | </listitem> | 73 | </listitem> |
74 | 74 | ||
75 | <listitem> | 75 | <listitem> |
@@ -111,8 +111,12 @@ | |||
111 | <section id="relinfo-backward-compat"> | 111 | <section id="relinfo-backward-compat"> |
112 | <title>Compatibility</title> | 112 | <title>Compatibility</title> |
113 | 113 | ||
114 | <para>Due to the fact that OFP is not included in this release, any | 114 | <para condition="arm">Due to the fact that the current release is only |
115 | applications dependent on these components are not compatible with the | 115 | supported on ARM reference boards, it is not backwards compatible with |
116 | current release.</para> | 116 | previous versions of Enea NFV Access.</para> |
117 | |||
118 | <para condition="intel">Due to the fact that ODP and OFP are not included | ||
119 | in this release, any applications dependent on these components are not | ||
120 | compatible with the current release.</para> | ||
117 | </section> | 121 | </section> |
118 | </chapter> \ No newline at end of file | 122 | </chapter> \ No newline at end of file |