diff options
author | Miruna Paun <Miruna.Paun@enea.com> | 2017-08-18 16:18:23 +0200 |
---|---|---|
committer | Miruna Paun <Miruna.Paun@enea.com> | 2017-08-18 16:18:23 +0200 |
commit | 448a81331b3fe72a026dc2cd4cfb8ace3dc6b0b8 (patch) | |
tree | 306bcf863ae005ce4314d06dd4b2f7695cee1f9d | |
parent | ae8a4bb3dfe9be55f341b97a578bf031cacb7aa7 (diff) | |
download | nfv-access-documentation-448a81331b3fe72a026dc2cd4cfb8ace3dc6b0b8.tar.gz |
Updating the content of the Enea NFV Access Release Info
USERDOCAP-229
Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
5 files changed, 45 insertions, 121 deletions
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 9ee8d14..9aa4866 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 | |||
@@ -22,9 +22,8 @@ | |||
22 | <title>NFV Access Release content</title> | 22 | <title>NFV Access Release content</title> |
23 | 23 | ||
24 | <para>The current release contains along with other items, documentation, | 24 | <para>The current release contains along with other items, documentation, |
25 | pre-built kernels and images, a bootloader and a SDK.</para> | 25 | pre-built kernels and images, a bootloader and a SDK. The directories |
26 | 26 | structure is detailed below:</para> | |
27 | <para>The directories structure is detailed below:</para> | ||
28 | 27 | ||
29 | <programlisting>-- documentation/ | 28 | <programlisting>-- documentation/ |
30 | /* NFV Access documentation */ | 29 | /* NFV Access documentation */ |
@@ -107,8 +106,11 @@ | |||
107 | <title>Supported Host Environment</title> | 106 | <title>Supported Host Environment</title> |
108 | 107 | ||
109 | <itemizedlist> | 108 | <itemizedlist> |
109 | <para>The following environments have been validated as host | ||
110 | environments for Enea NFV Access 1.0:</para> | ||
111 | |||
110 | <listitem> | 112 | <listitem> |
111 | <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file. | 113 | <para>Ubuntu 16.04 LTS, 64bit<remark>Hardcoded now in this XML file. |
112 | Might be moved to the parameter file later.</remark><remark>INFO Below | 114 | Might be moved to the parameter file later.</remark><remark>INFO Below |
113 | is a complete section with ID "eltf-target-tables-section" included | 115 | is a complete section with ID "eltf-target-tables-section" included |
114 | from elft_params_updated.xml. It contains a variable number of target | 116 | from elft_params_updated.xml. It contains a variable number of target |
@@ -118,6 +120,10 @@ | |||
118 | in the manifest.</remark></para> | 120 | in the manifest.</remark></para> |
119 | </listitem> | 121 | </listitem> |
120 | </itemizedlist> | 122 | </itemizedlist> |
123 | |||
124 | <para>For more details on system requirements and how to configure the | ||
125 | host environment, please see <xref | ||
126 | linkend="sys-req-prerequisites" />.</para> | ||
121 | </section> | 127 | </section> |
122 | 128 | ||
123 | <xi:include href="eltf_params_updated.xml" | 129 | <xi:include href="eltf_params_updated.xml" |
@@ -128,9 +134,10 @@ | |||
128 | <title>Provided Toolchain(s) (SDK)</title> | 134 | <title>Provided Toolchain(s) (SDK)</title> |
129 | 135 | ||
130 | <para>The SDK contains toolchains supporting cross-compilation of | 136 | <para>The SDK contains toolchains supporting cross-compilation of |
131 | applications for the targets on an x86_64 host. See the <trademark | 137 | applications for the targets on an x86_64b host. <remark>(Possibly add |
132 | class="registered">Enea</trademark> NFV Access Application Development | 138 | this in later) See the <trademark class="registered">Enea</trademark> NFV |
133 | Guide for information on how to build and install a toolchain.</para> | 139 | Access Application Development Guide for information on how to build and |
140 | install a toolchain.</remark></para> | ||
134 | </section> | 141 | </section> |
135 | 142 | ||
136 | <section id="relinfo-documentation"> | 143 | <section id="relinfo-documentation"> |
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 503eb7c..7be944e 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 | |||
@@ -22,7 +22,7 @@ | |||
22 | <bridgehead>A programlisting, ID | 22 | <bridgehead>A programlisting, ID |
23 | "eltf-prereq-apt-get-commands-host"</bridgehead> | 23 | "eltf-prereq-apt-get-commands-host"</bridgehead> |
24 | 24 | ||
25 | <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 14.04.5 LTS 64bit | 25 | <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 16.04 LTS 64bit |
26 | sudo apt-get -y update | 26 | sudo apt-get -y update |
27 | sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \ | 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 \ | 28 | texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ |
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 aedfd1b..ccbf8d3 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 | |||
@@ -10,6 +10,8 @@ | |||
10 | faster. Please refer to the sections below for details on how to get Enea | 10 | faster. Please refer to the sections below for details on how to get Enea |
11 | NFV Access as pre-built binary images or source code.</para> | 11 | NFV Access as pre-built binary images or source code.</para> |
12 | 12 | ||
13 | <remark>fix this para above to not sound so EL influenced</remark> | ||
14 | |||
13 | <section id="relinfo-getting-pre-built-images"> | 15 | <section id="relinfo-getting-pre-built-images"> |
14 | <title>Getting Pre-built Binaries</title> | 16 | <title>Getting Pre-built Binaries</title> |
15 | 17 | ||
@@ -22,6 +24,8 @@ | |||
22 | and the <emphasis role="bold">Online Documentation</emphasis> | 24 | and the <emphasis role="bold">Online Documentation</emphasis> |
23 | section.</para> | 25 | section.</para> |
24 | 26 | ||
27 | <remark>fix this para above to not sound so EL influenced</remark> | ||
28 | |||
25 | <para>The Files section lists each Enea NFV Access distribution, one for | 29 | <para>The Files section lists each Enea NFV Access distribution, one for |
26 | each version and profile, as a separate download package. Clicking on the | 30 | each version and profile, as a separate download package. Clicking on the |
27 | name of the distribution will open a new page, which presents further | 31 | name of the distribution will open a new page, which presents further |
@@ -56,14 +60,14 @@ | |||
56 | release:</para> | 60 | release:</para> |
57 | 61 | ||
58 | <itemizedlist> | 62 | <itemizedlist> |
59 | <listitem> | 63 | <listitem condition="hidden"> |
60 | <para><emphasis role="bold">Enea NFV Access Developer’s | 64 | <para><emphasis role="bold">Enea NFV Access Developer’s |
61 | Guide</emphasis> -intended for Enea NFV Access developers, who want to | 65 | Guide</emphasis> -intended for Enea NFV Access developers, who want to |
62 | configure and build customized NFV Access kernel images for embedded | 66 | configure and build customized NFV Access kernel images for embedded |
63 | system targets, using the Yocto configuration and build system.</para> | 67 | system targets, using the Yocto configuration and build system.</para> |
64 | </listitem> | 68 | </listitem> |
65 | 69 | ||
66 | <listitem> | 70 | <listitem condition="hidden"> |
67 | <para><emphasis role="bold">Enea NFV Access Application Developer's | 71 | <para><emphasis role="bold">Enea NFV Access Application Developer's |
68 | Guide</emphasis> - dedicated to Enea NFV Access application | 72 | Guide</emphasis> - dedicated to Enea NFV Access application |
69 | developers, who want to build and run applications.</para> | 73 | developers, who want to build and run applications.</para> |
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 3dd3e80..e3dff3b 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 | |||
@@ -4,10 +4,7 @@ | |||
4 | <chapter id="relinfo-changes"> | 4 | <chapter id="relinfo-changes"> |
5 | <title>Main Changes</title> | 5 | <title>Main Changes</title> |
6 | 6 | ||
7 | <para>N/A.</para> | 7 | <para>N/A. This is the first release of Enea NFV Access.</para> |
8 | |||
9 | <para>This is the first release of Enea NFV Access, Networking | ||
10 | profile.</para> | ||
11 | 8 | ||
12 | <section id="relinfo-changes-other"> | 9 | <section id="relinfo-changes-other"> |
13 | <title>New Features</title> | 10 | <title>New Features</title> |
@@ -17,15 +14,11 @@ | |||
17 | 14 | ||
18 | <itemizedlist spacing="compact"> | 15 | <itemizedlist spacing="compact"> |
19 | <listitem> | 16 | <listitem> |
20 | <para>New Yocto version (<xi:include href="eltf_params_updated.xml" | 17 | <para></para> |
21 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
22 | xpointer="element(Yocto_VER/1)" />). See <ulink | ||
23 | url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para> | ||
24 | </listitem> | 18 | </listitem> |
25 | 19 | ||
26 | <listitem> | 20 | <listitem> |
27 | <para>Introduction of the repo tool to manage the Git | 21 | <para></para> |
28 | repositories.</para> | ||
29 | </listitem> | 22 | </listitem> |
30 | </itemizedlist> | 23 | </itemizedlist> |
31 | 24 | ||
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 f4a815f..3217339 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 | |||
@@ -10,20 +10,10 @@ | |||
10 | <section id="enea-nfv-access-sysreq"> | 10 | <section id="enea-nfv-access-sysreq"> |
11 | <title>System Requirements</title> | 11 | <title>System Requirements</title> |
12 | 12 | ||
13 | <para>The host requirements listed below are extensive to allow for the | 13 | <para>The host requirements listed below are extensive to allow getting |
14 | building of Linux images via the Yocto system, and not just | 14 | Enea NFV Access to be booted on target machines and for building |
15 | applications.</para> | 15 | applications.</para> |
16 | 16 | ||
17 | <para>Please also see the system requirements in the Yocto 2.1 documents: | ||
18 | Yocto Project Start <ulink | ||
19 | url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources"> | ||
20 | http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink> | ||
21 | and the Yocto Project Reference Manual <ulink | ||
22 | url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements"> | ||
23 | http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>. | ||
24 | If needed, replace the Yocto version in the link(s) provided with a more | ||
25 | recent version.</para> | ||
26 | |||
27 | <informaltable> | 17 | <informaltable> |
28 | <tgroup cols="2"> | 18 | <tgroup cols="2"> |
29 | <colspec align="left" colname="1" colwidth="1*" /> | 19 | <colspec align="left" colname="1" colwidth="1*" /> |
@@ -34,8 +24,8 @@ | |||
34 | 24 | ||
35 | <tbody> | 25 | <tbody> |
36 | <row> | 26 | <row> |
37 | <entry spanname="onetwo"><emphasis role="bold"> Build host | 27 | <entry spanname="onetwo"><emphasis role="bold"> Build Host |
38 | requirements<indexterm> | 28 | Requirements<indexterm> |
39 | <primary>system requirements</primary> | 29 | <primary>system requirements</primary> |
40 | </indexterm></emphasis></entry> | 30 | </indexterm></emphasis></entry> |
41 | </row> | 31 | </row> |
@@ -43,107 +33,31 @@ | |||
43 | <row> | 33 | <row> |
44 | <entry>Linux distribution</entry> | 34 | <entry>Linux distribution</entry> |
45 | 35 | ||
46 | <entry>The downloaded code shall be built on a Linux host to | 36 | <entry>The downloaded product can installed on the target machine |
47 | generate images for your target or for emulation in QEMU. For | 37 | using a Linux host. For information about the supported hosts and |
48 | information about the supported hosts and targets, see the | 38 | targets, see <xref |
49 | <emphasis role="bold">Enea Linux Release Information</emphasis> in | 39 | linkend="relinfo-supported-host-environment" />.</entry> |
50 | your Enea Linux distribution.</entry> | ||
51 | </row> | ||
52 | |||
53 | <row> | ||
54 | <entry>Internet access</entry> | ||
55 | |||
56 | <entry>Internet access must be available when building an image, | ||
57 | since bitbake downloads source files from various servers during | ||
58 | the build.</entry> | ||
59 | </row> | 40 | </row> |
60 | 41 | ||
61 | <row> | 42 | <row> |
62 | <entry>Packages</entry> | 43 | <entry>Packages</entry> |
63 | 44 | ||
64 | <entry>Depending on the Linux distribution and version on host, | 45 | <entry>Depending on the Linux distribution and version of the |
65 | some packages may be required, by bitbake for example. You will | 46 | host, some packages may be required. See details on what packages |
66 | install any required packages while following the installation | 47 | are needed and how to install, in the following sections.</entry> |
67 | instructions.</entry> | ||
68 | </row> | ||
69 | |||
70 | <row> | ||
71 | <entry>Targets</entry> | ||
72 | |||
73 | <entry>Images can be built or downloaded for any of the targets | ||
74 | supported in this release, as specified in the <emphasis | ||
75 | role="bold">Enea Linux Release Information</emphasis>.</entry> | ||
76 | </row> | 48 | </row> |
77 | 49 | ||
78 | <row> | 50 | <row> |
79 | <entry>Disk space</entry> | 51 | <entry>Disk space</entry> |
80 | 52 | ||
81 | <entry><para>Your system should have at least 50 GB of free disk | 53 | <entry>Your system should have at least 50 GB of free disk space |
82 | space when bitbaking the basic enea-image-name kernel | 54 | for installing the SDK or cross-compiling applications.</entry> |
83 | image.</para> <para>For larger images and to allow for future | ||
84 | package extensions and variations in the build process, a minimum | ||
85 | of 100 GB free disk space is recommended.</para></entry> | ||
86 | </row> | 55 | </row> |
87 | 56 | ||
88 | <row> | 57 | <row> |
89 | <entry>Recommended RAM</entry> | 58 | <entry>Recommended RAM</entry> |
90 | 59 | ||
91 | <entry><para>Your system must have at least 4 GB available | 60 | <entry>Your system must have at least 4 GB available RAM.</entry> |
92 | RAM.</para> <para>It is recommended to have 8 GB RAM available for | ||
93 | parallel build jobs.</para></entry> | ||
94 | </row> | ||
95 | |||
96 | <row> | ||
97 | <entry>Java</entry> | ||
98 | |||
99 | <entry>Java <indexterm> | ||
100 | <primary>java</primary> | ||
101 | </indexterm>is required to run Eclipse. Currenly, Eclipse | ||
102 | generally recommends at least Java 6 JRE/JDK. More information | ||
103 | regarding operating environments for Eclipse, is provided in the | ||
104 | <emphasis>Eclipse Project Release Notes</emphasis> for the version | ||
105 | used. This can usually be found via | ||
106 | http://www.eclipse.org/eclipse/development/readme_eclipse_version. | ||
107 | See the <emphasis role="bold">Enea Linux Release Information | ||
108 | </emphasis>for the Eclipse Version.</entry> | ||
109 | </row> | ||
110 | </tbody> | ||
111 | </tgroup> | ||
112 | </informaltable> | ||
113 | |||
114 | <para>The build time depends on the capacity of the processor and other | ||
115 | hardware, available resources, speed of internet connection, load | ||
116 | situation, etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD | ||
117 | disks, a complete build from source could take about two hours.</para> | ||
118 | |||
119 | <informaltable> | ||
120 | <tgroup cols="2"> | ||
121 | <colspec align="left" colname="1" colwidth="1*" /> | ||
122 | |||
123 | <colspec align="left" colname="2" colwidth="3*" /> | ||
124 | |||
125 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
126 | |||
127 | <tbody> | ||
128 | <row> | ||
129 | <entry spanname="onetwo"><emphasis role="bold">Target | ||
130 | Requirements</emphasis></entry> | ||
131 | </row> | ||
132 | |||
133 | <row> | ||
134 | <entry>External memory</entry> | ||
135 | |||
136 | <entry>To boot a CGL<indexterm> | ||
137 | <primary>CGL</primary> | ||
138 | </indexterm> image, you need at least 16 GB on a hard-disk | ||
139 | drive<indexterm> | ||
140 | <primary>HDD</primary> | ||
141 | </indexterm> on eSATA, USB drive, or SD card.<remark>INFO: | ||
142 | (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good | ||
143 | margins)</remark><remark>INFO: NFS does not support SELinux. In | ||
144 | order to have a security-enhanced Linux, one must take off from an | ||
145 | NFS-booted system and proceed with boot from external | ||
146 | memory.</remark></entry> | ||
147 | </row> | 61 | </row> |
148 | </tbody> | 62 | </tbody> |
149 | </tgroup> | 63 | </tgroup> |
@@ -153,7 +67,7 @@ | |||
153 | <section id="ensure-bash"> | 67 | <section id="ensure-bash"> |
154 | <title>System Shell Configuration</title> | 68 | <title>System Shell Configuration</title> |
155 | 69 | ||
156 | <para>Before installing Enea Linux, ensure that bash is the default | 70 | <para>Before installing Enea NFV Access, ensure that bash is the default |
157 | shell.</para> | 71 | shell.</para> |
158 | 72 | ||
159 | <para>If your system runs Ubuntu, you can use ls -l to ensure | 73 | <para>If your system runs Ubuntu, you can use ls -l to ensure |
@@ -182,4 +96,10 @@ | |||
182 | xmlns:xi="http://www.w3.org/2001/XInclude" | 96 | xmlns:xi="http://www.w3.org/2001/XInclude" |
183 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> | 97 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> |
184 | </section> | 98 | </section> |
99 | |||
100 | <section id="dns-server"> | ||
101 | <title>Installing and Configuring the DNS server</title> | ||
102 | |||
103 | <para>CONTENT NEEDED</para> | ||
104 | </section> | ||
185 | </chapter> \ No newline at end of file | 105 | </chapter> \ No newline at end of file |