API Reference

Packages

qdrant.io/v1

Package v1 contains API Schema definitions for the qdrant.io v1 API group

Resource Types

ClusterPhase

Underlying type: string

Appears in:

ComponentPhase

Underlying type: string

Appears in:

ComponentStatus

Appears in:

FieldDescriptionDefaultValidation
name stringName specifies the name of the component
namespace stringNamespace specifies the namespace of the component
version stringVersion specifies the version of the component
phase ComponentPhasePhase specifies the current phase of the component
message stringMessage specifies the info explaining the current phase of the component

HelmRelease

Appears in:

FieldDescriptionDefaultValidation
markedForDeletionAt stringMarkedForDeletionAt specifies the time when the helm release was marked for deletion
object HelmReleaseObject specifies the helm release objectEmbeddedResource: {}

HelmRepository

Appears in:

FieldDescriptionDefaultValidation
markedForDeletionAt stringMarkedForDeletionAt specifies the time when the helm repository was marked for deletion
object HelmRepositoryObject specifies the helm repository objectEmbeddedResource: {}

Ingress

Appears in:

FieldDescriptionDefaultValidation
enabled booleanEnabled specifies whether to enable ingress for the cluster or not.
annotations object (keys:string, values:string)Annotations specifies annotations for the ingress.
ingressClassName stringIngressClassName specifies the name of the ingress class
type IngressTypeType specifies whether it is path or host based routing.pathEnum: [path host]
host stringHost specifies the host for the ingress.
tls booleanTLS specifies whether to enable tls for the ingress.
The default depends on the ingress provider:
- KubernetesIngress: False
- NginxIngress: False
- QdrantCloudTraefik: Depending on the config.tls setting of the operator.
tlsSecretName stringTLSSecretName specifies the name of the secret containing the tls certificate.
nginx NGINXConfigNGINX specifies the nginx ingress specific configurations.
traefik TraefikConfigTraefik specifies the traefik ingress specific configurations.

IngressType

Underlying type: string

Appears in:

KubernetesPod

Appears in:

FieldDescriptionDefaultValidation
annotations object (keys:string, values:string)Annotations specifies the annotations for the Pods.
labels object (keys:string, values:string)Labels specifies the labels for the Pods.
extraEnv EnvVar arrayExtraEnv specifies the extra environment variables for the Pods.

KubernetesService

Appears in:

FieldDescriptionDefaultValidation
type ServiceTypeType specifies the type of the Service: “ClusterIP”, “NodePort”, “LoadBalancer”.ClusterIP
annotations object (keys:string, values:string)Annotations specifies the annotations for the Service.

KubernetesStatefulSet

Appears in:

FieldDescriptionDefaultValidation
annotations object (keys:string, values:string)Annotations specifies the annotations for the StatefulSet.
pods KubernetesPodPods specifies the configuration of the Pods of the Qdrant StatefulSet.

NGINXConfig

Appears in:

FieldDescriptionDefaultValidation
allowedSourceRanges string arrayAllowedSourceRanges specifies the allowed CIDR source ranges for the ingress.
grpcHost stringGRPCHost specifies the host name for the GRPC ingress.

NodeStatus

Appears in:

FieldDescriptionDefaultValidation
name stringName specifies the name of the node
started_at stringStartedAt specifies the time when the node started (in RFC3339 format)
state object (keys:PodConditionType, values:ConditionStatus)States specifies the condition states of the node
version stringVersion specifies the version of Qdrant running on the node

Operation

Appears in:

FieldDescriptionDefaultValidation
type OperationTypeType specifies the type of the operation
phase OperationPhasePhase specifies the phase of the operation
id integerId specifies the id of the operation
startTime stringStartTime specifies the time when the operation started
completionTime stringCompletionTime specifies the time when the operation completed
message stringMessage specifies the message of the operation
subOperation booleanSubOperation specifies whether the operation is a sub-operation of another operation
steps OperationStep arraySteps specifies the steps the operation has performed

OperationPhase

Underlying type: string

Appears in:

OperationStep

Appears in:

