diff options
| author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-10-07 14:33:28 +0200 |
|---|---|---|
| committer | Miruna Paun <Miruna.Paun@enea.com> | 2019-10-08 14:54:06 +0200 |
| commit | 1796f799f44c713199ed92676c98ccb3934a1b7e (patch) | |
| tree | 0b14af97bec49b0555d5aec189e9fc62a828c1a0 | |
| parent | b3f8e75fd7c35fab4fed16b1c713c5beba23f2c9 (diff) | |
| download | nfv-access-documentation-1796f799f44c713199ed92676c98ccb3934a1b7e.tar.gz | |
GettingStarted: update Getting Started NFV Access
- Add additional installer method (BMP)
- Remove "2 physical interfaces" from "3.1.1 Prerequisites”
- Remove references to Windows
- Minor updates in some chapters
- Remove 3.1.5 Troubleshooting
- Update Figure 4.1 Host Interface Caps
Change-Id: I933d5e6e2d803100a0774c437879af1bef852aff
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | 140 | ||||
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 2 | ||||
| -rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png | bin | 32885 -> 34733 bytes |
3 files changed, 65 insertions, 77 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 6d9e8c4..7b29ef9 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 | |||
| @@ -7,9 +7,17 @@ | |||
| 7 | <section id="access_installer"> | 7 | <section id="access_installer"> |
| 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 one primary method of installation, | 10 | <para>The current release supports two methods of installation:</para> |
| 11 | using the installer, which guarantees a clean installation of NFV Access | 11 | |
| 12 | on a uCPE device.</para> | 12 | <itemizedlist> |
| 13 | <listitem><para>Manual installation using the Enea Installer, which | ||
| 14 | guarantees a clean installation of NFV Access on a uCPE device.</para></listitem> | ||
| 15 | <listitem><para>Mass installation and automated deployment using | ||
| 16 | Bare Metal Provisioning.</para></listitem> | ||
| 17 | </itemizedlist> | ||
| 18 | |||
| 19 | <para>For more information about Bare Metal Provisioning please refer | ||
| 20 | to <xref linkend="bare_meta_prov">5.3, Bare Metal Provisioning"</xref>.</para> | ||
| 13 | 21 | ||
| 14 | <section id="prereq"> | 22 | <section id="prereq"> |
| 15 | <title>Prerequisites</title> | 23 | <title>Prerequisites</title> |
| @@ -22,7 +30,7 @@ | |||
| 22 | 30 | ||
| 23 | <itemizedlist spacing="compact"> | 31 | <itemizedlist spacing="compact"> |
| 24 | <listitem> | 32 | <listitem> |
| 25 | <para>EFI and virtualization support</para> | 33 | <para>EFI and virtualization support.</para> |
| 26 | </listitem> | 34 | </listitem> |
| 27 | 35 | ||
| 28 | <listitem> | 36 | <listitem> |
| @@ -34,15 +42,11 @@ | |||
| 34 | </listitem> | 42 | </listitem> |
| 35 | 43 | ||
| 36 | <listitem> | 44 | <listitem> |
| 37 | <para>Stoarge Device (SSD recommended)</para> | 45 | <para>Storage Device (SSD recommended).</para> |
| 38 | </listitem> | ||
| 39 | |||
| 40 | <listitem> | ||
| 41 | <para>2 physical interfaces</para> | ||
| 42 | </listitem> | 46 | </listitem> |
| 43 | </itemizedlist> | 47 | </itemizedlist> |
| 44 | 48 | ||
| 45 | <para>Following BIOS settings to be enabled:</para> | 49 | <para>BIOS settings that need to be enabled:</para> |
| 46 | 50 | ||
| 47 | <itemizedlist spacing="compact"> | 51 | <itemizedlist spacing="compact"> |
| 48 | <listitem> | 52 | <listitem> |
| @@ -50,7 +54,7 @@ | |||
| 50 | </listitem> | 54 | </listitem> |
| 51 | 55 | ||
| 52 | <listitem> | 56 | <listitem> |
| 53 | <para>Intel Virtualization Technology (VT-x )</para> | 57 | <para>Intel Virtualization Technology (VT-x)</para> |
| 54 | </listitem> | 58 | </listitem> |
| 55 | 59 | ||
| 56 | <listitem> | 60 | <listitem> |
| @@ -198,9 +202,9 @@ rootfs_destination=</programlisting></para> | |||
| 198 | <section id="auto_installer"> | 202 | <section id="auto_installer"> |
| 199 | <title>Creating a bootable USB stick</title> | 203 | <title>Creating a bootable USB stick</title> |
| 200 | 204 | ||
| 201 | <para>In order to install Enea NFV Access Run Time Platform, you must | 205 | <para>In order to install the Enea NFV Access Run Time Platform, you must |
| 202 | first create a bootable USB stick with the image you intend to | 206 | first create a bootable USB stick with the image you intend to |
| 203 | install.</para> | 207 | install. Follow the example below to proceed.</para> |
| 204 | 208 | ||
| 205 | <para><emphasis role="bold">Create a bootable USB stick | 209 | <para><emphasis role="bold">Create a bootable USB stick |
| 206 | image</emphasis></para> | 210 | image</emphasis></para> |
| @@ -208,38 +212,46 @@ rootfs_destination=</programlisting></para> | |||
| 208 | <orderedlist> | 212 | <orderedlist> |
| 209 | <listitem> | 213 | <listitem> |
| 210 | <para>Copy the HDDIMG image file provided by Enea, onto a | 214 | <para>Copy the HDDIMG image file provided by Enea, onto a |
| 211 | development machine (Linux or Windows with Cygwin support).</para> | 215 | development machine.</para> |
| 212 | </listitem> | 216 | </listitem> |
| 213 | 217 | ||
| 214 | <listitem> | 218 | <listitem> |
| 215 | <para>Connect the USB stick to the development machine and identify | 219 | <para>Connect the USB stick to the development machine and identify |
| 216 | the device name given by the system with | 220 | the device name given by the system with |
| 217 | <command>lsblk</command>:<programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT | 221 | <command>lsblk</command>: |
| 222 | <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT | ||
| 218 | sda 8:0 1 28.7G 0 disk | 223 | sda 8:0 1 28.7G 0 disk |
| 219 | sdb 8:0 0 111.8G 0 disk | 224 | sdb 8:0 0 111.8G 0 disk |
| 220 | |-sdb1 8:1 0 111.8G 0 part</programlisting></para> | 225 | |-sdb1 8:1 0 111.8G 0 part</programlisting></para> |
| 221 | </listitem> | 226 | </listitem> |
| 222 | 227 | ||
| 223 | <listitem> | 228 | <listitem> |
| 224 | <para>Copy the HDDIMG image to the USB stick, e.g:<programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ | 229 | <para>Copy the HDDIMG image onto the USB stick, e.g: |
| 230 | <programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ | ||
| 225 | of=/dev/sdb bs=4M conv=fsync</programlisting></para> | 231 | of=/dev/sdb bs=4M conv=fsync</programlisting></para> |
| 226 | </listitem> | 232 | </listitem> |
| 227 | </orderedlist> | 233 | </orderedlist> |
| 228 | 234 | ||
| 229 | <para>Where <filename>enea-nfv-access-<machine>.hddimg | 235 | <para>Where <filename>enea-nfv-access-<machine>.hddimg |
| 230 | </filename>is the .hddimg file and <literal>sdb</literal> is the | 236 | </filename>is the <literal>.hddimg</literal> file and <literal>sdb</literal> is the |
| 231 | assigned USB device name.</para> | 237 | assigned USB device name.</para> |
| 232 | </section> | 238 | </section> |
| 233 | 239 | ||
| 234 | <section id="install_ena_stick"> | 240 | <section id="install_ena_stick"> |
| 235 | <title>Installing Enea NFV Access</title> | 241 | <title>Installing Enea NFV Access</title> |
| 236 | 242 | ||
| 237 | <para><emphasis role="bold">How to install Enea NFV Access Run Time | 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 Automatic Addition of uCPE devices in the Enea uCPE | ||
| 247 | Manager, Manual installation must be used.</para> | ||
| 248 | |||
| 249 | <para><emphasis role="bold">How to install the Enea NFV Access Run Time | ||
| 238 | Platform using a bootable USB stick image</emphasis></para> | 250 | Platform using a bootable USB stick image</emphasis></para> |
| 239 | 251 | ||
| 240 | <orderedlist> | 252 | <orderedlist> |
| 241 | <listitem> | 253 | <listitem> |
| 242 | <para>Plug the USB stick into the reference uCPE device. Make sure | 254 | <para>Plug the USB stick into the uCPE device. Make sure |
| 243 | you are connected to the serial port.</para> | 255 | you are connected to the serial port.</para> |
| 244 | </listitem> | 256 | </listitem> |
| 245 | 257 | ||
| @@ -254,18 +266,18 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 254 | 266 | ||
| 255 | <itemizedlist spacing="compact"> | 267 | <itemizedlist spacing="compact"> |
| 256 | <listitem> | 268 | <listitem> |
| 257 | <para>live-boot. Boots NFV Access Run Time Platform directly | 269 | <para><emphasis role="bold">live-boot</emphasis>. Boots the Run Time Platform directly |
| 258 | from the USB stick.</para> | 270 | from the USB stick.</para> |
| 259 | </listitem> | 271 | </listitem> |
| 260 | 272 | ||
| 261 | <listitem> | 273 | <listitem> |
| 262 | <para>installer. Launches the NFV Access Run Time Platform | 274 | <para><emphasis role="bold">installer</emphasis>. Launches the Run Time Platform |
| 263 | installer and uses the serial port for output.</para> | 275 | installer and uses the serial port for output.</para> |
| 264 | </listitem> | 276 | </listitem> |
| 265 | </itemizedlist> | 277 | </itemizedlist> |
| 266 | 278 | ||
| 267 | <note> | 279 | <note> |
| 268 | <para>The graphical console requires that a display is connected | 280 | <para>The graphical console requires a display to be connected |
| 269 | to the uCPE device.</para> | 281 | to the uCPE device.</para> |
| 270 | </note> | 282 | </note> |
| 271 | </listitem> | 283 | </listitem> |
| @@ -276,16 +288,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 276 | </listitem> | 288 | </listitem> |
| 277 | 289 | ||
| 278 | <listitem> | 290 | <listitem> |
| 279 | <para>Once the installation has commenced two options are | 291 | <para>Once the installation has commenced two options are displayed:</para> |
| 280 | displayed:</para> | ||
| 281 | 292 | ||
| 282 | <itemizedlist> | 293 | <itemizedlist> |
| 283 | <listitem> | 294 | <listitem> |
| 284 | <para><emphasis role="bold">Automatic install</emphasis>. This | 295 | <para><emphasis role="bold">Automatic install</emphasis>. This |
| 285 | option will partition a user-defined drive and install NFV | 296 | option will partition a user-defined drive and install the Enea NFV |
| 286 | Access Run Time Platform. You can create 2 or 4 partitions, and | 297 | Access Run Time Platform. You can create 2 or 4 partitions, and |
| 287 | choosing either of these two options will prompt you for a drive | 298 | choosing either of these two options will prompt you for a drive |
| 288 | on which to install NFV Access Run Time Platform. The | 299 | on which to install the Run Time Platform. The |
| 289 | 2-partition scheme divides the disk into one GPT partition | 300 | 2-partition scheme divides the disk into one GPT partition |
| 290 | containing the GRUB binary and configuration, leaving the rest | 301 | containing the GRUB binary and configuration, leaving the rest |
| 291 | of the disk for the root filesystem. The 4-partition scheme | 302 | of the disk for the root filesystem. The 4-partition scheme |
| @@ -302,13 +313,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 302 | <listitem> | 313 | <listitem> |
| 303 | <para><emphasis role="bold">Manual install</emphasis>. Gives the | 314 | <para><emphasis role="bold">Manual install</emphasis>. Gives the |
| 304 | user the possibility of choosing where GRUB and NFV Access will | 315 | user the possibility of choosing where GRUB and NFV Access will |
| 305 | be installed and what parameters can be set.</para> | 316 | be installed and what parameters can be set. Features like ZT Provisioning etc. |
| 306 | 317 | can be enabled as well.</para> | |
| 307 | <note> | ||
| 308 | <para>This option is <emphasis role="bold">only</emphasis> | ||
| 309 | recommended for advanced use and should otherwise not be | ||
| 310 | used.</para> | ||
| 311 | </note> | ||
| 312 | 318 | ||
| 313 | <para>Kernel parameters can be customized by selecting the | 319 | <para>Kernel parameters can be customized by selecting the |
| 314 | <literal>Customize kernel parameters</literal> option and | 320 | <literal>Customize kernel parameters</literal> option and |
| @@ -331,15 +337,29 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 331 | <listitem> | 337 | <listitem> |
| 332 | <para>2M huge page count. The number of 2M huge pages to | 338 | <para>2M huge page count. The number of 2M huge pages to |
| 333 | allocate at boot time.</para> | 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 algoritm 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> | ||
| 334 | </listitem> | 353 | </listitem> |
| 335 | 354 | ||
| 336 | <listitem> | 355 | <listitem> |
| 337 | <para>uCPE Manager IP address. The IP address needed for | 356 | <para>uCPE Manager IP address. The IP address used to connect |
| 338 | contacting the machine running the uCPE Manager.</para> | 357 | to the uCPE Manager during Automatic Addition.</para> |
| 339 | </listitem> | 358 | </listitem> |
| 340 | 359 | ||
| 341 | <listitem> | 360 | <listitem> |
| 342 | <para>Device ID. A unique UUID format string.</para> | 361 | <para>Device ID. A unique UUID format string used for device |
| 362 | identification during Zero Touch Provisioning.</para> | ||
| 343 | </listitem> | 363 | </listitem> |
| 344 | </itemizedlist> | 364 | </itemizedlist> |
| 345 | 365 | ||
| @@ -372,7 +392,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 372 | <note> | 392 | <note> |
| 373 | <para>The boot log will always be displayed on the serial port. | 393 | <para>The boot log will always be displayed on the serial port. |
| 374 | Modify the console parameter if you want the boot log to be shown | 394 | Modify the console parameter if you want the boot log to be shown |
| 375 | on something else than the serial port.</para> | 395 | on something else other than the serial port.</para> |
| 376 | </note> | 396 | </note> |
| 377 | </listitem> | 397 | </listitem> |
| 378 | </orderedlist> | 398 | </orderedlist> |
| @@ -387,22 +407,18 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
| 387 | BIOS/UEFI) to boot the system from the media storage device where NFV | 407 | BIOS/UEFI) to boot the system from the media storage device where NFV |
| 388 | Access was installed.</para> | 408 | Access was installed.</para> |
| 389 | 409 | ||
| 410 | <para>If the uCPE Manager uses the Automatic Addition 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 | |||
| 390 | <para>Once set, GRUB will start automatically and a menu will appear to | 416 | <para>Once set, GRUB will start automatically and a menu will appear to |
| 391 | let the user select one of the boot options:</para> | 417 | let the user select one of the boot options:</para> |
| 392 | 418 | ||
| 393 | <figure> | ||
| 394 | <title>Booting NFV Access</title> | ||
| 395 | |||
| 396 | <mediaobject> | ||
| 397 | <imageobject> | ||
| 398 | <imagedata align="center" fileref="images/boot_ena.png" scale="75" /> | ||
| 399 | </imageobject> | ||
| 400 | </mediaobject> | ||
| 401 | </figure> | ||
| 402 | |||
| 403 | <itemizedlist> | 419 | <itemizedlist> |
| 404 | <listitem> | 420 | <listitem> |
| 405 | <para><literal>Enea NFV Access 2.2 (rocko) (ostre:0)</literal>: The | 421 | <para><literal>Enea NFV Access 2.2.1 (ostree:0)</literal>: The |
| 406 | recommended configuration boot commands.</para> | 422 | recommended configuration boot commands.</para> |
| 407 | </listitem> | 423 | </listitem> |
| 408 | 424 | ||
| @@ -449,34 +465,6 @@ run</programlisting> | |||
| 449 | </listitem> | 465 | </listitem> |
| 450 | </itemizedlist> | 466 | </itemizedlist> |
| 451 | </section> | 467 | </section> |
| 452 | |||
| 453 | <section id="troubleshooting"> | ||
| 454 | <title>Troubleshooting</title> | ||
| 455 | |||
| 456 | <para>Use-case: When booting from UEFI, GRUB from the installer storage | ||
| 457 | on the USB stick previously set up, is always selected by | ||
| 458 | default.</para> | ||
| 459 | |||
| 460 | <para>Workaround: If both a USB stick with the Enea NFV Access installer | ||
| 461 | set up (e.g FS0) and an another media storage device (e.g. FS1), are | ||
| 462 | connected to a uCPE device, in order to select the former, the count | ||
| 463 | down must be stopped with the default <literal>startup.nsh</literal> | ||
| 464 | script by pressing <command>ESC</command> and then starting GRUB | ||
| 465 | manually:</para> | ||
| 466 | |||
| 467 | <figure> | ||
| 468 | <mediaobject> | ||
| 469 | <imageobject> | ||
| 470 | <imagedata align="center" fileref="images/efi_menu.png" scale="60" /> | ||
| 471 | </imageobject> | ||
| 472 | </mediaobject> | ||
| 473 | </figure> | ||
| 474 | |||
| 475 | <para>The default setting will try to boot GRUB from the FS0 device, in | ||
| 476 | this case a USB stick. To boot from the newly installed media storage | ||
| 477 | device instead (e.g FS1), run following command in the EFI | ||
| 478 | shell:<programlisting>Shell> FS1:EFI\boot\bootx64.efi</programlisting></para> | ||
| 479 | </section> | ||
| 480 | </section> | 468 | </section> |
| 481 | 469 | ||
| 482 | <section condition="hidden" id="release-content"> | 470 | <section condition="hidden" id="release-content"> |
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 5d980fc..9d5eecc 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 | |||
| @@ -10,7 +10,7 @@ | |||
| 10 | 10 | ||
| 11 | <itemizedlist> | 11 | <itemizedlist> |
| 12 | <listitem> | 12 | <listitem> |
| 13 | <para>A device that supports NFV Access.</para> | 13 | <para>A uCPE device with Enea NFV Access Run Time Platform installed.</para> |
| 14 | </listitem> | 14 | </listitem> |
| 15 | 15 | ||
| 16 | <listitem> | 16 | <listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png index 42188a5..8fdea95 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png | |||
| Binary files differ | |||
