XV. VigorACS and VigorConnect

Upgrade VigorACS 3 server on Linux platform

Products:
VigorACS 3
Keywords:
ACS3
ACS Server
Ubuntu
Ubuntu Server
Show all

This guide demonstrates how to upgrade an active VigorACS 3 installation that's running within a Linux-based operating system.

This procedure assumes access to Root Privileges on the Linux server. In the guide it's assumed that they are accessible via  the "sudo" command. If 'sudo' is not installed on the system then alternatively use the eleveation process for your distribution such as su to use a user which has the neccesary permissions.
Upgrading an existing VigorACS installation requires the MySQL Root Password, ensure that the password is available and correct before proceeding.

The upgrade procedure keeps all existing data, license information and router logs. There are some additional, optional steps to go through before the upgrade to ensure that all VigorACS information is backed up prior to the upgrade, allowing for rolling back or recovering if required.

This guide requires that the VigorACS installation has been installed as demonstrated in this guide and that the server is operating normally, with an active VigorACS license (or trial license).

Step 1 - Check account access and install necessary applications

Make sure your Linux user account has root privileges. The "sudo" prefix will be used to identify commands that require root privileges.

Ensure these packages are installed on your Linux VigorACS server:

  • unzip (Necessary before running installation script)
  • bzip2 (Necessary before running installation script)
  • net-tools (Included in the installation script)
  • vim (Included in the installation script)
  • libaio1/libaio-devel (MariaDB 10 dependencies. Included in the installation script)
  • epel-release/cabextract/xorg-x11-font-utils/fontconfig (fonts package is necessary if you have a minimum install of the linux distribution. Included in the installation script)
  • libcap (required for packet capture from VigorACS 2.4.0 onwards. Included in the installation script)

NOTE: The installation script for the standard Linux distributions should include most of the required dependencies, but if you are using a not-so-common distribution or a hardended install, you might need to install the dependencies manually.

Ubuntu & Debian variants: sudo apt install unzip bzip2 net-tools

OpenSUSE: sudo zypper install unzip bzip2 net-tools

RedHat: sudo yum install unzip bzip2 net-tools

Step 2 - Download VigorACS Installation File

Create a new directory to store the VigorACS installation files in. For example, VigorACS 3.0.5 can go into "acs305" of the user account's home directory. Navigate into the directory, download the VigorACS 3 installer package and extract the contents into the current directory.

Create a new directory in user account's Home directory:

/$ cd
~$ mkdir acs305

Navigate into the installer files directory and download VigorACS installer package from the file location provided by your VigorACS support agent:

~$ cd acs305
~/acs305$ wget https://www.draytek.co.uk/downloads/vigoracs.tar.bz2

Extract the VigorACS installation file into the current directory:

$ tar -jxv -f VigorACS_Unix_Like_xxxxxx_xxxxx.tar.bz2
or

$ bzip2 -cd VigorACS_Unix_Like_xxxxxx_xxxxx.tar.bz2 | tar xvf -

Step 3 - Set Install Script Permissions

Change the privileges of install.sh and uninstall.sh scripts to make them executable with these two commands:

$ chmod 755 ./install.sh
$ chmod 755 ./uninstall.sh

Then list the directory contents using the "ls -l" command, executable files are displayed in green:


$ ls -l

Step 4 - Shutdown VigorACS Service

Go to the path "/usr/local/vigoracs/VigorACS/bin" and execute the script "vigoracs.sh":

$ cd /usr/local/vigoracs/VigorACS/bin
/usr/local/vigoracs/VigorACS/bin$ sudo ./vigoracs.sh

Select the option to "Shutdown VigorACS". Once the service has finished shutting down, select the option to exit the script.

acs3 upgrade 20

Step 5 - Manually Backup Current VigorACS Installation (Optional)

If any problems occur during the installation or if there is an issue with the later version of VigorACS, taking a backup can be essential for restoring VigorACS.
If using a Virtual Machine, an alternative could be to take a Snapshot of the current virtual machine status, which can be rolled back to if the upgrade fails.

Step 5.1 - Backup existing VigorACS installation

Backing up the existing installation with all of its current directory contents, allows it to be restored quickly if required.

Check the VigorACS directory size: $ du -sh /usr/local/vigoracs/VigorACS

Create a copy of the current VigorACS installation to the home directory. Replace "2xx" with the currently installed version of VigorACS, i.e. "VigorACS_253_Backup":
$ sudo cp -rp /usr/local/vigoracs/VigorACS ~/VigorACS_2xx_Backup

