From 7bdf38661d9bc1a86e23a49c42b2021ba626c9d3 Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 27 Jan 2021 16:06:45 +0100 Subject: Updated the getting started manual with needed information. Change-Id: I7b7ec2cba523b83263bb4e2e348f9efaaf74d02d Signed-off-by: mrpa --- .../doc/installation_guide.xml | 186 ++++++++++++++------- .../doc/log_collector.xml | 95 ++++++----- .../doc/net_config_options.xml | 114 ++++++------- .../doc/troubleshooting.xml | 31 ++-- .../doc/upgrade_ena.xml | 183 ++++++++++---------- .../doc/vnf_mg.xml | 36 ++-- 6 files changed, 363 insertions(+), 282 deletions(-) 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 b82d48b..9f0aa37 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 @@ -17,9 +17,69 @@ 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 CentOS 7 server must be updated to the latest revision + before installing Enea NFV Access. + + + The following will detail CPU, RAM and storage requirements for + the uCPE Manager. + + + + For small-sized deployments (tens of devices): + + + + 4 cores + + + + 16 GB RAM + + + + 300 GB single disk storage + + + + + + For mid-sized deployments (hundreds of devices): + + + + 8 cores + + + + 32 GB RAM + + + + 300 GB single disk storage + + + + + + For large deployments (thousands of devices): + + + + 16 cores + + + + 64-256 GB RAM + + + + 1-2 TB single disk storage + + + + The purpose of the CentOS 7 server is to host the Enea uCPE Manager. Network access between the CentOS 7 server and the uCPE @@ -30,8 +90,8 @@ One or more uCPE devices. - Whitebox devices where the Enea NFV Access Runtime Platform - will be installed, containing a minimum of 2 cores and 4 GB RAM and at + Whitebox devices where the Enea NFV Access Runtime 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. @@ -251,14 +311,14 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar

