Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
48aa608
docs: hide outdated CLI install paths, reframe as Robusta Classic
claude Apr 30, 2026
e50fc00
docs: link manual Slack setup to Creating Custom Slack Apps section
claude Apr 30, 2026
113e92c
docs: refocus multi-cluster warning on clusterName
claude Apr 30, 2026
c6ab7aa
docs: scope Classic-only sections, retitle large-cluster page
claude Apr 30, 2026
7999d03
Merge branch 'master' into claude/hide-outdated-cli-docs-OpoQa
aantn May 1, 2026
c573434
docs: tighten welcome page intro
claude May 1, 2026
c5443ff
docs: drop K8s-only framing and "open source AI agent" boilerplate
claude May 3, 2026
d87a258
docs: mention MCP servers in welcome page data sources bullet
claude May 3, 2026
b90c609
docs: reframe oss-vs-saas page as Deployment Options
claude May 3, 2026
5f3a88b
docs: drop Classic-era feature bullets from SaaS section
claude May 3, 2026
7a0ef33
docs: add OSS-vs-Platform comparison, drop Learn More section
claude May 3, 2026
4be856a
docs: restructure OSS section as bullets, drop redundant link
claude May 3, 2026
e92f958
docs: note SOC 2 compliance and SaaS regions
claude May 4, 2026
f700a64
docs: shorten web interface bullet, add background agents bullet
claude May 4, 2026
6d7d473
docs: tighten the Kubernetes change-tracking bullet in architecture
claude May 4, 2026
473f601
docs: drop Classic-era sinks bullet from Security & Networking
claude May 4, 2026
89dc32f
docs: remove the OSS-vs-SaaS apologia from the install page
claude May 4, 2026
f22ec75
docs: defer install steps to the platform wizard
claude May 4, 2026
3d5d966
docs: drop slack_sink example from GitOps values
claude May 4, 2026
0df08e4
docs: drop isSmallCluster line from GitOps example values
claude May 4, 2026
56265de
docs: drop Configuring Argo Links section from ArgoCD page
claude May 4, 2026
fb5fdfe
docs: remove Supported Clusters page
claude May 4, 2026
2fd7b1e
docs: relocate Censoring section, trim FAQ
claude May 4, 2026
34c833a
docs: drop monitorHelmReleases bullet — default is now false
claude May 4, 2026
815be9e
docs: move Using Existing Secrets to Managing Secrets, drop SRE Agent…
claude May 4, 2026
1cc87ad
docs: delete SRE Agent stub pages, redirect to holmesgpt.dev
claude May 4, 2026
920e947
docs: redirect deleted SRE Agent pages to robusta.dev
claude May 4, 2026
0d36d37
docs: move Classic-era APIs to Robusta Classic menu
claude May 4, 2026
4b77a86
docs: drop "when does Robusta need internet" preamble from proxies page
claude May 4, 2026
c4341a3
docs: flatten proxy config — single block covering runner + holmes
claude May 4, 2026
d1a8d90
docs: replace air-gapped section with contact-us pointer
claude May 4, 2026
149e0cd
docs: remove Classic-era Data Privacy / SaaS UI section
claude May 4, 2026
26d2760
docs: remove Additional Settings page
claude May 4, 2026
cffa63f
Merge branch 'master' into claude/hide-outdated-cli-docs-OpoQa
aantn May 4, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,11 @@
"developer-guide/actions/findings-api.html": "/master/playbook-reference/actions/develop-actions/findings-api.html",
"tutorials/my-first-custom-action.html": "/master/playbook-reference/actions/develop-actions/index.html",
"user-guide/self-hosting.html": "/master/how-it-works/oss-vs-saas.html",
"getting-started/installation.html": "/master/setup-robusta/installation/all-in-one-installation.html",
"getting-started/installation.html": "/master/setup-robusta/installation/index.html",
"setup-robusta/installation/all-in-one-installation.html": "/master/setup-robusta/installation/index.html",
"setup-robusta/installation/standalone-installation.html": "/master/setup-robusta/installation/index.html",
"setup-robusta/installation/dev-setup.html": "/master/help.html",
"setup-robusta/supported-clusters.html": "/master/setup-robusta/installation/index.html",
"tutorials/java-troubleshooting.html": "/master/tutorials/application-troubleshooting-java.html",
"catalog/sinks/index.html": "/master/configuration/sinks/index.html",
"tutorials/prometheus-enrichment.html": "/master/tutorials/alert-custom-enrichment.html",
Expand All @@ -97,7 +101,8 @@
"configuration/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
"configuration/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
"playbook-reference/defining-playbooks/trigger-action-binding.html": "/master/playbook-reference/index.html#matching-actions-to-triggers",
"configuration/additional-settings.html": "/master/setup-robusta/additional-settings.html",
"configuration/additional-settings.html": "/master/setup-robusta/installation/index.html",
"setup-robusta/additional-settings.html": "/master/setup-robusta/installation/index.html",
"developer-guide/writing-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
"user-guide/slack.html": "/master/configuration/sinks/slack.html",
"user-guide/elasticsearch.html": "/master/playbook-reference/triggers/elasticsearch.html",
Expand Down Expand Up @@ -130,8 +135,11 @@
"tutorials/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/alert-custom-prometheus.html",
"catalog/triggers/prometheus.html": "/master/configuration/alertmanager-integration/index.html",
"playbook-reference/prometheus-examples/alert-remediation.html": "/master/playbook-reference/automatic-remediation-examples/index.html",
"configuration/ai-analysis.html": "/master/configuration/holmesgpt/main-features.html",
"configuration/holmesgpt/index.html": "/master/configuration/holmesgpt/main-features.html",
"configuration/ai-analysis.html": "https://robusta.dev/",
"configuration/holmesgpt/index.html": "https://robusta.dev/",
"configuration/holmesgpt/main-features.html": "https://robusta.dev/",
"configuration/holmesgpt/getting-started.html": "https://robusta.dev/",
"configuration/holmesgpt/holmesgpt-docs.html": "https://robusta.dev/",
# AI Analysis pages redirects to holmesgpt.dev (docs have moved there)
"configuration/holmesgpt/builtin_toolsets.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/?tab=robusta-helm-chart",
"configuration/holmesgpt/permissions.html": "https://holmesgpt.dev/data-sources/permissions/?tab=robusta-helm-chart",
Expand Down Expand Up @@ -164,12 +172,12 @@
"tutorials/more-tutorials.html": "/master/help.html",
"common-errors.html": "/master/help.html#common-errors",
"user-guide/defining-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
"user-guide/global-config.html": "/master/setup-robusta/additional-settings.html#global-config",
"user-guide/global-config.html": "/master/setup-robusta/installation/index.html",
"user-guide/configuration-secrets.html": "master/setup-robusta/configuration-secrets.html",
"user-guide/additional-playbooks.html": "/master/playbook-reference/defining-playbooks/external-playbook-repositories.html",
"user-guide/embedded-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#enabling-the-embedded-prometheus",
"user-guide/node-selector.html": "/master/setup-robusta/node-selector.html",
"user-guide/interactivity.html": "/master/setup-robusta/additional-settings.html#two-way-interactivity",
"user-guide/interactivity.html": "/master/setup-robusta/installation/index.html",
"user-guide/flow-control.html": "/master/playbook-reference/index.html#using-filters-to-restrict-triggers",
"catalog/triggers/index.html": "/master/playbook-reference/triggers/index.html",
"catalog/triggers/kubernetes.html": "/master/playbook-reference/triggers/kubernetes.html",
Expand Down Expand Up @@ -216,7 +224,7 @@
"playbook-reference/overview.html": "/master/playbook-reference/index.html",
"playbook-reference/defining-playbooks/playbook-basics.html": "/master/playbook-reference/index.html",
"how-it-works/alert-builtin-enrichment.html": "/master/playbook-reference/builtin-alert-enrichment.html",
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/standalone-installation.html",
"setup-robusta/installation/extend-prometheus-installation.html": "/master/setup-robusta/installation/index.html",
"playbook-reference/defining-playbooks/index.html": "/master/playbook-reference/index.html",
"configuration/alertmanager-integration/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#creating-custom-prometheus-alerts",
"configuration/alertmanager-integration/index.html": "/master/configuration/index.html",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ If everything is setup properly, this alert will reach Robusta. It will show up

