High availability
Store-backed replication has one primary and zero or more replicas. A new replica is born from a completed backup, then consumes the primary's object-store WAL.
For more information about replication mechanics, please refer to the official documentation.
Before running any command, replace every <angle-bracket> value; an unreplaced
placeholder can be interpreted as shell redirection.
status.replication.replicas[].caughtUp is a sticky "caught up at least once"
latch used for read routing. On an ordinary cluster, caughtUpNow=true means
reachable, unsuspended, self-consistent, and either exactly zero lag or bounded
streaming: the replica has applied everything the primary committed within the
operator's short lookback window. On a primaryless follower, only the zero-lag
proof is available. false means behind or stale; absent means freshness was
not determined and fails closed.
Failure behavior
There is no automatic promotion or failover decision.
| Failure | Operator behavior |
|---|---|
| Primary pod is lost, PVC survives, and fencing is safe | Recreate the same primary identity on its PVC. |
| Primary is stranded on an unreachable node | Report InstanceUnreachable; do not risk a second writer. |
| Established primary PVC is missing or Terminating | Fence the primary Pod, set PromotionRequired=True, remove ready RW endpoints, and do not create an empty replacement primary. |
| Replica is lost | Recreate/re-seed it from backup and WAL when prerequisites are available. |
A QuestDBPromotion records one explicit, one-shot cutover and remains as its
audit object. If a same-name primary Pod was recreated before its PVC deletion
began, do not wait forever for the mounted Terminating claim: current operator
versions automatically fence that established Pod so pvc-protection can
release the PVC. status.currentPrimary remains the non-empty primary of record
until an explicit promotion; fencing is not automatic failover.
Promotion and failover
| Mode | Use | Data effect |
|---|---|---|
Planned | Healthy primary and live replica | Drains the old primary and verifies the target before promotion. Fails rather than becoming lossy. |
Emergency | Primary is lost/wedged and service restoration outweighs data loss | Skips the drain. Unreplicated writes may be lost, but QWP clients using durable acknowledgements retain and retry writes that were not durably acknowledged. |
Planned prechecks
Start only when the ordinary writer-health contract is current
(Available=True/PrimaryReady, Progressing=False/Settled, and
WriteHealthy=True/Healthy), the target is a live replica, and its
caughtUpNow is explicitly true. WriteHealthy=True is an observation, not a
synthetic write or disk-capacity guarantee:
kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='generation={.metadata.generation}{" observed="}{.status.observedGeneration}{" primary="}{.status.currentPrimary}{"\n"}{range .status.replication.replicas[*]}{.instance}{" caughtUpNow="}{.caughtUpNow}{" lagTxns="}{.lagTxns}{" suspended="}{.suspendedTables}{"\n"}{end}'
kubectl get pods -n <namespace> -l questdb.io/cluster=<name> \
-L questdb.io/instance,questdb.io/role -o wide
Choose the integer serial from the target instance name (<name>-2 has target
2). Confirm no active cutover:
kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='{.status.replication.activePromotion}{"\n"}'
The defaults reflect two different costs:
catchUpTimeoutSeconds: 900bounds pre-drain catch-up while the old primary continues serving writes.primaryGracePeriodSeconds: 120bounds loss-of-primary and post-drain tail verification while writes are unavailable.0means wait indefinitely, not "do not wait". Use it only after accepting an unbounded outage/wait.
Create and watch
kubectl apply -f - <<EOF
apiVersion: questdb.io/v1alpha1
kind: QuestDBPromotion
metadata:
name: <promotion-name>
namespace: <namespace>
spec:
clusterRef:
name: <name>
target: <target-serial>
mode: Planned
catchUpTimeoutSeconds: 900
primaryGracePeriodSeconds: 120
EOF
Use a bounded progress loop that stops on both success and failure without terminating your interactive shell:
PHASE=""
for _ in $(seq 1 180); do
PHASE="$(kubectl get questdbpromotion <promotion-name> -n <namespace> \
-o jsonpath='{.status.phase}')"
printf '%s %s\n' "$(date -u +%FT%TZ)" "$PHASE"
case "$PHASE" in
Completed|Failed) break ;;
esac
sleep 10
done
kubectl get questdbpromotion <promotion-name> -n <namespace> \
-o jsonpath='{.status.phase}{" "}{.status.reason}{": "}{.status.message}{"\n"}'
[ "$PHASE" = "Completed" ]
The final test succeeds only for Completed; Failed and the 30-minute timeout
return a non-zero command status after printing the latest reason/message,
without calling exit.
Verify
kubectl get questdbpromotion <promotion-name> -n <namespace> \
-o jsonpath='phase={.status.phase}{" mode="}{.status.mode}{" reason="}{.status.reason}{" message="}{.status.message}{"\n"}'
kubectl get questdbcluster <name> -n <namespace> -o wide
kubectl get endpointslice -n <namespace> \
-l kubernetes.io/service-name=<name>-rw
Confirm status.currentPrimary names the target and require current-generation
Available=True/PrimaryReady, Progressing=False/Settled, and
WriteHealthy=True/Healthy. Test <name>-rw connectivity, critical table
timestamps/row counts, and application writes before closing the change. Confirm
replicas return healthy after the demoted primary is re-seeded. Finally inspect
PVC labels: the target PVC must have questdb.io/role=primary, while every
demoted/re-seeded replica PVC must have questdb.io/role=replica. The separate
questdb.io/bootstrap label records ancestry/state and does not identify the
current role.
Emergency promotion
Use the same object shape with mode: Emergency only after selecting a live
target and accepting data loss.
replicated. QWP clients configured with
durable acknowledgements
retain writes until object-store durability is confirmed and retry
unacknowledged writes after connecting to the new primary. Clients connected
directly to the old pod can briefly receive acknowledgements for writes that
will be discarded while it detects loss of store ownership. Stop/repoint writers
and use the stable <name>-rw Service, not pod addresses. :::
kubectl apply -f - <<EOF
apiVersion: questdb.io/v1alpha1
kind: QuestDBPromotion
metadata:
name: <promotion-name>
namespace: <namespace>
spec:
clusterRef:
name: <name>
target: <target-serial>
mode: Emergency
EOF
Use the bounded terminal-phase watcher above and perform the same primary, full
writer-health, connectivity, data, and PVC current-role checks. Before
promotion, the fenced loss state must have zero ready <name>-rw EndpointSlice
endpoints; afterward the selected target is the only live primary. Record the
accepted recovery point and any expected lost-write window.
If promotion stalls or fails
Read the promotion's status first:
kubectl get questdbpromotion <promotion-name> -n <namespace> \
-o jsonpath='phase={.status.phase}{" mode="}{.status.mode}{" reason="}{.status.reason}{" message="}{.status.message}{"\n"}{range .status.conditions[*]}{.type}{"="}{.status}{" reason="}{.reason}{" message="}{.message}{"\n"}{end}'
Stalled=True/TargetNotPrimarymeans the shaped target has not become the serving primary.Stalled=True/FenceNotEffectivemeans the target reports that the old owner still holds the stream. If the old Pod remains on a NotReady node, first power off or otherwise isolate that machine, then apply Kubernetes' out-of-service procedure. Do not remove the finalizer or force ownership while the old process may run.Stalledis an alarm, not a terminal failure or relaxation of fencing.- A running
Plannedcutover may be escalated against the same immutable target. Do not create a second promotion while one is active; it is refused. - A terminal
Failedobject is one-shot. Retry with a new name/object after correcting the cause. - Deleting in
PendingorValidatingcancels because nothing has been shaped. - Deleting in
DrainingorPromotingdoes not abort. The finalizer holds the object while the cutover continues.
Emergency abandons the losslessdrain and accepts loss of unreplicated writes. :::
kubectl patch questdbpromotion <promotion-name> -n <namespace> --type merge \
-p '{"spec":{"mode":"Emergency"}}'
A live but hung drain can remain in Draining because the operator cannot
distinguish a slow final upload from a wedged one; escalation is the human
decision. Promoting is also unbounded while the target fails to serve.
Diagnose the target pod, image pull, scheduling, PVC, Secret, network, and
object-store access. Do not start by removing the promotion finalizer: that
deletes the audit/control object but neither stops nor rolls back the shaped
cutover. Contact support before considering it.
Migrate an existing QuestDB onto the operator
A follower reduces migration downtime by restoring the source's backup and consuming its WAL while the external source continues serving.
Source prerequisites
The source must:
- run a compatible QuestDB Enterprise version;
- create completed backups in a known object-store backup root;
- upload replication WAL to a known root in the same store;
- retain WAL back to the seed backup;
- expose its exact
SELECT backup_instance_name();value, matching^[a-z0-9]+(-[a-z0-9]+)*$; and - support a controlled stop and one final
primary-catchup-uploadsrun.
The operator never connects to, configures, stops, fences, or lists storage for the source.
Create and verify the follower
All source selectors are immutable. Confirm sourceInstanceName, backup root,
and WAL root before creating the cluster. The source instance name must be
copied exactly and match the lowercase hyphen-separated engine identity format.
Copy the working tenant cluster's spec.image and spec.imagePullSecrets: set
<questdb-enterprise-image> to that private image and
<tenant-image-pull-secret> to the pull Secret in this namespace. Remove the
entire imagePullSecrets block only when every node has ambient pull access,
such as an authorized EKS worker-node role.
apiVersion: questdb.io/v1alpha1
kind: QuestDBCluster
metadata:
name: <name>
namespace: <namespace>
spec:
image: <questdb-enterprise-image>
imagePullSecrets:
- name: <tenant-image-pull-secret>
instances: 2
storage:
storageClassName: <storage-class>
size: 100Gi
objectStoreRef:
name: <source-store>
backup:
enabled: true
schedule: "0 * * * *"
root: <source-backup-root>
replication:
root: <source-wal-root>
bootstrap:
follow:
sourceInstanceName: <source-backup-instance-name>
A healthy follower has .status.replication.following=true, no current primary,
an empty <name>-rw, and reads through <name>-ro. It intentionally omits
WriteHealthy because it has no primary; do not wait for that condition. Verify
all instances and ReplicationHealthy; a quiet source can make progress
indeterminate, so also confirm the immutable source identity and roots directly
against the source configuration.
kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='following={.status.replication.following}{" primary="}{.status.currentPrimary}{"\n"}{range .status.conditions[?(@.type=="ReplicationHealthy")]}{.status}{" "}{.reason}{" "}{.message}{"\n"}{end}{.status.replication.stream}{"\n"}'
kubectl get endpointslice -n <namespace> \
-l kubernetes.io/service-name=<name>-rw
Cut over
Immediately before stopping the source, record when cutover preparation began in the same Bash shell you will use for the post-cutover check:
CUTOVER_TIME_CAPTURED=false
CUTOVER_STARTED_AT=""
if CUTOVER_STARTED_AT="$(date -u +%Y-%m-%dT%H:%M:%SZ)" && \
[ -n "$CUTOVER_STARTED_AT" ]; then
CUTOVER_TIME_CAPTURED=true
fi
[ "$CUTOVER_TIME_CAPTURED" = true ] && \
printf 'Cutover preparation started at: %s\n' "$CUTOVER_STARTED_AT"
- Stop application writes to the source, then stop the source database.
- Restart the source once with
replication.role=primary-catchup-uploads. - Wait for
CLOSE_REASON_UPLOADS_COMPLETE_SUCCESSin the source logs, then stop it again. This final upload may itself be unbounded; supervise it at the source. A normal shutdown does not prove the tail reached object storage. - Create a
PlannedQuestDBPromotionfor a healthy follower instance and use the bounded watcher above.
The planned follower gate requires the source stream to remain quiet for at
least 60 seconds and the target to consume the published WAL before promotion.
It still cannot prove an idle source process is stopped. If the engine reports
SourceStillOwnsStore, stop the source fully and retry with a new promotion
object.
uploaded or not consumed. Use it only when the source cannot be drained and that loss is explicitly accepted. :::
- After a completed cutover, verify
<name>-rw, data, writes, andcurrentPrimary. - Permanently decommission the source so it cannot restart and contend for the adopted WAL root.
- Wait for this cluster's own first post-cutover backup. The hourly deadline
must exceed one schedule interval plus the roughly two-minute observation
delay, so this check allows about 75 minutes. Do not accept an old
completedstatus: require a non-emptyendTimelater than the captured cutover-start time. Both values are RFC3339 UTC timestamps, so the Bash string comparison proves the observed backup completed after cutover preparation began. The WAL cleaner remains off until this backup completes; its release rolls the primary once. Verify the roll and writer readiness afterward.
BACKUP_VERIFIED=false
STATUS=""
END_TIME=""
for _ in $(seq 1 450); do
STATUS="$(kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='{.status.backup.lastBackup.status}')"
END_TIME="$(kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='{.status.backup.lastBackup.endTime}')"
if [ "${CUTOVER_TIME_CAPTURED:-false}" = true ] && \
[ "$STATUS" = "completed" ] && [ -n "$END_TIME" ] && \
[[ "$END_TIME" > "$CUTOVER_STARTED_AT" ]]; then
BACKUP_VERIFIED=true
break
fi
[ "$STATUS" = "failed" ] && break
sleep 10
done
[ "$BACKUP_VERIFIED" = true ] && \
kubectl get questdbcluster <name> -n <namespace> \
-o jsonpath='{range .status.conditions[?(@.type=="Available")]}Available={.status}{"/"}{.reason}{"\n"}{end}{range .status.conditions[?(@.type=="Progressing")]}Progressing={.status}{"/"}{.reason}{"\n"}{end}{range .status.conditions[?(@.type=="WriteHealthy")]}WriteHealthy={.status}{"/"}{.reason}{"\n"}{end}'
After the roll, require Available=True/PrimaryReady,
Progressing=False/Settled, and WriteHealthy=True/Healthy at the current
generation before declaring the cluster writer-ready and the WAL cleaner
released.