From 1796f799f44c713199ed92676c98ccb3934a1b7e Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Mon, 7 Oct 2019 14:33:28 +0200 Subject: GettingStarted: update Getting Started NFV Access MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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 --- .../doc/getting_started_nfv_access.xml | 140 ++++++++++----------- .../doc/getting_started_ucpe_manager.xml | 2 +- .../doc/images/host_interface_caps.png | Bin 32885 -> 34733 bytes 3 files changed, 65 insertions(+), 77 deletions(-) (limited to 'doc') 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 @@
Enea NFV Access Run Time Platform Installer - The current release supports one primary method of installation, - using the installer, which guarantees a clean installation of NFV Access - on a uCPE device. + The current release supports two methods of installation: + + + Manual installation using the Enea Installer, which + guarantees a clean installation of NFV Access on a uCPE device. + Mass installation and automated deployment using + Bare Metal Provisioning. + + + For more information about Bare Metal Provisioning please refer + to 5.3, Bare Metal Provisioning".
Prerequisites @@ -22,7 +30,7 @@ - EFI and virtualization support + EFI and virtualization support. @@ -34,15 +42,11 @@ - Stoarge Device (SSD recommended) - - - - 2 physical interfaces + Storage Device (SSD recommended). - Following BIOS settings to be enabled: + BIOS settings that need to be enabled: @@ -50,7 +54,7 @@ - Intel Virtualization Technology (VT-x ) + Intel Virtualization Technology (VT-x) @@ -198,9 +202,9 @@ rootfs_destination=
Creating a bootable USB stick - In order to install Enea NFV Access Run Time Platform, you must + In order to install the Enea NFV Access Run Time Platform, you must first create a bootable USB stick with the image you intend to - install. + install. Follow the example below to proceed. Create a bootable USB stick image @@ -208,38 +212,46 @@ rootfs_destination= Copy the HDDIMG image file provided by Enea, onto a - development machine (Linux or Windows with Cygwin support). + development machine. Connect the USB stick to the development machine and identify the device name given by the system with - lsblk:NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT + lsblk: + NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT sda 8:0 1 28.7G 0 disk sdb 8:0 0 111.8G 0 disk |-sdb1 8:1 0 111.8G 0 part - Copy the HDDIMG image to the USB stick, e.g:sudo dd if=./enea-nfv-access-<machine>.hddimg \ + Copy the HDDIMG image onto the USB stick, e.g: + sudo dd if=./enea-nfv-access-<machine>.hddimg \ of=/dev/sdb bs=4M conv=fsync Where enea-nfv-access-<machine>.hddimg - is the .hddimg file and sdb is the + is the .hddimg file and sdb is the assigned USB device name.
Installing Enea NFV Access - How to install Enea NFV Access Run Time + Installing the Run Time Platform can be done in two ways: + Automatic and Manual, depending on the features you wish to enable. + Please note that in order to enable features such as Zero Touch + Provisioning or Automatic Addition of uCPE devices in the Enea uCPE + Manager, Manual installation must be used. + + How to install the Enea NFV Access Run Time Platform using a bootable USB stick image - Plug the USB stick into the reference uCPE device. Make sure + Plug the USB stick into the uCPE device. Make sure you are connected to the serial port. @@ -254,18 +266,18 @@ of=/dev/sdb bs=4M conv=fsync - live-boot. Boots NFV Access Run Time Platform directly + live-boot. Boots the Run Time Platform directly from the USB stick. - installer. Launches the NFV Access Run Time Platform + installer. Launches the Run Time Platform installer and uses the serial port for output. - The graphical console requires that a display is connected + The graphical console requires a display to be connected to the uCPE device. @@ -276,16 +288,15 @@ of=/dev/sdb bs=4M conv=fsync - Once the installation has commenced two options are - displayed: + Once the installation has commenced two options are displayed: Automatic install. This - option will partition a user-defined drive and install NFV + option will partition a user-defined drive and install the Enea NFV Access Run Time Platform. You can create 2 or 4 partitions, and choosing either of these two options will prompt you for a drive - on which to install NFV Access Run Time Platform. The + on which to install the Run Time Platform. The 2-partition scheme divides the disk into one GPT partition containing the GRUB binary and configuration, leaving the rest of the disk for the root filesystem. The 4-partition scheme @@ -302,13 +313,8 @@ of=/dev/sdb bs=4M conv=fsync Manual install. Gives the user the possibility of choosing where GRUB and NFV Access will - be installed and what parameters can be set. - - - This option is only - recommended for advanced use and should otherwise not be - used. - + be installed and what parameters can be set. Features like ZT Provisioning etc. + can be enabled as well. Kernel parameters can be customized by selecting the Customize kernel parameters option and @@ -331,15 +337,29 @@ of=/dev/sdb bs=4M conv=fsync 2M huge page count. The number of 2M huge pages to allocate at boot time. + + + In case the number of hugepages is not specified during + this step, hugepages will be allocated by the NFV Access + Hugepage Reservation Service, based on an algoritm which + takes into consideration the size of RAM memory. For further + information, please see section + Hugepage Reservation Service in the + Manual. + - uCPE Manager IP address. The IP address needed for - contacting the machine running the uCPE Manager. + uCPE Manager IP address. The IP address used to connect + to the uCPE Manager during Automatic Addition. - Device ID. A unique UUID format string. + Device ID. A unique UUID format string used for device + identification during Zero Touch Provisioning. @@ -372,7 +392,7 @@ of=/dev/sdb bs=4M conv=fsync The boot log will always be displayed on the serial port. Modify the console parameter if you want the boot log to be shown - on something else than the serial port. + on something else other than the serial port. @@ -387,22 +407,18 @@ of=/dev/sdb bs=4M conv=fsync BIOS/UEFI) to boot the system from the media storage device where NFV Access was installed. + If the uCPE Manager uses the Automatic Addition method for enrolling + the uCPE devices, the uCPE Manager IP address has to be configured in NFV + Access, by setting vcpemgr=<IP> as a kernel + boot parameter in the GRUB configuration file. This step is not required + if configuration has been made during Manual Installation. + Once set, GRUB will start automatically and a menu will appear to let the user select one of the boot options: -
- Booting NFV Access - - - - - - -
- - Enea NFV Access 2.2 (rocko) (ostre:0): The + Enea NFV Access 2.2.1 (ostree:0): The recommended configuration boot commands. @@ -449,34 +465,6 @@ run
- -
- Troubleshooting - - Use-case: When booting from UEFI, GRUB from the installer storage - on the USB stick previously set up, is always selected by - default. - - Workaround: If both a USB stick with the Enea NFV Access installer - set up (e.g FS0) and an another media storage device (e.g. FS1), are - connected to a uCPE device, in order to select the former, the count - down must be stopped with the default startup.nsh - script by pressing ESC and then starting GRUB - manually: - -
- - - - - -
- - The default setting will try to boot GRUB from the FS0 device, in - this case a USB stick. To boot from the newly installed media storage - device instead (e.g FS1), run following command in the EFI - shell:Shell> FS1:EFI\boot\bootx64.efi -
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 @@ - A device that supports NFV Access. + A uCPE device with Enea NFV Access Run Time Platform installed. 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 Binary files a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png and b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png differ -- cgit v1.2.3-54-g00ecf