API 参考

qdrant.io/v1

包 v1 包含 qdrant.io v1 API 组的 API Schema 定义

资源类型

集群阶段

基础类型: string

出现在

组件阶段

基础类型: string

出现在

组件引用

出现在

字段描述默认值验证
apiVersion stringAPIVersion 是被引用组件的组和版本。
kind stringKind 是被引用组件的类型
name stringName 是被引用组件的名称
namespace stringNamespace 是被引用组件的命名空间。
markedForDeletion booleanMarkedForDeletion 指定组件是否被标记为删除

组件状态

出现在

字段描述默认值验证
name stringName 指定组件的名称
namespace stringNamespace 指定组件的命名空间
version stringVersion 指定组件的版本
phase ComponentPhasePhase 指定组件的当前阶段
message stringMessage 指定解释组件当前阶段的信息

实体阶段

基础类型: string

出现在

实体结果

基础类型: string

EntityResult 是对管理器调用的最后结果

出现在

GPU

出现在

字段描述默认值验证
gpuType GPUTypeGPUType 指定要使用的 GPU 类型。如果设置,将启用 GPU 索引。枚举值: [nvidia amd]
forceHalfPrecision boolean索引时强制对 f32 值使用半精度。
f16 转换将仅在 GPU 内存中进行,
不会影响存储类型。
false
deviceFilter string 数组按硬件名称过滤 GPU 设备。不区分大小写。
用于匹配 GPU 设备名称的子字符串列表。
示例:[- “nvidia”]
如果未指定,则接受所有设备。
最少项数:1
devices string 数组Devices 是要使用的显式 GPU 设备列表。
如果主机有多个 GPU,此选项允许通过在找到的设备列表中的索引来选择特定设备
.
如果设置了 deviceFilter,索引将在过滤后应用。
如果未指定,则接受所有设备。
最少项数:1
parallelIndexes integerParallelIndexes 是在 GPU 上运行的并行索引数。1最小值:1
groupsCount integerGroupsCount 是使用的 vulkan GPU“组”的数量。
换句话说,GPU 可以索引多少个并行点。
最佳值可能取决于 GPU 型号。
成比例,但不一定等于 warps 的物理数量。
除非您知道自己在做什么,否则不要更改此值。
最小值:1
allowIntegrated booleanAllowIntegrated 指定是否允许使用集成 GPU。false

GPUType

基础类型: string

出现在

Helm Release

出现在

字段描述默认值验证
markedForDeletionAt stringMarkedForDeletionAt 指定 helm release 被标记为删除的时间
object HelmReleaseObject 指定 helm release 对象EmbeddedResource: {}

Helm Repository

出现在

字段描述默认值验证
markedForDeletionAt stringMarkedForDeletionAt 指定 helm repository 被标记为删除的时间
object HelmRepositoryObject 指定 helm repository 对象EmbeddedResource: {}

推理配置

出现在

字段描述默认值验证
enabled booleanEnabled 指定是否为集群启用推理。false

Ingress

出现在

字段描述默认值验证
enabled booleanEnabled 指定是否为集群启用 ingress。
annotations object (键:string, 值:string)Annotations 指定 ingress 的注解。
ingressClassName stringIngressClassName 指定 ingress class 的名称
host stringHost 指定 ingress 的主机名。
tls booleanTLS 指定是否为 ingress 启用 TLS。
默认值取决于 ingress 提供者
- KubernetesIngress: False
- NginxIngress: False
- QdrantCloudTraefik: 取决于 operator 的 config.tls 设置。
tlsSecretName stringTLSSecretName 指定包含 TLS 证书的 secret 名称。
nginx NGINXConfigNGINX 指定 nginx ingress 的特定配置。
traefik TraefikConfigTraefik 指定 traefik ingress 的特定配置。

Kubernetes 发行版

基础类型: string

出现在

Kubernetes Pod

出现在

字段描述默认值验证
annotations object (键:string, 值:string)Annotations 指定 Pod 的注解。
labels object (键:string, 值:string)Labels 指定 Pod 的标签。
extraEnv EnvVar 数组ExtraEnv 指定 Pod 的额外环境变量。

Kubernetes Service

出现在

字段描述默认值验证
type ServiceTypeType 指定 Service 的类型:“ClusterIP”、“NodePort”、“LoadBalancer”。ClusterIP
annotations object (键:string, 值:string)Annotations 指定 Service 的注解。

Kubernetes StatefulSet

