diff options
3 files changed, 25 insertions, 58 deletions
diff --git a/doc/book-enea-nfv-access-guide-intel/doc/getting_started.xml b/doc/book-enea-nfv-access-guide-intel/doc/getting_started.xml index 3e7abeb..7000d5c 100644 --- a/doc/book-enea-nfv-access-guide-intel/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-guide-intel/doc/getting_started.xml | |||
@@ -5,11 +5,7 @@ | |||
5 | <title>Getting Started with Enea NFV Access</title> | 5 | <title>Getting Started with Enea NFV Access</title> |
6 | 6 | ||
7 | <para>Using Enea NFV Access requires access to a Linux machine, which is | 7 | <para>Using Enea NFV Access requires access to a Linux machine, which is |
8 | used for preparing a bootable drive or for developing applications. System | 8 | used for preparing a bootable drive or for developing applications.</para> |
9 | requirements for the development host are detailed in the <xi:include | ||
10 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
11 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
12 | xpointer="element(book_enea_nfv_access_release_info/1)" />.</para> | ||
13 | 9 | ||
14 | <section id="sysshell_config"> | 10 | <section id="sysshell_config"> |
15 | <title>Default Shell Configuration</title> | 11 | <title>Default Shell Configuration</title> |
@@ -210,7 +206,7 @@ rootfs_destination=</programlisting></para> | |||
210 | <orderedlist> | 206 | <orderedlist> |
211 | <listitem> | 207 | <listitem> |
212 | <para>Download the HDDIMG file from the download portal onto a Linux | 208 | <para>Download the HDDIMG file from the download portal onto a Linux |
213 | machine or Cyqwin.</para> | 209 | machine or Cygwin.</para> |
214 | </listitem> | 210 | </listitem> |
215 | 211 | ||
216 | <listitem> | 212 | <listitem> |
@@ -328,7 +324,7 @@ sdb 8:0 0 111.8G 0 disk | |||
328 | 324 | ||
329 | <note> | 325 | <note> |
330 | <para>This option is <emphasis role="bold">only</emphasis> | 326 | <para>This option is <emphasis role="bold">only</emphasis> |
331 | recommended for advanced development and should otherwise not | 327 | recommended for advanced use and should otherwise not |
332 | be used.</para> | 328 | be used.</para> |
333 | </note> | 329 | </note> |
334 | </listitem> | 330 | </listitem> |
diff --git a/doc/book-enea-nfv-access-guide-intel/doc/overview.xml b/doc/book-enea-nfv-access-guide-intel/doc/overview.xml index b6f1359..7cfc5ac 100644 --- a/doc/book-enea-nfv-access-guide-intel/doc/overview.xml +++ b/doc/book-enea-nfv-access-guide-intel/doc/overview.xml | |||
@@ -144,7 +144,7 @@ | |||
144 | </listitem> | 144 | </listitem> |
145 | 145 | ||
146 | <listitem> | 146 | <listitem> |
147 | <para>Data plan - High performance data plane that includes the DPDK | 147 | <para>Data plane - High performance data plane that includes the DPDK |
148 | optimized data plane driver.</para> | 148 | optimized data plane driver.</para> |
149 | </listitem> | 149 | </listitem> |
150 | </itemizedlist> | 150 | </itemizedlist> |
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 dc5f519..90d2dcc 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 | |||
@@ -8,7 +8,7 @@ | |||
8 | href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" | 8 | href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" |
9 | xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the | 9 | xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the |
10 | FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, | 10 | FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, |
11 | USB-stick based installation options, and various other optimizations, | 11 | USB-stick based installation, and various other optimizations, |
12 | security patches and documentation updated accordingly.</para> | 12 | security patches and documentation updated accordingly.</para> |
13 | 13 | ||
14 | <para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis> | 14 | <para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis> |
@@ -24,55 +24,28 @@ | |||
24 | <section id="release-content"> | 24 | <section id="release-content"> |
25 | <title>Enea NFV Access Release Content</title> | 25 | <title>Enea NFV Access Release Content</title> |
26 | 26 | ||
27 | <para>The current release contains documentation, prebuilt kernels and | 27 | <para>The release directory structure is detailed below:</para> |
28 | images, a bootloader, an SDK and an eSDK. The directory structure is | ||
29 | detailed below:</para> | ||
30 | 28 | ||
31 | <programlisting condition="intel">-- documentation/ | 29 | <programlisting condition="intel">-- Documentation/ |
32 | /* Enea NFV Access documentation */ | 30 | /* Enea NFV Access documentation */ |
33 | -- x86-64 /* architecture */ | 31 | -- x86-64 /* architecture */ |
34 | -- xeon-d/ | 32 | -- xeon-d/ |
35 | /* artifacts for the host side */ | ||
36 | -- images/ | 33 | -- images/ |
37 | -- enea-nfv-access | 34 | -- enea-nfv-access |
38 | /* precompiled artifacts for the platform release image */ | 35 | /* HDD image for bootable USB stick installer */ |
39 | -- various artifacts (rootfs, kernel, config etc.) | 36 | -- enea-nfv-access-xeon-d.hddimg |
40 | -- enea-nfv-access-edgelink-netconf | 37 | -- atom-c3000/ |
41 | /* precompiled artifacts for the platform release image */ | ||
42 | -- various artifacts (rootfs, kernel, config etc.) | ||
43 | -- atom-c3000/ | ||
44 | /* artifacts for the host side */ | ||
45 | -- images/ | 38 | -- images/ |
46 | -- enea-nfv-access | 39 | -- enea-nfv-access |
47 | /* precompiled artifacts for the platform release image */ | 40 | /* HDD image for bootable USB stick installer */ |
48 | -- various artifacts (rootfs, kernel, config etc.) | 41 | -- enea-nfv-access-atom-c3000.hddimg |
49 | -- enea-nfv-access-edgelink-netconf | 42 | -- install |
50 | /* precompiled artifacts for the platform release image */ | ||
51 | -- various artifacts (rootfs, kernel, config etc.) | ||
52 | |||
53 | -- qemux86-64 | ||
54 | /* artifacts for the guest side */ | ||
55 | -- images/ | ||
56 | -- enea-nfv-access-vnf | ||
57 | /* precompiled artifacts for the vnf release image */ | ||
58 | -- various artifacts (rootfs, kernel, config etc.) | ||
59 | -- install | ||
60 | -- sdk | 43 | -- sdk |
61 | /* SDK related artifacts including SDK installer and manifests */ | 44 | /* SDK installer */ |
62 | -- install-sdk.sh | 45 | -- install-sdk.sh |
63 | /* self-extracting archive installing cross-compilation | ||
64 | toolchain for the platform */ | ||
65 | -- esdk | 46 | -- esdk |
66 | /* Extensible SDK related artifacts including SDK installer and | 47 | /* Extensible SDK installer */ |
67 | manifests */ | 48 | -- install-esdk.sh</programlisting> |
68 | -- install-esdk.sh | ||
69 | /* self-extracting archive installing cross-compilation | ||
70 | toolchain for the platform */ | ||
71 | -- nfv-installer | ||
72 | /* Various tools assisting in booting Enea NFV Access */ | ||
73 | -- script-installer | ||
74 | /* installer tool intended for creating a bootable Enea | ||
75 | NFV Access installation on a physical media */</programlisting> | ||
76 | 49 | ||
77 | <programlisting condition="arm">-- documentation/ | 50 | <programlisting condition="arm">-- documentation/ |
78 | /* Enea NFV Access documentation */ | 51 | /* Enea NFV Access documentation */ |
@@ -123,22 +96,20 @@ | |||
123 | -- docker-pxe-ramboot | 96 | -- docker-pxe-ramboot |
124 | /* tools and files used in buidling a boot setup */</programlisting> | 97 | /* tools and files used in buidling a boot setup */</programlisting> |
125 | 98 | ||
126 | <para>For each combination of image and target, the following set of | 99 | <para condition="hidden">For each combination of image and target, the following set of |
127 | artifacts is available:</para> | 100 | artifacts is available:</para> |
128 | 101 | ||
129 | <programlisting condition="intel">-- bzImage | 102 | <programlisting condition="hidden">-- bzImage |
130 | /* kernel image */ | 103 | /* kernel image */ |
131 | -- bzImage-target.bin | 104 | -- bzImage-<target>.bin |
132 | /* kernel image, same as above */ | 105 | /* kernel image, same as above */ |
133 | -- config-target.config | 106 | -- config-<target>.config |
134 | /* kernel configuration file */ | 107 | /* kernel configuration file */ |
135 | -- image-name-target.ext4.gz | 108 | -- enea-nfv-access-<target>.hddimg |
109 | /* HDD image for bootable USB stick installer */ | ||
110 | -- enea-nfv-access-<target>.ext4.gz | ||
136 | /* compressed EXT4 image of the rootfs */ | 111 | /* compressed EXT4 image of the rootfs */ |
137 | -- image-name-target.qcow2 | 112 | -- enea-nfv-access-<target>.tar.gz |
138 | /* QCOW image for QEMU - only for guest images */ | ||
139 | -- image-name-target.qemuboot.conf | ||
140 | /* qemu config file for the guest images */ | ||
141 | -- image-name-target.tar.gz | ||
142 | /* tar archive of the image */ | 113 | /* tar archive of the image */ |
143 | -- modules-<target>.tgz | 114 | -- modules-<target>.tgz |
144 | /* external kernel modules */ | 115 | /* external kernel modules */ |