From bc0c835e6beeea10f5d11cd65ae62d521f40170c Mon Sep 17 00:00:00 2001 From: davidmyriel Date: Sun, 14 Apr 2024 20:44:58 -0700 Subject: [PATCH] fix documentation --- .../examples/rag-chatbot-scaleway.md | 7 ++++++ .../examples/rag-chatbot-vultr-dspy-ollama.md | 9 +++---- ...contract-management-stackit-aleph-alpha.md | 2 -- .../recommendation-system-ovhcloud.md | 7 ++++++ .../platform-deployment-options.md | 24 +++++++++---------- 5 files changed, 31 insertions(+), 18 deletions(-) diff --git a/qdrant-landing/content/documentation/examples/rag-chatbot-scaleway.md b/qdrant-landing/content/documentation/examples/rag-chatbot-scaleway.md index 4a73b6cee..82ef3b1f5 100644 --- a/qdrant-landing/content/documentation/examples/rag-chatbot-scaleway.md +++ b/qdrant-landing/content/documentation/examples/rag-chatbot-scaleway.md @@ -24,6 +24,13 @@ A notebook for this tutorial is available on [GitHub](https://github.com/qdrant/ - **LLM:** GPT-3.5, developed by OpenAI is utilized as the generator for producing answers. - **Framework:** [LangChain](https://www.langchain.com/) for extensive RAG capabilities. +## Deploying Qdrant Hybrid Cloud on Scaleway + +[Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/) and [Kosmos](https://www.scaleway.com/en/kubernetes-kosmos/) are managed Kubernetes services from [Scaleway](https://www.scaleway.com/en/). They abstract away the complexities of managing and operating a Kubernetes cluster. The primary difference being, Kapsule clusters are composed solely of Scaleway Instances. Whereas, a Kosmos cluster is a managed multi-cloud Kubernetes engine that allows you to connect instances from any cloud provider to a single managed Control-Plane. + +1. To start using managed Kubernetes on Scaleway, follow the [platform-specific documentation](/documentation/hybrid-cloud/platform-deployment-options/#scaleway). +2. Once your Kubernetes clusters are up, [you can begin deploying Qdrant Hybrid Cloud](/documentation/hybrid-cloud). + ## Prerequisites To prepare the environment for working with Qdrant and related libraries, it's necessary to install all required Python packages. This can be done using Poetry, a tool for dependency management and packaging in Python. The code snippet imports various libraries essential for the tasks ahead, including `bs4` for parsing HTML and XML documents, `langchain` and its community extensions for working with language models and document loaders, and `Qdrant` for vector storage and retrieval. These imports lay the groundwork for utilizing Qdrant alongside other tools for natural language processing and machine learning tasks. diff --git a/qdrant-landing/content/documentation/examples/rag-chatbot-vultr-dspy-ollama.md b/qdrant-landing/content/documentation/examples/rag-chatbot-vultr-dspy-ollama.md index 71995c816..47f7474f2 100644 --- a/qdrant-landing/content/documentation/examples/rag-chatbot-vultr-dspy-ollama.md +++ b/qdrant-landing/content/documentation/examples/rag-chatbot-vultr-dspy-ollama.md @@ -28,12 +28,13 @@ If you work in a regulated industry, or just need to keep your data private, thi ![Architecture diagram](/documentation/tutorials/information-extraction-ollama-vultr/architecture-diagram.png) -## Configuring the environment +## CDeploying Qdrant Hybrid Cloud on Vultr All the services we are going to use in this tutorial will be running on [Vultr Kubernetes -Engine](https://www.vultr.com/kubernetes/). That gives us a lot of flexibility in terms of scaling and managing the -resources. Before we go further, make sure you have a Vultr account and a Kubernetes cluster running. Please follow the -[official documentation](https://docs.vultr.com/vultr-kubernetes-engine) to get everything up and running. +Engine](https://www.vultr.com/kubernetes/). That gives us a lot of flexibility in terms of scaling and managing the resources. Vultr manages the control plane and worker nodes and provides integration with other managed services such as Load Balancers, Block Storage, and DNS. + +1. To start using managed Kubernetes on Vultr, follow the [platform-specific documentation](/documentation/hybrid-cloud/platform-deployment-options/#vultr). +2. Once your Kubernetes clusters are up, [you can begin deploying Qdrant Hybrid Cloud](/documentation/hybrid-cloud). ### Installing the necessary packages diff --git a/qdrant-landing/content/documentation/examples/rag-contract-management-stackit-aleph-alpha.md b/qdrant-landing/content/documentation/examples/rag-contract-management-stackit-aleph-alpha.md index 5dfc2e33b..eb07809af 100644 --- a/qdrant-landing/content/documentation/examples/rag-contract-management-stackit-aleph-alpha.md +++ b/qdrant-landing/content/documentation/examples/rag-contract-management-stackit-aleph-alpha.md @@ -15,8 +15,6 @@ Contract management benefits greatly from Retrieval Augmented Generation (RAG), Companies want their data to be kept and processed within specific geographical boundaries. For that reason, this RAG-centric tutorial focuses on dealing with a region-specific cloud provider. You will set up a contract management system using [Aleph Alpha's](https://aleph-alpha.com/) embeddings and LLM. You will host everything on [STACKIT](https://www.stackit.de/), a German business cloud provider. On this platform, you will run Qdrant Hybrid Cloud as well as the rest of your RAG application. This setup will ensure that your data is stored and processed in Germany. -[//]: # (TODO: add link to Qdrant Hybrid Cloud above) - ![Architecture diagram](/documentation/tutorials/contract-management-stackit-aleph-alpha/architecture-diagram.png) ## Components diff --git a/qdrant-landing/content/documentation/examples/recommendation-system-ovhcloud.md b/qdrant-landing/content/documentation/examples/recommendation-system-ovhcloud.md index 9f98c5f30..ae220436f 100644 --- a/qdrant-landing/content/documentation/examples/recommendation-system-ovhcloud.md +++ b/qdrant-landing/content/documentation/examples/recommendation-system-ovhcloud.md @@ -25,6 +25,13 @@ In this tutorial, you will build a mechanism that recommends movies based on def **Methodology:** We're adopting a collaborative filtering approach to construct a recommendation system from the dataset provided. Collaborative filtering works on the premise that if two users share similar tastes, they're likely to enjoy similar movies. Leveraging this concept, we'll identify users whose ratings align closely with ours, and explore the movies they liked but we haven't seen yet. To do this, we'll represent each user's ratings as a vector in a high-dimensional, sparse space. Using Qdrant, we'll index these vectors and search for users whose ratings vectors closely match ours. Ultimately, we will see which movies were enjoyed by users similar to us. +## Deploying Qdrant Hybrid Cloud on OVHcloud + +[Service Managed Kubernetes](https://www.ovhcloud.com/en-in/public-cloud/kubernetes/), powered by OVH Public Cloud Instances, a leading European cloud provider. With OVHcloud Load Balancers and disks built in. OVHcloud Managed Kubernetes provides high availability, compliance, and CNCF conformance, allowing you to focus on your containerized software layers with total reversibility. + +1. To start using managed Kubernetes on OVHcloud, follow the [platform-specific documentation](/documentation/hybrid-cloud/platform-deployment-options/#ovhcloud). +2. Once your Kubernetes clusters are up, [you can begin deploying Qdrant Hybrid Cloud](/documentation/hybrid-cloud). + ## Prerequisites Download and unzip the MovieLens dataset: diff --git a/qdrant-landing/content/documentation/hybrid-cloud/platform-deployment-options.md b/qdrant-landing/content/documentation/hybrid-cloud/platform-deployment-options.md index 26d528aca..9750c1e54 100644 --- a/qdrant-landing/content/documentation/hybrid-cloud/platform-deployment-options.md +++ b/qdrant-landing/content/documentation/hybrid-cloud/platform-deployment-options.md @@ -11,7 +11,7 @@ weight: 4 [The Linode Kubernetes Engine (LKE)](https://www.linode.com/products/kubernetes/) is a managed container orchestration engine built on top of Kubernetes. LKE enables you to quickly deploy and manage your containerized applications without needing to build (and maintain) your own Kubernetes cluster. All LKE instances are equipped with a fully managed control plane at no additional cost. -**To setup Qdrant Hybrid Cloud on LKE**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on LKE**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Linode Kubernetes Engine @@ -25,7 +25,7 @@ weight: 4 [Amazon Elastic Kubernetes Service (Amazon EKS)](https://aws.amazon.com/eks/) is a managed service to run Kubernetes in the AWS cloud and on-premises data centers which can then be paired with Qdrant's hybrid cloud. With Amazon EKS, you can take advantage of all the performance, scale, reliability, and availability of AWS infrastructure, as well as integrations with AWS networking and security services. -**To setup Qdrant Hybrid Cloud on AWS**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on AWS**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Amazon Elastic Kubernetes Service @@ -39,7 +39,7 @@ weight: 4 [DigitalOcean Kubernetes (DOKS)](https://www.digitalocean.com/products/kubernetes) is a managed Kubernetes service that lets you deploy Kubernetes clusters without the complexities of handling the control plane and containerized infrastructure. Clusters are compatible with standard Kubernetes toolchains and integrate natively with DigitalOcean Load Balancers and volumes. -**To setup Qdrant Hybrid Cloud on DigitalOcean**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on DigitalOcean**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on DigitalOcean Kubernetes @@ -53,7 +53,7 @@ weight: 4 [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine) is a managed Kubernetes service that you can use to deploy and operate containerized applications at scale using Google's infrastructure. GKE provides the operational power of Kubernetes while managing many of the underlying components, such as the control plane and nodes, for you. -**To setup Qdrant Hybrid Cloud on GCP**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on GCP**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on the Google Kubernetes Engine @@ -67,7 +67,7 @@ weight: 4 With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products/kubernetes-service), you can start developing and deploying cloud-native apps in Azure, datacenters, or at the edge. Get unified management and governance for on-premises, edge, and multicloud Kubernetes clusters. Interoperate with Azure security, identity, cost management, and migration services. -**To setup Qdrant Hybrid Cloud on Azure**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on Azure**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Azure Kubernetes Service @@ -81,7 +81,7 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products [Oracle Cloud Infrastructure Container Engine for Kubernetes (OKE)](https://www.oracle.com/in/cloud/cloud-native/container-engine-kubernetes/) is a managed Kubernetes solution that enables you to deploy Kubernetes clusters while ensuring stable operations for both the control plane and the worker nodes through automatic scaling, upgrades, and security patching. Additionally, OKE offers a completely serverless Kubernetes experience with virtual nodes. -**To setup Qdrant Hybrid Cloud on OCI**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on OCI**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on OCI Container Engine @@ -95,7 +95,7 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products [Service Managed Kubernetes](https://www.ovhcloud.com/en-in/public-cloud/kubernetes/), powered by OVH Public Cloud Instances, a leading European cloud provider. With OVHcloud Load Balancers and disks built in. OVHcloud Managed Kubernetes provides high availability, compliance, and CNCF conformance, allowing you to focus on your containerized software layers with total reversibility. -**To setup Qdrant Hybrid Cloud on OVHcloud**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on OVHcloud**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Service Managed Kubernetes by OVHcloud @@ -109,7 +109,7 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products [Red Hat OpenShift Kubernetes Engine](https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine) provides you with the basic functionality of Red Hat OpenShift. It offers a subset of the features that Red Hat OpenShift Container Platform offers, like full access to an enterprise-ready Kubernetes environment and an extensive compatibility test matrix with many of the software elements that you might use in your datacenter. -**To setup Qdrant Hybrid Cloud on Red Hat OpenShift**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on Red Hat OpenShift**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on OpenShift Kubernetes Engine @@ -121,9 +121,9 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products ## Scaleway -[Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/) and [Kosmos](https://www.scaleway.com/en/kubernetes-kosmos/) are managed Kubernetes services from [Scaleway](https://www.scaleway.com/en/). It abstracts away the complexities of managing and operating a Kubernetes cluster. The primary difference being, Kapsule clusters are composed solely of Scaleway Instances. Whereas, a Kosmos cluster is a managed multi-cloud Kubernetes engine that allows you to connect instances from any cloud provider to a single managed Control-Plane. +[Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/) and [Kosmos](https://www.scaleway.com/en/kubernetes-kosmos/) are managed Kubernetes services from [Scaleway](https://www.scaleway.com/en/). They abstract away the complexities of managing and operating a Kubernetes cluster. The primary difference being, Kapsule clusters are composed solely of Scaleway Instances. Whereas, a Kosmos cluster is a managed multi-cloud Kubernetes engine that allows you to connect instances from any cloud provider to a single managed Control-Plane. -**To setup Qdrant Hybrid Cloud on Scaleway**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on Scaleway**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Scaleway Kubernetes @@ -137,7 +137,7 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products [STACKIT Kubernetes Engine (SKE)](https://www.stackit.de/en/product/kubernetes/) is a robust, scalable, and managed Kubernetes service. SKE supplies a CNCF-compliant Kubernetes cluster, and makes it easy to provide standard Kubernetes applications and containerized workloads. User-defined Kubernetes clusters can be created as self-service without complications using the STACKIT Portal. -**To setup Qdrant Hybrid Cloud on STACKIT**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on STACKIT**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on STACKIT Kubernetes Engine @@ -151,7 +151,7 @@ With [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-in/products [Vultr Kubernetes Engine (VKE)](https://www.vultr.com/kubernetes/) is a fully-managed product offering with predictable pricing that makes Kubernetes easy to use. Vultr manages the control plane and worker nodes and provides integration with other managed services such as Load Balancers, Block Storage, and DNS. -**To setup Qdrant Hybrid Cloud on Vultr**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). Then, consult your platform's managed Kubernetes instructions below. +First, consult your platform's managed Kubernetes instructions below. Then, **to setup Qdrant Hybrid Cloud on Vultr**, follow our [step-by step documentation](/documentation/hybrid-cloud/hybrid-cloud-setup/). ### More on Vulr Kubernetes Engine