summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml')
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml205
1 files changed, 205 insertions, 0 deletions
diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml
new file mode 100644
index 0000000..075ade5
--- /dev/null
+++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml
@@ -0,0 +1,205 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="relinfo-getting-enea-linux">
5 <title>Getting Enea Linux</title>
6
7 <para>Enea Linux is available as both pre-built binary images and source
8 code. Both serve a specific purpose and each have their advantages. However,
9 using the pre-built binary images allows for getting up and running faster.
10 Please refer to the sections below for details on how to get Enea Linux as
11 pre-built binary images or source code.</para>
12
13 <section id="relinfo-getting-pre-built-images">
14 <title>Getting Pre-built Binaries</title>
15
16 <para>Enea Linux pre-built binaries are available for download on <ulink
17 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea
18 Download Portal</ulink>. Log in using the credentials provided. Using the
19 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
20 will now have access to the <emphasis role="bold">Files</emphasis> section
21 and the <emphasis role="bold">Online Documentation</emphasis>
22 section.</para>
23
24 <para>The Files section lists each Enea Linux distribution, one for each
25 version and profile, as a separate download package. Clicking on the name
26 of the distribution will open a new page, which presents further details
27 about the content of the release and a list of downloadable archives, one
28 for each hardware target included in the release. Each archive provides
29 the following content:</para>
30
31 <itemizedlist>
32 <listitem>
33 <para><emphasis>images</emphasis> directory &ndash; this directory
34 includes the binary image files needed to boot the target with Enea
35 Linux. This includes the kernel, the root file system, device tree,
36 etc.</para>
37 </listitem>
38
39 <listitem>
40 <para><emphasis>sdk</emphasis> directory &ndash; this directory
41 includes the installer for the SDK.</para>
42 </listitem>
43
44 <listitem>
45 <para><emphasis>rpm</emphasis> directory &ndash; this directory
46 contains all the packages included in the distribution in rpm format,
47 which can be installed using the package manager.</para>
48 </listitem>
49 </itemizedlist>
50
51 <para>For faster downloads, each archive is mirrored in several places,
52 geographically. Choose the archive in the region closest to you.</para>
53
54 <para>The Documentation section lists all the documents delivered with the
55 release:</para>
56
57 <itemizedlist>
58 <listitem>
59 <para><emphasis role="bold">Enea Linux Platform Developer&rsquo;s
60 Guide</emphasis> -intended for Enea Linux platform developers, who
61 want to configure and build customized Linux kernel images for
62 embedded system targets, using the Yocto configuration and build
63 system.</para>
64 </listitem>
65
66 <listitem>
67 <para><emphasis role="bold">Enea Linux Application Developer's
68 Guide</emphasis> - dedicated to Enea Linux application developers, who
69 want to build and run applications.</para>
70 </listitem>
71
72 <listitem>
73 <para><emphasis role="bold">Enea Linux Virtualization Guide</emphasis>
74 - provides further information meant to get the most out of the
75 virtualization features.</para>
76 </listitem>
77
78 <listitem>
79 <para><emphasis role="bold">Enea Linux Open Source Report</emphasis> -
80 contains the open source and license information pertaining to
81 packages provided with this release of Enea Linux.</para>
82 </listitem>
83
84 <listitem>
85 <para><emphasis role="bold">Enea Linux Eclipse Open Source
86 Report</emphasis> - contains the open source and license information
87 pertaining to the Eclipse package provided with this release of Enea
88 Linux.</para>
89 </listitem>
90
91 <listitem>
92 <para><emphasis role="bold">Enea Linux Release Info</emphasis> -
93 provides information about the current released distribution for a
94 selected set of targets, along with installation requirements and
95 procedures.</para>
96 </listitem>
97 </itemizedlist>
98 </section>
99
100 <section id="relinfo-getting-source">
101 <title>Getting the Sources</title>
102
103 <para>Enea Linux sources are available for cloning from a set of Git
104 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
105 Since Enea Linux requires multiple repositories, Google Repo tool is used
106 in order to manage configurations and make the cloning step simpler.
107 Google Repo tool uses files, known as manifests, which store a list of
108 tuples (repository URL, version). The Repo tool is then used to traverse
109 the list of tuples in the manifest file and clone the specified versions
110 of each repository. See <ulink
111 url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
112 for more info.</para>
113
114 <section id="getting-source-code-step-one">
115 <title>Get access to git.enea.com</title>
116
117 <para>In order to get access to git.enea.com, a ssh key is required for
118 Git authentication. If you don't already have such a key, follow the
119 steps below to generate one:</para>
120
121 <orderedlist>
122 <listitem>
123 <para>Generate the ssh key pair:</para>
124
125 <programlisting>$ ssh-keygen -t rsa</programlisting>
126
127 <para>When asked for a password, just press Enter. This will create
128 two files in the .ssh directory in your home directory.</para>
129
130 <programlisting>id_rsa
131id_rsa.pub</programlisting>
132 </listitem>
133
134 <listitem>
135 <para>Copy the public key into an authorized_keys file:</para>
136
137 <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
138 </listitem>
139 </orderedlist>
140
141 <para>Once these steps are done and you have a valid ssh key pair, send
142 the public key, <emphasis>id_rsa.pub</emphasis>, via email to
143 <email>mailto:git_support@list.enea.se</email> in order to get access to
144 <ulink url="https://git.enea.com">git.enea.com</ulink>.</para>
145 </section>
146
147 <section id="getting-source-code-step-two">
148 <title>Get Sources</title>
149
150 <para>To use the Repo tool to download the sources for Enea Linux, do
151 the following:</para>
152
153 <orderedlist>
154 <listitem condition="hidden">
155 <para>Make sure that the repo tool is installed. If not, do the
156 following: <remark>Below is include of ID
157 "eltf-getting-repo-install-command" from
158 eltf_params_updated.xml</remark></para>
159
160 <xi:include href="eltf_params_updated.xml"
161 xmlns:xi="http://www.w3.org/2001/XInclude"
162 xpointer="element(eltf-getting-repo-install-command/1)" />
163 </listitem>
164
165 <listitem>
166 <para>Define the MACHINE from one of the targets listed
167 here,<remark>Below is the "machine_list" programlisting in
168 machine_list_generated.xml created by the make system by extracting
169 from the manifest</remark></para>
170
171 <xi:include href="machine_list_generated.xml"
172 xmlns:xi="http://www.w3.org/2001/XInclude"
173 xpointer="element(machine-list/1)" />
174 </listitem>
175
176 <listitem>
177 <para>Then use the repo command below:<remark> Below is include of
178 ID "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here
179 the $MACHINE shall be given!</remark></para>
180
181 <xi:include href="eltf_params_updated.xml"
182 xmlns:xi="http://www.w3.org/2001/XInclude"
183 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
184 </listitem>
185 </orderedlist>
186
187 <para>Once the source code is downloaded, the current directory will
188 contain a README file with instructions on how to build the distro and
189 boot the machine you choose. For ease of use, these instructions are
190 also copied into this document, see <xref
191 linkend="relinfo-build-boot" />.</para>
192
193 <para>It's not necessary to explicitly clone the manifest repository
194 since that is done automatically by the repo tool. To see the current
195 manifest, use the following command:</para>
196
197 <programlisting>$ repo manifest</programlisting>
198
199 <remark>The UG should be updated with instructions on how to add
200 customizations. That section should also contain more info about the
201 manifest: the manifest templates, using a branch instead of the tag EL6,
202 etc. When this is done a reference from here should be added.</remark>
203 </section>
204 </section>
205</chapter> \ No newline at end of file