krzysztof/landing_page
1
0
Fork 0
mirror of https://github.com/qdrant/landing_page.git synced 2026-10-11 13:58:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Private cloud 1.9.3

Browse Source
This commit is contained in:
Bastian Hofmann
2025-12-22 14:46:29 +01:00
parent cdf758566e
commit fde516c9e0
4 changed files with 204 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qdrant-landing/content/documentation/private-cloud/api-reference.md
+143 -20
View File
@@ -6,9 +6,58 @@ weight: 5
# API Reference
## Packages
- [auth.qdrant.io/v1alpha1](#authqdrantiov1alpha1)
- [qdrant.io/v1](#qdrantiov1)
## auth.qdrant.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the qdrant.io v1alpha1 API group
### Resource Types
- [APIAuthentication](#apiauthentication)
#### APIAuthentication
APIAuthentication is a configuration for authenticating against Qdrant clusters.
_Appears in:_
- [APIAuthenticationList](#apiauthenticationlist)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `apiVersion` _string_ | `auth.qdrant.io/v1alpha1` | | |
| `kind` _string_ | `APIAuthentication` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
| `spec` _[APIAuthenticationSpec](#apiauthenticationspec)_ | | | |
#### APIAuthenticationSpec
APIAuthenticationSpec describes the configuration for authenticating against Qdrant clusters.
_Appears in:_
- [APIAuthentication](#apiauthentication)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `sha512` _string_ | SHA512 hash of an API key. | | MaxLength: 128 <br />MinLength: 128 <br /> |
| `clusterIDs` _string array_ | List of cluster IDs for which the API key is valid | | |
## qdrant.io/v1
Package v1 contains API Schema definitions for the qdrant.io v1 API group
@@ -33,6 +82,25 @@ Package v1 contains API Schema definitions for the qdrant.io v1 API group
#### ClusterManagerReponse
_Appears in:_
- [QdrantClusterStatus](#qdrantclusterstatus)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `lastResponseTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | The last time the cluster-manager responded in UTC | | |
| `executed_actions` _[RawMessage](#rawmessage)_ | ExecutedActions are the actions that have been executed by the cluster-manager | | |
| `required_actions` _[RawMessage](#rawmessage)_ | RequiredActions are the actions that are required to be executed by the operator as instructed by cluster-manager | | |
| `suggested_actions` _[RawMessage](#rawmessage)_ | SuggestedActions are suggested but not required actions to be executed by the operator as instructed by cluster-manager | | |
#### ClusterPhase
_Underlying type:_ _string_
@@ -303,6 +371,28 @@ _Appears in:_
| `k3s` | |
#### KubernetesEventInfo
_Appears in:_
- [NodePVCStatus](#nodepvcstatus)
- [NodeStatus](#nodestatus)
- [VolumeSnapshotInfo](#volumesnapshotinfo)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `message` _string_ | Event message | | |
| `reason` _string_ | Event reason | | |
| `count` _integer_ | How many times the event has occurred | | |
| `firstTimestamp` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | The first time the event was seen | | |
| `lastTimestamp` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ | The last time the event was seen | | |
#### KubernetesPod
@@ -428,6 +518,28 @@ _Appears in:_
| `allocatable` _[NodeResourceInfo](#noderesourceinfo)_ | Allocatable specifies the allocatable resources of the node | | |
#### NodePVCStatus
_Appears in:_
- [NodeStatus](#nodestatus)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `storageClassName` _string_ | Name of the StorageClass used by the PVC | | |
| `phase` _[PersistentVolumeClaimPhase](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaimphase-v1-core)_ | Status phase of the PVC | | |
| `conditions` _[PersistentVolumeClaimCondition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaimcondition-v1-core) array_ | Conditions of the PVC | | |
| `events` _[KubernetesEventInfo](#kuberneteseventinfo) array_ | Recent Kubernetes Events related to the PVC<br />Events that happened in the last 30 minutes are stored. | | |
| `capacity` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcelist-v1-core)_ | capacity represents the actual resources of the underlying volume. | | |
| `currentVolumeAttributesClassName` _string_ | currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.<br />When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim | | |
| `modifyVolumeStatus` _[ModifyVolumeStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#modifyvolumestatus-v1-core)_ | ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.<br />When this is unset, there is no ModifyVolume operation being attempted. | | |
#### NodeResourceInfo
@@ -464,6 +576,16 @@ _Appears in:_
| `started_at` _string_ | StartedAt specifies the time when the node started (in RFC3339 format) | | |
| `state` _object (keys:[PodConditionType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podconditiontype-v1-core), values:[ConditionStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#conditionstatus-v1-core))_ | States specifies the condition states of the node | | |
| `version` _string_ | Version specifies the version of Qdrant running on the node | | |
| `liveness` _boolean_ | Reports if qdrant node responded to liveness request (before readiness).<br />This is needed to beter report recovery process to the user. | | |
| `podPhase` _[PodPhase](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podphase-v1-core)_ | Status phase of the Pod of the node | | |
| `podConditions` _[PodCondition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podcondition-v1-core) array_ | Conditions of the Pod of the node | | |
| `podMessage` _string_ | Status message of the Pod of the node | | |
| `podReason` _string_ | Status reason of the Pod of the node | | |
| `containerStatuses` _[ContainerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#containerstatus-v1-core) array_ | Details container statuses of the Pod of the node | | |
| `events` _[KubernetesEventInfo](#kuberneteseventinfo) array_ | Recent Kubernetes Events related to the Pod of the node<br />Events that happened in the last 30 minutes are stored. | | |
| `restartCount` _integer_ | The number of times the main qdrant container has been restarted. | | |
| `databasePVCStatus` _[NodePVCStatus](#nodepvcstatus)_ | Status of the database storage PVC | | |
| `snapshotsPVCStatus` _[NodePVCStatus](#nodepvcstatus)_ | Status of the snapshots storage PVC | | |
#### Pause
@@ -801,7 +923,7 @@ _Appears in:_
| `gpu` _[GPU](#gpu)_ | GPU specifies GPU configuration for the cluster. If this field is not set, no GPU will be used. | | |
| `statefulSet` _[KubernetesStatefulSet](#kubernetesstatefulset)_ | StatefulSet specifies the configuration of the Qdrant Kubernetes StatefulSet. | | |
| `storageClassNames` _[StorageClassNames](#storageclassnames)_ | StorageClassNames specifies the storage class names for db and snapshots. | | |
| `storageTier` _[StorageTier](#storagetier)_ | StorageTier specifies the performance tier to use for the disk | | Enum: [budget balanced performance] <br /> |
| `storage` _[Storage](#storage)_ | Storage specifies the storage specification for the PVCs of the cluster. If the field is not set, no configuration will be applied. | | |
| `topologySpreadConstraints` _[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#topologyspreadconstraint-v1-core)_ | TopologySpreadConstraints specifies the topology spread constraints for the cluster. | | |
| `podDisruptionBudget` _[PodDisruptionBudgetSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#poddisruptionbudgetspec-v1-policy)_ | PodDisruptionBudget specifies the pod disruption budget for the cluster. | | |
| `restartAllPodsConcurrently` _boolean_ | RestartAllPodsConcurrently specifies whether to restart all pods concurrently (also called one-shot-restart).<br />If enabled, all the pods in the cluster will be restarted concurrently in situations where multiple pods<br />need to be restarted, like when RestartedAtAnnotationKey is added/updated or the Qdrant version needs to be upgraded.<br />This helps sharded but not replicated clusters to reduce downtime to a possible minimum during restart.<br />If unset, the operator is going to restart nodes concurrently if none of the collections if replicated. | | |
@@ -1295,6 +1417,24 @@ _Appears in:_
| `Disabled` | |
#### Storage
_Appears in:_
- [QdrantClusterSpec](#qdrantclusterspec)
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `volumeAttributesClassName` _string_ | VolumeAttributesClassName specifies VolumeAttributeClass name to use for the storage PVCs | | |
| `iops` _integer_ | IOPS defines the IOPS number to configure for the storage PVCs | | |
| `throughput` _integer_ | Throughput defines the throughput number in MB/s for the storage PVCs | | |
#### StorageClass
@@ -1367,25 +1507,6 @@ _Appears in:_
| `async_scorer` _boolean_ | AsyncScorer enables io_uring when rescoring | | |
#### StorageTier
_Underlying type:_ _string_
StorageTier specifies the performance profile for the disk to use.
_Validation:_
- Enum: [budget balanced performance]
_Appears in:_
- [QdrantClusterSpec](#qdrantclusterspec)
| Field | Description |
| --- | --- |
| `budget` | |
| `balanced` | |
| `performance` | |
#### TraefikConfig
@@ -1437,6 +1558,8 @@ _Appears in:_
| `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 | | |
| `error` _[VolumeSnapshotError](#volumesnapshoterror)_ | Error contains the error details if the snapshot creation failed | | |
| `events` _[KubernetesEventInfo](#kuberneteseventinfo) array_ | Recent Kubernetes Events related to the VolumeSnapshot<br />Events that happened in the last 30 minutes are stored. | | |
#### WriteCluster