diff options
7 files changed, 304 insertions, 117 deletions
diff --git a/doc/book-enea-nfv-access-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-guide/doc/getting_started.xml index 8028d78..1682dac 100644 --- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml | |||
| @@ -198,9 +198,67 @@ runs</programlisting></para> | |||
| 198 | connect it to the target machine and configure the target machine to use | 198 | connect it to the target machine and configure the target machine to use |
| 199 | it as a primary boot device.</para> | 199 | it as a primary boot device.</para> |
| 200 | </section> | 200 | </section> |
| 201 | |||
| 202 | <section id="troubleshooting"> | ||
| 203 | <title>Troubleshooting</title> | ||
| 204 | |||
| 205 | <para>GRUB might display the following: <literal>error: no such | ||
| 206 | partition</literal> or <filename>error: disk not found</filename>, if | ||
| 207 | the default GRUB config is set to use <filename>hd0</filename> as the | ||
| 208 | primary drive for booting. Due to this, the errors described above have | ||
| 209 | two possible causes:</para> | ||
| 210 | |||
| 211 | <itemizedlist> | ||
| 212 | <listitem> | ||
| 213 | <para>The drive where NFV Access was installed is not identified as | ||
| 214 | <literal>hd0</literal> by the BIOS.</para> | ||
| 215 | </listitem> | ||
| 216 | |||
| 217 | <listitem> | ||
| 218 | <para>The BIOS has assigned the <literal>hd0</literal> label to a | ||
| 219 | different drive (e.g. a USB stick) than the one where NFV Access was | ||
| 220 | installed.</para> | ||
| 221 | </listitem> | ||
| 222 | </itemizedlist> | ||
| 223 | |||
| 224 | <para>The solution for these errors is detailed below:</para> | ||
| 225 | |||
| 226 | <orderedlist> | ||
| 227 | <listitem> | ||
| 228 | <para>In the GRUB selection screen press | ||
| 229 | <command><literal>c</literal></command> to enter the command | ||
| 230 | line.</para> | ||
| 231 | </listitem> | ||
| 232 | |||
| 233 | <listitem> | ||
| 234 | <para>Run <command>ls</command> to list all of the available | ||
| 235 | partitions</para> | ||
| 236 | </listitem> | ||
| 237 | |||
| 238 | <listitem> | ||
| 239 | <para>For each available partition run <command>ls | ||
| 240 | PARTITION</command> in order to identify where NFV Access was | ||
| 241 | installed.</para> | ||
| 242 | </listitem> | ||
| 243 | |||
| 244 | <listitem> | ||
| 245 | <para>After identifying the partition, press <command>ESC</command> | ||
| 246 | to return to the GRUB selection screen and press | ||
| 247 | <command>e</command> to edit the boot command.</para> | ||
| 248 | </listitem> | ||
| 249 | |||
| 250 | <listitem> | ||
| 251 | <para>Set the boot partition to the one identified in step 3</para> | ||
| 252 | </listitem> | ||
| 253 | |||
| 254 | <listitem> | ||
| 255 | <para>Press <literal>F10</literal> to boot</para> | ||
| 256 | </listitem> | ||
| 257 | </orderedlist> | ||
| 258 | </section> | ||
| 201 | </section> | 259 | </section> |
| 202 | 260 | ||
| 203 | <section id="release-content"> | 261 | <section condition="hidden" id="release-content"> |
| 204 | <title>NFV Access Release content</title> | 262 | <title>NFV Access Release content</title> |
| 205 | 263 | ||
| 206 | <para>The NFV Access 1.1 Release contains along with other items, | 264 | <para>The NFV Access 1.1 Release contains along with other items, |
| @@ -285,7 +343,7 @@ runs</programlisting></para> | |||
| 285 | /* GRUB EFI file */</programlisting> | 343 | /* GRUB EFI file */</programlisting> |
| 286 | </section> | 344 | </section> |
| 287 | 345 | ||
| 288 | <section id="prebuilt-artifacts"> | 346 | <section condition="hidden" id="prebuilt-artifacts"> |
| 289 | <title>How to use the Prebuilt Artifacts</title> | 347 | <title>How to use the Prebuilt Artifacts</title> |
| 290 | 348 | ||
| 291 | <section id="boot-ramdisk"> | 349 | <section id="boot-ramdisk"> |
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 c16be2f..b76f3ff 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 | |||
| @@ -6,9 +6,8 @@ | |||
| 6 | 6 | ||
| 7 | <para>Enea NFV Access <xi:include href="eltf_params_updated.xml" | 7 | <para>Enea NFV Access <xi:include href="eltf_params_updated.xml" |
| 8 | xmlns:xi="http://www.w3.org/2001/XInclude" | 8 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 9 | xpointer="element(EneaLinux_REL_VER/1)" /> adds support for Element ODM | 9 | xpointer="element(EneaLinux_REL_VER/1)" /> is a maintenance update to Enea |
| 10 | integration, improves perfomrance and provides a better onboarding | 10 | NFV Access 1.0 with the major changes listed below:<remark>INFO <emphasis |
| 11 | experience.<remark>INFO <emphasis | ||
| 12 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in | 11 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in |
| 13 | the book, also in the open source books, and MUST be created FROM <emphasis | 12 | the book, also in the open source books, and MUST be created FROM <emphasis |
| 14 | role="bold">eltf_params_template.xml</emphasis>. The parameters are | 13 | role="bold">eltf_params_template.xml</emphasis>. The parameters are |
| @@ -18,15 +17,99 @@ | |||
| 18 | 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 |
| 19 | will auto-create/update it.</remark></para> | 18 | will auto-create/update it.</remark></para> |
| 20 | 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 | |||
| 21 | <section id="release-content"> | 104 | <section id="release-content"> |
| 22 | <title>NFV Access Release content</title> | 105 | <title>Enea NFV Access Release Content</title> |
| 23 | 106 | ||
| 24 | <para>The current release contains along with other items, documentation, | 107 | <para>The current release contains along with other items, documentation, |
| 25 | pre-built kernels and images, a bootloader and a SDK. The directories | 108 | pre-built kernels and images, a bootloader and a SDK. The directories |
| 26 | structure is detailed below:</para> | 109 | structure is detailed below:</para> |
| 27 | 110 | ||
| 28 | <programlisting>-- documentation/ | 111 | <programlisting>-- documentation/ |
| 29 | /* NFV Access documentation */ | 112 | /* Enea NFV Access documentation */ |
| 30 | -- x86-64 /* architecture */ | 113 | -- x86-64 /* architecture */ |
| 31 | -- inteld1521/ | 114 | -- inteld1521/ |
| 32 | /* artifacts for the host side */ | 115 | /* artifacts for the host side */ |
| @@ -37,7 +120,7 @@ | |||
| 37 | /* precompiled artifacts for the platform release image */ | 120 | /* precompiled artifacts for the platform release image */ |
| 38 | -- various artifacts (rootfs, kernel, config etc.) | 121 | -- various artifacts (rootfs, kernel, config etc.) |
| 39 | -- enea-nfv-access-dev | 122 | -- enea-nfv-access-dev |
| 40 | /* precompiled artifacts for development process. The image | 123 | /* precompiled artifacts for the development process. The image |
| 41 | contains userspace tools and kernel configurations necessary | 124 | contains userspace tools and kernel configurations necessary |
| 42 | for developing, debugging and profiling applications and | 125 | for developing, debugging and profiling applications and |
| 43 | kernel modules */ | 126 | kernel modules */ |
| @@ -48,35 +131,42 @@ | |||
| 48 | /* deb packages */ | 131 | /* deb packages */ |
| 49 | -- images/ | 132 | -- images/ |
| 50 | -- enea-nfv-access-guest | 133 | -- enea-nfv-access-guest |
| 51 | /* precompiled artifacts for QEMU/Docker release image */ | 134 | /* precompiled artifacts for the QEMU/Docker release image */ |
| 52 | -- various artifacts | 135 | -- various artifacts |
| 53 | -- enea-nfv-access-guest-dev | 136 | -- enea-nfv-access-guest-dev |
| 54 | /* precompiled artifacts for development process. The image | 137 | /* precompiled artifacts for the development process. The image |
| 55 | contains userspace tools and kernel configurations necessary | 138 | contains userspace tools and kernel configurations necessary |
| 56 | for developing, debugging and profiling applications and | 139 | for developing, debugging and profiling applications and |
| 57 | kernel modules */ | 140 | kernel modules */ |
| 58 | -- various artifacts | 141 | -- various artifacts |
| 59 | -- install | 142 | -- install |
| 60 | -- install-sdk.sh | 143 | -- sdk |
| 61 | /* self-extracting archive installing cross-compilation | 144 | /* SDK related artifacts including SDK installer and manifests */ |
| 62 | toolchain for the platform */</programlisting> | 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> | ||
| 63 | 153 | ||
| 64 | <para>For each combination of image and target, the following set of | 154 | <para>For each combination of image and target, the following set of |
| 65 | artifacts is available:</para> | 155 | artifacts is available:</para> |
| 66 | 156 | ||
| 67 | <programlisting>-- bzImage | 157 | <programlisting>-- bzImage |
| 68 | /* kernel image */ | 158 | /* kernel image */ |
| 69 | -- bzImage-<target>.bin | 159 | -- bzImage-target.bin |
| 70 | /* kernel image, same as above */ | 160 | /* kernel image, same as above */ |
| 71 | -- config-<target>.config | 161 | -- config-target.config |
| 72 | /* kernel configuration file */ | 162 | /* kernel configuration file */ |
| 73 | -- <image-name>-<target>.ext4.gz | 163 | -- image-name-target.ext4.gz |
| 74 | /* compressed EXT4 image of the rootfs */ | 164 | /* compressed EXT4 image of the rootfs */ |
| 75 | -- <image-name>-<target>.qcow2 | 165 | -- image-name-target.qcow2 |
| 76 | /* QCOW image for QEMU - only for guest images */ | 166 | /* QCOW image for QEMU - only for guest images */ |
| 77 | -- <image-name>-<target>.qemuboot.conf | 167 | -- image-name-target.qemuboot.conf |
| 78 | /* qemu config file for the guest images */ | 168 | /* qemu config file for the guest images */ |
| 79 | -- <image-name>-<target>.tar.gz | 169 | -- image-name-target.tar.gz |
| 80 | /* tar archive of the image */ | 170 | /* tar archive of the image */ |
| 81 | -- modules-<target>.tgz | 171 | -- modules-<target>.tgz |
| 82 | /* external kernel modules */ | 172 | /* external kernel modules */ |
| @@ -91,21 +181,15 @@ | |||
| 91 | for Enea NFV Access 1.1: <emphasis role="bold">Ubuntu 16.04 LTS, | 181 | for Enea NFV Access 1.1: <emphasis role="bold">Ubuntu 16.04 LTS, |
| 92 | 64bit</emphasis>.</para> | 182 | 64bit</emphasis>.</para> |
| 93 | 183 | ||
| 94 | <para> | 184 | <para><remark>Hardcoded now in this XML file. Might be moved to the |
| 95 | <remark>Hardcoded now in this XML file. Might be moved to the parameter | 185 | parameter file later.</remark> <remark>INFO Below is a complete section |
| 96 | file later.</remark> | 186 | with ID "eltf-target-tables-section" included from |
| 97 | 187 | elft_params_updated.xml. It contains a variable number of target tables | |
| 98 | <remark>INFO Below is a complete section with ID | 188 | and the section title should be "Supported Targets with Parameters". It |
| 99 | "eltf-target-tables-section" included from elft_params_updated.xml. It | 189 | has have a short sentence about what it is in the beginning. The subtitles |
| 100 | contains a variable number of target tables and the section title should | 190 | shall have the directory name of the target in the manifest.</remark>For |
| 101 | be "Supported Targets with Parameters". It has have a short sentence | 191 | more details on host requirements and how to configure the host |
| 102 | about what it is in the beginning. The subtitles shall have the | 192 | environment, please see <xref linkend="sys-req-prerequisites" />.</para> |
| 103 | directory name of the target in the manifest.</remark> | ||
| 104 | </para> | ||
| 105 | |||
| 106 | <para>For more details on system requirements and how to configure the | ||
| 107 | host environment, please see <xref | ||
| 108 | linkend="sys-req-prerequisites" />.</para> | ||
| 109 | </section> | 193 | </section> |
| 110 | 194 | ||
| 111 | <xi:include href="eltf_params_updated.xml" | 195 | <xi:include href="eltf_params_updated.xml" |
| @@ -116,14 +200,13 @@ | |||
| 116 | <title>Provided Toolchain(s) (SDK)</title> | 200 | <title>Provided Toolchain(s) (SDK)</title> |
| 117 | 201 | ||
| 118 | <para>The provided SDK contains toolchains supporting cross-compilation of | 202 | <para>The provided SDK contains toolchains supporting cross-compilation of |
| 119 | applications for both the host and the guest targets on an x86_64 | 203 | applications for both the host and the guest targets on an x86-64 |
| 120 | machine.</para> | 204 | machine.</para> |
| 121 | 205 | ||
| 122 | <para> | 206 | <para><remark>(Possibly add this in later) See the <trademark |
| 123 | <remark>(Possibly add this in later) See the <trademark | 207 | class="registered">Enea</trademark> NFV Access Application Development |
| 124 | class="registered">Enea</trademark> NFV Access Application Development | 208 | Guide for information on how to build and install a |
| 125 | Guide for information on how to build and install a toolchain.</remark> | 209 | toolchain.</remark></para> |
| 126 | </para> | ||
| 127 | </section> | 210 | </section> |
| 128 | 211 | ||
| 129 | <section id="relinfo-documentation"> | 212 | <section id="relinfo-documentation"> |
| @@ -150,7 +233,7 @@ | |||
| 150 | </listitem> | 233 | </listitem> |
| 151 | 234 | ||
| 152 | <listitem> | 235 | <listitem> |
| 153 | <para>Enea NFV Access Developer's Open Source Report - A document | 236 | <para>Enea NFV Access Development Open Source Report - A document |
| 154 | containing open source and license information pertaining to packages | 237 | containing open source and license information pertaining to packages |
| 155 | provided with Enea NFV Access for application developers.</para> | 238 | provided with Enea NFV Access for application developers.</para> |
| 156 | </listitem> | 239 | </listitem> |
| @@ -162,13 +245,13 @@ | |||
| 162 | </listitem> | 245 | </listitem> |
| 163 | 246 | ||
| 164 | <listitem> | 247 | <listitem> |
| 165 | <para>Enea NFV Access Guest Developer's Open Source Report - A | 248 | <para>Enea NFV Access Guest Development Open Source Report - A |
| 166 | document detailing the open source and license information of packages | 249 | document detailing the open source and license information of packages |
| 167 | provided with Enea NFV Access for application developers on a guest | 250 | provided with Enea NFV Access for applications development on a guest |
| 168 | target.</para> | 251 | target.</para> |
| 169 | </listitem> | 252 | </listitem> |
| 170 | 253 | ||
| 171 | <listitem> | 254 | <listitem condition="hidden"> |
| 172 | <para>Enea NFV Access Test Report - The document that summarizes the | 255 | <para>Enea NFV Access Test Report - The document that summarizes the |
| 173 | test results for the Enea NFV Access release.</para> | 256 | test results for the Enea NFV Access release.</para> |
| 174 | </listitem> | 257 | </listitem> |
| @@ -180,6 +263,10 @@ | |||
| 180 | </itemizedlist> | 263 | </itemizedlist> |
| 181 | </section> | 264 | </section> |
| 182 | 265 | ||
| 183 | <xi:include href="../../s_doceneacommon/doc/security_fixes.xml" | 266 | <section id="security_fixes"> |
| 184 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 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> | ||
| 185 | </chapter> \ No newline at end of file | 272 | </chapter> \ No newline at end of file |
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 bc2acb3..e6d3929 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 | |||
| @@ -113,7 +113,7 @@ repo sync</programlisting></para> | |||
| 113 | <row> | 113 | <row> |
| 114 | <entry>Architecture and Description</entry> | 114 | <entry>Architecture and Description</entry> |
| 115 | 115 | ||
| 116 | <entry>x86-64b</entry> | 116 | <entry>x86-64</entry> |
| 117 | </row> | 117 | </row> |
| 118 | 118 | ||
| 119 | <row> | 119 | <row> |
| @@ -134,16 +134,16 @@ repo sync</programlisting></para> | |||
| 134 | <row> | 134 | <row> |
| 135 | <entry>GCC version</entry> | 135 | <entry>GCC version</entry> |
| 136 | 136 | ||
| 137 | <entry>5.3</entry> | 137 | <entry>5.3<remark>FIXME</remark></entry> |
| 138 | </row> | 138 | </row> |
| 139 | 139 | ||
| 140 | <row> | 140 | <row> |
| 141 | <entry>Linux Kernel Version</entry> | 141 | <entry>Linux Kernel Version</entry> |
| 142 | 142 | ||
| 143 | <entry>3.12</entry> | 143 | <entry>3.12<remark>FIXME</remark></entry> |
| 144 | </row> | 144 | </row> |
| 145 | 145 | ||
| 146 | <row> | 146 | <row condition="hidden"> |
| 147 | <entry>Supported Drivers</entry> | 147 | <entry>Supported Drivers</entry> |
| 148 | 148 | ||
| 149 | <entry>Ethernet, RTC, UART</entry> | 149 | <entry>Ethernet, RTC, UART</entry> |
diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml index d75390a..2bf9c22 100644 --- a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml +++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml | |||
| @@ -4,24 +4,24 @@ | |||
| 4 | <chapter id="relinfo-getting-enea-nfv-access"> | 4 | <chapter id="relinfo-getting-enea-nfv-access"> |
| 5 | <title>Getting Enea NFV Access</title> | 5 | <title>Getting Enea NFV Access</title> |
| 6 | 6 | ||
| 7 | <para>Enea NFV Access releases are available as pre-built binaries ready for | 7 | <para>Enea NFV Access releases are available as binaries ready for download |
| 8 | download on the <ulink | 8 | on the <ulink |
| 9 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea | 9 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea |
| 10 | Download Portal</ulink>. Log in using the credentials provided by | 10 | Download Portal</ulink>. Updates of Enea NFV Access are also available for |
| 11 | Enea.</para> | 11 | download through the portal.</para> |
| 12 | 12 | ||
| 13 | <para>Using the menu at the top, browse to the <literal>NFV | 13 | <para>Log in using the credentials provided by Enea. Using the menu at the |
| 14 | </literal>section, which will provide access to a <literal>Files</literal> | 14 | top, browse to the <literal>NFV</literal> section, which will provide access |
| 15 | section and an <literal>Online Documentation</literal> section. The | 15 | to a <literal>Files</literal> section and an <literal>Online |
| 16 | <literal>Files</literal> section lists each Enea NFV Access release version | 16 | Documentation</literal> section. The <literal>Files</literal> section lists |
| 17 | as a separate download package. Clicking on any of the release packages will | 17 | each Enea NFV Access release version as a separate download package. |
| 18 | provide further details such as the date when it was made available, the | 18 | Clicking on any of the release packages will provide further details such as |
| 19 | file size and the changelog. Most importantly, it provides access to the | 19 | the date when it was made available, the file size and the changelog. Most |
| 20 | download links.</para> | 20 | importantly, it provides access to the download links.</para> |
| 21 | 21 | ||
| 22 | <para>Each archive is mirrored in several places, geographically. Choose the | 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 | 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 section <xref | 24 | about the contents of the release package, please refer to <xref |
| 25 | linkend="release-content" />.</para> | 25 | linkend="release-content" />.</para> |
| 26 | 26 | ||
| 27 | <para>The <literal>Online documentation</literal> section provides quick | 27 | <para>The <literal>Online documentation</literal> section provides quick |
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index c4f42ac..8c7d9e5 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml | |||
| @@ -4,19 +4,30 @@ | |||
| 4 | <chapter id="bugs-limitations"> | 4 | <chapter id="bugs-limitations"> |
| 5 | <title>Known Problems in This Release</title> | 5 | <title>Known Problems in This Release</title> |
| 6 | 6 | ||
| 7 | <para>The open source projects are continuously working on correcting | 7 | <para>All known issues listed in this chapter will be addressed in |
| 8 | reported problems. Corrections to bugs detected by Enea are submitted | 8 | maintenance updates following the major release.<remark>INFO: The <emphasis |
| 9 | upstream, and the corrections are included in Enea NFV Access regardless of | 9 | role="bold">Release-Specific Problems</emphasis> section further down is |
| 10 | when they will be included by the open source project. Remaining issues are | 10 | generated from JIRA with gen_known_issues.py, but that script is HARDCODED |
| 11 | listed below.<remark>INFO: The <emphasis role="bold">Release-Specific | 11 | with affectedversion "EL7_3-virtualization" and needs to be adapted when a |
| 12 | Problems</emphasis> section further down is generated from JIRA with | 12 | release info for another ENFV Access version changes.</remark></para> |
| 13 | gen_known_issues.py, but that script is HARDCODED with affectedversion | ||
| 14 | "EL7_3-virtualization" and needs to be adapted when a release info for | ||
| 15 | another ENFV Access version changes.</remark></para> | ||
| 16 | 13 | ||
| 17 | <section id="release-specific-limitations"> | 14 | <section id="release-specific-limitations"> |
| 18 | <title>Release-Specific Limitations</title> | 15 | <title>Release-Specific Limitations</title> |
| 19 | 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 | |||
| 20 | <itemizedlist> | 31 | <itemizedlist> |
| 21 | <listitem> | 32 | <listitem> |
| 22 | <para><emphasis role="bold">PDF navigation</emphasis>: When using | 33 | <para><emphasis role="bold">PDF navigation</emphasis>: When using |
| @@ -32,6 +43,6 @@ | |||
| 32 | 43 | ||
| 33 | <!-- The file with a section below is autocreated by make init --> | 44 | <!-- The file with a section below is autocreated by make init --> |
| 34 | 45 | ||
| 35 | <xi:include href="jiraissues_generated.xml" | 46 | <!-- <xi:include href="jiraissues_generated.xml" |
| 36 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 47 | xmlns:xi="http://www.w3.org/2001/XInclude" /> --> |
| 37 | </chapter> \ No newline at end of file | 48 | </chapter> \ 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 e2f6c6f..a0cf1c5 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 | |||
| @@ -13,72 +13,102 @@ | |||
| 13 | 13 | ||
| 14 | <itemizedlist> | 14 | <itemizedlist> |
| 15 | <listitem> | 15 | <listitem> |
| 16 | <para>Updated DPDK to version 17.08 and OVS to version 2.8 for | 16 | <para>Key Component updates:</para> |
| 17 | improved perfomrance</para> | ||
| 18 | </listitem> | ||
| 19 | 17 | ||
| 20 | <listitem> | 18 | <itemizedlist> |
| 21 | <para>VCPE characteristics optimizations</para> | 19 | <listitem> |
| 22 | </listitem> | 20 | <para>DPDK 17.08</para> |
| 21 | </listitem> | ||
| 23 | 22 | ||
| 24 | <listitem> | 23 | <listitem> |
| 25 | <para>Added support for integrating Element ODM</para> | 24 | <para>OVS 2.8</para> |
| 25 | </listitem> | ||
| 26 | </itemizedlist> | ||
| 26 | </listitem> | 27 | </listitem> |
| 27 | 28 | ||
| 28 | <listitem> | 29 | <listitem> |
| 29 | <para>Added support for Edgelink Netconf (beta)</para> | 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> | ||
| 30 | </listitem> | 42 | </listitem> |
| 31 | 43 | ||
| 32 | <listitem> | 44 | <listitem> |
| 33 | <para>Included tools for easier installation</para> | 45 | <para>Extended Tools Feature Set:</para> |
| 34 | </listitem> | ||
| 35 | 46 | ||
| 36 | <listitem> | 47 | <itemizedlist> |
| 37 | <para>Enhanced tool-set on development image (python-pip, dosfstools, | 48 | <listitem> |
| 38 | htop, etc.)</para> | 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> | ||
| 39 | </listitem> | 60 | </listitem> |
| 40 | 61 | ||
| 41 | <listitem> | 62 | <listitem> |
| 42 | <para>Unified cross-development SDK for host and virtualized | 63 | <para>Unified cross-development SDK for host and virtualized |
| 43 | environments</para> | 64 | environments.</para> |
| 44 | </listitem> | 65 | </listitem> |
| 45 | 66 | ||
| 46 | <listitem> | 67 | <listitem> |
| 47 | <para>Native toolchain support in the development image</para> | 68 | <para>Native toolchain support on development image.</para> |
| 48 | </listitem> | 69 | </listitem> |
| 49 | 70 | ||
| 50 | <listitem> | 71 | <listitem> |
| 51 | <para>Removed OFP</para> | 72 | <para>USB-stick based installation</para> |
| 52 | </listitem> | 73 | </listitem> |
| 53 | 74 | ||
| 54 | <listitem> | 75 | <listitem> |
| 55 | <para>Improved manuals and documentation</para> | 76 | <para>Product Maintenance:</para> |
| 56 | </listitem> | ||
| 57 | 77 | ||
| 58 | <listitem> | 78 | <itemizedlist> |
| 59 | <para>Improved evaluation experience</para> | 79 | <listitem> |
| 60 | </listitem> | 80 | <para>Optimizations</para> |
| 81 | </listitem> | ||
| 61 | 82 | ||
| 62 | <listitem> | 83 | <listitem> |
| 63 | <para>Various bug fixes</para> | 84 | <para>Security patches</para> |
| 64 | </listitem> | 85 | </listitem> |
| 65 | 86 | ||
| 66 | <listitem> | 87 | <listitem> |
| 67 | <para>Security updates</para> | 88 | <para>Bug fixes</para> |
| 89 | </listitem> | ||
| 90 | |||
| 91 | <listitem> | ||
| 92 | <para>Updated documentation</para> | ||
| 93 | </listitem> | ||
| 94 | </itemizedlist> | ||
| 68 | </listitem> | 95 | </listitem> |
| 69 | </itemizedlist> | 96 | </itemizedlist> |
| 70 | </section> | 97 | </section> |
| 71 | 98 | ||
| 72 | <section id="packages"> | 99 | <section id="open_source"> |
| 73 | <title>Provided Packages</title> | 100 | <title>Open Source</title> |
| 74 | 101 | ||
| 75 | <para>For more information on the packages provided, please refer to the | 102 | <para>For more information about the Open Source packages included, please |
| 76 | Enea NFV Access Open Source Reports provided with this release.</para> | 103 | refer to the Enea NFV Access Open Source Reports provided with this |
| 104 | release.</para> | ||
| 77 | </section> | 105 | </section> |
| 78 | 106 | ||
| 79 | <section id="relinfo-backward-compat"> | 107 | <section id="relinfo-backward-compat"> |
| 80 | <title>Compatibility</title> | 108 | <title>Compatibility</title> |
| 81 | 109 | ||
| 82 | <remark>FIXME, THIS NEEDS INFO OR ELSE SHOULD BE HIDDEN</remark> | 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> | ||
| 83 | </section> | 113 | </section> |
| 84 | </chapter> \ No newline at end of file | 114 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml index fb3f57f..44e70af 100644 --- a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml | |||
| @@ -2,12 +2,12 @@ | |||
| 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="sys-req-prerequisites"> | 4 | <chapter id="sys-req-prerequisites"> |
| 5 | <title>System Requirements and Prerequisites</title> | 5 | <title>Host Requirements</title> |
| 6 | 6 | ||
| 7 | <para>Using Enea NFV Access or compiling applications requires certain | 7 | <para>Using Enea NFV Access or compiling applications requires certain |
| 8 | packages to be installed on your NFV Access development host. The host | 8 | packages to be installed on your build host. The requirements listed below |
| 9 | requirements listed below are extensive to allow getting Enea NFV Access to | 9 | are extensive to allow getting Enea NFV Access to be booted on target |
| 10 | be booted on target machines and for building applications.</para> | 10 | machines and for building applications.</para> |
| 11 | 11 | ||
| 12 | <informaltable> | 12 | <informaltable> |
| 13 | <tgroup cols="2"> | 13 | <tgroup cols="2"> |
| @@ -21,7 +21,7 @@ | |||
| 21 | <row> | 21 | <row> |
| 22 | <entry spanname="onetwo"><emphasis role="bold"> Build Host | 22 | <entry spanname="onetwo"><emphasis role="bold"> Build Host |
| 23 | Requirements<indexterm> | 23 | Requirements<indexterm> |
| 24 | <primary>system requirements</primary> | 24 | <primary>host requirements</primary> |
| 25 | </indexterm></emphasis></entry> | 25 | </indexterm></emphasis></entry> |
| 26 | </row> | 26 | </row> |
| 27 | 27 | ||
| @@ -29,7 +29,7 @@ | |||
| 29 | <entry>Linux distribution</entry> | 29 | <entry>Linux distribution</entry> |
| 30 | 30 | ||
| 31 | <entry>The downloaded product can installed on the target machine | 31 | <entry>The downloaded product can installed on the target machine |
| 32 | using a Linux host. For information about the supported hosts and | 32 | using a Linux host. For information about supported hosts and |
| 33 | targets, see <xref | 33 | targets, see <xref |
| 34 | linkend="relinfo-supported-host-environment" />.</entry> | 34 | linkend="relinfo-supported-host-environment" />.</entry> |
| 35 | </row> | 35 | </row> |
| @@ -38,21 +38,22 @@ | |||
| 38 | <entry>Packages</entry> | 38 | <entry>Packages</entry> |
| 39 | 39 | ||
| 40 | <entry>Depending on the Linux distribution and version of the host, | 40 | <entry>Depending on the Linux distribution and version of the host, |
| 41 | some packages may be required. See details on what packages are | 41 | certain packages may be required. See details on what packages are |
| 42 | needed and how to install, in the following sections.</entry> | 42 | needed and how to install them in the following sections.</entry> |
| 43 | </row> | 43 | </row> |
| 44 | 44 | ||
| 45 | <row> | 45 | <row> |
| 46 | <entry>Disk space</entry> | 46 | <entry>Disk space</entry> |
| 47 | 47 | ||
| 48 | <entry>Your system should have at least 50 GB of free disk space for | 48 | <entry>Your build host should have at least 50 GB of free disk space |
| 49 | installing the SDK or cross-compiling applications.</entry> | 49 | for installing the SDK or cross-compiling applications.</entry> |
| 50 | </row> | 50 | </row> |
| 51 | 51 | ||
| 52 | <row> | 52 | <row> |
| 53 | <entry>Recommended RAM</entry> | 53 | <entry>Recommended RAM</entry> |
| 54 | 54 | ||
| 55 | <entry>Your system must have at least 4 GB available RAM.</entry> | 55 | <entry>Your build host must have at least 4 GB available |
| 56 | RAM.</entry> | ||
| 56 | </row> | 57 | </row> |
| 57 | </tbody> | 58 | </tbody> |
| 58 | </tgroup> | 59 | </tgroup> |
