Upgrades

Move a deployment to a new version without losing data or configuration.

What you will do: check the release notes, back up, upgrade one environment at a time and confirm the deployment reports the new version in dock.

Upgrades and GA updates are included in every subscription and evaluation. Releases are listed on Downloads in your workspace and in the changelog.

Before you upgrade

  1. Read the release notes for every version between yours and the target. Look for configuration changes and minimum-version requirements:
Supported upgrade path: <placeholder>
  1. Back up the data directory or volume, and export the configuration from the console.
  2. Upgrade a non-production deployment first and run your usual searches, routes or reports against it.

Steps by environment

  • Docker: pull the new tag, stop and remove the container, recreate it with the same volume and settings.
docker pull <placeholder-image>:<placeholder-new-version>
docker stop xplg-node && docker rm xplg-node
docker run -d --name xplg-node <placeholder-same-options> <placeholder-image>:<placeholder-new-version>
  • Kubernetes: update the chart repository and upgrade the release.
helm repo update
helm upgrade <placeholder-release> xplg/<placeholder-chart> -n <placeholder-namespace> -f values.yaml
  • Virtual machine and bare metal: install the new package over the old one and restart the service.
sudo <placeholder-install-command>
sudo systemctl restart <placeholder-service>
  • Cloud marketplaces: follow the listing's upgrade notes; keep the data disk when replacing the instance.
  • XPLG SaaS: XPLG upgrades the tenant and announces maintenance windows in advance.

Clusters

Upgrade nodes one at a time and wait for each to rejoin before moving on. Do not mix versions longer than the upgrade itself.

After the upgrade

Open Deployments in dock: the row shows the new version once the node has reported in. If the version does not change, check that the node is online and the registration is still valid.

Rolling back

Stop the deployment, restore the backup taken before the upgrade and start the previous version. Data ingested during the failed upgrade is lost unless the sources replay it; PortX's persistent queue and replay on demand limit that window.

Next: Products

Verify with XPLG engineering before publishing.