12. Software Upgrade

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

12.1. Release Notes

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

  • Implemented call recording based on rtpengine framework.
  • Implemented selective peer probing via SIP OPTIONS ping.
  • Switched ngcp-panel from its custom RRD-based monitoring dashboard to grafana dashboards based on influxdb.
  • Replaced metrics gathering framework collectd and its RRD backend by telegraf and influxdb.

    • old RRD files will be preserved on the system, but not used by the monitoring infrastructure.
    • some of the checks previously done by ngcp-witnessd are now done natively by telegraf.
    • there is a new ngcp-influxdb-extract script that replaces the old rrd_extract script.
  • Added possibility to trace Kamailio memory usage per module.
  • Added "ngcpcfg clean" to clean ngcpcfg framework (see available options in "man ngcpcfg").
  • Added cdr source/destination_user_out fields to track peer rewrite.
  • Implemented capability to allow/reject SIP messages based on SIP User-Agent patterns.
  • Improved cleanuptools speed for large amount of CDRs.
  • Improved code quality by extending and introducing perlcritic/shellcheck/coverity/lintian checks.

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

12.2. Upgrade from previous versions to mr5.3.1

The sip:provider CE system upgrade to mr5.3.1 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.3.1
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.3.1
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.3.1, execute the following commands:

NGCP_CURRENT_VERSION=$(cat /etc/ngcp_version)
sed -i "s/$NGCP_CURRENT_VERSION/mr5.3.1/" /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
info

sip:provider CE can be upgraded to mr5.3.1 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.

info

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.

info

You can find a backup of some important configuration files of your existing installation under /var/backup/ngcp-mr5.3.1-* (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.3.1-*/upgrade.log.