Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Introduction

The Qdrant Operator runs Qdrant, the vector search engine, on Kubernetes. You declare a QdrantCluster and the operator installs the official qdrant-helm chart with values derived from the spec, then reports StatefulSet readiness in the resource status. Six more kinds manage what lives inside or around that cluster: collections with their payload indexes and aliases, access tokens for applications, backups of every node to S3-compatible storage, backups on a cron schedule, restores from a backup, and point-by-point migrations from any other Qdrant.

Helm underneath

The operator does not render Qdrant's StatefulSet itself. Each QdrantCluster is one Helm release named qdrant-<name>, installed with helm upgrade --install from the upstream chart repository, and spec.version is both the Qdrant version and the chart version. A cluster you already run from the chart translates to a QdrantCluster almost value for value; Helm values the operator renders lists the mapping. What the chart cannot do, and the operator adds, is everything that talks to Qdrant's HTTP API: collection reconciliation, snapshots, recovery, point migration, and signing access tokens.

The kinds

KindShort nameWhat it manages
QdrantClusterqcOne Helm release of the qdrant chart: replicas, version, storage, service, API keys, TLS, metrics, scheduling
QdrantCollectionqcolA collection inside a cluster: vectors, sharding, payload indexes, aliases
QdrantAccessKeyqakA role-based access token signed with the cluster's API key, kept in a Secret and renewed before expiry
QdrantBackupqbOne backup: a snapshot of every node per collection, streamed into a bucket with a manifest
QdrantBackupScheduleqbsBackups on a cron schedule with CronJob-style concurrency and grandfather-father-son retention
QdrantRestoreqrRecovery of a backup into a cluster with the same node count, node by node
QdrantMigrationqmigA copy of collections from any reachable Qdrant, including Qdrant Cloud, into a managed cluster

All kinds live in the API group qdrant.io, version v1alpha1, and are namespaced.

Every node, not one

Qdrant in distributed mode spreads a collection's shards across nodes, and a snapshot taken on one node holds only that node's shards. The operator therefore snapshots each StatefulSet pod through the chart's headless Service and records which node every snapshot came from. A restore hands each target node the snapshot of the matching source node, which is why the node counts of source and target must be equal.

Where to go next

Installation deploys the operator and its CRDs. Quickstart creates a cluster, a collection and a backup. The guide then takes one topic per chapter, from running a cluster through backups to troubleshooting, and the reference section has a field table for every kind.