Consolidate installation documentation and remove dev setup#2059
Open
Consolidate installation documentation and remove dev setup#2059
Conversation
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
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughConsolidates and restructures installation docs into a single "Install Robusta" guide, removes several legacy installation and dev-setup pages and a Prometheus Helm include, updates config-generation flow to use Robusta signup, adjusts Slack and sink build instructions, updates Sphinx redirects, and reworks help/multi-cluster guidance. (49 words) Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 3/5 reviews remaining, refill in 22 minutes and 18 seconds. Comment |
|
✅ Docker image ready for
Use this tag to pull the image for testing. 📋 Copy commandsgcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:e10250c
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:e10250c me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:e10250c
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:e10250cPatch Helm values in one line: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:e10250c |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/configuration/sinks/slack.rst`:
- Line 30: Update the sentence that currently reads "Generate a Slack API key on
your own, then add it to your ``generated_values.yaml``" to include a direct
pointer to the concrete doc section for manual API-key creation (e.g., link or
reference to the "Creating Custom Slack Apps" section); ensure the text
explicitly directs readers to that section so they can follow step-by-step
instructions before adding the key to ``generated_values.yaml``.
In `@docs/setup-robusta/installation/index.rst`:
- Line 36: The page currently only includes the no-Prometheus install flow via
the include directive for "_helm_install_no_prometheus.inc.rst"; update this
consolidated install page to present both install paths by adding or
reintroducing an include for the Prometheus-enabled flow (for example
"_helm_install_with_prometheus.inc.rst") and/or a short selector/header that
links to both includes so readers can choose "Robusta-only" or "Robusta +
Prometheus" from the same entry point; ensure the include directive names
exactly match the existing partial filenames (e.g.,
"_helm_install_no_prometheus.inc.rst" and
"_helm_install_with_prometheus.inc.rst") and preserve surrounding headings/TOC
structure.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 997714d4-85dc-4124-b919-175a67398789
📒 Files selected for processing (12)
docs/conf.pydocs/configuration/sinks/sinks-development.rstdocs/configuration/sinks/slack.rstdocs/help.rstdocs/index.rstdocs/setup-robusta/installation/_generate_config.jinjadocs/setup-robusta/installation/_helm_install_with_prometheus.inc.rstdocs/setup-robusta/installation/all-in-one-installation.rstdocs/setup-robusta/installation/dev-setup.rstdocs/setup-robusta/installation/index.rstdocs/setup-robusta/installation/standalone-installation.rstdocs/setup-robusta/multi-cluster.rst
💤 Files with no reviewable changes (5)
- docs/setup-robusta/installation/all-in-one-installation.rst
- docs/setup-robusta/installation/_generate_config.jinja
- docs/setup-robusta/installation/standalone-installation.rst
- docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst
- docs/setup-robusta/installation/dev-setup.rst
| **Option 2: Manual Configuration** | ||
|
|
||
| Generate a Slack API key by running ``robusta integrations slack``, then add to your ``generated_values.yaml``: | ||
| Generate a Slack API key on your own, then add it to your ``generated_values.yaml``: |
There was a problem hiding this comment.
Add a direct pointer for manual API-key generation
Line 30 tells users to generate a key “on your own,” but doesn’t link to the concrete path. Add a direct pointer (e.g., to the “Creating Custom Slack Apps” section) so manual setup stays actionable.
Proposed docs tweak
-Generate a Slack API key on your own, then add it to your ``generated_values.yaml``:
+Generate a Slack API key on your own (see `Creating Custom Slack Apps` below), then add it to your ``generated_values.yaml``:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Generate a Slack API key on your own, then add it to your ``generated_values.yaml``: | |
| Generate a Slack API key on your own (see `Creating Custom Slack Apps` below), then add it to your ``generated_values.yaml``: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/configuration/sinks/slack.rst` at line 30, Update the sentence that
currently reads "Generate a Slack API key on your own, then add it to your
``generated_values.yaml``" to include a direct pointer to the concrete doc
section for manual API-key creation (e.g., link or reference to the "Creating
Custom Slack Apps" section); ensure the text explicitly directs readers to that
section so they can follow step-by-step instructions before adding the key to
``generated_values.yaml``.
| :class-card: sd-bg-text-light | ||
| :link: standalone-installation | ||
| :link-type: doc | ||
| .. include:: ./_helm_install_no_prometheus.inc.rst |
There was a problem hiding this comment.
Consolidated install page currently exposes only one install path
Line 36 includes only the “no Prometheus” flow. Based on the stated consolidation goal, this page should still expose both Robusta-only and Robusta+Prometheus paths from the same entry point.
Suggested direction
.. include:: ./_helm_install_no_prometheus.inc.rst
+
+Install Robusta + Prometheus (optional)
+--------------------------------------
+
+.. note::
+ Add the embedded Prometheus/all-in-one installation flow here (or a direct section link),
+ so both installation paths remain available from this consolidated page.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| .. include:: ./_helm_install_no_prometheus.inc.rst | |
| .. include:: ./_helm_install_no_prometheus.inc.rst | |
| Install Robusta + Prometheus (optional) | |
| -------------------------------------- | |
| .. note:: | |
| Add the embedded Prometheus/all-in-one installation flow here (or a direct section link), | |
| so both installation paths remain available from this consolidated page. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/setup-robusta/installation/index.rst` at line 36, The page currently
only includes the no-Prometheus install flow via the include directive for
"_helm_install_no_prometheus.inc.rst"; update this consolidated install page to
present both install paths by adding or reintroducing an include for the
Prometheus-enabled flow (for example "_helm_install_with_prometheus.inc.rst")
and/or a short selector/header that links to both includes so readers can choose
"Robusta-only" or "Robusta + Prometheus" from the same entry point; ensure the
include directive names exactly match the existing partial filenames (e.g.,
"_helm_install_no_prometheus.inc.rst" and
"_helm_install_with_prometheus.inc.rst") and preserve surrounding headings/TOC
structure.
Collaborator
Author
There was a problem hiding this comment.
Skipping this one. The Robusta+Prometheus all-in-one install path was intentionally removed in this PR — Holmes users always have an existing observability stack, so the all-in-one path isn't relevant going forward. The single-path install page is the goal, not a regression.
Generated by Claude Code
There was a problem hiding this comment.
@aantn, understood — thanks for the context! The single-path install page makes sense given that Holmes users already have an observability stack in place. I'll note this for future reviews.
✏️ Learnings added
Learnt from: aantn
Repo: robusta-dev/robusta PR: 2059
File: docs/setup-robusta/installation/index.rst:36-36
Timestamp: 2026-04-30T06:29:56.212Z
Learning: In the Robusta project (robusta-dev/robusta), the Robusta+Prometheus all-in-one installation path was intentionally removed from the documentation in favor of a single Robusta-only install path. Holmes users are assumed to always have an existing observability stack (DataDog, NewRelic, Prometheus, etc.), so the all-in-one/embedded Prometheus setup is no longer relevant. Do not flag the absence of the all-in-one install path in `docs/setup-robusta/installation/index.rst` as a regression.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
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
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
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR consolidates the Robusta installation documentation into a single, streamlined guide and removes the separate developer setup documentation. The changes simplify the installation experience by merging standalone and all-in-one installation paths into one unified guide.
Key Changes
standalone-installation.rstandall-in-one-installation.rstinto a singleindex.rstthat covers both Robusta-only and Robusta+Prometheus installationsdev-setup.rstwhich contained instructions for building from source, using mirrord, skaffold, and running tests_generate_config.jinjaand_helm_install_with_prometheus.inc.rstas their content is now integrated into the main installation guiderobusta gen-configgenerated_values.yamlacross clusters rather than running separate config generationconf.pyredirects and updated references in Slack and sink development documentationImplementation Details
https://claude.ai/code/session_019GQrc8wVq14if8f7F3pp4f