Upgrade Guide CX5.1.0 to CX5.2.0

Before upgrading, ensure that the system is idle, i.e, all agents are logged out from the AgentDesk.

Custom Configuration Strategy

For detailed guidelines on applying environment-specific configurations using custom values.yaml layering,

Refer to the CX Helm Chart Custom Configuration Strategy guide.

In this release, ActiveMQ Classic is being replaced by ActiveMQ Artemis

  1. Update Helm repo

    helm repo update expertflow
    
  2. Clone the CX repository on the target server

    # Create CX-5.2.0 directory from root
      mkdir CX-5.2.0
    # Navigate to CX-5.2.0
      cd CX-5.2.0
    # Clone the CX-5.2.0 branch of the cim-solution repository
      git clone -b CX-5.2.0 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git $HOME/CX-5.2.0
    # Navigate to current release /kubernetes
      cd <current-release-directory>/kubernetes
      
    
  3. Uninstall the ActiveMQ

    # Uninstall the ActiveMQ chart
      helm uninstall -n ef-external activemq
    # Remove the ActiveMQ PVC
      kubectl delete pvc -n ef-external activemq-activemq-0 
    
  4. Deploy the Artemis

    # Copy the activemq-artemis directory from CX-5.2.0/cim-solution/kubernetes/pre-deployment/activemq-artemis 
      to current release /pre-deployment
    # Copy the CX-5.2.0/cim-solution/kubernetes/scripts/artemis-install.sh  
      to current release /scripts
    

    Use the following guide to deploy Artemis.

  5. Deploy the AgentDesk helm chart

    # Update the app-translations for unified-agent
      Copy CX-5.2.0/cim-solution/kubernetes/pre-deployment/app-translations/unified-agent/i18
      To /pre-deployment/app-translations/unified-agent
      kubectl -n expertflow  delete configmap ef-app-translations-cm 
      kubectl -n expertflow  create configmap ef-app-translations-cm --from-file=pre-deployment/app-translations/unified-agent/i18n
    
    # Deploy the new chart version using the helm-values/cx-agent-desk-custom-values.yaml
      helm upgrade --install --namespace expertflow --set global.efCxReleaseName="ef-cx"  cx-agent-desk  --debug --values helm-values/cx-agent-desk-custom-values.yaml expertflow/agent-desk --version 5.2.0
    
  6. Update Application Gateway (APISIX)

    # Update the apisix-custom-values.yaml file with latest updates from 5.2.0 version, make sure to save any customisation and add once the apisix-custom-values.yaml is updated.
    helm show values expertflow/apisix --version 5.2.0  > helm-values/apisix-custom-values.yaml
    helm upgrade --install --namespace ef-external --values helm-values/apisix-custom-values.yaml apisix expertflow/apisix --version 5.2.0
    
  7. Deploy the Core helm chart

    # Deploy the new chart version using the helm-values/ef-cx-custom-values.yaml 
      helm upgrade --install --namespace expertflow --create-namespace   ef-cx  --debug --values helm-values/ef-cx-custom-values.yaml expertflow/cx --version 5.2.0
    
  8. Deploy the Channels helm chart

    # Deploy the new chart version using the helm-values/cx-channels-custom-values.yaml
      helm upgrade --install --namespace expertflow --set global.efCxReleaseName="ef-cx" --debug cx-channels --values helm-values/cx-channels-custom-values.yaml  expertflow/channels --version 5.2.0
    
  9. Deploy the Campaigns helm chart

    # Deploy the new chart version using the helm-values/cx-campaigns-custom-values.yaml
    helm upgrade --install --namespace expertflow   --set global.efCxReleaseName="ef-cx"  cx-campaigns --debug --values helm-values/cx-campaigns-custom-values.yaml expertflow/campaigns --version 5.2.0
    
  10. Deploy the QM helm chart (for single-tenant only)

    # Deploy the new chart version using the helm-values/cx-qm-custom-values.yaml
      helm upgrade --install --namespace=expertflow --set global.efCxReleaseName="ef-cx" qm  --debug --values=helm-values/cx-qm-custom-values.yaml expertflow/qm --version 5.2.0
    
  11. Deploy the MTT helm chart

    # Deploy the new chart version using the helm-values/mtt-single-custom-values.yaml
    helm upgrade --install --namespace <tenant-ns> --debug  <tenant-id> --values helm-values/mtt-single-custom-values.yaml  expertflow/MTT-single --version 5.2.0
    
  12. Deploy the Reporting connector

    # Edit pre-deployment/reportingConnector/<tenant_config_directory>/reporting-connector.conf, and update the following environment variable name
      tenant_id = <tenantId> // default is expertflow 
    to 
      tenantid = <tenantId> // default is expertflow 
    # Delete ef-reporting-connector-conf-cm configMap
      k delete cm -n <tenant-namespace> ef-reporting-connector-conf-cm
    # Create the ef-reporting-connector-conf-cm configMap
      kubectl -n <tenant-namespace> create configmap ef-reporting-connector-conf-cm --from-file=pre-deployment/reportingConnector/<tenant_config_directory>/reporting-connector.conf
    # Deploy the reporting
      helm upgrade --install --namespace <tenant-namespace> --set global.efCxReleaseName="ef-cx"   cx-reporting --debug --values helm-values/cx-reporting-scheduler-custom-values.yaml  expertflow/reporting  --version 5.2.0  
    
  13. Update Voice Components using the following guide