12. Software Upgrade

12.1. Release Notes
12.2. Upgrade from previous versions to mr5.1.2

12.1. Release Notes

The sip:provider CE version mr5.1.2 has several important changes comparing to the previous release:

  • kamailio has been upgraded to version 4.4.5
  • [PRO/Carrier] Packages elasticsearch rsyslog-elasticsearch openjdk-7-jre-headless were removed [TT#6711]
  • [PRO/Carrier] Introduced a new "Party Call Control" feature to support call and notifications integration with external APIs
  • rtpengine configuration was moved from the /etc/defaults/ file to a dedicated config file in /etc/rtpengine/. Legacy config options from the defaults file continue to be supported and take precedency over options found in the config file, but users are urged to migrate custom config options from the defaults file to the config file [TT#5566]
  • voicemail: refactored datetime announcements, they are flexible and dynamically configured in say.conf, to potentially support any language and desired formats.
  • ngcpcfg supports kernel modules to load on boot. Kernel module dummy is available and disabled in config.yml. [TT#6640]
  • [PRO/Carrier] faxserver: numbers normalisation is also applied to emails
  • timezones support for ngcp-panel, ngcp api and the voicemail announcements
  • redis server init script got a self-heal to recover in case of corrupted redis aof file
  • prosody modules got changes:

    • refresh upstream modules to 51cf82d36a8a
    • mod_sipwise_offline: store offline messages on DB
    • mod_mam: store messages on DB, support urn:xmpp:mam:1, don’t store bodyless chat messages

Please find the complete changelog in our release notes on our WEB site.

12.2. Upgrade from previous versions to mr5.1.2

The sip:provider CE system upgrade to mr5.1.2 will be performed in a couple of tasks:

  • Verify APT source lists
  • Upgrade NGCP software packages
  • Upgrade NGCP configuration templates
  • Upgrade NGCP DB schema
  • Upgrade the base system within Debian (v8) to the latest package versions
[Warning]

ensure you are using Sipwise APT repositories. Public Debian mirrors may not provide packages for old Debian releases anymore. Also they can be outdated. Consider to use Sipwise repositories for the time of upgrade.

Execute the following commands as root:

echo "# Please visit /etc/apt/sources.list.d/ instead." > /etc/apt/sources.list

mkdir -p /etc/apt/sources.list.d
for file in /etc/apt/sources.list.d/*.list ; do mv "${file}" "${file}.DISABLED" ; done

NGCP_CURRENT_VERSION=$(cat /etc/ngcp_version)
cat > /etc/apt/sources.list.d/debian.list << EOF
# Debian repositories, deployed via upgrade ${NGCP_CURRENT_VERSION}->mr5.1.2
deb https://debian.sipwise.com/debian/ jessie main contrib non-free
#deb-src https://debian.sipwise.com/debian/ jessie main contrib non-free
#
deb https://debian.sipwise.com/debian-security/ jessie-security main contrib non-free
#deb-src https://debian.sipwise.com/debian-security/ jessie-security main contrib non-free
#
deb https://debian.sipwise.com/debian/ jessie-updates main contrib non-free
#deb-src https://debian.sipwise.com/debian/ jessie-updates main contrib non-free
EOF

NGCP_CURRENT_VERSION=$(cat /etc/ngcp_version)
cat > /etc/apt/sources.list.d/sipwise.list << EOF
# NGCP_MANAGED_FILE
# Sipwise repository, deployed via upgrade ${NGCP_CURRENT_VERSION}->mr5.1.2
deb https://deb.sipwise.com/spce/${NGCP_CURRENT_VERSION}/ jessie main
#deb-src https://deb.sipwise.com/spce/${NGCP_CURRENT_VERSION}/ jessie main
EOF

Run "apt-get update" and ensure you have no warnings/errors here.

For upgrading the sip:provider CE to release mr5.1.2, execute the following commands:

NGCP_CURRENT_VERSION=$(cat /etc/ngcp_version)
sed -i "s/$NGCP_CURRENT_VERSION/mr5.1.2/" /etc/apt/sources.list.d/sipwise.list
apt-get update
apt-get install ngcp-upgrade-ce

Run the upgrade script as root like this:

ngcp-upgrade
[Note]

sip:provider CE can be upgraded to mr5.1.2 from previous release or previous build only. The script ngcp-upgrade will find all the possible destination releases for the upgrade and allow to choose the proper one.

[Note]

If there is an error during upgrade, the ngcp-upgrade script will request you to solve it. Once you’ve fixed the problem just re-execute ngcp-upgrade again and it will continue from the previous step.

The upgrade script will ask you to confirm that you want to start. Read the given information carefully, and if you agree, proceed with y.

The upgrade process will take several minutes, depending on your network connection and server performance. After everything has been updated successfully, it will finally ask you to reboot your system. Confirm to let the system reboot (it will boot with an updated kernel).

Once up again, double-check your config file /etc/ngcp-config/config.yml (sections will be rearranged now and will contain more parameters) and your domain/subscriber/peer configuration and test the setup.

When all finishes successfully check that replication is running. Check ngcp-status. Finally, do a basic functionality test. Check web interface, register two test subscribers and perform a test call between them to ensure call routing works.

[Note]

You can find a backup of some important configuration files of your existing installation under /var/backup/ngcp-mr5.1.2-* (where * is a place holder for a timestamp) in case you need to roll back something at any time. A log file of the upgrade procedure is available at /var/backup/ngcp-mr5.1.2-*/upgrade.log.