Retry PR 595

This commit is contained in:
mjang
2024-03-13 11:02:32 -07:00
parent 6b845d59d7
commit 0edecd4393
5 changed files with 96 additions and 38 deletions
@@ -10,9 +10,9 @@ aliases:
Qdrant Cloud is our SaaS (software-as-a-service) solution, providing managed Qdrant instances on the cloud.
We provide you with the same fast and reliable similarity search engine, but without the need to maintain your own infrastructure.
Transitioning from on-premise to the cloud version of Qdrant does not require changing anything in the way you interact with the service. All you have to do is [create a Qdrant Cloud account](https://qdrant.to/cloud) and [provide a new API key]({{< ref "/documentation/cloud/authentication" >}}) to each request.
Transitioning from on-premise to the cloud version of Qdrant does not require changing anything in the way you interact with the service. All you have to do is [create a Qdrant Cloud account](https://qdrant.to/cloud/) and [provide a new API key](/documentation/cloud/authentication/) to each request.
The transition is even easier if you use the official client libraries. For example, the [Python Client](https://github.com/qdrant/qdrant-client) has the support of the API key already built-in, so you only need to provide it once, when the QdrantClient instance is created.
The transition is even easier if you use the official client libraries. For example, the [Python Client](https://github.com/qdrant/qdrant-client/) has the support of the API key already built-in, so you only need to provide it once, when the QdrantClient instance is created.
### Cluster configuration
@@ -28,13 +28,20 @@ Each instance comes pre-configured with the following tools, features and suppor
### Getting started with Qdrant Cloud
To use Qdrant Cloud, you will need to create at least one cluster. There are two ways to start:
1. [**Create a Free Tier cluster**]({{< ref "/documentation/cloud/quickstart-cloud" >}}) with 1 node and a default configuration (1GB RAM, 0.5 CPU and 4GB Disk). This option is perfect for prototyping and you don't need a credit card to join.
2. [**Configure a custom cluster**]({{< ref "/documentation/cloud/create-cluster" >}}) with additional nodes and more resources. For this option, you will have to provide billing information.
We recommend that you use the Free Tier cluster for testing purposes. The capacity should be enough to serve up to 1M vectors of 768dim. To calculate your needs, refer to [capacity planning]({{< ref "/documentation/cloud/capacity-sizing" >}}).
1. [**Create a Free Tier cluster**](/documentation/cloud/quickstart-cloud/) with
1 node and a default configuration (1 GB RAM, 0.5 CPU and 4 GB Disk). This
option is perfect for prototyping. You don't need a credit card to join.
2. [**Configure a custom cluster**](/documentation/cloud/create-cluster/) with additional nodes and more resources. For this option, you will have to provide billing information.
We recommend that you use the Free Tier cluster for testing purposes. The
capacity should be enough to serve up to 1 M vectors of 768 dimensions. To
calculate your needs, refer to our documentation on [Capacity and sizing](/documentation/cloud/capacity-sizing/).
### Support & Troubleshooting
All Qdrant Cloud users are welcome to join our [Discord community](https://qdrant.to/discord). Our Support Engineers are available to help you anytime.
All Qdrant Cloud users are welcome to join our [Discord community](https://qdrant.to/discord/).
Our Support Engineers are available to help you anytime.
Additionally, paid customers can also contact support via channels provided during cluster creation and/or on-boarding.
Additionally, paid customers can also contact support through channels provided during cluster
creation and/or on-boarding.
@@ -9,25 +9,58 @@ This page shows you how to use the Qdrant Cloud Console to create a custom Qdran
> **Prerequisite:** Please make sure you have provided billing information before creating a custom cluster.
1. Start in the **Clusters** section of the [Cloud Dashboard](https://cloud.qdrant.io).
2. Select **Clusters** and then click **+ Create**.
3. A window will open. Enter a cluster **Name**.
4. Currently, you can deploy to AWS, GCP, or Azure.
5. Choose your data center region. If you have latency concerns or other topology-related requirements, [**let us know**](mailto:cloud@qdrant.io).
6. Configure RAM size for each node (1GB to 64GB).
> Please read [**Capacity and Sizing**](../../cloud/capacity-sizing/) to make the right choice. If you need more capacity per node, [**let us know**](mailto:cloud@qdrant.io).
7. Choose the number of CPUs per node (0.5 core to 16 cores). The max/min number of CPUs is coupled to the chosen RAM size.
8. Select the number of nodes you want the cluster to be deployed on.
> Each node is automatically attached with a disk space offering enough space for your data if you decide to put the metadata or even the index on the disk storage.
9. Click **Create** and wait for your cluster to be provisioned.
1. Start in the **Clusters** section of the [Cloud Dashboard](https://cloud.qdrant.io/).
1. Select **Clusters** and then click **+ Create**.
1. In the **Create a cluster** screen select **Free** or **Standard**
For more information on a free cluster, see the [Cloud quickstart](/documentation/cloud/quickstart-cloud/). The remaining steps assume you want a standard cluster.
1. Select a provider. Currently, you can deploy to:
Your cluster will be reachable on port 443 and 6333 (Rest) and 6334 (gRPC).
- Amazon Web Services (AWS)
- Google Cloud Platform (GCP)
- Microsoft Azure
![Embeddings](/docs/cloud/create-cluster.png)
1. Choose your data center region. If you have latency concerns or other topology-related requirements, [**let us know**](mailto:cloud@qdrant.io).
1. Configure RAM for each node (2 GB to 64 GB).
> For more informtion, see our [**Capacity and Sizing**](/documentation/cloud/capacity-sizing/) guidance. If you need more capacity per node, [**let us know**](mailto:cloud@qdrant.io).
1. Choose the number of vCPUs per node (0.5 core to 16 cores). If you add more
RAM, the menu provides differnet options for vCPUs.
1. Select the number of nodes you want the cluster to be deployed on.
> Each node is automatically attached with a disk space offering enough space for your data if you decide to put the metadata or even the index on the disk storage.
1. Select the disk space for your deployment. You can choose from 8 GB to 2 TB.
1. Review your cluster configuration and pricing.
1. When you're ready, select **Create**. It takes some time to provision your cluster.
Once provisioned, you can access your cluster on ports 443 and 6333 (REST)
and 6334 (gRPC).
![Cluster configured in the UI](/docs/cloud/create-cluster-test.png)
You should now see the new cluster in the **Clusters** menu.
A custom cluster includes the following resources. The values in the table are maximums.
| Resource | Value (max) |
|------------|-------------|
| RAM | 64 GB |
| vCPU | 16 vCPU |
| Disk space | 2 TB |
| Nodes | 10 |
### Included features (paid)
The features included with this cluster are:
- Dedicated resources
- Backup and disaster recovery
- Horizontal and vertical scaling
- Monitoring and log management
Learn more about these features in the [Qdrant Cloud dashboard](https://cloud.qdrant.io/).
## Next steps
You will need to connect to your new Qdrant Cloud cluster. Follow [**Authentication**](../../cloud/authentication/) to create one or more API keys.
You will need to connect to your new Qdrant Cloud cluster. Follow [**Authentication**](/documentation/cloud/authentication/) to create one or more API keys.
Your new cluster is highly available and responsive to your application requirements and resource load. Read more in [**Cluster Scaling**](../../cloud/cluster-scaling/).
Your new cluster is highly available and responsive to your application requirements and resource load. Read more in [**Cluster Scaling**](/documentation/cloud/cluster-scaling/).
@@ -1,26 +1,40 @@
---
title: Quickstart
title: Cloud Quickstart
weight: 10
aliases:
- ../cloud-quick-start
- cloud-quick-start
---
# Quickstart
# Cloud Quickstart
This page shows you how to use the Qdrant Cloud Console to create a free tier cluster and then connect to it with Qdrant Client.
## Step 1: Create a Free Tier cluster
## Create a Free Tier cluster
1. Start in the **Overview** section of the [Cloud Dashboard](https://cloud.qdrant.io).
2. Under **Set a Cluster Up** enter a **Cluster name**.
3. Click **Create Free Tier** and then **Continue**.
4. Under **Get an API Key**, select the cluster and click **Get API Key**.
5. Save the API key, as you won't be able to request it again. Click **Continue**.
6. Save the code snippet provided to access your cluster. Click **Complete** to finish setup.
1. Start in the **Overview** section of the [Cloud Dashboard](https://cloud.qdrant.io/).
1. Find the dashboard menu in the left-hand pane. If you do not see it, select
the icon with three horizonal lines in the upper-left of the screen
1. Select **Clusters**. On the Clusters page, select **Create**.
1. In the **Create a Cluster** page, select **Free**
1. Scroll down. Confirm your cluster configuration, and select **Create**.
![Embeddings](/docs/cloud/quickstart-cloud.png)
You should now see your new free tier cluster in the **Clusters** menu.
## Step 2: Test cluster access
A free tier cluster includes the following resources:
| Resource | Value |
|------------|-------|
| RAM | 1 GB |
| vCPU | 0.5 |
| Disk space | 4 GB |
| Nodes | 1 |
## Get an API key
To use your cluster, you need an API key. Read our documentation on [Cloud
Authentication](/documentation/cloud/authentication/) for the process.
## Test cluster access
After creation, you will receive a code snippet to access your cluster. Your generated request should look very similar to this one:
@@ -32,14 +46,18 @@ curl \
Open Terminal and run the request. You should get a response that looks like this:
```bash
{"title":"qdrant - vector search engine","version":"1.4.1"}
{"title":"qdrant - vector search engine","version":"1.8.1"}
```
> **Note:** The API key needs to be present in the request header every time you make a request via Rest or gRPC interface.
## Step 3: Authenticate via SDK
> **Note:** You need to include the API key in the request header for every
> request over REST or gRPC.
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, and .NET all support the API key parameter.
## Authenticate via SDK
Now that you have created your first cluster and API key, you can access the
Qdrant Cloud from within your application.
Our official Qdrant clients for Python, TypeScript, Go, Rust, and .NET all
support the API key parameter.
```python
from qdrant_client import QdrantClient