diff --git a/docs/_ext/region_box.py b/docs/_ext/region_box.py index 33e7f2bea..fc5d38126 100644 --- a/docs/_ext/region_box.py +++ b/docs/_ext/region_box.py @@ -27,6 +27,8 @@ from html import escape from docutils import nodes +from docutils.parsers.rst import directives +from sphinx.util import parselinenos from sphinx.util.docutils import SphinxDirective @@ -68,6 +70,9 @@ class RobustaCodeDirective(SphinxDirective): required_arguments = 0 optional_arguments = 1 final_argument_whitespace = False + option_spec = { + "emphasize-lines": directives.unchanged_required, + } def run(self): language = self.arguments[0] if self.arguments else "text" @@ -83,6 +88,17 @@ def run(self): container = nodes.container(classes=["robusta-region-box", "robusta-region-box--code"]) literal = nodes.literal_block(code, code) literal["language"] = language + + emphasize_spec = self.options.get("emphasize-lines") + if emphasize_spec: + try: + nlines = len(code.split("\n")) + hl_lines = [x + 1 for x in parselinenos(emphasize_spec, nlines) if 0 <= x < nlines] + except ValueError: + hl_lines = [] + if hl_lines: + literal["highlight_args"] = {"hl_lines": hl_lines} + container += literal return [container] diff --git a/docs/configuration/alertmanager-integration/launchdarkly.rst b/docs/configuration/alertmanager-integration/launchdarkly.rst index b1420129d..522ec59f0 100644 --- a/docs/configuration/alertmanager-integration/launchdarkly.rst +++ b/docs/configuration/alertmanager-integration/launchdarkly.rst @@ -1,3 +1,5 @@ +.. include:: ../_legacy_banner.rst + LaunchDarkly Integration with Robusta ===================================== diff --git a/docs/configuration/sinks/DataDog.rst b/docs/configuration/sinks/DataDog.rst index eafb712b7..c7d0cfd38 100644 --- a/docs/configuration/sinks/DataDog.rst +++ b/docs/configuration/sinks/DataDog.rst @@ -1,6 +1,16 @@ DataDog ########## +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your cluster to the Datadog events API. Example Output: diff --git a/docs/configuration/sinks/Opsgenie.rst b/docs/configuration/sinks/Opsgenie.rst index 170e01ed3..acb360367 100644 --- a/docs/configuration/sinks/Opsgenie.rst +++ b/docs/configuration/sinks/Opsgenie.rst @@ -1,6 +1,16 @@ Opsgenie ########## +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to the OpsGenie alerts API. To configure OpsGenie, We need an OpsGenie API key. It can be configured using the OpsGenie team integration. diff --git a/docs/configuration/sinks/PagerDuty.rst b/docs/configuration/sinks/PagerDuty.rst index 6b3bd991b..9c6dbed69 100644 --- a/docs/configuration/sinks/PagerDuty.rst +++ b/docs/configuration/sinks/PagerDuty.rst @@ -1,6 +1,16 @@ PagerDuty ########## +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can send three types of data to `PagerDuty `_: * `Change Events `_ - for example, when Deployments are updated diff --git a/docs/configuration/sinks/RobustaUI.rst b/docs/configuration/sinks/RobustaUI.rst index 49fb9bd90..7ea3ba58d 100644 --- a/docs/configuration/sinks/RobustaUI.rst +++ b/docs/configuration/sinks/RobustaUI.rst @@ -1,19 +1,9 @@ Robusta UI ################# -Take your Kubernetes monitoring to the next level with a Robusta UI integration: +The Robusta UI sink connects your Robusta installation to the Robusta SaaS platform, where you can investigate alerts with HolmesGPT, review timelines, and more. -- **AI Assistant**: Solve alerts faster with an AI assistant that highlights relevant observability data -- **Alert Timeline**: View Prometheus alerts across multiple clusters and spot correlations with a powerful timeline view -- **Change Tracking**: Correlate alerts with changes to your infrastructure or applications, with Robusta’s automatic change tracking for Kubernetes - -.. raw:: html - -
- - - -
+For the full list of platform features, see `home.robusta.dev `_. Configuring the Robusta UI Sink @@ -45,6 +35,10 @@ Perform a :ref:`Helm Upgrade `. Handling Short-Lived Clusters in the UI ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. note:: + + This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT. + By default, inactive Robusta clusters will be kept in the UI for 6 months **data retention**. (4380 hours) If you have many short-lived clusters, you can remove them from the UI automatically once they stop running. @@ -66,7 +60,11 @@ To do so, configure a shorter retention period by setting the ``ttl_hours`` in t Monitoring Specific Resources in Namespaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval. +.. note:: + + This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT. + +By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval. However, we have a configuration to monitor custom namespaced resources, and an API is exposed via the Robusta Backend to see how many of each resource you have in a namespace. To configure this, use the ``namespace_discovery_seconds`` and ``namespaceMonitoredResources`` settings in the Robusta UI sink: diff --git a/docs/configuration/sinks/ServiceNow.rst b/docs/configuration/sinks/ServiceNow.rst index e70d8f557..f1af506b3 100644 --- a/docs/configuration/sinks/ServiceNow.rst +++ b/docs/configuration/sinks/ServiceNow.rst @@ -1,6 +1,16 @@ ServiceNow ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster by creating issues in ServiceNow. diff --git a/docs/configuration/sinks/VictorOps.rst b/docs/configuration/sinks/VictorOps.rst index 3ea05c902..dab66cc2c 100644 --- a/docs/configuration/sinks/VictorOps.rst +++ b/docs/configuration/sinks/VictorOps.rst @@ -1,6 +1,16 @@ VictorOps ########## +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to the VictorOps alerts API. | To configure VictorOps, a VictorOps REST endpoint (url) is needed. diff --git a/docs/configuration/sinks/YandexMessenger.rst b/docs/configuration/sinks/YandexMessenger.rst index b99f346f2..4c1654ace 100644 --- a/docs/configuration/sinks/YandexMessenger.rst +++ b/docs/configuration/sinks/YandexMessenger.rst @@ -1,6 +1,16 @@ Yandex Messenger ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Yandex Messenger chats, channels or private conversations. .. note:: diff --git a/docs/configuration/sinks/discord.rst b/docs/configuration/sinks/discord.rst index b28b3ed7f..881800d14 100644 --- a/docs/configuration/sinks/discord.rst +++ b/docs/configuration/sinks/discord.rst @@ -1,6 +1,16 @@ Discord ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Discord. .. image:: /images/discord_example.png diff --git a/docs/configuration/sinks/file.rst b/docs/configuration/sinks/file.rst index 73ae34eeb..c83b13363 100644 --- a/docs/configuration/sinks/file.rst +++ b/docs/configuration/sinks/file.rst @@ -1,6 +1,16 @@ File ########### +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can write issues and events in your Kubernetes cluster to a local file (in JSON format). diff --git a/docs/configuration/sinks/google_chat.rst b/docs/configuration/sinks/google_chat.rst index 1344a2f24..6f65209eb 100644 --- a/docs/configuration/sinks/google_chat.rst +++ b/docs/configuration/sinks/google_chat.rst @@ -1,6 +1,16 @@ Google Chat ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster by sending messages via the `Google Chat `_ app. diff --git a/docs/configuration/sinks/index.rst b/docs/configuration/sinks/index.rst index 388da2f63..3d9be6734 100644 --- a/docs/configuration/sinks/index.rst +++ b/docs/configuration/sinks/index.rst @@ -6,6 +6,15 @@ All Sinks ================== +.. admonition:: Sinks are a legacy feature of Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + Robusta can send notifications to various destinations, known as sinks. **Related Topics:** diff --git a/docs/configuration/sinks/jira.rst b/docs/configuration/sinks/jira.rst index 6132df785..4b28786b3 100644 --- a/docs/configuration/sinks/jira.rst +++ b/docs/configuration/sinks/jira.rst @@ -1,6 +1,16 @@ Jira ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can automatically open and (optionally) resolve Jira tickets, based on issues in your Kubernetes cluster. .. image:: /images/jira_example.png diff --git a/docs/configuration/sinks/kafka.rst b/docs/configuration/sinks/kafka.rst index 634378b70..49ba1e04b 100644 --- a/docs/configuration/sinks/kafka.rst +++ b/docs/configuration/sinks/kafka.rst @@ -1,6 +1,16 @@ Kafka ######### +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to a Kafka topic. Configuring the Kafka sink diff --git a/docs/configuration/sinks/mail.rst b/docs/configuration/sinks/mail.rst index 046796699..88f1f8e8f 100644 --- a/docs/configuration/sinks/mail.rst +++ b/docs/configuration/sinks/mail.rst @@ -1,6 +1,16 @@ Mail ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster by sending emails using either SMTP servers or Amazon Simple Email Service (SES). diff --git a/docs/configuration/sinks/mattermost.rst b/docs/configuration/sinks/mattermost.rst index 5bd3866e6..0b3e459ed 100644 --- a/docs/configuration/sinks/mattermost.rst +++ b/docs/configuration/sinks/mattermost.rst @@ -1,6 +1,16 @@ Mattermost ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Mattermost. .. image:: /images/mattermost_sink_example.png diff --git a/docs/configuration/sinks/ms-teams.rst b/docs/configuration/sinks/ms-teams.rst index ef6466471..e22e56c4f 100644 --- a/docs/configuration/sinks/ms-teams.rst +++ b/docs/configuration/sinks/ms-teams.rst @@ -1,6 +1,19 @@ MS Teams ########## +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend connecting HolmesGPT to MS Teams instead of using this legacy sink. + + Open the `MS Teams settings page `_ in the Robusta platform to connect HolmesGPT to MS Teams. This adds a single HolmesGPT bot that powers all of the flows below: + + - **Chat** — ``@mention`` the bot in any channel to investigate issues on demand; it replies in the thread. + - **Alerts** — let `Alerts Triage `_ automatically investigate incoming alerts and post the findings to MS Teams. + - **Custom events** — use :ref:`Triggered Workflows ` to react to arbitrary events and notify MS Teams. + + These are separate flows that share the same bot: chat is interactive, while Alerts Triage and Triggered Workflows run automatically. + Robusta can report issues and events in your Kubernetes cluster to a MS Teams webhook. .. image:: /images/msteams_sink/deployment-babysitter-teams.png diff --git a/docs/configuration/sinks/pushover.rst b/docs/configuration/sinks/pushover.rst index 4496c2e3e..307973aa6 100644 --- a/docs/configuration/sinks/pushover.rst +++ b/docs/configuration/sinks/pushover.rst @@ -1,6 +1,16 @@ Pushover ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Pushover notification enabled devices. .. note:: diff --git a/docs/configuration/sinks/rocketchat.rst b/docs/configuration/sinks/rocketchat.rst index 4c5feb78e..e28191678 100644 --- a/docs/configuration/sinks/rocketchat.rst +++ b/docs/configuration/sinks/rocketchat.rst @@ -1,6 +1,16 @@ Rocket.Chat ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Rocket.Chat. .. image:: /images/rocketchat1.png diff --git a/docs/configuration/sinks/slack.rst b/docs/configuration/sinks/slack.rst index 7de6b179c..7c3696aec 100644 --- a/docs/configuration/sinks/slack.rst +++ b/docs/configuration/sinks/slack.rst @@ -1,6 +1,19 @@ Slack ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend connecting HolmesGPT to Slack instead of using this legacy sink. + + Open the `Slack settings page `_ in the Robusta platform to connect HolmesGPT to Slack. This adds a single HolmesGPT Slack bot that powers all of the flows below: + + - **Chat** — ``@mention`` the bot in any channel to investigate issues on demand; it replies in the thread. + - **Alerts** — let `Alerts Triage `_ automatically investigate incoming alerts and post the findings to Slack. + - **Custom events** — use :ref:`Triggered Workflows ` to react to arbitrary events and notify Slack. + + These are separate flows that share the same bot: chat is interactive, while Alerts Triage and Triggered Workflows run automatically. + Robusta can proxy Prometheus alerts to Slack, adding powerful features like :ref:`AI investigation `, :ref:`smart grouping ` and more. .. image:: /images/robusta-slack.png diff --git a/docs/configuration/sinks/telegram.rst b/docs/configuration/sinks/telegram.rst index a759e85a4..c25f54625 100644 --- a/docs/configuration/sinks/telegram.rst +++ b/docs/configuration/sinks/telegram.rst @@ -1,6 +1,16 @@ Telegram ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Telegram conversations. .. note:: diff --git a/docs/configuration/sinks/webex.rst b/docs/configuration/sinks/webex.rst index e6bef6932..d82da7d5a 100644 --- a/docs/configuration/sinks/webex.rst +++ b/docs/configuration/sinks/webex.rst @@ -1,6 +1,16 @@ Webex ################# +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Webex. .. image:: /images/webex_sink/webex_sink_example.png diff --git a/docs/configuration/sinks/webhook.rst b/docs/configuration/sinks/webhook.rst index f1ba780a2..3b3c0f627 100644 --- a/docs/configuration/sinks/webhook.rst +++ b/docs/configuration/sinks/webhook.rst @@ -1,6 +1,16 @@ Webhook ########### +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to a webhook. .. admonition:: Add this to your generated_values.yaml diff --git a/docs/configuration/sinks/zulip.rst b/docs/configuration/sinks/zulip.rst index 478931106..538cbe9f7 100644 --- a/docs/configuration/sinks/zulip.rst +++ b/docs/configuration/sinks/zulip.rst @@ -1,6 +1,16 @@ Zulip ###### +.. admonition:: This page documents a legacy sink in Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + + Robusta can report issues and events in your Kubernetes cluster to Zulip. .. image:: /images/zulip_example.png diff --git a/docs/notification-routing/configuring-sinks.rst b/docs/notification-routing/configuring-sinks.rst index 638f8e2ad..902d122f8 100644 --- a/docs/notification-routing/configuring-sinks.rst +++ b/docs/notification-routing/configuring-sinks.rst @@ -34,6 +34,15 @@ Defining Sinks ../configuration/sinks/zulip ../configuration/sinks/sinks-development +.. admonition:: Sinks are a legacy feature of Robusta classic + :class: warning + + For new setups, we recommend `HolmesGPT `_ instead. + + HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself. + + HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage `_ for alerts, or :ref:`Triggered Workflows ` for custom events. + Robusta can send notifications to various destinations, called sinks. A Simple Sink Configuration diff --git a/docs/setup-robusta/proxies.rst b/docs/setup-robusta/proxies.rst index 4b6b7f96d..12b6764c7 100644 --- a/docs/setup-robusta/proxies.rst +++ b/docs/setup-robusta/proxies.rst @@ -128,7 +128,7 @@ After applying firewall rules, you can sanity-check connectivity from inside the A non-zero HTTP code (including ``401``/``404``) confirms TCP + TLS reach the host. Connection timeouts indicate the firewall is still blocking. Copying Images to a Private Image Registry ----------------------------------------- +------------------------------------------ If you are running the Robusta **self-hosted platform** (the ``robusta-platform`` Helm chart) in an environment that cannot pull from public registries (Docker Hub, ``us-central1-docker.pkg.dev``, ``quay.io``), mirror the images below to your internal registry and override the registry fields in your Helm values.