Merge branch 'master' into bugfix/no-ref/add-missing-include-for-inci…

…dentio
robusta-dev · Jan 30, 2025 · 9d0abf3 · 9d0abf3
2 parents 0cc5312 + 44d146e
commit 9d0abf3
Show file tree

Hide file tree

Showing 30 changed files with 239 additions and 198 deletions.
diff --git a/README.md b/README.md
@@ -52,10 +52,25 @@ Robusta is installed with Helm. For convenience, we provide a CLI wizard to gene
 
 You can install Robusta alongside your existing Prometheus, or as an all-in-one bundle with Robusta and a preconfigured `kube-prometheus-stack`.
 
+To get *even more* out of Robusta, we recommend creating [a free Robusta UI account](#-free-robusta-ui). Learn more below.
+
+[Create a free Robusta UI account »](https://platform.robusta.dev/signup?utm_source=github&utm_medium=robusta-readme&utm_content=installing_robusta_section)
+
 [Installation instructions »](https://docs.robusta.dev/master/setup-robusta/installation/index.html)
 
 <!-- <p align="right">(<a href="#top">back to top</a>)</p> -->
 
+## 🖥 Free Robusta UI
+Take your Kubernetes monitoring to the next level with the [Robusta SaaS platform](https://platform.robusta.dev/signup?utm_source=github&utm_medium=robusta-readme&utm_content=free_robusta_ui_section). Creating an account is free, and includes:
+
+- **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
+
+  <a href="https://www.loom.com/share/89c7e098d9494d79895738e0b06091f0">
+      <img src="https://cdn.loom.com/sessions/thumbnails/89c7e098d9494d79895738e0b06091f0-f508768968f50b46-full-play.gif">
+  </a>
+
 ## 📝 Documentation
 Interested? Learn more about Robusta.
 

diff --git a/docs/_images/99fcc86f5a32394a39110af37d30d234bcd01044 b/docs/_images/99fcc86f5a32394a39110af37d30d234bcd01044
diff --git a/docs/conf.py b/docs/conf.py
@@ -114,8 +114,12 @@
     "tutorials/playbook-track-secrets.html": "/master/playbook-reference/kubernetes-examples//playbook-track-secrets.html",
     "tutorials/alert-remediation.html": "/master/playbook-reference/prometheus-examples/alert-remediation.html",
     "tutorials/alert-custom-enrichment.html": "/master/playbook-reference/prometheus-examples/alert-custom-enrichment.html",
-    "catalog/sinks/slack.html": "/master/configuration/sinks/slack.html"
-
+    "catalog/sinks/slack.html": "/master/configuration/sinks/slack.html",
+    "user-guide/sinks-configuration.html": "/master/notification-routing/routing-with-scopes.html",
+    "tutorials/alert-builtin-enrichment.html": "/master/how-it-works/alert-builtin-enrichment.html",
+    "tutorials/robusta-runner-metrics.html": "/master/setup-robusta/robusta-runner-metrics.html",
+    "tutorials/alert-custom-prometheus.html": "/master/configuration/alertmanager-integration/alert-custom-prometheus.html",
+    "catalog/triggers/prometheus.html": "/master/configuration/alertmanager-integration/index.html",
 
 }
 

diff --git a/docs/tutorials/alert-custom-prometheus.rst → ...r-integration/alert-custom-prometheus.rst b/docs/tutorials/alert-custom-prometheus.rst → ...r-integration/alert-custom-prometheus.rst
diff --git a/docs/configuration/alertmanager-integration/index.rst b/docs/configuration/alertmanager-integration/index.rst
@@ -17,6 +17,7 @@ Integrating with Prometheus
    grafana-alert-manager
    embedded-prometheus
    troubleshooting-alertmanager
+   alert-custom-prometheus
 
 
 

diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst
@@ -26,7 +26,7 @@ Robusta can receive alerts from many sources and send them to many destinations.
 
     .. grid-item-card:: :octicon:`book;1em;` Sinks (Destinations)
         :class-card: sd-bg-light sd-bg-text-light
-        :link: configuring-sinks
+        :link: sinks/index
         :link-type: doc
 
         Send notifications from Robusta to 15+ integrations like Slack, MS Teams, and Email.

diff --git a/docs/configuration/sinks/RobustaUI.rst b/docs/configuration/sinks/RobustaUI.rst
@@ -1,34 +1,44 @@
 Robusta UI
 #################
 
-Robusta can send issues and events in your Kubernetes cluster to the `Robusta UI <https://home.robusta.dev/>`_.
+Take your Kubernetes monitoring to the next level with a Robusta UI integration:
 
-.. image:: /images/robusta-ui.gif
-  :align: center
+- **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
+
+    <div style="text-align: center;">
+      <a href="https://www.loom.com/share/89c7e098d9494d79895738e0b06091f0" target="_blank" rel="noopener noreferrer">
+          <img src="https://cdn.loom.com/sessions/thumbnails/89c7e098d9494d79895738e0b06091f0-f508768968f50b46-full-play.gif">
+      </a>
+    </div>
 
 
 Configuring the Robusta UI Sink
 ------------------------------------------------
 
+.. tip::
+    This guide is for users who have already installed Robusta on their cluster. If you haven't installed Robusta yet, we recommend starting by `creating a free Robusta UI account ↗ <https://platform.robusta.dev/signup?utm_source=docs&utm_content=robusta-ui-sink-page>`_ instead.
+
 Use the ``robusta`` CLI to generate a token:
 
 .. code-block::
    :name: cb-robusta-ui-sink-generate-token
 
     robusta integrations ui
 
-Add a new sink to your Helm values, under ``sinksConfig``, with the token you generated:
+Add a new sink to your Helm values (``generated_values.yaml``), under ``sinksConfig``, with the token you generated:
 
-.. admonition:: Add this to your generated_values.yaml
-
-    .. code-block:: bash
-      :name: cb-robusta-ui-sink-config
+.. code-block:: bash
+  :name: cb-robusta-ui-sink-config
 
-        sinksConfig:
-        - robusta_sink:
-            name: robusta_ui_sink
-            token: <your-token>
-            ttl_hours: 4380
+  sinksConfig:
+  - robusta_sink:
+      name: robusta_ui_sink
+      token: <your-token>
+      ttl_hours: 4380
 
 Perform a :ref:`Helm Upgrade <Simple Upgrade>`.
 

diff --git a/docs/help.rst b/docs/help.rst
@@ -257,8 +257,8 @@ CRD issues
       This is often a CRD issue which can be fixed by enabling server-side apply option as shown below. Check out `this blog <https://blog.ediri.io/kube-prometheus-stack-and-argocd-25-server-side-apply-to-the-rescue>`_ to learn more. 
 
       .. image:: /images/Argocd_crd_issue_fix.png 
-      :width: 400
-      :align: center
+        :width: 400
+        :align: center
 
 .. details:: one or more objects failed to apply... CustomResourceDefinition.apiextensions.k8s.io "prometheusagents.monitoring.coreos.com" is invalid
 

diff --git a/docs/tutorials/alert-builtin-enrichment.rst → ...how-it-works/alert-builtin-enrichment.rst b/docs/tutorials/alert-builtin-enrichment.rst → ...how-it-works/alert-builtin-enrichment.rst
diff --git a/docs/images/robusta_ui_loom_preview.gif b/docs/images/robusta_ui_loom_preview.gif
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,7 @@
    how-it-works/oss-vs-saas
    how-it-works/coverage
    how-it-works/usage-faq
+   how-it-works/alert-builtin-enrichment
 
 .. toctree::
    :maxdepth: 4
@@ -57,13 +58,6 @@
 
    playbook-reference/index
 
-.. toctree::
-   :maxdepth: 4
-   :caption: 🎓 Tutorials
-   :hidden:
-
-   tutorials/index
-
 .. toctree::
    :maxdepth: 4
    :caption: Help

diff --git a/docs/notification-routing/disable-oomkill-notifications.rst b/docs/notification-routing/disable-oomkill-notifications.rst
@@ -0,0 +1,11 @@
+Disable "OOMKill" Notifications
+===================================
+
+Configure Robusta to not send OOMKill notifications by disabling the built-in OOMKill playbook. 
+
+.. code-block:: yaml
+
+    disabledPlaybooks:
+    - PodOOMKill
+
+Similarly you can to disable any built-in notification using the name of the playbook. Find all the built-in playbooks `here <https://github.com/robusta-dev/robusta/blob/master/helm/robusta/values.yaml#L113>`_ and `here <https://github.com/robusta-dev/robusta/blob/master/helm/robusta/values.yaml#L169>`_
diff --git a/docs/notification-routing/excluding-resolved.rst b/docs/notification-routing/excluding-resolved.rst
@@ -0,0 +1,15 @@
+Exclude "Resolved" Notifications
+===================================
+
+Configure Robusta to not send notifications for issues that are resolved. This helps you reduce noise and focus on just firing alerts 
+
+.. code-block:: yaml
+
+    sinksConfig:
+    - slack_sink:
+        name: high_severity_sink
+        slack_channel: high-severity-notifications
+        api_key: secret-key
+        scope:
+        exclude:
+            - title: ".*[RESOLVED].*"
diff --git a/docs/notification-routing/notification-routing-examples.rst b/docs/notification-routing/notification-routing-examples.rst
@@ -11,5 +11,7 @@ Routing Cookbook
    routing-to-multiple-slack-channels
    routing-exclusion
    routing-by-severity
+   excluding-resolved
+   disable-oomkill-notifications
 
 In this section you'll find example configurations for common routing patterns.
diff --git a/docs/setup-robusta/index.rst b/docs/setup-robusta/index.rst
@@ -16,6 +16,7 @@
    multi-cluster
    upgrade
    configuration-secrets
+   robusta-runner-metrics
    supported-clusters
    openshift
    node-selector
@@ -24,4 +25,5 @@
    alertsui
    additional-settings
    installation-faq
+
 
diff --git a/docs/setup-robusta/installation/_generate_config.jinja b/docs/setup-robusta/installation/_generate_config.jinja
@@ -10,7 +10,7 @@ Choose a configuration method below:
     .. tab-item:: Web Installation (recommended)
         :name: web-installation-tab
 
-        Create the configuration by signing up `for a free Robusta UI account ↗ <https://platform.robusta.dev/signup?utm_source=docs>`_
+        Create the configuration by signing up `for a free Robusta UI account ↗ <https://platform.robusta.dev/signup?utm_source=docs&utm_content=install-page>`_
 
         .. note::
 

diff --git a/docs/setup-robusta/installation/index.rst b/docs/setup-robusta/installation/index.rst
@@ -15,6 +15,7 @@ Installation Guides
    extend-prometheus-installation
    standalone-installation
    dev-setup
+
 
 
 .. grid:: 1 1 2 2

diff --git a/docs/tutorials/robusta-runner-metrics.rst → .../setup-robusta/robusta-runner-metrics.rst b/docs/tutorials/robusta-runner-metrics.rst → .../setup-robusta/robusta-runner-metrics.rst
@@ -1,4 +1,4 @@
-Monitoring Robusta with Prometheus
+Self-Monitoring
 ======================================
 
 Robusta Metrics Graphs

diff --git a/docs/tutorials/_routing-further-reading.rst b/docs/tutorials/_routing-further-reading.rst
diff --git a/docs/tutorials/application-troubleshooting-java.rst b/docs/tutorials/application-troubleshooting-java.rst
diff --git a/docs/tutorials/grafana-annotations.rst b/docs/tutorials/grafana-annotations.rst
diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
diff --git a/helm/robusta/values.yaml b/helm/robusta/values.yaml
@@ -90,6 +90,7 @@ lightActions:
 - holmes_conversation
 - holmes_issue_chat
 - holmes_chat
+- holmes_workload_chat
 
 # install prometheus, alert-manager, and grafana along with Robusta?
 enablePrometheusStack: false
@@ -518,11 +519,11 @@ platformPlaybooks:
 
 - name: "IngressChangeTracking"
   triggers:
-    - on_ingress_all_changes: {}
+    - on_kubernetes_resource_operation:
+        resources: ["ingress"]
   actions:
     - resource_babysitter: {}
     - customise_finding:
-        title: Ingress Changes
         aggregation_key: IngressChange
   sinks:
     - "robusta_ui_sink"