Upgrading Enea NFV Access
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.
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.
Extract the
Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
folder.
The directory in which the archive has been unpacked will be
denoted as <uCPEM-installdir>.
Enter <uCPEM-installdir>.
Run the following command with the root account and change
/opt/ems to the correct location of the Enea uCPE
Manager installation:
./upgrade.sh /opt/ems \
Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
Running this command will:
Stop the currently running ucpemanager
service.
Create a compressed file of the ucpemanager
application folder
(ucpemanager-Back-up-YYYYddMMHHmm.tar.gz), which
contains a snapshot of the existing installation.
The snapshot file created during the upgrade can be used for
restoring the Enea uCPE Manager.
Extract the application files from the specified compressed
install kit.
Start the ucpemanager service.
Restoring a previous Enea uCPE Manager Installation
How to restore a previous Enea uCPE Manager
installation
Extract
Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz
The directory in which the archive has been unpacked will be
denoted as <uCPEM-installdir>.
Copy the snapshot file
(ucpemanager-Backup-YYYYddMMHHmm.tar.gz)
created during a previous Enea uCPE Manager Upgrade or Enea uCPE
Manager Uninstall Operation into the
<uCPEM-installdir> directory.
Enter <uCPEM-installdir>.
Run the following command with the root user and change
/opt/ems to the correct location of the Enea uCPE
Manager installation:
./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz
Running this command will:
Remove any vestiges of the existing
ucpemanager service, if they exist.
Reinstall the Enea uCPE Manager application on the specified
target location, restoring the data in the database and files in the
process.
The ucpemanager service will then start with
the older version now running on the system.
Uninstalling an existing Enea uCPE Manager Installation
How to uninstall an existing Enea uCPE
Manager installation
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 Enea uCPE
Manager installation:
./uninstall.sh /opt/ems
Running this command will:
Stop the currently running ucpemanager
service.
Create a compressed file of the ucpemanager
application folder:
ucpemanager-Back-up-YYYYddMMHHmm.tar.gz, which
contains a snapshot of the existing installation and functions as a
restore point.
The snapshot file created during the uninstall can be used
for restoring the Enea uCPE Manager.
Uninstall the ucpemanager service, so that
it will not startup on reboot.
Uninstall the database service.
Completely remove the contents of the application and database
folders.
After these steps, the Enea uCPE Manager is completely removed
from the system.
uCPE device Upgrades
A uCPE device can be upgraded using the Enea uCPE Manager
GUI.
The uCPE device Upgrade Process
The Device Upgrade/Install option performs the following
operations to the uCPE device:
Prepare for upgrade. This
stage prepares the files needed for an upgrade.
Install file on device. This
stage copies the file to the uCPE device.
Upgrade Device. This stage
upgrades the uCPE device to a newer version.
Managing the 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.
Launch the Device Upgrade management console by selecting
Devices -> Upgrade from the top
tool-bar. The console will contain the following tabs:
Image Library. To add/delete an
image.
Upgrade Operations. See running upgrades,
cancel any upgrades in progress, start a uCPE device upgrade.
Configuration. Upgrade configuration
parameters.
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
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.
Image Library
Adding 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 (must be of type
rootfs.os-tree.tar.bz2).
Select the target hardware platform corresponding to the
image being uploaded (xeon-d or
atom-c3000).
Click Send to upload the image to the
image repository.
Deleting 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 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
memory and will not persist across reboots of the server.
How to Install/Upgrade a device
immediately or schedule the process 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 uCPE 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 hour represents the local Enea uCPE Manager server
hour.
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 uCPE Devices that
can accept an image file is populated when the image file is
chosen.
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:
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 uCPE 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 uCPE device.
When the uCPE device activates the upgrade, it will be
rebooted automatically.
Releases installed on a uCPE device
The installed releases on a uCPE device can be viewed by
selecting the uCPE device first, then from the top toolbar selecting
Configuration ->
Upgrade.
The installed releases on the uCPE device, the release status,
release state, commit-id and release version will
be listed in a table.
uCPE 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.
To view the status of an installation or
upgrade operations
Select Devices ->
Upgrade.
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.
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 then be deleted from the list.
Configuration
The default values present in the configuration of each uCPE
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 no absolute path name is given it is assumed 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 uCPE
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.