Guides

Upgrade Guide

Suggest Edits

RegScale is regularly updated. Follow these instructions to keep your instance current.

Upgrade Rules

  • RegScale supports upgrades only, not downgrades.
  • Downgrading may corrupt the database schema. Restore from backup if needed.
  • Configuration files and secrets are customer-managed. RegScale cannot recover lost credentials or custom configurations.

Before You Upgrade

  • Back up your SQL Server database.
  • Back up your configuration files and secrets.
  • Review the release notes for any version-specific steps.

Upgrade by Deployment Model

Local eval (Docker-Compose)

docker-compose down
# Update the image tag in docker-compose.yml
docker-compose pull
docker-compose up

VM Based (Podman-Compose)

podman-compose down
# Update the image tag in your compose file
podman-compose pull
podman-compose up

Managed Container Services (Azure ACA, AWS ECS, GCP Cloud Run)

Update the RegScale container image reference to the new image tag, then deploy a new revision/task:

  • Azure Container Apps (ACA): update the image and create a new revision.
  • AWS ECS: register a new task definition with the updated image and update the service.
  • GCP Cloud Run: deploy a new revision with the updated image.

Kubernetes

Update the RegScale image to the new release tag using either Helm or kubectl:

# Helm — upgrade the release with the new image tag
helm upgrade regscale <chart> --reuse-values --set image.tag=x.x.x.x

# kubectl — set the new image on the deployment
kubectl set image deployment/regscale regscale=regscale/regscale:x.x.x.x