From 76118f73b3d1f9d2cb1e4bb956921ab4fda2c569 Mon Sep 17 00:00:00 2001 From: mrpa Date: Thu, 3 Dec 2020 05:14:53 +0100 Subject: Updated the getting started and rel notes, with the edites requested. Change-Id: I05d75e8537c2fe1a1781cbf62908ebfb2db1fd82 Signed-off-by: mrpa --- .../doc/advanced_configurations.xml | 26 +- .../doc/images/prep_deploy.png | Bin 125599 -> 322979 bytes .../doc/images/prep_execution.png | Bin 116871 -> 312054 bytes .../doc/installation_guide.xml | 385 ++++---- .../doc/introduction.xml | 45 +- .../doc/log_collector.xml | 63 +- .../doc/net_config_options.xml | 1024 ++++++++++---------- .../doc/troubleshooting.xml | 55 +- .../doc/upgrade_ena.xml | 56 +- .../doc/vnf_mg.xml | 67 +- .../doc/about_release.xml | 12 +- .../doc/known_bugs_and_limitations.xml | 24 +- .../doc/main_changes.xml | 14 +- 13 files changed, 876 insertions(+), 895 deletions(-) (limited to 'doc') 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 bd51b21..8925498 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 @@ -5,9 +5,8 @@ Advanced Configurations This chapter describes possible configurations for advanced features - such as the Hugepage Reservation Service, UEFI Secure Boot and Bare Metal - Provisioning. These features are optional in the Enea NFV Access platform. - If you do not intend to use these features, skip this chapter. + such as the Hugepage Reservation Service customization, UEFI Secure Boot and + Bare Metal Provisioning.
Bare Metal Provisioning @@ -62,9 +61,18 @@ - A remote management tool is available that can be used to set - the next boot option to PXE and reboot the uCPE devices in order to - begin the installation. + CSM support and Dual Boot must be enabled in BIOS (i.e. PXE + booting in legacy mode), while the final Enea NFV Access image will + boot in UEFI mode. Doing a mass deployment using legacy PXE booting + usually means that SecureBoot is disabled, SecureBoot will need to + be enabled afterwards. + + + + A remote management tool such as ipmitool + (or a vendor-specific tool) is available for use to set the next + boot option to PXE and reboot the uCPE devices in order to begin the + installation.
@@ -265,9 +273,9 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address&
Hugepage Reservation Service - NFV Access implements an automatic hugepage allocation service that - is triggered at each startup. The service is skipped if hugepages have - been allocated in the kernel boot command line. + Enea NFV Access implements an automatic hugepage allocation service + that is triggered at each startup. The service is skipped if hugepages + have been allocated in the kernel boot command line. There are two strategies outlined for hugepage allocation: diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png index e93e7f1..e75275e 100755 Binary files a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png and b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png differ diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png index 5d5a355..2917cd6 100755 Binary files a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png and b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png differ diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index 80ae36b..9e0ccb8 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml @@ -1,6 +1,7 @@ - Setting up and Installing the NFV Access Base Configuration + Setting up and Installing the Enea NFV Access Base + Configuration The setup and installation steps detailed below will deploy a base configuration which will be used as a reference for more complex deployment @@ -14,45 +15,22 @@ - One CentOS 7 server + One server running the CentOS 7 distribution Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk storage. Make sure the CentOS 7 server is updated to the latest revision before installing Enea NFV Access. - The purpose of the CentOS 7 server is to host the uCPE Manager. - Network access between the CentOS 7 server and the uCPE devices is - required. The uCPE Manager and the uCPE devices will be connected on - separate subnets to avoid inconsistencies. - - - - A laptop. - - The laptop is used for 2 scenarios: - - - - Installing the NFV Access Run Time Platform on uCPE - Devices. - - - - Connecting to the GUI of the uCPE Manager for management and - configuration. Network access between the CentOS 7 server and the - laptop is required. Please see the manual - available with your release, for recommended browsers. - - + The purpose of the CentOS 7 server is to host the Enea uCPE + Manager. Network access between the CentOS 7 server and the uCPE + devices is required. The Enea uCPE Manager and the uCPE devices will + be connected on separate subnets to avoid inconsistencies. One or more uCPE devices. - White Box devices where the Enea NFV Access Runtime Platform + Whitebox devices where the Enea NFV Access Run Time Platform will be installed, containing a minimum of 2 cores and 4 GB RAM and at least two ethernet ports that will be configured as WAN and LAN during deployment. @@ -72,6 +50,29 @@ required. + + A laptop. + + The laptop is used for 2 scenarios: + + + + Installing the Enea NFV Access Run Time Platform on uCPE + Devices. + + + + Connecting to the GUI of the Enea uCPE Manager for + management and configuration. Network access between the CentOS 7 + server and the laptop is required. Please see the manual + available with your release, for recommended browsers. + + + + A 16 GB USB stick used for the uCPE Device Installation. @@ -89,9 +90,9 @@ Any firewall running on the CentOS 7 server may block the management protocols required to communicate between the uCPE device and - the uCPE Manager as well as between the uCPE Manager and its northbound - clients. Quick handling of a blocking firewall would be to disable it, - typical for a lab environment, through: + the Enea uCPE Manager as well as between the Enea uCPE Manager and its + northbound clients. Quick handling of a blocking firewall would be to + disable it, typical for a lab environment, through: sudo systemctl stop firewalld sudo systemctl disable firewalld @@ -128,7 +129,7 @@ sudo systemctl mask -now firewalld UDP - Required for the uCPE Manager High Availability + Required for the Enea uCPE Manager High Availability Configuration. @@ -137,7 +138,7 @@ sudo systemctl mask -now firewalld TCP - Required for the uCPE Manager High Availability + Required for the Enea uCPE Manager High Availability Configuration. @@ -169,7 +170,7 @@ sudo systemctl mask -now firewalld Use the following command sequence to enable the required ports - for deployment of the uCPE Manager: + for deployment of the Enea uCPE Manager: sudo firewall-cmd --permanent --add-service=80/tcp sudo firewall-cmd --permanent --add-service=443/tcp @@ -184,8 +185,8 @@ sudo firewall-cmd --reload
Configuring OpenJDK and PostgreSQL - The uCPE Manager requires a specific Java version (OpenJDK 11) and - a PostgreSQL version to operate correctly. + The Enea uCPE Manager requires a specific Java version (OpenJDK + 11) and a PostgreSQL version to operate correctly. Installing OpenJDK @@ -201,7 +202,7 @@ sudo firewall-cmd --reload java -version openjdk version "11.0.3" 2019-04-16 LTS -OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS) +OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS) OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) @@ -235,9 +236,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar

