Skip to main content
The Admin Server keeps a small amount of state on its own persistent volume. This page covers what is on that volume, and how to back it up and restore it. Your FalkorDB deployments and their data are separate; back those up as described in Backups & schedules.

What the volume holds

The chart mounts the PersistentVolumeClaim <release>-admin-server at /data in the Admin Server pod. With the installer’s defaults, that is falkordb-enterprise-admin-server in the falkordb-system namespace, an 8 GiB ReadWriteOnce volume. Everything else the Admin Server manages lives in Kubernetes objects: deployments, backups, users (Secrets named falkordb-user-*), settings and RBAC configuration. A Kubernetes-level backup of the release namespace, or your GitOps repository, covers those.
The database path is set by adminServer.env.databasePath and the mount by adminServer.persistence.mountPath. The commands below use the defaults: release falkordb-enterprise, namespace falkordb-system, path /data/admin.db. Adjust them if you changed any of these.
A license supplied through Helm (adminServer.license.value or adminServer.license.existingSecret) is applied again on every start, so it does not depend on /data/license-state.json. Supplying the license that way makes the license state the one thing on this volume you never need to restore.

Back up with a volume snapshot

If the volume’s StorageClass is CSI-backed and the cluster has a VolumeSnapshotClass for its driver, snapshot the claim. SQLite in WAL mode recovers from a crash-consistent copy, so you can snapshot while the Admin Server runs.
The snapshot is ready when READYTOUSE is true. List the classes with kubectl get volumesnapshotclass.

Back up with a database copy

The Admin Server image has no sqlite3 binary, but it does have Node.js and the SQLite library the server uses. Its online backup API copies a consistent database while the server keeps running.
1

Write a copy next to the database

2

Copy it and the license state out of the pod

3

Remove the copy from the volume

Store both files somewhere outside the cluster. The audit log can hold user email addresses and resource names, so treat the copy like any other audit record.

Restore from a volume snapshot

Create a claim from the snapshot and point the chart at it with adminServer.persistence.existingClaim.
Then set the claim in your values and run the installer or helm upgrade as usual:
The Admin Server restarts on the restored volume. The chart does not delete the original claim.

Restore from a database copy

The database can’t be replaced while the Admin Server has it open. Stop the Admin Server, copy the files in through a temporary pod that mounts the same volume, then start it again.
1

Stop the Admin Server

Wait until the second command lists no pods, so the volume is released. The Admin UI and API are unavailable until you scale it back up. Your FalkorDB deployments keep serving traffic.
2

Start a temporary pod on the volume

The pod uses the Admin Server image and pull Secrets, so it needs no other registry access, and the same non-root security context.
3

Replace the database

Copy the backup in, then remove the WAL files that belong to the old database before moving the copy into place:
To restore the license state as well:
4

Remove the temporary pod and start the Admin Server

On start, the Admin Server applies any database migrations the running version needs, so a copy taken by an earlier release is brought up to date.

Validate

Sign in to the Admin UI and open Audit Logs. The newest entries should be the ones from before the backup, followed by your sign-in. Check Licensing for the expected license state.