From f1603e3dde23b0af093e2cc3ed0f3ba7da764fbd Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Fri, 20 Dec 2019 10:06:16 +0100 Subject: GettingStarted: add Custom Scripts chapter Change-Id: I8dd3fbf29fac4003782e153128a3cff345424869 Signed-off-by: Sona Sarmadi --- .../doc/getting_started_ucpe_manager.xml | 259 +++++++++++++++++---- 1 file changed, 212 insertions(+), 47 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 3155be6..095d2d5 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml @@ -885,6 +885,160 @@ section. + +
+ Custom Scripts + + 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. + + + +
+
@@ -910,8 +1064,8 @@ Upgrade Device. This stage - causes the device to replace its running image with the newly - copied image. + causes the device to replace its running image with the newly copied + image. @@ -919,9 +1073,9 @@
Managing the Device Upgrade - Before an install or upgrade can be completed, certain configuration - data must be set. Files also need to be uploaded to the Device Upgrade - image repository to upload to the device. + Before an install or upgrade can be completed, certain + configuration data must be set. Files also need to be uploaded to the + Device Upgrade image repository to upload to the device. Launch the Device Upgrade management console by selecting Devices -> Upgrade from the top @@ -930,7 +1084,8 @@ - Image Library. To add/delete an image. + Image Library. To add/delete an + image. @@ -948,10 +1103,9 @@ 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.
Image Library @@ -1005,14 +1159,18 @@ The Upgrade Operations tab allows a user to manage 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 here. - - The list of completed upgrade tasks resides in memory and will not - persist across reboots of the server. + 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 here. + + + The list of completed upgrade tasks resides in memory and will + not persist across reboots of the server. + - How to Install/Upgrade immediately or schedule for later + How to Install/Upgrade immediately or + schedule for later @@ -1021,19 +1179,19 @@ - Select Upgrade Devices from the - Upgrade Operations tab. This will launch a + 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 device at a - time or upgrade later. - + allow the user to install and upgrade more than one device at a + time or upgrade later. + The configurable parameters are: Scheduling. Click this checkbox if - the upgrade will be done later. Schedule the day, hour and - minute for when to run the upgrade. + the upgrade will be done later. Schedule the day, hour and + minute for when to run the upgrade. The time zone is set to Eastern Standard Time @@ -1043,8 +1201,8 @@ Description. An optional description - of the operation. It is recommended to add a description so that - different upgrades happening simultaneously can be + of the operation. It is recommended to add a description so + that different upgrades happening simultaneously can be distinguished. @@ -1055,15 +1213,16 @@ Devices. The list of available - devices is populated when an image file is chosen. The device(s) - chooser is then populated with the list of devices that can - accept that file. Press the > button to - move the devices to the right side of the chooser, which is - the list of devices that will be upgraded. + devices is populated when an image file is chosen. The + device(s) chooser is then populated with the list of devices + that can accept that file. Press the > + button to move the devices to the right side of the chooser, + which is the list of devices that will be upgraded. - Upgrade Operation. Available options are: + Upgrade Operation. Available options + are: @@ -1073,9 +1232,10 @@ Install Only. This will do an - image installation only. The image is copied to the device, - and an upgrade will be done later either at a scheduled time or - when the option Activate Only is selected. + image installation only. The image is copied to the + device, and an upgrade will be done later either at a + scheduled time or when the option Activate + Only is selected. @@ -1106,8 +1266,8 @@ Device Status tab. Ongoing or scheduled upgrade operations can be viewed or cancelled. - To view the status of an installation or upgrade - operations + To view the status of an installation or + upgrade operations @@ -1142,15 +1302,19 @@
Configuration -The default values present in the configuration of each device are -recommended for use. Modifying them is for an Advanced User only. + + The default values present in the configuration of each 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 -> + Upgrade. @@ -1164,10 +1328,10 @@ recommended for use. Modifying them is for an Advanced User only. deviceImageDir. This is the disk location of the device image repository. If an absolute path - name such as /usr/local/deviceimage is given, then the - absolute path name is used. If no absolute pathname is given - it is considered to be relative to the installation - directory. + name such as /usr/local/deviceimage is + given, then the absolute path name is used. If no absolute + pathname is given it is considered to be relative to the + installation directory. @@ -1181,10 +1345,11 @@ recommended for use. Modifying them is for an Advanced User only. KeepAlive. This number represents the number of seconds that a thread will be kept alive before it - is collected. If multiple installations are occurring, this will - keep the thread alive for X seconds before it is released. If - not released, it can be used by the internal scheduling system - as soon as it has completed an upgrade. + is collected. If multiple installations are occurring, this + will keep the thread alive for X seconds before it is + released. If not released, it can be used by the internal + scheduling system as soon as it has completed an + upgrade. -- cgit v1.2.3-54-g00ecf