summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-getting-started
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2020-08-24 14:03:13 +0200
committerMiruna Paun <mrpa@enea.se>2020-08-25 12:23:47 +0200
commit1b64e9b4819aa960257aa2e5290b8582b51010c2 (patch)
tree97a605d54109f2ad605bcfc4e2d360e56bac78c1 /doc/book-enea-nfv-access-getting-started
parentef0a1615f1b1897f2592860a21e318ea88a2aa58 (diff)
downloadnfv-access-documentation-1b64e9b4819aa960257aa2e5290b8582b51010c2.tar.gz
Final 2.2.3 edits.Enea_NFV_Access_2.2.3_RC6
Change-Id: Ic391ab17dd0ebd8483598be84eb9051aec5f0546 Signed-off-by: mrpa <miruna.paun@enea.com>
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started')
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml27
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml192
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml23
3 files changed, 142 insertions, 100 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index 47c4ea4..649a80d 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -253,6 +253,14 @@ node0.1048576kB = 3 </programlisting>
253 root filesystem. When the installation is complete, the uCPE device is 253 root filesystem. When the installation is complete, the uCPE device is
254 automatically rebooted into Enea NFV Access Run Time Platform.</para> 254 automatically rebooted into Enea NFV Access Run Time Platform.</para>
255 255
256 <note>
257 <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and
258 <literal>bzImage</literal> files are available in the
259 Enea_NFV_Access_Run_Time_Platform_
260 &lt;processor&gt;_&lt;version&gt;-&lt;build_number&gt;.tar.gz file you
261 downloaded with your release.</para>
262 </note>
263
256 <section id="bare_meta_prov_prereq"> 264 <section id="bare_meta_prov_prereq">
257 <title>Prerequisites</title> 265 <title>Prerequisites</title>
258 266
@@ -303,9 +311,10 @@ node0.1048576kB = 3 </programlisting>
303 311
304 <listitem> 312 <listitem>
305 <para>Compress the Enea NFV Access Run Time Platform 313 <para>Compress the Enea NFV Access Run Time Platform
306 <literal>hddimg</literal> image for the uCPE device architecture 314 <literal>.hddimg</literal> image for the uCPE
307 using <literal>gzip</literal> and copy the resulting 315 device architecture using <literal>gzip</literal> and copy the
308 <literal>hddimg.gz</literal> file to the HTTP server.</para> 316 resulting <literal>hddimg.gz</literal> file to the HTTP
317 server.</para>
309 </listitem> 318 </listitem>
310 </orderedlist> 319 </orderedlist>
311 320
@@ -348,14 +357,12 @@ node0.1048576kB = 3 </programlisting>
348 357
349 <para>Installation Configuration File Example:</para> 358 <para>Installation Configuration File Example:</para>
350 359
351 <programlisting> 360 <programlisting>image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
352 image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz 361install_drive = /dev/sda</programlisting>
353 install_drive = /dev/sda
354 362
355</programlisting> 363 <note>
356 <note> 364 <para>The installation configuration file needs to use the Linux
357 <para>The installation configuration file needs to use the Linux end-of-line 365 end-of-line format (\n), not the Windows format (\r\n).</para>
358 format (\n), not the Windows format (\r\n).</para>
359 </note> 366 </note>
360 </section> 367 </section>
361 368
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
index bb7b525..d46b4c7 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
@@ -8,16 +8,24 @@
8 <title>Enea NFV Access Run Time Platform Installer</title> 8 <title>Enea NFV Access Run Time Platform Installer</title>
9 9
10 <para>The current release supports two methods of installation:</para> 10 <para>The current release supports two methods of installation:</para>
11 11
12 <itemizedlist> 12 <itemizedlist>
13 <listitem><para>Manual installation from a USB stick using the Enea NFV Access Web-installer, 13 <listitem>
14 which guarantees a clean installation of NFV Access on a uCPE device.</para></listitem> 14 <para>Manual installation from a USB stick using the Enea NFV Access
15 <listitem><para>Mass installation and automated deployment using 15 Web-installer, which guarantees a clean installation of NFV Access on
16 Bare Metal Provisioning.</para></listitem> 16 a uCPE device.</para>
17 </listitem>
18
19 <listitem>
20 <para>Mass installation and automated deployment using Bare Metal
21 Provisioning.</para>
22 </listitem>
17 </itemizedlist> 23 </itemizedlist>
18 24
19 <para>For more information about Bare Metal Provisioning please refer 25 <para>For more information about Bare Metal Provisioning please refer to
20 to <xref linkend="bare_meta_prov">5.3, Bare Metal Provisioning"</xref>.</para> 26 <xref linkend="bare_meta_prov">
27 5.3, Bare Metal Provisioning"
28 </xref>.</para>
21 29
22 <section id="prereq"> 30 <section id="prereq">
23 <title>Prerequisites</title> 31 <title>Prerequisites</title>
@@ -202,149 +210,167 @@ rootfs_destination=</programlisting></para>
202 <section id="auto_installer"> 210 <section id="auto_installer">
203 <title>Creating a bootable USB stick</title> 211 <title>Creating a bootable USB stick</title>
204 212
205 <para>In order to install the Enea NFV Access Run Time Platform, you must 213 <para>In order to install the Enea NFV Access Run Time Platform, you
206 first create a bootable USB stick with the image you intend to 214 must first create a bootable USB stick with the image you intend to
207 install. Follow the example below to proceed.</para> 215 install. Follow the example below to proceed.</para>
208 216
217 <note>
218 <para>The <literal>.hddimg</literal> image is available in the
219 Enea_NFV_Access_Run_Time_Platform_
220 &lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz file you
221 downloaded with your release.</para>
222 </note>
223
209 <para><emphasis role="bold">Create a bootable USB stick 224 <para><emphasis role="bold">Create a bootable USB stick
210 image</emphasis></para> 225 image</emphasis></para>
211 226
212 <orderedlist> 227 <orderedlist>
213 <listitem> 228 <listitem>
214 <para>Copy the HDDIMG image file provided by Enea, onto a 229 <para>Copy the <literal>.hddimg</literal> image file provided by
215 development machine.</para> 230 Enea, onto a development machine.</para>
216 </listitem> 231 </listitem>
217 232
218 <listitem> 233 <listitem>
219 <para>Connect the USB stick to the development machine and identify 234 <para>Connect the USB stick to the development machine and identify
220 the device name given by the system with 235 the device name given by the system with <command>lsblk</command>:
221 <command>lsblk</command>: 236 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
222 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
223sda 8:0 1 28.7G 0 disk 237sda 8:0 1 28.7G 0 disk
224sdb 8:0 0 111.8G 0 disk 238sdb 8:0 0 111.8G 0 disk
225|-sdb1 8:1 0 111.8G 0 part</programlisting></para> 239|-sdb1 8:1 0 111.8G 0 part</programlisting></para>
226 </listitem> 240 </listitem>
227 241
228 <listitem> 242 <listitem>
229 <para>Copy the HDDIMG image onto the USB stick, e.g: 243 <para>Copy the <literal>.hddimg</literal> image onto the USB stick,
230 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \ 244 e.g: <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
231of=/dev/sdb bs=4M conv=fsync</programlisting></para> 245of=/dev/sdb bs=4M conv=fsync</programlisting></para>
232 </listitem> 246 </listitem>
233 </orderedlist> 247 </orderedlist>
234 248
235 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg 249 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg
236 </filename>is the <literal>.hddimg</literal> file and <literal>sdb</literal> is the 250 </filename>is the <literal>.hddimg</literal> file and
237 assigned USB device name.</para> 251 <literal>sdb</literal> is the assigned USB device name.</para>
238 </section> 252 </section>
239 253
240 <section id="install_ena_stick"> 254 <section id="install_ena_stick">
241 <title>Installing Enea NFV Access</title> 255 <title>Installing Enea NFV Access</title>
242 256
243 <para><emphasis role="bold">How to install the Enea NFV Access Run Time 257 <para><emphasis role="bold">How to install the Enea NFV Access Run Time
244 Platform using a bootable USB stick image</emphasis></para> 258 Platform using a bootable USB stick image</emphasis></para>
245 259
246 <orderedlist> 260 <orderedlist>
247 <listitem> 261 <listitem>
248 <para>Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will 262 <para>Plug the USB stick into the uCPE device. Connect a laptop
249 not later be chosen as a WAN port. No other ports should be connected.</para> 263 directly into one of the ports that will not later be chosen as a
264 WAN port. No other ports should be connected.</para>
250 </listitem> 265 </listitem>
251 266
252 <listitem> 267 <listitem>
253 <para>Power up the uCPE device and boot the USB stick. Verify that the 268 <para>Power up the uCPE device and boot the USB stick. Verify that
254 USB stick is selected from the BIOS boot menu.</para> 269 the USB stick is selected from the BIOS boot menu.</para>
255 </listitem> 270 </listitem>
256 271
257 <listitem> 272 <listitem>
258 <para>Once the USB stick is properly booted, the Web-installer application starts 273 <para>Once the USB stick is properly booted, the Web-installer
259 automatically and can be accessed in a web browser at <literal>http://172.16.1.1</literal> (port 80). 274 application starts automatically and can be accessed in a web
260 </para> 275 browser at <literal>http://172.16.1.1</literal> (port 80).</para>
261 276
262 <para>On the first page of the Web-installer, the user should fill in:</para> 277 <para>On the first page of the Web-installer, the user should fill
278 in:</para>
263 279
264 <itemizedlist> 280 <itemizedlist>
265 <listitem> 281 <listitem>
266 <para><emphasis role="bold">The uCPE Manager IP Address</emphasis>.</para> 282 <para><emphasis role="bold">The uCPE Manager IP
283 Address</emphasis>.</para>
267 </listitem> 284 </listitem>
268 285
269 <listitem> 286 <listitem>
270 <para><emphasis role="bold">The Device ID</emphasis>. The unique identifier of the 287 <para><emphasis role="bold">The Device ID</emphasis>. The unique
271 uCPE device.</para> 288 identifier of the uCPE device.</para>
272
273 </listitem> 289 </listitem>
274 290
275 <listitem> 291 <listitem>
276 <para><emphasis role="bold">Customer Tags</emphasis>. They are used for 292 <para><emphasis role="bold">Customer Tags</emphasis>. They are
277 <link linkend="zero_touch_prov">Zero Touch Provisining (ZTP)</link> and can be left 293 used for <link linkend="zero_touch_prov">Zero Touch Provisining
278 empty. What can be entered here (as needed), are the tag(s) specified when 294 (ZTP)</link> and can be left empty. What can be entered here (as
279 creating an offline configuration in the uCPE Manager.</para> 295 needed), are the tag(s) specified when creating an offline
296 configuration in the uCPE Manager.</para>
280 </listitem> 297 </listitem>
281 </itemizedlist> 298 </itemizedlist>
282 299
283 <para>On the second page of the Web-installer, the user should fill in:</para> 300 <para>On the second page of the Web-installer, the user should fill
301 in:</para>
284 302
285 <itemizedlist> 303 <itemizedlist>
286 <listitem> 304 <listitem>
287 <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. 305 <para><emphasis role="bold">The Layer 3 configuration of WAN
288 Static or Dynamic IP must be specified.</para> 306 Interface(s)</emphasis>. Static or Dynamic IP must be
289 307 specified.</para>
290 <para>During network configuration, WAN cables will be plugged into the device 308
291 in order to identify ports and make them available for configuration. Each 309 <para>During network configuration, WAN cables will be plugged
292 port with a physically connected cable will be automatically set as a WAN port and must be 310 into the device in order to identify ports and make them
293 configured (DHCP is the default setting). The user needs to connect the same quantity of 311 available for configuration. Each port with a physically
294 cables as the number of WAN ports that he wishes to configure. No LAN ports should be 312 connected cable will be automatically set as a WAN port and must
295 connected nor configured at this time. The configured WAN cables cannot be removed 313 be configured (DHCP is the default setting). The user needs to
296 after being configured.</para> 314 connect the same quantity of cables as the number of WAN ports
297 315 that he wishes to configure. No LAN ports should be connected
298 <note> 316 nor configured at this time. The configured WAN cables cannot be
299 <para>The LAN port used to access the Web-installer from the laptop will not be shown 317 removed after being configured.</para>
300 and cannot be configured.</para></note> 318
319 <note>
320 <para>The LAN port used to access the Web-installer from the
321 laptop will not be shown and cannot be configured.</para>
322 </note>
301 </listitem> 323 </listitem>
302 324
303 <listitem> 325 <listitem>
304 <para><emphasis role="bold">The Management Interface</emphasis>. The interface that 326 <para><emphasis role="bold">The Management Interface</emphasis>.
305 will be used by the uCPE Manager to communicate with the device.</para> 327 The interface that will be used by the uCPE Manager to
306 328 communicate with the device.</para>
307 </listitem> 329 </listitem>
308 </itemizedlist> 330 </itemizedlist>
309 </listitem> 331 </listitem>
310 332
311 <listitem> 333 <listitem>
312 <para>When the user has completed the configuration steps in the Web-installer, NFV Access 334 <para>When the user has completed the configuration steps in the
313 is installed on the hard drive. The largest drive found on the device will be used for 335 Web-installer, NFV Access is installed on the hard drive. The
314 installation.</para> 336 largest drive found on the device will be used for
337 installation.</para>
315 </listitem> 338 </listitem>
316
317 </orderedlist> 339 </orderedlist>
318 </section> 340 </section>
319 341
320 <section id="boot_ena"> 342 <section id="boot_ena">
321 <title>Booting NFV Access</title> 343 <title>Booting NFV Access</title>
322 344
323 <para>When the installation has finished successfully, the user should remove the USB stick 345 <para>When the installation has finished successfully, the user should
324 before confirming the reboot of the device in Web-installer and ensure that BIOS is configured 346 remove the USB stick before confirming the reboot of the device in
325 to boot from the hard drive.</para> 347 Web-installer and ensure that BIOS is configured to boot from the hard
348 drive.</para>
349
350 <para>When configured with the Web-installer GUI, the uCPE device
351 start-up sequence will configure the interfaces accordingly and try to
352 register the device in the uCPE manager. If connectivity is established
353 with the uCPE manager server and a device with a matching Device ID is
354 found, the configuration is successful, and the connection is
355 established.</para>
326 356
327 <para>When configured with the Web-installer GUI, the uCPE device start-up sequence will
328 configure the interfaces accordingly and try to register the device in the uCPE manager.
329 If connectivity is established with the uCPE manager server and a device with a matching
330 Device ID is found, the configuration is successful, and the connection is established.</para>
331
332 <note> 357 <note>
333 <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at 358 <para>If NFV Access was installed by Bare Metal Provisioning, the
334 start-up expecting the user to provide the post-installation configuration. The Web-installer will 359 Web-installer will launch at start-up expecting the user to provide
335 be launched on port 80 for post-installation configuration: <literal> 360 the post-installation configuration. The Web-installer will be
361 launched on port 80 for post-installation configuration: <literal>
336 http://172.16.1.1</literal>.</para> 362 http://172.16.1.1</literal>.</para>
337 </note> 363 </note>
338 364
339 <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot 365 <para>In case of failure, the user should remove all WAN cables,
340 the device and then access the Web-installer on <literal>http://172.16.1.1</literal>. 366 re-attach the laptop, reboot the device and then access the
341 </para> 367 Web-installer on <literal>http://172.16.1.1</literal>.</para>
342 368
343 <note> 369 <note>
344 <para>After having established a successful connection with the uCPE Manager, the user will 370 <para>After having established a successful connection with the uCPE
345 connect any LAN cable(s) that should be connected to the device. 371 Manager, the user will connect any LAN cable(s) that should be
346 </para> 372 connected to the device.</para>
347 </note> 373 </note>
348 </section> 374 </section>
349 375
350 <section condition="hidden" id="examples"> 376 <section condition="hidden" id="examples">
@@ -684,4 +710,4 @@ ssh root@&lt;target_ip&gt; "cd /mnt/sda6; tar -zxf -"</programlisting>
684 </note> 710 </note>
685 </section> 711 </section>
686 </section> 712 </section>
687</chapter> 713</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
index 818bd52..dda71bb 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
@@ -228,11 +228,11 @@ userdel postgres</programlisting>
228 </listitem> 228 </listitem>
229 229
230 <listitem> 230 <listitem>
231 <para><literal>configureHA.sh</literal></para> 231 <para><filename>configureHA.sh</filename></para>
232 </listitem> 232 </listitem>
233 233
234 <listitem> 234 <listitem>
235 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 235 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
236 </listitem> 236 </listitem>
237 237
238 <listitem> 238 <listitem>
@@ -244,7 +244,8 @@ userdel postgres</programlisting>
244 <listitem> 244 <listitem>
245 <para>Run the following command:</para> 245 <para>Run the following command:</para>
246 246
247 <programlisting>./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 247 <programlisting>./install.sh /opt/ems \
248 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
248 </listitem> 249 </listitem>
249 </orderedlist> 250 </orderedlist>
250 251
@@ -321,7 +322,7 @@ userdel postgres</programlisting>
321 additional argument as shown below:</para> 322 additional argument as shown below:</para>
322 323
323 <programlisting>./install.sh \ 324 <programlisting>./install.sh \
324 /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz \ 325 /opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
325 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> 326 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
326 327
327 <para>The other steps are exactly the same as specified in the 328 <para>The other steps are exactly the same as specified in the
@@ -350,7 +351,7 @@ userdel postgres</programlisting>
350 </listitem> 351 </listitem>
351 352
352 <listitem> 353 <listitem>
353 <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> 354 <para><filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
354 </listitem> 355 </listitem>
355 </itemizedlist> 356 </itemizedlist>
356 </listitem> 357 </listitem>
@@ -358,7 +359,8 @@ userdel postgres</programlisting>
358 <listitem> 359 <listitem>
359 <para>Run the following command:</para> 360 <para>Run the following command:</para>
360 361
361 <programlisting>./upgrade.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting> 362 <programlisting>./upgrade.sh /opt/ems \
363 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
362 </listitem> 364 </listitem>
363 </orderedlist> 365 </orderedlist>
364 366
@@ -1298,6 +1300,13 @@ userdel postgres</programlisting>
1298 Uploaded Successfully</literal> appears on the File Upload 1300 Uploaded Successfully</literal> appears on the File Upload
1299 Screen.</para> 1301 Screen.</para>
1300 1302
1303 <note>
1304 <para>The image file of type <literal>rootfs.ostree.tar.bz2</literal>
1305 is available in the
1306 Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
1307 file you downloaded with your release.</para>
1308 </note>
1309
1301 <section id="upload_image"> 1310 <section id="upload_image">
1302 <title>Image Library</title> 1311 <title>Image Library</title>
1303 1312
@@ -1320,7 +1329,7 @@ userdel postgres</programlisting>
1320 to the image file (must be of type 1329 to the image file (must be of type
1321 <literal>rootfs.ostree.tar.bz2</literal>). Select the target 1330 <literal>rootfs.ostree.tar.bz2</literal>). Select the target
1322 hardware platform corresponding to the image being uploaded 1331 hardware platform corresponding to the image being uploaded
1323 (xeon-d or atomc-3000).</para> 1332 (xeon-d or atom-c3000).</para>
1324 </listitem> 1333 </listitem>
1325 1334
1326 <listitem> 1335 <listitem>