Step 5.2 - Backup Files Repository data

Backup the Files Repository data, which contains Config Backups, Firmware files and other files used by VigorACS. Replace "xxx" with your ACS version i.e. "EMS_253": $ sudo cp -rp /srv/EMS /srv/EMS_xxx

Step 5.3 - Backup VigorACS SQL data

VigorACS includes a script that will take a snapshot of the current VigorACS database contents and store them in a compressed file. It requires the "backupconfig.txt" configuration file to be configured with the MySQL db root password to operate. The password is cleared when VigorACS is updated.

Go to the backup script's directory:
$ cd /usr/local/vigoracs/VigorACS/bin/acs_util/dbutil/BackupRestoreScript/Linux/

Edit the config file to include the DB root password - this file is reset during the upgrade procedure. Move the cursor around with the arrow keys and press Ctrl+X to save & exit:
$ sudo nano backupconfig.txt

Run the backup script:
$ sudo ./automysqlbackup.sh

To check that the backup has completed successfully, check the directory that the backup has saved to.
This should contain an .sql.gz file created at the current time:
$ sudo ls -lah /root/temp/mysqlbackups/now/tr069

Step 6 - Run Installer Script

Navigate back to the directory that the new VigorACS installation files were extracted into. Start the VigorACS installation script:

$ cd ~/acs305
~/acs305$ sudo ./install.sh

acs3 upgrade 19

The installation program will prompt to install some dependencies required by VigorACS.

If your VigorACS server installation is working without issue and users are able to login, enter "n", otherwise, it may be helpful to install these dependencies.

Step 7 - Install / Update InfluxDB

  • If upgrading from VigorACS before 2.4.0: Install InfluxDB to allow VigorACS to record graph data & statistics information. Select option "3" to install then follow the instructions to convert data into the format required for InfluxDB
  • If upgrading from VigorACS after 2.4.0: You can check whether an update is required by selecting the option.

acs3 upgrade 5

Step 8 - Upgrade Java

Select option "4". This will display the current version of Java installed and the version available from the installer.

Select "y" to upgrade Java if the installer has a newer version.

acs3 upgrade 8

Step 9 - Upgrade VigorACS

Select option "6" to begin the VigorACS upgrade. Select the options for your VigorACS & MySQL configuration and enter the MySQL DB root password when prompted:

acs3 upgrade 10

Test the password. If the password is incorrect, press Ctrl+C to end the installation script immediately. Verify the password and retry the install script.

Once the VigorACS installer has successfully accessed the database, it will proceed with the upgrade.

acs3 upgrade 11

After installing files, the installer will prompt to change the jBoss configuration, which controls the TLS ciphers that VigorACS will allow to connect to the server. The selection depends on router support - only select "standalone-compatible.xml" if there are older CPEs connecting to the VigorACS server that do not support TLS 1.2.

Otherwise, select the recommended "standalone.xml" (recommended) setting to allow only TLS 1.2 and later.

There can be a delay when the script displays "Start to upgrade tr069 db...".

acs3 upgrade 12

Wait for this to complete, the installer will then display "Upgrade tr069 table Successfully..." and finish the installation.

Exit the installer script once the upgrade has completed successfully.

acs3 upgrade 14

Step 10 - Start VigorACS Service

Go to the path "/usr/local/vigoracs/VigorACS/bin" and execute the script "vigoracs.sh":

$ cd /usr/local/vigoracs/VigorACS/bin
/usr/local/vigoracs/VigorACS/bin$ sudo ./vigoracs.sh

Select the option to "Start VigorACS". Once the service has finished starting up, select the option to exit the script.

acs3 upgrade 15

Once the VigorACS services are showing "VigorACS process id" values, exit the vigoracs.sh script.

acs3 upgrade 17

Step 11 - Check VigorACS

Access the VigorACS server from its URL, log in to VigorACS.

acs3 upgrade 18

In VigorACS 3; to find the version number, click the information icon and the Version number will be displayed in the About VigorACS menu:

acs3 upgrade versioncheck

Troubleshooting

How to check if the VigorACS services have started successfully?

To troubleshoot the VigorACS 3 service, if it isn't able to start correctly or has another issue, check the server log, which can be found with this command:

tail -f /usr/local/vigoracs/VigorACS/standalone/log/server.log

If you cannot see the start message in this log file, please provide the log and all of the VigorACS install information to DrayTek UK technical support: Contact Support


How do you rate this article?

1 1 1 1 1 1 1 1 1 1