FieldDescriptionDefaultValidation
name stringName specifies the name of the step
id integerId specifies the id of the step
phase StepPhasePhase specifies the phase of the step
message stringMessage specifies the reason in case of failure

OperationType

Underlying type: string

Appears in:

OperatorVersion

Underlying type: string

Appears in:

Pause

Appears in:

FieldDescriptionDefaultValidation
owner stringOwner specifies the owner of the pause request.
reason stringReason specifies the reason for the pause request.
creationTimestamp stringCreationTimestamp specifies the time when the pause request was created.

QdrantCloudRegion

QdrantCloudRegion is the Schema for the qdrantcloudregions API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantCloudRegion
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantCloudRegionSpec

QdrantCloudRegionList

QdrantCloudRegionList contains a list of QdrantCloudRegion

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantCloudRegionList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantCloudRegion array

QdrantCloudRegionSpec

QdrantCloudRegionSpec defines the desired state of QdrantCloudRegion

Appears in:

FieldDescriptionDefaultValidation
id stringId specifies the unique identifier of the region
helmRepositories HelmRepository arrayHelmRepositories specifies the list of helm repositories to be created to the region
helmReleases HelmRelease arrayHelmReleases specifies the list of helm releases to be created to the region

QdrantCluster

QdrantCluster is the Schema for the qdrantclusters API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantCluster
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantClusterSpec

QdrantClusterList

QdrantClusterList contains a list of QdrantCluster

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantCluster array

QdrantClusterRestore

QdrantClusterRestore is the Schema for the qdrantclusterrestores API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterRestore
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantClusterRestoreSpec

QdrantClusterRestoreList

QdrantClusterRestoreList contains a list of QdrantClusterRestore objects

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterRestoreList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantClusterRestore array

QdrantClusterRestoreSpec

QdrantClusterRestoreSpec defines the desired state of QdrantClusterRestore

Appears in:

FieldDescriptionDefaultValidation
operatorVersion OperatorVersionThe version of the operator which reconciles this instanceV1Enum: [V1 V2]
source RestoreSourceSource defines the source snapshot from which the restore will be done
destination RestoreDestinationDestination defines the destination cluster where the source data will end up

QdrantClusterScheduledSnapshot

QdrantClusterScheduledSnapshot is the Schema for the qdrantclusterscheduledsnapshots API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterScheduledSnapshot
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantClusterScheduledSnapshotSpec

QdrantClusterScheduledSnapshotList

QdrantClusterScheduledSnapshotList contains a list of QdrantCluster

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterScheduledSnapshotList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantClusterScheduledSnapshot array

QdrantClusterScheduledSnapshotSpec

QdrantClusterScheduledSnapshotSpec defines the desired state of QdrantCluster

Appears in:

