API参考

包

qdrant.io/v1

包 v1 包含 qdrant.io v1 API 组的 API 模式定义

资源类型

集群阶段

基础类型: string

出现在：

组件阶段

基础类型: string

出现在：

组件状态

出现在：

字段描述默认值验证
name string名称指定组件的名称
namespace string命名空间指定组件的命名空间
version string版本指定组件的版本
phase 组件阶段Phase 指定组件的当前阶段
message string消息指定了解释组件当前阶段的信息

HelmRelease

出现在：

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

Helm仓库

出现在：

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

入口

出现在：

字段描述默认值验证
enabled booleanEnabled 指定是否启用集群的入口。
annotations object (keys:string, values:string)Annotations 指定了 ingress 的注解。
ingressClassName stringIngressClassName 指定了 ingress 类的名称
host stringHost 指定了 ingress 的主机。
tls booleanTLS 指定是否为入口启用 tls。
默认值取决于入口提供者：
- KubernetesIngress: 否
- NginxIngress: 否
- QdrantCloudTraefik: 取决于操作员的 config.tls 设置。
tlsSecretName stringTLSSecretName 指定包含TLS证书的密钥的名称。
nginx NGINX配置NGINX 指定了 nginx ingress 的具体配置。
traefik TraefikConfigTraefik 指定了 traefik ingress 的具体配置。

Kubernetes 发行版

基础类型: string

出现在：

KubernetesPod

出现在：

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

Kubernetes服务

出现在：

字段描述默认值验证
type 服务类型类型指定服务的类型：“ClusterIP”，“NodePort”，“LoadBalancer”。ClusterIP
annotations object (keys:string, values:string)Annotations 指定了服务的注释。

Kubernetes有状态集

出现在：

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

指标源

基础类型: string

出现在：

监控

出现在：

字段描述默认值验证
cAdvisorMetricSource 指标来源CAdvisorMetricSource 指定了 cAdvisor 指标源
nodeMetricSource 度量来源NodeMetricSource 指定节点指标源

NGINX配置

出现在：

字段描述默认值验证
allowedSourceRanges string arrayAllowedSourceRanges 指定了入口允许的CIDR源范围。
grpcHost stringGRPCHost 指定 GRPC 入口的主机名。

节点状态

出现在：

字段描述默认值验证
name string名称指定节点的名称
started_at stringStartedAt 指定节点启动的时间（以RFC3339格式）
state 对象 (键:Pod条件类型, 值:条件状态)状态指定了节点的条件状态
version string版本指定了节点上运行的Qdrant版本

操作

出现在：

字段描述默认值验证
type 操作类型类型指定操作的类型
phase 操作阶段Phase 指定操作的阶段
id integerId 指定操作的 id
startTime stringStartTime 指定操作开始的时间
completionTime stringCompletionTime 指定操作完成的时间
message stringMessage 指定操作的消息
subOperation booleanSubOperation 指定该操作是否是另一个操作的子操作
steps 操作步骤 arraySteps 指定操作已执行的步骤

操作阶段

基础类型: string

出现在：

操作步骤

出现在：

字段描述默认值验证
name string名称指定步骤的名称
id integerId 指定步骤的 id
phase 步骤阶段Phase 指定步骤的阶段
message string消息指定失败时的原因

操作类型

基础类型: string

出现在：

暂停

出现在：

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

QdrantCloudRegion

QdrantCloudRegion 是 qdrantcloudregions API 的架构

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantCloudRegion
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantCloudRegionSpec

QdrantCloudRegionList

QdrantCloudRegionList 包含一个 QdrantCloudRegion 的列表

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

QdrantCloudRegionSpec

QdrantCloudRegionSpec 定义了 QdrantCloudRegion 的期望状态

出现在：

字段描述默认值验证
id stringId 指定区域的唯一标识符
helmRepositories Helm仓库 arrayHelmRepositories 指定要创建到该区域的 helm 仓库列表
helmReleases HelmRelease arrayHelmReleases 指定要在该区域创建的 helm 发布列表

Qdrant集群

QdrantCluster 是 qdrantclusters API 的架构

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind 字符串QdrantCluster
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantClusterSpec

Qdrant集群列表

QdrantClusterList 包含一个 QdrantCluster 的列表

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