Execute the following command to check if you have a currently - running the PostgreSQL database server: + running PostgreSQL database server: ps -ef | grep post - Remove the currently installed PostgreSQL server (including - the existing postgres user): + Remove the installed PostgreSQL server (including the existing + postgres user): yum remove postgres\* rm -rf /var/lib/pgsql @@ -327,7 +387,7 @@ userdel postgres Each uCPE device needs a unique identifier. This identifier is used to match the registration in the Enea uCPE Manager and the offline configuration of the uCPE device during ZTP (Zero Touch - Provisioning) + Provisioning). Select a text string to represent the uCPE device, e.g. uCPE-1 or @@ -395,7 +455,7 @@ userdel postgres
Installing the Enea uCPE Manager - The Enea uCPE Manager can be installed using as a fresh/first-time + The Enea uCPE Manager can be installed using a fresh (first-time) configuration or using a backup file of a previous installation, created within the Enea uCPE Manager GUI. @@ -569,7 +629,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz 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. + parameter when setting up the uCPE devices.
@@ -577,14 +637,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzInstallation of the Enea uCPE Manager using a System Back-up - The Enea uCPE Manager can be restored if a back-up file has been + The Enea uCPE Manager can be restored if a backup file has been previously created. - A backup file can be created by accessing: - System -> System Backup from - the Enea uCPE Manager GUI. The resulting zip archive will be located - in the /opt/ems/ucpemanager/application/backup - folder and will be named + A backup file can be created by accessing the System menu, and clicking System Backup, from 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 Enea uCPE Manager installation folder for future @@ -593,11 +654,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz 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 + different from the snapshot obtained during a Enea uCPE Manager + Upgrade or Uninstall operation (ucpemanager-Backup-YYYYddMMHHmm.tar.gz) needed - for recovery of the Enea uCPE Manager. For more details please see - Restoring a previous uCPE Manager installation in the Preparing the USB stick for installation of the Enea NFV Access Runtime Platform - To install the Enea NFV Access Runtime Platform, create a - bootable USB stick with the image you intend to install. + To install the Enea NFV Access Runtime Platform, create a 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 + The .hddimg image is available in the Enea_NFV_Access_Run_Time_Platform_ <processor>_<version>-build<build_number>.tar.gz file you downloaded with your release. @@ -682,9 +743,9 @@ of=/dev/sdb bs=4M conv=fsync While the uCPE device is powered off, in order to install and - configure the Enea NFV Access Runtime 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. + configure the Enea NFV Access Runtime Platform (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.
@@ -723,7 +784,7 @@ of=/dev/sdb bs=4M conv=fsync - Customer Tags. They are used for Zero Touch Provisining + Customer Tags. They are used for Zero Touch Provisioning (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 Enea uCPE Manager. A @@ -760,9 +821,10 @@ of=/dev/sdb bs=4M conv=fsync When the user has completed the configuration steps in the 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. + stage, the user should remove the USB stick and the LAN cable, and + shutdown the uCPE device. It will be started after necessary + configurations are done on the Enea uCPE Manager, as described + below. If the USB stick was booted in UEFI mode, an UEFI boot entry is @@ -817,11 +879,11 @@ of=/dev/sdb bs=4M conv=fsync Day-0 configuration is a software lifecycle term referring to - early configurations to put the uCPE device in an active state. Day-1 - Configurations are applied after Day-0 and set the uCPE device and its - service in an active state. Day-2 Configurations are live - configurations on the uCPE and its service, applied after the uCPE - device and its service have been activated. + early configurations used to put the uCPE device in an active state. + Day-1 Configurations are applied after Day-0 and set the uCPE device + and its service in an active state. Day-2 Configurations are live + configurations on the uCPE device and its service, applied after they + have been activated. The offline configuration consists of data and parameters that are @@ -834,27 +896,28 @@ of=/dev/sdb bs=4M conv=fsync For this base configuration, the offline configuration will be left blank. The blank offline configuration can be filled with user-specific values and data once the service is created, which is done - after installation is complete. + after the installation is complete. 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 Enea uCPE Manager, informing the user that the ZTP - setup failed for the uCPE device. + tries to connect to the Enea uCPE Manager, informing the user that the + ZTP setup failed for the uCPE device. To create an offline - configuration + configuration - In a browser access the Enea uCPE Manager, then - Applications->Offline - Config. + In a browser access the Enea uCPE Manager, open Applications and select Offline Config. - Create a new offline configuration in the GUI by clicking - Add and filling in the mandatory fields: - name, deviceVersion and + Create a new offline configuration in the GUI by selecting + the Add button and filling in the + mandatory fields: name, + deviceVersion and deviceId. The name is user defined and can be set to any unique text @@ -872,9 +935,10 @@ of=/dev/sdb bs=4M conv=fsync 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. + information in the Enea uCPE Manager. This is accomplished by going to + Devices, selecting Manage and then clicking the Add button. The relevant parameters are: @@ -927,8 +991,9 @@ of=/dev/sdb bs=4M conv=fsync established. When a uCPE device is registered it can be manually added to the - map for overview. Right-click on the map and select Place - Device to put the uCPE device on the map. + map for overview. Right-click on the + map and select Place Device to put the + uCPE device on the map. In case of management connection failure (e.g. due to a misconfiguration), the uCPE device status will be seen as RED @@ -976,9 +1041,9 @@ of=/dev/sdb bs=4M conv=fsync 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 - view. The same view will show active VNFs running on the uCPE device - once instantiated. + device and go to the Virtual Machines + tab in the map view. The same view will show active VNFs running on the + uCPE device once instantiated.
@@ -986,18 +1051,19 @@ of=/dev/sdb bs=4M conv=fsync 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. + 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 In case the uCPE device was installed behind a NAT device, the + reverse SSH connection will be used. For more details, please see + Device Call Home Connection for deployment behind NAT in the 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 Enea uCPE - Manager. The following describe how the log collection mechanism - works. + set of information i.e. logs collected from the uCPE device and/or the Enea + uCPE Manager. The following information describes how the log collection + mechanism works.
Log collecting using the Enea uCPE Manager @@ -22,8 +22,8 @@ - Access Operations -> Collect - Debug Logs. + Access Operations and then + select Collect Debug Logs. @@ -31,7 +31,7 @@ - Press the Execute button. + Press the Execute button. A success message is shown in the same window as shown below. At this moment, the process of collecting logs on the uCPE device @@ -54,8 +54,8 @@ 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 Enea uCPE Manager. This can be viewed in the - GUI under the Faults -> - Events toolbar menu. + GUI in the Faults menu, after selecting +Events.
Collecting Debug Logs @@ -74,16 +74,16 @@ View collected Logs A list with the archives containing already collected logs will be - shown in the Device File Listing table: + shown in the Device File Listing table: - Access Files -> - Download. + Access Files and then the +Download button. - Press the List button. + Press the List button.
Device File Listing Table @@ -100,7 +100,7 @@ If the filename you specified does not appear, it might still be - in the process of creation. Click on the Refresh + in the process of creation. Click on the Refresh icon at the bottom of the table until you can see the desired file listing. @@ -114,22 +114,22 @@ - Access Files -> - Download. + Access Files and choose the + Download button. - Press the List button. + Press the List button. - In the Device File Listing table, select + In the Device File Listing table, select the archive you want to download from the uCPE device to Enea uCPE Manager. - Press the Download from Device + Press the Download from Device button. The archive will be downloaded from the uCPE device and stored @@ -152,21 +152,21 @@ - Access Devices -> - Files. + Access the Devices menu and select +Files. - Select the Downloaded Files tab. + Select the Downloaded Files tab. - Select an archive from Downloaded Files + Select an archive from the Downloaded Files table. - Click the Download button. + Click the Download button. The file will be downloaded in browser's download folder. @@ -193,21 +193,21 @@ - Access Files -> - Download. + Access Files and then click the + Download button. - Press the List button. + Press the List button. - In the Device File Listing table, select + In the Device File Listing table, select the archive you want to delete from the uCPE device. - Press the Delete button. + Press the Delete button. The archive will be deleted from the uCPE device and the table will be updated. @@ -218,8 +218,8 @@ - Access Operations -> Delete - Debug Log Archive. + Access the Operations menu and +select Delete Debug Log Archive. @@ -227,7 +227,7 @@ - Press the Execute button. + Press the Execute button. A success message is displayed if the file is deleted from the uCPE device correctly. @@ -243,21 +243,21 @@ - Access Devices -> - Files. + Access the Devices menu, then select + Files. - Select the Downloaded Files tab. + Select the Downloaded Files tab. - Select an archive from the Downloaded Files - table. + Select an archive from the Downloaded Files +table. - Click the Delete button. + Click the Delete button. The file will be deleted from the Enea uCPE Manager and the table will be updated. @@ -279,12 +279,12 @@ - Access Security -> - Configuration. + Access the Security menu, +then select Configuration. - Click the Security Groups tab. + Click the Security Groups tab. @@ -292,18 +292,18 @@ - Click the Permissions tab on the right + Click the Permissions tab on the right side. - Click the Devices tab like in the image + Click the Devices tab like in the image below. - Change the Device File Management option to - none to disable the feature. + Change the Device File Management option to + none to disable the feature. @@ -336,16 +336,15 @@ - Access Test -> Debug - Settings and select the Log Files - tab. + Access Test, then Debug + Settings and select the Log Files tab. Select the desired log file (ucpemanager.log or watchdog.log) and press the - Download button. + Download button. 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 1d51537..034908a 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 @@ -43,16 +43,16 @@ In use cases where CPU capacity is very limited, disabling DPDK can free up CPU capacity and overall performance can improve. Navigate - to Configuration -> DPDK and - deselect Enable DPDK to disable the DPDK. + to Configuration, then DPDK and + deselect Enable DPDK to disable the DPDK. Disabling the DPDK cannot be done after other network configurations have been made. - In Configuration -> DPDK - it is also possible to configure DPDK resources such as: + In Configuration, select DPDK + where DPDK resources can also be configured such as: @@ -89,9 +89,9 @@ management system. 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. + device, then from the top toolbar select Configuration, then + External Interfaces, Configuration, +and click the Add button. The available Interface types are detailed below.
DPDK Interface Type @@ -102,10 +102,10 @@ bridge. - Make sure the Enable DPDK checkbox is - selected in Device -> Configuration -> - DPDK, otherwise no interface can be assigned as - DPDK. + Make sure the Enable DPDK checkbox is + selected by accessing Device, +Configuration and choosing +DPDK, otherwise no interface can be assigned as DPDK. To add a DPDK interface under the management system, set @@ -202,17 +202,16 @@ 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. + the Configuration menu, then External + Interfaces and Configuration. + The already configured interfaces are displayed here, as 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 + each type of interface. From the Host Interface window, a user can change the networking type and the IP address assignment: @@ -243,9 +242,9 @@ Manual Configuration For Manual Configuration of uCPE networking, select the uCPE - device first and then Configuration -> - External Interfaces, where one can find a list of - available network interfaces and their capabilities. + device first, then access the Configuration menu, + and choose External Interfaces, where a list of + available network interfaces and their capabilities can be found. After networking interfaces have been added to the Enea uCPE Manager, the user can change the interface type (DPDK, SR-IOV, @@ -290,22 +289,23 @@ - Select Configuration. + Select Configuration. - Click OpenvSwitch. + Click OpenvSwitch. - Select the Bridges option, then click - Add. + Select the Bridges option, then click + Add. - Depending on the settings in Configuration -> - OpenVSwitch -> DPDK, OVS bridges with or without DPDK + Depending on the settings found when accessing Configuration, + OpenVSwitch and selecting + DPDK, OVS bridges with or without DPDK support will be used on the uCPE device. @@ -473,9 +473,9 @@ 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 + To create an offline configuration, select from the top toolbar + the Applications menu, then Offline + Config and choose Add. The following fields should be filled: @@ -536,9 +536,9 @@ 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 + After creating the Offline Config Store, access the device by selecting + Applications, then offline config + and clicking Config App, to provision it with the required initial configuration. This operation mirrors what happens during manual configuration described previously. @@ -547,9 +547,9 @@ 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. + factory reset can be executed to force a new ZTP to execute. +Select the device, then access the Operations menu +and select factory reset.
@@ -597,22 +597,22 @@ - Select Devices -> Custom - Scripts -> Configure. + Access the Devices menu, then Custom + Scripts and choose Configure. - Select Upload to EMS. + Select Upload to EMS. - In the Script Type menu, select the type + 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. + Press Choose File to select the scripts + needed, and then click Send.
@@ -624,14 +624,14 @@ - Select Devices -> Custom - Scripts -> Configure. + Access the Devices menu, then Custom + Scripts and select Configure. Select the script you want to delete from the - Uploaded Scripts tab and then click - Delete, which will remove the script immediately + Uploaded Scripts tab and then click + Delete, which will remove the script immediately from the Enea uCPE Manager. @@ -645,12 +645,12 @@ - Select Devices -> Custom - Scripts -> Configure. + Access the Devices menu, choose Custom + Scripts and select Configure. - Select the Configuration tab and specify a + Select the Configuration tab and specify a new loacation to store the scripts. @@ -669,21 +669,21 @@ - Select Devices -> Custom - Scripts -> Apply Scripts. + Access the Devices menu, choose Custom + Scripts and select Apply Scripts. - In the Script Config Screen pop up, select + 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 + 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. + by pressing the + button. @@ -694,14 +694,14 @@ - Check the checkbox Reboot devices if you - want to reboot and execute the scripts at once and then press - ok. + Check the Reboot devices checkbox if you + want to reboot and execute the scripts at once and then select +ok. The status of execution for the scripts can be seen by - opening the Fault -> - Events screen and filtering by device and/or + accessing Fault, opening the +Events screen and filtering by device and/or the event name CustomScriptExecuted. 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 e176cec..f416f8f 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml @@ -2,20 +2,20 @@ Troubleshooting and Recovery - 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 In all scenarios where possible, collect the logs 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 Enea NFV Access to work + The following is a small list of possible Enea NFV Access problems, + and their solutions. 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 + targetptr="contacting_enea_support">Enea Support Team Form, available in the Manual @@ -154,8 +154,8 @@ - Use the Reconnect button from the - Enea uCPE Manager's GUI. + Use the Reconnect + button from the Enea uCPE Manager's GUI. @@ -205,17 +205,18 @@ - Reboot the device using Operations - -> Reboot menu options from within the - Enea uCPE Manager. + Reboot the device by accessing Operations and then selecting Reboot from within the Enea uCPE + Manager. If the above actions do not work, redeploy all services. - This is done by cleaning up the existing configuration using: - Operations -> Factory - Reset for a specific device and redeploying the VNF - services. + This is done by cleaning up the existing configuration by +accessing Operations, then selecting +Factory Reset for a specific device and +redeploying the VNF services. 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 01fd8ec..2f5801c 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 @@ -4,16 +4,17 @@ 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 Runtime on the uCPE devices. + followed by upgrading the Enea NFV Access Runtime Platform on the uCPE + devices.
Upgrading the Enea uCPE Manager - It is recommended to create a system backup by accessing: - System -> System Backup from - the Enea uCPE Manager GUI, for recovery in case of an upgrade - failure. + It is recommended to create a system backup by accessing System and selecting System + Backup from the Enea uCPE Manager GUI, for recovery in case + of an upgrade failure. @@ -171,7 +172,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Uninstall the ucpemanager service, so that - it will not startup on reboot. + it will not start up on reboot. @@ -220,38 +221,42 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
- Managing the device Upgrade + Managing the uCPE device Upgrade Before an installation or upgrade can be completed, certain configuration data must be set. Files also need to be uploaded to the - Device Upgrade image repository to be uploaded to the device. + Device Upgrade image repository in order to be uploaded to the + device. Launch the Device Upgrade management console by selecting - Devices -> Upgrade from the top - tool-bar. The console will contain the following tabs: + Devices and then the Upgrade button from the top tool-bar. The console + will contain the following tabs: - Image Library. To add/delete an - image. + Image Library. To add/delete + an image. - Upgrade Operations. See running upgrades, - cancel any upgrades in progress, start a uCPE device upgrade. + Upgrade Operations. See + upgrades that are currently running, cancel any upgrades in + progress, or start a uCPE device upgrade. - Configuration. Upgrade configuration - parameters. + Configuration. Upgrade + configuration parameters. - Press Close when the message File Uploaded - Successfully appears on the File Upload Screen. + Press Close when the message + File Uploaded Successfully appears on the File Upload screen. - The uCPE Device upgrade is done with image files of type + The uCPE Device upgrade is done with image files of the type rootfs.ostree.tar.bz2, which are available in the Enea_NFV_Access_Run_Time_Platform_<processor>_<version>-build<build_number>.tar.gz file you downloaded with your release. @@ -263,18 +268,19 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzAdding an image to the image repository/library - Select Devices -> - Upgrade. + Select Devices and then + the Upgrade button. - Select Add from the Image - Library tab to add a new image file. + Select Add from the + Image Library tab to add a new + image file. - Click on Choose File to provide the - path to the image file (must be of type + Select Choose File to + provide the path to the image file (must be of type rootfs.os-tree.tar.bz2). @@ -285,8 +291,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Click Send to upload the image to the - image repository. + Click Send to upload the + image to the image repository. @@ -295,14 +301,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Select Devices -> - Upgrade. + Select Devices and then the + Upgrade button. - Select the image you want to delete from the Image - Library tab and then click - Delete. + Select the image you want to delete from the Image Library tab and then click Delete.
@@ -310,12 +316,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz Upgrade Operations - The Upgrade Operations tab allows a user to - manage uCPE device upgrades in the system. It allows the user to see - all the upgrades that are currently in progress, as well as listing - the completed ones. If an upgrade succeeds or fails, then a row will - be added to the completed upgrades table. If one fails, the failure - message will be visible in the table. + The Upgrade Operations tab + allows a user to manage uCPE device upgrades in the system. It allows + the user to see all the upgrades that are currently in progress, as + well as listing the completed ones. If an upgrade succeeds or fails, + then a row will be added to the completed upgrades table. If one + fails, the failure message will be visible in the table. The list of completed upgrade tasks resides in the cache @@ -325,16 +331,17 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzHow to Install/Upgrade a device immediately or schedule the process for later - Select Devices -> - Upgrade. + Select Devices and then + the Upgrade button. - Select Upgrade Devices from the - Upgrade Operations tab. This will launch a - Multi Device Install Image screen that will - allow the user to install and upgrade more than one uCPE device - at a time or upgrade later. + Select Upgrade Devices + from the Upgrade Operations + tab. This will launch a Multi Device Install + Image screen that will allow the user to install and + upgrade more than one uCPE device at a time or upgrade + later. @@ -360,8 +367,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Image File. Click on Choose - Image File to select the image file. + Image File. Click on Choose Image File to select the image + file. @@ -369,13 +377,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Press the > button to move the uCPE - devices to the right side of the selector. Those chosen form the - list of uCPE devices that will be upgraded. + Press the > button to + move the uCPE devices to the right side of the selector. Those + chosen form the list of uCPE devices that will be upgraded. - Upgrade Operation. The available options are: + Upgrade Operation. The available options + are: @@ -410,8 +419,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzThe installed releases on a uCPE device can be viewed by selecting the uCPE device first, then from the top toolbar selecting - Configuration -> - Upgrade. + Configuration and then the Upgrade button. The installed releases on the uCPE device, the release status, release state, commit-id and release version will @@ -422,30 +431,31 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzuCPE device Upgrade Status The status of the installation and upgrade can be viewed in the - Upgrade Operations tab. Ongoing or scheduled - upgrade operations can be viewed or cancelled. + Upgrade Operations tab. Ongoing or + scheduled upgrade operations can be viewed or cancelled. To view the status of an installation or upgrade operations - Select Devices -> - Upgrade. + Select Devices and then the + Upgrade button. - Select Upgrade Operations. The ongoing - operations are listed at the top and a history of failed or - successful operations are listed at the bottom. + Select Upgrade Operations. + The ongoing operations are listed at the top and a history of + failed or successful operations are listed at the bottom. - Select an Active or Completed - Upgrade Operation and click the Device - Status button to see detailed information regarding the - upgrade operation, including the uCPE devices involved and - information per uCPE device. + Select an Active or + Completed Upgrade Operation and + then the Device Status button to + see detailed information regarding the upgrade operation, + including the uCPE devices involved and information per uCPE + device. @@ -454,15 +464,16 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Select Devices -> - Upgrade -> Upgrade - Operations. + Select Devices, then the + Upgrade button and choose + Upgrade Operations. - Select an operation from the list and press Cancel - Upgrade and Confirm. The operation - will then be deleted from the list. + Select an operation from the list and choose Cancel Upgrade and Confirm. The operation will then be deleted + from the list.
@@ -472,19 +483,20 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz The default values present in the configuration of each uCPE - device are recommended for use. Modifying them is for an Advanced - User only. + device are recommended for use. Modifying them is for an Advanced User only. How to Configure the uCPE device Upgrade - Select Devices -> - Upgrade. + Select Devices and then + the Upgrade button. - Select Configuration. + Select Configuration. @@ -528,17 +540,18 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzEach uCPE device can receive image files and use them to upgrade. This can be done by selecting the uCPE device in the - System view and clicking the - Upgrade button. In the new window, an upgrade image - can be chosen from the Image Files tab by selecting - the image file from the list and clicking the Install on - Device button. + System view and clicking the + Upgrade button. In the new window, an + upgrade image can be chosen from the Image + Files tab by selecting the image file from the list and + clicking the Install on Device + button. Once an image is installed on the uCPE device, the image will be - available on the uCPE device and be visible in the - Releases tab. It can then be selected from the list - and the upgrade started by clicking the Upgrade - button. + available on the uCPE device and be visible in the Releases tab. It can then be selected from the + list and the upgrade started by clicking the Upgrade button. 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 2dfe248..e8c65eb 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 @@ -116,17 +116,17 @@ - Select from the top toolbar VNF -> - Descriptors + Select from the top toolbar VNF + and then Descriptors. - Click the On-board button. + Click the On-board button. - When prompted by the UI, make sure the VM - Image radio button at the top of the onboarding screen is + When prompted by the UI, make sure the VM + Image radio button at the top of the onboarding screen is selected, it will trigger a popup menu window. @@ -153,7 +153,7 @@ VM Image File. This is the Virtual Machine image file for the VNF. Typically, it is a QCOW - image. Press Choose File and select the image you + image. Press Choose File and select the image you wish to upload. @@ -203,7 +203,7 @@ Interfaces Tab - Click on the Interfaces tab to show the + Click on the Interfaces tab to show the Interfaces table. This table will contain the interfaces required by this VNF to be @@ -219,7 +219,7 @@ Cloud Init Tab - Click the Cloud Init tab to provide the + Click the Cloud Init tab to provide the Cloud-Init configuration. There are three fields that need to be populated: @@ -349,12 +349,12 @@ - Select from the top toolbar VNF -> - Instances + Select from the top toolbar VNF and + choose Instances. - Click the Add button. + Click the Add button. @@ -406,13 +406,13 @@ - Hit the Create button to deploy the VNF and + Hit the Create button to deploy the VNF and run it on the specified uCPE device. - Selecting the VNF -> Events menu will show - that the VNF was created and a connection was established. + Selecting the VNF menu then choosing Events + will show that the VNF was created and a connection was established.
@@ -426,7 +426,7 @@ SSH to the uCPE device from the Enea uCPE Manager - (Device->SSH) using: + (Access the Device menu and select SSH) using: @@ -441,8 +441,10 @@ 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 + defined in the SSH configuration panel, + available when accessing System, then + Configuration and choosing Reverse + SSH . 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. -- cgit v1.2.3-54-g00ecf