Skip to content

Commit 388770d

Browse files
committed
Simplify getting-started, link to holmesgpt.dev with robusta-helm-chart tab
- Change "GPT-4o" to "frontier models from Anthropic, OpenAI, and more" - Remove Test Your Setup section - Replace inline AI provider configs with link to holmesgpt.dev/ai-providers/ - Add ?tab=robusta-helm-chart to all holmesgpt.dev links (docs + conf.py redirects) - Remove redundant note about Helm chart configuration sections https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS
1 parent bd25af2 commit 388770d

7 files changed

Lines changed: 37 additions & 131 deletions

File tree

docs/conf.py

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -133,32 +133,32 @@
133133
"configuration/ai-analysis.html": "/master/configuration/holmesgpt/main-features.html",
134134
"configuration/holmesgpt/index.html": "/master/configuration/holmesgpt/main-features.html",
135135
# AI Analysis pages redirects to holmesgpt.dev (docs have moved there)
136-
"configuration/holmesgpt/builtin_toolsets.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/",
137-
"configuration/holmesgpt/permissions.html": "https://holmesgpt.dev/data-sources/permissions/",
138-
"configuration/holmesgpt/custom_toolsets.html": "https://holmesgpt.dev/data-sources/custom-toolsets/",
139-
"configuration/holmesgpt/remote_mcp_servers.html": "https://holmesgpt.dev/data-sources/remote-mcp-servers/",
136+
"configuration/holmesgpt/builtin_toolsets.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart",
137+
"configuration/holmesgpt/permissions.html": "https://holmesgpt.dev/data-sources/permissions/?tab=robusta-helm-chart",
138+
"configuration/holmesgpt/custom_toolsets.html": "https://holmesgpt.dev/data-sources/custom-toolsets/?tab=robusta-helm-chart",
139+
"configuration/holmesgpt/remote_mcp_servers.html": "https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart",
140140
# Individual toolset page redirects
141-
"configuration/holmesgpt/toolsets/argocd.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/argocd/",
142-
"configuration/holmesgpt/toolsets/aws.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/aws/",
143-
"configuration/holmesgpt/toolsets/confluence.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/confluence/",
144-
"configuration/holmesgpt/toolsets/coralogix_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/coralogix-logs/",
145-
"configuration/holmesgpt/toolsets/datadog_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datadog/",
146-
"configuration/holmesgpt/toolsets/datetime.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datetime/",
147-
"configuration/holmesgpt/toolsets/docker.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/docker/",
148-
"configuration/holmesgpt/toolsets/grafanaloki.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanaloki/",
149-
"configuration/holmesgpt/toolsets/grafanatempo.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanatempo/",
150-
"configuration/holmesgpt/toolsets/helm.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/helm/",
151-
"configuration/holmesgpt/toolsets/internet.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/internet/",
152-
"configuration/holmesgpt/toolsets/kafka.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kafka/",
153-
"configuration/holmesgpt/toolsets/kubernetes.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kubernetes/",
154-
"configuration/holmesgpt/toolsets/newrelic.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/newrelic/",
155-
"configuration/holmesgpt/toolsets/notion.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/notion/",
156-
"configuration/holmesgpt/toolsets/opensearch_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-logs/",
157-
"configuration/holmesgpt/toolsets/opensearch_status.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-status/",
158-
"configuration/holmesgpt/toolsets/prometheus.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/",
159-
"configuration/holmesgpt/toolsets/rabbitmq.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/rabbitmq/",
160-
"configuration/holmesgpt/toolsets/robusta.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/robusta/",
161-
"configuration/holmesgpt/toolsets/slab.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/slab/",
141+
"configuration/holmesgpt/toolsets/argocd.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/argocd/?tab=robusta-helm-chart",
142+
"configuration/holmesgpt/toolsets/aws.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/aws/?tab=robusta-helm-chart",
143+
"configuration/holmesgpt/toolsets/confluence.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/confluence/?tab=robusta-helm-chart",
144+
"configuration/holmesgpt/toolsets/coralogix_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/coralogix-logs/?tab=robusta-helm-chart",
145+
"configuration/holmesgpt/toolsets/datadog_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datadog/?tab=robusta-helm-chart",
146+
"configuration/holmesgpt/toolsets/datetime.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datetime/?tab=robusta-helm-chart",
147+
"configuration/holmesgpt/toolsets/docker.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/docker/?tab=robusta-helm-chart",
148+
"configuration/holmesgpt/toolsets/grafanaloki.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanaloki/?tab=robusta-helm-chart",
149+
"configuration/holmesgpt/toolsets/grafanatempo.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanatempo/?tab=robusta-helm-chart",
150+
"configuration/holmesgpt/toolsets/helm.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/helm/?tab=robusta-helm-chart",
151+
"configuration/holmesgpt/toolsets/internet.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/internet/?tab=robusta-helm-chart",
152+
"configuration/holmesgpt/toolsets/kafka.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kafka/?tab=robusta-helm-chart",
153+
"configuration/holmesgpt/toolsets/kubernetes.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kubernetes/?tab=robusta-helm-chart",
154+
"configuration/holmesgpt/toolsets/newrelic.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/newrelic/?tab=robusta-helm-chart",
155+
"configuration/holmesgpt/toolsets/notion.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/notion/?tab=robusta-helm-chart",
156+
"configuration/holmesgpt/toolsets/opensearch_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-logs/?tab=robusta-helm-chart",
157+
"configuration/holmesgpt/toolsets/opensearch_status.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-status/?tab=robusta-helm-chart",
158+
"configuration/holmesgpt/toolsets/prometheus.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/?tab=robusta-helm-chart",
159+
"configuration/holmesgpt/toolsets/rabbitmq.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/rabbitmq/?tab=robusta-helm-chart",
160+
"configuration/holmesgpt/toolsets/robusta.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/robusta/?tab=robusta-helm-chart",
161+
"configuration/holmesgpt/toolsets/slab.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/slab/?tab=robusta-helm-chart",
162162
"coverage.html": "/master/how-it-works/coverage.html",
163163
"tutorials/python-profiling.html": "/master/playbook-reference/actions/python-troubleshooting.html#python-profiler",
164164
"tutorials/more-tutorials.html": "/master/community-tutorials.html",

