From 41cd787a201e96bc4452d007d7cb0724e005b29b Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 24 Mar 2021 22:03:12 +0100 Subject: Added documentation concerning device operations. Change-Id: I90a696a5adefa16a4a75de3535d5e9307e3eb7d8 Signed-off-by: mrpa --- .../doc/installation_guide.xml | 48 ++++++++++++++++--- .../doc/introduction.xml | 6 +++ .../doc/net_config_options.xml | 30 ++++++++++-- .../doc/upgrade_ena.xml | 34 +++++++++++-- doc/book-enea-edge-getting-started/doc/vnf_mg.xml | 55 ++++++++++++++++++++-- 5 files changed, 156 insertions(+), 17 deletions(-) diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml index 50a90b0..2805d4f 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml @@ -22,7 +22,7 @@ The following will detail CPU, RAM and storage requirements for - the Enea Edge Management. + the Enea Edge Management Application. @@ -81,7 +81,7 @@ The purpose of the CentOS 7 server is to host the Enea Edge - Management. Network access between the CentOS 7 server and the uCPE + Management Application. Network access between the CentOS 7 server and the uCPE devices is required. The Enea Edge Management and the uCPE devices will be connected on separate subnets to avoid inconsistencies. @@ -1134,10 +1134,11 @@ of=/dev/sdb bs=4M conv=fsync
uCPE Device Monitorization and Control - Once the uCPE device is connected to the Enea Edge Management, it is - ready for central management. Two important functions available in the - Enea Edge Management GUI are alarm checking and resource - allocation. + Once the uCPE device is connected to the Enea Edge Management + application, it is ready for central management. Two important functions + available in the Enea uCPE Management GUI are alarm checking and resource + allocation. Additionally, the device can be rebooted, the factory settings + can be restored or simply the vCPE service can be restarted.
Checking Alarms @@ -1167,6 +1168,41 @@ of=/dev/sdb bs=4M conv=fsync uCPE device once instantiated.
+
+ Basic operations for uCPE device Managememt + + When the uCPE device is connected to the Enea Edge Management application, it can + be rebooted, the factory settings can be restored or simply the vCPE + service can be restarted. + + Select the uCPE device and go to the Operations menu, where the following options are available: + + + + Reboot. Reboots the device. Settings will be preserved. + + + + Factory reset. Resets the device to its + default factory settings. All current configuration settings are lost. All + running VNFs are destroyed. Any installed custom scripts will be removed and + they will need to be reinstalled. + + Only the vCPE service will be restarted, the device will not + be rebooted. No reboot is needed. + + Once the vCPE service restart completes, appropriate day-0 + provisioning will take place. + + + + Restart Vcpe. Restarts the + vCPE service on the device. The device will not be rebooted. + + +
+
Accessing the uCPE device CLI diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml index 8186ff1..5786883 100644 --- a/doc/book-enea-edge-getting-started/doc/introduction.xml +++ b/doc/book-enea-edge-getting-started/doc/introduction.xml @@ -257,6 +257,12 @@ Virtual Network Function. + + + vCPE + + Virtual Customer Premises Equipment. + diff --git a/doc/book-enea-edge-getting-started/doc/net_config_options.xml b/doc/book-enea-edge-getting-started/doc/net_config_options.xml index dae5b36..344b79b 100644 --- a/doc/book-enea-edge-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-edge-getting-started/doc/net_config_options.xml @@ -722,7 +722,8 @@
Removing Scripts - Follow the instruction below to remove scripts: + Follow the instruction below to remove scripts from the Enea Edge + Management application: @@ -744,7 +745,7 @@ Configuring Script Location The location where the scripts are staged in the Enea Edge - Management can be chanaged as described below: + Management application can be changed as described below: @@ -814,9 +815,32 @@
+ +
+ Removing Scripts from a uCPE Device + + Follow the instructions below to remove scripts from a uCPE + Device: + + + + Access the Operations menu + and select Delete Custom + Script. + + + + In the Delete Custom Script + pop up, set the name and the type of the script that should be + deleted and press Execute. If the + Script Type remains unset, the + script will be deleted regardless of its type. + + +
-
+
Wireless Access Point The Wireless AP Screen from the Enea Edge Management Configuration diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml index 14ac049..9680a0c 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml @@ -245,7 +245,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzSystem, Configuration, Web Access and checking the Enable - HTTP box, or installing it manually. + HTTP box, or install Edge Enea 2.4.0 on the device manually.
@@ -576,13 +576,37 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzImage Files tab by selecting the image file from the list and clicking the Install on Device - button. + button. The Image files that appear in the Image + Library tab can be uploaded to the Enea Edge Management Application + by following the steps listed in Image Library. 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. + role="bold">Releases tab. There are two ways to make it + active, choose one or the other: + + + + Select it from the list and then start the upgrade by + clicking the Upgrade button. + + + + Select Operations, then + Upgrade, enter the + Release Name and press Execute. Filling in the Restore Archive + text field is optional and should be left unset if the + NFVi Snapshot feature is disabled. + + + + If an installed image is no longer needed, it can be removed + from the device by selecting Operations and Remove + Release. In the Remove + Release window, provide the Release Name + and press Execute.
diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml index bd2fb0b..e3fcde2 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml @@ -407,9 +407,58 @@ - Selecting the VNF menu then - choosing Events 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. + + +
+ VNF Instance Operations + + Various operations can be done to a VNF instance. It can be paused, + resumed, stopped, started or deleted. + + + + Select from the top toolbar VNF + and choose Instances. + + + + Select an instance that needs to be modified. + + + + Depending on the desired action, click the Delete/ Force Delete / Start / Stop / Pause / + Resume button respectively. + + + + Alternatively, these same operations can be performed by: + + + + Selecting Operations. + + + + Depending on the desired action, choosing Destroy / Start / Stop / Pause / Resume + VM respectively. + + + + The Id of the VM that should be modified can + be found by selecting Configuration, then + Virtual Machines, and then accessing the VMs tab. + + + + Provide the Id of the VM that should be + modified and press Execute. + +
-- cgit v1.2.3-54-g00ecf