diff options
6 files changed, 776 insertions, 32 deletions
diff --git a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml index 19c3c0b..097f9ff 100644 --- a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml +++ b/book-enea-nfv-core-installation-guide/doc/installation_instructions.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="install_instructions"> | 4 | <chapter id="install_instructions"> |
@@ -202,7 +202,7 @@ | |||
202 | <row> | 202 | <row> |
203 | <entry>Networks</entry> | 203 | <entry>Networks</entry> |
204 | 204 | ||
205 | <entry><para>Apart from the integrated NICs, one Intel® 82574L | 205 | <entry><para>Apart from the integrated NICs, one Intel® 82574L |
206 | PCIe card was also installed, to be used by Fuel Admin on each | 206 | PCIe card was also installed, to be used by Fuel Admin on each |
207 | server.</para></entry> | 207 | server.</para></entry> |
208 | </row> | 208 | </row> |
@@ -235,7 +235,7 @@ | |||
235 | <row> | 235 | <row> |
236 | <entry>CPU</entry> | 236 | <entry>CPU</entry> |
237 | 237 | ||
238 | <entry>Intel® Xeon® D-1537 8-core/HT 1.7 GHz 35W</entry> | 238 | <entry>Intel® Xeon® D-1537 8-core/HT 1.7 GHz 35W</entry> |
239 | </row> | 239 | </row> |
240 | 240 | ||
241 | <row> | 241 | <row> |
@@ -255,7 +255,7 @@ | |||
255 | 255 | ||
256 | <entry><para>NICs: </para><itemizedlist> | 256 | <entry><para>NICs: </para><itemizedlist> |
257 | <listitem> | 257 | <listitem> |
258 | <para>Intel® i350-AM2 Dual port GbE LAN</para> | 258 | <para>Intel® i350-AM2 Dual port GbE LAN</para> |
259 | </listitem> | 259 | </listitem> |
260 | 260 | ||
261 | <listitem> | 261 | <listitem> |
@@ -289,7 +289,8 @@ | |||
289 | <row> | 289 | <row> |
290 | <entry>CPU</entry> | 290 | <entry>CPU</entry> |
291 | 291 | ||
292 | <entry>2 x Intel® Xeon® E5-2620 v4 8 -core/HT 2.0 GHz 85W</entry> | 292 | <entry>2 x Intel® Xeon® E5-2620 v4 8 -core/HT 2.0 GHz |
293 | 85W</entry> | ||
293 | </row> | 294 | </row> |
294 | 295 | ||
295 | <row> | 296 | <row> |
@@ -303,7 +304,7 @@ | |||
303 | 304 | ||
304 | <entry><para>NICs: </para><itemizedlist> | 305 | <entry><para>NICs: </para><itemizedlist> |
305 | <listitem> | 306 | <listitem> |
306 | <para>Intel® i350-AM2 Dual port GbE LAN</para> | 307 | <para>Intel® i350-AM2 Dual port GbE LAN</para> |
307 | </listitem> | 308 | </listitem> |
308 | 309 | ||
309 | <listitem> | 310 | <listitem> |
@@ -668,7 +669,8 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog | |||
668 | </listitem> | 669 | </listitem> |
669 | 670 | ||
670 | <listitem condition="hidden"> | 671 | <listitem condition="hidden"> |
671 | <para>In the Additional Services select “Install Vitrage”:</para> | 672 | <para>In the Additional Services select ”Install |
673 | Vitrage”:</para> | ||
672 | 674 | ||
673 | <mediaobject> | 675 | <mediaobject> |
674 | <imageobject> | 676 | <imageobject> |
@@ -1245,14 +1247,15 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog | |||
1245 | <para>Set up targets for "Verify Networks" with non-default | 1247 | <para>Set up targets for "Verify Networks" with non-default |
1246 | "Offloading Modes".</para> | 1248 | "Offloading Modes".</para> |
1247 | 1249 | ||
1248 | <para>Please check the Release Notes for the <phrase>1.1</phrase> | 1250 | <para>Please see the chapter <olink |
1249 | release of Enea NFV Core when using Fuel as a deployment tool, | 1251 | targetdoc="book_enea_nfv_core_release_info" |
1250 | <remark>Change this to an Olink to the Release notes once the ID has | 1252 | targetptr="bugs-limitations">Known Issues and Limitations, in the |
1251 | been created for that book. Add the ID to pardoc-names.xml and | 1253 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1252 | pardoc-common if needed, then updated the OlinkDB</remark>for an | 1254 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1253 | updated and comprehensive list of known issues and limitations, | 1255 | xpointer="element(book_enea_nfv_core_release_info/1)" /></olink> for |
1254 | including the "Offloading Modes" not being applied during the "Verify | 1256 | the <phrase>1.1</phrase> release, for an updated and comprehensive |
1255 | Networks" step.</para> | 1257 | list of known issues and limitations, including the "Offloading Modes" |
1258 | not being applied during the "Verify Networks" step.</para> | ||
1256 | 1259 | ||
1257 | <para>Setting custom "Offloading Modes" in the Fuel GUI will only | 1260 | <para>Setting custom "Offloading Modes" in the Fuel GUI will only |
1258 | apply during provisioning, not during "Verify Networks". If your | 1261 | apply during provisioning, not during "Verify Networks". If your |
@@ -1339,14 +1342,14 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog | |||
1339 | 1342 | ||
1340 | <itemizedlist> | 1343 | <itemizedlist> |
1341 | <listitem> | 1344 | <listitem> |
1342 | <para>Provisioning – at this stage the nodes have been booted from PXE | 1345 | <para>Provisioning – at this stage the nodes have been booted |
1343 | and are running a small bootstrap image in ramdisk. The provisioning | 1346 | from PXE and are running a small bootstrap image in ramdisk. The |
1344 | process will write the target image onto the disk and make other | 1347 | provisioning process will write the target image onto the disk and |
1345 | preparations for running it after reboot.</para> | 1348 | make other preparations for running it after reboot.</para> |
1346 | </listitem> | 1349 | </listitem> |
1347 | 1350 | ||
1348 | <listitem> | 1351 | <listitem> |
1349 | <para>OpenStack installation – at this stage the nodes have been | 1352 | <para>OpenStack installation – at this stage the nodes have been |
1350 | rebooted on the newly written target image and the OpenStack | 1353 | rebooted on the newly written target image and the OpenStack |
1351 | components are installed and configured.</para> | 1354 | components are installed and configured.</para> |
1352 | </listitem> | 1355 | </listitem> |
@@ -1376,7 +1379,12 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog | |||
1376 | </orderedlist> | 1379 | </orderedlist> |
1377 | 1380 | ||
1378 | <para>On Mixed Arch deployments, certain tests might fail due to | 1381 | <para>On Mixed Arch deployments, certain tests might fail due to |
1379 | limitations detailed in the Enea NFV Core Release Information.</para> | 1382 | limitations detailed in the <olink |
1383 | targetdoc="book_enea_nfv_core_release_info" | ||
1384 | targetptr="bugs-limitations-gen">Know Issues and Limitations in the | ||
1385 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
1386 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
1387 | xpointer="element(book_enea_nfv_core_release_info/1)" /></olink>.</para> | ||
1380 | </section> | 1388 | </section> |
1381 | 1389 | ||
1382 | <section id="smoke_test"> | 1390 | <section id="smoke_test"> |
diff --git a/book-enea-nfv-core-release-info/doc/about_release.xml b/book-enea-nfv-core-release-info/doc/about_release.xml index 63827c5..5347e33 100644 --- a/book-enea-nfv-core-release-info/doc/about_release.xml +++ b/book-enea-nfv-core-release-info/doc/about_release.xml | |||
@@ -245,4 +245,39 @@ | |||
245 | </tgroup> | 245 | </tgroup> |
246 | </informaltable> | 246 | </informaltable> |
247 | </section> | 247 | </section> |
248 | |||
249 | <section id="relinfo_documentation_enc"> | ||
250 | <title>Provided Documentation</title> | ||
251 | |||
252 | <para>The following Enea NFV Core manuals are available in this | ||
253 | release:</para> | ||
254 | |||
255 | <itemizedlist spacing="compact"> | ||
256 | <listitem> | ||
257 | <para><trademark class="registered">Enea</trademark> NFV Core Release | ||
258 | Information (this document)</para> | ||
259 | </listitem> | ||
260 | |||
261 | <listitem> | ||
262 | <para><olink targetdoc="book_enea_nfv_core_installation_guide" | ||
263 | targetptr="book_enea_nfv_core_installation_guide"><trademark | ||
264 | class="registered">Enea</trademark> NFV Core User's Guide Installation | ||
265 | Guide</olink></para> | ||
266 | </listitem> | ||
267 | |||
268 | <listitem condition="hidden"> | ||
269 | <para> Enea Linux Open Source Report</para> | ||
270 | </listitem> | ||
271 | |||
272 | <listitem condition="hidden"> | ||
273 | <para><trademark class="registered">Enea</trademark> Linux Test | ||
274 | Report</para> | ||
275 | </listitem> | ||
276 | |||
277 | <listitem condition="hidden"> | ||
278 | <para><trademark class="registered">Enea</trademark> Linux Security | ||
279 | Report</para> | ||
280 | </listitem> | ||
281 | </itemizedlist> | ||
282 | </section> | ||
248 | </chapter> \ No newline at end of file | 283 | </chapter> \ No newline at end of file |
diff --git a/book-enea-nfv-core-release-info/doc/eltf_params_template.xml b/book-enea-nfv-core-release-info/doc/eltf_params_template.xml new file mode 100644 index 0000000..eaa7ebd --- /dev/null +++ b/book-enea-nfv-core-release-info/doc/eltf_params_template.xml | |||
@@ -0,0 +1,151 @@ | |||
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/book-enea-nfv-core-release-info/doc/eltf_params_updated.xml b/book-enea-nfv-core-release-info/doc/eltf_params_updated.xml new file mode 100644 index 0000000..cfb837e --- /dev/null +++ b/book-enea-nfv-core-release-info/doc/eltf_params_updated.xml | |||
@@ -0,0 +1,223 @@ | |||
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="EneaNfvCore_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 | <table condition="intel"> | ||
98 | <title>MACHINE Information</title> | ||
99 | |||
100 | <tgroup cols="2"> | ||
101 | <colspec align="center" /> | ||
102 | |||
103 | <thead> | ||
104 | <row> | ||
105 | <entry align="center">Component</entry> | ||
106 | |||
107 | <entry align="center">Description</entry> | ||
108 | </row> | ||
109 | </thead> | ||
110 | |||
111 | <tbody> | ||
112 | <row> | ||
113 | <entry align="left">Target official name</entry> | ||
114 | |||
115 | <entry>Intel Xeon D-1521</entry> | ||
116 | </row> | ||
117 | |||
118 | <row> | ||
119 | <entry align="left">Architecture and Description</entry> | ||
120 | |||
121 | <entry>x86-64</entry> | ||
122 | </row> | ||
123 | |||
124 | <row> | ||
125 | <entry align="left">Link to target datasheet</entry> | ||
126 | |||
127 | <entry><ulink | ||
128 | url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's | ||
129 | datasheet</ulink></entry> | ||
130 | </row> | ||
131 | |||
132 | <row> | ||
133 | <entry align="left">Poky version</entry> | ||
134 | |||
135 | <entry>Git-commit-id: | ||
136 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | ||
137 | </row> | ||
138 | |||
139 | <row> | ||
140 | <entry align="left">GCC version</entry> | ||
141 | |||
142 | <entry>5.3<remark>FIXME</remark></entry> | ||
143 | </row> | ||
144 | |||
145 | <row> | ||
146 | <entry align="left">Linux Kernel Version</entry> | ||
147 | |||
148 | <entry>3.12<remark>FIXME</remark></entry> | ||
149 | </row> | ||
150 | |||
151 | <row condition="hidden"> | ||
152 | <entry align="left">Supported Drivers</entry> | ||
153 | |||
154 | <entry>Ethernet, RTC, UART</entry> | ||
155 | </row> | ||
156 | </tbody> | ||
157 | </tgroup> | ||
158 | </table> | ||
159 | |||
160 | <table condition="arm"> | ||
161 | <title>MACHINE Information</title> | ||
162 | |||
163 | <tgroup cols="2"> | ||
164 | <colspec align="center" /> | ||
165 | |||
166 | <thead> | ||
167 | <row> | ||
168 | <entry align="center">Component</entry> | ||
169 | |||
170 | <entry align="center">Description</entry> | ||
171 | </row> | ||
172 | </thead> | ||
173 | |||
174 | <tbody> | ||
175 | <row> | ||
176 | <entry align="left">Target official name</entry> | ||
177 | |||
178 | <entry>OCTEON TX™ cn8304</entry> | ||
179 | </row> | ||
180 | |||
181 | <row> | ||
182 | <entry align="left">Architecture and Description</entry> | ||
183 | |||
184 | <entry>arm64</entry> | ||
185 | </row> | ||
186 | |||
187 | <row> | ||
188 | <entry align="left">Link to target datasheet</entry> | ||
189 | |||
190 | <entry><ulink | ||
191 | url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON | ||
192 | TX™ cn8304 datasheet</ulink></entry> | ||
193 | </row> | ||
194 | |||
195 | <row> | ||
196 | <entry align="left">Poky version</entry> | ||
197 | |||
198 | <entry>Git-commit-id: | ||
199 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | ||
200 | </row> | ||
201 | |||
202 | <row> | ||
203 | <entry align="left">GCC version</entry> | ||
204 | |||
205 | <entry>5.3<remark>FIXME</remark></entry> | ||
206 | </row> | ||
207 | |||
208 | <row> | ||
209 | <entry align="left">Linux Kernel Version</entry> | ||
210 | |||
211 | <entry>3.12<remark>FIXME</remark></entry> | ||
212 | </row> | ||
213 | |||
214 | <row condition="hidden"> | ||
215 | <entry align="left">Supported Drivers</entry> | ||
216 | |||
217 | <entry>Ethernet, RTC, UART</entry> | ||
218 | </row> | ||
219 | </tbody> | ||
220 | </tgroup> | ||
221 | </table> | ||
222 | </section> | ||
223 | </section> \ No newline at end of file | ||
diff --git a/book-enea-nfv-core-release-info/doc/eltf_params_updated_template_how_to_use.txt b/book-enea-nfv-core-release-info/doc/eltf_params_updated_template_how_to_use.txt new file mode 100755 index 0000000..62e5d02 --- /dev/null +++ b/book-enea-nfv-core-release-info/doc/eltf_params_updated_template_how_to_use.txt | |||
@@ -0,0 +1,320 @@ | |||
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/docsrc_common/pardoc-distro.xml b/docsrc_common/pardoc-distro.xml index a09e3ef..11d473f 100644 --- a/docsrc_common/pardoc-distro.xml +++ b/docsrc_common/pardoc-distro.xml | |||
@@ -1,18 +1,25 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE book 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 | |||
5 | <!-- Declarations to inherit by xi:include | 4 | <!-- Declarations to inherit by xi:include |
6 | ========================================== --> | 5 | ========================================== --> |
7 | <section id="pardoc_names"> | 6 | <section id="pardoc_names"> |
8 | <title>Enea NFV Core DocBook XML Based UserDoc Names and Parameters</title> | 7 | <title>Enea NFV Core DocBook XML Based UserDoc Names and Parameters</title> |
9 | <para>NOTE: DO NOT EDIT THIS FILE IN XMLMIND only open it to see any errors, but don't save!</para> | 8 | |
10 | <para>Note: Use 'xi:include' to include parameters into a docbook XML file. | 9 | <para>NOTE: DO NOT EDIT THIS FILE IN XMLMIND only open it to see any errors, |
11 | Note: Only full elements can be included and the included element must be allowed in that place. | 10 | but don't save!</para> |
12 | Example: For ulink, entire ulink elements must be included, not just parts of them.</para> | 11 | |
13 | <para>**** The phrase elements below can be used as variables in several places in XML files ****</para> | 12 | <para>Note: Use 'xi:include' to include parameters into a docbook XML file. |
13 | Note: Only full elements can be included and the included element must be | ||
14 | allowed in that place. Example: For ulink, entire ulink elements must be | ||
15 | included, not just parts of them.</para> | ||
16 | |||
17 | <para>**** The phrase elements below can be used as variables in several | ||
18 | places in XML files ****</para> | ||
19 | |||
20 | <!-- Distribution and release --> | ||
21 | |||
22 | <para id="EneaNFV_REL_VER"><phrase>1.1</phrase></para> | ||
14 | 23 | ||
15 | <!-- Distribution and release --> | 24 | <para id="ULINK_ENEA_NFV_URL"><ulink url="FIXTHIS">FIXTHIS</ulink></para> |
16 | <para id="EneaNFV_REL_VER"><phrase>1.0.1</phrase></para> | 25 | </section> \ No newline at end of file |
17 | <para id="ULINK_ENEA_NFV_URL"><ulink url='FIXTHIS'>FIXTHIS</ulink></para> | ||
18 | </section> | ||