Upgrades
Excalibase ships as numbered releases: images excalibase/*:X.Y.Z, the chart platform-aio
X.Y.Z, and the single-host bundle at tag vX.Y.Z. Upgrade from release to release only; never
run latest or main images.
Before every upgrade:
- Read the release notes on GitHub: they name any setting that changed and any step to take.
- Take a backup of the projects you care about (Studio, Operations → Backups → Trigger Backup) and, on a single host, of the volumes.
- With manual vault unseal, have the key at hand: the control plane restarts sealed.
Kubernetes
helm repo update excalibase
helm search repo excalibase/platform-aio --versions | head -5
helm upgrade platform-aio excalibase/platform-aio --version <X.Y.Z> \
-n excalibase-platform --reset-then-reuse-values --timeout 15m
for d in provisioning auth graphql studio; do kubectl -n excalibase-platform rollout status deploy/$d; done
--reset-then-reuse-values takes the new release's defaults and keeps every value you set. If you
keep a values.yaml under version control, pass -f values.yaml instead. The upgrade re-runs the
bootstrap Job; --wait is safe here. The control plane restarts with a short pause in Studio;
project APIs keep answering.
Roll back to the release you came from:
helm history platform-aio -n excalibase-platform
helm rollback platform-aio <revision> -n excalibase-platform
Project databases, the platform database and their volumes are not touched by an upgrade or a rollback. Upgrade CloudNativePG, cert-manager, the Barman Cloud plugin and HAProxy separately, when a release note asks for it.
Single host
In the directory you installed from, keeping .env:
git fetch --depth 1 origin tag v<X.Y.Z>
git checkout v<X.Y.Z>
docker compose pull
docker compose up -d
(podman compose with Podman.) The bundle names its own release; if you set TAG in .env,
change or remove it. To roll back, check out the tag you came from and run docker compose up -d
again.