docs/configuration/holmesgpt/getting-started.rst

Lines changed: 5 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Prerequisites
1616
Quick Setup (Recommended)
1717
--------------------------
1818

19-
Use Robusta's hosted AI service with GPT-4o:
19+
Use Robusta's hosted AI service with frontier models from Anthropic, OpenAI, and more:
2020

2121
1. **Add to your Helm values:**
2222

@@ -42,104 +42,10 @@ Use Robusta's hosted AI service with GPT-4o:
4242

4343
That's it! HolmesGPT will now analyze your alerts automatically.
4444

45-
.. note::
46-
47-
When exploring HolmesGPT documentation, focus on **Robusta Helm chart configuration** sections rather than CLI installation. Robusta users should follow the Robusta Helm Chart based configuration examples for data sources and advanced settings.
48-
49-
Test Your Setup
50-
---------------
51-
52-
Deploy a crashing pod to see HolmesGPT in action:
53-
54-
.. code-block:: bash
55-
56-
kubectl apply -f https://raw.githubusercontent.com/robusta-dev/kubernetes-demos/main/crashpod/broken.yaml
57-
58-
Then check:
59-
- **Robusta UI**: Look for the ``CrashLoopBackOff`` alert and click the "Root Cause" tab
60-
- **Slack**: Click "Ask HolmesGPT" on the alert notification
61-
6245
Using Your Own AI Provider
6346
---------------------------
6447