- The uCPE Manager requires a specific PostgreeSQL version. This is - embedded in the uCPE Manager installation. In order to avoid conflicts, - any existing PostgreeSQL installation needs to be uninstalled. + The Enea uCPE Manager requires a specific PostgreeSQL version. + This is embedded in the Enea uCPE Manager installation. In order to + avoid conflicts, any existing PostgreeSQL installation needs to be + uninstalled. Uninstalling PostgreSQL @@ -264,8 +266,8 @@ rm -f /etc/postgres-reg.ini userdel postgres - This step is not necessary if the uCPE Manager will be using - an external database (like MariaDB). + This step is not necessary if the Enea uCPE Manager will be + using an external database (like MariaDB). @@ -291,8 +293,8 @@ userdel postgres - Follow the installation steps for the uCPE Manager available - in Follow the installation steps for the Enea uCPE Manager + available in Installing the uCPE Manager in the
Determining the WAN and LAN ports - A typical White box comes with multiple physical network ports, + A typical whitebox comes with multiple physical network ports, ready to be used. The user must determine the purpose and allocation of each port. The allocation is later aligned with the software configuration within the Enea NFV Access installer. @@ -320,10 +322,10 @@ userdel postgres
- Determining the uCPE Identifier + Determining the DeviceId Each uCPE device needs a unique identifier. This identifier is - used to match the registration in the uCPE Manager and the offline + used to match the registration in the Enea uCPE Manager and the offline configuration of the uCPE device during ZTP (Zero Touch Provisioning) @@ -341,7 +343,7 @@ userdel postgres installation. Access the BIOS using a serial cable between the uCPE device and - the laptop, to review and configure the BIOS correctly. The White box + the laptop, to review and configure the BIOS correctly. The whitebox vendor is expected to provide the right serial cable for the box. A terminal emulator (such as putty) is needed on the laptop. @@ -366,7 +368,7 @@ userdel postgres The boot order may also need to be modified to support - installation and execution of the Enea NFV Access Runtime Platform on + installation and execution of the Enea NFV Access Run Time Platform on the uCPE device. The following boot order is recommended for a base @@ -391,14 +393,14 @@ userdel postgres Preparing the deployment
- Installing the uCPE Manager + Installing the Enea uCPE Manager - The uCPE Manager can be installed using as a fresh/first-time + The Enea uCPE Manager can be installed using as a fresh/first-time configuration or using a backup file of a previous installation, created - within the uCPE Manager GUI. + within the Enea uCPE Manager GUI.
- Fresh Installation of the uCPE Manager + Fresh Installation of the Enea uCPE Manager On the CentOS 7 server open a terminal, log into a bash shell with the root account and perform the following: @@ -442,7 +444,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz The same configuration values set now will need to be - provided when upgrading or uninstalling the uCPE Manager. + provided when upgrading or uninstalling the Enea uCPE + Manager. @@ -545,7 +548,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Install the uCPE Manager as a service with the name + Install the Enea uCPE Manager as a service with the name ucpemanager. @@ -556,44 +559,45 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Open the IP Address of the CentOS 7 Server in a web browser - on the laptop and log in with the username and password: - admin/admin. + Using the IPv4 address of the CentOS 7 Server in a web + browser, running on the laptop, log into the Enea uCPE Manager GUI + using the default username and password: + admin/admin. - The IPv4 address of the CentOS 7 server, connected to the same + The IPv4 address of the CentOS 7 Server, connected to the same network as the uCPE Devices, will be used as a configuration - parameter both when setting up the uCPE devices and when accessing - the uCPE Manager GUI. + parameter both when setting up the uCPE devices.
- Installation of the uCPE Manager using a System Back-up + Installation of the Enea uCPE Manager using a System + Back-up - The uCPE Manager can be restored if a back-up file has been + The Enea uCPE Manager can be restored if a back-up file has been previously created. A backup file can be created by accessing: System -> System Backup from - the uCPE Manager GUI. The resulting zip archive will be located in the - /opt/ems/ucpemanager/application/backup folder - and will be named + the Enea uCPE Manager GUI. The resulting zip archive will be located + in the /opt/ems/ucpemanager/application/backup + folder and will be named SystemBackup_MMMDD_YYYY_HHMM_SS.zip (e.g System-Backup_Feb19_2013_2257_42.zip). Save the archive to another - location outside the uCPE Manager installation folder for future + location outside the Enea uCPE Manager installation folder for future use. - The System Back-up file obtained from the uCPE Manager GUI - (SystemBackup_MMMDD_YYYY_HHMM_SS.zip) is - different from the uCPE Manager snapshot obtained during a uCPE - Manager Upgrade or Uninstall operation + The System Back-up file obtained from the Enea uCPE Manager + GUI (SystemBackup_MMMDD_YYYY_HHMM_SS.zip) is + different from the Enea uCPE Manager snapshot obtained during a Enea + uCPE Manager Upgrade or Uninstall operation (ucpemanager-Backup-YYYYddMMHHmm.tar.gz) needed - for recovery of the uCPE Manager. For more details please see Restoring a previous uCPE Manager installation in the - To install the uCPE Manager with the restore option provide an - additional argument as shown below during installation: + To install the Enea uCPE Manager with the restore option provide + an additional argument as shown below during installation: ./install.sh \ /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ @@ -612,12 +616,15 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip
- Preparing the USB stick for installation of the NFV Access Run - Time Platform + Preparing the USB stick for installation of the Enea NFV Access + Run Time Platform To install the Enea NFV Access Run Time Platform, create a - bootable USB stick with the image you intend to install. Follow the - example below to proceed. + bootable USB stick with the image you intend to install. + + In the example below, step by step instructions are provided for + the CentOS 7 distribution. It's possible with the appropriate tools to + also use Windows OS or MacOS. The .hddimg image is available in the @@ -674,43 +681,23 @@ of=/dev/sdb bs=4M conv=fsync - The following hardware configuration is needed to install uCPE - devices: - - - - Network connection between the CentOS 7 server and the - laptop. - - - - The uCPE device is powered off. - - - - Direct Ethernet cable connection between the uCPE Device LAN - and the laptop. - - + While the uCPE device is powered off, in order to install and + configure the Enea NFV Access Run Time using the prepared USB stick, + connect the laptop to a uCPE device LAN port. For this purpose, a Layer + 2 switch or direct cable connection can be used.
Installing Enea NFV Access - uCPE Device installation - To initiate the installation of the NFV Access Run Time Platform - do the following: + To initiate the installation of the Enea NFV Access Run Time + Platform do the following: Plug the USB stick into the uCPE device. - - Connect a laptop directly into one of the uCPE device ports. - This can't be used as a WAN port at a later moment. No other ports - should be connected. - - Power up the uCPE device and boot the USB stick. @@ -727,42 +714,49 @@ of=/dev/sdb bs=4M conv=fsync - The static uCPE Manager IP Address. + The static Enea uCPE Manager IP Address. - The unique identifier of the uCPE device (called "uCPE - Identifier" in this guide). + The unique identifier of the uCPE device (called + "DeviceId" in this guide). Customer Tags. They are used for Zero Touch Provisining (ZTP) and can be left empty for a base configuration. What can be entered here (if needed), are the tag(s) specified when - creating an offline configuration in the uCPE Manager. A later - addition of customer tags can only be done by reinstalling the - uCPE devices. + creating an offline configuration in the Enea uCPE Manager. A + later addition of customer tags can only be done by reinstalling + the uCPE devices. - On the second page of the Web-installer, the user must fill - in: + Connect the WAN cable to the uCPE device (see Figure 2). This + will be used as the uCPE management network interface, as described + below. + + + + On the second page of the Web-installer, the user must do the + following: - The Management Interface. The network interface used by - the uCPE Manager to communicate with the uCPE device. + Configure the management network interface. This interface + is used by the Enea uCPE Manager to communicate with the uCPE + device. - During network configuration, WAN cables are plugged into - the uCPE device to identify ports and make them available for - configuration. The user needs to connect the same number of - cables as the number of WAN ports that he wishes to configure - (DHCP is the default setting). The configured WAN cables cannot - be removed after being configured. + Plug-in additional WAN interfaces (if applicable) and + provide their Layer 3 configuration. + + + + The Static or Dynamic IP. No LAN ports should be connected nor configured at this @@ -771,22 +765,15 @@ of=/dev/sdb bs=4M conv=fsync Web-Installer. - - - The Layer 3 configuration of WAN Interface(s). - - - - The Static or Dynamic IP. - 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 uCPE device will be used for installation. Now the - user must remove USB stick and reboot the device. + Web-installer, Enea NFV Access is installed on the hard drive. At this + stage, user should remove the USB stick and LAN cable and shutdown the + uCPE device. It will be started after necessary configurations are done + on the Enea uCPE Manager, as described below.
@@ -802,26 +789,18 @@ of=/dev/sdb bs=4M conv=fsync - The following hardware configuration is needed for service - deployment: + The following network configuration is needed for managing the + uCPE device and service deployment: - Network connection between the CentOS 7 server and the - laptop. - - - - Network connection between the CentOS 7 server and the uCPE - device WAN port. + Network connection between the server running the Enea uCPE + Manager and the laptop. - The USB is removed from the uCPE device. - - - - The uCPE device powered off. + Network connection between the server running the Enea uCPE + Manager and the uCPE device.
@@ -830,15 +809,15 @@ of=/dev/sdb bs=4M conv=fsync
Management of uCPE Devices - When the installation is complete the uCPE Device can be connected - to uCPE Manager. + When the installation is complete the uCPE device can be managed in + the Enea uCPE Manager.
Add a default Offline Configuration Zero Touch Provisioning is always turned on when a uCPE device - connects to the uCPE Manager. To enable it in the uCPE Manager, an - offline configuration needs to be registered for Day-0 + connects to the Enea uCPE Manager. To enable it in the Enea uCPE + Manager, an offline configuration needs to be registered for Day-0 configuration. @@ -851,10 +830,11 @@ of=/dev/sdb bs=4M conv=fsync The offline configuration consists of data and parameters that are - meant to be automatically set when a uCPE device connects to the uCPE - Manager for the first time. The configuration is typically focused on - setting up the network management of the uCPE device, e.g. configuring - network interfaces, WAN and LAN networking and service chains. + meant to be automatically set when a uCPE device connects to the Enea + uCPE Manager for the first time. The configuration is typically focused + on setting up the network management of the uCPE device, e.g. + configuring network interfaces, WAN and LAN networking and service + chains. For this base configuration, the offline configuration will be left blank. The blank offline configuration can be filled with @@ -864,14 +844,14 @@ of=/dev/sdb bs=4M conv=fsync If the offline configuration is not configured, an alarm will be raised: Day-0 Config:ZTP:Major when the uCPE device - tries to connect to uCPE Manager, informing the user that the ZTP + tries to connect to Enea uCPE Manager, informing the user that the ZTP setup failed for the uCPE device. To create an offline configuration - In a browser access the uCPE Manager, then + In a browser access the Enea uCPE Manager, then Applications->Offline Config. @@ -886,8 +866,8 @@ of=/dev/sdb bs=4M conv=fsync string identifying the configuration. The deviceVersion must match the Enea NFV Access version of the uCPE device and the deviceId - must be the previously set identifier of the uCPE device (uCPE - Identifier). + must be the previously set identifier of the uCPE device + (DeviceId).
@@ -895,15 +875,11 @@ of=/dev/sdb bs=4M conv=fsync
Add a uCPE device to the Management System - The uCPE Manager will periodically poll the uCPE device based on - the IP address broadcasted by the uCPE device, attempting to establish a - management connection. - - For the connection to succeed, add the uCPE device running the NFV - Access Run Time Platform to the management system: + In order to enroll a uCPE device in the management system and + establish a management connection, the user will add uCPE device + information in the Enea uCPE Manager. This is accomplished by selecting Devices -> Manage -> - Add. Supply information about the uCPE device and set - the parameters that will be used to connect to it. + Add. The relevant parameters are: @@ -915,7 +891,8 @@ of=/dev/sdb bs=4M conv=fsync Name. The name by which the - uCPE device is referred to in the uCPE Manager. + uCPE device is referred to in the Enea uCPE Manager. + (Mandatory). @@ -941,7 +918,7 @@ of=/dev/sdb bs=4M conv=fsync Device ID. The unique - identifier of the uCPE device. + identifier of the uCPE device. (Mandatory).
@@ -949,18 +926,36 @@ of=/dev/sdb bs=4M conv=fsync
Booting the uCPE device and adding it to the Map - When connectivity is established with the uCPE Manager and a uCPE - device is already registered with a matching Device + When connectivity is established with the Enea uCPE Manager and a + uCPE device is already registered with a matching Device ID, the installation is complete, and the connection is established. In case of failure due to a misconfiguration or if a uCPE device - does not appear in the uCPE Manager, a reinstallation is needed .The - user should remove all WAN cables, reinsert the USB stick, reconnect - the laptop using the ethernet cable, reboot the uCPE device and then - access the Web-installer + does not appear in the Enea uCPE Manager, a reinstallation is needed + .The user should remove all WAN cables, reinsert the USB stick, + reconnect the laptop using the ethernet cable, reboot the uCPE device + and then access the Web-installer (http://172.16.1.1). + + In case of management connection failure (e.g. due to a + misconfiguration), the uCPE device status will be seen as RED + (disconnected) in Enea uCPE Manager. Please check the accuracy of the + information provided when the uCPE device was registered in the Enea + uCPE Manager. + + The uCPE device configuration can be amended. In order to do + that, please remove the WAN cable(s), reconnect the laptop to the LAN + interface of the uCPE device and reboot it. At this point, the + Web-installer can be accessed from the laptop as described in Installing Enea NFV Access - uCPE + Device installation in the + Manual. When a uCPE device is registered it can be manually added to the @@ -972,31 +967,31 @@ of=/dev/sdb bs=4M conv=fsync
uCPE Device Monitorization and Control - Once the uCPE device is connected to the uCPE Manager, it is ready - for central management. Two important functions available in the uCPE - Manager GUI are alarm checking and resource allocation. + Once the uCPE device is connected to the Enea uCPE Manager, it is + ready for central management. Two important functions available in the + Enea uCPE Manager GUI are alarm checking and resource allocation.
Checking Alarms - The uCPE Manager dashboard presents alarms in a specific window on - the front page. + The Enea uCPE Manager dashboard presents alarms in a specific + window on the front page. An alarm can be easily triggered by disconnecting and reconnecting the WAN ethernet cable from the uCPE device. The management system will detect the broken link and raise an alarm: Device Disconnected::Critical. - A separate Alarm Management window can be accessed from the uCPE - Manager menu for in-depth access and programming of Alarms and + A separate Alarm Management window can be accessed from the Enea + uCPE Manager menu for in-depth access and programming of Alarms and Events.
Checking uCPE device Resource Allocation - When the uCPE device is connected to the uCPE Manager it is of - interest to check the amount of hardware resources in use. + When the uCPE device is connected to the Enea uCPE Manager it is + of interest to check the amount of hardware resources in use. To check CPU, RAM and disk utilization simply select the uCPE device and click the Virtual Machines tab in the map @@ -1007,15 +1002,27 @@ of=/dev/sdb bs=4M conv=fsync
Accessing the uCPE device CLI - As a final check to make sure the uCPE device was installed - correctly, access its Linux CLI by marking the uCPE device on the map - and selecting SSH from the panel. A new window will - appear for CLI access. The default user and password are + As a final check to make sure the uCPE device was installed and + configured correctly, access the uCPE device Linux CLI by selecting the + uCPE device on the map and using the SSH button from the panel. A new + window will appear for CLI access. The default user and password are root and blank, respectively. The Enea NFV Access CLI is a pure Linux CLI providing access to standard Linux CLI commands. The CLI is a central feature for running custom scripting. + + + In case the uCPE was installed behind a NAT device, reverse SSH + connection will be used. For more details, please see Device Call Home Connection for + deployment behind NAT in the + Manual. +
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml index 0509566..c303902 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml @@ -17,11 +17,6 @@ One or several managed uCPE devices, ready to host network services, using one wired WAN and one wired LAN connection. - - - One laptop accessing both the uCPE Manager and the uCPE - device. - Extended deployment and configuration options are also detailed in the @@ -65,17 +60,19 @@
Enea NFV Access Run Time Platform - The Enea NFV Access Run Time Platform is a lightweight, - multi-architecture virtualization platform, supporting Virtual Machines - (KVM / QEMU) and container(s) (Docker). Designed for a low footprint and - fast boot by only providing essential functionality. - - The NFV Access virtualized data plane has DPDK and accelerated OVS - as its primary components. The data plane is highly optimized for - scenarios where high throughput and low latency are needed. + Enea NFV Access Runtime Platform is a lightweight, + multi-architecture virtualization platform built on de-facto standards + in an SDN/NFV ecosystem. It is designed for a high networking + performance with minimal hardware footprint, by only providing relevant + functionalties and technologies. - VNF Runtime Management, orchestration integration, and FCAPS are - provided through NETCONF. + Virtualization methods include Virtual Machines (KVM / QEMU) and + container(s) (Docker). High networking throughput and low latency are + ensured by accelerated data plane relying on technologies like DPDK, + OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as + platform software management, virtualized networking, VNFs life-cycle + management and FCAPS are provided through the YANG-modelled NETCONF + protocol.
VNF Space @@ -92,10 +89,10 @@
Enea uCPE Manager - The Enea uCPE Manager is a control center application providing a - full FCAPS and VNF management experience through a GUI and REST API. It - can be deployed on a host or a virtual machine running 64-bit CentOS 7 - on an x86 platform. The uCPE Manager uses a southbound NETCONF protocol + The Enea uCPE Manager is centralized control system providing + uCPEs domain management capabilities through a GUI and REST API. It can + be deployed on a host or a virtual machine running 64-bit CentOS 7 on an + x86 platform. The Enea uCPE Manager uses a southbound NETCONF protocol to connect and manage uCPE devices. The Enea uCPE Manager provides the following key features: @@ -142,7 +139,7 @@ Enea NFV Access - The Enea NFV Access Run Time Platform and the uCPE + The Enea NFV Access Run Time Platform and the Enea uCPE Manager. @@ -160,14 +157,6 @@ Manager. - - PCI Passthrough - - PCI Passthrough allows for use of a physical PCI device, - e.g. a network card inside a VM. If you "PCI passthrough" a - device, the device is not available to the host anymore. - - uCPE device diff --git a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml index 22b67b9..1c66db0 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml @@ -3,15 +3,15 @@ Using the Log Collector Troubleshooting problems on the uCPE device require an analysis of a - set of information i.e. logs collected from the uCPE device and/or uCPE + set of information i.e. logs collected from the uCPE device and/or Enea uCPE Manager. The following describe how the log collection mechanism works.
- Log collecting using the uCPE Manager + Log collecting using the Enea uCPE Manager - The uCPE Manager allows for collection of the relevant logs from the - GUI. + The Enea uCPE Manager allows for collecting a set of logs and state + information from a uCPE device.
Collecting the Logs @@ -53,9 +53,9 @@ It might take some time for the archive to be created. When the operation completes, a "CollectLogsComplete" notification is sent from - the uCPE device to the uCPE Manager. This can be viewed in the GUI - under the Faults -> Events - toolbar menu. + the uCPE device to the Enea uCPE Manager. This can be viewed in the + GUI under the Faults -> + Events toolbar menu.
Collecting Debug Logs @@ -110,7 +110,7 @@ Downloading Logs from the uCPE Device This option transfers a debug file archive from the uCPE device to - uCPE Manager machine. + Enea uCPE Manager. @@ -124,7 +124,7 @@ In the Device File Listing table, select - the archive you want to download from the uCPE device to uCPE + the archive you want to download from the uCPE device to Enea uCPE Manager. @@ -133,7 +133,7 @@ button. The archive will be downloaded from the uCPE device and stored - on the uCPE Machine. + on the Enea uCPE Manager. @@ -146,9 +146,9 @@
Downloading collected logs locally - This option downloads a logs archive from the uCPE Manager to a - local (user) machine for analysis. The archive must first be available - in the uCPE Manager in order to be downloaded. + This option downloads a logs archive from the Enea uCPE Manager to + a local (user) machine for analysis. The archive must first be available + in the Enea uCPE Manager in order to be downloaded. @@ -236,9 +236,10 @@
- Deleting logs archives from the uCPE Manager + Deleting logs archives from the Enea uCPE Manager - This option deletes a logs archive from the uCPE Manager. + This option deletes a logs archive from the Enea uCPE + Manager. @@ -258,14 +259,14 @@ Click the Delete button. - The file will be deleted from the uCPE Manager and the table - will be updated. + The file will be deleted from the Enea uCPE Manager and the + table will be updated. - Deleting the logs file from the uCPE Manager does not affect the - file located on the uCPE device. + Deleting the logs file from the Enea uCPE Manager does not + affect the file located on the uCPE device.
@@ -273,8 +274,8 @@ Enabling/Disabling of the Log Collector via Permissions To disable the ability to access/download the uCPE device's - debug-log files from the uCPE Manager, the appropriate permissions must - be changed: + debug-log files from the Enea uCPE Manager, the appropriate permissions + must be changed: @@ -319,19 +320,19 @@
- Downloading uCPE Manager logs + Downloading Enea uCPE Manager logs - Often, sending the uCPE Manager logs together with collected uCPE - device logs to the support team provides important information for + Often, sending the Enea uCPE Manager logs together with collected + uCPE device logs to the support team provides important information for troubleshooting (especially in cases of connectivity issues with the uCPE device and error popups). - uCPE Manager log files are located in - application/logs/ in the uCPE Manager's + Enea uCPE Manager log files are located in + application/logs/ in the Enea uCPE Manager's installation folder (e.g./opt/ems/ucpemanager/application/logs). They can be copied from that location, or they can be downloaded using the - uCPE Manager GUI by performing the following: + Enea uCPE Manager GUI by performing the following: @@ -372,12 +373,12 @@
- Log collecting without using the uCPE Manager + Log collecting without using the Enea uCPE Manager Log collection from uCPE Devices can also be done when there is no - uCPE Manager connection. A SSH connection to uCPE Device is needed for use - of the log collector script, which can be found in the uCPE Device file - system in /usr/local/enea/. + Enea uCPE Manager connection. A SSH connection to uCPE Device is needed + for use of the log collector script, which can be found in the uCPE Device + file system in /usr/local/enea/. The Log collector script takes relevant information about the system and collects it in an archive: diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml index 4c11b7c..873dc28 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml @@ -2,23 +2,23 @@ Network Configuration Options - Various Advanced Network Configuration options can be done from uCPE - Manager GUI. + Various Advanced Network Configuration options can be done from Enea + uCPE Manager GUI.
Device Call Home Connection for deployment behind NAT The Device Call Home option enables the initiation of the connection - between the uCPE Device and the uCPE Manager, from the uCPE device. The - Device Call Home option is required when deploying a uCPE device behind - NAT since the IP address of the uCPE device is hidden for the uCPE - Manager. + between the uCPE Device and the Enea uCPE Manager, from the uCPE device. + The Device Call Home option is required when deploying a uCPE device + behind NAT since the IP address of the uCPE device is hidden for the Enea + uCPE Manager. Enable Device Call Home by marking the Device Call Home checkbox - when registering the uCPE device in uCPE Manager. When using this - mechanism, the device will initiate a connection to the uCPE Manager for - NETCONF traffic (over SSH), while the uCPE Manager waits for a device - connection. + when registering the uCPE device in Enea uCPE Manager. When using this + mechanism, the device will initiate a connection to the Enea uCPE Manager + for NETCONF traffic (over SSH), while the Enea uCPE Manager waits for a + device connection.
@@ -57,18 +57,18 @@ LCore Mask. Allocated cores - for DPDK management functions (CPU core bitmask). Default: + for non-datapath OVS-DPDK threads (CPU core bitmask). Default: 0x2. PMD CPU Mask. Allocated cores - for DPDK packet processing (CPU core bitmask). Default: 0x4. + for datapath processing (CPU core bitmask). Default: 0x4. - Socket Memory. Allocated - memory to use. Default: 1494. + Socket Memory. Hugepage + memory allocated for DPDK. Default: 1494.
@@ -88,10 +88,10 @@ virtualization infrastructure and VNFs, they must be configured into the management system. - To add an interface into the uCPE Manager, select the uCPE device, - then from the top toolbar select Configuration -> External - Interfaces -> Configuration -> Add. The available - Interface types are detailed below. + To add an interface into the Enea uCPE Manager, select the uCPE + device, then from the top toolbar select Configuration -> + External Interfaces -> Configuration -> Add. The + available Interface types are detailed below.
DPDK Interface Type @@ -116,10 +116,6 @@ Source: name of the physical interface. - - Type: dpdk - - Networking-type: dpdk @@ -148,10 +144,6 @@ Source: name of the physical interface. - - Type: sr-iov - - Networking-type: srIov @@ -172,9 +164,7 @@ Some of the physical network interfaces available on a uCPE device, including Ethernet interfaces, do not have DPDK or SR-IOV - support. Instead, the Linux kernel driver has to be used. Wi-Fi and - 4G/LTE modems can also be configured and used for virtualization - infrastructure and VNFs. + support. Instead, the Linux kernel driver has to be used. To add Standard Interfaces under the management system, the user must set values for the following fields: @@ -190,13 +180,54 @@
-
- PCI Passthrough Interface Type +
+ Wan Interface Type + + WAN interfaces configured during the installation of the uCPE + device are automatically added in the Enea uCPE manager as type + wan. The WAN interface used for management of the + uCPE device is marked with the Management property + set to True. - For the PCI Passthrough a user does not have to configure a - physical interface, instead simply select the PCI address and connect - it to a virtual port when the VNF instantiation step is - reached. + If a WAN interface is to be assigned for use by a VNF, it must + be changed into another interface type depending on the type of + connection that will be used. The management WAN interface cannot be + changed to a different type. It is automatically used when an In-band + management bridge is created. + + How to Edit the Configuration of a Wan + Interface + + + + To edit an interface configuration type from the Enea uCPE + Manager, select the uCPE device, then from the top toolbar select + the Configuration menu then External + Interfaces -> Configuration. The already configured + interfaces are displayed here, as can be seen in the figure + above. + + + + In order to edit an already configured interface, (as in the + example popup shown below, a WAN interface) double click on the + desired one and a popup will appear. A different popup appears for + each type of interface. From the Host Interface + window, a user can change the networking type and the IP address + assignment: + +
+ Editing an Interface + + + + + + +
+ +
@@ -207,534 +238,465 @@ External Interfaces, where one can find a list of available network interfaces and their capabilities. -
- Configuring Interfaces + After networking interfaces have been added to the Enea uCPE + Manager, the user can change the interface type (DPDK, SR-IOV, + Standard, WAN). - After networking interfaces have been added to the uCPE - Manager, the user can change the interface type (DPDK, SR-IOV, - Standard, WAN). +
+ Configuration of External Interfaces - - WAN interfaces, which are configured during the installation - of the device, do not need to be added, they will be automatically - listed as such in the uCPE Manager when the device - connects. - + + + + + +
+
+
-
- Configuration of External Interfaces - - - - - - -
- - How to Edit the Configuration of an - Interface - - - - To edit an interface configuration type from the uCPE - Manager, select the uCPE device, then from the top toolbar - select the Configuration menu then - External Interfaces -> Configuration. The - already configured interfaces are displayed here, as can be seen - in the figure above. - - - - In order to edit an already configured interface, (as in - the example popup shown below, a WAN interface) double click on - the desired one and a popup will appear. A different popup - appears for each type of interface. From the Host - Interface window, a user can change the networking - type and the IP address assignment: - -
- Editing an Interface - - - - - - -
- - +
+ Configuring Bridges - - The IP address assignment of an interface can be set as - static or dynamic for each type of interface. - -
+ After networking interfaces have been added to the Enea uCPE + Manager, the user can create the necessary OVS bridges. + +
+ OVS Bridges + + + + + + +
+ + How to add OVS bridges in the Enea uCPE + Manager + + + + Select the uCPE device. + -
- Configuring Bridges + + Select Configuration. + - After networking interfaces have been added to the uCPE - Manager, the user can create the necessary OVS bridges. + + Click OpenvSwitch. + -
- OVS Bridges + + Select the Bridges option, then click + Add. + + - - - - - -
+ + Depending on the settings in Configuration -> + OpenVSwitch -> DPDK, OVS bridges with or without DPDK + support will be used on the uCPE device. + - How to add OVS bridges in the uCPE - Manager + There are three types of bridges which can be created, each one + fulfiling a different role. - - - Select the uCPE device. - +
+ uCPE In-band Management bridge - - Select Configuration. - + In-band Management refers to a model where both the data plane + and control plane flow over the same network path. In some situations + (e.g. the uCPE device has only one routable IP address), this is the + only option available to both control and configure the uCPE device, + while also allowing for data-path traffic to pass over the same + physical interface. - - Click OpenvSwitch. - + The solution provided by Enea for in-band management is based + upon an OpenvSwitch bridge managing all traffic passing through the + WAN physical port. Any standard or DPDK-assigned network interface can + be used for the In-Band management bridge. - - Select the Bridges option, then click - Add. - - + To create the In-Band Management bridge, the user must set + values for the following fields: - - Depending on the settings in Configuration -> - OpenVSwitch -> DPDK, OVS bridges with or without DPDK - support will be used on the uCPE device. - + + + name: name of the bridge. + - There are three types of bridges which can be created, each - one fulfiling a different role. + + ovs-bridge-type: inbandMgmt + + +
-
- uCPE In-band Management bridge +
+ In-band Management bridge for VNFs - In-band Management refers to a model where both the data - plane and control plane flow over the same network path. In some - situations (e.g. the uCPE device has only one routable IP - address), this is the only option available to both control and - configure the uCPE device, while also allowing for data-path - traffic to pass over the same physical interface. + If VNF management can be done over a dedicated virtual + interface, its possible to extend the networking infrastructure + configuration to also access the VNF's management interface over the + WAN port. - The solution provided by Enea for in-band management is - based upon an OpenvSwitch bridge fielding all traffic passing - through the WAN physical port. Any standard or DPDK-assigned - network interface can be used for the In-Band management - bridge. + For this setup, three types of traffic will pass over the WAN + physical interface: + + + + Device management. Part of + the device configuration done by the Enea uCPE Manager. + + + + VNF(s) management. Enabling + or disabling features of a VNF. E.g. enabling/disabling the + firewall or VPN setup. + + + + Data-path. All other + traffic that is not used in the control plane and needs to reach a + LAN network. + + + + To create a VNF In-Band Management bridge, the user must set + values for the following fields: + + + + name: name of the bridge. + + + + ovs-bridge-type: vnfMgmt + + + + vnf-mgmt-address: select IPv4 as the type and fill in an + internal IP address for the bridge interface that will be + connected to the VNF management network, e.g 10.0.0.1. + + + + + VNF management interfaces must be configured in same subnet as + that used by the bridge interface connected to the VNF management + network. + +
+ +
+ Data-plane Bridge + + Data-plane bridges are generic bridges used for the VNF + data-plane. There are two supported sub-types: + + + + communication: allows for + VNF communication towards LAN/WAN networks. This bridge type has + at least one physical port attached to it. + + + + integration: allows for + VNF-to-VNF communication (usually for service function chaining). + This bridge type does not have any physical port attached. + + - - The In-band Management bridge must be recreated each time - the uCPE Manager IP address is changed. - - - To create the In-Band Management bridge, the user must set - values for the following fields: - - - - name: name of the bridge. - - - - ovs-bridge-type: inbandMgmt - - - - - The first VNF instantiated on the uCPE device must be - connected to the In-Band Management bridge and its WAN interface - must be configured as the DHCP client. - -
- -
- In-band Management bridge for VNFs - - If VNF management can be done over a dedicated virtual - interface, its possible to extend the networking infrastructure - configuration to also access the VNF's management interface over - the WAN port. - - For this setup, three types of traffic will pass over the - WAN physical interface: - - - - Device management. Part - of the device configuration done by the uCPE Manager. - - - - VNF(s) management. - Enabling or disabling features of a VNF. E.g. - enabling/disabling the firewall or VPN setup. - - - - Data-path. All other - traffic that is not used in the control plane and needs to - reach a LAN network. - - - - To create a VNF In-Band Management bridge, the user must set - values for the following fields: - - - - name: name of the bridge. - - - - ovs-bridge-type: vnfMgmt - - - - vnf-mgmt-address: select IPv4 as the type and fill in - the IP address for management network, e.g 10.0.0.1. - - - - - VNF management interfaces must be configured in same - network as the vnf-mgmt-address of the - bridge. - -
- -
- Data-plane Bridge - - Data-plane bridges are generic bridges used for the VNF - data-plane. There are two supported sub-types: - - - - communication: allows - for VNF communication towards LAN/WAN networks. This bridge - type has at least one physical port attached to it. - - - - integration: allows for - VNF-to-VNF communication (usually for service function - chaining). This bridge type does not have any physical port - attached. - - - - To create a Data-plane bridge, the user must set values for - the following fields: - - - - name: name of the bridge. - - - - ovs-bridge-type: select communication - or integration, depending on intended - usage. For communication bridges, physical interfaces can be - added to the bridge. - - -
-
+ To create a Data-plane bridge, the user must set values for the + following fields: + + + + name: name of the bridge. + + + + ovs-bridge-type: select communication or + integration, depending on intended usage. For + communication bridges, physical interfaces can be added to the + bridge. + +
+
+
+ +
+ Zero Touch Provisioning - Creating an offline configuration + + Zero-Touch Provisioning (ZTP) refers to the process of when a device + starts up for the first time and its initial configuration is pushed down + by an external management system, so that it is setup for proper operation + without additional manual intervention by an operator. ZTP is an + alternative to Manual configuration. + + A variety of operations can occur as part of ZTP such as initial + device setup, configuration of managed objects, etc. The goal is to set up + a device to the maximum possible extent without forcing an operator to be + physically present (initially) to manage the device. + + An offline configuration is usually prepared in advance for the Enea + uCPE Manager to setup the virtualization infrastructure on the uCPE + device, as soon as a device enrolls into the management system. + +
+ Offline Configuration -
- Zero Touch Provisioning - Creating an offline - configuration - - Zero-Touch Provisioning (ZTP) refers to the process of when a - device starts up for the first time and its initial configuration is - pushed down by an external management system, so that it is setup for - proper operation without additional manual intervention by an - operator. ZTP is an alternative to Manual configuration. - - A variety of operations can occur as part of ZTP such as initial - device setup, configuration of managed objects, etc. The goal is to - set up a device to the maximum possible extent without forcing an - operator to be physically present (initially) to manage the - device. - - An offline configuration is usually prepared in advance for the - uCPE Manager to setup the virtualization infrastructure on the uCPE - device, as soon as a device enrolls into the management system. - -
- Offline Configuration - - The Offline Configuration subsystem is used to pre-populate a - configuration for a device that will be brought under management at - a future point in time. When creating an offline configuration store - a Device ID can be specified. This ID uniquely - identifies the device to be initialized. - - Alternatively, a wildcard can be used in the Device - ID field, which results in a configuration being pushed on - all uCPE devices upon their initial connection towards the uCPE - Manager. - - If the offline configuration is not configured for a uCPE - device, an alarm will be raised: Day-0 - Config:ZTP:Major, which occurs when the uCPE device - connects to the uCPE Manager informing that the ZTP setup failed for - the specific uCPE device. - - To create an offline configuration, from the top toolbar menu - select Applications -> Offline - Config -> Add. The following fields - should be filled: - - - - Name: name of the device. - - - - Device type: Enea universal CPE. - - - - DeviceVersion: - - - - Config Set: uCPE Config - - - - Device ID: device ID or a wildcard(*). - - - - Device Grouping Tags: a tag to group devices. These tags - match the customer tags provided during the installation of the - device. - - - - The Name is user defined and can be set to any unique text - string identifying the configuration. The Device Version will match - the Enea NFV Access version of the uCPE device and the Device ID - will be set to the previously set identifier of the uCPE + The Offline Configuration subsystem is used to pre-populate a + configuration for a device that will be brought under management at a + future point in time. When creating an offline configuration store a + Device ID can be specified. This ID uniquely + identifies the device to be initialized. + + Alternatively, a wildcard can be used in the Device + ID field, which results in a configuration being pushed on all + uCPE devices upon their initial connection towards the Enea uCPE + Manager. + + If the offline configuration is not configured for a uCPE device, + an alarm will be raised: Day-0 Config:ZTP:Major, + which occurs when the uCPE device connects to the Enea uCPE Manager + informing that the ZTP setup failed for the specific uCPE device. + + To create an offline configuration, from the top toolbar menu + select Applications -> Offline + Config -> Add. The following fields + should be filled: + + + + Name: name of the device. + + + + Device type: Enea universal CPE. + + + + DeviceVersion: + + + + Config Set: uCPE Config + + + + Device ID: device ID or a wildcard(*). + + + + Device Grouping Tags: a tag to group devices. These tags match + the customer tags provided during the installation of the device. + + + + The Name is user defined and can be set to any unique text string + identifying the configuration. The Device Version will match the Enea + NFV Access version of the uCPE device and the Device ID will be set to + the previously set identifier of the uCPE device. + + When a device connects to the Enea uCPE Manager for the first + time, it checks the device to see if it has been Zero Touch Provisioned + (ZTP). If not, it looks for an offline configuration that matches these + values, in the following order: + + + + The Device ID. + + + + The set of tags. + - When a device connects to the uCPE Manager for the first time, - it checks the device to see if it has been Zero Touch Provisioned - (ZTP). If not, it looks for an offline configuration that matches - these values, in the following order: + + A "*" for Device ID (wildcard). + + + + If a match is found, the offline configuration is sent to the + device as part of Zero-Touch-Provisioning. + + After creating the Offline Config Store, access the device through + Applications -> offline config + -> Config App and provision it with the required + initial configuration. This operation mirrors what happens during manual + configuration described previously. + + + The ZTP will only be triggered the first time a uCPE device + connects to the Enea uCPE Manager. Just changing an offline + configuration will not push the new changes to the device. If an + offline configuration is changed after uCPE device registration, a + factory reset can be executed to force a new ZTP to execute by + selecting the device, then Operations -> + factory reset. + +
+
+ +
+ Custom Scripts for Custom Networking Configurations + + The custom scripts feature allows users to execute user-defined + scripts on the uCPE device at various times.This allows for more flexible + and advanced configurations such as a LTE modem configuration, advanced + network configurations or OVS flow rule programming at any time. + +
+ Uploading Scripts - - - The Device ID. - + The scripts need to be uploaded to the Enea uCPE Manager prior to + use. When uploading scripts to the Enea uCPE Manager make sure to select + the right script type. - - The set of tags. - + The following script types are supported: - - A "*" for Device ID (wildcard). - - + + + Once-before-startup. This script will only + execute once during the startup. + - If a match is found, the offline configuration is sent to the - device as part of Zero-Touch-Provisioning. + + Always-before-startup. This script will + always execute during the startup. + - After creating the Offline Config Store, access the device - through Applications -> offline - config -> Config App and provision - it with the required initial configuration. This operation mirrors - what happens during manual configuration described - previously. + + Once-after-startup. This script will only + execute once after the system has been started. + + + + Always-after-startup. This script will + always execute after the system has been started. + + + + Follow the instruction below to upload scripts: + + + + Select Devices -> Custom + Scripts -> Configure. + + + + Select Upload to EMS. + + + + In the Script Type menu, select the type + the uploaded script should have. + + + + Press Choose File to select the scripts + needed, and then press Send. + + +
+ +
+ Removing Scripts + + Follow the instruction below to remove scripts: + + + + Select Devices -> Custom + Scripts -> Configure. + + + + Select the script you want to delete from the + Uploaded Scripts tab and then click + Delete, which will remove the script immediately + from the Enea uCPE Manager. + + +
+ +
+ Configuring Script Location + + The location where the scripts are staged in the Enea uCPE Manager + can be chanaged as described below: + + + + Select Devices -> Custom + Scripts -> Configure. + + + + Select the Configuration tab and specify a + new loacation to store the scripts. - The ZTP will only be triggered the first time a uCPE device - connects to the uCPE Manager. Just changing an offline - configuration will not push the new changes to the device. If an - offline configuration is changed after uCPE device registration, a - factory reset can be executed to force a new ZTP to execute by - selecting the device, then Operations -> - factory reset. + Change the script storage location only if you have many + scripts which you would prefer to store on another partition, + otherwise leave this configuration as is. -
-
+ + +
-
- Custom Scripts for Custom Networking Configurations - - The custom scripts feature allows users to execute user-defined - scripts on the uCPE device at various times.This allows for more - flexible and advanced configurations such as a LTE modem - configuration, advanced network configurations or OVS flow rule - programming at any time. - -
- Uploading Scripts - - The scripts need to be uploaded to the uCPE Manager prior to - use. When uploading scripts to the uCPE Manager make sure to select - the right script type. - - The following script types are supported: - - - - Once-before-startup. This script will - only execute once during the startup. - - - - Always-before-startup. This script will - always execute during the startup. - - - - Once-after-startup. This script will - only execute once after the system has been started. - - - - Always-after-startup. This script will - always execute after the system has been started. - - - - Follow the instruction below to upload scripts: - - - - Select Devices -> Custom - Scripts -> Configure. - - - - Select Upload to EMS. - - - - In the Script Type menu, select the - type the uploaded script should have. - - - - Press Choose File to select the scripts - needed, and then press Send. - - -
- -
- Removing Scripts - - Follow the instruction below to remove scripts: - - - - Select Devices -> Custom - Scripts -> Configure. - - - - Select the script you want to delete from the - Uploaded Scripts tab and then click - Delete, which will remove the script - immediately from the uCPE Manager. - - -
- -
- Configuring Script Location - - The location where the scripts are staged in the uCPE Manager - can be chanaged as described below: - - - - Select Devices -> Custom - Scripts -> Configure. - - - - Select the Configuration tab and - specify a new loacation to store the scripts. - - - Change the script storage location only if you have many - scripts which you would prefer to store on another partition, - otherwise leave this configuration as is. - - - -
- -
- Running the Scripts - - How to run Custom - Scripts - - - - Select Devices -> Custom - Scripts -> Apply Scripts. - - - - In the Script Config Screen pop up, - select the devices from the device(s) chooser list on which to - run the scripts. Press the > button to - move the devices to the right side of the chooser, which is the - list of devices that will execute the selected scripts. - - - - Select the scripts from the list under the device(s) - chooser by pressing the + button. - - - - In the pop-up window, select the scripts from the list. If - there are no scripts to select, then there is no script uploaded - with that particular type. Upload the script(s) needed and try - again. - - - - Check the checkbox Reboot devices if - you want to reboot and execute the scripts at once and then - press ok. - - - The status of execution for the scripts can be seen by - opening the Fault -> - Events screen and filtering by device - and/or the event name Custom. - - - -
-
+
+ Running the Scripts + + How to run Custom Scripts + + + + Select Devices -> Custom + Scripts -> Apply Scripts. + + + + In the Script Config Screen pop up, select + the devices from the device(s) chooser list on which to run the + scripts. Press the > button to move the + devices to the right side of the chooser, which is the list of + devices that will execute the selected scripts. + + + + Select the scripts from the list under the device(s) chooser + by pressing the + button. + + + + In the pop-up window, select the scripts from the list. If + there are no scripts to select, then there is no script uploaded + with that particular type. Upload the script(s) needed and try + again. + + + + Check the checkbox Reboot devices if you + want to reboot and execute the scripts at once and then press + ok. + + + The status of execution for the scripts can be seen by + opening the Fault -> + Events screen and filtering by device and/or + the event name Custom. + + +
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml index 9bf8822..e176cec 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml @@ -2,17 +2,17 @@ Troubleshooting and Recovery - The following is a small list of possible NFV Access problems, and - their solutions. In all scenarios collect the logs if - possible for debugging. More information on log collecting can be - found in The following is a small list of possible Enea NFV Access problems, + and their solutions. In all scenarios collect the logs + if possible for debugging. More information on log collecting can + be found in Using the Log Collector in the Manual. - If you encounter other issues or can't get NFV Access to work + If you encounter other issues or can't get Enea NFV Access to work successfully after consulting the information below, please use the Enea Support team Form, available in the @@ -29,21 +29,38 @@ - NFV Access Problem + Enea NFV Access Problem Solution + + A uCPE device fails to connect to the Enea uCPE Manager after + installation. + + If the uCPE device is not able to connect to the Enea uCPE + Manager after an installation, the Web-installer application is + started automatically on the uCPE device to change the configuration + via a web browser. Please see Booting the uCPE device and adding + it to the Map in the + Manual. + + The uCPE Device cannot boot after an upgrade. Perform a hardware reboot of the uCPE Device and select - the previous NFV Access image from the GRUB menu. This action - assumes physical access to the uCPE device. + the previous Enea NFV Access image from the GRUB menu. This + action assumes physical access to the uCPE device. @@ -60,10 +77,10 @@ - After a failed uCPE device upgrade the previous NFV Access - image (from the GRUB menu) does not boot. + After a failed uCPE device upgrade the previous Enea NFV + Access image (from the GRUB menu) does not boot. - Reinstall NFV Access on the uCPE device and redeploy the + Reinstall Enea NFV Access on the uCPE device and redeploy the initial configuration and virtualized services, by following the steps in Installing Enea NFV Access - uCPE @@ -75,7 +92,7 @@ - The uCPE Manager upgrade fails and a working snapshot is + The Enea uCPE Manager upgrade fails and a working snapshot is available. If a working snapshot obtained during a previous Upgrade or @@ -102,8 +119,8 @@ - The uCPE Manager upgrade fails and no working snapshot is - available, but a System Back-up file exists. + The Enea uCPE Manager upgrade fails and no working snapshot + is available, but a System Back-up file exists. @@ -114,8 +131,8 @@ Perform an installation with the restore option of a - previous uCPE Manager configuration as described in Installation of the uCPE Manager using a System Back-up in the The uCPE device is booted, the ssh connection is available - but the device is not connected to the uCPE Manager. + but the device is not connected to the Enea uCPE Manager. @@ -138,7 +155,7 @@ Use the Reconnect button from the - uCPE Manager's GUI. + Enea uCPE Manager's GUI. @@ -190,7 +207,7 @@ Reboot the device using Operations -> Reboot menu options from within the - uCPE Manager. + Enea uCPE Manager. diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 0876709..3706548 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml @@ -1,18 +1,19 @@ - Upgrading NFV Access + Upgrading Enea NFV Access - Enea provides regular releases that will require the upgrading of NFV - Access components. The uCPE Manager must be upgraded to the new Enea NFV - Access version before the uCPE devices are. + Enea provides regular releases that will require the upgrading of Enea + NFV Access components. The Enea uCPE Manager must be upgraded first, + followed by upgrading Enea NFV Access Run Time on the uCPE devices.
- Upgrading the uCPE Manager + Upgrading the Enea uCPE Manager It is recommended to create a system backup by accessing: System -> System Backup from - the uCPE Manager GUI, for recovery in case of an upgrade failure. + the Enea uCPE Manager GUI, for recovery in case of an upgrade + failure. @@ -31,7 +32,7 @@ Run the following command with the root account and change - /opt/ems to the correct location of the uCPE + /opt/ems to the correct location of the Enea uCPE Manager installation: ./upgrade.sh /opt/ems \ @@ -55,7 +56,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz The snapshot file created during the upgrade can be used for - restoring the uCPE Manager. + restoring the Enea uCPE Manager. @@ -70,9 +71,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Restoring a previous uCPE Manager installation + Restoring a previous Enea uCPE Manager installation - How to restore a previous uCPE Manager + How to restore a previous Enea uCPE Manager installation @@ -89,8 +90,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Copy the snapshot file (ucpemanager-Backup-YYYYddMMHHmm.tar.gz) - created during a previous uCPE Manager Upgrade or uCPE Manager - Uninstall Operation into the + created during a previous Enea uCPE Manager Upgrade or Enea uCPE + Manager Uninstall Operation into the <uCPEM-installdir> directory. @@ -100,7 +101,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Run the following command with the root user and change - /opt/ems to the correct location of the uCPE + /opt/ems to the correct location of the Enea uCPE Manager installation: ./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz @@ -116,8 +117,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Reinstall the uCPE Manager application on the specified target - location, restoring the data in the database and files in the + Reinstall the Enea uCPE Manager application on the specified + target location, restoring the data in the database and files in the process. @@ -127,20 +128,20 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Uninstalling an existing uCPE Manager installation + Uninstalling an existing Enea uCPE Manager installation - How to uninstall an existing uCPE Manager - installation + How to uninstall an existing Enea uCPE + Manager installation - Navigate to the folder where the uCPE Manager is installed: - <uCPEM-installdir>. + Navigate to the folder where the Enea uCPE Manager is + installed: <uCPEM-installdir>. Run the following command with the root user and change - /opt/ems to the correct location of the uCPE + /opt/ems to the correct location of the Enea uCPE Manager installation: ./uninstall.sh /opt/ems @@ -164,7 +165,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz The snapshot file created during the uninstall can be used - for restoring the uCPE Manager. + for restoring the Enea uCPE Manager. @@ -183,15 +184,16 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - After these steps, the uCPE Manager is completely removed from the - system. + After these steps, the Enea uCPE Manager is completely removed + from the system.
uCPE device upgrades - A uCPE device can be upgraded using the uCPE Manager GUI. + A uCPE device can be upgraded using the Enea uCPE Manager + GUI.
The uCPE device upgrade process @@ -251,7 +253,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz The uCPE Device upgrade is done with image files of type rootfs.ostree.tar.bz2, which are available in the - Enea_NFV_Ac-cess_uCPEManager_<version>-build<build_number>.tar.gz + Enea_NFV_Access_Run_Time_Platform_<processor>_<version>-build<build_number>.tar.gz file you downloaded with your release. @@ -345,7 +347,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - The hour represents the local uCPE Manager server + The hour represents the local Enea uCPE Manager server hour. diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml index 545bf99..dd90884 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml @@ -35,8 +35,8 @@ There are no standard ways of managing VNF licenses, therefore no general guidelines can be provided. One example of - license handling that can be employed in the uCPE Manager is the - adding of a license during the Cloud-Init setup. + license handling that can be employed in the Enea uCPE Manager is + the adding of a license during the Cloud-Init setup. @@ -109,10 +109,10 @@
- Onboarding into the uCPE Manager + Onboarding into the Enea uCPE Manager - How to onboard a VNF into the uCPE Manager - + How to onboard a VNF into the Enea uCPE + Manager @@ -133,8 +133,8 @@ This window contains data fields where both necessary and optional information about the VNF can be supplied. After doing so, press the - Onboard button, the uCPE Manager will create the VNF descriptor and add - it to its VNF Catalog. + Onboard button, the Enea uCPE Manager will create the VNF descriptor and + add it to its VNF Catalog.
Onboard a VNF @@ -171,7 +171,7 @@ Description. This field contains any description provided and is only displayed in the GUI - tables in the uCPE Manager. + tables in the Enea uCPE Manager. @@ -209,7 +209,7 @@ This table will contain the interfaces required by this VNF to be configured, when creating an instance. Consult the VNF vendor to determine which and how many are required. Each interface requires a - name, and optionally a description, used only by the uCPE + name, and optionally a description, used only by the Enea uCPE Manager. @@ -219,8 +219,8 @@ Cloud Init Tab - Click the Clout Init tab to provide the - Clout-Init configuration. There are three fields that need to be + Click the Cloud Init tab to provide the + Cloud-Init configuration. There are three fields that need to be populated: @@ -271,9 +271,9 @@ Content Files Table The Content Files Table is ONLY used if - ConfigDrive is chosend as the Cloud-Init + ConfigDrive is chosen as the Cloud-Init Datasource. For each content file added, a Path - must be provided. When the uCPE Manager is used to create an + must be provided. When the Enea uCPE Manager is used to create an instance for multiple VNFs, the user will be prompted to provide a data file for each entry in this table. Each type of VNF will require different cloud-init files, e.g.: a license file. The data @@ -291,10 +291,10 @@ In this table, you can enter values for properties that will be used during instantiation of the VNF. The values will augment the - default values in the Domain.XML file used by - libvirt/virsh (running in NFV Access) when creating - an instance of the VNF. Consult with the VNF Vendor or ENEA support for - values needed by specific VNFs. + default values in the domain.xml file used by + libvirt/virsh (running in Enea NFV Access) when + creating an instance of the VNF. Consult with the VNF Vendor or ENEA + support for values needed by specific VNFs. Property Values @@ -437,25 +437,20 @@ - For reverse ssh connections: the Username - (default: root) and the Reverse ssh checkbox - checked. The port will be automatically choosen by the uCPE - Manager in the range defined in the System -> - Configuration -> Reverse SSH configuration panel. By - default, the start port will be 7000 and the - maximum number of ports allocated to all devices is 10. Only one - port per device is allowed. - - A SSH Tunnel between the uCPE Manager and the device will be - created: - - ssh -f -N -T -R < Port > :localhost:22 <uCPE Mgr user>@<uCPE MgrIP> - - The device must be connected to the uCPE Manager for the - tunnel to be created. On connection, a normal ssh connection will - be made: - - ssh -p <Port> <Username>@localhost + For reverse ssh connections (ssh to a uCPE device behind + NAT): the Username (default: root) and the + Reverse ssh checkbox checked. The port will be + automatically choosen by the Enea uCPE Manager in the range + defined in the System -> Configuration -> Reverse + SSH configuration panel. By default, the start port will + be 7000 and the maximum number of ports + allocated to all devices is 10. Only one port per device is + allowed. + + When the SSH window is closed, the tunnel configuration is + deleted on the uCPE device and the tunnel is destroyed, so that + the port can be reused to establish a new tunnel when + needed. diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml index d470415..a7c1c69 100644 --- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml @@ -14,10 +14,10 @@ href="../../s_doceneacommon/doc/eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of - the major components as well as other features and optimizations, - and documentation updates. A list of new features and improvements can be found in - Section 2.1 New - Features and Improvements. + the major components as well as other features and optimizations, and + documentation updates. A list of new features and improvements can be found + in Section 2.1 New Features and + Improvements.
Enea NFV Access Release Content @@ -107,8 +107,8 @@ . - Describes how to install the uCPE Manager, the NFV Access Run-Time - platform and Device Management. + Describes how to install the Enea uCPE Manager, the Enea NFV Access + Run-Time platform and Device Management. diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index 9b7ac80..e4c9764 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml @@ -9,8 +9,8 @@ - LXCR-9904NFV Access cannot be installed on USB - storage devices. + LXCR-9904Enea NFV Access cannot be installed on + USB storage devices. @@ -19,9 +19,9 @@ - ELCCR-527Cancelling a file upload in the uCPE - Manager will require the user to close and reopen the upload window for - the next upload to work. + ELCCR-527Cancelling a file upload in the Enea + uCPE Manager will require the user to close and reopen the upload window + for the next upload to work. @@ -58,10 +58,10 @@ LXCR-9992Depending on hardware capabilities, there are certain limitations regarding the vfio-pci - and igb_uio drivers. While the NFV Access Run Time - Platform uses the vfio-pci driver by default, for - certain hardware configurations, igb_uio should be - used instead, by providing custom scripting. Please contact Enea for + and igb_uio drivers. While the Enea NFV Access Run + Time Platform uses the vfio-pci driver by default, + for certain hardware configurations, igb_uio should + be used instead, by providing custom scripting. Please contact Enea for further details. @@ -77,11 +77,11 @@ - ELCCR-912Adding an upgrade image into the uCPE - Manager (Device > Upgrade > Add) fails, + ELCCR-912Adding an upgrade image into the Enea + uCPE Manager (Device > Upgrade > Add) fails, producing the following error ostree: symbol lookup error: /usr/local/lib/libostree-1.so.1: undefined symbol: - g_utf8_make_valid. This occurs when the uCPE Manager is + g_utf8_make_valid. This occurs when the Enea uCPE Manager is installed on CentOS 7 prior to C7.1804 (kernel version < 3.10.0-862). As a workaround, update glib2 to version 2.54.2 or later, using #yum update glib2. diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml index 10c29ca..65b1784 100644 --- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml @@ -42,21 +42,21 @@ - Support for installing NFV Access on eMMC disks. + Support for installing Enea NFV Access on eMMC disks. - Support for installing NFV Access on disks larger than + Support for installing Enea NFV Access on disks larger than 1TB. - Improved boot time of NFV Access by removing unnecessary or + Improved boot time of Enea NFV Access by removing unnecessary or redundant services. - Fixed the NFV Access bare metal installation on Dell + Fixed the Enea NFV Access bare metal installation on Dell VEP1445. More information might be needed here. @@ -67,7 +67,7 @@ - ELCCR-354Improved uCPE Manager instance + ELCCR-354Improved Enea uCPE Manager instance recovery from a faulty state, through the System Backup functionality. @@ -110,7 +110,7 @@ framework that will replace the existing AF&TH in the next major release. The new automation framework has improved usability and an extended automation feature set. It has to be downloaded separately as - it is not part of the standard NFV Access 2.3 distribution. The + it is not part of the standard Enea NFV Access 2.3 distribution. The Automation Framework - Early Access distribution also includes updated user documentation. @@ -144,7 +144,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" />. Provides license information pertaining to packages available with the - uCPE Manager. + Enea uCPE Manager. -- cgit v1.2.3-54-g00ecf