diff options
author | Andreas Wellving <andreas.wellving@enea.com> | 2020-03-06 12:49:15 +0100 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2020-03-06 18:48:42 +0100 |
commit | c2e65a29758b9e12994056e8b14121c15c6ffc04 (patch) | |
tree | 1db5d244a7fa876ee612a46b6a104d2ee832e6a0 | |
parent | be5114a3fd53ec3485e40a2b980c328ccd1cbd80 (diff) | |
download | el_releases-nfv-access-c2e65a29758b9e12994056e8b14121c15c6ffc04.tar.gz |
Write documentation for the Web-installer
Update book-enea-nfv-access-getting-started.pdf chapters
3.1.3 Installing Enea NFV Access
3.1.4 Booting NFV Access
Change-Id: I94ccfda84c2bf35adf5ea75e3ad8965bab0380d7
Signed-off-by: Andreas Wellving <andreas.wellving@enea.com>
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | 222 |
1 files changed, 75 insertions, 147 deletions
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 29b6dbb..8c907fc 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 | |||
@@ -239,195 +239,123 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
239 | 239 | ||
240 | <section id="install_ena_stick"> | 240 | <section id="install_ena_stick"> |
241 | <title>Installing Enea NFV Access</title> | 241 | <title>Installing Enea NFV Access</title> |
242 | |||
243 | <para>Installing the Run Time Platform can be done in two ways: | ||
244 | Automatic and Manual, depending on the features you wish to enable. | ||
245 | Please note that in order to enable features such as Zero Touch | ||
246 | Provisioning or Device Call Home Connection of uCPE devices in the | ||
247 | Enea uCPE Manager, Manual installation must be used.</para> | ||
248 | 242 | ||
249 | <para><emphasis role="bold">How to install the Enea NFV Access Run Time | 243 | <para><emphasis role="bold">How to install the Enea NFV Access Run Time |
250 | Platform using a bootable USB stick image</emphasis></para> | 244 | Platform using a bootable USB stick image</emphasis></para> |
251 | 245 | ||
252 | <orderedlist> | 246 | <orderedlist> |
253 | <listitem> | 247 | <listitem> |
254 | <para>Plug the USB stick into the uCPE device. Make sure | 248 | <para>To install and configure a device using the Web-installer, |
255 | you are connected to the serial port.</para> | 249 | the user must first connect a laptop directly into one of the LAN ports. |
250 | No other ports should be connected.</para> | ||
256 | </listitem> | 251 | </listitem> |
257 | 252 | ||
258 | <listitem> | 253 | <listitem> |
259 | <para>Power up the uCPE device and boot the USB stick. Verify the | 254 | <para>Power up the uCPE device and boot the USB stick. Verify that the |
260 | USB stick is selected from the BIOS boot menu.</para> | 255 | USB stick is selected from the BIOS boot menu.</para> |
261 | </listitem> | 256 | </listitem> |
262 | 257 | ||
263 | <listitem> | 258 | <listitem> |
264 | <para>Once the USB stick is properly booted, a GRUB menu appears on | 259 | <para>Once the USB stick is properly booted, the Web-installer application starts |
265 | the serial console. The following options are available:</para> | 260 | automatically and can be accessed in a web browser at <literal>http://192.168.1.1</literal> (port 80). |
261 | A DHCP Server is started on the device to serve the connected LAN port, in order to give | ||
262 | the laptop an IP-address.</para> | ||
263 | |||
264 | <para>From there, the user can configure the device with things such as:</para> | ||
266 | 265 | ||
267 | <itemizedlist spacing="compact"> | 266 | <itemizedlist> |
268 | <listitem> | 267 | <listitem> |
269 | <para><emphasis role="bold">live-boot</emphasis>. Boots the Run Time Platform directly | 268 | <para><emphasis role="bold">The uCPE Manager IP Address</emphasis>.</para> |
270 | from the USB stick.</para> | ||
271 | </listitem> | 269 | </listitem> |
272 | 270 | ||
273 | <listitem> | 271 | <listitem> |
274 | <para><emphasis role="bold">installer</emphasis>. Launches the Run Time Platform | 272 | <para><emphasis role="bold">The Device ID</emphasis>. The device must be previously |
275 | installer and uses the serial port for output.</para> | 273 | added to the uCPE Manager with a unique ID. The Device ID must be the same as the one |
274 | previously added in the uCPE Manager for he device.</para> | ||
275 | |||
276 | <note> | ||
277 | <para>To be able to connect, the same Device ID must first be added for the device | ||
278 | in uCPE Manager.</para> | ||
279 | </note> | ||
276 | </listitem> | 280 | </listitem> |
277 | </itemizedlist> | ||
278 | |||
279 | <note> | ||
280 | <para>The graphical console requires a display to be connected | ||
281 | to the uCPE device.</para> | ||
282 | </note> | ||
283 | </listitem> | ||
284 | 281 | ||
285 | <listitem> | ||
286 | <para>Select <command>Install NFV Access</command> from the menu to | ||
287 | proceed with the installation.</para> | ||
288 | </listitem> | ||
289 | |||
290 | <listitem> | ||
291 | <para>Once the installation has commenced two options are displayed:</para> | ||
292 | |||
293 | <itemizedlist> | ||
294 | <listitem> | 282 | <listitem> |
295 | <para><emphasis role="bold">Automatic install</emphasis>. This | 283 | <para><emphasis role="bold">Customer Tags</emphasis>. They can be left empty.</para> |
296 | option will partition a user-defined drive and install the Enea NFV | ||
297 | Access Run Time Platform. You can create 2 or 4 partitions, and | ||
298 | choosing either of these two options will prompt you for a drive | ||
299 | on which to install the Run Time Platform. The | ||
300 | 2-partition scheme divides the disk into one GPT partition | ||
301 | containing the GRUB binary and configuration, leaving the rest | ||
302 | of the disk for the root filesystem. The 4-partition scheme | ||
303 | creates: a GPT partition for GRUB (similar to the one in the | ||
304 | 2-partition scheme), two 20 GB partitions, and one containing | ||
305 | the remaining free disk space.</para> | ||
306 | |||
307 | <para>After choosing the Automatic install option and one of the | ||
308 | predefined partitioning actions, the <literal>install | ||
309 | steps</literal> detailing what will be installed and where are | ||
310 | updated by the installer.</para> | ||
311 | </listitem> | 284 | </listitem> |
312 | 285 | ||
313 | <listitem> | 286 | <listitem> |
314 | <para><emphasis role="bold">Manual install</emphasis>. Gives the | 287 | <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. |
315 | user the possibility of choosing where GRUB and NFV Access will | 288 | Static or Dynamic IP must be specified.</para> |
316 | be installed and what parameters can be set. Features like ZTP Provisioning etc. | 289 | |
317 | can be enabled as well.</para> | 290 | <para>During network configuration, WAN cables will be plugged into the device |
318 | 291 | in order to identify the ports and make them available for configuration. Each | |
319 | <para>Kernel parameters can be customized by selecting the | 292 | connected port will automatically be set as a WAN port and must be configured |
320 | <literal>Customize kernel parameters</literal> option and | 293 | (DHCP is the default setting).</para> |
321 | altering any of the parameters below.</para> | 294 | |
322 | 295 | <note> | |
323 | <para><emphasis role="bold">Default | 296 | <para>A WAN cable must first be added to the device, otherwise the port used to |
324 | Parameters</emphasis>:</para> | 297 | access the Web-installer from the laptop will not be shown and cannot be |
325 | 298 | configured as a WAN port.</para> | |
326 | <itemizedlist> | 299 | </note> |
327 | <listitem> | ||
328 | <para>Core isolation. Isolates the selected range of cores | ||
329 | from the kernel scheduler.</para> | ||
330 | </listitem> | ||
331 | |||
332 | <listitem> | ||
333 | <para>1G huge page count. The number of 1GB huge pages to | ||
334 | allocate at boot time.</para> | ||
335 | </listitem> | ||
336 | |||
337 | <listitem> | ||
338 | <para>2M huge page count. The number of 2M huge pages to | ||
339 | allocate at boot time.</para> | ||
340 | |||
341 | <note> | ||
342 | <para>In case the number of hugepages is not specified during | ||
343 | this step, hugepages will be allocated by the NFV Access | ||
344 | Hugepage Reservation Service, based on an algorithm which | ||
345 | takes into consideration the size of RAM memory. For further | ||
346 | information, please see section | ||
347 | <olink targetdoc="book_enea_nfv_access_getting_started" | ||
348 | targetptr="hugepage_reservation">Hugepage Reservation Service in the | ||
349 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
350 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
351 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> Manual.</para> | ||
352 | </note> | ||
353 | </listitem> | ||
354 | |||
355 | <listitem> | ||
356 | <para>uCPE Manager IP address. The IP address used to connect | ||
357 | to the uCPE Manager during Device Call Home Connection.</para> | ||
358 | </listitem> | ||
359 | |||
360 | <listitem> | ||
361 | <para>Device ID. A unique UUID format string used for device | ||
362 | identification during Zero Touch Provisioning.</para> | ||
363 | </listitem> | ||
364 | </itemizedlist> | ||
365 | |||
366 | <note> | ||
367 | <para>Modifying any of the Default parameters (e.g Core | ||
368 | isolation, 1G huge page count, etc.) will automatically update | ||
369 | the kernel parameters string. Updating the Custom parameters | ||
370 | within the kernel string directly will override any values set | ||
371 | previously for the Default parameters.</para> | ||
372 | </note> | ||
373 | </listitem> | 300 | </listitem> |
301 | |||
302 | <listitem> | ||
303 | <para><emphasis role="bold">The Management Interface</emphasis>. The interface that | ||
304 | will be used by the uCPE Manager to communicate with the device.</para> | ||
305 | |||
306 | <para>The IP address of this interface will be listed for the device in the uCPE | ||
307 | Manager. The WAN and management interfaces will be marked as such in the | ||
308 | <literal>capabilities</literal> view and are restricted in use. The user can change | ||
309 | the Layer 3 configuration of WAN interfaces and add new ones from the uCPE manager | ||
310 | as needed.</para> | ||
311 | </listitem> | ||
374 | </itemizedlist> | 312 | </itemizedlist> |
375 | </listitem> | 313 | </listitem> |
376 | 314 | ||
377 | <listitem> | 315 | <listitem> |
378 | <para>Once all settings are in place, select <command>Start | 316 | <para>The Web-installer stores the user provided configuration in a json metadata file located |
379 | install</command> to install NFV Access.</para> | 317 | in <filename>/boot/enea/install_data.json</filename>. There is also a command line tool that can |
380 | 318 | be used to access metadata entries: <literal>nfva-cfgtool</literal>.</para> | |
381 | <note> | ||
382 | <para>It is recommended to perform a dry run with the | ||
383 | <command>Start install (dry run)</command> option before | ||
384 | proceeding with actually modifying the drive.</para> | ||
385 | </note> | ||
386 | </listitem> | 319 | </listitem> |
387 | 320 | ||
388 | <listitem> | 321 | <listitem> |
389 | <para>At the end of the installation process, you can choose between | 322 | <para>When the user has completed the configuration steps in the Web-installer, NFV Access |
390 | running the installer again or rebooting the uCPE device.</para> | 323 | is installed on the hard drive. The largest drive found on the device will be used for |
391 | 324 | installation.</para> | |
392 | <note> | ||
393 | <para>The boot log will always be displayed on the serial port. | ||
394 | Modify the console parameter if you want the boot log to be shown | ||
395 | on something else other than the serial port.</para> | ||
396 | </note> | ||
397 | </listitem> | 325 | </listitem> |
326 | |||
398 | </orderedlist> | 327 | </orderedlist> |
399 | </section> | 328 | </section> |
400 | 329 | ||
401 | <section id="boot_ena"> | 330 | <section id="boot_ena"> |
402 | <title>Booting NFV Access</title> | 331 | <title>Booting NFV Access</title> |
403 | 332 | ||
404 | <para>After installing Enea NFV Access on a media storage device (e.g. | 333 | <para>When the installation has finished successfully, the user should remove the USB stick |
405 | eMMC, HDD or SSD), the uCPE device must be reset so that Enea NFV Access | 334 | and ensure that BIOS is configured to boot from the hard drive.</para> |
406 | can boot. The user must configure the first stage bootloader (e.g. | ||
407 | BIOS/UEFI) to boot the system from the media storage device where NFV | ||
408 | Access was installed.</para> | ||
409 | |||
410 | <para>If the uCPE Manager uses the Device Call Home Connection method for enrolling | ||
411 | the uCPE devices, the uCPE Manager IP address has to be configured in NFV | ||
412 | Access, by setting <literal>vcpemgr=<IP></literal> as a kernel | ||
413 | boot parameter in the GRUB configuration file. This step is not required | ||
414 | if configuration has been made during Manual Installation.</para> | ||
415 | 335 | ||
416 | <para>Once set, GRUB will start automatically and a menu will appear to | 336 | <para>When the NFV Access installation is booted from the hard drive, it will first check |
417 | let the user select one of the boot options:</para> | 337 | that the configuration metadata is complete. If any mandatory information is missing, the |
338 | Web-installer will be launched on port 82 for post-installation configuration: <literal> | ||
339 | http://192.168.1.1:82</literal>. The WAN cable needs to be removed and the device rebooted, | ||
340 | enabling the device's DHCP server to give the laptop an IP address over the LAN connection.</para> | ||
341 | |||
342 | <para>When all mandatory fields have been filled in, the new configuration is saved, stored | ||
343 | and the device will be rebooted.</para> | ||
418 | 344 | ||
419 | <itemizedlist> | 345 | <note> |
420 | <listitem> | 346 | <para>If NFV Access was installed by some other means, such as a PXE mass installation or by |
421 | <para><literal>Enea NFV Access 2.2.1 (ostree:0)</literal>: The | 347 | simply writing an image to a partition, no <filename>/boot/enea/install_data.json</filename> |
422 | recommended configuration boot commands.</para> | 348 | metadata file will exist and the Web-installer will launch at start-up expecting the |
423 | </listitem> | 349 | user to provide the post-installation configuration.</para> |
350 | </note> | ||
351 | |||
352 | <para>Once the configuration is complete, the system proceeds to launch the ODM/vCPE which will | ||
353 | configure the interfaces accordingly and try to register the device in the uCPE manager. If | ||
354 | connectivity is established with the uCPE manager server and a device with a matching Device ID is | ||
355 | found, the configuration is marked as successful, and the connection is established. In case of | ||
356 | failure, the Web-installer will be launched for reconfiguration. | ||
357 | </para> | ||
424 | 358 | ||
425 | <listitem> | ||
426 | <para><literal>Advanced</literal>: The Advanced option is a submenu | ||
427 | which can be used for other booting options. The default value is | ||
428 | minimal boot.</para> | ||
429 | </listitem> | ||
430 | </itemizedlist> | ||
431 | </section> | 359 | </section> |
432 | 360 | ||
433 | <section condition="hidden" id="examples"> | 361 | <section condition="hidden" id="examples"> |