summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml
blob: f4a815f3d291ecfb9a23c262845fb35eeb6cdb83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="sys-req-prerequisites">
  <title>System Requirements and Prerequisites</title>

  <para>Using Enea NFV Access or compiling applications requires certain
  packages to be installed on your NFV Access development host.</para>

  <section id="enea-nfv-access-sysreq">
    <title>System Requirements</title>

    <para>The host requirements listed below are extensive to allow for the
    building of Linux images via the Yocto system, and not just
    applications.</para>

    <para>Please also see the system requirements in the Yocto 2.1 documents:
    Yocto Project Start <ulink
    url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources">
    http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink>
    and the Yocto Project Reference Manual <ulink
    url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements">
    http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>.
    If needed, replace the Yocto version in the link(s) provided with a more
    recent version.</para>

    <informaltable>
      <tgroup cols="2">
        <colspec align="left" colname="1" colwidth="1*" />

        <colspec align="left" colname="2" colwidth="3*" />

        <spanspec nameend="2" namest="1" spanname="onetwo" />

        <tbody>
          <row>
            <entry spanname="onetwo"><emphasis role="bold"> Build host
            requirements<indexterm>
                <primary>system requirements</primary>
              </indexterm></emphasis></entry>
          </row>

          <row>
            <entry>Linux distribution</entry>

            <entry>The downloaded code shall be built on a Linux host to
            generate images for your target or for emulation in QEMU. For
            information about the supported hosts and targets, see the
            <emphasis role="bold">Enea Linux Release Information</emphasis> in
            your Enea Linux distribution.</entry>
          </row>

          <row>
            <entry>Internet access</entry>

            <entry>Internet access must be available when building an image,
            since bitbake downloads source files from various servers during
            the build.</entry>
          </row>

          <row>
            <entry>Packages</entry>

            <entry>Depending on the Linux distribution and version on host,
            some packages may be required, by bitbake for example. You will
            install any required packages while following the installation
            instructions.</entry>
          </row>

          <row>
            <entry>Targets</entry>

            <entry>Images can be built or downloaded for any of the targets
            supported in this release, as specified in the <emphasis
            role="bold">Enea Linux Release Information</emphasis>.</entry>
          </row>

          <row>
            <entry>Disk space</entry>

            <entry><para>Your system should have at least 50 GB of free disk
            space when bitbaking the basic enea-image-name kernel
            image.</para> <para>For larger images and to allow for future
            package extensions and variations in the build process, a minimum
            of 100 GB free disk space is recommended.</para></entry>
          </row>

          <row>
            <entry>Recommended RAM</entry>

            <entry><para>Your system must have at least 4 GB available
            RAM.</para> <para>It is recommended to have 8 GB RAM available for
            parallel build jobs.</para></entry>
          </row>

          <row>
            <entry>Java</entry>

            <entry>Java <indexterm>
                <primary>java</primary>
              </indexterm>is required to run Eclipse. Currenly, Eclipse
            generally recommends at least Java 6 JRE/JDK. More information
            regarding operating environments for Eclipse, is provided in the
            <emphasis>Eclipse Project Release Notes</emphasis> for the version
            used. This can usually be found via
            http://www.eclipse.org/eclipse/development/readme_eclipse_version.
            See the <emphasis role="bold">Enea Linux Release Information
            </emphasis>for the Eclipse Version.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para>The build time depends on the capacity of the processor and other
    hardware, available resources, speed of internet connection, load
    situation, etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD
    disks, a complete build from source could take about two hours.</para>

    <informaltable>
      <tgroup cols="2">
        <colspec align="left" colname="1" colwidth="1*" />

        <colspec align="left" colname="2" colwidth="3*" />

        <spanspec nameend="2" namest="1" spanname="onetwo" />

        <tbody>
          <row>
            <entry spanname="onetwo"><emphasis role="bold">Target
            Requirements</emphasis></entry>
          </row>

          <row>
            <entry>External memory</entry>

            <entry>To boot a CGL<indexterm>
                <primary>CGL</primary>
              </indexterm> image, you need at least 16 GB on a hard-disk
            drive<indexterm>
                <primary>HDD</primary>
              </indexterm> on eSATA, USB drive, or SD card.<remark>INFO:
            (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good
            margins)</remark><remark>INFO: NFS does not support SELinux. In
            order to have a security-enhanced Linux, one must take off from an
            NFS-booted system and proceed with boot from external
            memory.</remark></entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </section>

  <section id="ensure-bash">
    <title>System Shell Configuration</title>

    <para>Before installing Enea Linux, ensure that bash is the default
    shell.</para>

    <para>If your system runs Ubuntu, you can use ls -l to ensure
    <filename>/usr/bin</filename> is a symbolic link to bash. In case the link
    points to dash, which is default in some Ubuntu versions, change it to
    bash by running <emphasis role="bold">sudo dpkg-reconfigure
    dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the
    question "Use dash as the default system shell (/bin/sh)?":</para>

    <programlisting># ls -l /bin/sh
	lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
  </section>

  <section id="preq-packages">
    <title>Prerequisite Packages</title>

    <para>First ensure the system is up-to-date, then for the supported
    distribution(s), you need the following packages:<remark>INFO: The
    programlisting below is a parameters in eltf_params_updated.xml with ID:
    "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
    the commands for each host in the same programlisting with empty lines
    between each - the comment with the FULL HOST name and version is
    essential.</remark></para>

    <xi:include href="eltf_params_updated.xml"
                xmlns:xi="http://www.w3.org/2001/XInclude"
                xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
  </section>
</chapter>