mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-28 15:38:33 +02:00
32 KiB
32 KiB
title, weight
| title | weight |
|---|---|
| API Reference | 5 |
API Reference
Packages
qdrant.io/v1
Package v1 contains API Schema definitions for the qdrant.io v1 API group
Resource Types
- QdrantCloudRegion
- QdrantCloudRegionList
- QdrantCluster
- QdrantClusterList
- QdrantClusterRestore
- QdrantClusterRestoreList
- QdrantClusterScheduledSnapshot
- QdrantClusterScheduledSnapshotList
- QdrantClusterSnapshot
- QdrantClusterSnapshotList
- QdrantRelease
- QdrantReleaseList
ClusterPhase
Underlying type: string
Appears in:
ComponentPhase
Underlying type: string
Appears in:
ComponentStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name specifies the name of the component | ||
namespace string |
Namespace specifies the namespace of the component | ||
version string |
Version specifies the version of the component | ||
phase ComponentPhase |
Phase specifies the current phase of the component | ||
message string |
Message specifies the info explaining the current phase of the component |
HelmRelease
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
markedForDeletionAt string |
MarkedForDeletionAt specifies the time when the helm release was marked for deletion | ||
object HelmRelease |
Object specifies the helm release object | EmbeddedResource: {} |
HelmRepository
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
markedForDeletionAt string |
MarkedForDeletionAt specifies the time when the helm repository was marked for deletion | ||
object HelmRepository |
Object specifies the helm repository object | EmbeddedResource: {} |
Ingress
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
Enabled specifies whether to enable ingress for the cluster or not. | ||
annotations object (keys:string, values:string) |
Annotations specifies annotations for the ingress. | ||
ingressClassName string |
IngressClassName specifies the name of the ingress class | ||
host string |
Host specifies the host for the ingress. | ||
tls boolean |
TLS 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 string |
TLSSecretName specifies the name of the secret containing the tls certificate. | ||
nginx NGINXConfig |
NGINX specifies the nginx ingress specific configurations. | ||
traefik TraefikConfig |
Traefik specifies the traefik ingress specific configurations. |
KubernetesDistribution
Underlying type: string
Appears in:
KubernetesPod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
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 array |
ExtraEnv specifies the extra environment variables for the Pods. |
KubernetesService
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type ServiceType |
Type 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:
| Field | Description | Default | Validation |
|---|---|---|---|
annotations object (keys:string, values:string) |
Annotations specifies the annotations for the StatefulSet. | ||
pods KubernetesPod |
Pods specifies the configuration of the Pods of the Qdrant StatefulSet. |
MetricSource
Underlying type: string
Appears in:
Monitoring
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cAdvisorMetricSource MetricSource |
CAdvisorMetricSource specifies the cAdvisor metric source | ||
nodeMetricSource MetricSource |
NodeMetricSource specifies the node metric source |
NGINXConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
allowedSourceRanges string array |
AllowedSourceRanges specifies the allowed CIDR source ranges for the ingress. | ||
grpcHost string |
GRPCHost specifies the host name for the GRPC ingress. |
NodeStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name specifies the name of the node | ||
started_at string |
StartedAt 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 string |
Version specifies the version of Qdrant running on the node |
Operation
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type OperationType |
Type specifies the type of the operation | ||
phase OperationPhase |
Phase specifies the phase of the operation | ||
id integer |
Id specifies the id of the operation | ||
startTime string |
StartTime specifies the time when the operation started | ||
completionTime string |
CompletionTime specifies the time when the operation completed | ||
message string |
Message specifies the message of the operation | ||
subOperation boolean |
SubOperation specifies whether the operation is a sub-operation of another operation | ||
steps OperationStep array |
Steps specifies the steps the operation has performed |
OperationPhase
Underlying type: string
Appears in:
OperationStep
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name specifies the name of the step | ||
id integer |
Id specifies the id of the step | ||
phase StepPhase |
Phase specifies the phase of the step | ||
message string |
Message specifies the reason in case of failure |
OperationType
Underlying type: string
Appears in:
Pause
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
owner string |
Owner specifies the owner of the pause request. | ||
reason string |
Reason specifies the reason for the pause request. | ||
creationTimestamp string |
CreationTimestamp specifies the time when the pause request was created. |
QdrantCloudRegion
QdrantCloudRegion is the Schema for the qdrantcloudregions API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantCloudRegion |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantCloudRegionSpec |
QdrantCloudRegionList
QdrantCloudRegionList contains a list of QdrantCloudRegion
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantCloudRegionList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantCloudRegion array |
QdrantCloudRegionSpec
QdrantCloudRegionSpec defines the desired state of QdrantCloudRegion
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
Id specifies the unique identifier of the region | ||
helmRepositories HelmRepository array |
HelmRepositories specifies the list of helm repositories to be created to the region | ||
helmReleases HelmRelease array |
HelmReleases specifies the list of helm releases to be created to the region |
QdrantCluster
QdrantCluster is the Schema for the qdrantclusters API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantCluster |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantClusterSpec |
QdrantClusterList
QdrantClusterList contains a list of QdrantCluster
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantCluster array |
QdrantClusterRestore
QdrantClusterRestore is the Schema for the qdrantclusterrestores API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterRestore |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantClusterRestoreSpec |
QdrantClusterRestoreList
QdrantClusterRestoreList contains a list of QdrantClusterRestore objects
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterRestoreList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantClusterRestore array |
QdrantClusterRestoreSpec
QdrantClusterRestoreSpec defines the desired state of QdrantClusterRestore
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
source RestoreSource |
Source defines the source snapshot from which the restore will be done | ||
destination RestoreDestination |
Destination defines the destination cluster where the source data will end up |
QdrantClusterScheduledSnapshot
QdrantClusterScheduledSnapshot is the Schema for the qdrantclusterscheduledsnapshots API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterScheduledSnapshot |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantClusterScheduledSnapshotSpec |
QdrantClusterScheduledSnapshotList
QdrantClusterScheduledSnapshotList contains a list of QdrantCluster
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterScheduledSnapshotList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantClusterScheduledSnapshot array |
QdrantClusterScheduledSnapshotSpec
QdrantClusterScheduledSnapshotSpec defines the desired state of QdrantCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cluster-id string |
Id specifies the unique identifier of the cluster | ||
scheduleShortId string |
Specifies short Id which identifies a schedule | MaxLength: 8 |
|
schedule string |
Cron expression for frequency of creating snapshots, see https://en.wikipedia.org/wiki/Cron. The schedule is specified in UTC. |
Pattern: `^(@(annually | |
retention string |
Retention of schedule in hours | Pattern: ^[0-9]+h$ |
QdrantClusterSnapshot
QdrantClusterSnapshot is the Schema for the qdrantclustersnapshots API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterSnapshot |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantClusterSnapshotSpec |
QdrantClusterSnapshotList
QdrantClusterSnapshotList contains a list of QdrantClusterSnapshot
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantClusterSnapshotList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantClusterSnapshot array |
QdrantClusterSnapshotPhase
Underlying type: string
Appears in:
QdrantClusterSnapshotSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cluster-id string |
The 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 integer |
The CreationTimestamp of the backup (expressed in Unix epoch format) | ||
scheduleShortId string |
Specifies the short Id which identifies a schedule, if any. This field should not be set if the backup is made manually. |
MaxLength: 8 |
|
retention string |
The 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:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
Id specifies the unique identifier of the cluster | ||
version string |
Version specifies the version of Qdrant to deploy | ||
size integer |
Size specifies the desired number of Qdrant nodes in the cluster | Maximum: 30 Minimum: 1 |
|
servicePerNode boolean |
ServicePerNode specifies whether the cluster should start a dedicated service for each node. | true | |
clusterManager boolean |
ClusterManager 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. If not set, the default will be taken from the operator config. |
||
suspend boolean |
Suspend 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 array |
Pauses 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 boolean |
Deprecated | ||
image QdrantImage |
Image specifies the image to use for each Qdrant node. | ||
resources Resources |
Resources specifies the resources to allocate for each Qdrant node. | ||
security QdrantSecurityContext |
Security specifies the security context for each Qdrant node. | ||
tolerations Toleration array |
Tolerations specifies the tolerations for each Qdrant node. | ||
nodeSelector object (keys:string, values:string) |
NodeSelector specifies the node selector for each Qdrant node. | ||
config QdrantConfiguration |
Config specifies the Qdrant configuration setttings for the clusters. | ||
ingress Ingress |
Ingress specifies the ingress for the cluster. | ||
service KubernetesService |
Service specifies the configuration of the Qdrant Kubernetes Service. | ||
statefulSet KubernetesStatefulSet |
StatefulSet specifies the configuration of the Qdrant Kubernetes StatefulSet. | ||
storageClassNames StorageClassNames |
StorageClassNames specifies the storage class names for db and snapshots. | ||
topologySpreadConstraints TopologySpreadConstraint |
TopologySpreadConstraints specifies the topology spread constraints for the cluster. | ||
podDisruptionBudget PodDisruptionBudgetSpec |
PodDisruptionBudget specifies the pod disruption budget for the cluster. | ||
restartAllPodsConcurrently boolean |
RestartAllPodsConcurrently specifies whether to restart all pods concurrently (also called one-shot-restart). If enabled, all the pods in the cluster will be restarted concurrently in situations where multiple pods need to be restarted like when RestartedAtAnnotationKey is added/updated or the Qdrant version need to be upgraded. This helps sharded but not replicated clusters to reduce downtime to possible minimum during restart. |
QdrantConfiguration
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
collection QdrantConfigurationCollection |
Collection specifies the default collection configuration for Qdrant. | ||
log_level string |
LogLevel specifies the log level for Qdrant. | ||
service QdrantConfigurationService |
Service specifies the service level configuration for Qdrant. | ||
tls QdrantConfigurationTLS |
TLS specifies the TLS configuration for Qdrant. | ||
storage StorageConfig |
Storage specifies the storage configuration for Qdrant. |
QdrantConfigurationCollection
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
replication_factor integer |
ReplicationFactor specifies the default number of replicas of each shard | ||
write_consistency_factor integer |
WriteConsistencyFactor specifies how many replicas should apply the operation to consider it successful | ||
vectors QdrantConfigurationCollectionVectors |
Vectors specifies the default parameters for vectors |
QdrantConfigurationCollectionVectors
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
on_disk boolean |
OnDisk specifies whether vectors should be stored in memory or on disk. |
QdrantConfigurationService
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
api_key QdrantSecretKeyRef |
ApiKey for the qdrant instance | ||
read_only_api_key QdrantSecretKeyRef |
ReadOnlyApiKey for the qdrant instance | ||
jwt_rbac boolean |
JwtRbac specifies whether to enable jwt rbac for the qdrant instance Default is false |
||
hide_jwt_dashboard boolean |
HideJwtDashboard specifies whether to hide the JWT dashboard of the embedded UI Default is false |
||
enable_tls boolean |
EnableTLS specifies whether to enable tls for the qdrant instance Default is false |
QdrantConfigurationTLS
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cert QdrantSecretKeyRef |
Reference to the secret containing the server certificate chain file | ||
key QdrantSecretKeyRef |
Reference to the secret containing the server private key file |
QdrantImage
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
repository string |
Repository 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 PullPolicy |
PullPolicy 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 string |
PullSecretName specifies the pull secret for the Qdrant image. |
QdrantRelease
QdrantRelease describes an available Qdrant release
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantRelease |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec QdrantReleaseSpec |
QdrantReleaseList
QdrantReleaseList contains a list of QdrantRelease
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
qdrant.io/v1 |
||
kind string |
QdrantReleaseList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items QdrantRelease array |
QdrantReleaseSpec
QdrantReleaseSpec defines the desired state of QdrantRelease
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string |
Version number (should be semver compliant). E.g. "v1.10.1" |
||
default boolean |
If 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 string |
Full docker image to use for this version. If empty, a default image will be derived from Version (and qdrant/qdrant is assumed). |
||
unavailable boolean |
If set, this version cannot be used for new clusters. | false | |
endOfLife boolean |
If set, this version is no longer actively supported. | false | |
accountIds string array |
If set, this version can only be used by accounts with given IDs. | ||
accountPrivileges string array |
If set, this version can only be used by accounts that have been given the listed privileges. | ||
remarks string |
General remarks for human reading | ||
releaseNotesURL string |
Release Notes URL for the specified version |
QdrantSecretKeyRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretKeyRef SecretKeySelector |
SecretKeyRef to the secret containing data to configure the qdrant instance |
QdrantSecurityContext
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
user integer |
User specifies the user to run the Qdrant process as. | ||
group integer |
Group specifies the group to run the Qdrant process as. | ||
fsGroup integer |
FsGroup specifies file system group to run the Qdrant process as. |
RegionCapabilities
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
volumeSnapshot boolean |
VolumeSnapshot specifies whether the Kubernetes cluster supports volume snapshot | ||
volumeExpansion boolean |
VolumeExpansion specifies whether the Kubernetes cluster supports volume expansion |
RegionPhase
Underlying type: string
Appears in:
ResourceRequests
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string |
CPU specifies the CPU request for each Qdrant node. | ||
memory string |
Memory specifies the memory request for each Qdrant node. |
Resources
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string |
CPU specifies the CPU limit for each Qdrant node. | ||
memory string |
Memory specifies the memory limit for each Qdrant node. | ||
storage string |
Storage specifies the storage amount for each Qdrant node. | ||
requests ResourceRequests |
Requests specifies the resource requests for each Qdrant node. |
RestoreDestination
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the destination cluster | ||
namespace string |
Namespace of the destination cluster |
RestorePhase
Underlying type: string
Appears in:
RestoreSource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
snapshotName string |
SnapshotName is the name of the snapshot from which we wish to restore | ||
namespace string |
Namespace of the snapshot |
ScheduledSnapshotPhase
Underlying type: string
Appears in:
StepPhase
Underlying type: string
Appears in:
StorageClassNames
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
db string |
DB specifies the storage class name for db volume. | ||
snapshots string |
Snapshots specifies the storage class name for snapshots volume. |
StorageConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
performance StoragePerformanceConfig |
Performance configuration |
StoragePerformanceConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
optimizerCPUBudget integer |
OptimizerCPUBudget defines the number of CPU allocation. If 0 - auto selection, keep 1 or more CPUs unallocated depending on CPU size If negative - subtract this number of CPUs from the available CPUs. If positive - use this exact number of CPUs. |
||
asyncScorer boolean |
AsyncScorer enables io_uring when rescoring |
TraefikConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
allowedSourceRanges string array |
AllowedSourceRanges specifies the allowed CIDR source ranges for the ingress. |
VolumeSnapshotInfo
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
volumeSnapshotName string |
VolumeSnapshotName is the name of the volume snapshot | ||
volumeName string |
VolumeName is the name of the volume that was backed up | ||
readyToUse boolean |
ReadyToUse indicates if the volume snapshot is ready to use | ||
snapshotHandle string |
SnapshotHandle is the identifier of the volume snapshot in the respective cloud provider |