Qdrant集群恢复

QdrantClusterRestore 是 qdrantclusterrestores API 的架构

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantClusterRestore
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantClusterRestoreSpec

QdrantClusterRestoreList

QdrantClusterRestoreList 包含一个 QdrantClusterRestore 对象列表

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

QdrantClusterRestoreSpec

QdrantClusterRestoreSpec 定义了 QdrantClusterRestore 的期望状态

出现在：

字段描述默认值验证
source 恢复源Source 定义了从中进行还原的源快照
destination 恢复目的地目标定义了源数据最终将到达的目标集群

Qdrant集群计划快照

QdrantClusterScheduledSnapshot 是 qdrantclusterscheduledsnapshots API 的架构

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind 字符串QdrantClusterScheduledSnapshot
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantClusterScheduledSnapshotSpec

Qdrant集群计划快照列表

QdrantClusterScheduledSnapshotList 包含一个 QdrantCluster 的列表

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

QdrantClusterScheduledSnapshotSpec

QdrantClusterScheduledSnapshotSpec 定义了 QdrantCluster 的期望状态

出现在：

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

Qdrant集群快照

QdrantClusterSnapshot 是 qdrantclustersnapshots API 的架构

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind 字符串QdrantClusterSnapshot
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantClusterSnapshotSpec

Qdrant集群快照列表

QdrantClusterSnapshotList 包含一个 QdrantClusterSnapshot 的列表

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

Qdrant集群快照阶段

基础类型: string

出现在：

QdrantClusterSnapshotSpec

出现在：

字段描述默认值验证
cluster-id string需要为其创建快照的集群ID
集群应与此QdrantClusterSnapshot位于同一命名空间中
creation-timestamp integer备份的创建时间戳（以Unix纪元格式表示）
scheduleShortId string指定用于识别计划的短ID（如果有）。
如果备份是手动进行的，则不应设置此字段。		最大长度：8
retention string此快照的保留时间（以小时为单位），如果有的话。
如果未设置，则备份没有保留时间，意味着它不会被删除。		模式：^[0-9]+h$

QdrantClusterSpec

QdrantClusterSpec 定义了 QdrantCluster 的期望状态

出现在：

字段描述默认值验证
id stringId 指定集群的唯一标识符
version string版本指定要部署的Qdrant版本
size integerSize 指定集群中所需的 Qdrant 节点数量最大值：30
最小值：1
servicePerNode booleanServicePerNode 指定集群是否应为每个节点启动一个专用服务。true
clusterManager booleanClusterManager 指定是否为此集群使用集群管理器。
Python-operator 将部署一个专用的集群管理器实例。
Go-operator 将使用一个共享实例。
如果未设置，将从操作员配置中获取默认值。
suspend booleanSuspend 指定是否暂停集群。
如果启用，集群将被暂停，所有相关资源将被移除，除了PVCs。		false
pauses 暂停 arrayPauses 指定了开发者手动维护的暂停请求列表。
如果存在任何暂停请求，操作员将跳过处理 CR 中的任何更改。
distributed boolean已弃用
image QdrantImageImage 指定用于每个 Qdrant 节点的镜像。
resources 资源资源指定为每个Qdrant节点分配的资源。
security QdrantSecurityContextSecurity 指定了每个 Qdrant 节点的安全上下文。
tolerations 容忍 arrayTolerations 指定了每个 Qdrant 节点的容忍度。
nodeSelector object (keys:string, values:string)NodeSelector 指定每个 Qdrant 节点的节点选择器。
config QdrantConfiguration配置指定了集群的Qdrant配置设置。
ingress 入口Ingress 指定了集群的入口。
service KubernetesServiceService 指定了 Qdrant Kubernetes 服务的配置。
statefulSet Kubernetes有状态集StatefulSet 指定了 Qdrant Kubernetes StatefulSet 的配置。
storageClassNames 存储类名称StorageClassNames 指定了数据库和快照的存储类名称。
topologySpreadConstraints 拓扑分布约束TopologySpreadConstraints 指定了集群的拓扑分布约束。
podDisruptionBudget Pod中断预算规格PodDisruptionBudget 指定了集群的 Pod 中断预算。
restartAllPodsConcurrently booleanRestartAllPodsConcurrently 指定是否同时重启所有 pod（也称为一次性重启）。
如果启用，在需要重启多个 pod 的情况下（例如添加/更新 RestartedAtAnnotationKey 或需要升级 Qdrant 版本时），集群中的所有 pod 将同时重启。
这有助于分片但未复制的集群在重启期间将停机时间减少到可能的最小值。

