Upgrade Deployment
Upgrading your OpenReplay deployment to the latest version requires updating both your backend (instance) and tracker.
Upgrade Backend
Section titled Upgrade Backend- Copy/backup the current openreplay folder to
_version-numberlike below:
mv openreplay openreplay_v1.8.1- Clone the new OpenReplay version. In this example we’re upgrading to the latest available version:
git clone https://github.com/openreplay/openreplay- Upgrade OpenReplay:
cd openreplay/scripts/helmcharts
# Merge previous vars.yaml with current var.yaml (using yq for yaml parsing)
cp ~/openreplay_v1.8.1/scripts/helmcharts/vars.yaml old_vars.yaml
wget https://github.com/mikefarah/yq/releases/download/v4.30.4/yq_linux_amd64 -O yq
chmod +x ./yq
./yq '(load("old_vars.yaml") | .. | select(tag != "!!map" and tag != "!!seq")) as $i ireduce(.; setpath($i | path; $i))' vars.yaml > new_vars.yaml
mv new_vars.yaml vars.yaml
# Upgrade dependencies
SKIP_K8S_INSTALL=1 SKIP_OR_INSTALL=1 UPGRADE_TOOLS=1 bash init.sh
# Cleanup deprecated resource
kubectl delete ing -n db minio-frontend
# Setting proper permissions
/bin/bash -c '[[ -d /openreplay ]] && sudo chown -R 1001:1001 /openreplay'
# Upgrade OpenReplay
helm upgrade --install openreplay ./openreplay -n app --wait -f ./vars.yaml --atomic- If you’re not using a load balancer and have generated your SSL certificate via the
certmanager.shscript:
cd openreplay/scripts/helmcharts && bash certmanager.sh- Update
fromVersionvariable in/openreplay/scripts/helmcharts/vars.yamlto reflect the new version. As an example if you’re moving fromv1.8.1tov1.9.0then update thefromVersionlike below:
fromVersion: "v1.9.0"Upgrade Tracker
Section titled Upgrade TrackerEnsure 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.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 |
Troubleshooting
Section titled TroubleshootingIf you encounter any issue during the upgrade process, reach out on Slack and get help from our community.