From c2e65a29758b9e12994056e8b14121c15c6ffc04 Mon Sep 17 00:00:00 2001 From: Andreas Wellving Date: Fri, 6 Mar 2020 12:49:15 +0100 Subject: 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 --- .../doc/getting_started_nfv_access.xml | 222 +++++++-------------- 1 file changed, 75 insertions(+), 147 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 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
Installing Enea NFV Access - - 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 Device Call Home Connection 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 uCPE device. Make sure - you are connected to the serial port. + To install and configure a device using the Web-installer, + the user must first connect a laptop directly into one of the LAN ports. + No other ports should be connected. - Power up the uCPE device and boot the USB stick. Verify the + Power up the uCPE device and boot the USB stick. Verify that the USB stick is selected from the BIOS boot menu. - Once the USB stick is properly booted, a GRUB menu appears on - the serial console. The following options are available: + Once the USB stick is properly booted, the Web-installer application starts + automatically and can be accessed in a web browser at http://192.168.1.1 (port 80). + A DHCP Server is started on the device to serve the connected LAN port, in order to give + the laptop an IP-address. + + From there, the user can configure the device with things such as: - + - live-boot. Boots the Run Time Platform directly - from the USB stick. + The uCPE Manager IP Address. - installer. Launches the Run Time Platform - installer and uses the serial port for output. + The Device ID. The device must be previously + added to the uCPE Manager with a unique ID. The Device ID must be the same as the one + previously added in the uCPE Manager for he device. + + + To be able to connect, the same Device ID must first be added for the device + in uCPE Manager. + - - - - The graphical console requires a display to be connected - to the uCPE device. - - - - Select Install NFV Access from the menu to - proceed with the installation. - - - - Once the installation has commenced two options are displayed: - - - Automatic install. This - 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 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 - creates: a GPT partition for GRUB (similar to the one in the - 2-partition scheme), two 20 GB partitions, and one containing - the remaining free disk space. - - After choosing the Automatic install option and one of the - predefined partitioning actions, the install - steps detailing what will be installed and where are - updated by the installer. + Customer Tags. They can be left empty. - Manual install. Gives the - user the possibility of choosing where GRUB and NFV Access will - be installed and what parameters can be set. Features like ZTP Provisioning etc. - can be enabled as well. - - Kernel parameters can be customized by selecting the - Customize kernel parameters option and - altering any of the parameters below. - - Default - Parameters: - - - - Core isolation. Isolates the selected range of cores - from the kernel scheduler. - - - - 1G huge page count. The number of 1GB huge pages to - allocate at boot time. - - - - 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 algorithm 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 used to connect - to the uCPE Manager during Device Call Home Connection. - - - - Device ID. A unique UUID format string used for device - identification during Zero Touch Provisioning. - - - - - Modifying any of the Default parameters (e.g Core - isolation, 1G huge page count, etc.) will automatically update - the kernel parameters string. Updating the Custom parameters - within the kernel string directly will override any values set - previously for the Default parameters. - + The Layer 3 configuration of WAN Interface(s). + Static or Dynamic IP must be specified. + + During network configuration, WAN cables will be plugged into the device + in order to identify the ports and make them available for configuration. Each + connected port will automatically be set as a WAN port and must be configured + (DHCP is the default setting). + + + A WAN cable must first be added to the device, otherwise the port used to + access the Web-installer from the laptop will not be shown and cannot be + configured as a WAN port. + + + + The Management Interface. The interface that + will be used by the uCPE Manager to communicate with the device. + + The IP address of this interface will be listed for the device in the uCPE + Manager. The WAN and management interfaces will be marked as such in the + capabilities view and are restricted in use. The user can change + the Layer 3 configuration of WAN interfaces and add new ones from the uCPE manager + as needed. + - Once all settings are in place, select Start - install to install NFV Access. - - - It is recommended to perform a dry run with the - Start install (dry run) option before - proceeding with actually modifying the drive. - + The Web-installer stores the user provided configuration in a json metadata file located + in /boot/enea/install_data.json. There is also a command line tool that can + be used to access metadata entries: nfva-cfgtool. - At the end of the installation process, you can choose between - running the installer again or rebooting the uCPE device. - - - 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 other than the serial port. - + When the user has completed the configuration steps in the Web-installer, NFV Access + is installed on the hard drive. The largest drive found on the device will be used for + installation. +
Booting NFV Access - After installing Enea NFV Access on a media storage device (e.g. - eMMC, HDD or SSD), the uCPE device must be reset so that Enea NFV Access - can boot. The user must configure the first stage bootloader (e.g. - BIOS/UEFI) to boot the system from the media storage device where NFV - Access was installed. - - If the uCPE Manager uses the Device Call Home Connection 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. + When the installation has finished successfully, the user should remove the USB stick + and ensure that BIOS is configured to boot from the hard drive. - Once set, GRUB will start automatically and a menu will appear to - let the user select one of the boot options: + When the NFV Access installation is booted from the hard drive, it will first check + that the configuration metadata is complete. If any mandatory information is missing, the + Web-installer will be launched on port 82 for post-installation configuration: + http://192.168.1.1:82. The WAN cable needs to be removed and the device rebooted, + enabling the device's DHCP server to give the laptop an IP address over the LAN connection. + + When all mandatory fields have been filled in, the new configuration is saved, stored + and the device will be rebooted. - - - Enea NFV Access 2.2.1 (ostree:0): The - recommended configuration boot commands. - + + If NFV Access was installed by some other means, such as a PXE mass installation or by + simply writing an image to a partition, no /boot/enea/install_data.json + metadata file will exist and the Web-installer will launch at start-up expecting the + user to provide the post-installation configuration. + + + Once the configuration is complete, the system proceeds to launch the ODM/vCPE which will + configure the interfaces accordingly and try to register the device in the uCPE manager. If + connectivity is established with the uCPE manager server and a device with a matching Device ID is + found, the configuration is marked as successful, and the connection is established. In case of + failure, the Web-installer will be launched for reconfiguration. + - - Advanced: The Advanced option is a submenu - which can be used for other booting options. The default value is - minimal boot. - -
-- cgit v1.2.3-54-g00ecf