Qdrant配置

出现在：

字段描述默认值验证
collection QdrantConfigurationCollection集合指定了Qdrant的默认集合配置。
log_level stringLogLevel 指定了 Qdrant 的日志级别。
service QdrantConfigurationService服务指定了Qdrant的服务级别配置。
tls QdrantConfigurationTLSTLS 指定了 Qdrant 的 TLS 配置。
storage 存储配置Storage 指定了 Qdrant 的存储配置。

Qdrant配置集合

出现在：

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

Qdrant配置集合向量

出现在：

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

Qdrant配置服务

出现在：

字段描述默认值验证
api_key QdrantSecretKeyRefQdrant实例的ApiKey
read_only_api_key QdrantSecretKeyRef用于qdrant实例的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引用包含服务器证书链文件的密钥
key QdrantSecretKeyRef引用包含服务器私钥文件的密钥

QdrantImage

出现在：

字段描述默认值验证
repository stringRepository 指定 Qdrant 镜像的仓库。
如果未指定，则默认为操作员的配置（如果操作员中未指定，则默认为 qdrant/qdrant）。
pullPolicy 拉取策略PullPolicy 指定了 Qdrant 镜像的拉取策略。
如果未指定，则默认为操作员的配置（如果操作员中未指定，则默认为 IfNotPresent）。
pullSecretName stringPullSecretName 指定了 Qdrant 镜像的拉取密钥。

Qdrant发布

QdrantRelease 描述了一个可用的 Qdrant 版本

出现在：

字段描述默认值验证
apiVersion stringqdrant.io/v1
kind stringQdrantRelease
metadata 对象元数据请参考Kubernetes API文档以了解metadata的字段。
spec QdrantReleaseSpec

Qdrant发布列表

QdrantReleaseList 包含一个 QdrantRelease 的列表

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

QdrantReleaseSpec

QdrantReleaseSpec 定义了 QdrantRelease 的期望状态

出现在：

字段描述默认值验证
version string版本号（应符合semver规范）。
例如：“v1.10.1”
default boolean如果设置，此版本将成为云上新集群的默认版本。
平台上应该只有一个Qdrant版本被设置为默认。		false
image string用于此版本的完整docker镜像。
如果为空，将从版本中派生默认镜像（并假定为qdrant/qdrant）。
unavailable boolean如果设置，此版本不能用于新集群。false
endOfLife boolean如果设置，此版本不再被积极支持。false
accountIds 字符串数组如果设置，此版本只能由具有给定ID的账户使用。
accountPrivileges string array如果设置，此版本只能由已被授予列出的权限的账户使用。
remarks string供人类阅读的一般备注
releaseNotesURL string指定版本的发布说明URL

QdrantSecretKeyRef

出现在：

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

Qdrant安全上下文

出现在：

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

区域能力

出现在：

字段描述默认值验证
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 资源请求Requests 指定了每个 Qdrant 节点的资源请求。

恢复目的地

出现在：

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

恢复阶段

基础类型: string

出现在：

恢复源

出现在：

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

计划快照阶段

基础类型: string

出现在：

步骤阶段

基础类型: string

出现在：

存储类名称

出现在：

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

存储配置

出现在：

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

存储性能配置

出现在：

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

Traefik配置

出现在：

字段描述默认值验证
allowedSourceRanges string arrayAllowedSourceRanges 指定了入口允许的CIDR源范围。

卷快照信息

出现在：

字段描述默认值验证
volumeSnapshotName stringVolumeSnapshotName 是卷快照的名称
volumeName stringVolumeName 是被备份的卷的名称
readyToUse booleanReadyToUse 表示卷快照是否可以使用
snapshotHandle stringSnapshotHandle 是相应云提供商中卷快照的标识符
这个页面有用吗？

感谢您的反馈！🙏

我们很抱歉听到这个消息。😔 你可以在GitHub上编辑这个页面，或者创建一个GitHub问题。

本页内容：