-
Notifications
You must be signed in to change notification settings - Fork 309
Docs reorganize clean #1902
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Docs reorganize clean #1902
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
74d054d
Reorganize documentation structure
pavangudiwada de5467e
Reorganize documentation structure
pavangudiwada bfb805f
removed IAM service account info
pavangudiwada ded8fbc
Removed IAM references and some extra security related content
pavangudiwada 7303cfa
Merge branch 'master' into docs-reorganize-clean
pavangudiwada File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 63 additions & 63 deletions
126
docs/configuration/alertmanager-integration/_alertmanager-config.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,63 @@ | ||
| .. admonition:: AlertManager config for sending alerts to Robusta | ||
|
|
||
| .. tab-set:: | ||
|
|
||
| .. tab-item:: kube-prometheus-stack (Prometheus Operator) | ||
|
|
||
| Add the following to your `AlertManager's config Secret <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/alerting.md#managing-alertmanager-configuration>`_ | ||
|
|
||
| Do not apply in other ways, they all `have limitations <https://github.com/prometheus-operator/prometheus-operator/issues/3750>`_ and won't forward all alerts. | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| receivers: | ||
| - name: 'robusta' | ||
| webhook_configs: | ||
| - url: 'http://<helm-release-name>-runner.<namespace>.svc.cluster.local/api/alerts' | ||
| send_resolved: true # (3) | ||
| - name: 'default-receiver' | ||
|
|
||
| route: # (1) | ||
| routes: | ||
| - receiver: 'robusta' | ||
| group_by: [ '...' ] | ||
| group_wait: 1s | ||
| group_interval: 1s | ||
| matchers: | ||
| - severity =~ ".*" | ||
| repeat_interval: 4h | ||
| continue: true # (2) | ||
| receiver: 'default-receiver' | ||
|
|
||
| .. code-annotations:: | ||
| 1. Put Robusta's route as the first route, to guarantee it receives alerts. If you can't do so, you must guarantee all previous routes set ``continue: true`` set. | ||
| 2. Keep sending alerts to receivers defined after Robusta. | ||
| 3. Important, so Robusta knows when alerts are resolved. | ||
|
|
||
| .. tab-item:: Other Prometheus Installations | ||
|
|
||
| Add the following to your AlertManager configuration, wherever it is defined. | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| receivers: | ||
| - name: 'robusta' | ||
| webhook_configs: | ||
| - url: 'http://<helm-release-name>-runner.<namespace>.svc.cluster.local/api/alerts' | ||
| send_resolved: true # (3) | ||
|
|
||
| route: # (1) | ||
| routes: | ||
| - receiver: 'robusta' | ||
| group_by: [ '...' ] | ||
| group_wait: 1s | ||
| group_interval: 1s | ||
| matchers: | ||
| - severity =~ ".*" | ||
| repeat_interval: 4h | ||
| continue: true # (2) | ||
|
|
||
| .. code-annotations:: | ||
| 1. Put Robusta's route as the first route, to guarantee it receives alerts. If you can't do so, you must guarantee all previous routes set ``continue: true`` set. | ||
| 2. Keep sending alerts to receivers defined after Robusta. | ||
| 3. Important, so Robusta knows when alerts are resolved. | ||
| Configure your AlertManager to send alerts to Robusta: | ||
|
|
||
| .. tab-set:: | ||
|
|
||
| .. tab-item:: kube-prometheus-stack (Prometheus Operator) | ||
|
|
||
| Add the following to your `AlertManager's config Secret <https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/alerting.md#managing-alertmanager-configuration>`_. | ||
|
|
||
| Do not apply in other ways, they all `have limitations <https://github.com/prometheus-operator/prometheus-operator/issues/3750>`_ and won't forward all alerts. | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| receivers: | ||
| - name: 'robusta' | ||
| webhook_configs: | ||
| - url: 'http://<helm-release-name>-runner.<namespace>.svc.cluster.local/api/alerts' | ||
| send_resolved: true # (3) | ||
| - name: 'default-receiver' | ||
|
|
||
| route: # (1) | ||
| routes: | ||
| - receiver: 'robusta' | ||
| group_by: [ '...' ] | ||
| group_wait: 1s | ||
| group_interval: 1s | ||
| matchers: | ||
| - severity =~ ".*" | ||
| repeat_interval: 4h | ||
| continue: true # (2) | ||
| receiver: 'default-receiver' | ||
|
|
||
| .. code-annotations:: | ||
| 1. Put Robusta's route as the first route, to guarantee it receives alerts. If you can't do so, you must guarantee all previous routes set ``continue: true``. | ||
| 2. Keep sending alerts to receivers defined after Robusta. | ||
| 3. Important, so Robusta knows when alerts are resolved. | ||
|
|
||
| .. tab-item:: Other Prometheus Installations | ||
|
|
||
| Add the following to your AlertManager configuration, wherever it is defined. | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| receivers: | ||
| - name: 'robusta' | ||
| webhook_configs: | ||
| - url: 'http://<helm-release-name>-runner.<namespace>.svc.cluster.local/api/alerts' | ||
| send_resolved: true # (3) | ||
|
|
||
| route: # (1) | ||
| routes: | ||
| - receiver: 'robusta' | ||
| group_by: [ '...' ] | ||
| group_wait: 1s | ||
| group_interval: 1s | ||
| matchers: | ||
| - severity =~ ".*" | ||
| repeat_interval: 4h | ||
| continue: true # (2) | ||
|
|
||
| .. code-annotations:: | ||
| 1. Put Robusta's route as the first route, to guarantee it receives alerts. If you can't do so, you must guarantee all previous routes set ``continue: true``. | ||
| 2. Keep sending alerts to receivers defined after Robusta. | ||
| 3. Important, so Robusta knows when alerts are resolved. | ||
7 changes: 3 additions & 4 deletions
7
docs/configuration/alertmanager-integration/_prometheus_flags_check.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,8 @@ | ||
|
|
||
| Robusta utilizes the flags API to retrieve data from Prometheus-style metric stores. However, some platforms like Google Managed Prometheus, Azure Managed Prometheus etc, do not implement the flags API. | ||
|
|
||
| You can disable the Prometheus flags API check by setting the following option to ``false``. | ||
| You can disable the Prometheus flags API check by setting the following option to false. | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| globalConfig: | ||
| check_prometheus_flags: true/false | ||
| globalConfig: | ||
| check_prometheus_flags: true/false |
79 changes: 4 additions & 75 deletions
79
docs/configuration/alertmanager-integration/_pull_integration.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,10 @@ | ||
| Configure Metric Querying | ||
| ==================================== | ||
|
|
||
| Metrics querying lets Robusta pull metrics and create silences. | ||
| To enable Robusta to pull metrics and create silences, you need to configure Prometheus and AlertManager URLs. | ||
|
|
||
| If Robusta fails to auto-detect the Prometheus and Alertmanager urls - and you see related connection errors in the logs - configure the ``prometheus_url`` and ``alertmanager_url`` in your Helm values and :ref:`update Robusta <Simple Upgrade>` | ||
| See :doc:`Prometheus and metrics configuration </configuration/metric-providers-in-cluster>` for detailed instructions. | ||
|
|
||
| .. code-block:: yaml | ||
| .. note:: | ||
|
|
||
| globalConfig: # This line should already exist | ||
| # Add the lines below | ||
| alertmanager_url: "http://ALERT_MANAGER_SERVICE_NAME.NAMESPACE.svc.cluster.local:9093" # (1) | ||
| prometheus_url: "http://PROMETHEUS_SERVICE_NAME.NAMESPACE.svc.cluster.local:9090" # (2) | ||
|
|
||
| # If Prometheus has data for multiple clusters, tell Robusta how to query data for this cluster only | ||
| # prometheus_additional_labels: | ||
| # cluster: 'CLUSTER_NAME_HERE' | ||
|
|
||
| # If using Grafana alerts, add this too | ||
| # grafana_api_key: <YOUR GRAFANA EDITOR API KEY> # (3) | ||
| # alertmanager_flavor: grafana | ||
|
|
||
| # If necessary, see docs below | ||
| # prometheus_auth: ... | ||
| # alertmanager_auth: ... | ||
|
|
||
| # If using a multi-tenant prometheus or alertmanager, pass the org id to all queries | ||
| # prometheus_additional_headers: | ||
| # X-Scope-OrgID: <org id> | ||
| # alertmanager_additional_headers: | ||
| # X-Scope-OrgID: <org id> | ||
|
|
||
| .. code-annotations:: | ||
| 1. Example: http://alertmanager-Helm_release_name-kube-prometheus-alertmanager.default.svc.cluster.local:9093. | ||
| 2. Example: http://Helm_Release_Name-kube-prometheus-prometheus.default.svc.cluster.local:9090 | ||
| 3. This is necessary for Robusta to create silences when using Grafana Alerts, because of minor API differences in the AlertManager embedded in Grafana. | ||
|
|
||
| You can optionally setup authentication, SSL verification, and other parameters described below. | ||
|
|
||
| Verify it Works | ||
| ^^^^^^^^^^^^^^^^^ | ||
| Open any application in the Robusta UI. If CPU and memory graphs are shown, everything is working. | ||
|
|
||
| If you don't use the Robusta UI, trigger a `demo OOMKill alert <https://github.com/robusta-dev/kubernetes-demos/#oomkilled-pod-out-of-memory-kill>`_, | ||
| and verify that Robusta sends a Slack/Teams message with a memory graph included. If so, everything is configured properly. | ||
|
|
||
| Optional Settings | ||
| ============================= | ||
|
|
||
| Authentication Headers | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| If Prometheus and/or AlertManager require authentication, add the following to ``generated_values.yaml``: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| globalConfig: | ||
| prometheus_auth: Bearer <YOUR TOKEN> # Replace <YOUR TOKEN> with your actual token or use any other auth header as needed | ||
| alertmanager_auth: Basic <USER:PASSWORD base64-encoded> # Replace <USER:PASSWORD base64-encoded> with your actual credentials, base64-encoded, or use any other auth header as needed | ||
|
|
||
| These settings may be configured independently. | ||
|
|
||
| SSL Verification | ||
| ^^^^^^^^^^^^^^^^^^^^ | ||
| By default, Robusta does not verify the SSL certificate of the Prometheus server. | ||
|
|
||
| To enable SSL verification, add the following to Robusta's ``generated_values.yaml``: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| runner: | ||
| additional_env_vars: | ||
| - name: PROMETHEUS_SSL_ENABLED | ||
| value: "true" | ||
|
|
||
| If you have a custom Certificate Authority (CA) certificate, add one more setting: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| runner: | ||
| certificate: "<YOUR BASE-64 ENCODED DATA>" # base64-encoded certificate value | ||
| Robusta will attempt to auto-detect Prometheus and AlertManager URLs in your cluster. Manual configuration is only needed if auto-detection fails. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 3 additions & 7 deletions
10
docs/configuration/alertmanager-integration/alert-manager.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.