Skip to content

Commit 2f57b11

Browse files
committed
fixes
1 parent 219de12 commit 2f57b11

11 files changed

Lines changed: 19 additions & 19 deletions

File tree

docs/configuration/alertmanager-integration/alert-custom-prometheus.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ Create Custom Prometheus Alerts
88
You can define new alerts in two ways using Robusta:
99

1010
1. Prometheus Alerts - Using PromQL
11-
2. Robusta Playbooks - Using :ref:`customPlaybooks YAML <What are Playbooks?>`
11+
2. Robusta Playbooks - Using :ref:`customPlaybooks YAML <Playbook Basics>`
1212

1313
These methods are not mutually exclusive. Robusta playbooks can respond to Prometheus alerts, or they can generate
14-
alerts themselves by listening directly to the Kubernetes APIServer. To better understand the trade-offs, refer to
15-
:ref:`Should I generate alerts with Robusta or with Prometheus? <robusta-or-prometheus-alerts>`
14+
alerts themselves by listening directly to the Kubernetes APIServer.
1615

1716
In this tutorial, we use the first method to generate a custom Prometheus alert using PromQL. In the next tutorial,
1817
we define a custom Robusta playbook that enhances the alert and makes it better.
@@ -109,4 +108,4 @@ Next Steps
109108

110109
Learn how to enrich Prometheus alerts with more context, so that you can respond faster:
111110

112-
* :ref:`Prometheus Alert Enrichment`
111+
* :ref:`Alert Enrichment <builtin-alert-enrichment>`

docs/configuration/holmesgpt/getting-started.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ Instead of Robusta AI, you can use your own OpenAI, Azure, or AWS Bedrock accoun
142142
name: holmes-secrets
143143
key: awsSecretAccessKey
144144
145+
.. _Reading the Robusta UI Token from a secret in HolmesGPT:
146+
145147
Using Existing Secrets
146148
----------------------
147149

docs/configuration/resource-recommender.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Cost Savings (KRR)
22
************************************************************
33

4-
Robustas `KRR <https://github.com/robusta-dev/krr>`_ is a CLI tool for optimizing resource allocation in Kubernetes clusters.
5-
It gathers pod usage data from Prometheus and recommends requests and limits for CPU and memory. This reduces costs and improves performance.
4+
`KRR <https://github.com/robusta-dev/krr>`_ is a CLI tool that optimizes resource allocation in Kubernetes clusters.
5+
It gathers pod usage data from Prometheus and recommends requests and limits for CPU and memory, reducing costs and improving performance.
66

7-
By optionally integrating KRR with Robusta you can:
7+
Robusta can run KRR scans on a :ref:`schedule <Scheduled>` using playbooks. Because KRR is so popular, it has dedicated documentation here. You can:
88

9-
1. Get weekly KRR scan reports in Slack via Robusta OSS (disabled by default, see below to configure)
10-
2. View KRR scans from all your clusters in the Robusta UI (enabled by default for UI users)
9+
1. Send weekly scan reports to Slack or other sinks via Robusta OSS (disabled by default, configure below)
10+
2. View scans from all your clusters in the Robusta UI (enabled by default for UI users)
1111

1212

1313
Sending Weekly KRR Scan Reports to Slack

docs/help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Holmes
250250
251251
It's often because the ``Robusta UI Token`` is pulled from a secret, and Holmes cannot read it.
252252

253-
See :ref:`Reading the Robusta UI Token from a secret in HolmesGPT` to configure Holmes to read the ``token``
253+
See :ref:`Using Existing Secrets <Reading the Robusta UI Token from a secret in HolmesGPT>` to configure Holmes to read the ``token``
254254

255255
Phase 4: Integration Issues
256256
^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/how-it-works/coverage.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Prometheus Alerts
2020

2121
.. warning::
2222

23-
You must :ref:`send your Prometheus alerts to Robusta by webhook <Integrating with Prometheus>` for these to work.
23+
You must send your Prometheus alerts to Robusta by webhook for these to work. See :doc:`AlertManager Integration </configuration/alertmanager-integration/index>`.
2424

2525
Other errors
2626
----------------
@@ -39,8 +39,7 @@ Change Tracking
3939
By default all changes to Deployments, DaemonSets, and StatefulSets are sent to the Robusta UI for correlation
4040
with Prometheus alerts and other errors.
4141

42-
These changes are not sent to other sinks (e.g. Slack) by default because they are spammy. :ref:`Routing Cookbook`
43-
explains how to selectively track changes you care about in Slack as well.
42+
These changes are not sent to other sinks (e.g. Slack) by default because they are spammy. See :doc:`Notification Routing </notification-routing/index>` to learn how to selectively track changes you care about in Slack as well.
4443

4544
We also wrote a blog post `Why everyone should track Kubernetes changes and top four ways to do so <https://home.robusta.dev/blog/why-everyone-should-track-and-audit-kubernetes-changes-and-top-ways/>`_
4645

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,9 @@
147147
Playbook Notifications <playbook-reference/defining-playbooks/creating-notifications>
148148
Alert Enrichment <playbook-reference/builtin-alert-enrichment>
149149
Automatic Remediation <playbook-reference/automatic-remediation-examples/index>
150+
Change Tracking Playbooks <playbook-reference/kubernetes-examples/kubernetes-change-notifications>
150151
Silencer Playbooks <playbook-reference/defining-playbooks/silencer-playbooks>
151152
Log Based Alerting <playbook-reference/logs-triggers/index>
152-
K8s Change Notification <playbook-reference/kubernetes-examples/kubernetes-change-notifications>
153153
Cost Savings - KRR <configuration/resource-recommender>
154154
Triggers Reference <playbook-reference/triggers/index>
155155
Actions Reference <playbook-reference/actions/index>

docs/notification-routing/configuring-sinks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A Simple Sink Configuration
99
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1010
Sinks are defined in Robusta's Helm chart, using the ``sinksConfig`` value.
1111

12-
For example, lets add a :ref:`Microsoft Teams Sink <MS Teams sink>`:
12+
For example, lets add a :ref:`Microsoft Teams Sink <MS Teams>`:
1313

1414
.. code-block:: yaml
1515

docs/notification-routing/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Popular Sinks
6868

6969
.. grid-item-card:: PagerDuty
7070
:class-card: sd-bg-light sd-bg-text-light
71-
:link: ../configuration/sinks/pagerduty
71+
:link: ../configuration/sinks/PagerDuty
7272
:link-type: doc
7373

7474
.. grid-item-card:: View All Sinks

docs/playbook-reference/kubernetes-examples/kubernetes-change-notifications.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
K8s Change Notification
1+
Change Tracking Playbooks
22
################################
33

44
You can configure Robusta to send push notifications when Kubernetes resources change or become unhealthy. This is done by listening to API Server changes with `kubewatch <https://github.com/robusta-dev/kubewatch/>`_ and then filtering the stream of events in a Robusta playbook.

docs/playbook-reference/triggers/kubernetes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These triggers work even when Prometheus is not connected to Robusta. They're tr
99

1010
.. details:: Related Tutorials
1111

12-
* :doc:`K8s Change Notification </playbook-reference/kubernetes-examples/kubernetes-change-notifications>`
12+
* :doc:`Change Tracking Playbooks </playbook-reference/kubernetes-examples/kubernetes-change-notifications>`
1313

1414

1515
Crashing Pod Triggers

0 commit comments

Comments
 (0)