krzysztof/landing_page
1
0
Fork 0
mirror of https://github.com/qdrant/landing_page.git synced 2026-09-29 07:58:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Further improvements of cloud docs

Browse Source 
* Cleanup authentication
* Add detailed docs site to explain cluster access and node specific urls
* More details for monitoring
* Added screenshots
* Clarify the distinction between telemetry and anonymous usage statistics
This commit is contained in:
Bastian Hofmann
2024-12-03 17:03:30 +01:00
parent 1777c47d40
commit a620dba29f
8 changed files with 64 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qdrant-landing/content/documentation/cloud/authentication.md
+6 -7
View File
@@ -5,17 +5,16 @@ weight: 30
# Database Authentication in Qdrant Managed Cloud
This page shows you how to use the Qdrant Cloud Console to create a custom API key for a cluster. You will learn how to connect to your cluster using the new API key.
This page shows you how to use the Qdrant Cloud Console to create a Database API key for a cluster. You will learn how to connect to your cluster using the new API key.
## Create API keys
## Create Database API keys
The API key is only shown once after creation. If you lose it, you will need to create a new one.
However, we recommend rotating the keys from time to time. To create additional API keys do the following.
1. Go to the [Cloud Dashboard](https://qdrant.to/cloud).
2. Select **Access Management** to display available API keys, or go to the **API Keys** section of the Cluster detail page.
3. Click **Create** and choose a cluster name from the dropdown menu.
> **Note:** You can create a key that provides access to multiple clusters. Select desired clusters in the dropdown box.
2. SGo to the **API Keys** section of the Cluster detail page.
3. Click **Create**. If you have granular access control activated, you can now configure the permissions for the new key.
4. Click **OK** and retrieve your API key.
## Test cluster access
@@ -38,8 +37,8 @@ Open Terminal and run the request. You should get a response that looks like thi
## Authenticate via SDK
Now that you have created your first cluster and key, you might want to access Qdrant Cloud from within your application.
Our official Qdrant clients for Python, TypeScript, Go, Rust, .NET and Java all support the API key parameter.
Now that you have created your first cluster and key, you might want to access your database from within your application.
Our [official Qdrant clients](/documentation/interfaces) for Python, TypeScript, Go, Rust, .NET and Java all support the API key parameter.
```bash
curl \
qdrant-landing/content/documentation/cloud/cluster-access.md
+30
View File
@@ -0,0 +1,30 @@
---
title: Cluster Access
weight: 35
---
# Accessing Qdrant Cloud Clusters
Once you [created](/documentation/cloud/create-cluster/) a cluster, and set up an [API key](/documentation/cloud/authentication/), you can access your cluster through the integrated Web UI, the REST API and the GRPC API.
## Web UI
There is the convenient link on the cluster detail page in the Qdrant Cloud Console to access the [Web UI](/documentation/web-ui) of your cluster.
![Cluster Web UI](/documentation/cloud/cloud-db-dashboard.png)
## API
The REST API is exposed on your cluster endpoint at port `6333`. The GRPC API is exposed on your cluster endpoint at port `6334`. When accessing the cluster endpoint, traffic is automatically load balanced across all healthy Qdrant nodes in the cluster. For all operations, but the few mentioned at [Node specific endpoints](#node-specific-endpoints), you should use the cluster endpoint. It does not matter which node in the cluster you land on. All nodes can handle all search and write requests.
![Cluster cluster endpoint](/documentation/cloud/cloud-endpoint.png)
Have a look at the [API reference](/documentation/interfaces/#api-reference) and the official [client libraries](/documentation/interfaces/#client-libraries) for more information on how to interact with the Qdrant Cloud API.
## Node specific endpoints
Next to the cluster endpoint which loadbalances requests across all healthy Qdrant nodes, each node in the cluster has its own endpoint as well. This is mainly usefull for monitoring or manual shard management purpuses.
You can finde the node specific endpoints on the cluster detail page in the Qdrant Cloud Console.
![Cluster node endpoints](/documentation/cloud/cloud-node-endpoints.png)
qdrant-landing/content/documentation/cloud/cluster-monitoring.md
+8
View File
@@ -16,3 +16,11 @@ Logs of the database cluster are available in the Qdrant Cloud Console in the **
## Alerts
You will receive automatic alerts via email before your cluster reaches the currently configured memory or storage limits, including recommendations for scaling your cluster.
## Qdrant database metrics and telemetry
You can also directly access the metrics and telemetry that the Qdrant database nodes provide.
Metrics in a Prometheus compatible format are available at the `/metrics` endpoint of each Qdrant database node. When scraping, you should use the [node specific URLs](/documentation/cloud/cluster-access/#node-specific-endpoints) to ensure that you are scraping metrics from all nodes in each cluster. For more information see [Qdrant monitoring](/documentation/guides/monitoring).
You can also access the `/telemetry` [endpoint](https://api.qdrant.tech/api-reference/service/telemetry) of your database. This endpoint is available on the cluster endpoint and provides information about the current state of the database, including the number of vectors, shards, and other useful information.