Robusta enriches alerts with Kubernetes and log data using Prometheus labels for mapping.
Standard label names are used by default. If your setup differs, you can
`customize this mapping </setup-robusta/additional-settings.html#alert-label-mapping>`_ to fit your environment.
`customize this mapping </configuration/alertmanager-integration/customize-labels-priorities.html>`_ to fit your environment.
2 changes: 0 additions & 2 deletions docs/configuration/exporting/robusta-pro-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ Data Export and Reporting
* :doc:`Alert Reporting API <alert-statistics-api>`: Get aggregated statistics and counts for different alert types
* :doc:`Send Alerts API <send-alerts-api>`: Send alerts programmatically from external systems
* :doc:`Configuration Changes API <configuration-changes-api>`: Track configuration changes in your environment
* :doc:`Namespace Resources API <namespace-resources-api>`: Query namespace-level resource information
* :doc:`RBAC Configuration API <rbac-api>`: Programmatically manage role-based access control configurations
* :doc:`Prometheus Query API <prometheus-query-api>`: Run PromQL queries against Prometheus in your connected clusters

Getting Started
---------------
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/exporting/send-alerts-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Troubleshooting

**Alerts arriving but missing Kubernetes context?**

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

Testing Your Integration
------------------------
Expand Down
70 changes: 0 additions & 70 deletions docs/configuration/holmesgpt/getting-started.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/configuration/holmesgpt/holmesgpt-docs.rst