65-
Instead of Robusta AI, you can use your own OpenAI, Azure, or AWS Bedrock account.
66-
67-
.. tab-set::
68-
69-
.. tab-item:: OpenAI
70-
71-
.. code-block:: bash
72-
73-
kubectl create secret generic holmes-secrets \
74-
--from-literal=openAiKey='YOUR_API_KEY'
75-
76-
.. code-block:: yaml
77-
78-
enableHolmesGPT: true
79-
holmes:
80-
additionalEnvVars:
81-
- name: MODEL
82-
value: gpt-4o
83-
- name: OPENAI_API_KEY
84-
valueFrom:
85-
secretKeyRef:
86-
name: holmes-secrets
87-
key: openAiKey
88-
89-
.. tab-item:: Azure AI
90-
91-
.. code-block:: bash
92-
93-
kubectl create secret generic holmes-secrets \
94-
--from-literal=azureOpenAiKey='YOUR_API_KEY'
95-
96-
.. code-block:: yaml
97-
98-
enableHolmesGPT: true
99-
holmes:
100-
additionalEnvVars:
101-
- name: MODEL
102-
value: azure/YOUR_DEPLOYMENT_NAME
103-
- name: AZURE_API_VERSION
104-
value: "2024-06-01"
105-
- name: AZURE_API_BASE
106-
value: https://your-org.openai.azure.com/
107-
- name: AZURE_API_KEY
108-
valueFrom:
109-
secretKeyRef:
110-
name: holmes-secrets
111-
key: azureOpenAiKey
112-
113-
**Important**: In Azure Portal, increase your deployment's token limit to at least 450K.
114-
115-
.. tab-item:: AWS Bedrock
116-
117-
.. code-block:: bash
118-
119-
kubectl create secret generic holmes-secrets \
120-
--from-literal=awsAccessKeyId='YOUR_KEY_ID' \
121-
--from-literal=awsSecretAccessKey='YOUR_SECRET_KEY'
122-
123-
.. code-block:: yaml
124-
125-
enableHolmesGPT: true
126-
holmes:
127-
enablePostProcessing: true
128-
additionalEnvVars:
129-
- name: MODEL
130-
value: bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0
131-
- name: AWS_REGION_NAME
132-
value: us-east-1
133-
- name: AWS_ACCESS_KEY_ID
134-
valueFrom:
135-
secretKeyRef:
136-
name: holmes-secrets
137-
key: awsAccessKeyId
138-
- name: AWS_SECRET_ACCESS_KEY
139-
valueFrom:
140-
secretKeyRef:
141-
name: holmes-secrets
142-
key: awsSecretAccessKey
48+
Instead of Robusta AI, you can bring your own LLM provider (OpenAI, Azure, AWS Bedrock, Anthropic, and more). See the `AI Providers documentation <https://holmesgpt.dev/ai-providers/?tab=robusta-helm-chart>`_ for setup instructions.
14349

14450
.. _Reading the Robusta UI Token from a secret in HolmesGPT:
14551

@@ -172,13 +78,13 @@ Common Issues
17278
- Consider using Robusta AI for unlimited investigations
17379

17480
**Analysis seems incomplete?**
175-
- Enable additional data sources in `HolmesGPT data sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ (follow Helm chart configuration examples)
81+
- Enable additional data sources in `HolmesGPT data sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_
17682
- Ensure Prometheus is configured for metrics analysis
17783
- Check that pod logs are accessible
17884

17985
Next Steps
18086
----------
18187

18288
* :doc:`main-features` - See what HolmesGPT can do
183-
* `Configure Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ - Add more context for better analysis (use Helm chart configuration)
184-
* `Helm Configuration Reference <https://holmesgpt.dev/reference/helm-configuration/>`_ - Advanced HolmesGPT Helm settings
89+
* `Configure Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_ - Add more context for better analysis
90+
* `Helm Configuration Reference <https://holmesgpt.dev/reference/helm-configuration/?tab=robusta-helm-chart>`_ - Advanced HolmesGPT Helm settings
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
HolmesGPT Documentation
22
========================
33

