Skip to content

Commit a83367f

Browse files
committed
doc: docs for secrets sinks config
1 parent 8d52191 commit a83367f

File tree

16 files changed

+64
-1
lines changed

16 files changed

+64
-1
lines changed

docs/configuration/sinks/RobustaUI.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ Add a new sink to your Helm values (``generated_values.yaml``), under ``sinksCon
4242
4343
Perform a :ref:`Helm Upgrade <Simple Upgrade>`.
4444

45+
.. note::
46+
47+
To secure your token using Kubernetes Secrets, see :ref:`Managing Secrets`.
48+
4549
Handling Short-Lived Clusters in the UI
4650
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4751

docs/configuration/sinks/ServiceNow.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ Configuring the ServiceNow Sink
2828

2929

3030
Then perform a :ref:`Helm Upgrade <Simple Upgrade>`.
31+
32+
.. note::
33+
34+
To secure your username and password using Kubernetes Secrets, see :ref:`Managing Secrets`.

docs/configuration/sinks/VictorOps.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Save the file and run
2525
2626
helm upgrade robusta robusta/robusta --values=generated_values.yaml
2727
28+
.. note::
29+
30+
To secure your REST endpoint URL using Kubernetes Secrets, see :ref:`Managing Secrets`.
31+
2832
**Example Output:**
2933

3034
.. admonition:: Typically you'll send alerts from Robusta to VictorOps and not deployment changes. We're showing a non-typical example with deployment changes because it helps compare the format with other sinks.

docs/configuration/sinks/YandexMessenger.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,8 @@ After you have configured the sink in your ``generated_values.yaml`` save the fi
5959
6060
helm upgrade robusta robusta/robusta --values=generated_values.yaml
6161
62+
.. note::
63+
64+
To secure your bot token using Kubernetes Secrets, see :ref:`Managing Secrets`.
65+
6266
You should now get playbooks results in Yandex Messenger!

docs/configuration/sinks/discord.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ Save the file and run
5858
5959
helm upgrade robusta robusta/robusta --values=generated_values.yaml
6060
61+
.. note::
62+
63+
To secure your webhook URL using Kubernetes Secrets, see :ref:`Managing Secrets`.
64+
6165
You should now get playbooks results in Discord!
6266

6367

docs/configuration/sinks/google_chat.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,7 @@ Configuring the Google Chat sink in Robusta
2727
2828
2929
Then do a :ref:`Helm Upgrade <Simple Upgrade>`.
30+
31+
.. note::
32+
33+
To secure your webhook URL using Kubernetes Secrets, see :ref:`Managing Secrets`.

docs/configuration/sinks/jira.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ Save the file and run
8282
8383
helm upgrade robusta robusta/robusta --values=generated_values.yaml
8484
85+
.. note::
86+
87+
To secure your API key and credentials using Kubernetes Secrets, see :ref:`Managing Secrets`.
88+
8589
Try the example below to recieve an alert notification in Jira.
8690

8791

docs/configuration/sinks/kafka.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Save the file and run
4040
4141
helm upgrade robusta robusta/robusta --values=generated_values.yaml
4242
43+
.. note::
44+
45+
To secure your Kafka credentials using Kubernetes Secrets, see :ref:`Managing Secrets`.
4346

4447
**Example Output:**
4548

docs/configuration/sinks/mail.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,4 +192,8 @@ Troubleshooting
192192

193193
We highly recommend using quotes around "mailto" to ensure special characters are handled correctly.
194194

195-
Then do a :ref:`Helm Upgrade <Simple Upgrade>`.
195+
Then do a :ref:`Helm Upgrade <Simple Upgrade>`.
196+
197+
.. note::
198+
199+
To secure your email credentials and AWS credentials using Kubernetes Secrets, see :ref:`Managing Secrets`.

docs/configuration/sinks/mattermost.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ Save the file and run
8383
8484
helm upgrade robusta robusta/robusta --values=generated_values.yaml
8585
86+
.. note::
87+
88+
To secure your bot token using Kubernetes Secrets, see :ref:`Managing Secrets`.
89+
8690
You should now get playbooks results in Mattermost!
8791

8892

0 commit comments

Comments
 (0)