Upgrade Deployment

Upgrading your OpenReplay deployment to the latest version requires updating both your backend (instance) and tracker.

Upgrade Backend (Vanilla Installation)

Section titled Upgrade Backend (Vanilla Installation)
  1. Download the latest CLI
# Download the latest CLI
sudo wget https://raw.githubusercontent.com/openreplay/openreplay/main/scripts/helmcharts/openreplay-cli -O /bin/openreplay 
sudo chmod +x /bin/openreplay
export PATH=/var/lib/openreplay:$PATH
  1. Check your Kubernetes cluster version, and upgrade it if it’s older than 1.25 (Mandatory)
# Check Kubernetes version
kubectl version --short 2>/dev/null | grep -i server | awk '{print $NF}'
# Update Kubernetes
k3s-killall.sh
curl -sL https://get.k3s.io | sudo K3S_KUBECONFIG_MODE="644" INSTALL_K3S_VERSION='v1.25.6+k3s1' INSTALL_K3S_EXEC="--disable=traefik" sh -
  
# Restart Kubernetes cluster
sudo systemctl restart k3s.service

# Update Kubernetes deprecated apis
helm plugin install https://github.com/helm/helm-mapkubeapis
helm mapkubeapis -n app openreplay
  1. Upgrade OpenReplay
RELEASE_UPGRADE=1 openreplay --upgrade

Note: Your updated OpenReplay config file will be stored in /var/lib/openreplay/vars.yaml.

git clone https://github.com/openreplay/openreplay --depth 1
cd openreplay/scripts/docker-compose
bash upgrade.sh /path/to/old/common.env
eg: bash upgrade.sh ~/openreplay-docker-compose/common.env

Note: Your updated OpenReplay config file will be stored in common.env along with the docker-compose file.

Ensure your tracker (and tracker-assist plugin if you do use the Assist plugin) is compatible with the new backend version by checking the below compatibility table:

Backend VersionTracker VersionAssist Version
1.20.014.x.x9.x.x
1.19.014.x.x9.x.x
1.18.013.x.x9.x.x
1.17.012.x.x8.x.x
1.16.011.x.x7.x.x
1.15.010.x.x6.x.x
1.14.09.x.x6.x.x
1.13.08.x.x6.x.x
1.12.07.x.x5.x.x
1.11.06.x.x5.x.x
1.10.05.x.x5.x.x
1.9.04.x.x4.x.x
1.8.14.1.44.1.1
1.8.04.0.14.0.1
1.7.03.5.153.5.14
1.6.03.5.123.5.11
1.5.43.5.43.5.7
1.5.33.5.33.5.5
1.5.23.5.23.5.4
1.5.13.5.13.5.3
1.5.03.5.03.5.0
1.4.03.4.173.4.16
1.3.63.4.163.4.15
1.3.53.4.03.4.13
1.3.03.2.13.4.12
1.2.03.1.0N/A
1.1.03.0.3N/A

If you encounter any issue during the upgrade process, reach out on Slack or check out our Forum and get help from our community.