Upgrade Deployment

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

Upgrade Backend

  1. Copy/backup the current openreplay folder to _version-number like below:

    mv openreplay openreplay_v1.7.0

  2. Clone the new OpenReplay version. In this example we're upgrading to the latest available version:

    git clone https://github.com/openreplay/openreplay

  3. Upgrade OpenReplay:

    cd openreplay/scripts/helmcharts
    # Merge previous vars.yaml with current var.yaml (using yq for yaml parsing)
    cp ~/openreplay_v1.4.0/scripts/helmcharts/vars.yaml old_vars.yaml
    wget https://github.com/mikefarah/yq/releases/download/v4.24.4/yq_linux_amd64 -O yq
    chmod +x ./yq
    ./yq '. *= load("old_vars.yaml")' vars.yaml > new_vars.yaml
    mv new_vars.yaml vars.yaml
    # Cleanup depricated resource
    kubectl delete ing -n db minio-frontend
    # Upgrade openreplay
    helm upgrade --install openreplay ./openreplay -n app --wait -f ./vars.yaml --atomic

  4. If you're not using a load balancer and have generated your SSL certificate via the certmanager.sh script:

    cd openreplay/scripts/helmcharts && bash certmanager.sh

  5. Update fromVersion variable in /openreplay/scripts/helmcharts/vars.yaml to reflect the new version. As an example if you're moving from v1.7.0 to v1.8.1 then update the fromVersion like below:

    fromVersion: "v1.8.1"

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 VersionMinimum Tracker Version
1.8.14.1.4
1.8.04.0.1
1.7.03.5.15
1.6.03.5.12
1.5.43.5.4
1.5.33.5.3
1.5.23.5.2
1.5.13.5.1
1.5.03.5.0
1.4.03.4.17
1.3.63.4.16
1.3.53.4.0
1.3.03.2.1
1.2.03.1.0
1.1.03.0.3

Troubleshooting

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

Previous
OpenReplay Administration
Next
Introduction