mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-26 22:48:30 +02:00
Bastian Hofmann
5ca363a439
This significantly improves our cloud and hybrid cloud docs: * Adds screenshots * Better structure * More information about payments, including stripe and azure marketplace * Better cluster creation docs * Account setup and invitation docs * Monitoring docs * Cluster upgrade docs * Support docs * Removed duplications
114 lines
6.9 KiB
Markdown
114 lines
6.9 KiB
Markdown
---
|
|
title: Hybrid Cloud setup
|
|
weight: 1
|
|
---
|
|
|
|
# Creating a Hybrid Cloud Environment
|
|
|
|
The following instruction set will show you how to properly set up a **Qdrant cluster** in your **Hybrid Cloud Environment**.
|
|
|
|
To learn how Hybrid Cloud works, [read the overview document](/documentation/hybrid-cloud/).
|
|
|
|
## Prerequisites
|
|
|
|
- **Kubernetes cluster:** To create a Hybrid Cloud Environment, you need a [standard compliant](https://www.cncf.io/training/certification/software-conformance/) Kubernetes cluster. You can run this cluster in any cloud, on-premise or edge environment, with distributions that range from AWS EKS to VMWare vSphere.
|
|
- **Storage:** For storage, you need to set up the Kubernetes cluster with a Container Storage Interface (CSI) driver that provides block storage. For vertical scaling, the CSI driver needs to support volume expansion. For backups and restores, the driver needs to support CSI snapshots and restores.
|
|
|
|
<aside role="status">Network storage systems like NFS or object storage systems such as S3 are not supported.</aside>
|
|
|
|
- **Permissions:** To install the Qdrant Kubernetes Operator you need to have `cluster-admin` access in your Kubernetes cluster.
|
|
- **Connection:** The Qdrant Kubernetes Operator in your cluster needs to be able to connect to Qdrant Cloud. It will create an outgoing connection to `cloud.qdrant.io` on port `443`.
|
|
- **Locations:** By default, the Qdrant Cloud Agent and Operator pulls Helm charts and container images from `registry.cloud.qdrant.io`. The Qdrant database container image is pulled from `docker.io`.
|
|
|
|
> **Note:** You can also mirror these images and charts into your own registry and pull them from there.
|
|
|
|
### CLI tools
|
|
|
|
During the onboarding, you will need to deploy the Qdrant Kubernetes Operator and Agent using Helm. Make sure you have the following tools installed:
|
|
|
|
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
* [helm](https://helm.sh/docs/intro/install/)
|
|
|
|
You will need to have access to the Kubernetes cluster with `kubectl` and `helm` configured to connect to it. Please refer the documentation of your Kubernetes distribution for more information.
|
|
|
|
### Required artifacts
|
|
|
|
Container images:
|
|
|
|
- `docker.io/qdrant/qdrant`
|
|
- `registry.cloud.qdrant.io/qdrant/qdrant-cloud-agent`
|
|
- `registry.cloud.qdrant.io/qdrant/qdrant-operator`
|
|
- `registry.cloud.qdrant.io/qdrant/cluster-manager`
|
|
- `registry.cloud.qdrant.io/qdrant/prometheus`
|
|
- `registry.cloud.qdrant.io/qdrant/prometheus-config-reloader`
|
|
- `registry.cloud.qdrant.io/qdrant/kube-state-metrics`
|
|
|
|
Open Containers Initiative (OCI) Helm charts:
|
|
|
|
- `registry.cloud.qdrant.io/qdrant-charts/qdrant-cloud-agent`
|
|
- `registry.cloud.qdrant.io/qdrant-charts/qdrant-operator`
|
|
- `registry.cloud.qdrant.io/qdrant-charts/qdrant-cluster-manager`
|
|
- `registry.cloud.qdrant.io/qdrant-charts/prometheus`
|
|
|
|
## Installation
|
|
|
|
1. To set up Hybrid Cloud, open the Qdrant Cloud Console at [cloud.qdrant.io](https://cloud.qdrant.io). On the dashboard, select **Hybrid Cloud**.
|
|
|
|
2. Before creating your first Hybrid Cloud Environment, you have to provide billing information and accept the Hybrid Cloud license agreement. The installation wizard will guide you through the process.
|
|
|
|
> **Note:** You will only be charged for the Qdrant cluster you create in a Hybrid Cloud Environment, but not for the environment itself.
|
|
|
|
3. Now you can specify the following:
|
|
|
|
- **Name:** A name for the Hybrid Cloud Environment
|
|
- **Kubernetes Namespace:** The Kubernetes namespace for the operator and agent. Once you select a namespace, you can't change it.
|
|
|
|
You can also configure the StorageClass and VolumeSnapshotClass to use for the Qdrant databases, if you want to deviate from the default settings of your cluster.
|
|
|
|
4. You can then enter the YAML configuration for your Kubernetes operator. Qdrant supports a specific list of configuration options, as described in the [Qdrant Operator configuration](/documentation/hybrid-cloud/operator-configuration/) section.
|
|
|
|
5. (Optional) If you have special requirements for any of the following, activate the **Show advanced configuration** option:
|
|
|
|
- If you require to use a proxy to connect from your infrastructure to the Qdrant Cloud API, you can specify the proxy URL, credentials and cetificates.
|
|
- Container registry URL for Qdrant Operator and Agent images. The default is <https://registry.cloud.qdrant.io/qdrant/>.
|
|
- Helm chart repository URL for the Qdrant Operator and Agent. The default is <oci://registry.cloud.qdrant.io/qdrant-charts>.
|
|
- Log level for the operator and agent
|
|
|
|
6. Once complete, click **Create**.
|
|
|
|
> **Note:** All settings but the Kubernetes namespace can be changed later.
|
|
|
|
### Generate Installation Command
|
|
|
|
After creating your Hybrid Cloud, select **Generate Installation Command** to generate a script that you can run in your Kubernetes cluster which will perform the initial installation of the Kubernetes operator and agent. It will:
|
|
|
|
- Create the Kubernetes namespace, if not present
|
|
- Set up the necessary secrets with credentials to access the Qdrant container registry and the Qdrant Cloud API.
|
|
- Sign in to the Helm registry at `registry.cloud.qdrant.io`
|
|
- Install the Qdrant cloud agent and Kubernetes operator chart
|
|
|
|
You need this command only for the initial installation. After that, you can update the agent and operator using the Qdrant Cloud Console.
|
|
|
|
> **Note:** If you generate the installation command a second time, it will re-generate the included secrets, and you will have to apply the command again to update them.
|
|
|
|
## Deleting a Hybrid Cloud Environment
|
|
|
|
To delete a Hybrid Cloud Environment, first delete all Qdrant database clusters in it. Then you can delete the environment itself.
|
|
|
|
To clean up your Kubernetes cluster, after deleting the Hybrid Cloud Environment, you can use the following command:
|
|
|
|
```shell
|
|
helm -n the-qdrant-namespace delete qdrant-cloud-agent
|
|
helm -n the-qdrant-namespace delete qdrant-prometheus
|
|
helm -n the-qdrant-namespace delete qdrant-operator
|
|
kubectl -n the-qdrant-namespace patch HelmRelease.cd.qdrant.io qdrant-cloud-agent -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmRelease.cd.qdrant.io qdrant-prometheus -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmRelease.cd.qdrant.io qdrant-operator -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmChart.cd.qdrant.io the-qdrant-namespace-qdrant-cloud-agent -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmChart.cd.qdrant.io the-qdrant-namespace-qdrant-prometheus -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmChart.cd.qdrant.io the-qdrant-namespace-qdrant-operator -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl -n the-qdrant-namespace patch HelmRepository.cd.qdrant.io qdrant-cloud -p '{"metadata":{"finalizers":null}}' --type=merge
|
|
kubectl delete namespace the-qdrant-namespace
|
|
kubectl get crd -o name | grep qdrant | xargs -n 1 kubectl delete
|
|
```
|