VRS Upgrade Guide from 14.9 to 14.10.0

Upgrade Cisco VRS from 14.9 to 14.10.0

Follow these steps in order.

This guide is for Cisco VRS only.

Before you start

You have SSH/login access to the VRS server
You know your database type: PostgreSQL 14+ or SQL Server
You know the database host, username, and password (ask DBA if needed)
Existing SQL Server customers can migrate to PostgreSQL. Plan the migration with your DBA before changing database settings.

Step 1 - Backup your settings

Save a copy of your current settings file so nothing is lost:

Bash

cp recording-solution/docker/config.env ~/config.env.backup

Check the backup exists:

Bash

ls -l ~/config.env.backup

Step 2 - Stop VRS

Bash

cd recording-solution
docker compose --env-file docker/config.env -f docker/docker-compose-cisco.yml down

Wait until this command finishes.

Step 3 - Update VRS files to 14.10.0

Open the file docker/docker-compose-cisco.yml and change every image tag that still says 14.9 or 14.9.0 to 14.10.0.

These lines should look like this (all end with :14.10.0):

front-end
apis (backend)
freeswitch-mixer
jtapi-connector
archival-process (only if this line is not commented)

Save the file.

Tip: If your team prefers to download the release again, ask them to check out Git tag 14.10.0, then put your backup back:

Bash

cp ~/config.env.backup recording-solution/docker/config.env

Step 4 - Update the database (required)

14.10.0 needs a few new columns in the VRS database (for wrap-up, call variables, and tags). This does not delete your recordings or old data. You can run it safely even if some columns already exist.

Important: Run the script only on database vrs. Do not run it on keycloak_vrs.

Ask your DBA which option you use, then run only one option below.

Option A - PostgreSQL

On a machine that has psql (often the database server):

Bash

cd recording-solution
psql -h <db_host> -U <db_user> -d vrs -f data/scripts/postgres.sql

Example:

Bash

psql -h 192.168.1.50 -U postgres -d vrs -f data/scripts/postgres.sql

Or in pgAdmin: open database vrs → Query Tool → open file data/scripts/postgres.sql → Run.

Option B - Microsoft SQL Server

Bash

cd recording-solution
sqlcmd -S <db_host> -U <db_user> -P <db_password> -d vrs -i data/scripts/sqlserver.sql

Or in SSMS: connect to database vrs → open data/scripts/sqlserver.sql → Execute.

If the script finishes without errors, the database part is done. Missing columns are added automatically; existing columns are left as they are.

Step 5 - Add new settings to config.env

Open:

Bash

nano recording-solution/docker/config.env

Add these lines (if they are not already there). You can keep the default values:

Bash

CISCO_WRAPUP_BACKFILL_ENABLED=true
CISCO_WRAPUP_SYNC_LAG_MIN=2
CISCO_WRAPUP_SYNC_BATCH_SIZE=500
CISCO_WRAPUP_SAFETY_BATCH_SIZE=50
CISCO_WRAPUP_CYCLE_BUDGET_SEC=45

Do not change your existing database password, Keycloak secret, or CUCM settings unless your team told you to.

Save and close the file (Ctrl+O, Enter, Ctrl+X in nano).

Step 6 - Start VRS again

Bash

cd recording-solution
chmod 755 install-cisco.sh
./install-cisco.sh
docker ps

Wait until install finishes. In docker ps you should see containers such as:

frontend
backend
mixer
keycloak
jtapi-connector

Step 7 - Open VRS in the browser

Open:

https://<your-server-IP>/#/login

Example: https://192.168.1.187/#/login

What this upgrade gives you

Cisco wrap-up and call variables for new calls after upgrade (pre-upgrade recordings are not backfilled)
Call tagging support in the database
All Cisco VRS images at version 14.10.0