From e7ef0bffc081936b60559a32f820d97f7a868cf8 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Fri, 22 Nov 2019 08:54:46 +0100 Subject: GettingStarted: add device upgrade chapter - Add device upgrade from uCPE Manager chapter - Update doc version to 2.2.2 - Fixed minor review comments - Added 4.4.2.3 Releases installed on a device ch - Added Note to 4.4.2.2 Upgrade Operations ch Change-Id: Ie46ae108f159b376e491b8364c049041ae914e87 Signed-off-by: Sona Sarmadi --- .../doc/eltf_params_updated.xml | 2 +- .../doc/getting_started_ucpe_manager.xml | 320 ++++++++++++++++++++- 2 files changed, 313 insertions(+), 9 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml index 7fe09ec..be0be23 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml @@ -42,7 +42,7 @@ export PATH=~/bin:$PATH correct also compared to the "previous" REL VER in pardoc-distro.xml "prev_baseline". - 2.2.1 + 2.2.2 2.4 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 688c278..3155be6 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 @@ -178,8 +178,8 @@ In order to manage the ucpemanager service, user can run: service ucpemanager start/stop - +
Installing with the restore option @@ -195,7 +195,7 @@ The name format of this file will be: SystemBackup_MMMDD_YYYY_HHMM_SS.zip (e.g - SystemBackup_Feb19_2013_2257_42.zip). + SystemBackup_Feb19_2013_2257_42.zip). Follow the steps for Installation provided above and provide an additional argument as shown below: @@ -380,7 +380,7 @@ Running this command will remove any vestiges of the existing ucpemanager service, if they exist, and reinstall the ucpemanager application on the specified target, restoring the data in the database - and files in the process. + and files in the process. The ucpemanager service is then started and the older version is now running on the system. @@ -888,6 +888,311 @@
+
+ Device Upgrade + +
+ Device Upgrade Process + + Device Upgrade/Install performs the following operations to the + device: + + + + Prepare for upgrade. This + stage tells the device that an upgrade is about to happen. + + + + Install file on device. This + stage copies the file to the uCPE device. + + + + Upgrade Device. This stage + causes the device to replace its running image with the newly + copied image. + + +
+ +
+ 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. + + Launch the Device Upgrade management console by selecting + Devices -> Upgrade from the top + toolbar. The console when launched will contain the following + tabs: + + + + Image Library. To add/delete an image. + + + + Upgrade Operations. See running upgrades, + cancel any upgrades in progress, start a device upgrade. + + + + Device Status. Shows the device + status. + + + + Configuration. Upgrade configuration + parameters. + + + + Press "Close" when the message File Uploaded + Successfully appears on the File Upload Screen. + + +
+ Image Library + + Add an image to the image + repository/library + + + + Select Devices -> + Upgrade. + + + + 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. Select the target hardware platform + corresponding to the image being uploaded (xeon-d or + atomc-3000). + + + + Click Send to upload the image to the + image repository. + + + + Delete an image from the image + repository + + + + Select Devices -> + Upgrade. + + + + Select the image you want to delete from the Image + Library tab and then click + Delete. + + +
+ +
+ Upgrade Operations + + 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. + + How to Install/Upgrade immediately or schedule for later + + + + Select Devices -> + Upgrade. + + + + 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. + + 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 time zone is set to Eastern Standard Time + (EST). + + + + + Description. An optional description + of the operation. It is recommended to add a description so that + different upgrades happening simultaneously can be + distinguished. + + + + Image File. Click on Choose + Image File to select the image file. + + + + 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. + + + + Upgrade Operation. Available options are: + + + + Install and Activate. This will + do an image installation as well as an upgrade. + + + + 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. + + + + Activate Only. This will activate + an already installed image on the device. + + + + + + +
+ +
+ Releases installed on a Device + + The installed releases on a device can be viewed by selecting + the device first, then from the top toolbar selecting + Configuration -> Upgrade. The + installed releases on the device, the release status, release state, + commit-id and release version will be listed in a table. +
+ +
+ Device Status + + The status of the installation and upgrade can be viewed in the + Device Status 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 Device Status. The ongoing + operations are listed at the top and a history of failed or + successful operations are listed at the bottom. + + + + To cancel an upgrade + operation + + + + Select Devices -> Upgrade + -> Upgrade Operations. + + + + Select an operation from the list and press Cancel + Upgrade and Confirm. The operation + will now be deleted from the list. + + +
+ +
+ Configuration + +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 Configuration. + + + + The configurable parameters are: + + + + 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. + + + + maxThreads. This number dictates how + many upgrades the system can manage at one time, either + individually launched or launched from the multi-device + screens. This value defaults to 20, which means that 20 + devices may be updated at one time. + + + + 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. + + + + +
+
+
+
VNF Management @@ -1163,8 +1468,8 @@ Path. When a user uses the uCPE Manager to create an instance for multiple VNFs, they 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. - + will require different cloud-init files, e.g.: a license + file. @@ -1209,7 +1514,7 @@ The last three properties are useful in conjuction with the vnfMgmt bridge type. They allow the user to map the internal VNF management port to an external port, useful for VNF - configuration from WAN. + configuration from WAN. In the previous example, the internal TCP port 443 (HTTPS) was mapped to the external port 60001, which allows the user to access @@ -1224,8 +1529,7 @@ When a VNF is onboarded and available in the VNF catalog, it can be instantiated on connected uCPE devices. The configurations provided - when the VNF is onboarded, serve as a template for instantiation. - + when the VNF is onboarded, serve as a template for instantiation. Follow the instructions below to instantiate a VNF: -- cgit v1.2.3-54-g00ecf