Skip to content

Commit adcc345

Browse files
aantnclaude
andauthored
Consolidate installation documentation and remove dev setup (#2059)
* docs: hide outdated CLI install paths, reframe as Robusta Classic The robusta CLI install flow (robusta gen-config / pipx / docker) is outdated. Drop those paths from the install docs in favor of the SaaS signup wizard, and reframe non-Holmes/non-SaaS content as Robusta Classic so the primary docs focus on the AI agent + Robusta Platform (with HolmesGPT OSS docs living separately at holmesgpt.dev). - Rename "Other Features" toctree caption to "Robusta Classic" - Consolidate install pages into a single Install Robusta page (drop the all-in-one Prometheus and Build-from-Source variants; Holmes users always have an existing observability stack) - Strip robusta gen-config / robusta-cli references from the Slack sink, multi-cluster, and help/troubleshooting pages - Update conf.py redirects for removed pages https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: link manual Slack setup to Creating Custom Slack Apps section Addresses CodeRabbit review comment on PR #2059 — gives readers a direct pointer to the step-by-step manual setup section instead of leaving them to figure it out. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: refocus multi-cluster warning on clusterName The previous warning argued against generating a fresh generated_values.yaml per cluster — framing leftover from the CLI era. Replace it with the actionable instruction: set a unique clusterName on each cluster. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: scope Classic-only sections, retitle large-cluster page - Manual Upgrade / kube-prometheus-stack CRDs: scope to old Robusta Classic installs with enablePrometheusStack=true; new installs don't need the CRD dance - Replace two robusta logs CLI references in upgrade.rst with kubectl logs - Rename "Monitoring Large Clusters" to "Deploying on Large Clusters" - Move Self-Monitoring page from Installation menu to Robusta Classic - Mark OpenShift debug-permissions section as Classic-only (the python/java/node_disk_analyzer playbooks aren't part of HolmesGPT) https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: tighten welcome page intro Drop the "open source AI agent that pulls evidence and uses LLMs" framing — generic and not differentiating now that AI agents are common. Lead with "SRE agent" instead. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop K8s-only framing and "open source AI agent" boilerplate Same edits applied to the welcome page now applied to architecture and oss-vs-saas: remove the "Kubernetes alerts" qualifier (Robusta investigates more than just K8s alerts) and trim the generic "open source AI agent that uses LLMs" framing now that AI agents are common knowledge. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: mention MCP servers in welcome page data sources bullet https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: reframe oss-vs-saas page as Deployment Options - Rename page title and sidebar links from "Open Source vs SaaS" to "Deployment Options" - Lead with SaaS and Self-Hosted (the paths most users will pick) instead of opening with the Open Source / HolmesGPT pitch - Move OSS HolmesGPT to a brief mention near the end pointing standalone users to holmesgpt.dev - Reorder welcome-page sentence so "SaaS" comes before "open source" Filename oss-vs-saas.rst kept to preserve URLs and existing redirects. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop Classic-era feature bullets from SaaS section These bullets (centralized alert management, multi-cluster visibility, Slack/Teams bot, no infra) lean on Robusta Classic framing. Keep this detail under Classic-specific pages, not the main Deployment Options overview. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: add OSS-vs-Platform comparison, drop Learn More section Reframe the Open Source section to clarify what HolmesGPT OSS is (CLI/HTTP API only) and what the Robusta Platform adds (web UI, Slack/Teams bots, automatic alert triage and grouping). Drop the trailing Learn More section — its links already appear elsewhere on the page. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: restructure OSS section as bullets, drop redundant link Make the OSS-vs-Platform comparison more scannable by giving each side its own bullet list (CLI/HTTP API on one side, web UI / bots / triage on the other). Remove the duplicate holmesgpt.dev link — the GitHub link earlier in the paragraph is enough. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: note SOC 2 compliance and SaaS regions https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: shorten web interface bullet, add background agents bullet https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: tighten the Kubernetes change-tracking bullet in architecture https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop Classic-era sinks bullet from Security & Networking The "data stays in cluster unless sent to sinks" bullet relates to Robusta Classic's notification routing, not the Holmes architecture. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: remove the OSS-vs-SaaS apologia from the install page We're not orienting docs around OSS anymore — the SaaS signup flow is the canonical install path, no need to defend it. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: defer install steps to the platform wizard Strip Helm commands, per-cluster install tabs, verification steps, and Next Steps from the install page. The platform signup wizard now produces tailored install commands for each cluster, so the docs page just points users there. Delete the unused _helm_install_no_prometheus.inc.rst include. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop slack_sink example from GitOps values The example generated_values.yaml in argocd.rst and flux.rst showed a slack_sink config alongside robusta_sink. Drop the slack_sink to keep the example focused on what's necessary for the GitOps install (robusta_sink + cluster knobs). https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop isSmallCluster line from GitOps example values https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop Configuring Argo Links section from ArgoCD page https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: remove Supported Clusters page Robusta runs on any Kubernetes distribution; the dedicated page added little beyond the list. Drop the file, remove it from the toctree, relax the install-page prerequisite to "A Kubernetes cluster", and add a redirect for the old URL. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: relocate Censoring section, trim FAQ - Move "Censoring Sensitive Data" from privacy-and-security.rst to playbook-reference/builtin-alert-enrichment.rst — censoring relies on Classic playbook actions (logs_enricher, report_crash_loop) and fits under the Robusta Classic / Playbooks menu - Drop FAQ entries: - "Can I install Robusta without the cli?" — CLI is no longer the canonical install path - "Does Robusta support Thanos/Cortex/Mimir/VictoriaMetrics?" — answer was a single sentence pointing back to docs - Stale "robusta cli --namespace" warning under the namespace FAQ https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop monitorHelmReleases bullet — default is now false The bullet told users to set monitorHelmReleases: false to reduce permissions. Since the default has changed to false, the guidance is no longer needed. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: move Using Existing Secrets to Managing Secrets, drop SRE Agent menu The Using Existing Secrets section (HolmesGPT reading the Robusta UI token from a Kubernetes secret) belongs alongside the rest of the secrets handling guidance. Move it to configuration-secrets.rst and preserve the inbound anchor reference. Drop the SRE Agent toctree caption from the welcome page — the entire docs site is about the SRE agent now, no need to carve out a separate menu for it. The underlying pages (main-features, getting-started, holmesgpt-docs) remain accessible via existing inbound links. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: delete SRE Agent stub pages, redirect to holmesgpt.dev The SRE Agent menu was already dropped from the welcome page nav. Now delete the three underlying pages — main-features (a stub), getting-started (Quick Setup is now wizard-driven), and the holmesgpt-docs redirect-stub — and point inbound references at holmesgpt.dev or platform.robusta.dev. - Update conf.py redirects: main-features.html, getting-started.html, holmesgpt-docs.html, plus the existing ai-analysis.html and holmesgpt/index.html — all now go to holmesgpt.dev - Update inbound refs in metric-providers-external.rst, builtin-alert-enrichment.rst, and playbook-reference/index.rst to external links instead of internal :doc: references https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: redirect deleted SRE Agent pages to robusta.dev Update the redirects added in the prior commit to point at robusta.dev (the marketing site) rather than holmesgpt.dev. Same for the alert-enrichment "Looking for automatic AI enrichment" inline link. (Pre-existing toolset redirects to holmesgpt.dev are left alone since they target real toolset pages on that site.) https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: move Classic-era APIs to Robusta Classic menu Move Managed Prometheus Alerts (alertsui), Namespace Resources API, and Prometheus Query API from the HTTP APIs menu to the Robusta Classic menu — they're Classic-era functionality that fits better under that section. Drop the moved entries from the HTTP APIs Overview page bullet list. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: drop "when does Robusta need internet" preamble from proxies page https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: flatten proxy config — single block covering runner + holmes Combine the separate "Configuring Proxy Settings for Robusta" and "... for HolmesGPT" sections into one. Show a single Helm-values example that sets HTTP_PROXY/HTTPS_PROXY on both deployments at once, and keep the env_froms note as a brief follow-up for many-at-once overrides. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: replace air-gapped section with contact-us pointer The previous bullets implied air-gapped support was just a configuration toggle. Replace with a direct pointer to contact support for self-hosted options that actually work in air-gapped or offline environments. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: remove Classic-era Data Privacy / SaaS UI section The Data Privacy section described what the Robusta Classic OSS sends to sinks (Slack, MS Teams, etc.) and the SaaS UI's role relative to that pipeline. Both are Classic-era framing. https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f * docs: remove Additional Settings page The page held a single "Global Config" section describing clusterName/account_id/signing_key — values the platform wizard generates. Drop the page from the toctree, redirect old URLs to the install page, and rewire two stale "Alert Label Mapping" inbound refs to the page that actually documents that (customize-labels-priorities.rst). https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent e78dedb commit adcc345

37 files changed

Lines changed: 195 additions & 921 deletions

docs/conf.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,11 @@
7171
"developer-guide/actions/findings-api.html": "/master/playbook-reference/actions/develop-actions/findings-api.html",
7272
"tutorials/my-first-custom-action.html": "/master/playbook-reference/actions/develop-actions/index.html",
7373
"user-guide/self-hosting.html": "/master/how-it-works/oss-vs-saas.html",
74-
"getting-started/installation.html": "/master/setup-robusta/installation/all-in-one-installation.html",
74+
"getting-started/installation.html": "/master/setup-robusta/installation/index.html",
75+
"setup-robusta/installation/all-in-one-installation.html": "/master/setup-robusta/installation/index.html",
76+
"setup-robusta/installation/standalone-installation.html": "/master/setup-robusta/installation/index.html",
77+
"setup-robusta/installation/dev-setup.html": "/master/help.html",
78+
"setup-robusta/supported-clusters.html": "/master/setup-robusta/installation/index.html",
7579
"tutorials/java-troubleshooting.html": "/master/tutorials/application-troubleshooting-java.html",
7680
"catalog/sinks/index.html": "/master/configuration/sinks/index.html",
7781
"tutorials/prometheus-enrichment.html": "/master/tutorials/alert-custom-enrichment.html",
@@ -97,7 +101,8 @@
97101
"configuration/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
98102
"configuration/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
99103
"playbook-reference/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
100-
"configuration/additional-settings.html": "/master/setup-robusta/additional-settings.html",
104+
"configuration/additional-settings.html": "/master/setup-robusta/installation/index.html",
105+
"setup-robusta/additional-settings.html": "/master/setup-robusta/installation/index.html",
101106
"developer-guide/writing-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
102107
"user-guide/slack.html": "/master/configuration/sinks/slack.html",
103108
"user-guide/elasticsearch.html": "/master/playbook-reference/triggers/elasticsearch.html",
@@ -130,8 +135,11 @@
130135
"tutorials/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/alert-custom-prometheus.html",
131136
"catalog/triggers/prometheus.html": "/master/configuration/alertmanager-integration/index.html",
132137
"playbook-reference/prometheus-examples/alert-remediation.html": "/master/playbook-reference/automatic-remediation-examples/index.html",
133-
"configuration/ai-analysis.html": "/master/configuration/holmesgpt/main-features.html",
134-
"configuration/holmesgpt/index.html": "/master/configuration/holmesgpt/main-features.html",
138+
"configuration/ai-analysis.html": "https://robusta.dev/",
139+
"configuration/holmesgpt/index.html": "https://robusta.dev/",
140+
"configuration/holmesgpt/main-features.html": "https://robusta.dev/",
141+
"configuration/holmesgpt/getting-started.html": "https://robusta.dev/",
142+
"configuration/holmesgpt/holmesgpt-docs.html": "https://robusta.dev/",
135143
# AI Analysis pages redirects to holmesgpt.dev (docs have moved there)
136144
"configuration/holmesgpt/builtin_toolsets.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart",
137145
"configuration/holmesgpt/permissions.html": "https://holmesgpt.dev/data-sources/permissions/?tab=robusta-helm-chart",
@@ -164,12 +172,12 @@
164172
"tutorials/more-tutorials.html": "/master/help.html",
165173
"common-errors.html": "/master/help.html#common-errors",
166174
"user-guide/defining-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
167-
"user-guide/global-config.html": "/master/setup-robusta/additional-settings.html#global-config",
175+
"user-guide/global-config.html": "/master/setup-robusta/installation/index.html",
168176
"user-guide/configuration-secrets.html": "master/setup-robusta/configuration-secrets.html",
169177
"user-guide/additional-playbooks.html": "/master/playbook-reference/defining-playbooks/external-playbook-repositories.html",
170178
"user-guide/embedded-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#enabling-the-embedded-prometheus",
171179
"user-guide/node-selector.html": "/master/setup-robusta/node-selector.html",
172-
"user-guide/interactivity.html": "/master/setup-robusta/additional-settings.html#two-way-interactivity",
180+
"user-guide/interactivity.html": "/master/setup-robusta/installation/index.html",
173181
"user-guide/flow-control.html": "/master/playbook-reference/index.html#using-filters-to-restrict-triggers",
174182
"catalog/triggers/index.html": "/master/playbook-reference/triggers/index.html",
175183
"catalog/triggers/kubernetes.html": "/master/playbook-reference/triggers/kubernetes.html",
@@ -216,7 +224,7 @@
216224
"playbook-reference/overview.html": "/master/playbook-reference/index.html",
217225
"playbook-reference/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
218226
"how-it-works/alert-builtin-enrichment.html": "/master/playbook-reference/builtin-alert-enrichment.html",
219-
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/standalone-installation.html",
227+
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/index.html",
220228
"playbook-reference/defining-playbooks/index.html": "/master/playbook-reference/index.html",
221229
"configuration/alertmanager-integration/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#creating-custom-prometheus-alerts",
222230
"configuration/alertmanager-integration/index.html": "/master/configuration/index.html",

docs/configuration/alertmanager-integration/_testing_integration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ If everything is setup properly, this alert will reach Robusta. It will show up
5656

5757
Robusta enriches alerts with Kubernetes and log data using Prometheus labels for mapping.
5858
Standard label names are used by default. If your setup differs, you can
59-
`customize this mapping </setup-robusta/additional-settings.html#alert-label-mapping>`_ to fit your environment.
59+
`customize this mapping </configuration/alertmanager-integration/customize-labels-priorities.html>`_ to fit your environment.

docs/configuration/exporting/robusta-pro-features.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ Data Export and Reporting
1919
* :doc:`Alert Reporting API <alert-statistics-api>`: Get aggregated statistics and counts for different alert types
2020
* :doc:`Send Alerts API <send-alerts-api>`: Send alerts programmatically from external systems
2121
* :doc:`Configuration Changes API <configuration-changes-api>`: Track configuration changes in your environment
22-
* :doc:`Namespace Resources API <namespace-resources-api>`: Query namespace-level resource information
2322
* :doc:`RBAC Configuration API <rbac-api>`: Programmatically manage role-based access control configurations
24-
* :doc:`Prometheus Query API <prometheus-query-api>`: Run PromQL queries against Prometheus in your connected clusters
2523

2624
Getting Started
2725
---------------

docs/configuration/exporting/send-alerts-api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Troubleshooting
261261

262262
**Alerts arriving but missing Kubernetes context?**
263263

264-
Check :doc:`Alert Label Mapping </setup-robusta/additional-settings>` to customize how Prometheus labels map to Kubernetes resources.
264+
Check :doc:`Customize Labels and Priorities </configuration/alertmanager-integration/customize-labels-priorities>` to customize how Prometheus labels map to Kubernetes resources.
265265

266266
Testing Your Integration
267267
------------------------

docs/configuration/holmesgpt/getting-started.rst

Lines changed: 0 additions & 70 deletions
This file was deleted.

docs/configuration/holmesgpt/holmesgpt-docs.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/configuration/holmesgpt/main-features.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/configuration/metric-providers-external.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,5 +185,5 @@ Next Steps
185185
----------
186186

187187
- Configure :doc:`alert routing </notification-routing/index>`
188-
- Set up :doc:`AI-powered insights </configuration/holmesgpt/getting-started>`
188+
- `Set up AI-powered insights <https://platform.robusta.dev/signup>`_
189189
- Learn about :doc:`common configuration options <metric-providers>`

docs/configuration/sinks/sinks-development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Each sink consists of a sink class and a config class. Optionally, helpers are u
2727

2828
To implement a new sink you must:
2929

30-
1. :ref:`Build Robusta from source <Build from Source>`
30+
1. Clone the `Robusta repo <https://github.com/robusta-dev/robusta>`_ and follow the README to build from source
3131
2. Add a new Python module inside `src/robusta/core/sinks <https://github.com/robusta-dev/robusta/tree/master/src/robusta/core/sinks>`_ containing your sink’s source code
3232
3. Implement a sink config class
3333
4. Implement a sink class

docs/configuration/sinks/slack.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Quick Start
2020

2121
**Option 1: Automatic Setup (Recommended)**
2222

23-
When installing Robusta, run ``robusta gen-config`` and follow the prompts. This automatically configures Slack using our `official
23+
Sign up for a `free Robusta account <https://platform.robusta.dev/signup>`_ and connect Slack during the signup wizard. This automatically configures Slack using our `official
2424
Slack app <https://slack.com/apps/A0214S5PHB4-robusta?tab=more_info>`_.
2525

2626
Note: Robusta can only write messages and doesn't require read permissions.
2727

2828
**Option 2: Manual Configuration**
2929

30-
Generate a Slack API key by running ``robusta integrations slack``, then add to your ``generated_values.yaml``:
30+
Generate a Slack API key on your own (see :ref:`Creating Custom Slack Apps` below), then add it to your ``generated_values.yaml``:
3131

3232
.. code-block:: yaml
3333

0 commit comments

Comments
 (0)