Upgrading SIP Feature Server

Use this procedure to upgrade from one version of SIP Feature Server 8.1.2 to another.

Important

While upgrading Feature Server, launcher.xml will not be updated and the options in launcher.xml remain unchanged.

Important

Beginning with SIP Feature Server version 8.1.203.XX, the Embedded Cassandra cluster mode is being deprecated and the feature will be completely removed in future versions. As part of this deprecation, the Embedded Cassandra cluster mode will be removed from the default installation in future versions. If your current deployment model uses the Embedded Cassandra cluster mode for SIP Feature Server, Genesys recommends you to migrate the deployment to other Cassandra modes.

Upgrading while Feature Server is running (recommended)

To upgrade a running Feature Server environment, stop and upgrade one Feature Server Cassandra cluster instance at a time, beginning with the master Feature Server.

1. On the Feature Server master node (which is also the Cassandra seeds node, in case you are running the embedded Cassandra cluster), back up all files in the etc folder, which includes the cassandra.yaml file.
2. Stop Feature Server.
3. Install Feature Server from the installation package. During the upgrade, the installer uses the values provided during a fresh installation.
4. Start Feature Server.
5. Repeat steps 2-4 for each Feature Server instance.
6. Upgrade or install and configure the Feature Server GAX Plug-in.
7. If you are updating a Feature Server 8.1.200.88 environment that also uses the Feature Server dial plan, you must run a migration script.
8. Optionally, create and assign voicemail profiles.

Upgrading while Feature Server is stopped

To upgrade a running Feature Server environment, upgrade one Feature Server Cassandra cluster instance at a time. Upgrade the master Feature Server last.

1. On the Feature Server master node (which is also the Cassandra seeds node, in case you are running the embedded Cassandra cluster), back up all files in the etc folder, which includes the cassandra.yaml file. Do not upgrade the master node until after you have upgraded all other nodes.
2. On a non-master node, install Feature Server from the installation package. During the upgrade, the installer uses the values provided during a fresh installation.
3. Start Feature Server.
4. Repeat steps 2-3 for each Feature Server instance.
5. Upgrade or install and configure the Feature Server GAX Plug-in.
6. If you are updating a Feature Server 8.1.200.88 environment that also uses the Feature Server dial plan, you must run a migration script.
7. Optionally, create and assign voicemail profiles.

Restore HTTPS configuration

The following procedure shows how to restore HTTPS configuration of Feature Server after an upgrade. This procedure is applicable only while upgrading Feature Server to version 8.1.201.92 or above.

1. After upgrading to version 8.1.201.93 or above, the Feature Server installation folder contains the following files retrieved from the folder containing the previous versions: start.ini.bak and etc.bak in both Windows and Linux operating systems. Previously, when upgrading Feature Server overwrote these files rather than retrieving existing files.
2. Compare and copy the difference in the values of start.ini, start.ini.bak and etc/jetty-ssl.xml, etc.bak/jetty-ssl.xml and apply the differences in start.ini and etc/jetty-ssl.xml.
3. Copy etc.bak/keystore to etc/keystore to restore the configuration.

Important

After upgrading to Feature Server version 8.1.201.92, the backup of the etc folder and the start.ini file will be named as start.ini.backup (Windows), start.ini.bak (Linux), etc.backup (Windows), and etc.bak (Linux), respectively.

Post upgrade steps for version 8.1.203 and later

If you have upgraded SIP Feature Server to version 8.1.203 and later and used external Cassandra in your deployment, you can deactivate the Embedded Cassandra module from the deployment. Note that deactivating the Embedded Cassandra module is recommended but it is an optional step.

To deactivate the Embedded Cassandra module:

1. Locate the start.ini file in the path: <FS installation folder>/start.ini.
2. Open the file with a text editor and remove the line --module=fs-cass11.
3. Save the file.
4. Restart SIP Feature Server if it is running.
5. After restart, remove the installation files from the <FS installation folder>/lib/fs-cass11 folder.

Switching from Thrift to CQL protocol for Cassandra communication

If you have upgraded SIP Feature Server to version 8.1.203 and later and used external Cassandra in your deployment, you can switch over to use the new CQL communication protocol by referring the following procedure:

• Make sure the Cassandra cluster is configured to accept connections on the CQL port (9042).
• Make sure you have python3 interpreter available on all the SIP Feature Server host as per prerequisites.
• In all the SIP Feature Server application,
  • Configure the connection-type=cql option in the Cassandra section of the application object
  • Configure the process-launcher option in the python section pointing to the Python 3.x executable.
  • Restart the SIP Feature Server node.

Post switchover steps after transitioning from Thrift to CQL protocol

Complete the following steps after you switched over the communication protocol from Thrift to CQL. Note that this procedure is recommended but it is optional.

1. Deactivate the Thrift library by referring the procedure here.
2. Deactivate the embedded jython module by referring the following procedure. The embedded jython is used for execution of dialplan and maintenance scripts, which is now replaced with the native python interpreter.

   Important

   Before deactivating the embedded jython module, ensure the Python executor is configured in the application options under the python section.

   1. Locate the start.ini file in the path: <FS installation folder>/start.ini.
   2. Open the file with a text editor and remove the line --module=fs-jython.
   3. Save the file.
   4. Restart SIP Feature Server if it is running.
   5. After restart, remove the installation files from the <FS installation folder>/lib/fs-jython folder.