Merge pull request #132 from k8sgpt-ai/feat/grafana

feat: added quick grafana doc
k8sgpt-ai · Dec 16, 2024 · be97d2f · be97d2f
2 parents 81b93d3 + d2e6f78
commit be97d2f
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/imgs/grafana.png b/docs/imgs/grafana.png
diff --git a/docs/tutorials/observability.md b/docs/tutorials/observability.md
@@ -0,0 +1,25 @@
+# Integrating Observability with K8sGPT
+
+Enhance your Kubernetes observability by integrating Prometheus and Grafana with K8sGPT. Follow these steps to set up and visualize your cluster's insights:
+## Prerequisites
+- Prometheus: Install using Helm via Prometheus Community Helm Charts.
+- Grafana Dashboard: Ensure Grafana is installed and accessible in your environment.
+
+# Installation Steps
+
+Install the K8sGPT Operator with observability features enabled:
+```
+helm install release k8sgpt/k8sgpt-operator -n k8sgpt-operator-system --create-namespace --set interplex.enabled=true --set grafanaDashboard.enabled=true --set serviceMonitor.enabled=true
+```
+This command:
+- Creates a ServiceMonitor to integrate with Prometheus.
+- Automatically configures and populates data into your Grafana dashboard.
+
+Once set up, you can explore key metrics like:
+- Results identified by K8sGPT.
+- Operator workload details, providing insight into resource usage and efficiency.
+
+
+_See example of a K8sGPT Grafana dashboard_
+
+![Generate a token on the OpenAI website](../imgs/grafana.png)