出现在

字段描述默认值验证
annotations object (键:string, 值:string)Annotations 指定 StatefulSet 的注解。
pods KubernetesPodPods 指定 Qdrant StatefulSet 的 Pod 配置。

度量源

基础类型: string

出现在

监控

出现在

字段描述默认值验证
cAdvisorMetricSource MetricSourceCAdvisorMetricSource 指定 cAdvisor 度量源
nodeMetricSource MetricSourceNodeMetricSource 指定节点度量源

NGINX 配置

出现在

字段描述默认值验证
allowedSourceRanges string 数组AllowedSourceRanges 指定 ingress 允许的 CIDR 源范围。
grpcHost stringGRPCHost 指定 GRPC ingress 的主机名。

节点信息

出现在

字段描述默认值验证
name stringName 指定节点的名称
region stringRegion 指定节点的区域
zone stringZone 指定节点的可用区
instanceType stringInstanceType 指定节点的实例类型
arch stringArch 指定节点的 CPU 架构
capacity NodeResourceInfoCapacity 指定节点的容量
allocatable NodeResourceInfoAllocatable 指定节点的可分配资源

节点资源信息

出现在

字段描述默认值验证
cpu stringCPU 指定节点的 CPU 资源
memory stringMemory 指定节点的内存资源
pods stringPods 指定节点的 Pod 资源
ephemeralStorage stringEphemeralStorage 指定节点的临时存储资源

节点状态

出现在

字段描述默认值验证
name stringName 指定节点的名称
started_at stringStartedAt 指定节点启动的时间(RFC3339 格式)
state object (键:PodConditionType, 值:ConditionStatus)States 指定节点的状况状态
version stringVersion 指定节点上运行的 Qdrant 版本

暂停

出现在

字段描述默认值验证
owner stringOwner 指定暂停请求的所有者。
reason stringReason 指定暂停请求的原因。
creationTimestamp stringCreationTimestamp 指定暂停请求创建的时间。

QdrantCloudRegion

QdrantCloudRegion 是 qdrantcloudregions API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantCloudRegion
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantCloudRegionSpec

QdrantCloudRegionList

QdrantCloudRegionList 包含 QdrantCloudRegion 列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantCloudRegionList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantCloudRegion 数组

Qdrant 云区域 Spec

QdrantCloudRegionSpec 定义 QdrantCloudRegion 的期望状态

出现在

字段描述默认值验证
id stringId 指定区域的唯一标识符
components ComponentReference 数组Components 指定要在区域中安装的组件列表
helmRepositories HelmRepository 数组HelmRepositories 指定要在区域中创建的 helm repository 列表
已弃用:请改用“Components”
helmReleases HelmRelease 数组HelmReleases 指定要在区域中创建的 helm release 列表
已弃用:请改用“Components”

QdrantCluster

QdrantCluster 是 qdrantclusters API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantCluster
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantClusterSpec

QdrantClusterList

QdrantClusterList 包含 QdrantCluster 列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantCluster 数组

QdrantClusterRestore

QdrantClusterRestore 是 qdrantclusterrestores API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterRestore
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantClusterRestoreSpec

QdrantClusterRestoreList

QdrantClusterRestoreList 包含 QdrantClusterRestore 对象列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterRestoreList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantClusterRestore 数组

QdrantClusterRestoreSpec

QdrantClusterRestoreSpec 定义 QdrantClusterRestore 的期望状态

出现在

字段描述默认值验证
source RestoreSourceSource 定义将从中进行恢复的源快照
destination RestoreDestinationDestination 定义源数据将存储到的目标集群

QdrantClusterScheduledSnapshot

QdrantClusterScheduledSnapshot 是 qdrantclusterscheduledsnapshots API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterScheduledSnapshot
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantClusterScheduledSnapshotSpec

QdrantClusterScheduledSnapshotList

QdrantClusterScheduledSnapshotList 包含 QdrantClusterScheduledSnapshot 列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterScheduledSnapshotList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantClusterScheduledSnapshot 数组

QdrantClusterScheduledSnapshotSpec

QdrantClusterScheduledSnapshotSpec 定义 QdrantClusterScheduledSnapshot 的期望状态

出现在

