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

Update Helm repo
```
helm repo update expertflow
```

Clone the CX repository on the target server

Bash

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

Deploy the Core Helm chart

# Copy graphqls files to the current release
Copy from 5.7.0/kubernetes/pre-deployment/conversation-manager/graphql/schemas/CimEvent.graphqls to ./pre-deployment/conversation-manager/graphql/schemas/

Copy from 5.7.0/kubernetes/pre-deployment/conversation-manager/graphql/graphql-mongodb-rules.json to ./pre-deployment/conversation-manager/graphql/

# Delete Existing Configmaps
k delete cm -n expertflow conversation-manager-graphql-mongodb-rules conversation-manager-graphql-schemas

# Apply graphql Configmap 
kubectl create configmap -n expertflow conversation-manager-graphql-schemas --from-file=pre-deployment/conversation-manager/graphql/schemas

kubectl create cm -n expertflow conversation-manager-graphql-mongodb-rules --from-file=pre-deployment/conversation-manager/graphql/graphql-mongodb-rules.json

# 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.7.0

Deploy the AgentDesk Helm chart

# Copy the unified agent translation directory to the current release
Copy from 5.7.0/kubernetes/pre-deployment/app-translations/unified-agent/i18n/ to ./pre-deployment/app-translations/unified-agent

# Run script from <kubernetes> diectory, to update the translations
  chmod +x scripts/upload_agent_desk_translations.sh
  ./scripts/upload_agent_desk_translations.sh

# 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.7.0

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.7.0

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.7.0

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.7.0

Deploy Artemis

Run as Helm-based

# Update Artemis tag on ef-artemis-custom-values.yaml
  Artemis tag: 2.42.0-activemq-artemis-5-7-0
helm upgrade --install=true  --namespace=ef-external --values=helm-values/ef-activemq-custom-values.yaml activemq expertflow/artemis --version 5.7.0

Run as a system service.

# Copy the attached Artemis Auth Plugin Jar file
Copy from 5.7.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar to ./pre-deployment/activemq-artemis/artifacts/plugins/
####### restart artemis
sudo systemctl restart artemis

Automate Vault Unseal and Token Recovery for EF CX <Optional>
Deploy the Vault Helm chart

# Deploy the new chart version using these commands 
helm show values expertflow/vault --version 5.7.0 > helm-values/ef-vault-custom-values.yaml

helm upgrade --install --namespace vault --create-namespace vault --debug --values helm-values/ef-vault-custom-values.yaml expertflow/vault --version 5.7.0

To configure auto unseal using transit auto unseal (On Prem), refer to this guide.
To configure auto unseal using Google Cloud KMS (Cloud), refer to this guide.
To troubleshoot ActiveMQ and Keycloak issues, refer to this guide.

CX Voice and Outbound dialer upgrade guide.

Configurations:

For the upgrade, besides updating these tags, we need to follow these steps for every existing tenant:
- Keycloak Realm file upgrade:
  1. Go to Realm > Clients > cim > Authorization > Policies
  2. Search for form in Policy
  3. Delete both view-form-policy and manage-form-policy
  4. Import the file 5.7.0-authz-config.json in your Realm > Clients > cim > Authorization > Import