Skip to content

Commit

Permalink
more docs fixes (#1682)
Browse files Browse the repository at this point in the history
  • Loading branch information
@aantn
aantn authored Jan 7, 2025
1 parent 3523b03 commit e363f6a
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 20 deletions.
68 changes: 50 additions & 18 deletions docs/notification-routing/configuring-sinks.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,7 @@ For example, lets add a :ref:`Microsoft Teams Sink <MS Teams sink>`:
name: my_teams_sink # name that uniquely identifies this sink in Robusta
webhook_url: <placeholder> # the webhook URL for MSTeams - each sink has different parameters like this
More Sink Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Here are some more options you can set on sinks:

.. code-block:: yaml
sinksConfig:
- ms_teams_sink: # sink type
name: my_teams_sink # name that uniquely identifies this sink in Robusta
stop: false # optional - covered in the next tutorial
scope: {} # optional - covered in the next tutorial
default: true # optional - covered in the next tutorial
# sink-specific parameters
webhook_url: <placeholder>
The ``stop``, ``scope``, and ``default`` fields are used for :ref:`routing (scopes) <sink-scope-matching>`.
For all options, refer to :ref:`All Sink Options`.

Defining Multiple Sinks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -58,6 +41,55 @@ In the following example, we define a :ref:`Slack sink <Slack>` and a :ref:`MS T
To selectively send notifications to different sinks, refer to :ref:`routing (scopes) <sink-scope-matching>`.


All Sink Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Here is an example showing common sink options:

.. code-block:: yaml
sinksConfig:
- slack_sink: # sink type
name: my_sink_name # name that uniquely identifies this sink in Robusta
scope: {} # optional - filter notifications sent to this sink
activity: {} # optional - enable/disable sink according to time of day/week
stop: false # optional - stop notifications from continuing to subsequent sinks
grouping: {} # optional - use grouping to reduce the number of notifications (i.e. group into slack threads)
default: true # optional - disable this sink by default
# sink-specific parameters - e.g. for Slack, some options are shown below
# api_key: xoxb-112...
# slack_channel: general-alerts
Description of each option:

+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| Parameter Name | Description | Default | Docs |
+==================+=========================================================+==========================================================+===============================================+
| name | A unique name for this sink in Robusta | - | - |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| scope | Filters the notifications sent to this sink | *undefined* - all notifications are sent (unless already | |
| | | sent a previou sink that set `stop: true`) | :ref:`Routing (scopes) <sink-scope-matching>` |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| activity | Controls the hours this sink is active | *undefined* - active all hours and all days of the week | :ref:`Route by Time` |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| stop | Should notifications continue to subsequent sinks? | false - notification sent to this sink will continue to | :ref:`Stop Further Notifications` |
| | | subsequent sinks | |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| grouping | Currently only impacts the Slack sink, where it controls| *undefined* (disabled) | :ref:`Grouping <notification-grouping>` |
| | the creation of threads and the grouping of many | | |
| | notifications into one message | | |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| default | Is this sink enabled by default? When false, this sink | true - this sink is enabled by default | :ref:`Alternative Routing Methods` |
| | only accepts notifications from customPlaybooks which | | |
| | explicitly named this sink (if scope is set, it will | | |
| | still filter those notifications) | | |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+
| *sink specific* | Parameters specific to the sink type, like api_key for | - | :ref:`sink-specific docs <Sinks Reference>` |
| *parameters* | Slack and webhook_url for MSTeams | | |
+------------------+---------------------------------------------------------+----------------------------------------------------------+-----------------------------------------------+

Learn More
^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion docs/setup-robusta/installation-faq.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For example, to install in the ``robusta`` namespace:
helm install robusta robusta/robusta -f ./generated_values.yaml -n robusta --create-namespace --set clusterName=<YOUR_CLUSTER_NAME>
Verify success by checking that two Robusta pods are running:
Verify success by checking that Robusta pods are running:

.. code-block:: bash
:name: cb-get-pods-robusta-logs-custom
Expand Down
2 changes: 1 addition & 1 deletion docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ On some clusters this can take a while, so don't panic if it appears stuck:
Verifying Installation
------------------------------

Confirm that two Robusta pods are running with no errors in the logs:
Confirm that Robusta pods are running with no errors in the logs:

.. code-block:: bash
:name: cb-get-pods-robusta-logs
Expand Down

0 comments on commit e363f6a

Please sign in to comment.