Upgrade Deployment

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

Upgrade Backend

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

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

Upgrade OpenReplay:

RELEASE_UPGRADE=1 openreplay --upgrade

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

Upgrade Tracker

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 Version	Minimum Tracker Version	Minimum Assist Version (NPM)
1.12.0	7.0.0	5.0.2
1.11.0	6.0.1	5.0.2
1.10.0	5.0.3	5.0.0
1.9.0	4.1.9	4.1.3
1.8.1	4.1.4	4.1.1
1.8.0	4.0.1	4.0.1
1.7.0	3.5.15	3.5.14
1.6.0	3.5.12	3.5.11
1.5.4	3.5.4	3.5.7
1.5.3	3.5.3	3.5.5
1.5.2	3.5.2	3.5.4
1.5.1	3.5.1	3.5.3
1.5.0	3.5.0	3.5.0
1.4.0	3.4.17	3.4.16
1.3.6	3.4.16	3.4.15
1.3.5	3.4.0	3.4.13
1.3.0	3.2.1	3.4.12
1.2.0	3.1.0	N/A
1.1.0	3.0.3	N/A

Have questions?

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