This file was deleted.

17 changes: 0 additions & 17 deletions docs/configuration/holmesgpt/main-features.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/configuration/metric-providers-external.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,5 +185,5 @@ Next Steps
----------

- Configure :doc:`alert routing </notification-routing/index>`
- Set up :doc:`AI-powered insights </configuration/holmesgpt/getting-started>`
- `Set up AI-powered insights <https://platform.robusta.dev/signup>`_
- Learn about :doc:`common configuration options <metric-providers>`
2 changes: 1 addition & 1 deletion docs/configuration/sinks/sinks-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Each sink consists of a sink class and a config class. Optionally, helpers are u

To implement a new sink you must:

1. :ref:`Build Robusta from source <Build from Source>`
1. Clone the `Robusta repo <https://github.com/robusta-dev/robusta>`_ and follow the README to build from source
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
3. Implement a sink config class
4. Implement a sink class
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/sinks/slack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Quick Start

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

When installing Robusta, run ``robusta gen-config`` and follow the prompts. This automatically configures Slack using our `official
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
Slack app <https://slack.com/apps/A0214S5PHB4-robusta?tab=more_info>`_.

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

**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 (see :ref:`Creating Custom Slack Apps` below), then add it to your ``generated_values.yaml``:

.. code-block:: yaml

Expand Down
54 changes: 6 additions & 48 deletions docs/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,54 +41,12 @@ Issues are organized by installation phase to help you quickly find solutions.

<div style="margin: 20px 0; padding: 15px; background-color: #f0f7ff; border-left: 4px solid #0066cc;">
<strong>Where are you stuck?</strong><br>
• <a href="#phase-1-configuration-generation">Phase 1: Configuration Generation</a> - Issues with robusta gen-config<br>
• <a href="#phase-2-helm-installation">Phase 2: Helm Installation</a> - Helm install/upgrade failures<br>
• <a href="#phase-3-runtime-issues">Phase 3: Runtime Issues</a> - Alerts not arriving, pods crashing<br>
• <a href="#phase-4-integration-issues">Phase 4: Integration Issues</a> - Slack, Prometheus connection problems
• <a href="#phase-1-helm-installation">Phase 1: Helm Installation</a> - Helm install/upgrade failures<br>
• <a href="#phase-2-runtime-issues">Phase 2: Runtime Issues</a> - Alerts not arriving, pods crashing<br>
• <a href="#phase-3-integration-issues">Phase 3: Integration Issues</a> - Slack, Prometheus connection problems
</div>

Phase 1: Configuration Generation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Issues when running ``robusta gen-config`` or generating initial configuration.

