diff options
Diffstat (limited to 'doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml')
-rw-r--r-- | doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml | 205 |
1 files changed, 178 insertions, 27 deletions
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 f598693..f4a815f 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 | |||
@@ -4,31 +4,182 @@ | |||
4 | <chapter id="sys-req-prerequisites"> | 4 | <chapter id="sys-req-prerequisites"> |
5 | <title>System Requirements and Prerequisites</title> | 5 | <title>System Requirements and Prerequisites</title> |
6 | 6 | ||
7 | <para>Using Enea NFV Access or compiling applications requires that your git | 7 | <para>Using Enea NFV Access or compiling applications requires certain |
8 | environment be setup properly and for certain packages to be installed on | 8 | packages to be installed on your NFV Access development host.</para> |
9 | your NFV Access development host.</para> | 9 | |
10 | 10 | <section id="enea-nfv-access-sysreq"> | |
11 | <para>Please refer to <ulink | 11 | <title>System Requirements</title> |
12 | url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting | 12 | |
13 | Started - First-Time Git Setup</ulink>, for more details on how to set up | 13 | <para>The host requirements listed below are extensive to allow for the |
14 | your git environment correctly, including how to set your identity using the | 14 | building of Linux images via the Yocto system, and not just |
15 | following commands:</para> | 15 | applications.</para> |
16 | 16 | ||
17 | <programlisting>$ git config --global user.name "John Doe" | 17 | <para>Please also see the system requirements in the Yocto 2.1 documents: |
18 | $ git config --global user.email johndoe@example.com</programlisting> | 18 | Yocto Project Start <ulink |
19 | 19 | url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources"> | |
20 | <para>First ensure the system is up-to-date, then for the supported | 20 | http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink> |
21 | distribution(s), you need the following packages:<remark>INFO: The | 21 | and the Yocto Project Reference Manual <ulink |
22 | programlisting below is a parameters in eltf_params_updated.xml with ID: | 22 | url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements"> |
23 | "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store | 23 | http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>. |
24 | the commands for each host in the same programlisting with empty lines | 24 | If needed, replace the Yocto version in the link(s) provided with a more |
25 | between each - the comment with the FULL HOST name and version is | 25 | recent version.</para> |
26 | essential.</remark></para> | 26 | |
27 | 27 | <informaltable> | |
28 | <xi:include href="eltf_params_updated.xml" | 28 | <tgroup cols="2"> |
29 | xmlns:xi="http://www.w3.org/2001/XInclude" | 29 | <colspec align="left" colname="1" colwidth="1*" /> |
30 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> | 30 | |
31 | 31 | <colspec align="left" colname="2" colwidth="3*" /> | |
32 | <xi:include href="system_requirements.xml" | 32 | |
33 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 33 | <spanspec nameend="2" namest="1" spanname="onetwo" /> |
34 | |||
35 | <tbody> | ||
36 | <row> | ||
37 | <entry spanname="onetwo"><emphasis role="bold"> Build host | ||
38 | requirements<indexterm> | ||
39 | <primary>system requirements</primary> | ||
40 | </indexterm></emphasis></entry> | ||
41 | </row> | ||
42 | |||
43 | <row> | ||
44 | <entry>Linux distribution</entry> | ||
45 | |||
46 | <entry>The downloaded code shall be built on a Linux host to | ||
47 | generate images for your target or for emulation in QEMU. For | ||
48 | information about the supported hosts and targets, see the | ||
49 | <emphasis role="bold">Enea Linux Release Information</emphasis> in | ||
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> | ||
60 | |||
61 | <row> | ||
62 | <entry>Packages</entry> | ||
63 | |||
64 | <entry>Depending on the Linux distribution and version on host, | ||
65 | some packages may be required, by bitbake for example. You will | ||
66 | install any required packages while following the installation | ||
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> | ||
77 | |||
78 | <row> | ||
79 | <entry>Disk space</entry> | ||
80 | |||
81 | <entry><para>Your system should have at least 50 GB of free disk | ||
82 | space when bitbaking the basic enea-image-name kernel | ||
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> | ||
87 | |||
88 | <row> | ||
89 | <entry>Recommended RAM</entry> | ||
90 | |||
91 | <entry><para>Your system must have at least 4 GB available | ||
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> | ||
148 | </tbody> | ||
149 | </tgroup> | ||
150 | </informaltable> | ||
151 | </section> | ||
152 | |||
153 | <section id="ensure-bash"> | ||
154 | <title>System Shell Configuration</title> | ||
155 | |||
156 | <para>Before installing Enea Linux, ensure that bash is the default | ||
157 | shell.</para> | ||
158 | |||
159 | <para>If your system runs Ubuntu, you can use ls -l to ensure | ||
160 | <filename>/usr/bin</filename> is a symbolic link to bash. In case the link | ||
161 | points to dash, which is default in some Ubuntu versions, change it to | ||
162 | bash by running <emphasis role="bold">sudo dpkg-reconfigure | ||
163 | dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the | ||
164 | question "Use dash as the default system shell (/bin/sh)?":</para> | ||
165 | |||
166 | <programlisting># ls -l /bin/sh | ||
167 | lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash</programlisting> | ||
168 | </section> | ||
169 | |||
170 | <section id="preq-packages"> | ||
171 | <title>Prerequisite Packages</title> | ||
172 | |||
173 | <para>First ensure the system is up-to-date, then for the supported | ||
174 | distribution(s), you need the following packages:<remark>INFO: The | ||
175 | programlisting below is a parameters in eltf_params_updated.xml with ID: | ||
176 | "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store | ||
177 | the commands for each host in the same programlisting with empty lines | ||
178 | between each - the comment with the FULL HOST name and version is | ||
179 | essential.</remark></para> | ||
180 | |||
181 | <xi:include href="eltf_params_updated.xml" | ||
182 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
183 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> | ||
184 | </section> | ||
34 | </chapter> \ No newline at end of file | 185 | </chapter> \ No newline at end of file |