FieldDescriptionDefaultValidation
operatorVersion OperatorVersionThe version of the operator which reconciles this instanceV1Enum: [V1 V2]
cluster-id stringId specifies the unique identifier of the cluster
scheduleShortId stringSpecifies short Id which identifies a scheduleMaxLength: 8
schedule stringCron expression for frequency of creating snapshots, see https://en.wikipedia.org/wiki/Cron.
The schedule is specified in UTC.
Pattern: `^(@(annually
retention stringRetention of schedule in hoursPattern: ^[0-9]+h$

QdrantClusterSnapshot

QdrantClusterSnapshot is the Schema for the qdrantclustersnapshots API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterSnapshot
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantClusterSnapshotSpec

QdrantClusterSnapshotList

QdrantClusterSnapshotList contains a list of QdrantClusterSnapshot

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantClusterSnapshotList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantClusterSnapshot array

QdrantClusterSnapshotPhase

Underlying type: string

Appears in:

QdrantClusterSnapshotSpec

Appears in:

FieldDescriptionDefaultValidation
operatorVersion OperatorVersionThe version of the operator which reconciles this instanceV1Enum: [V1 V2]
cluster-id stringThe cluster ID for which a Snapshot need to be taken
The cluster should be in the same namespace as this QdrantClusterSnapshot is located
creation-timestamp integerThe CreationTimestamp of the backup (expressed in Unix epoch format)
scheduleShortId stringSpecifies the short Id which identifies a schedule, if any.
This field should not be set if the backup is made manually.
MaxLength: 8
retention stringThe retention period of this snapshot in hours, if any.
If not set, the backup doesn’t have a retention period, meaning it will not be removed.
Pattern: ^[0-9]+h$

QdrantClusterSpec

QdrantClusterSpec defines the desired state of QdrantCluster

Appears in:

FieldDescriptionDefaultValidation
operatorVersion OperatorVersionThe version of the operator which reconciles this instanceV1Enum: [V1 V2]
id stringId specifies the unique identifier of the cluster
version stringVersion specifies the version of Qdrant to deploy
size integerSize specifies the desired number of Qdrant nodes in the clusterMaximum: 30
Minimum: 1
servicePerNode booleanServicePerNode specifies whether the cluster should start a dedicated service for each node.true
clusterManager booleanClusterManager specifies whether to use the cluster manager for this cluster.
The Python-operator will deploy a dedicated cluster manager instance.
The Go-operator will use a shared instance.
false
suspend booleanSuspend specifies whether to suspend the cluster.
If enabled, the cluster will be suspended and all related resources will be removed except the PVCs.
false
pauses Pause arrayPauses specifies a list of pause request by developer for manual maintenance.
Operator will skip handling any changes in the CR if any pause request is present.
distributed booleanDeprecated
image QdrantImageImage specifies the image to use for each Qdrant node.
resources ResourcesResources specifies the resources to allocate for each Qdrant node.
security QdrantSecurityContextSecurity specifies the security context for each Qdrant node.
tolerations Toleration arrayTolerations specifies the tolerations for each Qdrant node.
nodeSelector object (keys:string, values:string)NodeSelector specifies the node selector for each Qdrant node.
config QdrantConfigurationConfig specifies the Qdrant configuration setttings for the clusters.
ingress IngressIngress specifies the ingress for the cluster.
service KubernetesServiceService specifies the configuration of the Qdrant Kubernetes Service.
statefulSet KubernetesStatefulSetStatefulSet specifies the configuration of the Qdrant Kubernetes StatefulSet.
storageClassNames StorageClassNamesStorageClassNames specifies the storage class names for db and snapshots.
topologySpreadConstraints TopologySpreadConstraintTopologySpreadConstraints specifies the topology spread constraints for the cluster.
podDisruptionBudget PodDisruptionBudgetSpecPodDisruptionBudget specifies the pod disruption budget for the cluster.

QdrantConfiguration

Appears in:

FieldDescriptionDefaultValidation
collection QdrantConfigurationCollectionCollection specifies the default collection configuration for Qdrant.
log_level stringLogLevel specifies the log level for Qdrant.
service QdrantConfigurationServiceService specifies the service level configuration for Qdrant.
tls QdrantConfigurationTLSTLS specifies the TLS configuration for Qdrant.

QdrantConfigurationCollection

Appears in:

FieldDescriptionDefaultValidation
replication_factor integerReplicationFactor specifies the default number of replicas of each shard
write_consistency_factor integerWriteConsistencyFactor specifies how many replicas should apply the operation to consider it successful
vectors QdrantConfigurationCollectionVectorsVectors specifies the default parameters for vectors

QdrantConfigurationCollectionVectors

Appears in:

FieldDescriptionDefaultValidation
on_disk booleanOnDisk specifies whether vectors should be stored in memory or on disk.

QdrantConfigurationService

Appears in:

FieldDescriptionDefaultValidation
api_key QdrantSecretKeyRefApiKey for the qdrant instance
read_only_api_key QdrantSecretKeyRefReadOnlyApiKey for the qdrant instance
jwt_rbac booleanJwtRbac specifies whether to enable jwt rbac for the qdrant instance
Default is false
enable_tls booleanEnableTLS specifies whether to enable tls for the qdrant instance
Default is false

QdrantConfigurationTLS

Appears in:

FieldDescriptionDefaultValidation
cert QdrantSecretKeyRefReference to the secret containing the server certificate chain file
key QdrantSecretKeyRefReference to the secret containing the server private key file

QdrantImage

Appears in:

FieldDescriptionDefaultValidation
repository stringRepository specifies the repository of the Qdrant image.
If not specified defaults the config of the operator (or qdrant/qdrant if not specified in operator).
pullPolicy PullPolicyPullPolicy specifies the image pull policy for the Qdrant image.
If not specified defaults the config of the operator (or IfNotPresent if not specified in operator).
pullSecretName stringPullSecretName specifies the pull secret for the Qdrant image.

QdrantSecretKeyRef

Appears in:

FieldDescriptionDefaultValidation
secretKeyRef SecretKeySelectorSecretKeyRef to the secret containing data to configure the qdrant instance

QdrantSecurityContext

Appears in:

FieldDescriptionDefaultValidation
user integerUser specifies the user to run the Qdrant process as.
group integerGroup specifies the group to run the Qdrant process as.
fsGroup integerFsGroup specifies file system group to run the Qdrant process as.

QdrantVersion

QdrantVersion is the Schema for the qdrantversions API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantVersion
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec QdrantVersionSpec

QdrantVersionList

QdrantVersionList contains a list of QdrantVersion

FieldDescriptionDefaultValidation
apiVersion stringqdrant.io/v1
kind stringQdrantVersionList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items QdrantVersion array

QdrantVersionSpec

QdrantVersionSpec defines the desired state of QdrantVersion

Appears in:

FieldDescriptionDefaultValidation
version stringVersion number (should be semver compliant).
E.g. “v1.10.1”
isDefault booleanIf set, this version is default for new clusters on Cloud.
There should be only 1 Qdrant version in the platform set as default.
false
image stringFull docker image to use for this version.
If empty, a default image will be derived from Version (and qdrant/qdrant is assumed).
unavailable booleanIf set, this version cannot be used for new clusters.false
isEndOfLife booleanIf set, this version is no longer actively supported.false
accountIds string arrayIf set, this version can only be used by accounts with given IDs.
accountPrivileges string arrayIf set, this version can only be used by accounts that have been given the listed privileges.
remarks stringGeneral remarks for human reading
releaseNotesURL stringRelease Notes URL for the specified version

RegionCapabilities

Appears in:

FieldDescriptionDefaultValidation
volumeSnapshot booleanVolumeSnapshot specifies whether the Kubernetes cluster supports volume snapshot
volumeExpansion booleanVolumeExpansion specifies whether the Kubernetes cluster supports volume expansion

RegionPhase

Underlying type: string

Appears in:

ResourceRequests

Appears in:

FieldDescriptionDefaultValidation
cpu stringCPU specifies the CPU request for each Qdrant node.
memory stringMemory specifies the memory request for each Qdrant node.

Resources

Appears in:

FieldDescriptionDefaultValidation
cpu stringCPU specifies the CPU limit for each Qdrant node.
memory stringMemory specifies the memory limit for each Qdrant node.
storage stringStorage specifies the storage amount for each Qdrant node.
requests ResourceRequestsRequests specifies the resource requests for each Qdrant node.

RestoreDestination

Appears in:

FieldDescriptionDefaultValidation
name stringName of the destination cluster
namespace stringNamespace of the destination cluster

RestorePhase

Underlying type: string

Appears in:

RestoreSource

Appears in:

FieldDescriptionDefaultValidation
snapshotName stringSnapshotName is the name of the snapshot from which we wish to restore
namespace stringNamespace of the snapshot

ScheduledSnapshotPhase

Underlying type: string

Appears in:

StepPhase

Underlying type: string

Appears in:

StorageClassNames

Appears in:

FieldDescriptionDefaultValidation
db stringDB specifies the storage class name for db volume.
snapshots stringSnapshots specifies the storage class name for snapshots volume.

TraefikConfig

Appears in:

FieldDescriptionDefaultValidation
allowedSourceRanges string arrayAllowedSourceRanges specifies the allowed CIDR source ranges for the ingress.

VolumeSnapshotInfo

Appears in:

FieldDescriptionDefaultValidation
volumeSnapshotName stringVolumeSnapshotName is the name of the volume snapshot
volumeName stringVolumeName is the name of the volume that was backed up
readyToUse booleanReadyToUse indicates if the volume snapshot is ready to use

API Reference