Breadcrumbs

Upgrade Guide CX5.4.0 to CX5.5.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.

  1. Update Helm repo

    helm repo update expertflow

  2. Clone the CX repository on the target server

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

  3. Deploy the Core Helm chart

# Delete the existing log-masking configmaps:
kubectl -n expertflow delete configmap ef-logback-cm ef-node-logback-cm  

# Copy and replace files in the logback folder from CX-5.5.0 into the active solution directory "cim-solution/kubernetes/pre-deployment/logback"
CX-5.5.0/kubernetes/pre-deployment/logback to <current release>/pre-deployment/

# Create the masking pattern configmaps:
kubectl -n expertflow create configmap ef-logback-cm --from-file=pre-deployment/logback/logback-spring.xml
kubectl apply -f pre-deployment/logback/ef-node-logback-configmap.yaml

# Deploy the new chart version using the helm-values/ef-cx-custom-values.yaml last tested: 5.5.0
helm upgrade --install --namespace expertflow --create-namespace   ef-cx  --debug --values helm-values/ef-cx-custom-values.yaml expertflow/cx --version 5.5.0

# Restart the core components:
kubectl -n expertflow rollout restart deployment

Log Masking Update
The logback configmap steps above apply the CX 5.5.0 log masking refinement. From this release, CX masks only genuine PII fields in application logs, improving readability for ops and support teams. See PII Data Masking in Logs for details on what changed.

  1. Deploy the AgentDesk Helm chart

# Copy the unified agent translation directory to the current release 
  Copy From CX-5.5.0/kubernetes/pre-deployment/app-translations/unified-agent/i18n/ To ./pre-deployment/app-translations/unified-agent
  
# Deploy the new chart version using the helm-values/cx-agent-desk-custom-values.yaml  last tested: 5.5.0
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.5.0

  1. Deploy the Channels Helm chart

# Deploy the new chart version using the helm-values/cx-channels-custom-values.yaml last tested: 5.5.0
  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.5.0

  1. Deploy the Campaigns Helm chart

# Deploy the new chart version using the helm-values/cx-campaigns-custom-values.yaml  last tested: 5.5.0
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.5.0

  1. Deploy the MTT Helm chart

# Deploy the new chart version using the helm-values/mtt-single-custom-values.yaml last tested: 5.5.0
helm upgrade --install --namespace <tenant-ns> --debug  <tenant-id> --values helm-values/mtt-single-custom-values.yaml  expertflow/MTT-single --version 5.5.0

  1. AI Deployment Guide <Optional>

    # Copy the expertflow-ai directory to the current release
Copy From CX-5.5.0/kubernetes/pre-deployment/expertflow-ai/ To ./pre-deployment/

    1. Use the following guide to deploy Agent Co-Pilot.

    2. Use the guide to deploy QM-by-AI.

  2. Setup Apisix

    # Clone the latest version apisixi custom values last tested: 5.5.0
helm show values expertflow/apisix --version 5.5.0  > helm-values/apisix-custom-values.yaml
# Update the helm-values/apisix-custom-values.yaml file for given parameters
global:
  ingressRouter: "*.expertflow.com"   # * for MTT & replace FQDN for on-prem
  ingressClassName: "nginx"
  ingressTlsCertName: "ef-ingress-tls-secret"
# Deploy the apisix using updated custom-values.yaml file
helm upgrade --install --namespace ef-external --values helm-values/apisix-custom-values.yaml apisix expertflow/apisix --version 5.5.0
# Verify the deployment of the apisix
kubectl -n ef-external get deploy

configuration:

For the Campaign call compliance feature, use this guide