Commit adcc345
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
File tree
- docs
- configuration
- alertmanager-integration
- exporting
- holmesgpt
- sinks
- how-it-works
- playbook-reference
- setup-robusta
- gitops
- installation
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | | - | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
75 | 79 | | |
76 | 80 | | |
77 | 81 | | |
| |||
97 | 101 | | |
98 | 102 | | |
99 | 103 | | |
100 | | - | |
| 104 | + | |
| 105 | + | |
101 | 106 | | |
102 | 107 | | |
103 | 108 | | |
| |||
130 | 135 | | |
131 | 136 | | |
132 | 137 | | |
133 | | - | |
134 | | - | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
135 | 143 | | |
136 | 144 | | |
137 | 145 | | |
| |||
164 | 172 | | |
165 | 173 | | |
166 | 174 | | |
167 | | - | |
| 175 | + | |
168 | 176 | | |
169 | 177 | | |
170 | 178 | | |
171 | 179 | | |
172 | | - | |
| 180 | + | |
173 | 181 | | |
174 | 182 | | |
175 | 183 | | |
| |||
216 | 224 | | |
217 | 225 | | |
218 | 226 | | |
219 | | - | |
| 227 | + | |
220 | 228 | | |
221 | 229 | | |
222 | 230 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
59 | | - | |
| 59 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | 22 | | |
24 | | - | |
25 | 23 | | |
26 | 24 | | |
27 | 25 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
264 | | - | |
| 264 | + | |
265 | 265 | | |
266 | 266 | | |
267 | 267 | | |
| |||
This file was deleted.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
185 | 185 | | |
186 | 186 | | |
187 | 187 | | |
188 | | - | |
| 188 | + | |
189 | 189 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| |||
0 commit comments