VRS Upgrade Guide from 14.6 to 14.6.1

Steps to Upgrade VRS with CISCO Deployment Profile

  1. Place record.lua in the scripts directory, which can be found here /usr/local/freeswitch/scripts. Add the IP address in record.lua also.

  2. Stop and remove all the VRS containers and images running in the docker.

  3. Navigate to the recording-solution/docker directory.

  4. Open docker-compose-cisco.yml file.

  5. Open the docker-compose-cisco.yml and add this container

.....
.....

keycloak:
    image: quay.io/keycloak/keycloak:23.0.1
    environment:
      KC_DB: mssql
      KC_DB_URL: jdbc:sqlserver://${KC_HOSTNAME}:1433;databaseName=keycloak_vrs3;encrypt=true;trustServerCertificate=true
      KC_DB_USERNAME: sa
      KC_DB_PASSWORD: Expertflow464
      KEYCLOAK_ADMIN: admin
      KEYCLOAK_ADMIN_PASSWORD: admin
      KC_HOSTNAME: ${KC_HOSTNAME}
      KC_HOSTNAME_PORT: 8088
      JDBC_PARAMS: "connectTimeout=30000;socketTimeout=60000"
      KC_HTTP_RELATIVE_PATH: /auth
      KC_DB_POOL_MIN_SIZE: "1"
      KC_DB_POOL_MAX_SIZE: "10"
      KC_DB_POOL_INITIAL_SIZE: "1"
      KC_TRANSACTION_XA_ENABLED: "false"
      KC_HOSTNAME_STRICT: false
    ports:
      - "8088:8080"
    command:
      - "start-dev"
    healthcheck:
      test: curl --fail http://localhost:8080/auth || exit 1
      interval: 30s
      timeout: 10s
      retries: 5
    restart: always
    networks:
      - cisco-vrs-network
  1. Replace ${KC_HOSTNAME} with the IP address of Database Server. Database named “keycloak_vrs3” should be created. You can add name of your choice.

  2. Add the database username as the value of KC_DB_USERNAME and password as the value of KC_DB_PASSWORD.

  3. Replace KC_HOSTNAME with the IP address of recorder server.

  4. After adding the KeyCloak container, navigate application directory and run ./install-cisco so that KeyCloak docker container can started and it can be access via Web.

  5. Verify KeyCloak is accessible via, http://IP:8088/auth

  6. Update all the tags. Add 14.6.1 tag for apis and mixer docker compose.
    image: gitlab.expertflow.com:9242/voice-recording-solution/apis:14.6.1

  7. Open <your installation folder name>/docker/config.env and tally all the following env variables. Add the following variables and assign values accordingly.

Name

Description

1

LOCAL_MACHINE_IP

IP Address of local machine. Example, 192.168.1.101

2

KEYCLOAK_REALM_NAME

Its value is “VRS”. In case of new realm name to be created follow step 4 of keycloak setup

3

KEYCLOAK_CLIENT_ID

Its value is “vrs“. In case of new keycloak client id follow step 6 of keycloak setup

4

KEYCLOAK_CLIENT_SECRET

Keycloak client secret please follow the step 8 of keycloak setup

5

KEYCLOAK_URL

https://keycloak:8080/

  1. The Following variables will be added/updated in the config.env file. Open the config.env file.

Name

Description

1

VRS_URL

URL of a local machine. example, https: //192.168.1.101

2

ROOT_DOMAIN

Set it to “VRS”

3

TENANT_URL

Comment this out

4

CX_ROOT_DOMAIN

Comment this out

5

EFCX_FQDN

Comment this out

  1. Run the SQL Scripts placed in /root/recording-solution/data/scripts/ so that is_encrypted column can be added in Mixed_Sessions Table.

  2. Navigate application directory and run ./install-cisco and check you container using docker ps command.

  3. Once the containers get up the VRS Application should be accessible on https://<IP-Address >/#/login

Steps to Upgrade VRS with EFCX Deployment Profile

Follow these steps to update your deployment profile to the latest version:

  1. Update Image Tags: Open the docker-compose-efcx.yaml file in your preferred text editor. Locate the apis and frontend services and update their version tags from 14.6 to 14.6.1. Save the changes before closing the file.

  2. Navigate to the Application Directory: Open your terminal and change your directory to the root folder where the application files are located.

  3. Execute the Install Script: Run the installation script to apply the changes:

    ./install-efcx
    
  4. Verify Container Status: Once the script finishes, confirm that the containers are running correctly by using the following command:

    docker ps
    
  5. Verify Application Access: After the containers are confirmed as "Up," the VRS Application should be fully accessible via your mapped FQDN.