.. details:: command not found: robusta (CLI not in path)

1. Determine where the Robusta-cli binary file is located

.. code-block:: bash
:name: cb-find-python-cli-loc

find / -regex '.*/bin/robusta' 2>/dev/null

2. Add the path you found (e.g ``/opt/homebrew/bin/``) to your PATH. To do so, find your shell config file ( ~/.profile or ~/.bash_profile or ~/.zshrc etc...) and append the following:

.. code-block:: bash
:name: add-path-var

export PATH="$PATH:<new-path>"

3. Reopen the terminal or run:

.. code-block:: bash
:name: cb-refresh-terminal

source <your-shell-config-file>

.. admonition:: Alternative Solution

Instead of modifying PATH, run Robusta commands via the python3 binary: ``python3 -m robusta.cli.main gen-config``

.. details:: SSL certificate errors on Mac OS

This implies a python package with certificates is missing on your system.

To fix it, run ``/Applications/Python 3.9/Install Certificates.command``

For more info see:
https://stackoverflow.com/questions/52805115/certificate-verify-failed-unable-to-get-local-issuer-certificate

Phase 2: Helm Installation
Phase 1: Helm Installation
^^^^^^^^^^^^^^^^^^^^^^^^^^

Problems when running ``helm install`` command or installing via GitOps.
Expand Down Expand Up @@ -128,7 +86,7 @@ Problems when running ``helm install`` command or installing via GitOps.

Follow this guide for :ref:`upgrading CRDs from an older version <Manual Upgrade>`.

Phase 3: Runtime Issues
Phase 2: Runtime Issues
^^^^^^^^^^^^^^^^^^^^^^^

Issues after installation when pods are running but not working correctly.
Expand Down Expand Up @@ -252,7 +210,7 @@ Holmes

See :ref:`Using Existing Secrets <Reading the Robusta UI Token from a secret in HolmesGPT>` to configure Holmes to read the ``token``

Phase 4: Integration Issues
Phase 3: Integration Issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Problems with external service integrations after Robusta is running.
Expand Down
5 changes: 2 additions & 3 deletions docs/how-it-works/architecture.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Architecture
==================

Robusta uses `HolmesGPT <https://github.com/robusta-dev/holmesGPT>`_, an open source AI agent, to automatically investigate and root-cause Kubernetes alerts. HolmesGPT runs as part of the **in-cluster Agent**, connects to your existing **data sources**, and reports findings through the **Robusta Platform** (SaaS or self-hosted).
Robusta uses `HolmesGPT <https://github.com/robusta-dev/holmesGPT>`_ to automatically investigate and root-cause alerts. HolmesGPT runs as part of the **in-cluster Agent**, connects to your existing **data sources**, and reports findings through the **Robusta Platform** (SaaS or self-hosted).

.. image:: ../images/architecture-overview.png
:width: 800
Expand All @@ -15,7 +15,7 @@ Agent (In-Cluster)
The Robusta Agent runs inside your Kubernetes cluster. It includes HolmesGPT and is responsible for:

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

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.

Expand Down Expand Up @@ -44,7 +44,6 @@ Security & Networking
- The Agent runs entirely within your cluster with configurable RBAC permissions
- Data sources are accessed only by the in-cluster Agent, never by the Platform
- SaaS connectivity is outbound-only — no inbound access is required
- All data remains in your cluster unless explicitly sent to configured sinks or the Robusta Platform

Next Steps
^^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ Overview

How Robusta's components work together — the Agent, HolmesGPT, data sources, and the Platform.

.. grid-item-card:: :octicon:`package;1em;` Open Source vs SaaS
.. grid-item-card:: :octicon:`package;1em;` Deployment Options
:class-card: sd-bg-light sd-bg-text-light
:link: oss-vs-saas
:link-type: doc

Compare deployment options: open source HolmesGPT, SaaS, and self-hosted.
SaaS, self-hosted, or open source HolmesGPT.

.. toctree::
:maxdepth: 1
:hidden:

Architecture <architecture>
Open Source vs SaaS <oss-vs-saas>
Deployment Options <oss-vs-saas>
Loading
Loading