diff --git a/README.md b/README.md index 6a412cdcc..3f5dbd374 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@
-

Robusta - Better Prometheus Notifications for Kubernetes

-

Better grouping, enrichment, and remediation of your existing alerts

-

- How it Works | - Installation | - Integrations ↗ | - Docs ↗ | - Slack Community ↗ -

+

Robusta Classic - Prometheus Alert Enrichment for Kubernetes

+> **Note:** This repository contains **Robusta Classic** — the rule-based alert enrichment engine. For AI-powered root cause analysis, see [HolmesGPT](https://github.com/robusta-dev/holmesgpt). Both can be installed together as part of the [Robusta platform](https://platform.robusta.dev/signup). + ## What Can Robusta Do? +

+ How it Works | + Installation | + Integrations ↗ | + Docs ↗ | + Slack Community ↗ +

+ Compatible with kube-prometheus-stack, Prometheus Operator, and more. Robusta integrates with Prometheus by webhook and adds features like: diff --git a/docs/community-tutorials.rst b/docs/community-tutorials.rst deleted file mode 100644 index bcee19b6f..000000000 --- a/docs/community-tutorials.rst +++ /dev/null @@ -1,14 +0,0 @@ -Community Tutorials -################################################### - -Here are more tutorials from the Robusta community: - -.. raw:: html - -
- -* **Video:** `Twitter challenge - Robusta.dev on 10 nodes `_ by `Nuno Captain Corsair `_ -* `Getting Started with Robusta on Digital Ocean `_ by `Rutam Prita Mishra `_ -* `Getting Started with Robusta on Civo Cloud `_ by `Rutam Prita Mishra `_ -* `Kubernetes troubleshooting and automation using Robusta `_ by `Philippe Bogaerts `_ -* `Enhancing Kubernetes Monitoring Automation with Robusta `_ by `Naren P `_ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index ea71868d6..4853c12b1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -109,7 +109,7 @@ "tutorials/routing-silencing.html": "/master/notification-routing/routing-silencing.html", "configuration/configuring-sinks.html": "/master/notification-routing/configuring-sinks.html", "how-it-works/privacy-and-security.html": "/master/setup-robusta/privacy-and-security.html", - "how-it-works/index.html": "/master/playbook-reference/what-are-playbooks.html", + # "how-it-works/index.html": "/master/playbook-reference/what-are-playbooks.html", # removed: now a real page "playbook-reference/examples.html": "/master/playbook-reference/builtin-alert-enrichment.html", "playbook-reference/prometheus-examples/index.html": "/master/playbook-reference/builtin-alert-enrichment.html", "tutorials/playbook-track-changes.html": "/master/playbook-reference/kubernetes-examples/kubernetes-change-notifications.html", @@ -133,35 +133,35 @@ "configuration/ai-analysis.html": "/master/configuration/holmesgpt/main-features.html", "configuration/holmesgpt/index.html": "/master/configuration/holmesgpt/main-features.html", # AI Analysis pages redirects to holmesgpt.dev (docs have moved there) - "configuration/holmesgpt/builtin_toolsets.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/", - "configuration/holmesgpt/permissions.html": "https://holmesgpt.dev/data-sources/permissions/", - "configuration/holmesgpt/custom_toolsets.html": "https://holmesgpt.dev/data-sources/custom-toolsets/", - "configuration/holmesgpt/remote_mcp_servers.html": "https://holmesgpt.dev/data-sources/remote-mcp-servers/", + "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", + "configuration/holmesgpt/custom_toolsets.html": "https://holmesgpt.dev/data-sources/custom-toolsets/?tab=robusta-helm-chart", + "configuration/holmesgpt/remote_mcp_servers.html": "https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart", # Individual toolset page redirects - "configuration/holmesgpt/toolsets/argocd.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/argocd/", - "configuration/holmesgpt/toolsets/aws.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/aws/", - "configuration/holmesgpt/toolsets/confluence.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/confluence/", - "configuration/holmesgpt/toolsets/coralogix_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/coralogix-logs/", - "configuration/holmesgpt/toolsets/datadog_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datadog/", - "configuration/holmesgpt/toolsets/datetime.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datetime/", - "configuration/holmesgpt/toolsets/docker.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/docker/", - "configuration/holmesgpt/toolsets/grafanaloki.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanaloki/", - "configuration/holmesgpt/toolsets/grafanatempo.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanatempo/", - "configuration/holmesgpt/toolsets/helm.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/helm/", - "configuration/holmesgpt/toolsets/internet.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/internet/", - "configuration/holmesgpt/toolsets/kafka.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kafka/", - "configuration/holmesgpt/toolsets/kubernetes.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kubernetes/", - "configuration/holmesgpt/toolsets/newrelic.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/newrelic/", - "configuration/holmesgpt/toolsets/notion.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/notion/", - "configuration/holmesgpt/toolsets/opensearch_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-logs/", - "configuration/holmesgpt/toolsets/opensearch_status.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-status/", - "configuration/holmesgpt/toolsets/prometheus.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/", - "configuration/holmesgpt/toolsets/rabbitmq.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/rabbitmq/", - "configuration/holmesgpt/toolsets/robusta.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/robusta/", - "configuration/holmesgpt/toolsets/slab.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/slab/", + "configuration/holmesgpt/toolsets/argocd.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/argocd/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/aws.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/aws/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/confluence.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/confluence/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/coralogix_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/coralogix-logs/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/datadog_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datadog/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/datetime.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/datetime/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/docker.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/docker/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/grafanaloki.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanaloki/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/grafanatempo.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/grafanatempo/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/helm.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/helm/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/internet.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/internet/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/kafka.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kafka/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/kubernetes.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/kubernetes/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/newrelic.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/newrelic/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/notion.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/notion/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/opensearch_logs.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-logs/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/opensearch_status.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/opensearch-status/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/prometheus.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/prometheus/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/rabbitmq.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/rabbitmq/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/robusta.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/robusta/?tab=robusta-helm-chart", + "configuration/holmesgpt/toolsets/slab.html": "https://holmesgpt.dev/data-sources/builtin-toolsets/slab/?tab=robusta-helm-chart", "coverage.html": "/master/how-it-works/coverage.html", "tutorials/python-profiling.html": "/master/playbook-reference/actions/python-troubleshooting.html#python-profiler", - "tutorials/more-tutorials.html": "/master/community-tutorials.html", + "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", @@ -201,10 +201,10 @@ "developer-guide/actions/triggers-and-events.html": "/master/playbook-reference/actions/develop-actions/triggers-and-events.html", "developer-guide/actions/utility-functions.html": "/master/playbook-reference/actions/develop-actions/utility-functions.html", "developer-guide/actions/documenting-actions.html": "/master/playbook-reference/actions/develop-actions/documenting-actions.html", - "developer-guide/platform/index.html": "/master/contributing.html", - "developer-guide/platform/dev-setup.html": "/master/contributing.html", - "developer-guide/platform/coding-conventions.html": "/master/contributing.html", - "developer-guide/platform/docs-contributions.html": "/master/docs-contributions.html#improving-these-docs", + "developer-guide/platform/index.html": "/master/help.html", + "developer-guide/platform/dev-setup.html": "/master/help.html", + "developer-guide/platform/coding-conventions.html": "/master/help.html", + "developer-guide/platform/docs-contributions.html": "/master/help.html", "developer-guide/platform/sinks-guide.html": "/master/configuration/sinks/sinks-development.html", "user-guide/robusta-cli.html": "/master/setup-robusta/installation/index.html", "advanced/index.html": "/master/setup-robusta/installation/index.html", @@ -293,8 +293,8 @@ "icon": { "repo": "fontawesome/brands/github", }, - "repo_url": "https://github.com/robusta-dev/robusta", - "repo_name": "Robusta", + "repo_url": "https://github.com/robusta-dev/holmesGPT", + "repo_name": "HolmesGPT", "repo_type": "github", "edit_uri": "tree/master/docs", "palette": [ @@ -330,7 +330,7 @@ "social": [ { "icon": "fontawesome/brands/github", - "link": "https://github.com/robusta-dev/robusta", + "link": "https://github.com/robusta-dev/holmesGPT", }, { "icon": "fontawesome/brands/slack", diff --git a/docs/configuration/alertmanager-integration/google-managed-alertmanager.rst b/docs/configuration/alertmanager-integration/google-managed-alertmanager.rst index 00da424b5..ffd9204af 100644 --- a/docs/configuration/alertmanager-integration/google-managed-alertmanager.rst +++ b/docs/configuration/alertmanager-integration/google-managed-alertmanager.rst @@ -48,7 +48,7 @@ Apply the following Secret in the GMP namespace (default ``gmp-public``). Replac repeat_interval: 4h Ensure alerts include ``cluster_name`` -************************************* +************************************** Use an ``OperatorConfig`` to add external labels to both collection and rule evaluation so every alert contains the required ``cluster_name`` label. diff --git a/docs/configuration/exporting/robusta-pro-features.rst b/docs/configuration/exporting/robusta-pro-features.rst index e8ca75c89..5998c66e1 100644 --- a/docs/configuration/exporting/robusta-pro-features.rst +++ b/docs/configuration/exporting/robusta-pro-features.rst @@ -1,78 +1,32 @@ -Overview -======== +HTTP APIs +========= .. note:: - These features are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version. + These APIs are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version. -Robusta Pro adds a web UI, additional integrations, and enterprise APIs to the open-source engine. Available as SaaS (we handle hosting) or self-hosted on-premise. +The Robusta Platform exposes REST APIs for programmatic access to alerts, investigations, and platform data. -AI Analysis ------------ - -Automatically investigate and resolve issues with AI-powered analysis. - -:doc:`AI Analysis (HolmesGPT) <../holmesgpt/main-features>` - Automatically analyze Kubernetes alerts, logs, and metrics. Get potential root causes and remediation suggestions. +Holmes Chat API +--------------- :doc:`Holmes Chat API <../holmesgpt/holmes-chat-api>` - Programmatically send questions to Holmes AI for root cause analysis via REST API. - -Custom Alert Ingestion ------------------------ - -Send alerts to Robusta from any monitoring system using HTTP webhooks. - -:doc:`Custom Webhooks ` - Send alerts from any system that supports HTTP webhooks, including custom monitoring solutions. - -:doc:`New Relic Integration <../alertmanager-integration/newrelic>` - Forward alerts from New Relic to Robusta via webhooks. - -:doc:`LaunchDarkly Integration <../alertmanager-integration/launchdarkly>` - Forward feature flag changes from LaunchDarkly to Robusta via webhooks. - -:doc:`SolarWinds Integration <../alertmanager-integration/solarwinds>` - Configure SolarWinds to send alert webhooks directly to Robusta. + Send questions to HolmesGPT for on-demand root cause analysis via REST. -:doc:`Nagios Integration <../alertmanager-integration/nagios>` - Forward alerts from Nagios to Robusta for enrichment and automation. - -Data Export and Reporting APIs -------------------------------- - -Export alert history and generate reports using Robusta's REST APIs. - -**Robusta API Reference** - Comprehensive APIs for exporting alert history, generating reports, and sending custom alerts programmatically. - -Features include: +Data Export and Reporting +------------------------- * :doc:`Alert Export API `: Export historical alert data with filtering by time range, alert name, and account * :doc:`Alert Reporting API `: Get aggregated statistics and counts for different alert types -* :doc:`Send Alerts API `: Send alerts programmatically from external systems or via integrations +* :doc:`Send Alerts API `: Send alerts programmatically from external systems * :doc:`Configuration Changes API `: Track configuration changes in your environment +* :doc:`Namespace Resources API `: Query namespace-level resource information * :doc:`RBAC Configuration API `: Programmatically manage role-based access control configurations * :doc:`Prometheus Query API `: Run PromQL queries against Prometheus in your connected clusters -Additional Pro Features ------------------------ - -Additional capabilities in Robusta Pro: - -* **Web UI**: Manage alerts, playbooks, and configuration through a browser interface -* **Alert Templates**: Create Prometheus alerts without writing PromQL -* **Historical Data**: Query alert history and trends -* **Enterprise Support**: Production support and SLA options - -For more details on the differences between open-source and SaaS, see :doc:`Open Source vs SaaS <../../how-it-works/oss-vs-saas>`. - Getting Started --------------- -To access these features: - -1. **Robusta SaaS**: `Sign up for free `_ to get started with the full platform -2. **Self-hosted Commercial**: Contact support@robusta.dev for enterprise plans with self-hosted UI -3. **API Access**: Generate API keys in the Robusta platform under **Settings** → **API Keys** +To access these APIs: -For detailed API documentation and examples, see the individual API references listed above. \ No newline at end of file +1. `Sign up `_ for Robusta SaaS or contact support@robusta.dev for self-hosted plans +2. Generate API keys in the Robusta Platform under **Settings** → **API Keys** diff --git a/docs/configuration/holmesgpt/getting-started.rst b/docs/configuration/holmesgpt/getting-started.rst index f66083d18..40332545c 100644 --- a/docs/configuration/holmesgpt/getting-started.rst +++ b/docs/configuration/holmesgpt/getting-started.rst @@ -9,15 +9,14 @@ Prerequisites .. raw:: html
- ✓ Robusta SaaS account (free or paid)
- ✓ Robusta UI sink enabled
+ ✓ Robusta SaaS account (free or paid)
✓ Robusta version 0.22.0 or higher
Quick Setup (Recommended) -------------------------- -Use Robusta's hosted AI service with GPT-4o: +Use Robusta's hosted AI service with frontier models from Anthropic, OpenAI, and more: 1. **Add to your Helm values:** @@ -43,104 +42,10 @@ Use Robusta's hosted AI service with GPT-4o: That's it! HolmesGPT will now analyze your alerts automatically. -.. note:: - - 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. - -Test Your Setup ---------------- - -Deploy a crashing pod to see HolmesGPT in action: - -.. code-block:: bash - - kubectl apply -f https://raw.githubusercontent.com/robusta-dev/kubernetes-demos/main/crashpod/broken.yaml - -Then check: -- **Robusta UI**: Look for the ``CrashLoopBackOff`` alert and click the "Root Cause" tab -- **Slack**: Click "Ask HolmesGPT" on the alert notification - Using Your Own AI Provider --------------------------- -Instead of Robusta AI, you can use your own OpenAI, Azure, or AWS Bedrock account. - -.. tab-set:: - - .. tab-item:: OpenAI - - .. code-block:: bash - - kubectl create secret generic holmes-secrets \ - --from-literal=openAiKey='YOUR_API_KEY' - - .. code-block:: yaml - - enableHolmesGPT: true - holmes: - additionalEnvVars: - - name: MODEL - value: gpt-4o - - name: OPENAI_API_KEY - valueFrom: - secretKeyRef: - name: holmes-secrets - key: openAiKey - - .. tab-item:: Azure AI - - .. code-block:: bash - - kubectl create secret generic holmes-secrets \ - --from-literal=azureOpenAiKey='YOUR_API_KEY' - - .. code-block:: yaml - - enableHolmesGPT: true - holmes: - additionalEnvVars: - - name: MODEL - value: azure/YOUR_DEPLOYMENT_NAME - - name: AZURE_API_VERSION - value: "2024-06-01" - - name: AZURE_API_BASE - value: https://your-org.openai.azure.com/ - - name: AZURE_API_KEY - valueFrom: - secretKeyRef: - name: holmes-secrets - key: azureOpenAiKey - - **Important**: In Azure Portal, increase your deployment's token limit to at least 450K. - - .. tab-item:: AWS Bedrock - - .. code-block:: bash - - kubectl create secret generic holmes-secrets \ - --from-literal=awsAccessKeyId='YOUR_KEY_ID' \ - --from-literal=awsSecretAccessKey='YOUR_SECRET_KEY' - - .. code-block:: yaml - - enableHolmesGPT: true - holmes: - enablePostProcessing: true - additionalEnvVars: - - name: MODEL - value: bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0 - - name: AWS_REGION_NAME - value: us-east-1 - - name: AWS_ACCESS_KEY_ID - valueFrom: - secretKeyRef: - name: holmes-secrets - key: awsAccessKeyId - - name: AWS_SECRET_ACCESS_KEY - valueFrom: - secretKeyRef: - name: holmes-secrets - key: awsSecretAccessKey +Instead of Robusta AI, you can bring your own LLM provider (OpenAI, Azure, AWS Bedrock, Anthropic, and more). See the `AI Providers documentation `_ for setup instructions. .. _Reading the Robusta UI Token from a secret in HolmesGPT: @@ -159,27 +64,7 @@ If you store the Robusta UI token in a Kubernetes secret (instead of directly in name: my-robusta-secrets # Your existing secret key: ui-token # Your existing key -Common Issues -------------- - -**Not seeing the "Ask HolmesGPT" button?** - - Ensure ``enableHolmesGPT: true`` is set - - Check HolmesGPT pod is running: ``kubectl get pods -n robusta | grep holmes`` - - Verify AI provider credentials are correct - -**Getting rate limit errors?** - - Azure: Increase token limit in Azure Portal (minimum 450K) - - OpenAI: Check your API quota and billing - - Consider using Robusta AI for unlimited investigations - -**Analysis seems incomplete?** - - Enable additional data sources in `HolmesGPT data sources `_ (follow Helm chart configuration examples) - - Ensure Prometheus is configured for metrics analysis - - Check that pod logs are accessible - Next Steps ---------- -* :doc:`main-features` - See what HolmesGPT can do -* `Configure Data Sources `_ - Add more context for better analysis (use Helm chart configuration) -* `Helm Configuration Reference `_ - Advanced HolmesGPT Helm settings \ No newline at end of file +* `Configure Data Sources `_ - Add more context for better analysis \ No newline at end of file diff --git a/docs/configuration/holmesgpt/holmesgpt-docs.rst b/docs/configuration/holmesgpt/holmesgpt-docs.rst index b5861ee8d..d854d8ff1 100644 --- a/docs/configuration/holmesgpt/holmesgpt-docs.rst +++ b/docs/configuration/holmesgpt/holmesgpt-docs.rst @@ -1,6 +1,6 @@ HolmesGPT Documentation ======================== -For comprehensive HolmesGPT documentation, please visit the official HolmesGPT documentation site at `holmesgpt.dev `_. +For comprehensive HolmesGPT documentation, please visit the official HolmesGPT documentation site at `holmesgpt.dev `_. For Robusta-specific setup instructions, see :doc:`getting-started`. \ No newline at end of file diff --git a/docs/configuration/holmesgpt/main-features.rst b/docs/configuration/holmesgpt/main-features.rst index 4611a4510..d25c42536 100644 --- a/docs/configuration/holmesgpt/main-features.rst +++ b/docs/configuration/holmesgpt/main-features.rst @@ -6,55 +6,12 @@ Robusta integrates `HolmesGPT `_ to pr See HolmesGPT in Action ----------------------- -.. tab-set:: - - .. tab-item:: AWS Troubleshooting - - .. raw:: html - -
- -
- - .. tab-item:: CPU Spike Investigation - - .. raw:: html - -
- -
- -How to Use It -------------- - -**In Robusta UI** - Click the ``Root Cause`` tab on any alert to see the AI investigation. - - .. image:: /images/ai-root-causeanalysis.png - :width: 600px - -**Via @holmes in Slack** - Ask natural language questions about your clusters: - - * ``@holmes what apps are crashing in prod-cluster?`` - * ``@holmes why is my alert firing on staging?`` - * ``@holmes investigate high memory usage in dev-cluster`` +See demos and up-to-date videos on the `Robusta homepage `_. Next Steps ---------- +* `Sign up for Robusta `_ - Get started with the full platform * :doc:`getting-started` - Set up HolmesGPT in 5 minutes -* `Available Data Sources `_ - See all supported integrations (use Robusta Helm Chart configuration method) -* `Helm Configuration Reference `_ - Advanced HolmesGPT settings for Robusta deployments \ No newline at end of file +* `Available Data Sources `_ - See all supported integrations +* `Helm Configuration Reference `_ - Advanced HolmesGPT settings for Robusta deployments \ No newline at end of file diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst index 30c8597ad..fa72ec326 100644 --- a/docs/configuration/index.rst +++ b/docs/configuration/index.rst @@ -5,6 +5,30 @@ Send Alerts to Robusta Connect your monitoring system to Robusta, to enrich alerts and apply automation rules. +.. toctree:: + :maxdepth: 1 + :hidden: + + alertmanager-integration/outofcluster-prometheus + alertmanager-integration/alert-manager + alertmanager-integration/eks-managed-prometheus + alertmanager-integration/azure-managed-prometheus + alertmanager-integration/coralogix_managed_prometheus + alertmanager-integration/embedded-prometheus + alertmanager-integration/google-managed-prometheus + alertmanager-integration/google-managed-alertmanager + alertmanager-integration/grafana-self-hosted + alertmanager-integration/grafana-cloud + alertmanager-integration/victoria-metrics + alertmanager-integration/dynatrace + alertmanager-integration/gcp-monitoring + alertmanager-integration/nagios + alertmanager-integration/newrelic + alertmanager-integration/pagerduty-alerting + alertmanager-integration/solarwinds + alertmanager-integration/customize-labels-priorities + exporting/custom-webhooks + Prometheus & AlertManager -------------------------- diff --git a/docs/configuration/metric-providers-grafana-cloud.rst b/docs/configuration/metric-providers-grafana-cloud.rst index 37dff3cfe..29971bc04 100644 --- a/docs/configuration/metric-providers-grafana-cloud.rst +++ b/docs/configuration/metric-providers-grafana-cloud.rst @@ -80,7 +80,7 @@ Make sure ``clusterName`` in Robusta Helm's values matches the ``cluster`` label HolmesGPT Configuration ----------------------- -Give HolmesGPT - Robusta's AI Agent - read access to metrics. See the `Grafana Cloud (Mimir) Configuration `_ guide. +Give HolmesGPT - Robusta's AI Agent - read access to metrics. See the `Grafana Cloud (Mimir) Configuration `_ guide. Next Steps ---------- diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index fc136a4b5..000000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,26 +0,0 @@ -:hide-toc: - -Contributing -================ - -.. toctree:: - :maxdepth: 1 - :hidden: - - docs-contributions - -We love our community and appreciate any contribution to the Robusta project. - -Join the Robusta `Slack community `_ and introduce yourself in the ``#contributors`` channel. - -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -How to contribute -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To contribute to the docs, see :ref:`Improving These Docs`. - -For code contributions, a good place to start is developing a new sink OR creating a new action. - -* :ref:`Developing a New Sink` -* :ref:`Developing New Actions` -* :ref:`Build from Source` \ No newline at end of file diff --git a/docs/docs-contributions.rst b/docs/docs-contributions.rst deleted file mode 100644 index 70ee34e83..000000000 --- a/docs/docs-contributions.rst +++ /dev/null @@ -1,64 +0,0 @@ -Improving These Docs -################################################### - -These docs are generated with `Sphinx `_ - -Writing Docs -^^^^^^^^^^^^^ - -Our docs are written in RST format. Learn more about RST `here `_ - -Building Docs Locally -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Prerequisites ----------------- - -The following must be installed on your local machine: - -* `Python `_ -* `Poetry `_ - -Instructions ----------------- - -Clone Robusta's repository: - -.. code-block:: bash - - git clone https://github.com/robusta-dev/robusta.git && cd robusta - -Install all devlopment requirements: - -.. code-block:: bash - - poetry install -E all - -Build the docs locally: - -.. code-block:: bash - - ./docs_autobuild.sh - -.. details:: Instructions for Windows - - Instead of running ``./docs_autobuild.sh``, copy-paste the commands inside of it and run them manually. - -.. details:: Common Errors - - 1. ``poetry: command not found`` - Make sure you have `Poetry `_ installed and run ``source $HOME/.poetry/env`` in Linux environments to set the poetry environment variables. - - 2. ``sphinx-build: command not found`` - Make sure you have `Sphinx `__ installed. - - 3. ``OSError: [Errno 98] Address already in use`` - Use the ``--port `` argument, with a port of your choice. Example: ``./docs_autobuild.sh --port 8822`` - -Deploying the Docs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -These docs are automatically deployed on every commit. - -On every push to ``docs/*``, a GitHub action builds and deploys docs to https://docs.robusta.dev/ - -On every release, a GitHub action builds and deploys docs to https://docs.robusta.dev/ - -If you need to override an existing docs release, you can manually trigger the workflow. diff --git a/docs/help.rst b/docs/help.rst index cea2849d7..d926cad02 100644 --- a/docs/help.rst +++ b/docs/help.rst @@ -22,7 +22,7 @@ Ask for help, or just say hi! .. grid-item-card:: :octicon:`mark-github;1em;` Github Issue :class-card: sd-bg-light sd-bg-text-light - :link: https://github.com/robusta-dev/robusta/issues + :link: https://github.com/robusta-dev/holmesgpt/issues -------------------------------- Commercial Support diff --git a/docs/how-it-works/architecture.rst b/docs/how-it-works/architecture.rst index d4f461841..03e19da6a 100644 --- a/docs/how-it-works/architecture.rst +++ b/docs/how-it-works/architecture.rst @@ -1,56 +1,63 @@ Architecture ================== -Robusta follows a modular architecture designed to integrate seamlessly with your existing Kubernetes observability stack. The system consists of core components that run in-cluster and optional components for enhanced functionality. +Robusta uses `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). -Core Components -^^^^^^^^^^^^^^^ +.. image:: ../images/architecture-overview.png + :width: 800 + :align: center -Robusta's core architecture runs entirely within your Kubernetes cluster: +| -**robusta-forwarder** - A lightweight deployment that connects to the Kubernetes APIServer to monitor cluster events and resource changes. It forwards relevant events to the runner component for processing. This component ensures Robusta stays up-to-date with your cluster state in real-time. +Agent (In-Cluster) +^^^^^^^^^^^^^^^^^^^ -**robusta-runner** - The main processing engine that receives events from the forwarder, evaluates playbook rules, executes enrichment actions, and sends notifications to configured destinations. It contains the business logic for alert correlation, data enrichment, and routing decisions. +The Robusta Agent runs inside your Kubernetes cluster. It includes HolmesGPT and is responsible for: -.. image:: ../images/arch-1/arch-1.png - :width: 600 - :align: center +- Fetching data from external `data sources `_ +- Optional: for customers troubleshooting issues on Kubernetes itself, track new deploys and changes to Kubernetes and query Kubernetes events -Data Flow -^^^^^^^^^ +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. -1. **Event Collection**: The forwarder monitors Kubernetes APIServer for resource changes and forwards them to the runner -2. **Alert Processing**: Prometheus AlertManager webhooks are received by the runner for alert enrichment -3. **Playbook Execution**: The runner evaluates configured playbooks and triggers appropriate actions -4. **Enrichment**: Additional context is gathered (logs, metrics, resource states) and attached to alerts -5. **Routing**: Enriched alerts are routed to configured sinks (Slack, Teams, etc.) based on routing rules +Robusta Platform +^^^^^^^^^^^^^^^^^ -Extended Architecture -^^^^^^^^^^^^^^^^^^^^^ +The Robusta Platform is a centralized place to control your SRE agents and chat with them. It is available as **SaaS** (hosted by Robusta) or **self-hosted** (for enterprise deployments). -**AI Analysis with HolmesGPT** - Robusta's AI engine automatically investigates alerts by analyzing logs, events, and cluster state to provide root cause analysis and remediation suggestions. See :ref:`AI Analysis ` for configuration details. +The Platform receives investigation results from HolmesGPT and provides: -**Prometheus Integration** - Robusta can work with your existing Prometheus setup or be installed with a :ref:`bundled Prometheus stack ` powered by ``kube-prometheus-stack``. The integration enables automatic alert enrichment and correlation. +- AI-powered root cause analysis results for every alert +- Centralized alert management and triage +- Historical alert analysis and timelines +- HolmesGPT Slack and Teams bot — tag the AI agent like a teammate to investigate issues on demand -**Centralized Management** - The Robusta `SaaS platform `_ provides centralized alert management, historical analysis, and cross-cluster visibility. Self-hosted options are available for enterprise deployments. +Data Sources +^^^^^^^^^^^^^ -**CLI Tooling** - The ``robusta`` CLI simplifies installation and configuration management by auto-generating Helm values and providing cluster diagnostics. +HolmesGPT integrates with a wide range of `data sources `_ in your environment to gather evidence during investigations. + +All data source connections are made by the Agent within your environment. The Robusta Platform never connects to your data sources directly. Security & Networking ^^^^^^^^^^^^^^^^^^^^^ -* All core components run within your cluster with configurable RBAC permissions. -* External integrations use secure webhook endpoints with optional authentication. -* SaaS connectivity is outbound-only with no inbound access required. -* All data remains in your cluster unless explicitly sent to configured sinks e.g. Slack, Robusta UI. +- 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 ^^^^^^^^^^ -:ref:`Ready to install Robusta? Get started. ` +`Ready to install Robusta? Get started. `_ + +.. _Robusta Classic: + +---- + +A Note on Robusta Classic +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You may see references to "Robusta Classic" in parts of this documentation. Robusta Classic is the original open source alert engine that provides deterministic, rule-based enrichment using configurable playbooks — automatically attaching pod logs, resource state, and related events to alerts before routing them to Slack, Teams, PagerDuty, and :doc:`other notification channels <../configuration/configuring-sinks>`. + +Robusta Classic can be installed as part of the Agent and runs alongside HolmesGPT, if you like. diff --git a/docs/how-it-works/index.rst b/docs/how-it-works/index.rst new file mode 100644 index 000000000..5833d1ff9 --- /dev/null +++ b/docs/how-it-works/index.rst @@ -0,0 +1,28 @@ +:hide-toc: + +Overview +==================== + +.. grid:: 1 1 2 3 + :gutter: 2 + + .. grid-item-card:: :octicon:`cpu;1em;` Architecture + :class-card: sd-bg-text-light + :link: architecture + :link-type: doc + + How Robusta's components work together — the Agent, HolmesGPT, data sources, and the Platform. + + .. grid-item-card:: :octicon:`package;1em;` Open Source vs SaaS + :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. + +.. toctree:: + :maxdepth: 1 + :hidden: + + Architecture + Open Source vs SaaS diff --git a/docs/how-it-works/oss-vs-saas.rst b/docs/how-it-works/oss-vs-saas.rst index 8736c9bab..4b99e2e1e 100644 --- a/docs/how-it-works/oss-vs-saas.rst +++ b/docs/how-it-works/oss-vs-saas.rst @@ -1,25 +1,42 @@ Open Source vs SaaS ################################ -Robusta has three deployment options: +HolmesGPT (Open Source) +^^^^^^^^^^^^^^^^^^^^^^^^ -- **Open Source**: MIT-licensed engine that sends alerts to Slack, Teams, etc. No web UI. -- **SaaS**: Open source engine + hosted web UI with :doc:`additional features <../configuration/exporting/robusta-pro-features>`. -- **Self-hosted**: Open source engine + on-premise web UI (enterprise plans). +At the core of Robusta is `HolmesGPT `_ — an open source, AI-powered agent that automatically investigates Kubernetes alerts and identifies root causes. + +HolmesGPT pulls data from your cluster logs, events, metrics, and external data sources like Prometheus, Grafana, New Relic, and more. It uses LLMs to correlate evidence across sources and produce actionable root cause analysis — turning noisy alerts into clear answers. + +HolmesGPT is MIT-licensed and can be used standalone or as part of the Robusta platform. + +Deployment Options +^^^^^^^^^^^^^^^^^^^ + +- **Open Source Only**: Run HolmesGPT on its own. No web UI. CLI interface and HTTP API on OSS. +- **SaaS**: HolmesGPT + Robusta's hosted web UI with :doc:`additional features <../configuration/exporting/robusta-pro-features>` including centralized alert management, multi-cluster visibility, and historical timelines. +- **Self-Hosted**: HolmesGPT + on-premise web UI for organizations that require dedicated infrastructure (enterprise plans). **Which should I choose?** -Most teams use the SaaS option for the :doc:`complete feature set <../configuration/exporting/robusta-pro-features>` without infrastructure overhead. The open source version works well if you only need basic alert routing to external systems. +Most teams use the **SaaS** option for the complete feature set without infrastructure overhead. Pricing ^^^^^^^^^^^^ -The Robusta OSS is and always will be free. It is MIT licensed. +HolmesGPT is and always will be free. It is a CNCF sandbox project. -The Robusta UI is `free to get started `_ on our SaaS platform. If you want to self-host the UI, you'll need an enterprise plan. +The Robusta Platform UI is `free to get started `_ on our SaaS. If you want to self-host the UI, you'll need an enterprise plan. Contact support@robusta.dev for questions. +Robusta Classic +^^^^^^^^^^^^^^^^ + +Before HolmesGPT, Robusta's open source engine focused on rule-based automation — enriching alerts with extra context (logs, pod status, resource graphs) and routing them to Slack, Teams, and other sinks using configurable playbooks. This is sometimes referred to as **Robusta Classic**. + +If you are running Robusta Classic, upgrading to HolmesGPT is a configuration change — no migration required. + Learn More ^^^^^^^^^^^^ -- :doc:`Robusta Pro Features <../configuration/exporting/robusta-pro-features>` - Detailed breakdown of SaaS and enterprise features +- `HolmesGPT on GitHub `_ - AI-powered root cause analysis for Kubernetes - `Pricing Plans `_ - Compare pricing options and start a free trial diff --git a/docs/how-it-works/usage-faq.rst b/docs/how-it-works/usage-faq.rst deleted file mode 100644 index 17ba1d2f6..000000000 --- a/docs/how-it-works/usage-faq.rst +++ /dev/null @@ -1,16 +0,0 @@ - -Usage FAQ -========== - -Does Robusta have Builtin Alerts? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Yes, you can install all-in-one bundle to install Robusta along with well-tested enriched alerts. - -If you already have alerts, you can skip the bundle and send your existing alerts to Robusta instead. They'll be enriched with extra context. - -Can Robusta monitor alerts from outside Kubernetes? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Robusta OSS is designed for Kubernetes environments and requires both Kubernetes and Prometheus to provide the most value. - -Robusta Pro extends beyond Kubernetes and can ingest alerts from any monitoring system via webhook, including Nagios, SolarWinds, and custom sources. These alerts get the same AI analysis and correlation features. diff --git a/docs/images/architecture-overview.png b/docs/images/architecture-overview.png index 4fbdbf885..e822b22c3 100644 Binary files a/docs/images/architecture-overview.png and b/docs/images/architecture-overview.png differ diff --git a/docs/index.rst b/docs/index.rst index d5034fb0e..07725d344 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,14 +1,13 @@ :hide-toc: .. toctree:: - :maxdepth: 1 + :maxdepth: 4 :caption: Overview :hidden: self how-it-works/architecture how-it-works/oss-vs-saas - how-it-works/usage-faq .. toctree:: :maxdepth: 4 @@ -19,121 +18,21 @@ .. toctree:: :maxdepth: 4 - :caption: AI Analysis + :caption: SRE Agent :hidden: configuration/holmesgpt/main-features configuration/holmesgpt/getting-started HolmesGPT Docs - Holmes Chat API - -.. toctree:: - :maxdepth: 4 - :caption: Send Alerts - :hidden: - - Overview - AlertManager - external - AlertManager - in-cluster - AWS Managed Prometheus - Azure Managed Prometheus - Coralogix - Dynatrace - Embedded Prometheus Stack - Google Managed Prometheus - GCP Cloud Monitoring - Google Managed Alertmanager - Grafana - Self-Hosted - Grafana Cloud - Nagios - New Relic - PagerDuty - SolarWinds - VictoriaMetrics - Customize Labels & Priorities - Other - Custom Webhooks - -.. toctree:: - :maxdepth: 4 - :caption: Track Config Changes - :hidden: - - track-changes/kubernetes-changes - LaunchDarkly .. toctree:: :maxdepth: 4 - :caption: Connect Metrics + :caption: HTTP APIs :hidden: - General Settings - Prometheus - in-cluster - Prometheus - external - Azure Managed - AWS Managed - Google Managed - Coralogix - VictoriaMetrics - Grafana Cloud (Mimir) - -.. toctree:: - :maxdepth: 4 - :caption: Notification Sinks - :hidden: - - Overview - All Sinks - configuration/sinks/slack - configuration/sinks/ms-teams - configuration/sinks/RobustaUI - configuration/sinks/mail - configuration/sinks/telegram - configuration/sinks/discord - configuration/sinks/DataDog - configuration/sinks/mattermost - configuration/sinks/Opsgenie - configuration/sinks/PagerDuty - configuration/sinks/VictorOps - configuration/sinks/YandexMessenger - configuration/sinks/jira - configuration/sinks/webhook - configuration/sinks/file - configuration/sinks/webex - configuration/sinks/kafka - configuration/sinks/rocketchat - configuration/sinks/google_chat - configuration/sinks/pushover - configuration/sinks/ServiceNow - configuration/sinks/zulip - configuration/sinks/sinks-development - -.. toctree:: - :maxdepth: 4 - :caption: Alert Routing - :hidden: - - Overview - Routing (Scopes) - Grouping (Slack Threads) - notification-routing/routing-by-time - notification-routing/routing-by-namespace - notification-routing/routing-by-type - notification-routing/implementing-monitoring-shifts - notification-routing/routing-to-multiple-slack-channels - notification-routing/routing-exclusion - notification-routing/routing-by-severity - notification-routing/excluding-resolved - notification-routing/disable-oomkill-notifications - notification-routing/routing-silencing - -.. toctree:: - :maxdepth: 4 - :caption: Robusta Pro Features - :hidden: - - configuration/exporting/robusta-pro-features + Overview + Holmes Chat API setup-robusta/alertsui - setup-robusta/crds configuration/exporting/send-alerts-api configuration/exporting/configuration-changes-api configuration/exporting/alert-export-api @@ -144,19 +43,16 @@ .. toctree:: :maxdepth: 4 - :caption: Advanced - Playbooks + :caption: Other Features :hidden: - playbook-reference/index - Playbook Notifications - Alert Enrichment - Automatic Remediation - Change Tracking Playbooks - Silencer Playbooks - Log Based Alerting - Cost Savings - KRR - Triggers Reference - Actions Reference + Send Alerts to Robusta + Track Config Changes + Connect Metrics + Notification Sinks + Alert Routing + CRDs Monitoring + Playbooks .. toctree:: :maxdepth: 4 @@ -164,43 +60,25 @@ :hidden: help - contributing - community-tutorials Welcome to Robusta ==================== -Robusta is an SRE agent that transforms alerts into actionable insights using LLMs combined with a rules (playbooks) engine. +Robusta is an AI-powered SRE agent that automatically investigates alerts and finds root causes. It is built on `HolmesGPT `_, an open source AI agent that pulls evidence from your existing `data sources `_ and uses LLMs to pinpoint what went wrong. -Robusta is available in open-source and commercial versions: +**How it works:** -.. list-table:: - :widths: 30 35 35 - :header-rows: 1 +* **Automatic investigation** — every alert is analyzed with AI-powered root cause analysis +* **Your data sources** — HolmesGPT connects to your existing monitoring, ITSM, and cloud tools to gather evidence +* **Chat with your agent** — tag HolmesGPT in Slack or Teams to investigate issues on demand +* **Centralized control** — the `Robusta Platform `_ gives you a single place to manage your SRE agents, triage alerts, and review investigation timelines - * - **Version** - - **Cloud Environments** - - **Alert Sources** - * - `Robusta Open Source `_ - - Kubernetes - - Prometheus - * - `Robusta Pro `_ - - Kubernetes and non-Kubernetes environments - - Prometheus, DataDog, NewRelic, and more - -**Key Features:** - -* **Smart Grouping** - Reduce notification spam -* **AI Investigation** - Find the root cause with AI -* **Alert Enrichment** - Correlate alerts with logs, k8s events, and more -* **Auto-Remediation** - Define self-healing rules for faster fixes +Robusta is available as **open source**, **SaaS**, or **self-hosted**. See :doc:`how-it-works/oss-vs-saas` for details. Ready to get started? --------------------- -Join hundreds of teams already running Robusta in production. - -.. button-ref:: ../setup-robusta/installation/index +.. button-link:: https://platform.robusta.dev/signup :color: primary :outline: diff --git a/docs/notification-routing/configuring-sinks.rst b/docs/notification-routing/configuring-sinks.rst index eea558ae2..53c79567e 100644 --- a/docs/notification-routing/configuring-sinks.rst +++ b/docs/notification-routing/configuring-sinks.rst @@ -1,8 +1,38 @@ .. _sinks-overview: + + Defining Sinks ========================== +.. toctree:: + :maxdepth: 1 + :hidden: + + ../configuration/sinks/slack + ../configuration/sinks/ms-teams + ../configuration/sinks/RobustaUI + ../configuration/sinks/telegram + ../configuration/sinks/discord + ../configuration/sinks/DataDog + ../configuration/sinks/mattermost + ../configuration/sinks/Opsgenie + ../configuration/sinks/PagerDuty + ../configuration/sinks/VictorOps + ../configuration/sinks/YandexMessenger + ../configuration/sinks/jira + ../configuration/sinks/webhook + ../configuration/sinks/file + ../configuration/sinks/webex + ../configuration/sinks/kafka + ../configuration/sinks/rocketchat + ../configuration/sinks/mail + ../configuration/sinks/google_chat + ../configuration/sinks/pushover + ../configuration/sinks/ServiceNow + ../configuration/sinks/zulip + ../configuration/sinks/sinks-development + Robusta can send notifications to various destinations, called sinks. A Simple Sink Configuration diff --git a/docs/notification-routing/index.rst b/docs/notification-routing/index.rst index b491d6ab5..b07165347 100644 --- a/docs/notification-routing/index.rst +++ b/docs/notification-routing/index.rst @@ -3,6 +3,23 @@ Notifications & Routing Overview ================================= +.. toctree:: + :maxdepth: 1 + :hidden: + + routing-with-scopes + notification-grouping + routing-silencing + routing-by-namespace + routing-by-severity + routing-by-time + routing-by-type + routing-exclusion + routing-to-multiple-slack-channels + excluding-resolved + disable-oomkill-notifications + implementing-monitoring-shifts + Robusta can send notifications to various destinations and route them intelligently based on alert type, namespace, severity, and more. Key Concepts diff --git a/docs/playbook-reference/index.rst b/docs/playbook-reference/index.rst index 608d07b49..373dbbb90 100644 --- a/docs/playbook-reference/index.rst +++ b/docs/playbook-reference/index.rst @@ -4,9 +4,21 @@ Playbooks Basics ################## +.. toctree:: + :maxdepth: 1 + :hidden: + + builtin-alert-enrichment + defining-playbooks/index + triggers/index + actions/index + automatic-remediation-examples/index + logs-triggers/index + kubernetes-examples/kubernetes-change-notifications + Playbooks are deterministic rules for responding to alerts and unhealthy conditions in a Kubernetes cluster. -Playbooks are recommended for advanced use cases. Most users should start with :doc:`AI Analysis ` of alerts first, which requires far less configuration. +Playbooks are recommended for advanced use cases. Most users should start with :doc:`SRE Agent ` of alerts first, which requires far less configuration. How Playbooks Work ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/setup-robusta/installation-faq.rst b/docs/setup-robusta/installation-faq.rst index a42da90a7..ef63a248d 100644 --- a/docs/setup-robusta/installation-faq.rst +++ b/docs/setup-robusta/installation-faq.rst @@ -54,16 +54,3 @@ Does Robusta support Thanos/Cortex/Mimir/VictoriaMetrics? ============================================================ Any Prometheus-compatible solution is fine. Just follow instructions in the :doc:`Send Alerts ` documentation. -Can I use Robusta with DataDog? -============================================================ -Yes, we have a :ref:`DataDog integration ` available. Try it out. - -Is NewRelic supported? -======================= -It's being planned, speak to us on Slack. - -Does Robusta replace monitoring tools? -============================================================ -Robusta's :ref:`all-in-one package ` is a complete monitoring and observability solution. - -Alternatively, you can keep your existing tools and add-on robusta. diff --git a/docs/track-changes/kubernetes-changes.rst b/docs/track-changes/kubernetes-changes.rst index bca7e4b1a..5de8b5d9b 100644 --- a/docs/track-changes/kubernetes-changes.rst +++ b/docs/track-changes/kubernetes-changes.rst @@ -1,8 +1,12 @@ Kubernetes Changes ================== +.. toctree:: + :maxdepth: 1 + :hidden: + + LaunchDarkly <../configuration/alertmanager-integration/launchdarkly> + When using Robusta SaaS, Robusta automatically tracks all Kubernetes changes and correlates them with alerts. This provides context about recent changes when investigating issues, helping you quickly identify if a deployment, configuration update, or other change caused a problem. - -Looking to get push notifications (e.g. Slack or other sinks) when Kubernetes resources change? See the :doc:`Change Tracking Playbooks ` guide in the Advanced section.