4-
For comprehensive HolmesGPT documentation, please visit the official HolmesGPT documentation site at `holmesgpt.dev <https://holmesgpt.dev>`_.
4+
For comprehensive HolmesGPT documentation, please visit the official HolmesGPT documentation site at `holmesgpt.dev <https://holmesgpt.dev/?tab=robusta-helm-chart>`_.
55

66
For Robusta-specific setup instructions, see :doc:`getting-started`.

docs/configuration/holmesgpt/main-features.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ Next Steps
1313

1414
* `Sign up for Robusta <https://platform.robusta.dev/signup>`_ - Get started with the full platform
1515
* :doc:`getting-started` - Set up HolmesGPT in 5 minutes
16-
* `Available Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ - See all supported integrations (use Robusta Helm Chart configuration method)
17-
* `Helm Configuration Reference <https://holmesgpt.dev/reference/helm-configuration/>`_ - Advanced HolmesGPT settings for Robusta deployments
16+
* `Available Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart>`_ - See all supported integrations
17+
* `Helm Configuration Reference <https://holmesgpt.dev/reference/helm-configuration/?tab=robusta-helm-chart>`_ - Advanced HolmesGPT settings for Robusta deployments

docs/configuration/metric-providers-grafana-cloud.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Make sure ``clusterName`` in Robusta Helm's values matches the ``cluster`` label
8080
HolmesGPT Configuration
8181
-----------------------
8282

83-
Give HolmesGPT - Robusta's AI Agent - read access to metrics. See the `Grafana Cloud (Mimir) Configuration <https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/?h=prometheus#grafana-cloud-mimir-configuration>`_ guide.
83+
Give HolmesGPT - Robusta's AI Agent - read access to metrics. See the `Grafana Cloud (Mimir) Configuration <https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/?tab=robusta-helm-chart#grafana-cloud-mimir-configuration>`_ guide.
8484

8585
Next Steps
8686
----------

docs/how-it-works/architecture.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Agent (In-Cluster)
1414

1515
The Robusta Agent runs inside your Kubernetes cluster. It includes HolmesGPT and is responsible for:
1616

17-
- Fetching data from external `data sources <https://holmesgpt.dev/data-sources/>`_
17+
- Fetching data from external `data sources <https://holmesgpt.dev/data-sources/?tab=robusta-helm-chart>`_
1818
- Optional: for customers troubleshooting issues on Kubernetes itself, track new deploys and changes to Kubernetes and query Kubernetes events
1919

2020
The Agent keeps your data secure — it fetches data from your data sources directly, so there is no direct connection from the Robusta Platform to your data sources.
@@ -34,7 +34,7 @@ The Platform receives investigation results from HolmesGPT and provides:
3434
Data Sources
3535
^^^^^^^^^^^^^
3636

37-
HolmesGPT integrates with a wide range of `data sources <https://holmesgpt.dev/data-sources/>`_ in your environment to gather evidence during investigations.
37+
HolmesGPT integrates with a wide range of `data sources <https://holmesgpt.dev/data-sources/?tab=robusta-helm-chart>`_ in your environment to gather evidence during investigations.
3838

3939
All data source connections are made by the Agent within your environment. The Robusta Platform never connects to your data sources directly.
4040

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
Welcome to Robusta
6767
====================
6868

69-
Robusta is an AI-powered SRE agent that automatically investigates alerts and finds root causes. It is built on `HolmesGPT <https://github.com/robusta-dev/holmesGPT>`_, an open source AI agent that pulls evidence from your existing `data sources <https://holmesgpt.dev/data-sources/>`_ and uses LLMs to pinpoint what went wrong.
69+
Robusta is an AI-powered SRE agent that automatically investigates alerts and finds root causes. It is built on `HolmesGPT <https://github.com/robusta-dev/holmesGPT>`_, an open source AI agent that pulls evidence from your existing `data sources <https://holmesgpt.dev/data-sources/?tab=robusta-helm-chart>`_ and uses LLMs to pinpoint what went wrong.
7070

7171
**How it works:**
7272

0 commit comments

Comments
 (0)