mirror of
https://github.com/qdrant/landing_page.git
synced 2026-10-02 17:38:31 +02:00
Restructure Docs - Stage 4a (#2280)
* create Develop and Deploy tabs; move Operations; re-weight pages * move capacity planning page; create section dropdown content * added aliases to frontmatter * update link references to new canonical links; maintain anchoring * address remaining link issues and errors * fix outlier tutorial reference issue * Treat 'develop' and 'deploy' as a unified search space * fix some frontmatter aliases * add section header redirects * fix 'Operations' redirect to go to 'Deploy' tab * update redirects file for * pattern * add :splat to redirect references * Add wildcard to each entry in _redirects file --------- Co-authored-by: Abdon Pijpelink <abdon.pijpelink@qdrant.com>
This commit is contained in:
kanungle
co-authored by
Abdon Pijpelink
Abdon Pijpelink
parent
7b463c5ae5
commit
544708f293
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: Tutorials & Examples
|
||||
weight: 40
|
||||
partition: cloud
|
||||
hideInSidebar: true
|
||||
partition: deploy
|
||||
---
|
||||
## Cloud Tutorials & Examples
|
||||
|
||||
| Tutorial | Objective | Stack | Time | Level |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [Qdrant Cloud Prometheus Monitoring](/documentation/tutorials-and-examples/managed-cloud-prometheus/) | Observability with Prometheus and Grafana. | <span class="pill">Prometheus</span> | 30m | <span class="text-yellow">Intermediate</span> |
|
||||
| [Self-Hosted Prometheus Monitoring](/documentation/tutorials-and-examples/hybrid-cloud-prometheus/) | Observability for hybrid/private cloud setups. | <span class="pill">Prometheus</span> | 30m | <span class="text-yellow">Intermediate</span> |
|
||||
| [Qdrant Cloud Prometheus Monitoring](/documentation/ops-monitoring/managed-cloud-prometheus/) | Observability with Prometheus and Grafana. | <span class="pill">Prometheus</span> | 30m | <span class="text-yellow">Intermediate</span> |
|
||||
| [Self-Hosted Prometheus Monitoring](/documentation/ops-monitoring/hybrid-cloud-prometheus/) | Observability for hybrid/private cloud setups. | <span class="pill">Prometheus</span> | 30m | <span class="text-yellow">Intermediate</span> |
|
||||
|
||||
-110
@@ -1,110 +0,0 @@
|
||||
---
|
||||
title: Self-Hosted Prometheus Monitoring
|
||||
weight: 37
|
||||
---
|
||||
|
||||
# Monitoring Hybrid/Private Cloud with Prometheus and Grafana
|
||||
| Time: 30 min | Level: Intermediate |
|
||||
| --- | ----------- |
|
||||
|
||||
This tutorial will guide you through the process of setting up Prometheus and Grafana to monitor Qdrant databases running in a Kubernetes cluster used for Hybrid or Private Cloud.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
This tutorial assumes that you already have a Kubernetes cluster running and a Qdrant database deployed in it, using either a Hybrid Cloud or Private Cloud deployment. You should also have `kubectl` and `helm` configured to interact with your cluster.
|
||||
|
||||
## Step 1: Install Prometheus and Grafana
|
||||
|
||||
If you haven't installed Prometheus and Grafana yet, you can use the [kube-prometheus-stack](https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack) Helm chart to deploy them in your Kubernetes cluster.
|
||||
|
||||
A minimal example of installing the stack:
|
||||
|
||||
```bash
|
||||
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
|
||||
|
||||
helm install prometheus prometheus-community/kube-prometheus-stack --namespace monitoring --create-namespace
|
||||
```
|
||||
|
||||
This command will install Prometheus, Grafana, and all necessary components into a new `monitoring` namespace.
|
||||
|
||||
## Step 2: Configure Prometheus to Scrape Qdrant Metrics
|
||||
|
||||
To monitor Qdrant, you need to configure Prometheus to scrape metrics from the Qdrant database(s). You can do this by creating a `ServiceMonitor` resource in the host Kubernetes cluster.
|
||||
|
||||
```yaml
|
||||
apiVersion: monitoring.coreos.com/v1
|
||||
kind: ServiceMonitor
|
||||
metadata:
|
||||
name: qdrant-cluster-exporter
|
||||
namespace: qdrant
|
||||
labels:
|
||||
release: prometheus
|
||||
spec:
|
||||
endpoints:
|
||||
- honorLabels: true
|
||||
interval: 30s
|
||||
port: metrics
|
||||
scheme: http
|
||||
scrapeTimeout: 55s
|
||||
jobLabel: app.kubernetes.io/name
|
||||
namespaceSelector:
|
||||
matchNames:
|
||||
- qdrant
|
||||
selector:
|
||||
matchLabels:
|
||||
app.kubernetes.io/instance: qdrant-cluster-exporter
|
||||
app.kubernetes.io/name: qdrant-cluster-exporter
|
||||
---
|
||||
apiVersion: monitoring.coreos.com/v1
|
||||
kind: ServiceMonitor
|
||||
metadata:
|
||||
name: qdrant-operator
|
||||
namespace: qdrant
|
||||
labels:
|
||||
release: prometheus
|
||||
spec:
|
||||
endpoints:
|
||||
- honorLabels: true
|
||||
interval: 30s
|
||||
port: metrics
|
||||
scheme: http
|
||||
scrapeTimeout: 55s
|
||||
jobLabel: app.kubernetes.io/name
|
||||
namespaceSelector:
|
||||
matchNames:
|
||||
- qdrant
|
||||
selector:
|
||||
matchLabels:
|
||||
app.kubernetes.io/name: operator
|
||||
```
|
||||
|
||||
The example above assumes that your Qdrant database and the cloud platform exporter are deployed in the `qdrant` namespace. Adjust the `namespaceSelector` and `namespace` fields according to your deployment.
|
||||
|
||||
## Step 3: Access Grafana
|
||||
|
||||
Once Prometheus is configured to scrape metrics from Qdrant, you can access Grafana to visualize the metrics.
|
||||
|
||||
Get the Grafana 'admin' user password by running:
|
||||
|
||||
```bash
|
||||
kubectl --namespace monitoring get secrets prometheus-grafana -o jsonpath="{.data.admin-password}" | base64 -d ; echo
|
||||
```
|
||||
|
||||
Access the Grafana dashboard by port-forwarding:
|
||||
|
||||
```bash
|
||||
export POD_NAME=$(kubectl --namespace monitoring get pod -l "app.kubernetes.io/name=grafana,app.kubernetes.io/instance=prometheus" -oname)
|
||||
kubectl --namespace monitoring port-forward $POD_NAME 3000
|
||||
```
|
||||
|
||||
Now you can open your web browser and go to `http://localhost:3000`. Log in with the username `admin` and the password you retrieved earlier.
|
||||
|
||||
## Step 4: Import Qdrant Dashboard
|
||||
|
||||
Qdrant Cloud offers an example Grafana dashboard in the [Qdrant GitHub repository](https://github.com/qdrant/qdrant-cloud-grafana-dashboard). This comes with built-in views and graphs to help you get started monitoring your Qdrant clusters.
|
||||
|
||||
To import the dashboard:
|
||||
|
||||
1. In Grafana, go to "Dashboards" and click on "New" -> "Import".
|
||||
2. Copy and paste the dashboard JSON from the Qdrant GitHub repository.
|
||||
3. Click "Load" and then "Import".
|
||||
-94
@@ -1,94 +0,0 @@
|
||||
---
|
||||
title: Managed Cloud Prometheus Monitoring
|
||||
weight: 36
|
||||
---
|
||||
|
||||
# Monitoring Managed Cloud with Prometheus and Grafana
|
||||
|
||||
This tutorial will guide you through the process of setting up Prometheus and Grafana to monitor Qdrant databases running in Qdrant Managed Cloud.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
This tutorial assumes that you already have a Kubernetes cluster running where you want to deploy your monitoring stack, and a Qdrant database created in Qdrant Managed Cloud. You should also have `kubectl` and `helm` configured to interact with your cluster.
|
||||
|
||||
## Step 1: Install Prometheus and Grafana
|
||||
|
||||
If you haven't installed Prometheus and Grafana yet, you can use the [kube-prometheus-stack](https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack) Helm chart to deploy them in your Kubernetes cluster.
|
||||
|
||||
A minimal example of installing the stack:
|
||||
|
||||
```bash
|
||||
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
|
||||
|
||||
helm install prometheus prometheus-community/kube-prometheus-stack --namespace monitoring --create-namespace
|
||||
```
|
||||
|
||||
This command will install Prometheus, Grafana, and all necessary components into a new `monitoring` namespace.
|
||||
|
||||
## Step 2: Configure Prometheus to Scrape Qdrant Metrics
|
||||
|
||||
To monitor Qdrant, you need to configure Prometheus to scrape metrics from the Qdrant database. You can do this by creating a `ScrapeConfig` resource in your Kubernetes cluster. The API key to authenticate at your Qdrant database should be stored in a Kubernetes Secret. A read-only API key is sufficient for monitoring purposes.
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: qdrant-cluster-api-key
|
||||
namespace: monitoring
|
||||
labels:
|
||||
app: qdrant-cluster
|
||||
stringData:
|
||||
apiKey: "a-read-only-api-key"
|
||||
---
|
||||
apiVersion: monitoring.coreos.com/v1alpha1
|
||||
kind: ScrapeConfig
|
||||
metadata:
|
||||
name: qdrant-cluster
|
||||
namespace: monitoring
|
||||
labels:
|
||||
app: qdrant-cluster
|
||||
release: prometheus
|
||||
spec:
|
||||
metricsPath: /sys_metrics
|
||||
scrapeInterval: 30s
|
||||
scheme: HTTPS
|
||||
authorization:
|
||||
type: Bearer
|
||||
credentials:
|
||||
name: qdrant-cluster-api-key
|
||||
key: apiKey
|
||||
staticConfigs:
|
||||
- labels:
|
||||
job: prometheus
|
||||
targets:
|
||||
- your-cluster.europe-west3-0.gcp.cloud.qdrant.io:443
|
||||
```
|
||||
|
||||
## Step 3: Access Grafana
|
||||
|
||||
Once Prometheus is configured to scrape metrics from Qdrant, you can access Grafana to visualize the metrics.
|
||||
|
||||
Get the Grafana 'admin' user password by running:
|
||||
|
||||
```bash
|
||||
kubectl --namespace monitoring get secrets prometheus-grafana -o jsonpath="{.data.admin-password}" | base64 -d ; echo
|
||||
```
|
||||
|
||||
Access the Grafana dashboard by port-forwarding:
|
||||
|
||||
```bash
|
||||
export POD_NAME=$(kubectl --namespace monitoring get pod -l "app.kubernetes.io/name=grafana,app.kubernetes.io/instance=prometheus" -oname)
|
||||
kubectl --namespace monitoring port-forward $POD_NAME 3000
|
||||
```
|
||||
|
||||
Now you can open your web browser and go to `http://localhost:3000`. Log in with the username `admin` and the password you retrieved earlier.
|
||||
|
||||
## Step 4: Import Qdrant Dashboard
|
||||
|
||||
Qdrant Cloud offers an example Grafana dashboard in the [Qdrant GitHub repository](https://github.com/qdrant/qdrant-cloud-grafana-dashboard). This comes with built-in views and graphs to help you get started monitoring your Qdrant clusters.
|
||||
|
||||
To import the dashboard:
|
||||
|
||||
1. In Grafana, go to "Dashboards" and click on "New" -> "Import".
|
||||
2. Copy and paste the dashboard JSON from the Qdrant GitHub repository.
|
||||
3. Click "Load" and then "Import".
|
||||
Reference in New Issue
Block a user