summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-edge-automation-user-guide/doc/getting_started.xml')
-rw-r--r--doc/book-enea-edge-automation-user-guide/doc/getting_started.xml280
1 files changed, 280 insertions, 0 deletions
diff --git a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
new file mode 100644
index 0000000..536cea6
--- /dev/null
+++ b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
@@ -0,0 +1,280 @@
1<?xml version="1.0" encoding="UTF-8"?>
2<chapter id="getting_started">
3 <title>Getting Started with Enea Edge Automation</title>
4
5 <section id="envrion">
6 <title>Environment</title>
7
8 <para>There are two scenarios for a proper setup:</para>
9
10 <itemizedlist spacing="compact">
11 <listitem>
12 <para>Basic Setup</para>
13
14 <figure>
15 <title>Lab setup overview for Basic Setup</title>
16
17 <mediaobject>
18 <imageobject>
19 <imagedata align="center" contentwidth="600"
20 fileref="images/environment_basicsetup.png" />
21 </imageobject>
22 </mediaobject>
23 </figure>
24 </listitem>
25
26 <listitem>
27 <para>Chained VNFs Service</para>
28
29 <figure>
30 <title>Lab Setup Overview for Chained VNFs Service</title>
31
32 <mediaobject>
33 <imageobject>
34 <imagedata align="center" contentwidth="600"
35 fileref="images/ChainedVNFsService_setup.png" />
36 </imageobject>
37 </mediaobject>
38 </figure>
39 </listitem>
40 </itemizedlist>
41
42 <para>The following environment setup is needed for running the Enea Edge
43 Automation tests:</para>
44
45 <itemizedlist>
46 <listitem>
47 <para>Lab Network Requirements:</para>
48
49 <itemizedlist spacing="compact">
50 <listitem>
51 <para>DHCP enabled</para>
52 </listitem>
53
54 <listitem>
55 <para>Internet connectivity</para>
56 </listitem>
57 </itemizedlist>
58 </listitem>
59
60 <listitem>
61 <para>Enea Edge Management Host Requirements:</para>
62
63 <itemizedlist spacing="compact">
64 <listitem>
65 <para>CentOS 7 installed</para>
66 </listitem>
67
68 <listitem>
69 <para>A connection to the Lab Network</para>
70 </listitem>
71
72 <listitem>
73 <para>The Enea Edge Management application installed. For details,
74 see <olink targetdoc="book_enea_edge_getting_started"
75 targetptr="install_ucpe_mg">Installing the Enea Edge Management
76 application in the <xi:include
77 href="../../s_docbuild/olinkdb/pardoc-names.xml"
78 xmlns:xi="http://www.w3.org/2001/XInclude"
79 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
80 Manual.</para>
81 </listitem>
82 </itemizedlist>
83 </listitem>
84
85 <listitem>
86 <para>uCPE device Requirements for Basic Setup:</para>
87
88 <itemizedlist spacing="compact">
89 <listitem>
90 <para>Minimum of 4 Physical Network Devices</para>
91 </listitem>
92
93 <listitem>
94 <para>4GB RAM and 4 cores (Intel C3000 or Xeon D)</para>
95 </listitem>
96
97 <listitem>
98 <para>2 Physical connections to the Lab Network</para>
99 </listitem>
100
101 <listitem>
102 <para>Enea Edge Runtime installed. For more details, see <olink
103 targetdoc="book_enea_edge_getting_started"
104 targetptr="prep_usb_ena">Preparing the USB stick for installation
105 of the Enea Edge Runtime in the <xi:include
106 href="../../s_docbuild/olinkdb/pardoc-names.xml"
107 xmlns:xi="http://www.w3.org/2001/XInclude"
108 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
109 Manual.</para>
110 </listitem>
111 </itemizedlist>
112 </listitem>
113
114 <listitem>
115 <para>uCPE device 1 and 2 Requirements for Chained VNFs
116 Service:</para>
117
118 <itemizedlist spacing="compact">
119 <listitem>
120 <para>Minimum of 4 Physical Network Devices</para>
121 </listitem>
122
123 <listitem>
124 <para>16GB RAM and 8 cores (Intel C3000 or Xeon D)</para>
125 </listitem>
126
127 <listitem>
128 <para>2 Physical connections to the Lab Network</para>
129 </listitem>
130
131 <listitem>
132 <para>1 Physical connection back to back between both uCPE
133 devices</para>
134 </listitem>
135
136 <listitem>
137 <para>Enea Edge Runtime installed</para>
138 </listitem>
139 </itemizedlist>
140 </listitem>
141 </itemizedlist>
142 </section>
143
144 <section id="prerequisites">
145 <title>Prerequisites</title>
146
147 <para>For the installation of the Enea Edge Automation a CentOS 7 host
148 machine is needed with support for:</para>
149
150 <itemizedlist>
151 <listitem>
152 <para>Python 3.6.8</para>
153 </listitem>
154
155 <listitem>
156 <para>EPEL Repository</para>
157
158 <programlisting>sudo yum install epel-release</programlisting>
159 </listitem>
160
161 <listitem>
162 <para>PIP package manager</para>
163
164 <programlisting>sudo yum -y install python-pip</programlisting>
165 </listitem>
166
167 <listitem>
168 <para>Virtualenv tool</para>
169
170 <programlisting>sudo pip install virtualenv</programlisting>
171 </listitem>
172 </itemizedlist>
173
174 <note>
175 <para>It is recommended to install Enea Edge Automation and the Enea
176 Edge Management application on different machines.</para>
177 </note>
178 </section>
179
180 <section id="initial_setup">
181 <title>Installing the Enea Edge Automation</title>
182
183 <para id="install_procedure"><emphasis role="bold">Installing the Enea
184 Edge Automation</emphasis></para>
185
186 <orderedlist>
187 <listitem>
188 <para>Log into the host machine</para>
189 </listitem>
190
191 <listitem>
192 <para><programlisting>cd &lt;Automation-installerdir&gt;</programlisting></para>
193 </listitem>
194
195 <listitem>
196 <para>Extract the archive file</para>
197
198 <programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting>
199 </listitem>
200
201 <listitem>
202 <para>Run the setup of virtual environment script:</para>
203
204 <programlisting>source setup_env.sh</programlisting>
205 </listitem>
206
207 <listitem>
208 <para>Configure the system. For more details, see <xref
209 linkend="AFTH_cofig" />.</para>
210 </listitem>
211 </orderedlist>
212
213 <note>
214 <para>The steps are executed only once, for the initial setup of the
215 environment.</para>
216 </note>
217
218 <para><emphasis role="bold">Setting up the environment for the Enea Edge
219 Automation</emphasis></para>
220
221 <orderedlist>
222 <listitem>
223 <para>Activate the Python virtual environment</para>
224
225 <programlisting>source &lt;Automation-installerdir&gt;/testHarness-venv/bin/activate</programlisting>
226 </listitem>
227
228 <listitem>
229 <para>Optionally, check the History Information</para>
230
231 <programlisting>vi &lt;Automation-installerdir&gt;/CHANGELOG</programlisting>
232 </listitem>
233
234 <listitem>
235 <para>Close the Python virtual environment</para>
236
237 <programlisting>deactivate</programlisting>
238 </listitem>
239 </orderedlist>
240 </section>
241
242 <section id="upgrade_AF">
243 <title>Upgrading the Enea Edge Automation</title>
244
245 <para><emphasis role="bold">Upgrading the Enea Edge
246 Automation</emphasis></para>
247
248 <orderedlist>
249 <listitem>
250 <para>Log into the host machine</para>
251 </listitem>
252
253 <listitem>
254 <para><programlisting>cd &lt;Automation-installerdir&gt;</programlisting></para>
255 </listitem>
256
257 <listitem>
258 <para>Back up the configuration files from
259 <literal>modules/enea/config</literal>.</para>
260 </listitem>
261
262 <listitem>
263 <para>Extract the archive file:</para>
264
265 <programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting>
266 </listitem>
267
268 <listitem>
269 <para>Restore the configuration files from step 2 into
270 <literal>modules/enea/config </literal>.</para>
271 </listitem>
272
273 <listitem>
274 <para>Run the setup of virtual environment script:</para>
275
276 <programlisting>source setup_env.sh</programlisting>
277 </listitem>
278 </orderedlist>
279 </section>
280</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-06-07 18:15:06 +0000