New to KubeDB? Please start here.

QdrantVersion

What is QdrantVersion

QdrantVersion is a Kubernetes Custom Resource Definitions (CRD). It provides a declarative configuration to specify the Docker images to be used for Qdrant database deployed with KubeDB in a Kubernetes native way.

When you install KubeDB, a QdrantVersion custom resource will be created automatically for every supported Qdrant version. You have to specify the name of the QdrantVersion CRD in spec.version field of the Qdrant CRD. Then, KubeDB will use the Docker images specified in the QdrantVersion CRD to create your expected database.

Using a separate CRD for specifying respective Docker images allows us to modify images independent of the KubeDB operator. This also allows users to use a custom image for the database.

QdrantVersion Specification

As with all other Kubernetes objects, a QdrantVersion needs apiVersion, kind, and metadata fields. It also needs a .spec section.

apiVersion: catalog.kubedb.com/v1alpha1
kind: QdrantVersion
metadata:
  name: "1.17.0"
spec:
  version: "1.17.0"
  db:
    image: "qdrant/qdrant:v1.17.0"
  deprecated: false

metadata.name

metadata.name is a required field that specifies the name of the QdrantVersion CRD. You have to specify this name in spec.version field of the Qdrant CRD.

The naming convention for QdrantVersion CRD follows the pattern {Original Qdrant version}.

spec.version

spec.version is a required field that specifies the original version of the Qdrant database that has been used to build the Docker image specified in spec.db.image field.

spec.deprecated

spec.deprecated is an optional field that specifies whether the Docker images specified here are supported by the current KubeDB operator.

The default value of this field is false. If spec.deprecated is set to true, KubeDB operator will not create the database and other respective resources for this version.

spec.db.image

spec.db.image is a required field that specifies the Docker image which will be used to create the Petset by KubeDB operator to create the expected Qdrant database.

$ kubectl get qdrantversions
NAME     VERSION   DB_IMAGE                                       DEPRECATED   AGE
1.15.4   1.15.4    docker.io/qdrant/qdrant:v1.15.4-unprivileged                28d
1.16.2   1.16.2    docker.io/qdrant/qdrant:v1.16.2-unprivileged                28d
1.17.0   1.17.0    docker.io/qdrant/qdrant:v1.17.0-unprivileged                28d

spec.endOfLife

spec.endOfLife is an optional <boolean> field that indicates whether this Qdrant version has reached its end of life.

spec.securityContext

spec.securityContext specifies the security context for the database container. It contains:

• spec.securityContext.runAsUser — the user ID to run the container as.

spec.ui

spec.ui is an optional array that specifies the UI configuration for this Qdrant version. Each entry contains:

• name — the name of the UI component.
• version — the version of the UI component.
• values — configuration values for the UI component.
• disable — whether the UI component is disabled.

spec.updateConstraints

spec.updateConstraints specifies constraints for version updates. It contains:

• spec.updateConstraints.allowlist — a list of versions that are allowed as update targets from this version.
• spec.updateConstraints.denylist — a list of versions that are forbidden as update targets from this version.

Next Steps

• Learn about the Qdrant CRD.
• Deploy your first Qdrant database with KubeDB by following the guide here.