字段描述默认值验证
cluster-id stringId 指定集群的唯一标识符
scheduleShortId string指定用于标识调度的短 ID最大长度:8
schedule string用于指定创建快照频率的 Cron 表达式,请参阅 https://en.wikipedia.org/wiki/Cron
调度以 UTC 时间指定。
模式: `^(@(annually
retention string调度的保留时间(小时)模式: ^[0-9]+h$

QdrantClusterSnapshot

QdrantClusterSnapshot 是 qdrantclustersnapshots API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterSnapshot
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantClusterSnapshotSpec

QdrantClusterSnapshotList

QdrantClusterSnapshotList 包含 QdrantClusterSnapshot 列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterSnapshotList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantClusterSnapshot 数组

QdrantClusterSnapshot 阶段

基础类型: string

出现在

QdrantClusterSnapshotSpec

出现在

字段描述默认值验证
cluster-id string需要为其创建快照的集群 ID
集群应与此 QdrantClusterSnapshot 位于同一命名空间中
creation-timestamp integer备份的 CreationTimestamp(以 Unix epoch 格式表示)
scheduleShortId string指定用于标识调度的短 ID(如果存在)。
如果备份是手动创建的,则不应设置此字段。
最大长度:8
retention string此快照的保留期(小时)(如果存在)。
如果未设置,则备份没有保留期,表示不会被删除。
模式: ^[0-9]+h$

Qdrant 集群 Spec

QdrantClusterSpec 定义 QdrantCluster 的期望状态

出现在

字段描述默认值验证
id stringId 指定集群的唯一标识符
version stringVersion 指定要部署的 Qdrant 版本
size integerSize 指定集群中 Qdrant 节点的期望数量最大值:30
最小值:1
servicePerNode booleanServicePerNode 指定集群是否应为每个节点启动一个专用服务。true
clusterManager booleanClusterManager 指定是否对此集群使用集群管理器。
Python-operator 将部署一个专用的集群管理器实例。
Go-operator 将使用一个共享实例。
如果未设置,将从 operator 配置中获取默认值。
suspend booleanSuspend 指定是否暂停集群。
如果启用,集群将被暂停,除 PVC 外所有相关资源将被移除。
false
pauses Pause 数组Pauses 指定开发者用于手动维护的暂停请求列表。
如果存在任何暂停请求,Operator 将跳过处理 CR 中的任何更改。
image QdrantImageImage 指定每个 Qdrant 节点要使用的镜像。
resources ResourcesResources 指定为每个 Qdrant 节点分配的资源。
security QdrantSecurityContextSecurity 指定每个 Qdrant 节点的安全上下文。
tolerations Toleration 数组Tolerations 指定每个 Qdrant 节点的容忍度。
nodeSelector object (键:string, 值:string)NodeSelector 指定每个 Qdrant 节点的节点选择器。
config QdrantConfigurationConfig 指定集群的 Qdrant 配置设置。
ingress IngressIngress 指定集群的 ingress。
service KubernetesServiceService 指定 Qdrant Kubernetes Service 的配置。
gpu GPUGPU 指定集群的 GPU 配置。如果未设置此字段,则不使用 GPU。
statefulSet KubernetesStatefulSetStatefulSet 指定 Qdrant Kubernetes StatefulSet 的配置。
storageClassNames StorageClassNamesStorageClassNames 指定 db 和快照的存储类名称。
topologySpreadConstraints TopologySpreadConstraintTopologySpreadConstraints 指定集群的拓扑分布约束。
podDisruptionBudget PodDisruptionBudgetSpecPodDisruptionBudget 指定集群的 Pod 驱逐预算。
restartAllPodsConcurrently booleanRestartAllPodsConcurrently 指定是否并发重启所有 Pod(也称为一次性重启)。
如果启用,在需要重启多个 Pod 的情况下(例如添加/更新 RestartedAtAnnotationKey 或需要升级 Qdrant 版本),集群中的所有 Pod 将并发重启。
需要重启,例如当 RestartedAtAnnotationKey 被添加/更新或 Qdrant 版本需要升级时。
这有助于减少分片但不复制的集群在重启期间的可能最短停机时间。
如果未设置,则在没有集合被复制的情况下,operator 将并发重启节点。
startupDelaySeconds integer如果设置了 StartupDelaySeconds (> 0),则会在 Pod 启动时额外添加一个‘睡眠’。’ 将会在 pod 启动时被发送。
睡眠将在 Pod 重启时添加,不会强制任何 Pod 重启。
此功能可用于调试核心,例如如果 Pod 处于崩溃循环中,它提供了一种方式
来检查附加的存储。
rebalanceStrategy RebalanceStrategyRebalanceStrategy 指定用于自动重新均衡集群分片的策略。
此功能需要启用集群管理器才能工作。

Qdrant 配置

出现在

字段描述默认值验证
collection QdrantConfigurationCollectionCollection 指定 Qdrant 的默认集合配置。
log_level stringLogLevel 指定 Qdrant 的日志级别。
service QdrantConfigurationServiceService 指定 Qdrant 的服务级别配置。
tls QdrantConfigurationTLSTLS 指定 Qdrant 的 TLS 配置。
storage StorageConfigStorage 指定 Qdrant 的存储配置。
inference InferenceConfig推理配置。仅在 Qdrant 托管云中使用。如果未设置,此集群不可用推理功能。

Qdrant 配置集合

出现在

字段描述默认值验证
replication_factor integerReplicationFactor 指定每个分片的默认副本数
write_consistency_factor integerWriteConsistencyFactor 指定需要有多少个副本应用操作才能认为操作成功
vectors QdrantConfigurationCollectionVectorsVectors 指定向量的默认参数

Qdrant 配置集合向量

出现在

字段描述默认值验证
on_disk booleanOnDisk 指定向量应存储在内存中还是磁盘上。

Qdrant 配置服务

出现在

字段描述默认值验证
api_key QdrantSecretKeyRefQdrant 实例的 ApiKey
read_only_api_key QdrantSecretKeyRefQdrant 实例的 ReadOnlyApiKey
jwt_rbac booleanJwtRbac 指定是否为 Qdrant 实例启用 JWT RBAC
默认值为 false
hide_jwt_dashboard booleanHideJwtDashboard 指定是否隐藏嵌入式 UI 的 JWT 控制面板
默认值为 false
enable_tls booleanEnableTLS 指定是否为 Qdrant 实例启用 TLS
默认值为 false

Qdrant 配置 TLS

出现在

字段描述默认值验证
cert QdrantSecretKeyRef引用包含服务器证书链文件的 secret
key QdrantSecretKeyRef引用包含服务器私钥文件的 secret
caCert QdrantSecretKeyRef引用包含 CA 证书文件的 secret

QdrantEntity

QdrantEntity 是 qdrantentities API 的 Schema

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantEntity
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantEntitySpec

QdrantEntityList

QdrantEntityList 包含 QdrantEntity 对象列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantEntityList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantEntity 数组

QdrantEntitySpec

QdrantEntitySpec 定义 QdrantEntity 的期望状态

出现在

字段描述默认值验证
id string实体的唯一标识符(UUID 格式)。
entityType string实体的类型。
clusterId string可选的集群标识符
createdAt MicroTime实体创建的时间戳。
lastUpdatedAt MicroTime实体最后更新的时间戳。
deletedAt MicroTime实体删除的时间戳(或开始删除的时间戳)。
如果未设置,则实体未被删除
payload JSON此实体的通用负载

Qdrant 实体 Status 结果

QdrantEntityStatusResult 是对管理器调用的最后结果

出现在

字段描述默认值验证
result EntityResult实体最后一次协调的结果枚举值: [Ok Pending Error]
reason string结果的原因(例如发生错误时)
payload JSON状态的可选负载。

Qdrant 镜像

出现在

字段描述默认值验证
repository stringRepository 指定 Qdrant 镜像的仓库。
如果未指定,默认为 operator 配置(或 operator 中未指定时的 qdrant/qdrant)。
pullPolicy PullPolicyPullPolicy 指定 Qdrant 镜像的拉取策略。
如果未指定,默认为 operator 配置(或 operator 中未指定时的 IfNotPresent)。
pullSecretName stringPullSecretName 指定 Qdrant 镜像的拉取 secret。

QdrantRelease

Qdrant Release 描述一个可用的 Qdrant 版本

出现在

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantRelease
metadata ObjectMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
spec QdrantReleaseSpec

QdrantReleaseList

QdrantReleaseList 包含 Qdrant Release 列表

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantReleaseList
metadata ListMeta请参阅 Kubernetes API 文档以了解 metadata 的字段。
items QdrantRelease 数组

QdrantReleaseSpec

QdrantReleaseSpec 定义 QdrantRelease 的期望状态

出现在

字段描述默认值验证
version string版本号(应符合 semver 规范)。
例如:“v1.10.1”
default boolean如果设置,此版本是 Cloud 上新集群的默认版本。
平台中应该只有 1 个 Qdrant 版本设置为默认版本。
false
image string此版本要使用的完整 docker 镜像。
如果为空,将从 Version 推导出默认镜像(并假定为 qdrant/qdrant)。
unavailable boolean如果设置,此版本不能用于新集群。false
endOfLife boolean如果设置,此版本不再获得积极支持。false
accountIds string 数组如果设置,此版本只能由具有给定 ID 的账户使用。
accountPrivileges string 数组如果设置,此版本只能由已获得列出权限的账户使用。
remarks string供人阅读的一般备注
releaseNotesURL string指定版本的发布说明 URL

Qdrant SecretKeyRef

出现在

字段描述默认值验证
secretKeyRef SecretKeySelectorSecretKeyRef 指向包含配置 Qdrant 实例数据的 secret

Qdrant 安全上下文

出现在

字段描述默认值验证
user integerUser 指定运行 Qdrant 进程的用户。
group integerGroup 指定运行 Qdrant 进程的组。
fsGroup integerFsGroup 指定运行 Qdrant 进程的文件系统组。

重新均衡策略

基础类型: string

出现在

区域能力

出现在

字段描述默认值验证
volumeSnapshot booleanVolumeSnapshot 指定 Kubernetes 集群是否支持卷快照
volumeExpansion booleanVolumeExpansion 指定 Kubernetes 集群是否支持卷扩展

区域阶段

基础类型: string

出现在

资源请求

出现在

字段描述默认值验证
cpu stringCPU 指定每个 Qdrant 节点的 CPU 请求。
memory stringMemory 指定每个 Qdrant 节点的内存请求。

资源

出现在

字段描述默认值验证
cpu stringCPU 指定每个 Qdrant 节点的 CPU 限制。
memory stringMemory 指定每个 Qdrant 节点的内存限制。
storage stringStorage 指定每个 Qdrant 节点的存储量。
requests ResourceRequestsRequests 指定每个 Qdrant 节点的资源请求。

恢复目标

出现在

字段描述默认值验证
name string目标集群的名称
namespace string目标集群的命名空间

恢复阶段

基础类型: string

出现在

恢复源

出现在

字段描述默认值验证
snapshotName stringSnapshotName 是希望从中恢复的快照的名称
namespace string快照的命名空间

计划快照阶段

基础类型: string

出现在

存储类

出现在

字段描述默认值验证
name stringName 指定存储类的名称
default booleanDefault 指定存储类是否为默认存储类
provisioner stringProvisioner 指定存储类的 Provisioner
allowVolumeExpansion booleanAllowVolumeExpansion 指定存储类是否允许卷扩展
reclaimPolicy stringReclaimPolicy 指定存储类的回收策略
parameters object (键:string, 值:string)Parameters 指定存储类的参数

存储类名称

出现在

字段描述默认值验证
db stringDB 指定 db 卷的存储类名称。
snapshots stringSnapshots 指定快照卷的存储类名称。

存储配置

出现在

字段描述默认值验证
performance StoragePerformanceConfig性能配置

存储性能配置

出现在

字段描述默认值验证
optimizer_cpu_budget integerOptimizerCPUBudget 定义 CPU 分配数量。
如果为 0 - 自动选择,根据 CPU 大小保留 1 个或更多 CPU 未分配
如果为负 - 从可用 CPU 中减去此数量。
如果为正 - 使用此精确数量的 CPU。
async_scorer booleanAsyncScorer 在重新评分时启用 io_uring

Traefik 配置

出现在

字段描述默认值验证
allowedSourceRanges string 数组AllowedSourceRanges 指定 ingress 允许的 CIDR 源范围。
entryPoints string 数组EntryPoints 是 ingress 路由要使用的 traefik 入口点列表。
如果未设置,将采用 operator 配置中配置的 entryPoints。

卷快照类

出现在

字段描述默认值验证
name stringName 指定卷快照类的名称
driver stringDriver 指定卷快照类的驱动程序

卷快照信息

出现在

字段描述默认值验证
volumeSnapshotName stringVolumeSnapshotName 是卷快照的名称
volumeName stringVolumeName 是已备份卷的名称
readyToUse booleanReadyToUse 指示卷快照是否准备就绪可使用
snapshotHandle stringSnapshotHandle 是卷快照在相应云提供商中的标识符
此页面对您有帮助吗?

感谢您的反馈!🙏

抱歉听到您这么说。😔 您可以在 GitHub 上编辑此页面,或创建一个 GitHub Issue。